@confect/react 4.0.0 → 6.0.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @confect/react
 
+## 6.0.0
+
+### Minor Changes
+
+- df95ce7: Add `Ref.OptionalArgs` type utility to `@confect/core` for conditionally optional function args. `QueryRunner`, `MutationRunner`, and `ActionRunner` now accept optional args for no-arg Confect functions. `useQuery`, `useMutation`, and `useAction` now accept optional args for no-arg Confect functions. `TestConfect` `query`/`mutation`/`action` helpers now accept optional args for no-arg Confect functions.
+
+### Patch Changes
+
+- Updated dependencies [df95ce7]
+- Updated dependencies [a8083e8]
+  - @confect/core@6.0.0
+
+## 5.0.0
+
+### Minor Changes
+
+- 5ddb437: Support passing `"skip"` as args to `useQuery` to disable query subscription.
+
+### Patch Changes
+
+- @confect/core@5.0.0
+
 ## 4.0.0
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import { Ref } from "@confect/core";
 
 //#region src/index.d.ts
-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>>;
+type UseQueryArgs<Query extends Ref.AnyPublicQuery> = keyof Ref.Args<Query> extends never ? [args?: Ref.Args<Query> | "skip"] : [args: Ref.Args<Query> | "skip"];
+declare const useQuery: <Query extends Ref.AnyPublicQuery>(ref: Query, ...rest: UseQueryArgs<Query>) => Ref.Returns<Query> | undefined;
+declare const useMutation: <Mutation extends Ref.AnyPublicMutation>(ref: Mutation) => (...args: Ref.OptionalArgs<Mutation>) => Promise<Ref.Returns<Mutation>>;
+declare const useAction: <Action extends Ref.AnyPublicAction>(ref: Action) => (...args: Ref.OptionalArgs<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,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"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;KAOK,YAAA,eAA2B,GAAA,CAAI,cAAA,UAC5B,GAAA,CAAI,IAAA,CAAK,KAAA,mBACV,IAAA,GAAO,GAAA,CAAI,IAAA,CAAK,KAAA,eAChB,IAAA,EAAM,GAAA,CAAI,IAAA,CAAK,KAAA;AAAA,cAET,QAAA,iBAA0B,GAAA,CAAI,cAAA,EACzC,GAAA,EAAK,KAAA,KACF,IAAA,EAAM,YAAA,CAAa,KAAA,MACrB,GAAA,CAAI,OAAA,CAAQ,KAAA;AAAA,cAoBF,WAAA,oBAAgC,GAAA,CAAI,iBAAA,EAC/C,GAAA,EAAK,QAAA,SAMA,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,QAAA,MACzB,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,QAAA;AAAA,cAWZ,SAAA,kBAA4B,GAAA,CAAI,eAAA,EAAiB,GAAA,EAAK,MAAA,SAItD,IAAA,EAAM,GAAA,CAAI,YAAA,CAAa,MAAA,MAAU,OAAA,CAAQ,GAAA,CAAI,OAAA,CAAQ,MAAA"}

package/dist/index.js

@@ -1,27 +1,25 @@
 import { Ref } from "@confect/core";
 import { useAction as useAction$1, useMutation as useMutation$1, useQuery as useQuery$1 } from "convex/react";
-import { Match, Schema } from "effect";
 
 //#region src/index.ts
-const useQuery = (ref, 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));
+const useQuery = (ref, ...rest) => {
+	const functionReference = Ref.getFunctionReference(ref);
+	const args = rest[0];
+	const encodedReturnsOrUndefined = useQuery$1(functionReference, args === "skip" ? "skip" : Ref.encodeArgsSync(ref, args ?? {}));
 	if (encodedReturnsOrUndefined === void 0) return;
-	return Match.value(functionSpec.functionProvenance).pipe(Match.tag("Confect", (confect) => Schema.decodeSync(confect.returns)(encodedReturnsOrUndefined)), Match.tag("Convex", () => encodedReturnsOrUndefined), Match.exhaustive);
+	return Ref.decodeReturnsSync(ref, encodedReturnsOrUndefined);
 };
 const useMutation = (ref) => {
-	const functionSpec = Ref.getFunctionSpec(ref);
-	const actualMutation = useMutation$1(Ref.getConvexFunctionName(ref));
-	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 actualMutation = useMutation$1(Ref.getFunctionReference(ref));
+	return (...args) => {
+		return actualMutation(Ref.encodeArgsSync(ref, args[0] ?? {})).then((result) => Ref.decodeReturnsSync(ref, result));
+	};
 };
 const useAction = (ref) => {
-	const functionSpec = Ref.getFunctionSpec(ref);
-	const actualAction = useAction$1(Ref.getConvexFunctionName(ref));
-	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);
+	const actualAction = useAction$1(Ref.getFunctionReference(ref));
+	return (...args) => {
+		return actualAction(Ref.encodeArgsSync(ref, args[0] ?? {})).then((result) => Ref.decodeReturnsSync(ref, result));
+	};
 };
 
 //#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 { 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"}
