@confect/react 2.0.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @confect/react
 
+## 3.0.0
+
+### Minor Changes
+
+- 5fb6a61: Add support for plain Convex functions. Plain Convex queries, mutations, and actions can now be included in your Confect spec and impl tree using new `FunctionSpec.convexPublic*` and `FunctionSpec.convexInternal*` constructors. This enables interop with Convex components and libraries (such as Workpool, Workflow, Migrations, and Better Auth) that require user-defined or -provided Convex functions.
+
+### Patch Changes
+
+- Updated dependencies [5fb6a61]
+  - @confect/core@3.0.0
+
 ## 2.0.0
 
 ### Major Changes

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { Ref } from "@confect/core";
 
 //#region src/index.d.ts
-declare const useQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, args: Ref.Args<Query>["Type"]) => Ref.Returns<Query>["Type"] | undefined;
-declare const useMutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation) => (args: Ref.Args<Mutation>["Type"]) => Promise<Ref.Returns<Mutation>["Type"]>;
-declare const useAction: <Action extends Ref.AnyPublicAction>(ref: Action) => (args: Ref.Args<Action>["Type"]) => Promise<Ref.Returns<Action>["Type"]>;
+declare const useQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, args: Ref.Args<Query>) => Ref.Returns<Query> | undefined;
+declare const useMutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation) => (args: Ref.Args<Mutation>) => Promise<Ref.Returns<Mutation>>;
+declare const useAction: <Action extends Ref.AnyPublicAction>(ref: Action) => (args: Ref.Args<Action>) => Promise<Ref.Returns<Action>>;
 //#endregion
 export { useAction, useMutation, useQuery };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;cAQa,QAAA,iBAA0B,GAAA,CAAI,cAAA,EACzC,GAAA,EAAK,KAAA,EACL,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,KAAA,cACd,GAAA,CAAI,OAAA,CAAQ,KAAA;AAAA,cAkBF,WAAA,oBAAgC,GAAA,CAAI,iBAAA,EAC/C,GAAA,EAAK,QAAA,MAOH,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,QAAA,cACd,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,QAAA;AAAA,cAOZ,SAAA,kBAA4B,GAAA,CAAI,eAAA,EAAiB,GAAA,EAAK,MAAA,MAM/D,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,MAAA,cACd,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,MAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;cAQa,QAAA,iBAA0B,GAAA,CAAI,cAAA,EACzC,GAAA,EAAK,KAAA,EACL,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,KAAA,MACd,GAAA,CAAI,OAAA,CAAQ,KAAA;AAAA,cA4BF,WAAA,oBAAgC,GAAA,CAAI,iBAAA,EAC/C,GAAA,EAAK,QAAA,MAMG,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,QAAA,MAAY,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,QAAA;AAAA,cAa5C,SAAA,kBAA4B,GAAA,CAAI,eAAA,EAAiB,GAAA,EAAK,MAAA,MAKzD,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,MAAA,MAAU,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,MAAA"}

package/dist/index.js

@@ -1,29 +1,27 @@
 import { Ref } from "@confect/core";
 import { useAction as useAction$1, useMutation as useMutation$1, useQuery as useQuery$1 } from "convex/react";
