@riboseinc/paneron-registry-kit 2.0.0-dev9 → 2.0.1

package/dependencies-local/extension-kit/settings.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INITIAL_GLOBAL_SETTINGS = void 0;
+const INITIAL_GLOBAL_SETTINGS = {
+  sidebarPosition: 'right',
+  mainNavbarPosition: 'top'
+};
+exports.INITIAL_GLOBAL_SETTINGS = INITIAL_GLOBAL_SETTINGS;

package/dependencies-local/extension-kit/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,uBAAuB,GAAmB;IACrD,eAAe,EAAE,OAAO;IACxB,kBAAkB,EAAE,KAAK;CAC1B,CAAC","sourcesContent":["export type Settings = Record<string, any>\n\nexport interface GlobalSettings extends Settings {\n  sidebarPosition: 'left' | 'right'\n  mainNavbarPosition: 'top' | 'bottom'\n}\n\nexport const INITIAL_GLOBAL_SETTINGS: GlobalSettings = {\n  sidebarPosition: 'right',\n  mainNavbarPosition: 'top',\n};\n"]}

package/dependencies-local/extension-kit/types/binary-invocation.d.ts

@@ -0,0 +1,31 @@
+export interface BinaryInvocationRequest {
+    /** Path relative to Paneron’s bin directory. No extension, .exe will be auto-appended on Windows. */
+    binaryName: string;
+    /** Arguments will be concatenated. */
+    cliArgs: string[];
+    /**
+     * If true, command is executed inside a shell.
+     * In this case, no untrusted input should be passed to the command.
+     */
+    useShell?: true;
+}
+export interface SubprocessDescription {
+    /** Platform-specific process ID. */
+    pid: number;
+    /** The original options subprocess had been invoked with. */
+    opts: BinaryInvocationRequest;
+    /** What the called subprocess output. */
+    stdout: string;
+    /** What the called subprocess emitted to error output. */
+    stderr: string;
+    /** Termination result. */
+    termination?: ProcessTerminationMetadata;
+}
+export interface ProcessTerminationMetadata {
+    /** Termination code, if any. */
+    code: number | null;
+    /** The signal subprocess was terminated with, if any. */
+    signal: string | null;
+    /** Error description, if any. */
+    error: string | null;
+}

package/dependencies-local/extension-kit/types/binary-invocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binary-invocation.js","sourceRoot":"","sources":["../../src/types/binary-invocation.ts"],"names":[],"mappings":"","sourcesContent":["export interface BinaryInvocationRequest {\n  /** Path relative to Paneron’s bin directory. No extension, .exe will be auto-appended on Windows. */\n  binaryName: string;\n\n  /** Arguments will be concatenated. */\n  cliArgs: string[];\n\n  /**\n   * If true, command is executed inside a shell.\n   * In this case, no untrusted input should be passed to the command.\n   */\n  useShell?: true;\n}\n\nexport interface SubprocessDescription {\n  /** Platform-specific process ID. */\n  pid: number\n\n  /** The original options subprocess had been invoked with. */\n  opts: BinaryInvocationRequest\n\n  /** What the called subprocess output. */\n  stdout: string\n\n  /** What the called subprocess emitted to error output. */\n  stderr: string\n\n  /** Termination result. */\n  termination?: ProcessTerminationMetadata\n}\n\nexport interface ProcessTerminationMetadata {\n  /** Termination code, if any. */\n  code: number | null;\n\n  /** The signal subprocess was terminated with, if any. */\n  signal: string | null;\n\n  /** Error description, if any. */\n  error: string | null;\n}\n"]}

package/dependencies-local/extension-kit/types/buffers.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Buffers describe physical data atoms.
+ * A buffer is a raw binary blob
+ * and in current implementation maps to a file on disk
+ * (or an object in Git repo).
+ *
+ * A buffer is associated with a path (in POSIX format)
+ * that describes its place in data repository tree.
+ *
+ * Multiple buffers may comprise a single logical **object**.
+ */
+import { Change, Changeset } from './changes';
+export declare type BufferDataset = {
+    [bufferPath: string]: Uint8Array | null;
+};
+export declare type BufferChange = Change<Uint8Array>;
+export declare type BufferChangeset = Changeset<BufferChange>;

