@hamzasaleemorg/convex-kv 1.0.0

package/README.md

@@ -0,0 +1,108 @@
+# Convex KV
+
+A hierarchical key-value store component for Convex. Supports pseudo-tables, caching, and document storage with ordered keys and automatic expiration.
+
+## Features
+
+- Hierarchical Keys: Array-based paths like `["users", "123", "profile"]`.
+- Ordered Scans: Lexicographical storage for efficient prefix range queries.
+- Time-To-Live (TTL): Optional automatic expiration for keys.
+- Atomic Operations: Operations run in standard Convex transactions.
+- Recursive Deletion: Automatic batching for large prefix clears.
+- Typed Clients: TypeScript generics and optional runtime validation.
+
+## Installation
+
+Create or update `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from "convex/server";
+import convexKv from "@hamzasaleemorg/convex-kv/convex.config.js";
+
+const app = defineApp();
+app.use(convexKv);
+
+export default app;
+```
+
+## Usage
+
+### Client Initialization
+
+```ts
+import { components } from "./_generated/api";
+import { kvClientFactory } from "@hamzasaleemorg/convex-kv";
+
+const kv = kvClientFactory(components.convexKv);
+
+// Create a typed client for a specific prefix
+const store = kv.use<{ name: string }>(["users"]);
+```
+
+### Basic Operations
+
+```ts
+// Store a value with optional TTL (1 hour)
+await store.set(ctx, ["123"], { name: "Alice" }, { ttl: 3600000 });
+
+// Retrieve a value
+const user = await store.get(ctx, ["123"]);
+
+// Check existence
+const exists = await store.has(ctx, ["123"]);
+
+// Delete a key
+await store.delete(ctx, ["123"]);
+```
+
+### Hierarchical Queries
+
+```ts
+// Fetch all entries under a prefix
+const allUsers = await store.getAll(ctx, []);
+
+// Paginate entries
+const page = await store.list(ctx, [], { limit: 10 });
+
+// Recursively delete a sub-tree
+await store.deleteAll(ctx, []);
+```
+
+### Expiration (TTL)
+
+To physically remove expired keys, expose a mutation in your `convex/` folder and schedule it via crons.
+
+```ts
+// convex/my_kv.ts
+import { mutation } from "./_generated/server";
+import { components } from "./_generated/api";
+
+export const vacuum = mutation({
+  handler: async (ctx) => {
+    await ctx.runMutation(components.convexKv.kv.vacuum);
+  },
+});
+
+// convex/crons.ts
+import { cronJobs } from "convex/server";
+import { api } from "./_generated/api";
+
+const crons = cronJobs();
+crons.interval("vacuum", { minutes: 5 }, api.my_kv.vacuum);
+export default crons;
+```
+
+
+## API Reference
+
+### `KeyValueStore<V>`
+
+- `get(ctx, key)`: Returns the value or null if missing/expired.
+- `getWithMetadata(ctx, key)`: Returns the value, metadata, and timestamps.
+- `set(ctx, key, value, options?)`: Stores a value. Options: `ttl`, `expiresAt`, `metadata`.
+- `delete(ctx, key)`: Removes a single key.
+- `has(ctx, key)`: Returns boolean existence.
+- `list(ctx, prefix, options?)`: Paginated scan. Options: `limit`, `cursor`, `includeValues`.
+- `getAll(ctx, prefix, options?)`: Fetch all entries under prefix.
+- `deleteAll(ctx, prefix)`: Batched recursive deletion.
+- `withPrefix(prefix, validator?)`: Creates a scoped sub-store.

package/dist/client/_generated/_ignore.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=_ignore.d.ts.map

package/dist/client/_generated/_ignore.d.ts.map

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

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

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

package/dist/client/index.d.ts