-import { Schema } from "effect";
+import { Match, Schema } from "effect";
 
 //#region src/index.ts
 const useQuery = (ref, args) => {
-	const function_ = Ref.getFunction(ref);
-	const encodedReturnsOrUndefined = useQuery$1(Ref.getConvexFunctionName(ref), Schema.encodeSync(function_.args)(args));
+	const functionSpec = Ref.getFunctionSpec(ref);
+	const encodedReturnsOrUndefined = useQuery$1(Ref.getConvexFunctionName(ref), Match.value(functionSpec.functionProvenance).pipe(Match.tag("Confect", (confect) => Schema.encodeSync(confect.args)(args)), Match.tag("Convex", () => args), Match.exhaustive));
 	if (encodedReturnsOrUndefined === void 0) return;
-	else return Schema.decodeSync(function_.returns)(encodedReturnsOrUndefined);
+	return Match.value(functionSpec.functionProvenance).pipe(Match.tag("Confect", (confect) => Schema.decodeSync(confect.returns)(encodedReturnsOrUndefined)), Match.tag("Convex", () => encodedReturnsOrUndefined), Match.exhaustive);
 };
 const useMutation = (ref) => {
-	const function_ = Ref.getFunction(ref);
+	const functionSpec = Ref.getFunctionSpec(ref);
 	const actualMutation = useMutation$1(Ref.getConvexFunctionName(ref));
-	return async (args) => {
-		const actualReturns = await actualMutation(Schema.encodeSync(function_.args)(args));
-		return Schema.decodeSync(function_.returns)(actualReturns);
-	};
+	return (args) => Match.value(functionSpec.functionProvenance).pipe(Match.tag("Confect", (confect) => {
+		return actualMutation(Schema.encodeSync(confect.args)(args)).then((result) => Schema.decodeSync(confect.returns)(result));
+	}), Match.tag("Convex", () => actualMutation(args)), Match.exhaustive);
 };
 const useAction = (ref) => {
-	const function_ = Ref.getFunction(ref);
+	const functionSpec = Ref.getFunctionSpec(ref);
 	const actualAction = useAction$1(Ref.getConvexFunctionName(ref));
-	return async (args) => {
-		const actualReturns = await actualAction(Schema.encodeSync(function_.args)(args));
-		return Schema.decodeSync(function_.returns)(actualReturns);
-	};
+	return (args) => Match.value(functionSpec.functionProvenance).pipe(Match.tag("Confect", (confect) => {
+		return actualAction(Schema.encodeSync(confect.args)(args)).then((result) => Schema.decodeSync(confect.returns)(result));
+	}), Match.tag("Convex", () => actualAction(args)), Match.exhaustive);
 };
 
 //#endregion

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["useConvexQuery","useConvexMutation","useConvexAction"],"sources":["../src/index.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport {\n  useAction as useConvexAction,\n  useMutation as useConvexMutation,\n  useQuery as useConvexQuery,\n} from \"convex/react\";\nimport { Schema } from \"effect\";\n\nexport const useQuery = <Query extends Ref.AnyPublicQuery>(\n  ref: Query,\n  args: Ref.Args<Query>[\"Type\"],\n): Ref.Returns<Query>[\"Type\"] | undefined => {\n  const function_ = Ref.getFunction(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n\n  const encodedArgs = Schema.encodeSync(function_.args)(args);\n\n  const encodedReturnsOrUndefined = useConvexQuery(\n    functionName as any,\n    encodedArgs,\n  );\n\n  if (encodedReturnsOrUndefined === undefined) {\n    return undefined;\n  } else {\n    return Schema.decodeSync(function_.returns)(encodedReturnsOrUndefined);\n  }\n};\n\nexport const useMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n) => {\n  const function_ = Ref.getFunction(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n  const actualMutation = useConvexMutation(functionName as any);\n\n  return async (\n    args: Ref.Args<Mutation>[\"Type\"],\n  ): Promise<Ref.Returns<Mutation>[\"Type\"]> => {\n    const encodedArgs = Schema.encodeSync(function_.args)(args);\n    const actualReturns = await actualMutation(encodedArgs);\n    return Schema.decodeSync(function_.returns)(actualReturns);\n  };\n};\n\nexport const useAction = <Action extends Ref.AnyPublicAction>(ref: Action) => {\n  const function_ = Ref.getFunction(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n  const actualAction = useConvexAction(functionName as any);\n\n  return async (\n    args: Ref.Args<Action>[\"Type\"],\n  ): Promise<Ref.Returns<Action>[\"Type\"]> => {\n    const encodedArgs = Schema.encodeSync(function_.args)(args);\n    const actualReturns = await actualAction(encodedArgs);\n    return Schema.decodeSync(function_.returns)(actualReturns);\n  };\n};\n"],"mappings":";;;;;AAQA,MAAa,YACX,KACA,SAC2C;CAC3C,MAAM,YAAY,IAAI,YAAY,IAAI;CAKtC,MAAM,4BAA4BA,WAJb,IAAI,sBAAsB,IAAI,EAE/B,OAAO,WAAW,UAAU,KAAK,CAAC,KAAK,CAK1D;AAED,KAAI,8BAA8B,OAChC;KAEA,QAAO,OAAO,WAAW,UAAU,QAAQ,CAAC,0BAA0B;;AAI1E,MAAa,eACX,QACG;CACH,MAAM,YAAY,IAAI,YAAY,IAAI;CAEtC,MAAM,iBAAiBC,cADF,IAAI,sBAAsB,IAAI,CACU;AAE7D,QAAO,OACL,SAC2C;EAE3C,MAAM,gBAAgB,MAAM,eADR,OAAO,WAAW,UAAU,KAAK,CAAC,KAAK,CACJ;AACvD,SAAO,OAAO,WAAW,UAAU,QAAQ,CAAC,cAAc;;;AAI9D,MAAa,aAAiD,QAAgB;CAC5E,MAAM,YAAY,IAAI,YAAY,IAAI;CAEtC,MAAM,eAAeC,YADA,IAAI,sBAAsB,IAAI,CACM;AAEzD,QAAO,OACL,SACyC;EAEzC,MAAM,gBAAgB,MAAM,aADR,OAAO,WAAW,UAAU,KAAK,CAAC,KAAK,CACN;AACrD,SAAO,OAAO,WAAW,UAAU,QAAQ,CAAC,cAAc"}
+{"version":3,"file":"index.js","names":["useConvexQuery","useConvexMutation","useConvexAction"],"sources":["../src/index.ts"],"sourcesContent":["import { Ref } from \"@confect/core\";\nimport {\n  useAction as useConvexAction,\n  useMutation as useConvexMutation,\n  useQuery as useConvexQuery,\n} from \"convex/react\";\nimport { Match, Schema } from \"effect\";\n\nexport const useQuery = <Query extends Ref.AnyPublicQuery>(\n  ref: Query,\n  args: Ref.Args<Query>,\n): Ref.Returns<Query> | undefined => {\n  const functionSpec = Ref.getFunctionSpec(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n\n  const encodedArgs = Match.value(functionSpec.functionProvenance).pipe(\n    Match.tag(\"Confect\", (confect) => Schema.encodeSync(confect.args)(args)),\n    Match.tag(\"Convex\", () => args),\n    Match.exhaustive,\n  );\n\n  const encodedReturnsOrUndefined = useConvexQuery(\n    functionName as any,\n    encodedArgs,\n  );\n\n  if (encodedReturnsOrUndefined === undefined) {\n    return undefined;\n  }\n\n  return Match.value(functionSpec.functionProvenance).pipe(\n    Match.tag(\"Confect\", (confect) =>\n      Schema.decodeSync(confect.returns)(encodedReturnsOrUndefined),\n    ),\n    Match.tag(\"Convex\", () => encodedReturnsOrUndefined),\n    Match.exhaustive,\n  );\n};\n\nexport const useMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n) => {\n  const functionSpec = Ref.getFunctionSpec(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n  const actualMutation = useConvexMutation(functionName as any);\n\n  return (args: Ref.Args<Mutation>): Promise<Ref.Returns<Mutation>> =>\n    Match.value(functionSpec.functionProvenance).pipe(\n      Match.tag(\"Confect\", (confect) => {\n        const encodedArgs = Schema.encodeSync(confect.args)(args);\n        return actualMutation(encodedArgs).then((result) =>\n          Schema.decodeSync(confect.returns)(result),\n        );\n      }),\n      Match.tag(\"Convex\", () => actualMutation(args as any)),\n      Match.exhaustive,\n    );\n};\n\nexport const useAction = <Action extends Ref.AnyPublicAction>(ref: Action) => {\n  const functionSpec = Ref.getFunctionSpec(ref);\n  const functionName = Ref.getConvexFunctionName(ref);\n  const actualAction = useConvexAction(functionName as any);\n\n  return (args: Ref.Args<Action>): Promise<Ref.Returns<Action>> =>\n    Match.value(functionSpec.functionProvenance).pipe(\n      Match.tag(\"Confect\", (confect) => {\n        const encodedArgs = Schema.encodeSync(confect.args)(args);\n        return actualAction(encodedArgs).then((result) =>\n          Schema.decodeSync(confect.returns)(result),\n        );\n      }),\n      Match.tag(\"Convex\", () => actualAction(args as any)),\n      Match.exhaustive,\n    );\n};\n"],"mappings":";;;;;AAQA,MAAa,YACX,KACA,SACmC;CACnC,MAAM,eAAe,IAAI,gBAAgB,IAAI;CAS7C,MAAM,4BAA4BA,WARb,IAAI,sBAAsB,IAAI,EAE/B,MAAM,MAAM,aAAa,mBAAmB,CAAC,KAC/D,MAAM,IAAI,YAAY,YAAY,OAAO,WAAW,QAAQ,KAAK,CAAC,KAAK,CAAC,EACxE,MAAM,IAAI,gBAAgB,KAAK,EAC/B,MAAM,WACP,CAKA;AAED,KAAI,8BAA8B,OAChC;AAGF,QAAO,MAAM,MAAM,aAAa,mBAAmB,CAAC,KAClD,MAAM,IAAI,YAAY,YACpB,OAAO,WAAW,QAAQ,QAAQ,CAAC,0BAA0B,CAC9D,EACD,MAAM,IAAI,gBAAgB,0BAA0B,EACpD,MAAM,WACP;;AAGH,MAAa,eACX,QACG;CACH,MAAM,eAAe,IAAI,gBAAgB,IAAI;CAE7C,MAAM,iBAAiBC,cADF,IAAI,sBAAsB,IAAI,CACU;AAE7D,SAAQ,SACN,MAAM,MAAM,aAAa,mBAAmB,CAAC,KAC3C,MAAM,IAAI,YAAY,YAAY;AAEhC,SAAO,eADa,OAAO,WAAW,QAAQ,KAAK,CAAC,KAAK,CACvB,CAAC,MAAM,WACvC,OAAO,WAAW,QAAQ,QAAQ,CAAC,OAAO,CAC3C;GACD,EACF,MAAM,IAAI,gBAAgB,eAAe,KAAY,CAAC,EACtD,MAAM,WACP;;AAGL,MAAa,aAAiD,QAAgB;CAC5E,MAAM,eAAe,IAAI,gBAAgB,IAAI;CAE7C,MAAM,eAAeC,YADA,IAAI,sBAAsB,IAAI,CACM;AAEzD,SAAQ,SACN,MAAM,MAAM,aAAa,mBAAmB,CAAC,KAC3C,MAAM,IAAI,YAAY,YAAY;AAEhC,SAAO,aADa,OAAO,WAAW,QAAQ,KAAK,CAAC,KAAK,CACzB,CAAC,MAAM,WACrC,OAAO,WAAW,QAAQ,QAAQ,CAAC,OAAO,CAC3C;GACD,EACF,MAAM,IAAI,gBAAgB,aAAa,KAAY,CAAC,EACpD,MAAM,WACP"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@confect/react",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Client-side bindings for React apps",
   "repository": {
     "type": "git",
@@ -47,7 +47,7 @@
     "convex": "^1.30.0",
     "effect": "^3.19.16",
     "react": "^18.0.0 || ^19.0.0",
-    "@confect/core": "2.0.0"
+    "@confect/core": "3.0.0"
   },
   "engines": {
     "node": ">=22",

package/src/index.ts

@@ -4,16 +4,20 @@ import {
   useMutation as useConvexMutation,
   useQuery as useConvexQuery,
 } from "convex/react";
-import { Schema } from "effect";
+import { Match, Schema } from "effect";
 
 export const useQuery = <Query extends Ref.AnyPublicQuery>(
   ref: Query,
-  args: Ref.Args<Query>["Type"],
-): Ref.Returns<Query>["Type"] | undefined => {
-  const function_ = Ref.getFunction(ref);
+  args: Ref.Args<Query>,
+): Ref.Returns<Query> | undefined => {
+  const functionSpec = Ref.getFunctionSpec(ref);
   const functionName = Ref.getConvexFunctionName(ref);
 
-  const encodedArgs = Schema.encodeSync(function_.args)(args);
+  const encodedArgs = Match.value(functionSpec.functionProvenance).pipe(
+    Match.tag("Confect", (confect) => Schema.encodeSync(confect.args)(args)),
+    Match.tag("Convex", () => args),
+    Match.exhaustive,
+  );
 
   const encodedReturnsOrUndefined = useConvexQuery(
     functionName as any,
@@ -22,37 +26,51 @@ export const useQuery = <Query extends Ref.AnyPublicQuery>(
 
   if (encodedReturnsOrUndefined === undefined) {
     return undefined;
-  } else {
-    return Schema.decodeSync(function_.returns)(encodedReturnsOrUndefined);
   }
+
+  return Match.value(functionSpec.functionProvenance).pipe(
+    Match.tag("Confect", (confect) =>
+      Schema.decodeSync(confect.returns)(encodedReturnsOrUndefined),
+    ),
+    Match.tag("Convex", () => encodedReturnsOrUndefined),
+    Match.exhaustive,
+  );
 };
 
 export const useMutation = <Mutation extends Ref.AnyPublicMutation>(
   ref: Mutation,
 ) => {
-  const function_ = Ref.getFunction(ref);
+  const functionSpec = Ref.getFunctionSpec(ref);
   const functionName = Ref.getConvexFunctionName(ref);
   const actualMutation = useConvexMutation(functionName as any);
 
-  return async (
-    args: Ref.Args<Mutation>["Type"],
-  ): Promise<Ref.Returns<Mutation>["Type"]> => {
-    const encodedArgs = Schema.encodeSync(function_.args)(args);
-    const actualReturns = await actualMutation(encodedArgs);
-    return Schema.decodeSync(function_.returns)(actualReturns);
-  };
+  return (args: Ref.Args<Mutation>): Promise<Ref.Returns<Mutation>> =>
+    Match.value(functionSpec.functionProvenance).pipe(
+      Match.tag("Confect", (confect) => {
+        const encodedArgs = Schema.encodeSync(confect.args)(args);
+        return actualMutation(encodedArgs).then((result) =>
+          Schema.decodeSync(confect.returns)(result),
+        );
+      }),
+      Match.tag("Convex", () => actualMutation(args as any)),
+      Match.exhaustive,
+    );
 };
 
 export const useAction = <Action extends Ref.AnyPublicAction>(ref: Action) => {
-  const function_ = Ref.getFunction(ref);
+  const functionSpec = Ref.getFunctionSpec(ref);
   const functionName = Ref.getConvexFunctionName(ref);
   const actualAction = useConvexAction(functionName as any);
 
-  return async (
-    args: Ref.Args<Action>["Type"],
-  ): Promise<Ref.Returns<Action>["Type"]> => {
-    const encodedArgs = Schema.encodeSync(function_.args)(args);
-    const actualReturns = await actualAction(encodedArgs);
-    return Schema.decodeSync(function_.returns)(actualReturns);
-  };
+  return (args: Ref.Args<Action>): Promise<Ref.Returns<Action>> =>
+    Match.value(functionSpec.functionProvenance).pipe(
+      Match.tag("Confect", (confect) => {
+        const encodedArgs = Schema.encodeSync(confect.args)(args);
+        return actualAction(encodedArgs).then((result) =>
+          Schema.decodeSync(confect.returns)(result),
+        );
+      }),
+      Match.tag("Convex", () => actualAction(args as any)),
+      Match.exhaustive,
+    );
 };