@convex-dev/sharded-counter 0.1.8 → 0.2.1

package/README.md

@@ -4,8 +4,8 @@
 
 <!-- START: Include on https://convex.dev/components -->
 
-This component adds counters to Convex. It acts as a key-value store from
-string to number, with sharding to increase throughput when updating values.
+This component adds counters to Convex. It acts as a key-value store from string
+to number, with sharding to increase throughput when updating values.
 
 Since it's built on Convex, everything is automatically consistent, reactive,
 and cached. Since it's built with [Components](https://convex.dev/components),
@@ -18,8 +18,8 @@ For example, if you want to display
 count the checkboxes in real-time while allowing a lot of the boxes to change in
 parallel.
 
-More generally, whenever you have a counter that is changing frequently, you
-can use this component to keep track of it efficiently.
+More generally, whenever you have a counter that is changing frequently, you can
+use this component to keep track of it efficiently.
 
 ```ts
 export const checkBox = mutation({
@@ -46,16 +46,17 @@ export const getCount = query({
 ```
 
 This relies on the assumption that you need to frequently modify the counter,
-but only need to read its value from a query, or infrequently in a mutation.
-If you read the count every time you modify it, you lose the sharding benefit.
+but only need to read its value from a query, or infrequently in a mutation. If
+you read the count every time you modify it, you lose the sharding benefit.
 
 ## Pre-requisite: Convex
 
