@pylonsync/sdk 0.11.4 → 0.11.5

package/dist/index.d.ts

@@ -334,6 +334,15 @@ export interface EntityDefinition {
      * can read" and "nothing".
      */
     sync?: boolean | SyncScope;
+    /**
+     * Per-row CRDT (Loro) documents. Default `true`: every write merges through
+     * a document, and offline edits from several devices converge. Set `false`
+     * for rows only the server writes and that nobody edits concurrently:
+     * rollups, counters, metering windows, audit logs. Those pay a document read
+     * and write on every change for nothing, and a row rewritten every few
+     * minutes carries a snapshot that grows with each write.
+     */
+    crdt?: boolean;
 }
 /**
  * Bounded replication for an entity that should stay live but shouldn't ship
@@ -375,6 +384,9 @@ export declare function entity(name: string, fields: Record<string, FieldBuilder
      *  which rows reach it. Mirrors {@link EntityDefinition.sync} — this is
      *  the type callers actually hit, so the two must not drift. */
     sync?: boolean | SyncScope;
+    /** `false` for server-written rows that need no CRDT document. Mirrors
+     *  {@link EntityDefinition.crdt}. */
+    crdt?: boolean;
 }): EntityDefinition;
 export declare function relation(def: RelationDefinition): RelationDefinition;
 export { defineRoute } from "./route";
@@ -557,6 +569,8 @@ export interface ManifestEntity {
      */
     sync_scope?: string;
     sync_limit?: number;
+    /** CRDT mode; omitted when true (the runtime default). */
+    crdt?: boolean;
 }
 export interface ManifestRoute {
     path: string;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.11.4",
+  "version": "0.11.5",
   "type": "module",
   "main": "./src/index.ts",
   "types": "./dist/index.d.ts",

package/src/entity-crdt.test.ts

@@ -0,0 +1,18 @@
+import { describe, expect, test } from "bun:test";
+import { entitiesToManifest, entity, field } from "./index";
+
+describe("entity crdt option", () => {
+  test("crdt: false reaches the manifest", () => {
+    const [m] = entitiesToManifest([entity("Rollup", { n: field.int() }, { crdt: false })]);
+    expect(m.crdt).toBe(false);
+  });
+
+  test("the default is omitted, so the runtime default (true) applies", () => {
+    const [a, b] = entitiesToManifest([
+      entity("Note", { title: field.string() }),
+      entity("Doc", { title: field.string() }, { crdt: true }),
+    ]);
+    expect("crdt" in a).toBe(false);
+    expect("crdt" in b).toBe(false);
+  });
+});

package/src/index.ts

@@ -431,6 +431,15 @@ export interface EntityDefinition {
    * can read" and "nothing".
    */
   sync?: boolean | SyncScope;
+  /**
+   * Per-row CRDT (Loro) documents. Default `true`: every write merges through
+   * a document, and offline edits from several devices converge. Set `false`
+   * for rows only the server writes and that nobody edits concurrently:
+   * rollups, counters, metering windows, audit logs. Those pay a document read
+   * and write on every change for nothing, and a row rewritten every few
+   * minutes carries a snapshot that grows with each write.
+   */
+  crdt?: boolean;
 }
 
 /**
@@ -477,6 +486,9 @@ export function entity(
      *  which rows reach it. Mirrors {@link EntityDefinition.sync} — this is
      *  the type callers actually hit, so the two must not drift. */
     sync?: boolean | SyncScope;
+    /** `false` for server-written rows that need no CRDT document. Mirrors
+     *  {@link EntityDefinition.crdt}. */
+    crdt?: boolean;
   },
 ): EntityDefinition {
   return {
@@ -486,6 +498,7 @@ export function entity(
     relations: options?.relations,
     search: options?.search,
     sync: options?.sync,
+    crdt: options?.crdt,
   };
 }
 
@@ -728,6 +741,8 @@ export interface ManifestEntity {
    */
   sync_scope?: string;
   sync_limit?: number;
+  /** CRDT mode; omitted when true (the runtime default). */
+  crdt?: boolean;
 }
 
 export interface ManifestRoute {
@@ -1052,6 +1067,10 @@ export function entitiesToManifest(
       if (scope.where !== undefined) result.sync_scope = scope.where;
       if (scope.limit !== undefined) result.sync_limit = scope.limit;
     }
+    // Emit only when opted OUT — the runtime defaults crdt to true.
+    if (e.crdt === false) {
+      result.crdt = false;
+    }
     return result;
   });
 }