@voidhash/mimic 0.0.1-alpha.1 → 0.0.1-alpha.111

package/dist/index.d.cts

@@ -0,0 +1,143 @@
+import { _ as OperationPath_d_exports, a as InferSetInput, c as InferUpdateInput, d as ProxyEnvironment_d_exports, g as Operation_d_exports, h as Operation, i as InferProxy, m as Transaction_d_exports, n as AnyTreeNodePrimitive, o as InferSnapshot, p as Transaction, r as AnyPrimitive, s as InferState, t as Primitive_d_exports, u as Transform_d_exports, v as __export } from "./Primitive-CvFVxR8_.cjs";
+import { i as Presence_d_exports } from "./Presence-DKKP4v5X.cjs";
+import { Schema } from "effect";
+
+//#region src/Document.d.ts
+declare namespace Document_d_exports {
+  export { Document, DocumentOptions, NestedTransactionError, OperationError, make };
+}
+/**
+ * Error thrown when attempting to start a nested transaction.
+ */
+declare class NestedTransactionError extends Error {
+  readonly _tag = "NestedTransactionError";
+  constructor();
+}
+/**
+ * Error thrown when an operation fails to apply.
+ */
+declare class OperationError extends Error {
+  readonly _tag = "OperationError";
+  constructor(message: string);
+}
+/**
+ * A Document manages state for a primitive-based schema with transaction support.
+ */
+interface Document<TSchema extends AnyPrimitive> {
+  /** The schema defining this document's structure */
+  readonly schema: TSchema;
+  /** Root proxy for accessing and modifying document data */
+  readonly root: InferProxy<TSchema>;
+  /** Returns the current document state */
+  get(): InferState<TSchema> | undefined;
+  /**
+   * Returns a readonly snapshot of the entire document state for rendering.
+   * The snapshot is a type-safe, readonly structure where:
+   * - Required fields and fields with defaults are guaranteed to be defined
+   * - Optional fields may be undefined
+   */
+  toSnapshot(): InferSnapshot<TSchema>;
+  /**
+   * Runs a function within a transaction.
+   * All operations are collected and applied atomically.
+   * If the function throws, all changes are rolled back.
+   * @returns The return value of the function
+   */
+  transaction<R>(fn: (root: InferProxy<TSchema>) => R): R;
+  /**
+   * Applies external operations (e.g., from server/peers) to the document.
+   * These operations are NOT added to pending operations.
+   */
+  apply(ops: ReadonlyArray<Operation<any, any, any>>): void;
+  /**
+   * Returns pending local operations as a Transaction and clears the buffer.
+   */
+  flush(): Transaction;
+}
+interface DocumentOptions<TSchema extends AnyPrimitive> {
+  /** Initial state for the document */
+  readonly initial?: InferState<TSchema>;
+}
+/**
+ * Creates a new Document for the given schema.
+ */
+declare const make: <TSchema extends AnyPrimitive>(schema: TSchema, options?: DocumentOptions<TSchema>) => Document<TSchema>;
+declare namespace EffectSchema_d_exports {
+  export { ToSetSchema, ToTreeNodeSetSchema, ToTreeNodeUpdateSchema, ToUpdateSchema, TreeNodeStateSchema, toSetSchema, toUpdateSchema };
+}
+/**
+ * Infer the Effect.Schema type for a primitive's set input.
+ */
+type ToSetSchema<T extends AnyPrimitive> = Schema.Schema<InferSetInput<T>>;
+/**
+ * Infer the Effect.Schema type for a primitive's update input.
+ */
+type ToUpdateSchema<T extends AnyPrimitive> = Schema.Schema<InferUpdateInput<T>>;
+/**
+ * Type for TreeNode set schema - uses the node's data set input type
+ */
+type ToTreeNodeSetSchema<T extends AnyTreeNodePrimitive> = Schema.Schema<InferSetInput<T["data"]>>;
+/**
+ * Type for TreeNode update schema - uses the node's data update input type
+ */
+type ToTreeNodeUpdateSchema<T extends AnyTreeNodePrimitive> = Schema.Schema<InferUpdateInput<T["data"]>>;
+/**
+ * Schema for a tree node state (flat storage format).
+ */
+declare const TreeNodeStateSchema: Schema.Struct<{
+  id: typeof Schema.String;
+  type: typeof Schema.String;
+  parentId: Schema.NullOr<typeof Schema.String>;
+  pos: typeof Schema.String;
+  data: typeof Schema.Unknown;
+}>;
+/**
+ * Convert a Mimic primitive to an Effect.Schema for set operations.
+ *
+ * The resulting schema:
+ * - For structs: required fields (required=true, no default) are non-optional, others are optional
+ * - For arrays: uses the element's set schema
+ * - For unions: creates a Schema.Union of variant schemas
+ * - For TreeNode: delegates to the node's data struct schema
+ * - For Tree: returns Schema.Array of TreeNodeState
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = Primitive.Struct({
+ *   name: Primitive.String().required(),
+ *   age: Primitive.Number().default(0),
+ *   email: Primitive.String(),
+ * });
+ *
+ * const SetSchema = toSetSchema(UserSchema);
+ * // { name: string, age?: number, email?: string }
+ * ```
+ */
+declare function toSetSchema<T extends AnyPrimitive>(primitive: T): ToSetSchema<T>;
+declare function toSetSchema<T extends AnyTreeNodePrimitive>(primitive: T): ToTreeNodeSetSchema<T>;
+/**
+ * Convert a Mimic primitive to an Effect.Schema for update operations.
+ *
+ * The resulting schema:
+ * - For structs: all fields are optional (partial updates)
+ * - For unions: all variant fields are optional
+ * - For TreeNode: delegates to the node's data struct update schema
+ * - For simple primitives: same as set schema
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = Primitive.Struct({
+ *   name: Primitive.String().required(),
+ *   age: Primitive.Number().default(0),
+ *   email: Primitive.String(),
+ * });
+ *
+ * const UpdateSchema = toUpdateSchema(UserSchema);
+ * // { name?: string, age?: string, email?: string }
+ * ```
+ */
+declare function toUpdateSchema<T extends AnyPrimitive>(primitive: T): ToUpdateSchema<T>;
+declare function toUpdateSchema<T extends AnyTreeNodePrimitive>(primitive: T): ToTreeNodeUpdateSchema<T>;
+//#endregion
+export { Document_d_exports as Document, EffectSchema_d_exports as EffectSchema, Operation_d_exports as Operation, OperationPath_d_exports as OperationPath, Presence_d_exports as Presence, Primitive_d_exports as Primitive, ProxyEnvironment_d_exports as ProxyEnvironment, Transaction_d_exports as Transaction, Transform_d_exports as Transform };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/Document.ts","../src/EffectSchema.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;cAaa,sBAAA,SAA+B,KAAA;;;;;;AAA5C;AAWa,cAAA,cAAA,SAAuB,KAAA,CAAK;EAexB,SAAA,IAAQ,GAAA,gBAAA;EAAiB,WAAA,CAAA,OAAA,EAAA,MAAA;;;;;AAQjC,UARQ,QAQR,CAAA,gBARiC,YAQjC,CAAA,CAAA;EAQ+B;EAAxB,SAAA,MAAA,EAdG,OAcH;EAQiC;EAArB,SAAA,IAAA,EAnBX,UAmBW,CAnBU,OAmBV,CAAA;EAAkC;EAAI,GAAA,EAAA,EAhBzD,UAgByD,CAhBpC,OAgBoC,CAAA,GAAA,SAAA;EAMvC;;;;AAY3B;;EAE0C,UAAA,EAAA,EA5B1B,aA4B0B,CA5BF,OA4BE,CAAA;EAArB;;AAUrB;;;;EAEY,WAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,IAAA,EAhCgB,UAgChB,CAhCqC,OAgCrC,CAAA,EAAA,GAhCkD,CAgClD,CAAA,EAhCsD,CAgCtD;EACA;;;;aA3BC,cAAc;;;;WAKhB;;UAOM,gCAAgC;;qBAE5B,WAAqB;;;AC7D1C;;AAA8E,cDuEjE,ICvEiE,EAAA,CAAA,gBDuEzC,YCvEyC,CAAA,CAAA,MAAA,EDwEpE,OCxEoE,EAAA,OAAA,CAAA,EDyElE,eCzEkE,CDyElD,OCzEkD,CAAA,EAAA,GD0E3E,QC1E2E,CD0ElE,OC1EkE,CAAA;AAAA;;;;;;KAAlE,sBAAsB,gBAAgB,MAAA,CAAO,OAAO,cAAc;ADT9E;AAWA;AAeA;AAA0C,KCZ9B,cDY8B,CAAA,UCZL,YDYK,CAAA,GCZW,MAAA,CAAO,MDYlB,CCZyB,gBDYzB,CCZ0C,CDY1C,CAAA,CAAA;;;;AAQZ,KCflB,mBDekB,CAAA,UCfY,oBDeZ,CAAA,GCfoC,MAAA,CAAO,MDe3C,CCfkD,aDelD,CCfgE,CDehE,CAAA,MAAA,CAAA,CAAA,CAAA;;;;AAgBmB,KC1BrC,sBD0BqC,CAAA,UC1BJ,oBD0BI,CAAA,GC1BoB,MAAA,CAAO,MD0B3B,CC1BkC,gBD0BlC,CC1BmD,CD0BnD,CAAA,MAAA,CAAA,CAAA,CAAA;;;;AAMtB,cCvBd,mBDuBc,ECvBK,MAAA,CAAA,MDuBL,CAAA;EAAd,EAAA,EAAA,oBAAA;EAKF,IAAA,EAAA,oBAAA;EAAuB,QAAA,eAAA,CAAA,oBAAA,CAAA;EAOjB,GAAA,EAAA,oBAAe;EAAiB,IAAA,EAAA,qBAAA;CAEP,CAAA;;;AAU1C;;;;;;;;;;;;;;;;;;;;ACvEY,iBAgUI,WAhUO,CAAA,UAgUe,YAhUf,CAAA,CAAA,SAAA,EAgUwC,CAhUxC,CAAA,EAgU4C,WAhU5C,CAgUwD,CAhUxD,CAAA;AAAW,iBAiUlB,WAjUkB,CAAA,UAiUI,oBAjUJ,CAAA,CAAA,SAAA,EAiUqC,CAjUrC,CAAA,EAiUyC,mBAjUzC,CAiU6D,CAjU7D,CAAA;;;;;AAKlC;;;;;;AAKA;;;;;;AAKA;;;;;AAAkF,iBA4UlE,cA5UkE,CAAA,UA4UzC,YA5UyC,CAAA,CAAA,SAAA,EA4UhB,CA5UgB,CAAA,EA4UZ,cA5UY,CA4UG,CA5UH,CAAA;AASrE,iBAoUG,cA9Td,CAAA,UA8TuC,oBA9TvC,CAAA,CAAA,SAAA,EA8TwE,CA9TxE,CAAA,EA8T4E,sBA9T5E,CA8TmG,CA9TnG,CAAA"}