-You'll need an existing Convex project to use the component.
-Convex is a hosted backend platform, including a database, serverless functions,
-and a ton more you can learn about [here](https://docs.convex.dev/get-started).
+You'll need an existing Convex project to use the component. Convex is a hosted
+backend platform, including a database, serverless functions, and a ton more you
+can learn about [here](https://docs.convex.dev/get-started).
 
-Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+Run `npm create convex` or follow any of the
+[quickstarts](https://docs.convex.dev/home) to set one up.
 
 ## Installation
 
@@ -65,13 +66,13 @@ First, install the component package:
 npm install @convex-dev/sharded-counter
 ```
 
-Then, create a `convex.config.ts` file in your app's `convex/` folder and install the
-component by calling `use`:
+Then, create a `convex.config.ts` file in your app's `convex/` folder and
+install the component by calling `use`:
 
 ```ts
 // convex/convex.config.ts
 import { defineApp } from "convex/server";
-import shardedCounter from "@convex-dev/sharded-counter/convex.config";
+import shardedCounter from "@convex-dev/sharded-counter/convex.config.js";
 
 const app = defineApp();
 app.use(shardedCounter);
@@ -79,8 +80,8 @@ app.use(shardedCounter);
 export default app;
 ```
 
-Finally, create a new `ShardedCounter` within your `convex/` folder, and point it to
-the installed component.
+Finally, create a new `ShardedCounter` within your `convex/` folder, and point
+it to the installed component.
 
 ```ts
 import { components } from "./_generated/api";
@@ -156,7 +157,7 @@ friends for each user, and you don't care about throughput for a single user,
 you would declare ShardedCounter like so:
 
 ```ts
-const friendCounts = new ShardedCounter<Record<Id<"users">, number>>(
+const friendCounts = new ShardedCounter<Id<"users">>(
   components.shardedCounter,
   { defaultShards: 1 },
 );
@@ -175,8 +176,8 @@ to get an accurate count. This takes a read dependency on all shard documents.
 - In a mutation, that means any modification to the counter causes an
   [OCC](https://docs.convex.dev/error#1) conflict.
 
-You can reduce contention by estimating the count: read from a smaller number
-of shards and extrapolate based on the total number of shards.
+You can reduce contention by estimating the count: read from a smaller number of
+shards and extrapolate based on the total number of shards.
 
 ```ts
 const estimatedCheckboxCount = await counter.estimateCount(ctx, "checkboxes");
@@ -190,9 +191,9 @@ from more shards, at the cost of more contention:
 const estimateFromThree = await counter.estimateCount(ctx, "checkboxes", 3);
 ```
 
-If the counter was accumulated from many
-small `counter.inc` and `counter.dec` calls, then they should be uniformly
-distributed across the shards, so estimated counts will be accurate.
+If the counter was accumulated from many small `counter.inc` and `counter.dec`
+calls, then they should be uniformly distributed across the shards, so estimated
+counts will be accurate.
 
 In some cases the counter will not be evenly distributed:
 
@@ -201,8 +202,8 @@ In some cases the counter will not be evenly distributed:
   values, because each operation only changes a single shard
 - If the number of shards changed
 
-In these cases, the count might not be evenly distributed across the shards.
-To repair such cases, you can call:
+In these cases, the count might not be evenly distributed across the shards. To
+repair such cases, you can call:
 
 ```ts
 await counter.rebalance(ctx, "checkboxes");
@@ -211,23 +212,21 @@ await counter.rebalance(ctx, "checkboxes");
 Which will even out the count across shards.
 
 You may change the number of shards for a key, by changing the second argument
-to the `ShardedCounter` constructor. If you decrease the number of shards,
-you will be left with extra shards that won't be written to but are still
-read when computing `count`.
-In this case, you should call `counter.rebalance` to delete
+to the `ShardedCounter` constructor. If you decrease the number of shards, you
+will be left with extra shards that won't be written to but are still read when
+computing `count`. In this case, you should call `counter.rebalance` to delete
 the extraneous shards.
 
-NOTE: `counter.rebalance` reads and writes all shards, so it could cause
-more OCCs, and it's recommended you call it sparingly, from the Convex dashboard
-or from an infrequent cron.
+NOTE: `counter.rebalance` reads and writes all shards, so it could cause more
+OCCs, and it's recommended you call it sparingly, from the Convex dashboard or
+from an infrequent cron.
 
-NOTE: counts are floats, and floating point arithmetic isn't infinitely
-precise. Even if you always add and subtract integers, you may get a fractional
-counts, especially if you use `estimateCount` or `rebalance`.
-Values distributed across shards may be added in different combinations, and
+NOTE: counts are floats, and floating point arithmetic isn't infinitely precise.
+Even if you always add and subtract integers, you may get a fractional counts,
+especially if you use `estimateCount` or `rebalance`. Values distributed across
+shards may be added in different combinations, and
 [floating point arithmetic isn't associative](https://docs.oracle.com/cd/E19957-01/806-3568/ncg_goldberg.html).
-You can use `Math.round` to ensure your final count is an integer, if
-desired.
+You can use `Math.round` to ensure your final count is an integer, if desired.
 
 ## Counting documents in a table
 
@@ -262,8 +261,7 @@ async function insertUser(ctx, user) {
 ```
 
 3. Register a [Trigger](https://www.npmjs.com/package/convex-helpers#triggers),
-   which automatically runs code when a mutation changes the
-   data in a table.
+   which automatically runs code when a mutation changes the data in a table.
 
 ```ts
 // Triggers hook up writes to the table to the ShardedCounter.
@@ -312,9 +310,9 @@ Walkthrough of steps:
 2. Create a new document in this table, with fields
    `{ creationTime: 0, id: "", isDone: false }`
 3. Wherever you want to update a counter based on a document changing, wrap the
-   update in a conditional, so it only gets updated if the backfill has processed
-   that document. In the example, you would be changing `insertUserBeforeBackfill`
-   to be implemented as `insertUserDuringBackfill`.
+   update in a conditional, so it only gets updated if the backfill has
+   processed that document. In the example, you would be changing
+   `insertUserBeforeBackfill` to be implemented as `insertUserDuringBackfill`.
 4. Define backfill functions similar to `backfillUsers` and `backfillUsersBatch`
 5. Call `backfillUsersBatch` from the dashboard.
 6. Remove the conditional when updating counters. In the example, you would be

package/dist/{commonjs/client → client}/index.d.ts

@@ -1,6 +1,6 @@
-import { DocumentByName, Expand, FunctionReference, GenericDataModel, GenericMutationCtx, GenericQueryCtx, TableNamesInDataModel } from "convex/server";
-import { GenericId } from "convex/values";
-import { api } from "../component/_generated/api";
+import type { DocumentByName, GenericActionCtx, GenericDataModel, GenericMutationCtx, GenericQueryCtx, TableNamesInDataModel } from "convex/server";
+import type { GenericId } from "convex/values";
+import type { ComponentApi } from "../component/_generated/component.js";
 /**
  * A sharded counter is a map from string -> counter, where each counter can
  * be incremented or decremented atomically.
@@ -22,7 +22,7 @@ export declare class ShardedCounter<ShardsKey extends string> {
      * @param options.defaultShards The number of shards for each counter, for
      *   keys not in `options.shards`.
      */
-    constructor(component: UseApi<typeof api>, options?: {
+    constructor(component: ComponentApi, options?: {
         shards?: Partial<Record<ShardsKey, number>>;
         defaultShards?: number;
     });
@@ -35,26 +35,26 @@ export declare class ShardedCounter<ShardsKey extends string> {
      * @param name The key to update the counter for.
      * @param count The amount to increment the counter by. Defaults to 1.
      */
-    add<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name, count?: number): Promise<void>;
+    add<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name, count?: number): Promise<void>;
     /**
      * Decrease the counter for key `name` by `count`.
      */
-    subtract<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name, count?: number): Promise<void>;
+    subtract<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name, count?: number): Promise<void>;
     /**
      * Increment the counter for key `name` by 1.
      */
-    inc<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name): Promise<void>;
+    inc<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name): Promise<void>;
     /**
      * Decrement the counter for key `name` by 1.
      */
-    dec<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name): Promise<void>;
+    dec<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name): Promise<void>;
     /**
      * Gets the counter for key `name`.
      *
      * NOTE: this reads from all shards. If used in a mutation, it will contend
      * with all mutations that update the counter for this key.
      */