@@ -0,0 +1,129 @@
+import type { GenericMutationCtx, GenericQueryCtx, GenericDataModel } from "convex/server";
+import type { Validator } from "convex/values";
+import type { ComponentApi } from "../component/_generated/component.js";
+/**
+ * Minimal context types required for the client store to execute operations.
+ */
+export type RunQuery = Pick<GenericQueryCtx<GenericDataModel>, "runQuery">;
+export type RunMutation = Pick<GenericMutationCtx<GenericDataModel>, "runMutation">;
+/**
+ * A client for interacting with the hierarchical Key-Value store.
+ *
+ * Supports hierarchical keys (e.g., ["users", "123", "profile"]),
+ * atomic mutations, and prefix-based range queries.
+ *
+ * @template V The type of values stored in this specific instance/prefix.
+ */
+export declare class KeyValueStore<V = any> {
+    private component;
+    private prefix;
+    private options;
+    constructor(component: ComponentApi, prefix?: string[], options?: {
+        validator?: Validator<V, any, any>;
+        /**
+         * Optional internal type metadata for identification or read-time validation.
+         */
+        metadata?: any;
+    });
+    /**
+     * Retrieves the value associated with a specific key path.
+     *
+     * @param ctx Convex Query Context.
+     * @param key The relative key path array.
+     * @returns The stored value, or null if it doesn't exist or is expired.
+     */
+    get(ctx: RunQuery, key: string[]): Promise<V | null>;
+    /**
+     * Retrieves the value along with its internal metadata (timestamps, expiration, etc.).
+     *
+     * @param ctx Convex Query Context.
+     * @param key The relative key path array.
+     * @returns The full entry object or null.
+     */
+    getWithMetadata(ctx: RunQuery, key: string[]): Promise<{
+        key: string[];
+        value: V;
+        metadata?: any;
+        updatedAt: number;
+        expiresAt?: number;
+    } | null>;
+    /**
+     * Stores a value at the specified key path.
+     *
+     * This is an atomic "upsert" operation. If a value already exists at this path,
+     * it will be overwritten.
+     *
+     * @param ctx Convex Mutation Context.
+     * @param key The relative key path array.
+     * @param value The value to store.
+     * @param options.ttl Time-To-Live in milliseconds from now.
+     * @param options.expiresAt Exact Unix timestamp when the key should expire.
+     */
+    set(ctx: RunMutation, key: string[], value: V, options?: {
+        metadata?: any;
+        ttl?: number;
+        expiresAt?: number;
+    }): Promise<void>;
+    /**
+     * Permanently removes a single key from the store.
+     */
+    delete(ctx: RunMutation, key: string[]): Promise<void>;
+    /**
+     * Quickly determines if a key exists without loading its value into memory.
+     * Efficient for existence checks on large blobs.
+     */
+    has(ctx: RunQuery, key: string[]): Promise<boolean>;
+    /**
+     * Scans and returns keys under a specific prefix with pagination support.
+     *
+     * @param options.includeValues If false, only returns keys and metadata (saves bandwidth).
+     * @param options.limit Number of items per page.
+     * @param options.cursor Pagination cursor from a previous call.
+     */
+    list(ctx: RunQuery, prefix: string[], options?: {
+        limit?: number;
+        cursor?: string;
+        includeValues?: boolean;
+    }): Promise<any>;
+    /**
+     * Fetches all entries under a prefix in a single call.
+     * Useful for small-to-medium datasets (up to ~1000 items).
+     */
+    getAll(ctx: RunQuery, prefix: string[], options?: {
+        includeValues?: boolean;
+    }): Promise<any>;
+    /**
+     * Recursively removes all keys under a specific prefix.
+     *
+     * For large hierarchies, this operation is automatically batched
+     * using the Convex scheduler to prevent timeout errors.
+     */
+    deleteAll(ctx: RunMutation, prefix: string[]): Promise<any>;
+    /**
+     * Creates a new scoped client for a specific sub-hierarchy.
+     *
+     * This allows you to treat a prefix like a "table" or "collection".
+     *
+     * @example
+     * const users = kv.withPrefix(["users"]);
+     * await users.get(ctx, ["123"]); // Actually gets ["users", "123"]
+     */
+    withPrefix<SubV = V>(prefix: string[], validator?: Validator<SubV, any, any>): KeyValueStore<SubV>;
+    /** Alias for withPrefix to support various developer naming conventions. */
+    subStore: <SubV = V>(prefix: string[], validator?: Validator<SubV, any, any>) => KeyValueStore<SubV>;
+}
+/**
+ * Creates a client factory that simplifies working with multiple typed prefixes.
+ *
+ * @param component The Convex Component API reference (usually `components.convexKv`).
+ */
+export declare function kvClientFactory(component: ComponentApi): {
+    /**
+     * Initializes a KeyValueStore instance for a specific prefix and type.
+     *
+     * @example
+     * const store = kv.use<{ count: number }>(["analytics"]);
+     */
+    use<V = any>(prefix?: string[], validator?: Validator<V, any, any>): KeyValueStore<V>;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,CAAC;AAC3E,MAAM,MAAM,WAAW,GAAG,IAAI,CAC5B,kBAAkB,CAAC,gBAAgB,CAAC,EACpC,aAAa,CACd,CAAC;AAEF;;;;;;;GAOG;AACH,qBAAa,aAAa,CAAC,CAAC,GAAG,GAAG;IAE9B,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,OAAO;gBAFP,SAAS,EAAE,YAAY,EACvB,MAAM,GAAE,MAAM,EAAO,EACrB,OAAO,GAAE;QACf,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACnC;;WAEG;QACH,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX;IAGR;;;;;;OAMG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAK1D;;;;;;OAMG;IACG,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,CAAC,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAMvJ;;;;;;;;;;;OAWG;IACG,GAAG,CACP,GAAG,EAAE,WAAW,EAChB,GAAG,EAAE,MAAM,EAAE,EACb,KAAK,EAAE,CAAC,EACR,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACjE,OAAO,CAAC,IAAI,CAAC;IAehB;;OAEG;IACG,MAAM,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5D;;;OAGG;IACG,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAMzD;;;;;;OAMG;IACG,IAAI,CACR,GAAG,EAAE,QAAQ,EACb,MAAM,EAAE,MAAM,EAAE,EAChB,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO;IAQ5E;;;OAGG;IACG,MAAM,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO;IAOvF;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE;IAMlD;;;;;;;;OAQG;IACH,UAAU,CAAC,IAAI,GAAG,CAAC,EACjB,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,CAAC,EAAE,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GACpC,aAAa,CAAC,IAAI,CAAC;IAOtB,4EAA4E;IAC5E,QAAQ,GAXG,IAAI,cACL,MAAM,EAAE,cACJ,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,KACpC,aAAa,CAAC,IAAI,CAAC,CAQK;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,YAAY;IAEnD;;;;;OAKG;QACC,CAAC,iBAAgB,MAAM,EAAE,cAAmB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC;EAIzE"}

package/dist/client/index.js

@@ -0,0 +1,153 @@
+/**
+ * A client for interacting with the hierarchical Key-Value store.
+ *
+ * Supports hierarchical keys (e.g., ["users", "123", "profile"]),
+ * atomic mutations, and prefix-based range queries.
+ *
+ * @template V The type of values stored in this specific instance/prefix.
+ */
+export class KeyValueStore {
+    component;
+    prefix;
+    options;
+    constructor(component, prefix = [], options = {}) {
+        this.component = component;
+        this.prefix = prefix;
+        this.options = options;
+    }
+    /**
+     * Retrieves the value associated with a specific key path.
+     *
+     * @param ctx Convex Query Context.
+     * @param key The relative key path array.
+     * @returns The stored value, or null if it doesn't exist or is expired.
+     */
+    async get(ctx, key) {
+        const result = await this.getWithMetadata(ctx, key);
+        return result?.value ?? null;
+    }
+    /**
+     * Retrieves the value along with its internal metadata (timestamps, expiration, etc.).
+     *
+     * @param ctx Convex Query Context.
+     * @param key The relative key path array.
+     * @returns The full entry object or null.
+     */
+    async getWithMetadata(ctx, key) {
+        return (await ctx.runQuery(this.component.kv.get, {
+            key: [...this.prefix, ...key],
+        }));
+    }
+    /**
+     * Stores a value at the specified key path.
+     *
+     * This is an atomic "upsert" operation. If a value already exists at this path,
+     * it will be overwritten.
+     *
+     * @param ctx Convex Mutation Context.
+     * @param key The relative key path array.
+     * @param value The value to store.
+     * @param options.ttl Time-To-Live in milliseconds from now.
+     * @param options.expiresAt Exact Unix timestamp when the key should expire.
+     */
+    async set(ctx, key, value, options = {}) {
+        // Note: If you provided a validator at initialization, it should be checked here.
+        if (this.options.validator) {
+            // In a production environment, you might use a runtime check here.
+        }
+        await ctx.runMutation(this.component.kv.set, {
+            key: [...this.prefix, ...key],
+            value,
+            metadata: options.metadata ?? this.options.metadata,
+            ttl: options.ttl,
+            expiresAt: options.expiresAt,
+        });
+    }
+    /**
+     * Permanently removes a single key from the store.
+     */
+    async delete(ctx, key) {
+        await ctx.runMutation(this.component.kv.remove, {
+            key: [...this.prefix, ...key],
+        });
+    }
+    /**
+     * Quickly determines if a key exists without loading its value into memory.
+     * Efficient for existence checks on large blobs.
+     */
+    async has(ctx, key) {
+        return await ctx.runQuery(this.component.kv.has, {
+            key: [...this.prefix, ...key],
+        });
+    }
+    /**
+     * Scans and returns keys under a specific prefix with pagination support.
+     *
+     * @param options.includeValues If false, only returns keys and metadata (saves bandwidth).
+     * @param options.limit Number of items per page.
+     * @param options.cursor Pagination cursor from a previous call.
+     */
+    async list(ctx, prefix, options = {}) {
+        return await ctx.runQuery(this.component.kv.list, {
+            prefix: [...this.prefix, ...prefix],
+            ...options,
+        });
+    }
+    /**
+     * Fetches all entries under a prefix in a single call.
+     * Useful for small-to-medium datasets (up to ~1000 items).
+     */
+    async getAll(ctx, prefix, options = {}) {
+        return await ctx.runQuery(this.component.kv.getAll, {
+            prefix: [...this.prefix, ...prefix],
+            ...options,
+        });
+    }
+    /**
+     * Recursively removes all keys under a specific prefix.
+     *
+     * For large hierarchies, this operation is automatically batched
+     * using the Convex scheduler to prevent timeout errors.
+     */
+    async deleteAll(ctx, prefix) {
+        return await ctx.runMutation(this.component.kv.deleteAll, {
+            prefix: [...this.prefix, ...prefix],
+        });
+    }
+    /**
+     * Creates a new scoped client for a specific sub-hierarchy.
+     *
+     * This allows you to treat a prefix like a "table" or "collection".
+     *
+     * @example
+     * const users = kv.withPrefix(["users"]);
+     * await users.get(ctx, ["123"]); // Actually gets ["users", "123"]
+     */
+    withPrefix(prefix, validator) {
+        return new KeyValueStore(this.component, [...this.prefix, ...prefix], {
+            validator: validator ?? this.options.validator,
+            metadata: this.options.metadata,
+        });
+    }
+    /** Alias for withPrefix to support various developer naming conventions. */
+    subStore = this.withPrefix;
+}
+/**
+ * Creates a client factory that simplifies working with multiple typed prefixes.
+ *
+ * @param component The Convex Component API reference (usually `components.convexKv`).
+ */
+export function kvClientFactory(component) {
+    return {
+        /**
+         * Initializes a KeyValueStore instance for a specific prefix and type.
+         *
+         * @example
+         * const store = kv.use<{ count: number }>(["analytics"]);
+         */
+        use(prefix = [], validator) {
+            return new KeyValueStore(component, prefix, { validator });
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAkBA;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAEd;IACA;IACA;IAHV,YACU,SAAuB,EACvB,SAAmB,EAAE,EACrB,UAMJ,EAAE;QARE,cAAS,GAAT,SAAS,CAAc;QACvB,WAAM,GAAN,MAAM,CAAe;QACrB,YAAO,GAAP,OAAO,CAMT;IACJ,CAAC;IAEL;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CAAC,GAAa,EAAE,GAAa;QACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACpD,OAAO,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,GAAa,EAAE,GAAa;QAChD,OAAO,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE;YAChD,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC;SAC9B,CAAC,CAA8F,CAAC;IACnG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,GAAG,CACP,GAAgB,EAChB,GAAa,EACb,KAAQ,EACR,UAAgE,EAAE;QAElE,kFAAkF;QAClF,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YAC3B,mEAAmE;QACrE,CAAC;QAED,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE;YAC3C,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC;YAC7B,KAAK;YACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ;YACnD,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,GAAgB,EAAE,GAAa;QAC1C,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE;YAC9C,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAC,GAAa,EAAE,GAAa;QACpC,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE;YAC/C,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,GAAa,EACb,MAAgB,EAChB,UAAwE,EAAE;QAE1E,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE;YAChD,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;YACnC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,GAAa,EAAE,MAAgB,EAAE,UAAuC,EAAE;QACrF,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE;YAClD,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;YACnC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,GAAgB,EAAE,MAAgB;QAChD,OAAO,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE;YACxD,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;SACpC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CACR,MAAgB,EAChB,SAAqC;QAErC,OAAO,IAAI,aAAa,CAAO,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE;YAC1E,SAAS,EAAE,SAAS,IAAK,IAAI,CAAC,OAAO,CAAC,SAAiB;YACvD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;SAChC,CAAC,CAAC;IACL,CAAC;IAED,4EAA4E;IAC5E,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,SAAuB;IACrD,OAAO;QACL;;;;;WAKG;QACH,GAAG,CAAU,SAAmB,EAAE,EAAE,SAAkC;YACpE,OAAO,IAAI,aAAa,CAAI,SAAS,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/component/_generated/api.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import type * as kv from "../kv.js";
+import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
+declare const fullApi: ApiFromModules<{
+    kv: typeof kv;
+}>;
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export declare const api: FilterApi<typeof fullApi, FunctionReference<any, "public">>;
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export declare const internal: FilterApi<typeof fullApi, FunctionReference<any, "internal">>;
+export declare const components: {};
+export {};
+//# sourceMappingURL=api.d.ts.map

package/dist/component/_generated/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAGvB,QAAA,MAAM,OAAO,EAAE,cAAc,CAAC;IAC5B,EAAE,EAAE,OAAO,EAAE,CAAC;CACf,CAAiB,CAAC;AAEnB;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,EAAE,SAAS,CACzB,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,CACjB,CAAC;AAElB;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,SAAS,CAC9B,OAAO,OAAO,EACd,iBAAiB,CAAC,GAAG,EAAE,UAAU,CAAC,CACnB,CAAC;AAElB,eAAO,MAAM,UAAU,EAAqC,EAAE,CAAC"}

package/dist/component/_generated/api.js

@@ -0,0 +1,31 @@
+/* eslint-disable */
+/**
+ * Generated `api` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import { anyApi, componentsGeneric } from "convex/server";
+const fullApi = anyApi;
+/**
+ * A utility for referencing Convex functions in your app's public API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = api.myModule.myFunction;
+ * ```
+ */
+export const api = anyApi;
+/**
+ * A utility for referencing Convex functions in your app's internal API.
+ *
+ * Usage:
+ * ```js
+ * const myFunctionReference = internal.myModule.myFunction;
+ * ```
+ */
+export const internal = anyApi;
+export const components = componentsGeneric();
+//# sourceMappingURL=api.js.map

package/dist/component/_generated/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/component/_generated/api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AASH,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE1D,MAAM,OAAO,GAER,MAAa,CAAC;AAEnB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAGZ,MAAa,CAAC;AAElB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAGjB,MAAa,CAAC;AAElB,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,EAAmB,CAAC"}

package/dist/component/_generated/component.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Generated `ComponentApi` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import type { FunctionReference } from "convex/server";
+/**
+ * A utility for referencing a Convex component's exposed API.
+ *
+ * Useful when expecting a parameter like `components.myComponent`.
+ * Usage:
+ * ```ts
+ * async function myFunction(ctx: QueryCtx, component: ComponentApi) {
+ *   return ctx.runQuery(component.someFile.someQuery, { ...args });
+ * }
+ * ```
+ */
+export type ComponentApi<Name extends string | undefined = string | undefined> = {
+    kv: {
+        deleteAll: FunctionReference<"mutation", "internal", {
+            prefix: Array<string>;
+        }, any, Name>;
+        get: FunctionReference<"query", "internal", {
+            key: Array<string>;
+        }, null | {
+            expiresAt?: number;
+            key: Array<string>;
+            metadata?: any;
+            updatedAt: number;
+            value: any;
+        }, Name>;
+        getAll: FunctionReference<"query", "internal", {
+            includeValues?: boolean;
+            prefix: Array<string>;
+        }, any, Name>;
+        has: FunctionReference<"query", "internal", {
+            key: Array<string>;
+        }, boolean, Name>;
+        list: FunctionReference<"query", "internal", {
+            cursor?: string;
+            includeValues?: boolean;
+            limit?: number;
+            prefix: Array<string>;
+        }, any, Name>;
+        remove: FunctionReference<"mutation", "internal", {
+            key: Array<string>;
+        }, null, Name>;
+        set: FunctionReference<"mutation", "internal", {
+            expiresAt?: number;
+            key: Array<string>;
+            metadata?: any;
+            ttl?: number;
+            value: any;
+        }, null, Name>;
+        vacuum: FunctionReference<"mutation", "internal", {}, any, Name>;
+    };
+};
+//# sourceMappingURL=component.d.ts.map

package/dist/component/_generated/component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/component.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,IAC3E;IACE,EAAE,EAAE;QACF,SAAS,EAAE,iBAAiB,CAC1B,UAAU,EACV,UAAU,EACV;YAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACzB,GAAG,EACH,IAAI,CACL,CAAC;QACF,GAAG,EAAE,iBAAiB,CACpB,OAAO,EACP,UAAU,EACV;YAAE,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACtB,IAAI,GAAG;YACL,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;YACf,SAAS,EAAE,MAAM,CAAC;YAClB,KAAK,EAAE,GAAG,CAAC;SACZ,EACD,IAAI,CACL,CAAC;QACF,MAAM,EAAE,iBAAiB,CACvB,OAAO,EACP,UAAU,EACV;YAAE,aAAa,CAAC,EAAE,OAAO,CAAC;YAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EAClD,GAAG,EACH,IAAI,CACL,CAAC;QACF,GAAG,EAAE,iBAAiB,CACpB,OAAO,EACP,UAAU,EACV;YAAE,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACtB,OAAO,EACP,IAAI,CACL,CAAC;QACF,IAAI,EAAE,iBAAiB,CACrB,OAAO,EACP,UAAU,EACV;YACE,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACvB,EACD,GAAG,EACH,IAAI,CACL,CAAC;QACF,MAAM,EAAE,iBAAiB,CACvB,UAAU,EACV,UAAU,EACV;YAAE,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,EACtB,IAAI,EACJ,IAAI,CACL,CAAC;QACF,GAAG,EAAE,iBAAiB,CACpB,UAAU,EACV,UAAU,EACV;YACE,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;YACf,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,GAAG,CAAC;SACZ,EACD,IAAI,EACJ,IAAI,CACL,CAAC;QACF,MAAM,EAAE,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;KAClE,CAAC;CACH,CAAC"}

package/dist/component/_generated/component.js

@@ -0,0 +1,11 @@
+/* eslint-disable */
+/**
+ * Generated `ComponentApi` utility.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+export {};
+//# sourceMappingURL=component.js.map

package/dist/component/_generated/component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"component.js","sourceRoot":"","sources":["../../../src/component/_generated/component.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG"}

package/dist/component/_generated/dataModel.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Generated data model types.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import type { DataModelFromSchemaDefinition, DocumentByName, TableNamesInDataModel, SystemTableNames } from "convex/server";
+import type { GenericId } from "convex/values";
+import schema from "../schema.js";
+/**
+ * The names of all of your Convex tables.
+ */
+export type TableNames = TableNamesInDataModel<DataModel>;
+/**
+ * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Doc<TableName extends TableNames> = DocumentByName<DataModel, TableName>;
+/**
+ * An identifier for a document in Convex.
+ *
+ * Convex documents are uniquely identified by their `Id`, which is accessible
+ * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
+ *
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
+ *
+ * IDs are just strings at runtime, but this type can be used to distinguish them from other
+ * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
+ */
+export type Id<TableName extends TableNames | SystemTableNames> = GenericId<TableName>;
+/**
+ * A type describing your Convex data model.
+ *
+ * This type includes information about what tables you have, the type of
+ * documents stored in those tables, and the indexes defined on them.
+ *
+ * This type is used to parameterize methods like `queryGeneric` and
+ * `mutationGeneric` to make them type-safe.
+ */
+export type DataModel = DataModelFromSchemaDefinition<typeof schema>;
+//# sourceMappingURL=dataModel.d.ts.map

package/dist/component/_generated/dataModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataModel.d.ts","sourceRoot":"","sources":["../../../src/component/_generated/dataModel.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,6BAA6B,EAC7B,cAAc,EACd,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,MAAM,MAAM,cAAc,CAAC;AAElC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,GAAG,CAAC,SAAS,SAAS,UAAU,IAAI,cAAc,CAC5D,SAAS,EACT,SAAS,CACV,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,EAAE,CAAC,SAAS,SAAS,UAAU,GAAG,gBAAgB,IAC5D,SAAS,CAAC,SAAS,CAAC,CAAC;AAEvB;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,6BAA6B,CAAC,OAAO,MAAM,CAAC,CAAC"}

package/dist/component/_generated/dataModel.js

@@ -0,0 +1,11 @@
+/* eslint-disable */
+/**
+ * Generated data model types.
+ *
+ * THIS CODE IS AUTOMATICALLY GENERATED.
+ *
+ * To regenerate, run `npx convex dev`.
+ * @module
+ */
+import schema from "../schema.js";
+//# sourceMappingURL=dataModel.js.map

package/dist/component/_generated/dataModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataModel.js","sourceRoot":"","sources":["../../../src/component/_generated/dataModel.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AASH,OAAO,MAAM,MAAM,cAAc,CAAC"}