feat(config): ActivityLoaderArgs.config

.changeset/perfect-impalas-marry.md

@@ -0,0 +1,7 @@
+---
+"@stackflow/react": minor
+"@stackflow/link": minor
+"@stackflow/config": minor
+---
+
+add `config` property in loader args

biome.json

@@ -53,6 +53,7 @@
       ".vscode/**",
       ".yarn/**",
       ".next/**",
+      "__generated__/**",
       ".ultra.cache.json",
       "package.json"
     ]

config/src/ActivityLoader.ts

@@ -1,6 +1,6 @@
 import type { ActivityLoaderArgs } from "./ActivityLoaderArgs";
-import type { RegisteredActivityParamTypes } from "./RegisteredActivityParamTypes";
+import type { RegisteredActivityName } from "./RegisteredActivityName";
 
-export type ActivityLoader<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
-> = (args: ActivityLoaderArgs<ActivityName>) => any;
+export type ActivityLoader<ActivityName extends RegisteredActivityName> = (
+  args: ActivityLoaderArgs<ActivityName>,
+) => any;

config/src/ActivityLoaderArgs.ts

@@ -1,8 +1,11 @@
+import type { ActivityDefinition } from "./ActivityDefinition";
+import type { Config } from "./Config";
 import type { InferActivityParams } from "./InferActivityParams";
-import type { RegisteredActivityParamTypes } from "./RegisteredActivityParamTypes";
+import type { RegisteredActivityName } from "./RegisteredActivityName";
 
-export type ActivityLoaderArgs<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
-> = {
+export interface ActivityLoaderArgs<
+  ActivityName extends RegisteredActivityName,
+> {
   params: InferActivityParams<ActivityName>;
-};
+  config: Config<ActivityDefinition<RegisteredActivityName>>;
+}

config/src/InferActivityParams.ts

@@ -1,8 +1,8 @@
 import type { ActivityBaseParams } from "./ActivityBaseParams";
+import type { RegisteredActivityName } from "./RegisteredActivityName";
 import type { RegisteredActivityParamTypes } from "./RegisteredActivityParamTypes";
 
-export type InferActivityParams<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
-> = RegisteredActivityParamTypes[ActivityName] extends never
-  ? ActivityBaseParams
-  : RegisteredActivityParamTypes[ActivityName];
+export type InferActivityParams<ActivityName extends RegisteredActivityName> =
+  RegisteredActivityParamTypes[ActivityName] extends never
+    ? ActivityBaseParams
+    : RegisteredActivityParamTypes[ActivityName];

config/src/RegisteredActivityName.ts

@@ -0,0 +1,6 @@
+import type { RegisteredActivityParamTypes } from "./RegisteredActivityParamTypes";
+
+export type RegisteredActivityName = Extract<
+  keyof RegisteredActivityParamTypes,
+  string
+>;

config/src/index.ts

@@ -6,4 +6,5 @@ export * from "./ActivityLoaderArgs";
 export * from "./Config";
 export * from "./InferActivityParams";
 export * from "./Register";
+export * from "./RegisteredActivityName";
 export * from "./RegisteredActivityParamTypes";

extensions/link/src/future/Link.tsx

@@ -2,7 +2,7 @@
 
 import type {
   InferActivityParams,
-  RegisteredActivityParamTypes,
+  RegisteredActivityName,
 } from "@stackflow/config";
 import { useConfig, useFlow } from "@stackflow/react/future";
 import { useMemo } from "react";
@@ -16,19 +16,16 @@ type AnchorProps = Omit<
   "ref" | "href"
 >;
 
-export interface LinkProps<
-  K extends Extract<keyof RegisteredActivityParamTypes, string>,
-> extends AnchorProps {
+export interface LinkProps<K extends RegisteredActivityName>
+  extends AnchorProps {
   ref?: React.RefObject<HTMLAnchorElement>;
   activityName: K;
   activityParams: InferActivityParams<K>;
   animate?: boolean;
   replace?: boolean;
 }
 
-export function Link<
-  K extends Extract<keyof RegisteredActivityParamTypes, string>,
->(props: LinkProps<K>) {
+export function Link<K extends RegisteredActivityName>(props: LinkProps<K>) {
   const config = useConfig();
   const { push, replace } = useFlow();
 

integrations/react/src/future/Actions.ts

@@ -1,10 +1,10 @@
 import type {
   InferActivityParams,
-  RegisteredActivityParamTypes,
+  RegisteredActivityName,
 } from "@stackflow/config";
 
 export type Actions = {
-  push<K extends Extract<keyof RegisteredActivityParamTypes, string>>(
+  push<K extends RegisteredActivityName>(
     activityName: K,
     activityParams: InferActivityParams<K>,
     options?: {
@@ -13,7 +13,7 @@ export type Actions = {
   ): {
     activityId: string;
   };
-  replace<K extends Extract<keyof RegisteredActivityParamTypes, string>>(
+  replace<K extends RegisteredActivityName>(
     activityName: K,
     activityParams: InferActivityParams<K>,
     options?: {

integrations/react/src/future/ActivityComponentType.tsx

@@ -1,9 +1,8 @@
 import type {
   InferActivityParams,
-  RegisteredActivityParamTypes,
+  RegisteredActivityName,
 } from "@stackflow/config";
 import type React from "react";
 
-export type ActivityComponentType<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
-> = React.ComponentType<{ params: InferActivityParams<ActivityName> }>;
+export type ActivityComponentType<ActivityName extends RegisteredActivityName> =
+  React.ComponentType<{ params: InferActivityParams<ActivityName> }>;

integrations/react/src/future/loader/loaderPlugin.tsx

@@ -39,6 +39,7 @@ export function loaderPlugin(
 
         const loaderData = loader({
           params: activityParams,
+          config,
         });
 
         return {
@@ -63,6 +64,7 @@ export function loaderPlugin(
 
       const loaderData = loader({
         params: activityParams,
+        config,
       });
 
       overrideActionParams({
@@ -86,6 +88,7 @@ export function loaderPlugin(
 
       const loaderData = loader({
         params: activityParams,
+        config,
       });
 
       overrideActionParams({

integrations/react/src/future/useActivityParams.ts

@@ -1,13 +1,12 @@
-import { useContext } from "react";
-
 import type {
   InferActivityParams,
-  RegisteredActivityParamTypes,
+  RegisteredActivityName,
 } from "@stackflow/config";
+import { useContext } from "react";
 import { ActivityContext } from "../__internal__/activity/ActivityProvider";
 
 export function useActivityParams<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
+  ActivityName extends RegisteredActivityName,
 >(): InferActivityParams<ActivityName> {
   return useContext(ActivityContext)
     .params as InferActivityParams<ActivityName>;

integrations/react/src/future/useStepFlow.ts

@@ -1,14 +1,14 @@
 import type {
   InferActivityParams,
-  RegisteredActivityParamTypes,
+  RegisteredActivityName,
 } from "@stackflow/config";
 import { useCoreActions } from "../__internal__/core";
 import type { StepActions } from "./StepActions";
 import { makeStepActions } from "./makeStepActions";
 
-export function useStepFlow<
-  ActivityName extends Extract<keyof RegisteredActivityParamTypes, string>,
->(activityName: ActivityName): StepActions<InferActivityParams<ActivityName>> {
+export function useStepFlow<ActivityName extends RegisteredActivityName>(
+  activityName: ActivityName,
+): StepActions<InferActivityParams<ActivityName>> {
   const coreActions = useCoreActions();
   return makeStepActions(() => coreActions);
 }