package/dependencies-local/extension-kit/types/buffers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffers.js","sourceRoot":"","sources":["../../src/types/buffers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG","sourcesContent":["/**\n * Buffers describe physical data atoms.\n * A buffer is a raw binary blob\n * and in current implementation maps to a file on disk\n * (or an object in Git repo).\n * \n * A buffer is associated with a path (in POSIX format)\n * that describes its place in data repository tree.\n * \n * Multiple buffers may comprise a single logical **object**.\n */\n\nimport { Change, Changeset } from './changes';\n\n\nexport type BufferDataset = { [bufferPath: string]: Uint8Array | null };\n\nexport type BufferChange = Change<Uint8Array>;\n\nexport type BufferChangeset = Changeset<BufferChange>;\n"]}

package/dependencies-local/extension-kit/types/changes.d.ts

@@ -0,0 +1,37 @@
+export declare type ChangeStatus = 'modified' | 'added' | 'removed';
+export declare type DiffStatus = ChangeStatus | 'unchanged';
+export interface PathDiff {
+    [path: string]: DiffStatus;
+}
+export interface PathChanges {
+    [path: string]: ChangeStatus;
+}
+/**
+ * Describes a change of an object.
+ *
+ * A null value below means nonexistend object at this path.
+ *
+ * - newValue: null means delete object, if it exists.
+ * - oldValue: null means the object previously did not exist.
+ * - Undefined (unspecified) oldValue means no consistency check.
+ */
+export declare type Change<T extends Uint8Array | Record<string, any>> = {
+    newValue: T | null;
+    oldValue?: T | null;
+};
+export declare type Changeset<C extends Change<any>> = {
+    [path: string]: C;
+};
+/**
+ * The result of applying a changeset.
+ *
+ * `conflicts` shows how paths don’t match reference data (`oldValue`s)
+ * provided by the changeset. Ideally conflicts would be an empty object,
+ *
+ * Paths in conflicts can be object or buffer paths,
+ * depending on use case.
+ */
+export interface CommitOutcome {
+    newCommitHash?: string;
+    conflicts?: PathChanges;
+}