+{"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\";\n\ntype UseQueryArgs<Query extends Ref.AnyPublicQuery> =\n  keyof Ref.Args<Query> extends never\n    ? [args?: Ref.Args<Query> | \"skip\"]\n    : [args: Ref.Args<Query> | \"skip\"];\n\nexport const useQuery = <Query extends Ref.AnyPublicQuery>(\n  ref: Query,\n  ...rest: UseQueryArgs<Query>\n): Ref.Returns<Query> | undefined => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const args = rest[0];\n  const encodedArgs =\n    args === \"skip\"\n      ? \"skip\"\n      : Ref.encodeArgsSync(ref, (args ?? {}) as Ref.Args<Query>);\n\n  const encodedReturnsOrUndefined = useConvexQuery(\n    functionReference,\n    encodedArgs,\n  );\n\n  if (encodedReturnsOrUndefined === undefined) {\n    return undefined;\n  }\n\n  return Ref.decodeReturnsSync(ref, encodedReturnsOrUndefined);\n};\n\nexport const useMutation = <Mutation extends Ref.AnyPublicMutation>(\n  ref: Mutation,\n) => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const actualMutation = useConvexMutation(functionReference);\n\n  return (\n    ...args: Ref.OptionalArgs<Mutation>\n  ): Promise<Ref.Returns<Mutation>> => {\n    const encodedArgs = Ref.encodeArgsSync(\n      ref,\n      (args[0] ?? {}) as Ref.Args<Mutation>,\n    );\n    return actualMutation(encodedArgs).then((result) =>\n      Ref.decodeReturnsSync(ref, result),\n    );\n  };\n};\n\nexport const useAction = <Action extends Ref.AnyPublicAction>(ref: Action) => {\n  const functionReference = Ref.getFunctionReference(ref);\n  const actualAction = useConvexAction(functionReference);\n\n  return (...args: Ref.OptionalArgs<Action>): Promise<Ref.Returns<Action>> => {\n    const encodedArgs = Ref.encodeArgsSync(\n      ref,\n      (args[0] ?? {}) as Ref.Args<Action>,\n    );\n    return actualAction(encodedArgs).then((result) =>\n      Ref.decodeReturnsSync(ref, result),\n    );\n  };\n};\n"],"mappings":";;;;AAYA,MAAa,YACX,KACA,GAAG,SACgC;CACnC,MAAM,oBAAoB,IAAI,qBAAqB,IAAI;CACvD,MAAM,OAAO,KAAK;CAMlB,MAAM,4BAA4BA,WAChC,mBALA,SAAS,SACL,SACA,IAAI,eAAe,KAAM,QAAQ,EAAE,CAAqB,CAK7D;AAED,KAAI,8BAA8B,OAChC;AAGF,QAAO,IAAI,kBAAkB,KAAK,0BAA0B;;AAG9D,MAAa,eACX,QACG;CAEH,MAAM,iBAAiBC,cADG,IAAI,qBAAqB,IAAI,CACI;AAE3D,SACE,GAAG,SACgC;AAKnC,SAAO,eAJa,IAAI,eACtB,KACC,KAAK,MAAM,EAAE,CACf,CACiC,CAAC,MAAM,WACvC,IAAI,kBAAkB,KAAK,OAAO,CACnC;;;AAIL,MAAa,aAAiD,QAAgB;CAE5E,MAAM,eAAeC,YADK,IAAI,qBAAqB,IAAI,CACA;AAEvD,SAAQ,GAAG,SAAiE;AAK1E,SAAO,aAJa,IAAI,eACtB,KACC,KAAK,MAAM,EAAE,CACf,CAC+B,CAAC,MAAM,WACrC,IAAI,kBAAkB,KAAK,OAAO,CACnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@confect/react",
-  "version": "4.0.0",
+  "version": "6.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": "4.0.0"
+    "@confect/core": "6.0.0"
   },
   "engines": {
     "node": ">=22",

package/src/index.ts

@@ -4,23 +4,25 @@ import {
   useMutation as useConvexMutation,
   useQuery as useConvexQuery,
 } from "convex/react";
-import { Match, Schema } from "effect";
+
+type UseQueryArgs<Query extends Ref.AnyPublicQuery> =
+  keyof Ref.Args<Query> extends never
+    ? [args?: Ref.Args<Query> | "skip"]
+    : [args: Ref.Args<Query> | "skip"];
 
 export const useQuery = <Query extends Ref.AnyPublicQuery>(
   ref: Query,
-  args: Ref.Args<Query>,
+  ...rest: UseQueryArgs<Query>
 ): Ref.Returns<Query> | undefined => {
-  const functionSpec = Ref.getFunctionSpec(ref);
-  const functionName = Ref.getConvexFunctionName(ref);
-
-  const encodedArgs = Match.value(functionSpec.functionProvenance).pipe(
-    Match.tag("Confect", (confect) => Schema.encodeSync(confect.args)(args)),
-    Match.tag("Convex", () => args),
-    Match.exhaustive,
-  );
+  const functionReference = Ref.getFunctionReference(ref);
+  const args = rest[0];
+  const encodedArgs =
+    args === "skip"
+      ? "skip"
+      : Ref.encodeArgsSync(ref, (args ?? {}) as Ref.Args<Query>);
 
   const encodedReturnsOrUndefined = useConvexQuery(
-    functionName as any,
+    functionReference,
     encodedArgs,
   );
 
@@ -28,49 +30,39 @@ export const useQuery = <Query extends Ref.AnyPublicQuery>(
     return undefined;
   }
 
-  return Match.value(functionSpec.functionProvenance).pipe(
-    Match.tag("Confect", (confect) =>
-      Schema.decodeSync(confect.returns)(encodedReturnsOrUndefined),
-    ),
-    Match.tag("Convex", () => encodedReturnsOrUndefined),
-    Match.exhaustive,
-  );
+  return Ref.decodeReturnsSync(ref, encodedReturnsOrUndefined);
 };
 
 export const useMutation = <Mutation extends Ref.AnyPublicMutation>(
   ref: Mutation,
 ) => {
-  const functionSpec = Ref.getFunctionSpec(ref);
-  const functionName = Ref.getConvexFunctionName(ref);
-  const actualMutation = useConvexMutation(functionName as any);
+  const functionReference = Ref.getFunctionReference(ref);
+  const actualMutation = useConvexMutation(functionReference);
 
-  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,
+  return (
+    ...args: Ref.OptionalArgs<Mutation>
+  ): Promise<Ref.Returns<Mutation>> => {
+    const encodedArgs = Ref.encodeArgsSync(
+      ref,
+      (args[0] ?? {}) as Ref.Args<Mutation>,
+    );
+    return actualMutation(encodedArgs).then((result) =>
+      Ref.decodeReturnsSync(ref, result),
     );
+  };
 };
 
 export const useAction = <Action extends Ref.AnyPublicAction>(ref: Action) => {
-  const functionSpec = Ref.getFunctionSpec(ref);
-  const functionName = Ref.getConvexFunctionName(ref);
-  const actualAction = useConvexAction(functionName as any);
+  const functionReference = Ref.getFunctionReference(ref);
+  const actualAction = useConvexAction(functionReference);
 
-  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,
+  return (...args: Ref.OptionalArgs<Action>): Promise<Ref.Returns<Action>> => {
+    const encodedArgs = Ref.encodeArgsSync(
+      ref,
+      (args[0] ?? {}) as Ref.Args<Action>,
+    );
+    return actualAction(encodedArgs).then((result) =>
+      Ref.decodeReturnsSync(ref, result),
     );
+  };
 };