-    count<Name extends ShardsKey>(ctx: RunQueryCtx, name: Name): Promise<number>;
+    count<Name extends ShardsKey>(ctx: QueryCtx | MutationCtx | ActionCtx, name: Name): Promise<number>;
     /**
      * Redistribute counts evenly across the counter's shards.
      *
@@ -67,13 +67,13 @@ export declare class ShardedCounter<ShardsKey extends string> {
      * This operation reads and writes all shards, so it can cause contention if
      * called too often.
      */
-    rebalance<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name): Promise<void>;
+    rebalance<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name): Promise<void>;
     /**
      * Clear the counter for key `name`.
      *
      * @param name The key to clear the counter for.
      */
-    reset<Name extends ShardsKey>(ctx: RunMutationCtx, name: Name): Promise<void>;
+    reset<Name extends ShardsKey>(ctx: MutationCtx | ActionCtx, name: Name): Promise<void>;
     /**
      * Estimate the count of a counter by only reading from a subset of shards,
      * and extrapolating the total count.
@@ -85,7 +85,7 @@ export declare class ShardedCounter<ShardsKey extends string> {
      *
      * Use this to reduce contention when reading the counter.
      */
-    estimateCount<Name extends ShardsKey>(ctx: RunQueryCtx, name: Name, readFromShards?: number): Promise<number>;
+    estimateCount<Name extends ShardsKey>(ctx: QueryCtx | MutationCtx | ActionCtx, name: Name, readFromShards?: number): Promise<any>;
     /**
      * Returns an object with methods to update and query the counter for key
      * `name`. For fixed keys, you can call `counter.for("<key>")` to get methods
@@ -105,46 +105,46 @@ export declare class ShardedCounter<ShardsKey extends string> {
         /**
          * Add `count` to the counter.
          */
-        add: (ctx: RunMutationCtx, count?: number) => Promise<void>;
+        add: (ctx: MutationCtx | ActionCtx, count?: number) => Promise<void>;
         /**
          * Subtract `count` from the counter.
          */
-        subtract: (ctx: RunMutationCtx, count?: number) => Promise<void>;
+        subtract: (ctx: MutationCtx | ActionCtx, count?: number) => Promise<void>;
         /**
          * Increment the counter by 1.
          */
-        inc: (ctx: RunMutationCtx) => Promise<void>;
+        inc: (ctx: MutationCtx | ActionCtx) => Promise<void>;
         /**
          * Decrement the counter by 1.
          */
-        dec: (ctx: RunMutationCtx) => Promise<void>;
+        dec: (ctx: MutationCtx | ActionCtx) => Promise<void>;
         /**
          * Get the current value of the counter.
          *
          * NOTE: this reads from all shards. If used in a mutation, it will
          * contend with all mutations that update the counter for this key.
          */
