@convex-dev/table-history 0.1.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,231 @@
+# Convex TableHistory Component
+
+[![npm version](https://badge.fury.io/js/%40convex-dev%2Ftable-history.svg)](https://badge.fury.io/js/%40convex-dev%2Ftable-history)
+
+<!-- START: Include on https://convex.dev/components -->
+
+Note: this Component is currently BETA. It was previously published under `convex-table-history`.
+
+## History on a Convex table
+
+Attach a history component to your Convex table to keep track of changes.
+
+- View an audit log of all table changes in the Convex Dashboard or in a custom React component.
+  - Answer questions like "was document A updated before document B?"
+- View an audit log of changes to a single document
+  - Answer questions like "what was the user's email address before they changed it?"
+- Look at a snapshot of the table at any point in time.
+
+```ts
+// Paginate through all history on the "documents" table, from newest to oldest.
+documentAuditLog.listHistory(ctx, args.maxTs, args.paginationOpts);
+
+// Paginate through all history for a specific document, from newest to oldest.
+documentAuditLog.listDocumentHistory(ctx, args.documentId, args.maxTs, args.paginationOpts);
+
+// Paginate through all documents in the "documents" table at a specific timestamp.
+documentAuditLog.listSnapshot(ctx, args.snapshotTs, args.currentTs, args.paginationOpts);
+```
+
+Found a bug? Feature request? [File it here](https://github.com/ldanilek/table-history/issues).
+
+## 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).
+
+Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+
+## Installation
+
+Install the component package:
+
+```ts
+npm install @convex-dev/table-history
+```
+
+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 tableHistory from "@convex-dev/table-history/convex.config";
+
+const app = defineApp();
+app.use(tableHistory, { name: "documentAuditLog" });
+
+export default app;
+```
+
+To add history to multiple tables, you can call `app.use` multiple times with
+different names. They will be available in your app as
+`new TableHistory(components.<name>, ...)`.
+
+## Usage
+
+```ts
+import { components } from "./_generated/api";
+import { TableHistory } from "@convex-dev/table-history";
+
+const documentAuditLog = new TableHistory<DataModel, "documents">(components.documentAuditLog);
+```
+
+Add an item to the history table when a document changes:
+
+```ts
+async function patchDocument(ctx: MutationCtx, documentId: Id<"documents">, patch: Partial<Doc<"documents">>) {
+  await ctx.db.patch(documentId, patch);
+  const document = await ctx.db.get(documentId);
+  await documentAuditLog.update(ctx, documentId, document);
+}
+
+async function insertDocument(ctx: MutationCtx, documentId: Id<"documents">, newDoc: WithoutSystemFields<Doc<"documents">>) {
+  const documentId = await ctx.db.insert("documents", newDoc);
+  const document = await ctx.db.get(documentId);
+  await documentAuditLog.update(ctx, documentId, document);
+}
+
+async function deleteDocument(ctx: MutationCtx, documentId: Id<"documents">) {
+  await ctx.db.delete(documentId);
+  await documentAuditLog.update(ctx, documentId, null);
+}
+```
+
+Or attach a [trigger](https://www.npmjs.com/package/convex-helpers#triggers) to automatically write to the history table when a mutation changes a document:
+
+```ts
+const triggers = new Triggers<DataModel>();
+triggers.register("documents", documentAuditLog.trigger());
+export const mutation = customMutation(rawMutation, customCtx(triggers.wrapDB));
+```
+
+Now that you're writing to the history table, you can use the `listHistory`, `listDocumentHistory`, and `listSnapshot` functions to query the history.
+
+These functions are paginated, so you can use them with `usePaginatedQuery` to get all of the entries incrementally.
+The pages consist of `HistoryEntry` objects, which have the following fields:
+
+- `id`: the id of the document that was changed
+- `doc`: the new version of the document that was changed, or null if the document was deleted
+- `ts`: the timestamp of the change. See [serializability](#serializability).
+- `isDeleted`: whether the document was deleted
+- `attribution`: an optional arbitrary object that will be stored with the history entry
+
+See more example usage in [example.ts](./example/convex/example.ts).
+
+## Details of usage
+
+### Serializability
+
+Convex mutations are serializable transactions, which is great for maintaining
+consistency in your tables.
+
+However, if you need the guarantee that history timestamps match the mutations'
+serializable order, that would require serializing all changes to your whole
+database, and your database would slow to a crawl and get OCC errors.
+
+You can configure the serializability of the history table by setting the
+`serializability` option. The three options are:
+
+- `"table"` -- i.e. the latest ts for the table, plus one
+  - history entries are serializable with other updates on the same table
+- `"document"` -- i.e. the latest ts for the document, plus one
+  - history entries are serializable with other updates on the same document.
+- `"wallclock"` -- i.e. Date.now()
+  - history entry timestamps don't have guarantees, but they also take no extra
+    dependencies and are usually sufficient.
+
+The default serializability is `"wallclock"`.
+
+### `currentTs` and `maxTs` are required
+
+```ts
+const [currentTs] = useState(Date.now()); // stable and recent
+const [yesterday] = useState(Date.now() - 24 * 60 * 60 * 1000); // stable
+const snapshotOfUsersYesterday = usePaginatedQuery(
+  api.documents.listSnapshot,
+  {
+    currentTs,
+    snapshotTs: yesterday,
+  },
+  { initialNumItems: 100 },
+);
+const auditLogBeforeYesterday = usePaginatedQuery(
+  api.documents.listHistory,
+  {
+    maxTs: yesterday,
+  },
+  { initialNumItems: 100 },
+);
+```
+
+- For `listSnapshot`, `currentTs` should be a stable recent timestamp.
+  - "Stable" means it should have the same value for all pages.
+    - To keep a stable timestamp for all pages, pick a value on the client and
+      pass it as an arg of `usePaginatedQuery`.
+  - "Recent" is relative to how often the table gets new inserts. The amount of
+    extra work performed by the query is proportional to the number of
+    `ctx.db.insert(tableName, doc)` calls since the `currentTs`.
+    - If the timestamp isn't recent, the queries might read too much data in
+      a single page and throw an error.
+    - Don't pick a timestamp in the future, or gaps will appear between pages
+      as new documents are inserted. The timestamp should be `Date.now()` or
+      slightly in the past.
+- For `listHistory` and `listDocumentHistory`, `maxTs` should be stable but
+  doesn't need to be recent.
+
+**Why is this necessary?** 
+
+The TableHistory component supports paginated queries with
+[`usePaginatedQuery`](https://docs.convex.dev/database/pagination#paginating-within-react-components)
+and [manual pagination](https://docs.convex.dev/database/pagination#paginating-manually).
+But it needs a little help from you to make everything work seamlessly.
+
+You want
+[fully reactive pagination](https://stack.convex.dev/fully-reactive-pagination).
+Concretely, `usePaginatedQuery` results should not have gaps or duplicates.
+
+In order to implement this feature without the built-in `.paginate` method,
+the TableHistory component assumes its own data model is append-only (which is
+true, except when vacuuming), and takes in a stable recent timestamp. Then it
+ignores history entries created after that timestamp.
+
+### Attribution
+
+Store an update's `attribution` to track information like which user made the
+change, or what mutation made the change.
+
+```ts
+await documentAuditLog.update(ctx, documentId, document, {
+  attribution: {
+    actorIdentity: await ctx.auth.getUserIdentity(),
+    mutationName: "patchDocument",
+    source: "web",
+  },
+});
+```
+
+The default attribution when using `TableHistory.update` is `null`.
+
+The default attribution when using `TableHistory.trigger` is the mutation's
+`ctx.auth.getUserIdentity()`.
+
+### Vacuuming
+
+The history table can grow large, so you can use the `vacuumHistory` function
+to remove old history entries. This function will
+schedule background jobs to delete old history entries.
+The entries which will be deleted are those which are not visible
+at snapshots `>=minTsToKeep`.
+
+After vacuuming up to `minTsToKeep`, you can no longer call `listSnapshot`
+with a snapshot timestamp less than `minTsToKeep`.
+
+### Limitations
+
+- No indexes: you can't use an index to change the sort order or get a subset of results.
+  - Workaround: you can paginate until `isDone` returns true, and sort or filter
+    the results yourself, either on the client or in an action.
+    Consider [manual pagination](https://docs.convex.dev/database/pagination#paginating-manually).
+
+<!-- END: Include on https://convex.dev/components -->

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

@@ -0,0 +1,116 @@
+import { DocumentByName, GenericDataModel, GenericMutationCtx, GenericQueryCtx, PaginationOptions, TableNamesInDataModel } from "convex/server";
+import { GenericId } from "convex/values";
+import type { Serializability } from "../component/lib.js";
+import type { ComponentApi } from "../component/_generated/component.js";
+export declare class TableHistory<DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>> {
+    component: ComponentApi;
+    options: {
+        serializability: Serializability;
+    };
+    constructor(component: ComponentApi, options?: {
+        serializability?: Serializability;
+    });
+    /**
+     * Write a new history entry.
+     *
+     * @argument attribution an arbitrary object that will be stored with the
+     *   history entry. Attribution can include actor/user identity, reason for
+     *   change, etc.
+     */
+    update(ctx: RunMutationCtx, id: GenericId<TableName>, doc: DocumentByName<DataModel, TableName> | null, attribution?: unknown): Promise<number>;
+    /**
+     * Paginate the history of the table, from newest to oldest.
+     *
+     * @argument maxTs To keep pages contiguous, set `maxTs` to a fixed timestamp
+     *   (milliseconds since epoch, like Date.now()) and keep
+     *   it the same for subsequent pages.
+     */
+    listHistory(ctx: RunQueryCtx, maxTs: number, paginationOpts: PaginationOptions): Promise<{
+        continueCursor: string;
+        isDone: boolean;
+        page: Array<{
+            attribution: any;
+            doc: any;
+            id: string;
+            isDeleted: boolean;
+            ts: number;
+        }>;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
+    }>;
+    /**
+     * Paginate the history of a single document, from newest to oldest.
+     *
+     * @argument maxTs To keep pages contiguous, set `maxTs` to a fixed timestamp
+     *   (milliseconds since epoch, like Date.now()) and keep
+     *   it the same for subsequent pages.
+     */
+    listDocumentHistory(ctx: RunQueryCtx, id: GenericId<TableName>, maxTs: number, paginationOpts: PaginationOptions): Promise<{
+        continueCursor: string;
+        isDone: boolean;
+        page: Array<{
+            attribution: any;
+            doc: any;
+            id: string;
+            isDeleted: boolean;
+            ts: number;
+        }>;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
+    }>;
+    /**
+     * Paginate a snapshot of the table at a fixed timestamp.
+     *
+     * @argument ts the snapshot at which you want to list the table (milliseconds since epoch)
+     * @argument currentTs a fixed recent timestamp (milliseconds since epoch, like Date.now())
+     *   which should be the same for subsequent pages.
+     */
+    listSnapshot(ctx: RunQueryCtx, snapshotTs: number, currentTs: number, paginationOpts: PaginationOptions): Promise<{
+        continueCursor: string;
+        isDone: boolean;
+        page: Array<{
+            attribution: any;
+            doc: any;
+            id: string;
+            isDeleted: boolean;
+            ts: number;
+        }>;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
+    }>;
+    /**
+     * Delete old history entries.
+     *
+     * @argument minTsToKeep the timestamp (milliseconds since epoch) of the oldest
+     *   snapshot of history that should be kept.
+     */
+    vacuumHistory(ctx: RunMutationCtx, minTsToKeep: number): Promise<any>;
+    /**
+     * For use with `Triggers` from "convex-helpers/server/triggers".
+     */
+    trigger<Ctx extends RunMutationCtx>(): Trigger<Ctx, DataModel, TableName>;
+}
+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>> = {
+    id: GenericId<TableName>;
+} & ({
+    operation: "insert";
+    oldDoc: null;
+    newDoc: DocumentByName<DataModel, TableName>;
+} | {
+    operation: "update";
+    oldDoc: DocumentByName<DataModel, TableName>;
+    newDoc: DocumentByName<DataModel, TableName>;
+} | {
+    operation: "delete";
+    oldDoc: DocumentByName<DataModel, TableName>;
+    newDoc: null;
+});
+type RunQueryCtx = {
+    runQuery: GenericQueryCtx<GenericDataModel>["runQuery"];
+};
+type RunMutationCtx = {
+    runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
+};
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AAEzE,qBAAa,YAAY,CACvB,SAAS,SAAS,gBAAgB,EAClC,SAAS,SAAS,qBAAqB,CAAC,SAAS,CAAC;IAMzC,SAAS,EAAE,YAAY;IAJzB,OAAO,EAAE;QACd,eAAe,EAAE,eAAe,CAAC;KAClC,CAAC;gBAEO,SAAS,EAAE,YAAY,EAC9B,OAAO,CAAC,EAAE;QACR,eAAe,CAAC,EAAE,eAAe,CAAC;KACnC;IAOH;;;;;;OAMG;IACG,MAAM,CACV,GAAG,EAAE,cAAc,EACnB,EAAE,EAAE,SAAS,CAAC,SAAS,CAAC,EACxB,GAAG,EAAE,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,IAAI,EAChD,WAAW,GAAE,OAAc;IAU7B;;;;;;OAMG;IACG,WAAW,CACf,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,iBAAiB;;;;;;;;;;;;;IAOnC;;;;;;OAMG;IACG,mBAAmB,CACvB,GAAG,EAAE,WAAW,EAChB,EAAE,EAAE,SAAS,CAAC,SAAS,CAAC,EACxB,KAAK,EAAE,MAAM,EACb,cAAc,EAAE,iBAAiB;;;;;;;;;;;;;IAQnC;;;;;;OAMG;IACG,YAAY,CAChB,GAAG,EAAE,WAAW,EAChB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,iBAAiB;;;;;;;;;;;;;IASnC;;;;;OAKG;IACG,aAAa,CAAC,GAAG,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM;IAI5D;;OAEG;IACH,OAAO,CAAC,GAAG,SAAS,cAAc,KAAK,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC;CAe1E;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,WAAW,GAAG;IACjB,QAAQ,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC,UAAU,CAAC,CAAC;CACzD,CAAC;AACF,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,aAAa,CAAC,CAAC;CAClE,CAAC"}

package/dist/esm/client/index.js

@@ -0,0 +1,93 @@
+export class TableHistory {
+    component;
+    options;
+    constructor(component, options) {
+        this.component = component;
+        this.options = {
+            serializability: options?.serializability ?? "wallclock",
+        };
+    }
+    /**
+     * Write a new history entry.
+     *
+     * @argument attribution an arbitrary object that will be stored with the
+     *   history entry. Attribution can include actor/user identity, reason for
+     *   change, etc.
+     */
+    async update(ctx, id, doc, attribution = null) {
+        return ctx.runMutation(this.component.lib.update, {
+            id,
+            doc,
+            serializability: this.options.serializability,
+            attribution,
+        });
+    }
+    /**
+     * Paginate the history of the table, from newest to oldest.
+     *
+     * @argument maxTs To keep pages contiguous, set `maxTs` to a fixed timestamp
+     *   (milliseconds since epoch, like Date.now()) and keep
+     *   it the same for subsequent pages.
+     */
+    async listHistory(ctx, maxTs, paginationOpts) {
+        return ctx.runQuery(this.component.lib.listHistory, {
+            maxTs,
+            paginationOpts,
+        });
+    }
+    /**
+     * Paginate the history of a single document, from newest to oldest.
+     *
+     * @argument maxTs To keep pages contiguous, set `maxTs` to a fixed timestamp
+     *   (milliseconds since epoch, like Date.now()) and keep
+     *   it the same for subsequent pages.
+     */
+    async listDocumentHistory(ctx, id, maxTs, paginationOpts) {
+        return ctx.runQuery(this.component.lib.listDocumentHistory, {
+            id,
+            maxTs,
+            paginationOpts,
+        });
+    }
+    /**
+     * Paginate a snapshot of the table at a fixed timestamp.
+     *
+     * @argument ts the snapshot at which you want to list the table (milliseconds since epoch)
+     * @argument currentTs a fixed recent timestamp (milliseconds since epoch, like Date.now())
+     *   which should be the same for subsequent pages.
+     */
+    async listSnapshot(ctx, snapshotTs, currentTs, paginationOpts) {
+        return ctx.runQuery(this.component.lib.listSnapshot, {
+            snapshotTs,
+            currentTs,
+            paginationOpts,
+        });
+    }
+    /**
+     * Delete old history entries.
+     *
+     * @argument minTsToKeep the timestamp (milliseconds since epoch) of the oldest
+     *   snapshot of history that should be kept.
+     */
+    async vacuumHistory(ctx, minTsToKeep) {
+        return ctx.runMutation(this.component.lib.vacuumHistory, { minTsToKeep });
+    }
+    /**
+     * For use with `Triggers` from "convex-helpers/server/triggers".
+     */
+    trigger() {
+        return async (ctx, change) => {
+            let attribution = null;
+            if (
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            ctx.auth &&
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                typeof ctx.auth.getUserIdentity === "function") {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                attribution = await ctx.auth.getUserIdentity();
+            }
+            await this.update(ctx, change.id, change.newDoc, attribution);
+        };
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAYA,MAAM,OAAO,YAAY;IAQd;IAJF,OAAO,CAEZ;IACF,YACS,SAAuB,EAC9B,OAEC;QAHM,cAAS,GAAT,SAAS,CAAc;QAK9B,IAAI,CAAC,OAAO,GAAG;YACb,eAAe,EAAE,OAAO,EAAE,eAAe,IAAI,WAAW;SACzD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CACV,GAAmB,EACnB,EAAwB,EACxB,GAAgD,EAChD,cAAuB,IAAI;QAE3B,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE;YAChD,EAAE;YACF,GAAG;YACH,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe;YAC7C,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CACf,GAAgB,EAChB,KAAa,EACb,cAAiC;QAEjC,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE;YAClD,KAAK;YACL,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,mBAAmB,CACvB,GAAgB,EAChB,EAAwB,EACxB,KAAa,EACb,cAAiC;QAEjC,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,mBAAmB,EAAE;YAC1D,EAAE;YACF,KAAK;YACL,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IACD;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,GAAgB,EAChB,UAAkB,EAClB,SAAiB,EACjB,cAAiC;QAEjC,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE;YACnD,UAAU;YACV,SAAS;YACT,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,GAAmB,EAAE,WAAmB;QAC1D,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YAC3B,IAAI,WAAW,GAAY,IAAI,CAAC;YAChC;YACE,8DAA8D;YAC7D,GAAW,CAAC,IAAI;gBACjB,8DAA8D;gBAC9D,OAAQ,GAAW,CAAC,IAAI,CAAC,eAAe,KAAK,UAAU,EACvD,CAAC;gBACD,8DAA8D;gBAC9D,WAAW,GAAG,MAAO,GAAW,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1D,CAAC;YACD,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;CACF"}