package/dependencies-local/extension-kit/types/changes.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/changes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changes.js","sourceRoot":"","sources":["../../src/types/changes.ts"],"names":[],"mappings":"","sourcesContent":["export type ChangeStatus = 'modified' | 'added' | 'removed';\n\nexport type DiffStatus = ChangeStatus | 'unchanged';\n\nexport interface PathDiff {\n  [path: string]: DiffStatus\n}\n\nexport interface PathChanges {\n  [path: string]: ChangeStatus\n}\n\n/**\n * Describes a change of an object.\n *\n * A null value below means nonexistend object at this path.\n *\n * - newValue: null means delete object, if it exists.\n * - oldValue: null means the object previously did not exist.\n * - Undefined (unspecified) oldValue means no consistency check.\n */\nexport type Change<T extends Uint8Array | Record<string, any>> =\n  { newValue: T | null, oldValue?: T | null };\n\nexport type Changeset<C extends Change<any>> = {\n  [path: string]: C\n}\n\n/**\n * The result of applying a changeset.\n *\n * `conflicts` shows how paths don’t match reference data (`oldValue`s)\n * provided by the changeset. Ideally conflicts would be an empty object,\n *\n * Paths in conflicts can be object or buffer paths,\n * depending on use case.\n */\nexport interface CommitOutcome {\n  // TODO: “Commit hash” ties this to Git; potentially this could be made generic.\n  newCommitHash?: string\n  conflicts?: PathChanges\n}\n"]}

package/dependencies-local/extension-kit/types/data.d.ts

@@ -0,0 +1,54 @@
+export declare type FileChangeType = 'modified' | 'added' | 'removed' | 'unchanged';
+/** Describes single object’s data, can be text with specified encoding or binary data. */
+export declare type ObjectData = null | {
+    value: string;
+    encoding: string;
+} | {
+    value: Uint8Array;
+    encoding: undefined;
+};
+/** Maps a set of object paths to respective data. */
+export interface ObjectDataset {
+    [objectPath: string]: ObjectData;
+}
+/** Maps a set of object paths to object’s change status. */
+export interface ObjectChangeStatusSet {
+    [objectPath: string]: FileChangeType;
+}
+/** Describes a query to retrieve which objects exist without knowing their paths. */
+export interface ObjectQuery {
+    pathPrefix: string;
+    contentSubstring?: string;
+}
+/** Describes a query to get object data for specified object paths. */
+export declare type ObjectDataRequest = Record<string, 'utf-8' | 'binary'>;
+/**
+ * Describes a change made to a single object.
+ *
+ * For data consistency, users must provide `oldValue` to indicate which value should be replaced;
+ * if preexisting value is different from `oldValue` then there was likely a race condition
+ * (object data changed e.g. by another user), the new value should not be written
+ * and user should be informed about a conflict.
+ *
+ * `encoding` is not expected to change through the lifetime of an object.
+ */
+export declare type ObjectChange = {
+    newValue: string | null;
+    encoding: string;
+    oldValue?: string | null;
+} | {
+    newValue: Uint8Array | null;
+    encoding: undefined;
+    oldValue?: Uint8Array | null;
+};
+/** Maps object data changes to object paths. */
+export interface ObjectChangeset {
+    [objectPath: string]: ObjectChange;
+}
+/** The result of applying an ObjectChangeset. */
+export interface CommitOutcome {
+    newCommitHash?: string;
+    conflicts?: {
+        [objectPath: string]: true;
+    };
+}

package/dependencies-local/extension-kit/types/data.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/types/data.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,mDAAmD;AACnD,sDAAsD","sourcesContent":["// DEPRECATED: These types are legacy:\n// - for binary data at physical level see buffers,\n// - for structured data at logical level see objects.\n\n// In context of Git/filesystem based data storage backend,\n// which is currently the only context, “object” below refers to a file,\n// and object path is a string like `folder1/folder2/file.yaml`\n// (depending on context, can be relative to repository root or dataset root).\n// Other backends may be implemented later, so let’s not involve filesystem specifics here.\n\n// Encoding can be any string, but types elsewhere may restrict encoding to 'utf-8' or 'binary'\n// (other encodings have not been tested).\n\nexport type FileChangeType = 'modified' | 'added' | 'removed' | 'unchanged';\n\n\n/** Describes single object’s data, can be text with specified encoding or binary data. */\nexport type ObjectData = null\n  | { value: string, encoding: string }\n  | { value: Uint8Array, encoding: undefined }\n\n\n/** Maps a set of object paths to respective data. */\nexport interface ObjectDataset {\n  [objectPath: string]: ObjectData\n}\n\n\n/** Maps a set of object paths to object’s change status. */\nexport interface ObjectChangeStatusSet {\n  [objectPath: string]: FileChangeType\n}\n\n\n/** Describes a query to retrieve which objects exist without knowing their paths. */\nexport interface ObjectQuery {\n  pathPrefix: string\n  contentSubstring?: string\n}\n\n\n/** Describes a query to get object data for specified object paths. */\nexport type ObjectDataRequest = Record<string, 'utf-8' | 'binary'>;\n\n\n/**\n * Describes a change made to a single object.\n *\n * For data consistency, users must provide `oldValue` to indicate which value should be replaced;\n * if preexisting value is different from `oldValue` then there was likely a race condition\n * (object data changed e.g. by another user), the new value should not be written\n * and user should be informed about a conflict.\n *\n * `encoding` is not expected to change through the lifetime of an object.\n */\nexport type ObjectChange =\n  | { newValue: string | null, encoding: string, oldValue?: string | null }\n  | { newValue: Uint8Array | null, encoding: undefined, oldValue?: Uint8Array | null }\n\n\n/** Maps object data changes to object paths. */\nexport interface ObjectChangeset {\n  // Object path must be supplied / is returned relative to repository root.\n  // Writing null must cause the object to be deleted.\n  // When null is returned, it means object does not exist.\n  [objectPath: string]: ObjectChange\n}\n\n\n/** The result of applying an ObjectChangeset. */\nexport interface CommitOutcome {\n  // TODO: “Commit hash” ties this to Git; potentially this could be made generic.\n  newCommitHash?: string\n  conflicts?: {\n    [objectPath: string]: true\n  }\n}\n"]}

package/dependencies-local/extension-kit/types/dialogs.d.ts

@@ -0,0 +1,15 @@
+import { FileFilter } from './renderer';
+export interface FSDialogProps {
+    prompt: string;
+}
+export interface OpenFileDialogProps extends FSDialogProps {
+    filters?: FileFilter[];
+    allowMultiple?: boolean;
+}
+export interface SelectDirectoryProps extends FSDialogProps {
+    prompt: string;
+}
+export interface SaveFileDialogProps extends FSDialogProps {
+    prompt: string;
+    filters?: FileFilter[];
+}

package/dependencies-local/extension-kit/types/dialogs.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/dialogs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialogs.js","sourceRoot":"","sources":["../../src/types/dialogs.ts"],"names":[],"mappings":"","sourcesContent":["import { FileFilter } from './renderer';\n\n\nexport interface FSDialogProps {\n  prompt: string\n}\n\nexport interface OpenFileDialogProps extends FSDialogProps {\n  filters?: FileFilter[]\n  allowMultiple?: boolean\n}\n\nexport interface SelectDirectoryProps extends FSDialogProps {\n  prompt: string\n}\n\n\nexport interface SaveFileDialogProps extends FSDialogProps {\n  prompt: string\n  filters?: FileFilter[]\n}\n"]}

package/dependencies-local/extension-kit/types/extension-maker.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { Extension } from './extension';
+import { MigrationModule } from './migrations';
+import { ObjectSpec } from './object-spec';
+export interface ExtensionMakerProps {
+    name: string;
+    requiredHostAppVersion: string;
+    mainView: () => Promise<{
+        default: React.FC<Record<never, never>>;
+    }>;
+    objects?: ObjectSpec[];
+    datasetInitializer?: () => MigrationModule;
+    datasetMigrations?: {
+        [versionSpec: string]: () => MigrationModule;
+    };
+}
+export declare type ExtensionMaker = (extensionOptions: ExtensionMakerProps) => Promise<Extension>;

package/dependencies-local/extension-kit/types/extension-maker.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/extension-maker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-maker.js","sourceRoot":"","sources":["../../src/types/extension-maker.ts"],"names":[],"mappings":"","sourcesContent":["import { Extension } from './extension';\nimport { MigrationModule } from './migrations';\nimport { ObjectSpec } from './object-spec';\n\n\nexport interface ExtensionMakerProps {\n  name: string\n  requiredHostAppVersion: string\n\n  /* Principal dataset view. */\n  mainView: () => Promise<{ default: React.FC<Record<never, never>> }>\n\n  /* Object specs allow an extension to provide information about\n     logical objects extension manipulates,\n     such as object view/edit GUI components.\n     Eventually this could also make mainView optional.\n  */\n  objects?: ObjectSpec[]\n\n  /* Instructs which migration to run if new dataset is being initialized.\n     The migration is supposed to return version matching latest extension version. */\n  datasetInitializer?: () => MigrationModule\n\n  /* Instructs a migration to run if current dataset version matches\n     one of these specs (in semver format).\n     The migration will return a new dataset version as a result.\n     The returned version will be checked for migration matches again,\n     the app will keep running matching migrations until one returns a version\n     for which there is no matching migration versionSpec anymore.\n\n     For example:\n\n     Let’s say current extension version is 1.3.4,\n     but user loaded dataset of version 1.1.8.\n\n     If extension developer specified a migration with versionSpec \"<1.2\",\n     the app will require the user to migrate.\n     When migration is run, it’s given dataset path\n     and currently specified version (1.1.8),\n     based on which it rewrites dataset files as necessary\n     and returns a new version (e.g., \"1.2\") after it finishes.\n\n     If developer also specified a migration for \">=1.2 <1.3\",\n     it will be run automatically.\n\n     Let’s say it returns \"1.3\" when finishes.\n     1.3 doesn’t match any migration spec, so dataset version is updated to \"1.3\"\n     and user can start the work.\n\n     New extension versions continue to come out with no migrations necessary,\n     but later the developer changes data schema again in 1.3.7. In that version,\n     they include a migration with versionSpec \">=1.3 <1.3.7\".\n     When user opens their 1.3 dataset, they will be asked to update again,\n     and that migration will run.\n\n     The idea is that extension developer only has to support the most current\n     data schema version, but they must alwyas provide migrations\n     if data schema changes.\n\n     IMPORTANT: It is developer’s responsibility\n     to carefully specify migration version specs,\n     as they could create infinite migration loops if they wanted to.\n  */\n  datasetMigrations?: {\n    [versionSpec: string]: () => MigrationModule\n  }\n}\n\n\nexport type ExtensionMaker =\n  (extensionOptions: ExtensionMakerProps) => Promise<Extension>;\n"]}

package/dependencies-local/extension-kit/types/extension.d.ts

@@ -0,0 +1,27 @@
+import type React from 'react';
+import type { ObjectSpec, ObjectSpecViewID, ObjectViewProps } from './object-spec';
+import type { DatasetMigrationFunction, MigrationModule } from './migrations';
+import type { DatasetContext } from './renderer';
+/**
+ * The interface that extension instance exposes to Paneron in main thread.
+ *
+ * TODO: Deprecated.
+ */
+export interface MainPlugin {
+    isCompatible: (withHostAppVersion: string) => boolean;
+    getMigration: (datasetVersion: string) => {
+        versionSpec: string;
+        migration: () => MigrationModule;
+    } | undefined;
+    initialMigration: DatasetMigrationFunction;
+    getObjectSpecs: () => ObjectSpec[];
+}
+/** The interface that extension instance exposes to Paneron in renderer thread. */
+export interface RendererPlugin {
+    mainView?: React.FC<DatasetContext>;
+    getObjectView: (opts: {
+        objectPath: string;
+        viewID: ObjectSpecViewID;
+    }) => React.FC<ObjectViewProps> | undefined;
+}
+export declare type Extension = MainPlugin | RendererPlugin;

package/dependencies-local/extension-kit/types/extension.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension.js","sourceRoot":"","sources":["../../src/types/extension.ts"],"names":[],"mappings":"","sourcesContent":["import type React from 'react';\nimport type { ObjectSpec, ObjectSpecViewID, ObjectViewProps } from './object-spec';\nimport type { DatasetMigrationFunction, MigrationModule } from './migrations';\nimport type { DatasetContext } from './renderer';\n\n\n/**\n * The interface that extension instance exposes to Paneron in main thread.\n * \n * TODO: Deprecated.\n */\nexport interface MainPlugin {\n  // False means another version of the host app must be used (probably a newer one).\n  isCompatible: (withHostAppVersion: string) => boolean\n\n  // Non-null result means migration must be applied for user to proceed.\n  getMigration: (datasetVersion: string) => {\n    versionSpec: string\n    migration: () => MigrationModule \n  } | undefined\n\n  initialMigration: DatasetMigrationFunction\n\n  getObjectSpecs: () => ObjectSpec[]\n}\n\n\n/** The interface that extension instance exposes to Paneron in renderer thread. */\nexport interface RendererPlugin {\n  mainView?: React.FC<DatasetContext>\n  getObjectView:\n    (opts: { objectPath: string, viewID: ObjectSpecViewID }) =>\n      React.FC<ObjectViewProps> | undefined\n}\n\nexport type Extension = MainPlugin | RendererPlugin;\n"]}

package/dependencies-local/extension-kit/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './extension';
+export * from './data';
+export * from './renderer';

package/dependencies-local/extension-kit/types/index.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _extension = require("./extension");
+
+Object.keys(_extension).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _extension[key];
+    }
+  });
+});
+
+var _data = require("./data");
+
+Object.keys(_data).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _data[key];
+    }
+  });
+});
+
+var _renderer = require("./renderer");
+
+Object.keys(_renderer).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _renderer[key];
+    }
+  });
+});