-        count: (ctx: RunQueryCtx) => Promise<number>;
+        count: (ctx: QueryCtx | MutationCtx | ActionCtx) => Promise<number>;
         /**
          * Reset the counter for this key.
          */
-        reset: (ctx: RunMutationCtx) => Promise<void>;
+        reset: (ctx: MutationCtx | ActionCtx) => Promise<void>;
         /**
          * Redistribute counts evenly across the counter's shards.
          *
          * This operation reads and writes all shards, so it can cause contention
          * if called too often.
          */
-        rebalance: (ctx: RunMutationCtx) => Promise<void>;
+        rebalance: (ctx: MutationCtx | ActionCtx) => Promise<void>;
         /**
          * Estimate the counter by only reading from a subset of shards,
          * and extrapolating the total count.
          *
          * Use this to reduce contention when reading the counter.
          */
-        estimateCount: (ctx: RunQueryCtx, readFromShards?: number) => Promise<number>;
+        estimateCount: (ctx: QueryCtx | MutationCtx | ActionCtx, readFromShards?: number) => Promise<any>;
     };
-    trigger<Ctx extends RunMutationCtx, Name extends ShardsKey>(name: Name): Trigger<Ctx, GenericDataModel, TableNamesInDataModel<GenericDataModel>>;
+    trigger<Ctx extends MutationCtx, Name extends ShardsKey>(name: Name): Trigger<Ctx, GenericDataModel, TableNamesInDataModel<GenericDataModel>>;
 }
 export type Trigger<Ctx, DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>> = (ctx: Ctx, change: Change<DataModel, TableName>) => Promise<void>;
 export type Change<DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>> = {
@@ -162,17 +162,8 @@ export type Change<DataModel extends GenericDataModel, TableName extends TableNa
     oldDoc: DocumentByName<DataModel, TableName>;
     newDoc: null;
 });
