🐛 Remove BrandedDataFunction in favor of intermediate StrongAction & … (

#10) * 🐛 Remove BrandedDataFunction in favor of intermediate StrongAction & StrongLoader types * Played again by F2
tatemz · Jul 28, 2023 · e7bf811 · e7bf811
1 parent 8013079
commit e7bf811
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 24 deletions.
diff --git a/src/buildStrongRoute.tsx b/src/buildStrongRoute.tsx
@@ -10,9 +10,10 @@ import {
 import { useStrongLoaderData, useStrongRouteError } from "./hooks";
 import { strongResponse } from "./strongResponse";
 import {
-  BrandedDataFunction,
   BuildStrongRemixRouteExportsOpts,
   PickDataAndStatus,
+  StrongAction,
+  StrongLoader,
   StrongRedirect,
   StrongRemixRouteExports,
   StrongResponse,
@@ -49,7 +50,9 @@ const handleDataFunctionForRemix = async <
   Failure extends StrongResponse<unknown, NonRedirectStatus> = never,
   Redirect extends StrongRedirect<string, RedirectStatus> = never,
 >(
-  dataFunction: BrandedDataFunction<Failure, Success, Redirect>,
+  dataFunction:
+    | StrongLoader<Failure, Success, Redirect>
+    | StrongAction<Failure, Success, Redirect>,
   args: DataFunctionArgs,
 ) => {
   const resultEffect = (await dataFunction(args)) as Effect.Effect<

diff --git a/src/index.ts b/src/index.ts
@@ -2,8 +2,10 @@ export { buildStrongRoute } from "./buildStrongRoute";
 export {
   StrongResponse,
   StrongRedirect,
-  StrongLoader,
+  StrongLoaderWithCallbacks,
+  StrongActionWithCallbacks,
   StrongAction,
+  StrongLoader,
   StrongComponent,
   StrongErrorBoundary,
 } from "./types";

diff --git a/src/strongAction.ts b/src/strongAction.ts
@@ -1,8 +1,8 @@
 import { DataFunctionArgs } from "@remix-run/server-runtime";
 import { NonRedirectStatus, RedirectStatus } from "./HttpStatusCode";
 import {
-  BrandedDataFunction,
   StrongAction,
+  StrongActionWithCallbacks,
   StrongRedirect,
   StrongResponse,
 } from "./types";
@@ -14,8 +14,8 @@ export const strongAction =
     Success extends StrongResponse<unknown, NonRedirectStatus> = never,
     Redirect extends StrongRedirect<string, RedirectStatus> = never,
   >(
-    actionFn: StrongAction<Failure, Success, Redirect>,
-  ): BrandedDataFunction<Failure, Success, Redirect> =>
+    actionFn: StrongActionWithCallbacks<Failure, Success, Redirect>,
+  ): StrongAction<Failure, Success, Redirect> =>
   (args: DataFunctionArgs) =>
     actionFn(args, {
       fail: Effect.fail,

diff --git a/src/strongLoader.ts b/src/strongLoader.ts
@@ -1,8 +1,8 @@
 import { DataFunctionArgs } from "@remix-run/server-runtime";
 import { NonRedirectStatus, RedirectStatus } from "./HttpStatusCode";
 import {
-  BrandedDataFunction,
   StrongLoader,
+  StrongLoaderWithCallbacks,
   StrongRedirect,
   StrongResponse,
 } from "./types";
@@ -14,8 +14,8 @@ export const strongLoader =
     Success extends StrongResponse<unknown, NonRedirectStatus>,
     Redirect extends StrongRedirect<string, RedirectStatus> = never,
   >(
-    loaderFn: StrongLoader<Failure, Success, Redirect>,
-  ): BrandedDataFunction<Failure, Success, Redirect> =>
+    loaderFn: StrongLoaderWithCallbacks<Failure, Success, Redirect>,
+  ): StrongLoader<Failure, Success, Redirect> =>
   (args: DataFunctionArgs) =>
     loaderFn(args, {
       fail: Effect.fail,

diff --git a/src/types.ts b/src/types.ts
@@ -17,18 +17,6 @@ import {
   RedirectStatus,
 } from "./HttpStatusCode";
 
-export type BrandedDataFunction<
-  Failure extends StrongResponse<unknown, NonRedirectStatus>,
-  Success extends StrongResponse<unknown, NonRedirectStatus>,
-  Redirect extends StrongRedirect<string, RedirectStatus>,
-> = LoaderFunction & {
-  __brand?: {
-    Failure: Failure;
-    Success: Success;
-    Redirect: Redirect;
-  };
-};
-
 export interface _StrongResponse<T, S extends HttpStatusCode>
   extends ResponseInit {
   data: T;
@@ -63,12 +51,29 @@ export type StrongCallbacks<
   ) => Effect.Effect<never, Failure, Success | Redirect>;
 };
 
+export type StrongLoaderWithCallbacks<
+  Failure extends StrongResponse<unknown, NonRedirectStatus> = never,
+  Success extends StrongResponse<unknown, NonRedirectStatus> = never,
+  Redirect extends StrongRedirect<string, RedirectStatus> = never,
+> = (
+  args: LoaderArgs,
+  callbacks: StrongCallbacks<Failure, Success, Redirect>,
+) => Promise<Effect.Effect<never, Failure, Success | Redirect>>;
+
 export type StrongLoader<
   Failure extends StrongResponse<unknown, NonRedirectStatus> = never,
   Success extends StrongResponse<unknown, NonRedirectStatus> = never,
   Redirect extends StrongRedirect<string, RedirectStatus> = never,
 > = (
   args: LoaderArgs,
+) => Promise<Effect.Effect<never, Failure, Success | Redirect>>;
+
+export type StrongActionWithCallbacks<
+  Failure extends StrongResponse<unknown, NonRedirectStatus> = never,
+  Success extends StrongResponse<unknown, NonRedirectStatus> = never,
+  Redirect extends StrongRedirect<string, RedirectStatus> = never,
+> = (
+  args: ActionArgs,
   callbacks: StrongCallbacks<Failure, Success, Redirect>,
 ) => Promise<Effect.Effect<never, Failure, Success | Redirect>>;
 
@@ -78,7 +83,6 @@ export type StrongAction<
   Redirect extends StrongRedirect<string, RedirectStatus> = never,
 > = (
   args: ActionArgs,
-  callbacks: StrongCallbacks<Failure, Success, Redirect>,
 ) => Promise<Effect.Effect<never, Failure, Success | Redirect>>;
 
 export type StrongComponent<
@@ -98,8 +102,8 @@ export type BuildStrongRemixRouteExportsOpts<
   ActionRedirect extends StrongRedirect<string, RedirectStatus> = never,
 > = {
   routeId: string;
-  loader?: BrandedDataFunction<LoaderFailure, LoaderSuccess, LoaderRedirect>;
-  action?: BrandedDataFunction<ActionFailure, ActionSuccess, ActionRedirect>;
+  loader?: StrongLoader<LoaderFailure, LoaderSuccess, LoaderRedirect>;
+  action?: StrongAction<ActionFailure, ActionSuccess, ActionRedirect>;
   Component?: StrongComponent<LoaderSuccess>;
   ErrorBoundary?: StrongErrorBoundary<LoaderFailure | ActionFailure>;
 };