package/dependencies-local/extension-kit/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC","sourcesContent":["export * from './extension';\nexport * from './data';\nexport * from './renderer';\n"]}

package/dependencies-local/extension-kit/types/indexes.d.ts

@@ -0,0 +1,6 @@
+import { Progress } from './progress';
+export interface IndexStatus {
+    objectCount: number;
+    progress?: Progress<'initializing' | 'counting' | 'indexing'>;
+}
+export declare const INITIAL_INDEX_STATUS: IndexStatus;

package/dependencies-local/extension-kit/types/indexes.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.INITIAL_INDEX_STATUS = void 0;
+const INITIAL_INDEX_STATUS = {
+  objectCount: 0,
+  progress: {
+    phase: 'initializing',
+    total: 0,
+    loaded: 0
+  }
+};
+exports.INITIAL_INDEX_STATUS = INITIAL_INDEX_STATUS;

package/dependencies-local/extension-kit/types/indexes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexes.js","sourceRoot":"","sources":["../../src/types/indexes.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,oBAAoB,GAAgB;IAC/C,WAAW,EAAE,CAAC;IACd,QAAQ,EAAE;QACR,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,CAAC;QACR,MAAM,EAAE,CAAC;KACV;CACF,CAAA","sourcesContent":["import { Progress } from './progress';\n\n// Describes status of a filtered (or future custom) object index of a dataset\nexport interface IndexStatus {\n  objectCount: number\n  progress?: Progress<'initializing' | 'counting' | 'indexing'>\n}\n\n\nexport const INITIAL_INDEX_STATUS: IndexStatus = {\n  objectCount: 0,\n  progress: {\n    phase: 'initializing',\n    total: 0,\n    loaded: 0,\n  },\n}\n"]}