-type RunQueryCtx = {
-    runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
-};
-type RunMutationCtx = {
-    runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
-};
-export type OpaqueIds<T> = T extends GenericId<infer _T> ? string : T extends (infer U)[] ? OpaqueIds<U>[] : 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]>;
-}>;
+type QueryCtx = Pick<GenericQueryCtx<GenericDataModel>, "runQuery">;
+type MutationCtx = Pick<GenericMutationCtx<GenericDataModel>, "runQuery" | "runMutation">;
+type ActionCtx = Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation" | "runAction">;
 export {};
 //# 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,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACtB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACzE;;;GAGG;AACH,qBAAa,cAAc,CAAC,SAAS,SAAS,MAAM;IAiBhD,OAAO,CAAC,SAAS;IAhBnB;;;;;;;;;;;;;;OAcG;gBAEO,SAAS,EAAE,YAAY,EAC/B,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAUH,OAAO,CAAC,YAAY,CAA0C;IAI9D,OAAO,CAAC,WAAW,CAAyB;IAE5C;;;;;;OAMG;IACG,GAAG,CAAC,IAAI,SAAS,SAAS,EAC9B,GAAG,EAAE,WAAW,GAAG,SAAS,EAC5B,IAAI,EAAE,IAAI,EACV,KAAK,GAAE,MAAU;IAWnB;;OAEG;IACG,QAAQ,CAAC,IAAI,SAAS,SAAS,EACnC,GAAG,EAAE,WAAW,GAAG,SAAS,EAC5B,IAAI,EAAE,IAAI,EACV,KAAK,GAAE,MAAU;IAKnB;;OAEG;IACG,GAAG,CAAC,IAAI,SAAS,SAAS,EAAE,GAAG,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI;IAI1E;;OAEG;IACG,GAAG,CAAC,IAAI,SAAS,SAAS,EAAE,GAAG,EAAE,WAAW,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI;IAI1E;;;;;OAKG;IACG,KAAK,CAAC,IAAI,SAAS,SAAS,EAChC,GAAG,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,EACvC,IAAI,EAAE,IAAI;IAKZ;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,IAAI,SAAS,SAAS,EACpC,GAAG,EAAE,WAAW,GAAG,SAAS,EAC5B,IAAI,EAAE,IAAI;IAQZ;;;;OAIG;IACG,KAAK,CAAC,IAAI,SAAS,SAAS,EAChC,GAAG,EAAE,WAAW,GAAG,SAAS,EAC5B,IAAI,EAAE,IAAI;IAKZ;;;;;;;;;;OAUG;IACG,aAAa,CAAC,IAAI,SAAS,SAAS,EACxC,GAAG,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,EACvC,IAAI,EAAE,IAAI,EACV,cAAc,GAAE,MAAU;IAQ5B;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,EAAE,IAAI;QAElC;;WAEG;mBACc,WAAW,GAAG,SAAS,UAAS,MAAM;QAEvD;;WAEG;wBACmB,WAAW,GAAG,SAAS,UAAS,MAAM;QAE5D;;WAEG;mBACc,WAAW,GAAG,SAAS;QACxC;;WAEG;mBACc,WAAW,GAAG,SAAS;QACxC;;;;;WAKG;qBACgB,QAAQ,GAAG,WAAW,GAAG,SAAS;QAErD;;WAEG;qBACgB,WAAW,GAAG,SAAS;QAC1C;;;;;WAKG;yBACoB,WAAW,GAAG,SAAS;QAE9C;;;;;WAKG;6BAEI,QAAQ,GAAG,WAAW,GAAG,SAAS,mBACvB,MAAM;;IAI5B,OAAO,CAAC,GAAG,SAAS,WAAW,EAAE,IAAI,SAAS,SAAS,EACrD,IAAI,EAAE,IAAI,GACT,OAAO,CAAC,GAAG,EAAE,gBAAgB,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;CAS3E;AAID,MAAM,MAAM,OAAO,CACjB,GAAG,EACH,SAAS,SAAS,gBAAgB,EAClC,SAAS,SAAS,qBAAqB,CAAC,SAAS,CAAC,IAChD,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEtE,MAAM,MAAM,MAAM,CAChB,SAAS,SAAS,gBAAgB,EAClC,SAAS,SAAS,qBAAqB,CAAC,SAAS,CAAC,IAChD;IACF,EAAE,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;CAC1B,GAAG,CACA;IACE,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;CAC9C,GACD;IACE,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC7C,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;CAC9C,GACD;IACE,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC7C,MAAM,EAAE,IAAI,CAAC;CACd,CACJ,CAAC;AAEF,KAAK,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,CAAC;AACpE,KAAK,WAAW,GAAG,IAAI,CACrB,kBAAkB,CAAC,gBAAgB,CAAC,EACpC,UAAU,GAAG,aAAa,CAC3B,CAAC;AACF,KAAK,SAAS,GAAG,IAAI,CACnB,gBAAgB,CAAC,gBAAgB,CAAC,EAClC,UAAU,GAAG,aAAa,GAAG,WAAW,CACzC,CAAC"}

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,MAAM,OAAO,cAAc;IAiBf;IAhBV;;;;;;;;;;;;;;OAcG;IACH,YACU,SAAuB,EAC/B,OAGC;QAJO,cAAS,GAAT,SAAS,CAAc;QAM/B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,MAAM,aAAa,GAAG,OAAO,EAAE,aAAa,CAAC;QAC7C,IAAI,CAAC,YAAY,GAAG,CAAC,IAAe,EAAE,EAAE;YACtC,MAAM,cAAc,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;YAC/C,OAAO,cAAc,IAAI,aAAa,CAAC;QACzC,CAAC,CAAC;IACJ,CAAC;IAEO,YAAY,CAA0C;IAE9D,8EAA8E;IAC9E,2BAA2B;IACnB,WAAW,CAAyB;IAE5C;;;;;;OAMG;IACH,KAAK,CAAC,GAAG,CACP,GAA4B,EAC5B,IAAU,EACV,QAAgB,CAAC;QAEjB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE;YAC7D,IAAI;YACJ,KAAK;YACL,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC;YAC/B,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;SAChC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,GAA4B,EAC5B,IAAU,EACV,QAAgB,CAAC;QAEjB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAyB,GAA4B,EAAE,IAAU;QACxE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAyB,GAA4B,EAAE,IAAU;QACxE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,GAAuC,EACvC,IAAU;QAEV,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CACb,GAA4B,EAC5B,IAAU;QAEV,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE;YACrD,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;SAChC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CACT,GAA4B,EAC5B,IAAU;QAEV,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,GAAuC,EACvC,IAAU,EACV,iBAAyB,CAAC;QAE1B,OAAO,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE;YAC7D,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAC/B,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAyB,IAAU;QACpC,OAAO;YACL;;eAEG;YACH,GAAG,EAAE,KAAK,EAAE,GAA4B,EAAE,QAAgB,CAAC,EAAE,EAAE,CAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC;YAC5B;;eAEG;YACH,QAAQ,EAAE,KAAK,EAAE,GAA4B,EAAE,QAAgB,CAAC,EAAE,EAAE,CAClE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC;YAC7B;;eAEG;YACH,GAAG,EAAE,KAAK,EAAE,GAA4B,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE;;eAEG;YACH,GAAG,EAAE,KAAK,EAAE,GAA4B,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACpE;;;;;eAKG;YACH,KAAK,EAAE,KAAK,EAAE,GAAuC,EAAE,EAAE,CACvD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC;YACvB;;eAEG;YACH,KAAK,EAAE,KAAK,EAAE,GAA4B,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC;YACpE;;;;;eAKG;YACH,SAAS,EAAE,KAAK,EAAE,GAA4B,EAAE,EAAE,CAChD,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC;YAC3B;;;;;eAKG;YACH,aAAa,EAAE,KAAK,EAClB,GAAuC,EACvC,iBAAyB,CAAC,EAC1B,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,cAAc,CAAC;SACnD,CAAC;IACJ,CAAC;IACD,OAAO,CACL,IAAU;QAEV,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YAC3B,IAAI,MAAM,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAClC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC5B,CAAC;iBAAM,IAAI,MAAM,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;gBACzC,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF"}

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 public_ from "../public.js";
+import type { ApiFromModules, FilterApi, FunctionReference } from "convex/server";
+declare const fullApi: ApiFromModules<{
+    public: typeof public_;
+}>;
+/**
+ * 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,OAAO,MAAM,cAAc,CAAC;AAE7C,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,iBAAiB,EAClB,MAAM,eAAe,CAAC;AAGvB,QAAA,MAAM,OAAO,EAAE,cAAc,CAAC;IAC5B,MAAM,EAAE,OAAO,OAAO,CAAC;CACxB,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/{src → dist}/component/_generated/api.js

@@ -7,11 +7,10 @@
  * 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 API.
+ * A utility for referencing Convex functions in your app's public API.
  *
  * Usage:
  * ```js
@@ -19,5 +18,14 @@ import { anyApi, componentsGeneric } from "convex/server";
  * ```
  */
 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,46 @@
