@pluv/crdt-loro 0.0.0-canary-20261027014949

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shoubhit Dash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+## `@pluv/crdt-loro`
+
+> This package is currently in preview and may have breaking changes between versions.
+
+> Loro adapter for [@pluv/client](https://www.npmjs.com/package/@pluv/client) and [@pluv/io](https://www.npmjs.com/package/@pluv/io).
+
+**👉 See full documentation on [docs.pluv.io](https://docs.pluv.io/docs). 👈**
+
+## Installation
+
+```bash
+# npm
+npm install @pluv/crdt-loro loro-crdt
+
+# yarn
+yarn add @pluv/crdt-loro loro-crdt
+
+# pnpm
+pnpm add @pluv/crdt-loro loro-crdt
+```
+
+## Runtime resolution
+
+Import `@pluv/crdt-loro` normally. Conditional exports pick the Loro entry best suited for each runtime:
+
+| Runtime                       | Resolved build     | Loro entry          |
+| ----------------------------- | ------------------ | ------------------- |
+| Browser (Vite, Webpack, etc.) | `dist/browser.mjs` | `loro-crdt`         |
+| Cloudflare Workers (Wrangler) | `dist/bundler.mjs` | `loro-crdt/bundler` |
+| Bun                           | `dist/bundler.mjs` | `loro-crdt/bundler` |
+| Node.js                       | `dist/node.mjs`    | `loro-crdt/nodejs`  |
+| Deno                          | `dist/node.mjs`    | `loro-crdt/nodejs`  |
+| Other bundlers (default)      | `dist/bundler.mjs` | `loro-crdt/bundler` |
+
+If your toolchain does not pick the expected build, import explicitly:
+
+```ts
+import { loro } from "@pluv/crdt-loro/browser";
+import { loro } from "@pluv/crdt-loro/workerd";
+import { loro } from "@pluv/crdt-loro/bun";
+import { loro } from "@pluv/crdt-loro/node";
+import { loro } from "@pluv/crdt-loro/deno";
+```
+
+## Browser setup
+
+When using Loro in the browser (e.g. with Next.js or Vite), configure your bundler to handle WASM. See the [Loro getting started guide](https://loro.dev/docs/tutorial/get_started).
+
+For Next.js with webpack, enable `asyncWebAssembly` in `next.config.js`:
+
+```js
+webpack: (config) => {
+    config.experiments = { asyncWebAssembly: true };
+    return config;
+},
+```
+
+## Node.js, Deno, and Bun
+
+When running on Node.js (e.g. with `@pluv/platform-node`), import `@pluv/crdt-loro` normally. Deno resolves to the same Node build. Bun resolves to the bundler build, which includes Bun-specific WASM initialization in `loro-crdt`.
+
+## Cloudflare Workers
+
+Import `@pluv/crdt-loro` normally in Workers. Wrangler resolves the `workerd` condition to the bundler build automatically. No wrangler alias is required.

package/dist/browser.d.mts

@@ -0,0 +1,90 @@
+import { LoroCounter, LoroDoc, LoroList, LoroMap, LoroMovableList, LoroText, LoroTree } from "loro-crdt";
+import { AbstractCrdtDocFactory, AnySchemaNode, DocApplyEncodedStateParams, DocBatchApplyEncodedStateParams, DocSubscribeCallbackParams, InferNodeJson, InferNodeSeed, InferNodeStorage, InferShapeJson, InferShapeSeed, InferShapeStorage, SchemaAst, SchemaNode } from "@pluv/crdt";
+import { CrdtDocLike } from "@pluv/types";
+declare const counter: () => LoroCounter;
+declare class LoroSchema<TShape extends Record<string, AnySchemaNode> = Record<string, AnySchemaNode>> extends AbstractCrdtDocFactory<LoroDoc, InferShapeStorage<TShape>, InferShapeJson<TShape>, InferShapeSeed<TShape>> {
+  readonly kind: "loro.doc";
+  readonly shape: TShape;
+  readonly _seed?: InferShapeSeed<TShape>;
+  constructor(shape: TShape, seed?: InferShapeSeed<TShape>);
+  toJSON(): {
+    kind: "loro.doc";
+    shape: Record<string, unknown>;
+  };
+  getEmpty(): CrdtLoroDoc<LoroSchema<TShape>>;
+  getFactory(seed?: InferShapeSeed<TShape>): LoroSchema<TShape>;
+  getInitialized(seed?: InferShapeSeed<TShape>): CrdtLoroDoc<LoroSchema<TShape>>;
+}
+type InferLoroStorage<TSchema extends LoroSchema<any>> = InferShapeStorage<TSchema["shape"]>;
+type InferLoroJson<TSchema extends LoroSchema<any>> = InferShapeJson<TSchema["shape"]>;
+declare function schema<TShape extends Record<string, AnySchemaNode>>(shape: TShape): LoroSchema<TShape>;
+declare namespace schema {
+  var fromJSON: (ast: SchemaAst) => LoroSchema;
+}
+declare class CrdtLoroDoc<TSchema extends LoroSchema = LoroSchema> implements CrdtDocLike<LoroDoc, InferLoroStorage<TSchema>, InferLoroJson<TSchema>> {
+  #private;
+  value: LoroDoc;
+  constructor(schema: TSchema, seed?: Record<string, unknown>, hydrate?: boolean);
+  applyEncodedState(params: DocApplyEncodedStateParams): this;
+  batchApplyEncodedState(params: DocBatchApplyEncodedStateParams): this;
+  captureUpdate(fn: () => void): string | null;
+  canRedo(): boolean;
+  canUndo(): boolean;
+  destroy(): void;
+  get(key?: undefined): InferLoroStorage<TSchema>;
+  get<TKey extends keyof InferLoroStorage<TSchema>>(key: TKey): InferLoroStorage<TSchema>[TKey];
+  encodeDiff(stateVector: string): string;
+  getEncodedState(): string;
+  getStateVector(): string;
+  readStateVersion(encoded: string): readonly (readonly [string, number])[];
+  readUpdateVersion(update: string): readonly (readonly [string, number])[];
+  containsUpdate(_update: string): boolean;
+  hasPending(): boolean;
+  canDetectPending(): boolean;
+  toJson(): InferLoroJson<TSchema>;
+  toJson<TKey extends keyof InferLoroJson<TSchema>>(type: TKey): InferLoroJson<TSchema>[TKey];
+  isDirty(): boolean;
+  isEmpty(): boolean;
+  rebuildStorage(): this;
+  redo(): this;
+  subscribe(listener: (params: DocSubscribeCallbackParams<LoroDoc, InferLoroStorage<TSchema>, InferLoroJson<TSchema>>) => void): () => void;
+  track(): this;
+  /**
+   * @description Unlike Yjs, this method is required to be called after each loro operation.
+   * @date January 12, 2025
+   */
+  transact(fn: () => void): this;
+  undo(): this;
+}
+declare const doc: (_value?: any) => LoroSchema;
+declare const list: <T extends unknown>(value?: T[] | readonly T[]) => LoroList<T>;
+declare const map: <T extends unknown>(value?: readonly (readonly [key: string, value: T])[]) => LoroMap<Record<string, T>>;
+declare const movableList: <T extends unknown>(value?: T[] | readonly T[]) => LoroMovableList<T>;
+declare const object: <T extends Record<string, any>>(value: T) => LoroMap<T>;
+type LoroListNode<TItem extends AnySchemaNode> = SchemaNode<"loroList", LoroList<InferNodeStorage<TItem>>, InferNodeJson<TItem>[], InferNodeSeed<TItem>[]> & {
+  readonly item: TItem;
+};
+type LoroMapNode<TValue extends AnySchemaNode> = SchemaNode<"loroMap", LoroMap<Record<string, InferNodeStorage<TValue>>>, Record<string, InferNodeJson<TValue>>, Record<string, InferNodeSeed<TValue>>> & {
+  readonly value: TValue;
+};
+type LoroTextNode = SchemaNode<"loroText", LoroText, string, string>;
+type LoroMovableListNode<TItem extends AnySchemaNode> = SchemaNode<"loroMovableList", LoroMovableList<InferNodeStorage<TItem>>, InferNodeJson<TItem>[], InferNodeSeed<TItem>[]> & {
+  readonly item: TItem;
+};
+type LoroCounterNode = SchemaNode<"loroCounter", LoroCounter, number, number>;
+type LoroTreeNode = SchemaNode<"loroTree", LoroTree, unknown, never>;
+declare const loroList: <TItem extends AnySchemaNode>(item: TItem) => LoroListNode<TItem>;
+declare const loroMap: <TValue extends AnySchemaNode>(value: TValue) => LoroMapNode<TValue>;
+declare const loroText: () => LoroTextNode;
+declare const loroMovableList: <TItem extends AnySchemaNode>(item: TItem) => LoroMovableListNode<TItem>;
+declare const loroCounter: () => LoroCounterNode;
+declare const loroTree: () => LoroTreeNode;
+declare const text: (value?: string) => LoroText;
+declare const tree: <T extends Record<string, unknown>>() => LoroTree<T>;
+declare namespace loro_d_exports {
+  export { CrdtLoroDoc, counter, doc, kind, list, loroCounter, loroList, loroMap, loroMovableList, loroText, loroTree, map, movableList, object, schema, text, tree };
+}
+declare const kind: "loro";
+export type LoroLibraryType = typeof loro_d_exports;
+export { loro_d_exports as loro };
+//# sourceMappingURL=browser.d.mts.map

package/dist/browser.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.mts","names":["loro"],"sources":["../src/counter.ts","../src/doc/LoroSchema.ts","../src/schema/schema.ts","../src/doc/CrdtLoroDoc.ts","../src/doc/doc.ts","../src/list.ts","../src/map.ts","../src/movableList.ts","../src/object.ts","../src/schema/nodes.ts","../src/text.ts","../src/tree.ts","../src/loro.ts","../src/index.ts"],"mappings":";;;cAEa,eAAc;cCSd,WACT,eAAe,eAAe,iBAAiB,eAAe,wBACxD,uBACN,SACA,kBAAkB,SAClB,eAAe,SACf,eAAe;WAEC;WACA,OAAO;WACP,QAAQ,eAAe;EAEvC,YAAY,OAAO,QAAQ,OAAO,eAAe;EAO1C;IAAY;IAAkB,OAAO;;EAOrC,YAAY,YAAY,WAAW;EAInC,WAAW,OAAO,eAAe,UAAU,WAAW;EAItD,eAAe,OAAO,eAAe,UAAU,YAAY,WAAW;;KC/BrE,iBAAiB,gBAAgB,mBAAmB,kBAAkB;KACtE,cAAc,gBAAgB,mBAAmB,eAAe;iBAOrD,OAAA,eAAe,eAAe,gBACjD,OAAO,SACR,WAAW;;MAkBU,WAAA,KAAA,cAAY;;cCTvB,YAAY,gBAAgB,aAAa,uBAAuB,YACzE,SACA,iBAAiB,UACjB,cAAc;;EAEP,OAAO;EAQd,YAAY,QAAQ,SAAS,OAAO,yBAAyB;EAatD,kBAAkB,QAAQ;EAW1B,uBAAuB,QAAQ;EAwC/B,cAAc;EAuBd;EAMA;EAMA;EAIA,IAAI,kBAAkB,iBAAiB;EACvC,IAAI,mBAAmB,iBAAiB,UAC3C,KAAK,OACN,iBAAiB,SAAS;EAStB,WAAW;EAYX;EAIA;EAUA,iBAAiB;EAYjB,kBAAkB;EAalB,eAAe;EAKf;EAIA;EAIA,UAAU,cAAc;EACxB,OAAO,mBAAmB,cAAc,UAC3C,MAAM,OACP,cAAc,SAAS;EAuBnB;EAIA;EAMA;EAgBA;EAMA,UACH,WACI,QAAQ,2BACJ,SACA,iBAAiB,UACjB,cAAc;EAsCnB;;;;;EAoBA,SAAS;EAQT;;cC/VE,MAAG,iBAAmB;cCAtB,OAAQ,mBAAiB,QAAS,eAAe,QAAW,SAAS;cCArE,MAAO,mBAAiB,4BACN,aAAa,OAAO,UAChD,QAAQ,eAAe;cCFb,cAAe,mBAAiB,QAClC,eAAe,QACvB,gBAAgB;cCFN,SAAU,UAAU,qBAAmB,OAAS,MAAI,QAAQ;KCe7D,aAAa,cAAc,iBAAiB,uBAEpD,SAAS,iBAAiB,SAC1B,cAAc,UACd,cAAc;WACH,MAAM;;KAET,YAAY,eAAe,iBAAiB,sBAEpD,QAAQ,eAAe,iBAAiB,WACxC,eAAe,cAAc,UAC7B,eAAe,cAAc;WAClB,OAAO;;KAEV,eAAe,uBAAuB;KACtC,oBAAoB,cAAc,iBAAiB,8BAE3D,gBAAgB,iBAAiB,SACjC,cAAc,UACd,cAAc;WACH,MAAM;;KACT,kBAAkB,0BAA0B;KAC5C,eAAe,uBAAuB;cAErC,WAAY,cAAc,eAAa,MAAQ,UAAQ,aAAa;cAMpE,UAAW,eAAe,eAAa,OAAS,WAAS,YAAY;cAMrE,gBAAe;cAIf,kBAAmB,cAAc,eAAa,MACjD,UACP,oBAAoB;cAMV,mBAAkB;cAIlB,gBAAe;cCpEf,OAAI,mBAAyB;cCA7B,OAAQ,UAAU,8BAAuB,SAAA;;;;cCezC;YCbD,yBAAyBA"}