@dxos/versioning 0.10.0

package/dist/types/src/internal/model.d.ts

@@ -0,0 +1,53 @@
+import { Obj } from '@dxos/echo';
+import { Text } from '@dxos/schema';
+import * as Versioning from './types';
+/** Any ECHO object that carries a versioning history (e.g. a markdown document). */
+export type VersionedObject = Obj.Unknown & {
+    history?: Versioning.History | undefined;
+};
+/** Initializes the history struct on first use so existing documents need no migration. */
+export declare const ensureHistory: (doc: VersionedObject) => Versioning.History;
+/** @returns The Text content at the given automerge heads (read-only time travel). */
+export declare const contentAt: (text: Text.Text, heads: readonly string[]) => string;
+export type CreateCheckpointProps = {
+    target: Text.Text;
+    name: string;
+    message?: string;
+    creator?: string;
+};
+/**
+ * Records a named checkpoint of the target Text's current automerge heads and appends it to
+ * the object's history. Zero-copy: only the heads are stored.
+ */
+export declare const createCheckpoint: (doc: VersionedObject, props: CreateCheckpointProps) => Versioning.Version;
+/** Display label for a checkpoint: its name, or the formatted creation time when unnamed. */
+export declare const versionLabel: (version: Versioning.Version) => string;
+/** Display label for a branch: its name, or the formatted creation time when unnamed. */
+export declare const branchLabel: (branch: Versioning.Branch) => string;
+/** Find the branch record owning a given Text (undefined for the root). */
+export declare const findBranch: (doc: VersionedObject, text: Text.Text) => Versioning.Branch | undefined;
+export type CreateBranchProps = {
+    name: string;
+    parent: Text.Text;
+    heads?: readonly string[];
+    creator?: string;
+};
+/**
+ * Forks a draft branch: a new Text seeded with the parent's content at the anchor heads
+ * (defaults to the parent's current heads), recorded in the object's history. The anchor is
+ * auto-checkpointed so the fork point stays addressable in the timeline.
+ */
+export declare const createBranch: (doc: VersionedObject, props: CreateBranchProps) => Versioning.Branch;
+/** Applies the checkpoint's content to the tip as a new forward edit — history is never rewritten. */
+export declare const restore: (doc: VersionedObject, version: Versioning.Version) => void;
+export type MergeResult = {
+    conflicts: number;
+};
+/**
+ * 3-way merge: base = parent@anchor, ours = parent tip, theirs = branch tip.
+ * Conflicting hunks are left in the document with git-style markers for manual cleanup.
+ */
+export declare const mergeBranch: (doc: VersionedObject, branch: Versioning.Branch) => MergeResult;
+/** Archives the branch; its Text is retained for recovery. */
+export declare const discardBranch: (doc: VersionedObject, branch: Versioning.Branch) => void;
+//# sourceMappingURL=model.d.ts.map

package/dist/types/src/internal/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../../src/internal/model.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoB,GAAG,EAAO,MAAM,YAAY,CAAC;AAGxD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAGpC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAC;AAEtC,oFAAoF;AACpF,MAAM,MAAM,eAAe,GAAG,GAAG,CAAC,OAAO,GAAG;IAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,SAAS,CAAA;CAAE,CAAC;AAEzF,2FAA2F;AAC3F,eAAO,MAAM,aAAa,QAAS,eAAe,KAAG,UAAU,CAAC,OAS/D,CAAC;AAQF,sFAAsF;AACtF,eAAO,MAAM,SAAS,SAAU,IAAI,CAAC,IAAI,SAAS,SAAS,MAAM,EAAE,KAAG,MAQrE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE5G;;;GAGG;AACH,eAAO,MAAM,gBAAgB,QAAS,eAAe,SAAS,qBAAqB,KAAG,UAAU,CAAC,OAkBhG,CAAC;AAEF,6FAA6F;AAC7F,eAAO,MAAM,YAAY,YAAa,UAAU,CAAC,OAAO,KAAG,MACG,CAAC;AAE/D,yFAAyF;AACzF,eAAO,MAAM,WAAW,WAAY,UAAU,CAAC,MAAM,KAAG,MACI,CAAC;AAE7D,2EAA2E;AAC3E,eAAO,MAAM,UAAU,QAAS,eAAe,QAAQ,IAAI,CAAC,IAAI,KAAG,UAAU,CAAC,MAAM,GAAG,SACR,CAAC;AAEhF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,QAAS,eAAe,SAAS,iBAAiB,KAAG,UAAU,CAAC,MAuCxF,CAAC;AAEF,sGAAsG;AACtG,eAAO,MAAM,OAAO,QAAS,eAAe,WAAW,UAAU,CAAC,OAAO,KAAG,IAO3E,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,WAAW,QAAS,eAAe,UAAU,UAAU,CAAC,MAAM,KAAG,WAoB7E,CAAC;AAEF,8DAA8D;AAC9D,eAAO,MAAM,aAAa,QAAS,eAAe,UAAU,UAAU,CAAC,MAAM,KAAG,IAK/E,CAAC"}