+/**
+ * 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> = {
+    public: {
+        add: FunctionReference<"mutation", "internal", {
+            count: number;
+            name: string;
+            shard?: number;
+            shards?: number;
+        }, number, Name>;
+        count: FunctionReference<"query", "internal", {
+            name: string;
+        }, number, Name>;
+        estimateCount: FunctionReference<"query", "internal", {
+            name: string;
+            readFromShards?: number;
+            shards?: number;
+        }, any, Name>;
+        rebalance: FunctionReference<"mutation", "internal", {
+            name: string;
+            shards?: number;
+        }, any, Name>;
+        reset: FunctionReference<"mutation", "internal", {
+            name: string;
+        }, 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,MAAM,EAAE;QACN,GAAG,EAAE,iBAAiB,CACpB,UAAU,EACV,UAAU,EACV;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,EAChE,MAAM,EACN,IAAI,CACL,CAAC;QACF,KAAK,EAAE,iBAAiB,CACtB,OAAO,EACP,UAAU,EACV;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,EAChB,MAAM,EACN,IAAI,CACL,CAAC;QACF,aAAa,EAAE,iBAAiB,CAC9B,OAAO,EACP,UAAU,EACV;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,cAAc,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,EAC1D,GAAG,EACH,IAAI,CACL,CAAC;QACF,SAAS,EAAE,iBAAiB,CAC1B,UAAU,EACV,UAAU,EACV;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,EACjC,GAAG,EACH,IAAI,CACL,CAAC;QACF,KAAK,EAAE,iBAAiB,CACtB,UAAU,EACV,UAAU,EACV;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,EAChB,GAAG,EACH,IAAI,CACL,CAAC;KACH,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"}