@convex-dev/rag 0.5.4 → 0.6.0

package/src/component/search.ts

@@ -5,7 +5,6 @@ import { numberedFiltersFromNamedFilters, vNamedFilter } from "./filters.js";
 import { internal } from "./_generated/api.js";
 import {
   vEntry,
-  type Entry,
   vSearchResult,
   type SearchResult,
   type EntryId,
@@ -22,7 +21,7 @@ export const search = action({
     limit: v.number(),
     vectorScoreThreshold: v.optional(v.number()),
     chunkContext: v.optional(
-      v.object({ before: v.number(), after: v.number() })
+      v.object({ before: v.number(), after: v.number() }),
     ),
   },
   returns: v.object({
@@ -31,10 +30,10 @@ export const search = action({
   }),
   handler: async (
     ctx,
-    args
+    args,
   ): Promise<{
     results: SearchResult[];
-    entries: Entry[];
+    entries: Infer<typeof vEntry>[];
   }> => {
     const { modelId, embedding, filters, limit } = args;
     const namespace = await ctx.runQuery(
@@ -44,11 +43,11 @@ export const search = action({
         modelId,
         dimension: embedding.length,
         filterNames: filters.map((f) => f.name),
-      }
+      },
     );
     if (!namespace) {
       console.debug(
-        `No compatible namespace found for ${args.namespace} with model ${args.modelId} and dimension ${embedding.length} and filters ${filters.map((f) => f.name).join(", ")}.`
+        `No compatible namespace found for ${args.namespace} with model ${args.modelId} and dimension ${embedding.length} and filters ${filters.map((f) => f.name).join(", ")}.`,
       );
       return {
         results: [],
@@ -71,20 +70,20 @@ export const search = action({
       {
         embeddingIds: aboveThreshold.map((r) => r._id),
         chunkContext,
-      }
+      },
     );
     return {
       results: ranges
         .map((r, i) => publicSearchResult(r, aboveThreshold[i]._score))
         .filter((r) => r !== null),
-      entries,
+      entries: entries as Infer<typeof vEntry>[],
     };
   },
 });
 
 function publicSearchResult(
   r: Infer<typeof vRangeResult> | null,
-  score: number
+  score: number,
 ): SearchResult | null {
   if (r === null) {
     return null;

package/src/component/setup.test.ts

@@ -3,17 +3,11 @@ import { test } from "vitest";
 import { convexTest } from "convex-test";
 import schema from "./schema.js";
 export const modules = import.meta.glob("./**/*.*s");
-
-// Sorry about everything
-import componentSchema from "../../node_modules/@convex-dev/workpool/src/component/schema.js";
-export { componentSchema };
-export const componentModules = import.meta.glob(
-  "../../node_modules/@convex-dev/workpool/src/component/**/*.ts"
-);
+import workpool from "@convex-dev/workpool/test";
 
 export function initConvexTest() {
   const t = convexTest(schema, modules);
-  t.registerComponent("workpool", componentSchema, componentModules);
+  t.registerComponent("workpool", workpool.schema, workpool.modules);
   return t;
 }
 

package/src/shared.ts

@@ -1,5 +1,11 @@
 import { v } from "convex/values";
-import type { Infer, Validator, Value, VObject } from "convex/values";
+import type {
+  GenericId,
+  Infer,
+  Validator,
+  Value,
+  VObject,
+} from "convex/values";
 import { vNamedFilter, type NamedFilter } from "./component/filters.js";
 import { brandedString } from "convex-helpers/validators";
 import type { FunctionReference } from "convex/server";
@@ -21,7 +27,7 @@ export const vSearchResult = v.object({
     v.object({
       text: v.string(),
       metadata: v.optional(v.record(v.string(), v.any())),
-    })
+    }),
   ),
   startOrder: v.number(),
   score: v.number(),
@@ -32,7 +38,7 @@ export type SearchResult = Infer<typeof vSearchResult>;
 export const vStatus = v.union(
   v.literal("pending"),
   v.literal("ready"),
-  v.literal("replaced")
+  v.literal("replaced"),
 );
 export const vActiveStatus = v.union(v.literal("pending"), v.literal("ready"));
 export type Status = Infer<typeof vStatus>;
@@ -77,10 +83,7 @@ export type VEntry<
 const _1: Entry = {} as Infer<typeof vEntry> & { status: "pending" | "ready" };
 const _2: Infer<typeof vEntry> = {} as Entry;
 
-export const vSearchEntry = v.object({
-  ...vEntry.fields,
-  text: v.string(),
-});
+export const vSearchEntry = v.object({ ...vEntry.fields, text: v.string() });
 
 export type VSearchEntry<
   Filters extends Record<string, Value>,
@@ -95,9 +98,7 @@ export type VSearchEntry<
 export type SearchEntry<
   Filters extends Record<string, Value>,
   Metadata extends Record<string, Value>,
-> = Entry<Filters, Metadata> & {
-  text: string;
-};
+> = Entry<Filters, Metadata> & { text: string };
 
 export type EntryFilter<
   Filters extends Record<string, Value> = Record<string, Value>,
@@ -106,9 +107,7 @@ export type EntryFilter<
 }[keyof Filters & string];
 
 export type Entry<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   Filters extends Record<string, Value> = any,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   Metadata extends Record<string, Value> = any,
 > = {
   /** The entry's id, uniquely identifying the key + contents + namespace etc. */
@@ -136,10 +135,7 @@ export type Entry<
       /** Whether this entry's contents have all been inserted and indexed. */
       status: "pending" | "ready";
     }
-  | {
-      status: "replaced";
-      replacedAt: number;
-    }
+  | { status: "replaced"; replacedAt: number }
 );
 
 export const vChunk = v.object({
@@ -173,8 +169,8 @@ export function vPaginationResult<
       v.union(
         v.literal("SplitRecommended"),
         v.literal("SplitRequired"),
-        v.null()
-      )
+        v.null(),
+      ),
     ),
   });
 }