package/dist/types/src/internal/types.d.ts

@@ -0,0 +1,69 @@
+import * as Schema from 'effect/Schema';
+import { Ref } from '@dxos/echo';
+import { Text } from '@dxos/schema';
+/**
+ * Named checkpoint: a pointer to the automerge heads of a Text's backing document.
+ * Heads are content-addressed change hashes, stable across peers, so a checkpoint is zero-copy.
+ * Generic over any object holding a `history` field (see model.ts).
+ */
+export declare const Version: Schema.mutable<Schema.Struct<{
+    id: typeof Schema.String;
+    name: typeof Schema.String;
+    target: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+    heads: Schema.mutable<Schema.Array$<typeof Schema.String>>;
+    createdAt: typeof Schema.String;
+    creator: Schema.optional<typeof Schema.String>;
+    message: Schema.optional<typeof Schema.String>;
+}>>;
+export interface Version extends Schema.Schema.Type<typeof Version> {
+}
+export declare const BranchStatus: Schema.Literal<["active", "merged", "archived"]>;
+export type BranchStatus = Schema.Schema.Type<typeof BranchStatus>;
+/**
+ * A draft Text forked from a parent Text at a specific revision (anchor heads).
+ * The branch tree is formed by `parent` references; the root is Document.content.
+ */
+export declare const Branch: Schema.mutable<Schema.Struct<{
+    id: typeof Schema.String;
+    name: typeof Schema.String;
+    content: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+    parent: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+    anchor: Schema.mutable<Schema.Array$<typeof Schema.String>>;
+    status: Schema.Literal<["active", "merged", "archived"]>;
+    createdAt: typeof Schema.String;
+    creator: Schema.optional<typeof Schema.String>;
+    mergedAt: Schema.optional<typeof Schema.String>;
+}>>;
+export interface Branch extends Schema.Schema.Type<typeof Branch> {
+}
+export declare const History: Schema.mutable<Schema.Struct<{
+    branches: Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
+        id: typeof Schema.String;
+        name: typeof Schema.String;
+        content: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+        parent: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+        anchor: Schema.mutable<Schema.Array$<typeof Schema.String>>;
+        status: Schema.Literal<["active", "merged", "archived"]>;
+        createdAt: typeof Schema.String;
+        creator: Schema.optional<typeof Schema.String>;
+        mergedAt: Schema.optional<typeof Schema.String>;
+    }>>>>;
+    versions: Schema.mutable<Schema.Array$<Schema.mutable<Schema.Struct<{
+        id: typeof Schema.String;
+        name: typeof Schema.String;
+        target: Ref.RefSchema<Text.Text & import("@dxos/echo/Entity").OfKind<import("@dxos/echo/internal").EntityKind.Object> & import("@dxos/echo/Obj").Unknown>;
+        heads: Schema.mutable<Schema.Array$<typeof Schema.String>>;
+        createdAt: typeof Schema.String;
+        creator: Schema.optional<typeof Schema.String>;
+        message: Schema.optional<typeof Schema.String>;
+    }>>>>;
+}>>;
+export interface History extends Schema.Schema.Type<typeof History> {
+}
+export type MakeVersionProps = Pick<Version, 'target' | 'heads' | 'name'> & Partial<Pick<Version, 'creator' | 'message'>>;
+/** Constructs a Version checkpoint record with a generated id and creation timestamp. */
+export declare const makeVersion: (props: MakeVersionProps) => Version;
+export type MakeBranchProps = Pick<Branch, 'content' | 'parent' | 'anchor' | 'name'> & Partial<Pick<Branch, 'creator'>>;
+/** Constructs an active Branch record with a generated id and creation timestamp. */
+export declare const makeBranch: (props: MakeBranchProps) => Branch;
+//# sourceMappingURL=types.d.ts.map

package/dist/types/src/internal/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/internal/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAO,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;;;;;;GAUnB,CAAC;AACF,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC;CAAG;AAEtE,eAAO,MAAM,YAAY,kDAAiD,CAAC;AAC3E,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC,CAAC;AAEnE;;;GAGG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;GAYlB,CAAC;AACF,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC;CAAG;AAEpE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;GAKnB,CAAC;AACF,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,OAAO,CAAC;CAAG;AAEtE,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC,GACvE,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;AAEhD,yFAAyF;AACzF,eAAO,MAAM,WAAW,UAAW,gBAAgB,KAAG,OAIpD,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAExH,qFAAqF;AACrF,eAAO,MAAM,UAAU,UAAW,eAAe,KAAG,MAKlD,CAAC"}

package/dist/types/src/model.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=model.test.d.ts.map

package/dist/types/src/model.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.test.d.ts","sourceRoot":"","sources":["../../../src/model.test.ts"],"names":[],"mappings":""}