package/dependencies-local/extension-kit/types/migrations.d.ts

@@ -0,0 +1,15 @@
+import { BufferChangeset } from './buffers';
+export interface DatasetMigrationOptions {
+    datasetRootPath: string;
+    versionBefore?: string;
+    onProgress?: (message: string) => void;
+}
+interface DatasetMigrationSpec {
+    bufferChangeset: BufferChangeset;
+    versionAfter: string;
+}
+export declare type DatasetMigrationFunction = (opts: DatasetMigrationOptions) => Promise<DatasetMigrationSpec>;
+export declare type MigrationModule = Promise<{
+    default: DatasetMigrationFunction;
+}>;
+export {};

package/dependencies-local/extension-kit/types/migrations.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.js","sourceRoot":"","sources":["../../src/types/migrations.ts"],"names":[],"mappings":"","sourcesContent":["import { BufferChangeset } from './buffers';\n\n\nexport interface DatasetMigrationOptions {\n  datasetRootPath: string\n  versionBefore?: string\n  onProgress?: (message: string) => void\n}\n\n/* Changeset describing changes that will make the dataset\n   conform to a version, and that version. */\ninterface DatasetMigrationSpec {\n  bufferChangeset: BufferChangeset\n  versionAfter: string\n}\n\n/* Given dataset path and current (‘before’) version, checks files at that path\n   and returns a migration spec.\n\n   If current version is not given, assume that a new dataset is initialized. */\nexport type DatasetMigrationFunction =\n  (opts: DatasetMigrationOptions) => Promise<DatasetMigrationSpec>;\n\nexport type MigrationModule =\n  Promise<{ default: DatasetMigrationFunction }>;\n"]}