package/dist/index.d.mts

@@ -0,0 +1,143 @@
+import { i as Presence_d_exports } from "./Presence-N8u7Eppr.mjs";
+import { _ as OperationPath_d_exports, a as InferSetInput, c as InferUpdateInput, d as ProxyEnvironment_d_exports, g as Operation_d_exports, h as Operation, i as InferProxy, m as Transaction_d_exports, n as AnyTreeNodePrimitive, o as InferSnapshot, p as Transaction, r as AnyPrimitive, s as InferState, t as Primitive_d_exports, u as Transform_d_exports } from "./Primitive-lEhQyGVL.mjs";
+import { Schema } from "effect";
+
+//#region src/Document.d.ts
+declare namespace Document_d_exports {
+  export { Document, DocumentOptions, NestedTransactionError, OperationError, make };
+}
+/**
+ * Error thrown when attempting to start a nested transaction.
+ */
+declare class NestedTransactionError extends Error {
+  readonly _tag = "NestedTransactionError";
+  constructor();
+}
+/**
+ * Error thrown when an operation fails to apply.
+ */
+declare class OperationError extends Error {
+  readonly _tag = "OperationError";
+  constructor(message: string);
+}
+/**
+ * A Document manages state for a primitive-based schema with transaction support.
+ */
+interface Document<TSchema extends AnyPrimitive> {
+  /** The schema defining this document's structure */
+  readonly schema: TSchema;
+  /** Root proxy for accessing and modifying document data */
+  readonly root: InferProxy<TSchema>;
+  /** Returns the current document state */
+  get(): InferState<TSchema> | undefined;
+  /**
+   * Returns a readonly snapshot of the entire document state for rendering.
+   * The snapshot is a type-safe, readonly structure where:
+   * - Required fields and fields with defaults are guaranteed to be defined
+   * - Optional fields may be undefined
+   */
+  toSnapshot(): InferSnapshot<TSchema>;
+  /**
+   * Runs a function within a transaction.
+   * All operations are collected and applied atomically.
+   * If the function throws, all changes are rolled back.
+   * @returns The return value of the function
+   */
+  transaction<R>(fn: (root: InferProxy<TSchema>) => R): R;
+  /**
+   * Applies external operations (e.g., from server/peers) to the document.
+   * These operations are NOT added to pending operations.
+   */
+  apply(ops: ReadonlyArray<Operation<any, any, any>>): void;
+  /**
+   * Returns pending local operations as a Transaction and clears the buffer.
+   */
+  flush(): Transaction;
+}
+interface DocumentOptions<TSchema extends AnyPrimitive> {
+  /** Initial state for the document */
+  readonly initial?: InferState<TSchema>;
+}
+/**
+ * Creates a new Document for the given schema.
+ */
+declare const make: <TSchema extends AnyPrimitive>(schema: TSchema, options?: DocumentOptions<TSchema>) => Document<TSchema>;
+declare namespace EffectSchema_d_exports {
+  export { ToSetSchema, ToTreeNodeSetSchema, ToTreeNodeUpdateSchema, ToUpdateSchema, TreeNodeStateSchema, toSetSchema, toUpdateSchema };
+}
+/**
+ * Infer the Effect.Schema type for a primitive's set input.
+ */
+type ToSetSchema<T extends AnyPrimitive> = Schema.Schema<InferSetInput<T>>;
+/**
+ * Infer the Effect.Schema type for a primitive's update input.
+ */
+type ToUpdateSchema<T extends AnyPrimitive> = Schema.Schema<InferUpdateInput<T>>;
+/**
+ * Type for TreeNode set schema - uses the node's data set input type
+ */
+type ToTreeNodeSetSchema<T extends AnyTreeNodePrimitive> = Schema.Schema<InferSetInput<T["data"]>>;
+/**
+ * Type for TreeNode update schema - uses the node's data update input type
+ */
+type ToTreeNodeUpdateSchema<T extends AnyTreeNodePrimitive> = Schema.Schema<InferUpdateInput<T["data"]>>;
+/**
+ * Schema for a tree node state (flat storage format).
+ */
+declare const TreeNodeStateSchema: Schema.Struct<{
+  id: typeof Schema.String;
+  type: typeof Schema.String;
+  parentId: Schema.NullOr<typeof Schema.String>;
+  pos: typeof Schema.String;
+  data: typeof Schema.Unknown;
+}>;
+/**
+ * Convert a Mimic primitive to an Effect.Schema for set operations.
+ *
+ * The resulting schema:
+ * - For structs: required fields (required=true, no default) are non-optional, others are optional
+ * - For arrays: uses the element's set schema
+ * - For unions: creates a Schema.Union of variant schemas
+ * - For TreeNode: delegates to the node's data struct schema
+ * - For Tree: returns Schema.Array of TreeNodeState
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = Primitive.Struct({
+ *   name: Primitive.String().required(),
+ *   age: Primitive.Number().default(0),
+ *   email: Primitive.String(),
+ * });
+ *
+ * const SetSchema = toSetSchema(UserSchema);
+ * // { name: string, age?: number, email?: string }
+ * ```
+ */
+declare function toSetSchema<T extends AnyPrimitive>(primitive: T): ToSetSchema<T>;
+declare function toSetSchema<T extends AnyTreeNodePrimitive>(primitive: T): ToTreeNodeSetSchema<T>;
+/**
+ * Convert a Mimic primitive to an Effect.Schema for update operations.
+ *
+ * The resulting schema:
+ * - For structs: all fields are optional (partial updates)
+ * - For unions: all variant fields are optional
+ * - For TreeNode: delegates to the node's data struct update schema
+ * - For simple primitives: same as set schema
+ *
+ * @example
+ * ```typescript
+ * const UserSchema = Primitive.Struct({
+ *   name: Primitive.String().required(),
+ *   age: Primitive.Number().default(0),
+ *   email: Primitive.String(),
+ * });
+ *
+ * const UpdateSchema = toUpdateSchema(UserSchema);
+ * // { name?: string, age?: string, email?: string }
+ * ```
+ */
+declare function toUpdateSchema<T extends AnyPrimitive>(primitive: T): ToUpdateSchema<T>;
+declare function toUpdateSchema<T extends AnyTreeNodePrimitive>(primitive: T): ToTreeNodeUpdateSchema<T>;
+//#endregion
+export { Document_d_exports as Document, EffectSchema_d_exports as EffectSchema, Operation_d_exports as Operation, OperationPath_d_exports as OperationPath, Presence_d_exports as Presence, Primitive_d_exports as Primitive, ProxyEnvironment_d_exports as ProxyEnvironment, Transaction_d_exports as Transaction, Transform_d_exports as Transform };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/Document.ts","../src/EffectSchema.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;cAaa,sBAAA,SAA+B,KAAA;;;;;;;AAA/B,cAWA,cAAA,SAAuB,KAAA,CAXa;EAWpC,SAAA,IAAA,GAAA,gBAAuB;EAenB,WAAQ,CAAA,OAAA,EAAA,MAAA;;;;;AAQK,UARb,QAQa,CAAA,gBARY,YAQZ,CAAA,CAAA;EAArB;EAQ+B,SAAA,MAAA,EAdrB,OAcqB;EAAxB;EAQiC,SAAA,IAAA,EAnBhC,UAmBgC,CAnBX,OAmBW,CAAA;EAArB;EAAkC,GAAA,EAAA,EAhBrD,UAgBqD,CAhBhC,OAgBgC,CAAA,GAAA,SAAA;EAAI;;;;;AAkBlE;EAAiD,UAAA,EAAA,EA1BjC,aA0BiC,CA1BT,OA0BS,CAAA;EAEP;;;AAU1C;;;EAE4B,WAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,IAAA,EAhCA,UAgCA,CAhCqB,OAgCrB,CAAA,EAAA,GAhCkC,CAgClC,CAAA,EAhCsC,CAgCtC;EAAhB;;;;aA1BC,cAAc;;;;WAKhB;;UAOM,gCAAgC;;qBAE5B,WAAqB;;;;AC7D1C;AAAkC,cDuErB,ICvEqB,EAAA,CAAA,gBDuEG,YCvEH,CAAA,CAAA,MAAA,EDwExB,OCxEwB,EAAA,OAAA,CAAA,EDyEtB,eCzEsB,CDyEN,OCzEM,CAAA,EAAA,GD0E/B,QC1E+B,CD0EtB,OC1EsB,CAAA;AAAA;;;;;;KAAtB,sBAAsB,gBAAgB,MAAA,CAAO,OAAO,cAAc;;ADT9E;AAWA;AAeiB,KCZL,cDYa,CAAA,UCZY,YDYZ,CAAA,GCZ4B,MAAA,CAAO,MDYnC,CCZ0C,gBDY1C,CCZ2D,CDY3D,CAAA,CAAA;;;;AAKR,KCZL,mBDYK,CAAA,UCZyB,oBDYzB,CAAA,GCZiD,MAAA,CAAO,MDYxD,CCZ+D,aDY/D,CCZ6E,CDY7E,CAAA,MAAA,CAAA,CAAA,CAAA;;;;AAWD,KClBJ,sBDkBI,CAAA,UClB6B,oBDkB7B,CAAA,GClBqD,MAAA,CAAO,MDkB5D,CClBmE,gBDkBnE,CClBoF,CDkBpF,CAAA,MAAA,CAAA,CAAA,CAAA;;;;AAQkD,cCjBrD,mBDiBqD,ECjBlC,MAAA,CAAA,MDiBkC,CAAA;EAMvC,EAAA,EAAA,oBAAA;EAAd,IAAA,EAAA,oBAAA;EAKF,QAAA,eAAA,CAAA,oBAAA,CAAA;EAAuB,GAAA,EAAA,oBAAA;EAOjB,IAAA,EAAA,qBAAe;CAAiB,CAAA;;;;AAYjD;;;;;;;;;;;;;;;;;;;iBCyPgB,sBAAsB,yBAAyB,IAAI,YAAY;AAhUnE,iBAiUI,WAjUO,CAAA,UAiUe,oBAjUf,CAAA,CAAA,SAAA,EAiUgD,CAjUhD,CAAA,EAiUoD,mBAjUpD,CAiUwE,CAjUxE,CAAA;;;;;;AAKvB;;;;;;AAKA;;;;;;AAKA;;;;AAAqE,iBA4UrD,cA5U4D,CAAA,UA4UnC,YA5UmC,CAAA,CAAA,SAAA,EA4UV,CA5UU,CAAA,EA4UN,cA5UM,CA4US,CA5UT,CAAA;AAAM,iBA6UlE,cA7UkE,CAAA,UA6UzC,oBA7UyC,CAAA,CAAA,SAAA,EA6UR,CA7UQ,CAAA,EA6UJ,sBA7UI,CA6UmB,CA7UnB,CAAA"}