@@ -182,10 +178,7 @@ export function vPaginationResult<
 export type OnCompleteNamespace = FunctionReference<
   "mutation",
   "internal",
-  {
-    namespace: Namespace;
-    replacedNamespace: Namespace | null;
-  },
+  { namespace: Namespace; replacedNamespace: Namespace | null },
   null,
   string
 >;
@@ -197,32 +190,32 @@ export const vOnCompleteArgs = v.object({
   error: v.optional(v.string()),
 });
 
-export type OnComplete<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type OnCompleteArgs<
   Filters extends Record<string, Value> = any,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   EntryMetadata extends Record<string, Value> = any,
-> = FunctionReference<
+> = {
+  /**
+   * The namespace that the entry belongs to.
+   */
+  namespace: Namespace;
+  /**
+   * The entry that was added.
+   */
+  entry: Entry<Filters, EntryMetadata>;
+  /**
+   * The previous "ready" entry with the same key that was replaced.
+   */
+  replacedEntry: Entry<Filters, EntryMetadata> | undefined;
+  /**
+   * If async generation failed, this is the error.
+   */
+  error: string | undefined;
+};
+
+export type OnComplete = FunctionReference<
   "mutation",
   "internal",
-  {
-    /**
-     * The namespace that the entry belongs to.
-     */
-    namespace: Namespace;
-    /**
-     * The entry that was added.
-     */
-    entry: Entry<Filters, EntryMetadata>;
-    /**
-     * The previous "ready" entry with the same key that was replaced.
-     */
-    replacedEntry: Entry<Filters, EntryMetadata> | undefined;
-    /**
-     * If async generation failed, this is the error.
-     */
-    error: string | undefined;
-  },
+  IdsToStrings<Infer<typeof vOnCompleteArgs>>,
   null
 >;
 