package/dependencies-local/extension-kit/types/object-spec.d.ts

@@ -0,0 +1,108 @@
+/// <reference types="react" />
+import type { BufferDataset } from './buffers';
+export interface PathMatcher {
+    /**
+     * Will apply any object path under given prefix,
+     * slash-prepended, relative to dataset root. */
+    pathPrefix?: string;
+    /**
+     * Will apply if this function,
+     * called with object path relative to dataset root, returns true. */
+    path?: (objectPath: string) => boolean;
+}
+/**
+ * Describes how Paneron built-in GUI should treat an object
+ * that matches this spec.
+ */
+export interface ObjectSpec {
+    /**
+     * All given conditions will be AND’ed together in order.
+     *
+     * If none are given, object is considered matching by default,
+     * so object spec with empty `matches` rule that comes last in a list
+     * can act as a catch-all.
+     */
+    matches: PathMatcher;
+    /**
+     * Available views for objects matching this type.
+     *
+     * Paneron can use these views when showing objects
+     * in its own views outside of extension’s main dataset view
+     * (e.g., during conflict resolution).
+     *
+     * Paneron uses views “full” and “item”.
+     */
+    views?: () => Promise<{
+        default: ObjectSpecViews;
+    }>;
+}
+declare const objectSpecViewIDs: readonly ["full", "item"];
+export declare type ObjectSpecViewID = typeof objectSpecViewIDs[number];
+export interface ObjectViewProps {
+    objectPath: string;
+    /** Deserialized object data to display. */
+    objectData: Record<string, any>;
+    /**
+     * If object can be changed, view should call this handler with updated data.
+     * NOTE: Doesn’t make sense for some views (e.g., item views). */
+    onChange?: (newData: Record<string, any>, msg?: string) => void;
+}
+interface ObjectSpecViews {
+    full: React.FC<ObjectViewProps>;
+    item?: React.FC<ObjectViewProps>;
+}
+export declare enum AtomicSerDesRuleName {
+    lfsPointer = "lfspointer",
+    textFile = "textfile",
+    jsonFile = "jsonfile",
+    yamlFile = "yamlfile",
+    binaryFile = "binaryfile"
+}
+export declare enum CompositeSerDesRuleName {
+}
+/** A union of available ser/des rule names. */
+export declare type SerDesRuleName = AtomicSerDesRuleName | CompositeSerDesRuleName;
+export declare type SerDesRuleNameExtensionMap = {
+    [ext: string]: SerDesRuleName;
+};
+/**
+ * Specifies how to transform an object as runtime in-memory structure
+ * to a storeable byte array and vice-versa
+ * (i.e., serializer/deserializer).
+ *
+ * Also specifies which objects this rule can be applied to.
+ */
+export interface SerDesRule<ObjectType extends Record<string, any> = any, Opts extends Record<string, any> = any> {
+    /**
+     * Called with object data,
+     * returns buffer dataset (a record that maps file paths to buffer data).
+     */
+    serialize: (object: ObjectType, opts: Opts) => Record<string, Uint8Array>;
+    /**
+     * Called with a buffer dataset,
+     * returns object representation,
+     * deserialized if possible.
+     */
+    deserialize: (data: Record<string, Uint8Array>, opts: Opts) => ObjectType;
+    /**
+     * Inspects a buffer/object path (tyipcally looks at extension)
+     * and returns whether this rule applies to it.
+     *
+     * If not defined, the rule is assumed to work for any path.
+     */
+    worksForPath?: (objPath: string) => boolean;
+    /**
+     * Inspects object and returns whether this rule can serialize it.
+     * (A lot like a type guard for ObjectType would do.)
+     *
+     * If not defined, assumed to always work.
+     */
+    worksForObject?: (obj: ObjectType) => boolean;
+    /**
+     * Inspects buffer data and returns whether this rule can deserialize it.
+     *
+     * If not defined, assumed to always work.
+     */
+    worksForBufferDataset?: (data: BufferDataset) => boolean;
+}
+export {};

