@riboseinc/paneron-registry-kit 2.0.1 → 2.0.2

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

@@ -1,27 +0,0 @@
-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

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

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

@@ -1 +0,0 @@
-{"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

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

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

@@ -1,41 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,6 +0,0 @@
-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

@@ -1,15 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,15 +0,0 @@
-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

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

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

@@ -1 +0,0 @@
-{"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

@@ -1,108 +0,0 @@
-/// <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

@@ -1,23 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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

@@ -1,18 +0,0 @@
-/**
- * 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

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

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

@@ -1 +0,0 @@
-{"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

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

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

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

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

@@ -1 +0,0 @@
-{"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"]}