@encorejs/saaz 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,240 @@
+import type { Cell, Ops } from './rogue';
+export type $IntentionalAny = any;
+export type $FixMe = any;
+type SerializablePrimitive = null | string | boolean | number;
+export type SerializableValue = SerializablePrimitive | ReadonlyArray<SerializableValue> | SerialzableMap;
+export type SerialzableMap = {
+    readonly [key: string]: SerializableValue | undefined;
+};
+export type EditorDefinitionFn = (state: $IntentionalAny, generators: $IntentionalAny, opts: $IntentionalAny) => $IntentionalAny;
+/**
+ * An editor definition is either a function or an object of editor definitions.
+ * ```ts
+ * {
+ *   foo: (state, ctx, opts) => {},
+ *   nested: {
+ *     a: {
+ *       b: {c: (state, ctx, opts) => {}},
+ *     },
+ *   },
+ * }
+ * ```
+ */
+export type EditorDefinitions = EditorDefinitionFn | {
+    [key: string]: EditorDefinitions;
+};
+/**
+ * Takes an editor definition and returns a function that can be used to invoke it.
+ * ```ts
+ * // input
+ * (state, ctx, opts) => {}
+ * // output
+ * (opts) => {}
+ *
+ * // OR:
+ * // input
+ * {foo: (state, ctx, opts) => {}}
+ * // output
+ * {foo: (opts) => {}}
+ * ```
+ */
+export type EditorDefinitionToEditorInvocable<Editors extends EditorDefinitions> = Editors extends EditorDefinitionFn ? (opts: Parameters<Editors>[2]) => void : Editors extends {
+    [key: string]: EditorDefinitions;
+} ? {
+    [K in keyof Editors]: EditorDefinitionToEditorInvocable<Editors[K]>;
+} : never;
+export type ValidGenerators = {
+    [key: string]: (() => SerializableValue) | ((opts: SerializableValue) => SerializableValue);
+};
+export type Invokations = Array<[fn: string, opts: SerialzableMap]>;
+export type Transaction = {
+    invokations: Invokations;
+    generatorRecordings: GeneratorRecordings;
+    peerId: string;
+    peerClock: number;
+    draftOps: Ops;
+};
+export type GeneratorRecordings = {
+    [key in string]?: SerializableValue[];
+};
+export type OnDiskSnapshot<OpSnapshot> = {
+    origin: string;
+    dbName: string;
+    clock: number;
+    snapshot: FullSnapshot<OpSnapshot>;
+};
+export type SessionState<OpSnapshot> = {
+    /**
+     * Unix timestamp of the last time the client synced with backend. Timestamp is produced on
+     * the client, so it may be inaccurate. Null means never synced.
+     */
+    lastSyncTime: number | null;
+    /**
+     * The clock of the backend. null means unknown.
+     */
+    backendClock: number | null;
+    /**
+     * The clock of the last optimistic update the backend has applied from this peer.
+     * The state (below) is calculated after this optimistic update has run.
+     */
+    lastIncorporatedPeerClock: number | null;
+    /**
+     * The state of the backend.
+     */
+    snapshot: FullSnapshot<OpSnapshot> | null;
+    peerId: string;
+};
+export type BackStateUpdateDescriptor = {
+    clock: number;
+    snapshot: {
+        type: 'Snapshot';
+        value: FullSnapshot<$IntentionalAny>;
+    } | {
+        type: 'Diff';
+        diff: 'todo';
+    };
+    lastIncorporatedPeerClock: number | null;
+    peerId: string;
+};
+export type BackApplyUpdateOps = {
+    peerId: string;
+    backendClock: number | null;
+    updates: Transaction[];
+};
+export type BackGetUpdateSinceClockResult = ({
+    hasUpdates: false;
+} & Omit<BackStateUpdateDescriptor, 'snapshot'>) | ({
+    hasUpdates: true;
+} & BackStateUpdateDescriptor);
+export type PeerPresenceState = {
+    tempTransactions: Array<Omit<Transaction, 'peerClock'>>;
+};
+export type AllPeersPresenceState = {
+    [peerId in string]?: PeerPresenceState;
+};
+export type PeerSubscribeCallback = (opts: {
+    presence: AllPeersPresenceState;
+    shouldCheckForUpdates: boolean;
+}) => void;
+export interface SaazBackInterface {
+    getUpdatesSinceClock(opts: {
+        clock: number | null;
+        peerId: string;
+    }): Promise<BackGetUpdateSinceClockResult>;
+    getLastIncorporatedPeerClock(opts: {
+        peerId: string;
+    }): Promise<{
+        lastIncorporatedPeerClock: null | number;
+        peerId: string;
+    }>;
+    closePeer(opts: {
+        peerId: string;
+    }): Promise<{
+        ok: boolean;
+    }>;
+    applyUpdates(opts: BackApplyUpdateOps): Promise<({
+        ok: true;
+    } & BackGetUpdateSinceClockResult) | {
+        ok: false;
+        error: unknown;
+    }>;
+    updatePresence(opts: {
+        peerId: string;
+        presence: PeerPresenceState;
+    }): Promise<{
+        ok: true;
+    } | {
+        ok: false;
+        error: unknown;
+    }>;
+    subscribe(opts: {
+        peerId: string;
+    }, onUpdate: PeerSubscribeCallback): Promise<() => void>;
+}
+export type FrontStorageAdapterTransaction = {
+    /**
+     * Gets a singular value.
+     */
+    get<T>(key: string, session: string): Promise<T | void>;
+    /**
+     * Like `get()`, but returns the value for each session
+     */
+    getAll<T>(key: string): Promise<Record<string, T>>;
+    /**
+     * Sets a singular value.
+     */
+    set<T>(key: string, value: T, session: string): Promise<void>;
+    deleteSession(session: string): Promise<void>;
+    /**
+     * Pushes one or more rows to a list.
+     */
+    pushToList<T extends {
+        id: string;
+    }>(key: string, rows: T[], session: string): Promise<void>;
+    /**
+     * Reads all the rows from a list.
+     */
+    getList<T extends {
+        id: string;
+    }>(key: string, session: string): Promise<T[]>;
+    /**
+     * Removes one or more rows from a list.
+     */
+    pluckFromList<T extends {
+        id: string;
+    }>(key: string, ids: Array<string>, session: string): Promise<Array<T | undefined>>;
+};
+export interface FrontStorageAdapter {
+    /**
+     * Transaction.
+     * Example:
+     * ```ts
+     * const newCount = await s.transaction(async ({get, set}) => {
+     *   const count = await get<number>('count')
+     *   await set('count', count + 1)
+     *   return count + 1
+     * })
+     * ```
+     */
+    transaction<T>(fn: (opts: FrontStorageAdapterTransaction) => Promise<T>): Promise<T>;
+    /**
+     * Gets a singular value.
+     */
+    get<T>(key: string, session: string): Promise<T | void>;
+    /**
+     * Sets a singular value.
+     */
+    getList<T extends {
+        id: string;
+    }>(key: string, session: string): Promise<T[]>;
+}
+export interface BackStorageAdapter {
+}
+export type Schema<OpSnapshot extends {
+    $schemaVersion: number;
+}, Editors extends {} = {}, Generators extends ValidGenerators = {}, CellShape extends {} = {}> = {
+    editors: Editors;
+    generators: Generators;
+    opShape: OpSnapshot;
+    cellShape: CellShape;
+    version: number;
+};
+export type ValidOpSnapshot = {
+    $schemaVersion: number;
+};
+export type TempTransaction = Omit<Transaction, 'peerClock'> & {
+    tempId: number;
+    backwardOps: Ops;
+};
+export type TempTransactionApi<Editors extends {}, CellShape extends {}> = {
+    commit: () => void;
+    discard: () => void;
+    recapture: (editorFn?: (editors: EditorDefinitionToEditorInvocable<Editors>) => void, draftFn?: (draft: CellShape) => void) => void;
+    reset: () => void;
+};
+export type FullSnapshot<OpSnapshot> = {
+    op: OpSnapshot;
+    cell: Cell | {};
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAE,GAAG,EAAC,MAAM,SAAS,CAAA;AAEtC,MAAM,MAAM,eAAe,GAAG,GAAG,CAAA;AACjC,MAAM,MAAM,MAAM,GAAG,GAAG,CAAA;AAExB,KAAK,qBAAqB,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;AAE7D,MAAM,MAAM,iBAAiB,GACzB,qBAAqB,GACrB,aAAa,CAAC,iBAAiB,CAAC,GAChC,cAAc,CAAA;AAElB,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAAA;CACtD,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,CAC/B,KAAK,EAAE,eAAe,EACtB,UAAU,EAAE,eAAe,EAC3B,IAAI,EAAE,eAAe,KAClB,eAAe,CAAA;AACpB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,GACzB,kBAAkB,GAClB;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAC,CAAA;AACtC;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,iCAAiC,CAC3C,OAAO,SAAS,iBAAiB,IAC/B,OAAO,SAAS,kBAAkB,GAClC,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GACtC,OAAO,SAAS;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAC,GAClD;KACG,CAAC,IAAI,MAAM,OAAO,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CACpE,GACD,KAAK,CAAA;AACT,MAAM,MAAM,eAAe,GAAG;IAC5B,CAAC,GAAG,EAAE,MAAM,GACR,CAAC,MAAM,iBAAiB,CAAC,GACzB,CAAC,CAAC,IAAI,EAAE,iBAAiB,KAAK,iBAAiB,CAAC,CAAA;CACrD,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAA;AAEnE,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,WAAW,CAAA;IACxB,mBAAmB,EAAE,mBAAmB,CAAA;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,GAAG,CAAA;CACd,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;KAC/B,GAAG,IAAI,MAAM,CAAC,CAAC,EAAE,iBAAiB,EAAE;CACtC,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,UAAU,IAAI;IAEvC,MAAM,EAAE,MAAM,CAAA;IAEd,MAAM,EAAE,MAAM,CAAA;IAEd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,UAAU,IAAI;IACrC;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;;OAGG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;IACzC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EACJ;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,CAAA;KAAC,GACxD;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,CAAA;IAChC,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,6BAA6B,GACrC,CAAC;IACC,UAAU,EAAE,KAAK,CAAA;CAClB,GAAG,IAAI,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC,GAChD,CAAC;IACC,UAAU,EAAE,IAAI,CAAA;CACjB,GAAG,yBAAyB,CAAC,CAAA;AAElC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAA;CACxD,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;KAAE,MAAM,IAAI,MAAM,CAAC,CAAC,EAAE,iBAAiB;CAAC,CAAA;AAE5E,MAAM,MAAM,qBAAqB,GAAG,CAAC,IAAI,EAAE;IACzC,QAAQ,EAAE,qBAAqB,CAAA;IAC/B,qBAAqB,EAAE,OAAO,CAAA;CAC/B,KAAK,IAAI,CAAA;AAEV,MAAM,WAAW,iBAAiB;IAChC,oBAAoB,CAAC,IAAI,EAAE;QACzB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;QACpB,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAA;IAE1C,4BAA4B,CAAC,IAAI,EAAE;QACjC,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC;QAAC,yBAAyB,EAAE,IAAI,GAAG,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,CAAC,CAAA;IAEvE,SAAS,CAAC,IAAI,EAAE;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC;QAAC,EAAE,EAAE,OAAO,CAAA;KAAC,CAAC,CAAA;IAEzD,YAAY,CACV,IAAI,EAAE,kBAAkB,GACvB,OAAO,CACR,CAAC;QAAC,EAAE,EAAE,IAAI,CAAA;KAAC,GAAG,6BAA6B,CAAC,GAAG;QAAC,EAAE,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAC,CAC3E,CAAA;IAED,cAAc,CAAC,IAAI,EAAE;QACnB,MAAM,EAAE,MAAM,CAAA;QACd,QAAQ,EAAE,iBAAiB,CAAA;KAC5B,GAAG,OAAO,CAAC;QAAC,EAAE,EAAE,IAAI,CAAA;KAAC,GAAG;QAAC,EAAE,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAC,CAAC,CAAA;IAErD,SAAS,CACP,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAA;KACf,EACD,QAAQ,EAAE,qBAAqB,GAC9B,OAAO,CAAC,MAAM,IAAI,CAAC,CAAA;CACvB;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IAEvD;;OAEG;IACH,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;IAElD;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7D,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE7C;;OAEG;IACH,UAAU,CACR,CAAC,SAAS;QACR,EAAE,EAAE,MAAM,CAAA;KACX,EAED,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,EAAE,EACT,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAAA;IAChB;;OAEG;IACH,OAAO,CACL,CAAC,SAAS;QACR,EAAE,EAAE,MAAM,CAAA;KACX,EAED,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;IACf;;OAEG;IACH,aAAa,CACX,CAAC,SAAS;QACR,EAAE,EAAE,MAAM,CAAA;KACX,EAED,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,EAClB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAA;CACjC,CAAA;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,CAAC,EACX,EAAE,EAAE,CAAC,IAAI,EAAE,8BAA8B,KAAK,OAAO,CAAC,CAAC,CAAC,GACvD,OAAO,CAAC,CAAC,CAAC,CAAA;IACb;;OAEG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACvD;;OAEG;IACH,OAAO,CAAC,CAAC,SAAS;QAAC,EAAE,EAAE,MAAM,CAAA;KAAC,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,MAAM,MAAM,MAAM,CAChB,UAAU,SAAS;IAAC,cAAc,EAAE,MAAM,CAAA;CAAC,EAC3C,OAAO,SAAS,EAAE,GAAG,EAAE,EACvB,UAAU,SAAS,eAAe,GAAG,EAAE,EACvC,SAAS,SAAS,EAAE,GAAG,EAAE,IACvB;IACF,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,UAAU,CAAA;IACnB,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG;IAC7D,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,GAAG,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,EAAE,EAAE,SAAS,SAAS,EAAE,IAAI;IACzE,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,SAAS,EAAE,CACT,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,iCAAiC,CAAC,OAAO,CAAC,KAAK,IAAI,EACxE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,KACjC,IAAI,CAAA;IACT,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,UAAU,IAAI;IAAC,EAAE,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAA;CAAC,CAAA"}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@encorejs/saaz",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Aria Minaei",
+    "email": "aria@theatrejs.com",
+    "url": "https://github.com/AriaMinaei"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ikanishakm/encore",
+    "directory": "packages/saaz"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "prepack": "node ../../devEnv/ensurePublishing.js",
+    "typecheck": "yarn run build:ts",
+    "build": "run-s build:ts build:js build:api-json",
+    "build:ts": "tsc --build ./tsconfig.json",
+    "build:js": "tsx ./devEnv/build.ts",
+    "build:api-json": "api-extractor run --local --config devEnv/api-extractor.json",
+    "prepublish": "node ../../devEnv/ensurePublishing.js",
+    "clean": "rm -rf ./dist && rm -f tsconfig.tsbuildinfo",
+    "docs": "typedoc src/index.ts --out api --plugin typedoc-plugin-markdown --readme none",
+    "precommit": "yarn run docs"
+  },
+  "devDependencies": {
+    "@encorejs/dataverse": "1.0.0",
+    "@encorejs/utils": "0.7.0",
+    "@microsoft/api-extractor": "^7.36.4",
+    "@types/jest": "^26.0.23",
+    "@types/lodash-es": "^4.17.4",
+    "@types/node": "^15.6.2",
+    "esbuild": "^0.12.15",
+    "fast-deep-equal": "^3.1.3",
+    "immer": "^9.0.6",
+    "jest-diff": "^29.6.4",
+    "lodash-es": "^4.17.21",
+    "nanoid": "^4.0.2",
+    "npm-run-all": "^4.1.5",
+    "tsx": "4.7.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.4",
+    "typescript": "5.1.6"
+  },
+  "dependencies": {
+    "idb": "^7.1.1"
+  }
+}