package/dependencies-local/extension-kit/types/object-spec.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CompositeSerDesRuleName = exports.AtomicSerDesRuleName = void 0;
+const objectSpecViewIDs = ['full', 'item'];
+var AtomicSerDesRuleName;
+exports.AtomicSerDesRuleName = AtomicSerDesRuleName;
+
+(function (AtomicSerDesRuleName) {
+  AtomicSerDesRuleName["lfsPointer"] = "lfspointer";
+  AtomicSerDesRuleName["textFile"] = "textfile";
+  AtomicSerDesRuleName["jsonFile"] = "jsonfile";
+  AtomicSerDesRuleName["yamlFile"] = "yamlfile";
+  AtomicSerDesRuleName["binaryFile"] = "binaryfile";
+})(AtomicSerDesRuleName || (exports.AtomicSerDesRuleName = AtomicSerDesRuleName = {}));
+
+var CompositeSerDesRuleName;
+exports.CompositeSerDesRuleName = CompositeSerDesRuleName;
+
+(function (CompositeSerDesRuleName) {//paneronObject = 'paneronObject',
+})(CompositeSerDesRuleName || (exports.CompositeSerDesRuleName = CompositeSerDesRuleName = {}));

package/dependencies-local/extension-kit/types/object-spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-spec.js","sourceRoot":"","sources":["../../src/types/object-spec.ts"],"names":[],"mappings":"AA4CA,MAAM,iBAAiB,GAAG;IACxB,MAAM;IACN,MAAM;CACE,CAAC;AAyBX,MAAM,CAAN,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,iDAAyB,CAAA;IACzB,6CAAqB,CAAA;IACrB,6CAAqB,CAAA;IACrB,6CAAqB,CAAA;IACrB,iDAAyB,CAAA;AAC3B,CAAC,EANW,oBAAoB,KAApB,oBAAoB,QAM/B;AAED,MAAM,CAAN,IAAY,uBAEX;AAFD,WAAY,uBAAuB;IACjC,kCAAkC;AACpC,CAAC,EAFW,uBAAuB,KAAvB,uBAAuB,QAElC","sourcesContent":["import type { BufferDataset } from './buffers';\n\nexport interface PathMatcher {\n  /**\n   * Will apply any object path under given prefix,\n   * slash-prepended, relative to dataset root. */\n  pathPrefix?: string\n\n  /**\n   * Will apply if this function,\n   * called with object path relative to dataset root, returns true. */\n  path?: (objectPath: string) => boolean\n}\n\n\n/** \n * Describes how Paneron built-in GUI should treat an object\n * that matches this spec.\n */\nexport interface ObjectSpec {\n\n  /**\n   * All given conditions will be AND’ed together in order.\n   * \n   * If none are given, object is considered matching by default,\n   * so object spec with empty `matches` rule that comes last in a list\n   * can act as a catch-all.\n   */\n  matches: PathMatcher\n\n  /**\n   * Available views for objects matching this type.\n   * \n   * Paneron can use these views when showing objects\n   * in its own views outside of extension’s main dataset view\n   * (e.g., during conflict resolution).\n   * \n   * Paneron uses views “full” and “item”.\n   */\n  views?: () => Promise<{ default: ObjectSpecViews }>\n\n}\n\n\nconst objectSpecViewIDs = [\n  'full',\n  'item',\n] as const;\n\n\nexport type ObjectSpecViewID = typeof objectSpecViewIDs[number];\n\n\nexport interface ObjectViewProps {\n  objectPath: string\n\n  /** Deserialized object data to display. */\n  objectData: Record<string, any>\n\n  /**\n   * If object can be changed, view should call this handler with updated data.\n   * NOTE: Doesn’t make sense for some views (e.g., item views). */\n  onChange?: (newData: Record<string, any>, msg?: string) => void\n}\n\n\ninterface ObjectSpecViews {\n  full: React.FC<ObjectViewProps>\n  item?: React.FC<ObjectViewProps>\n}\n\n\nexport enum AtomicSerDesRuleName {\n  lfsPointer = 'lfspointer',\n  textFile = 'textfile',\n  jsonFile = 'jsonfile',\n  yamlFile = 'yamlfile',\n  binaryFile = 'binaryfile',\n}\n\nexport enum CompositeSerDesRuleName {\n  //paneronObject = 'paneronObject',\n}\n\n/** A union of available ser/des rule names. */\nexport type SerDesRuleName = AtomicSerDesRuleName | CompositeSerDesRuleName\n\n\nexport type SerDesRuleNameExtensionMap = { [ext: string]: SerDesRuleName }\n\n\n\n/**\n * Specifies how to transform an object as runtime in-memory structure\n * to a storeable byte array and vice-versa\n * (i.e., serializer/deserializer).\n *\n * Also specifies which objects this rule can be applied to.\n */\nexport interface SerDesRule<\n  ObjectType extends Record<string, any> = any,\n  Opts extends Record<string, any> = any,\n> {\n  /**\n   * Called with object data,\n   * returns buffer dataset (a record that maps file paths to buffer data).\n   */\n  serialize: (object: ObjectType, opts: Opts) => Record<string, Uint8Array>\n\n  /**\n   * Called with a buffer dataset,\n   * returns object representation,\n   * deserialized if possible.\n   */\n  deserialize: (data: Record<string, Uint8Array>, opts: Opts) => ObjectType\n\n  /**\n   * Inspects a buffer/object path (tyipcally looks at extension)\n   * and returns whether this rule applies to it.\n   *\n   * If not defined, the rule is assumed to work for any path.\n   */\n  worksForPath?: (objPath: string) => boolean\n\n  /**\n   * Inspects object and returns whether this rule can serialize it.\n   * (A lot like a type guard for ObjectType would do.)\n   *\n   * If not defined, assumed to always work.\n   */\n  worksForObject?: (obj: ObjectType) => boolean\n\n  /**\n   * Inspects buffer data and returns whether this rule can deserialize it.\n   *\n   * If not defined, assumed to always work.\n   */\n  worksForBufferDataset?: (data: BufferDataset) => boolean\n\n}\n"]}

package/dependencies-local/extension-kit/types/objects.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Objects describe logical data atoms.
+ *
+ * On physical level, an object is comprised of one or more **buffers**.
+ *
+ * Object path is taken to be the path to its root buffer
+ * relative to dataset (not repository as a whole).
+ *
+ * Conversion between buffers and objects is specified
+ * by ser/des rules.
+ */
+import { Change, Changeset } from './changes';
+export declare type Object = Record<string, any>;
+export declare type ObjectDataset = {
+    [objectPath: string]: Object | null;
+};
+export declare type ObjectChange<T extends Object = Record<string, any>> = Change<T>;
+export declare type ObjectChangeset<T extends Object = Record<string, any>> = Changeset<ObjectChange<T>>;

package/dependencies-local/extension-kit/types/objects.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../../src/types/objects.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG","sourcesContent":["/**\n * Objects describe logical data atoms.\n *\n * On physical level, an object is comprised of one or more **buffers**.\n *\n * Object path is taken to be the path to its root buffer\n * relative to dataset (not repository as a whole).\n *\n * Conversion between buffers and objects is specified\n * by ser/des rules.\n */\n\nimport { Change, Changeset } from './changes';\n\n\n/* DEPRECATED. */\nexport type Object = Record<string, any>;\n// TODO: Rename this type to avoid the clash with default Object.\n// Options: LogicalObject?\n\nexport type ObjectDataset = { [objectPath: string]: Object | null };\n\nexport type ObjectChange<T extends Object = Record<string, any>> = Change<T>;\n\nexport type ObjectChangeset<T extends Object = Record<string, any>> = Changeset<ObjectChange<T>>\n"]}

package/dependencies-local/extension-kit/types/progress.d.ts

@@ -0,0 +1,5 @@
+export interface Progress<P extends string = string> {
+    phase: P;
+    loaded: number;
+    total: number;
+}

package/dependencies-local/extension-kit/types/progress.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dependencies-local/extension-kit/types/progress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.js","sourceRoot":"","sources":["../../src/types/progress.ts"],"names":[],"mappings":"","sourcesContent":["// Describes progress of some operation\nexport interface Progress<P extends string = string> {\n  phase: P\n  loaded: number\n  total: number\n}\n"]}