@@ -235,7 +228,7 @@ export const vChunkerArgs = v.object({
 export type ChunkerAction = FunctionReference<
   "action",
   "internal",
-  Infer<typeof vChunkerArgs>,
+  IdsToStrings<Infer<typeof vChunkerArgs>>,
   null
 >;
 
@@ -253,3 +246,12 @@ export function filterNamesContain(existing: string[], args: string[]) {
   }
   return true;
 }
+
+type IdsToStrings<T> =
+  T extends GenericId<string>
+    ? string
+    : T extends (infer U)[]
+      ? IdsToStrings<U>[]
+      : T extends Record<string, Value | undefined>
+        ? { [K in keyof T]: IdsToStrings<T[K]> }
+        : T;

package/src/test.ts

@@ -0,0 +1,20 @@
+/// <reference types="vite/client" />
+import type { TestConvex } from "convex-test";
+import type { GenericSchema, SchemaDefinition } from "convex/server";
+import workpool from "@convex-dev/workpool/test";
+import schema from "./component/schema.js";
+const modules = import.meta.glob("./component/**/*.ts");
+
+/**
+ * Register the component with the test convex instance.
+ * @param t - The test convex instance, e.g. from calling `convexTest`.
+ * @param name - The name of the component, as registered in convex.config.ts.
+ */
+export function register(
+  t: TestConvex<SchemaDefinition<GenericSchema, boolean>>,
+  name: string = "rag",
+) {
+  t.registerComponent(name, schema, modules);
+  workpool.register(t, "workpool");
+}
+export default { register, schema, modules };

package/dist/client/types.d.ts

@@ -1,29 +0,0 @@
-import type { Expand, FunctionReference, GenericActionCtx, GenericDataModel, GenericMutationCtx, GenericQueryCtx, StorageActionWriter, StorageReader } from "convex/server";
-import { type GenericId } from "convex/values";
-import type { Mounts } from "../component/_generated/api.js";
-export type RAGComponent = UseApi<Mounts>;
-export type RunQueryCtx = {
-    runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
-};
-export type RunMutationCtx = {
-    runQuery: GenericMutationCtx<GenericDataModel>["runQuery"];
-    runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
-};
-export type RunActionCtx = {
-    runQuery: GenericActionCtx<GenericDataModel>["runQuery"];
-    runMutation: GenericActionCtx<GenericDataModel>["runMutation"];
-    runAction: GenericActionCtx<GenericDataModel>["runAction"];
-};
-export type ActionCtx = RunActionCtx & {
-    storage: StorageActionWriter;
-};
-export type QueryCtx = RunQueryCtx & {
-    storage: StorageReader;
-};
-export type OpaqueIds<T> = T extends GenericId<infer _T> ? string : T extends (infer U)[] ? OpaqueIds<U>[] : T extends ArrayBuffer ? ArrayBuffer : T extends object ? {
-    [K in keyof T]: OpaqueIds<T[K]>;
-} : T;
-export type UseApi<API> = Expand<{
-    [mod in keyof API]: API[mod] extends FunctionReference<infer FType, "public", infer FArgs, infer FReturnType, infer FComponentPath> ? FunctionReference<FType, "internal", OpaqueIds<FArgs>, OpaqueIds<FReturnType>, FComponentPath> : UseApi<API[mod]>;
-}>;
-//# sourceMappingURL=types.d.ts.map

package/dist/client/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,MAAM,EACN,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,aAAa,EACd,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAK7D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAI1C,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IAC3D,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;IACzD,WAAW,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;IAC/D,SAAS,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC,WAAW,CAAC,CAAC;CAC5D,CAAC;AACF,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG;IACrC,OAAO,EAAE,mBAAmB,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,QAAQ,GAAG,WAAW,GAAG;IACnC,OAAO,EAAE,aAAa,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,IACrB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GACzB,MAAM,GACN,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACnB,SAAS,CAAC,CAAC,CAAC,EAAE,GACd,CAAC,SAAS,WAAW,GACnB,WAAW,GACX,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,GACD,CAAC,CAAC;AAEd,MAAM,MAAM,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC;KAC9B,GAAG,IAAI,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,iBAAiB,CACpD,MAAM,KAAK,EACX,QAAQ,EACR,MAAM,KAAK,EACX,MAAM,WAAW,EACjB,MAAM,cAAc,CACrB,GACG,iBAAiB,CACf,KAAK,EACL,UAAU,EACV,SAAS,CAAC,KAAK,CAAC,EAChB,SAAS,CAAC,WAAW,CAAC,EACtB,cAAc,CACf,GACD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACrB,CAAC,CAAC"}

package/dist/client/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/client/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":""}

package/dist/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/src/client/types.ts

@@ -1,69 +0,0 @@
-import type {
-  Expand,
-  FunctionReference,
-  GenericActionCtx,
-  GenericDataModel,
-  GenericMutationCtx,
-  GenericQueryCtx,
-  StorageActionWriter,
-  StorageReader,
-} from "convex/server";
-import { type GenericId } from "convex/values";
-import type { Mounts } from "../component/_generated/api.js";
-
-// UseApi<typeof api> is an alternative that has jump-to-definition but is
-// less stable and reliant on types within the component files, which can cause
-// issues where passing `components.foo` doesn't match the argument
-export type RAGComponent = UseApi<Mounts>;
-
-// Type utils follow
-
-export type RunQueryCtx = {
-  runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
-};
-export type RunMutationCtx = {
-  runQuery: GenericMutationCtx<GenericDataModel>["runQuery"];
-  runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
-};
-export type RunActionCtx = {
-  runQuery: GenericActionCtx<GenericDataModel>["runQuery"];
-  runMutation: GenericActionCtx<GenericDataModel>["runMutation"];
-  runAction: GenericActionCtx<GenericDataModel>["runAction"];
-};
-export type ActionCtx = RunActionCtx & {
-  storage: StorageActionWriter;
-};
-export type QueryCtx = RunQueryCtx & {
-  storage: StorageReader;
-};
-
-export type OpaqueIds<T> =
-  T extends GenericId<infer _T>
-    ? string
-    : T extends (infer U)[]
-      ? OpaqueIds<U>[]
-      : T extends ArrayBuffer
-        ? ArrayBuffer
-        : T extends object
-          ? {
-              [K in keyof T]: OpaqueIds<T[K]>;
-            }
-          : T;
-
-export type UseApi<API> = Expand<{
-  [mod in keyof API]: API[mod] extends FunctionReference<
-    infer FType,
-    "public",
-    infer FArgs,
-    infer FReturnType,
-    infer FComponentPath
-  >
-    ? FunctionReference<
-        FType,
-        "internal",
-        OpaqueIds<FArgs>,
-        OpaqueIds<FReturnType>,
-        FComponentPath
-      >
-    : UseApi<API[mod]>;
-}>;