@riboseinc/paneron-registry-kit 2.2.60 → 2.2.61

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

@@ -1,505 +0,0 @@
-/// <reference types="react" />
-/** Mimics FileFilter from electron without having to import Electron. */
-export interface FileFilter {
-    /** NOTE: Extensions should not contain the leading separator (dot/period). */
-    extensions: string[];
-    /** Name to be shown to the user for this filter. */
-    name: string;
-}
-import type { ObjectDataset, ObjectChangeset } from './objects';
-import type { CommitOutcome } from './changes';
-import type { IndexStatus } from './indexes';
-import type { BaseAction, PersistentStateReducerHook } from '../usePersistentStateReducer';
-import type { TimeTravelingPersistentStateReducerHook } from '../useTimeTravelingPersistentStateReducer';
-import type { Settings, GlobalSettings } from '../settings';
-import type { OpenFileDialogProps, SaveFileDialogProps } from './dialogs';
-import type { SubprocessDescription } from './binary-invocation';
-import type { ExportFormatInfo } from './export-formats';
-import type { ObjectSpecViewID, ObjectViewProps } from './object-spec';
-import type { ContextSpec as OperationContext } from '../widgets/OperationQueue/context';
-/** A specification of context available to extension component. */
-export interface DatasetContext extends OperationContext {
-    /** Dataset title, as specified by dataset manifest/metadata YAML file in the repository. */
-    title: string;
-    logger: {
-        log: Console["log"];
-        error: Console["error"];
-        debug: Console["debug"];
-    };
-    /** Launches specified URI in OS’s default browser. */
-    openExternalLink: (opts: {
-        uri: string;
-    }) => Promise<void>;
-    /** Retrieves object data, and does its best to auto-refresh hook value if objects change. */
-    useObjectData: Hooks.Data.GetObjectDataset;
-    /**
-     * Retrieves object data, as a simple async function.
-     * Generally it’s recommended to use the `useObjectData` hook instead.
-     *
-     * Request parameters are the same as to the hook.
-     */
-    getObjectData: (opts: ObjectDatasetRequest) => Promise<ObjectDatasetResponse>;
-    /**
-     * Builds (or reuses) custom dataset index for windowed data access.
-     *
-     * Filtered indexes are based on *query expressions*.
-     * A query expression is a small predicate function that returns true or false for each object
-     * in the dataset; objects for which true is returned are included in the filtered index.
-     *
-     * Whenever dataset contents change,
-     * Paneron calculates (using query expression)
-     * which filtered object indexes were affected by the change,
-     * performs relevant updates on those indexes
-     * and issues events triggering requisite hook refreshes & dependent GUI updates.
-     *
-     * NOTE: In some cases Paneron may fail to react to underlying object change,
-     * resulting in stale indexes. In such cases, the user can refresh indexes.
-     *
-     * This hook will not unnecessarily create filtered index
-     * if it already exists for given query expression.
-     *
-     * This hook returns filtered object index ID,
-     * which is intended to be used for further calls:
-     *
-     * - Filtered index status can be obtained using `useIndexDescription()`.
-     *
-     * - Filtered object paths can be subsequently obtained
-     *   via `useObjectPathFromFilteredIndex()`,
-     *   which in turn can be passed to `useObjectData()`
-     *   in order to obtain actual deserialized obejct data.
-     */
-    useFilteredIndex: Hooks.Indexes.GetOrCreateFiltered;
-    /** Describes a filtered object index: provides indexing status and object count. */
-    useIndexDescription: Hooks.Indexes.Describe;
-    /**
-     * Retrieve an object from a filtered index by its position in the index.
-     * Used for efficient data windowing.
-     */
-    useObjectPathFromFilteredIndex: Hooks.Indexes.GetFilteredObject;
-    /** Non-hook equivalent of `useObjectPathFromFilteredIndex()` as plain async function. */
-    getObjectPathFromFilteredIndex: (opts: FilteredObjectPathRequest) => Promise<FilteredObjectPathResponse>;
-    /**
-     * Given object path, retrieve its position in given filtered object index.
-     * NOTE: The primary use case of this hook is workaround-ish, so it may be deprecated in future.
-     */
-    useFilteredIndexPosition: Hooks.Indexes.GetFilteredObjectIndexPosition;
-    /** Non-hook equivalent of `useFilteredIndexPosition()` as plain async function. */
-    getFilteredIndexPosition: (opts: FilteredObjectIndexPositionRequest) => Promise<FilteredObjectIndexPositionResponse>;
-    /**
-     * Runs a set of map-reduce chains over the entire dataset.
-     * The final result is an object where each key is one of given chain IDs,
-     * and the value corresponding to the output of map-reduce chain
-     * (if `reduceFunc` is not provided, the corresponding value is always a list).
-     * `predicateFunc` is required.
-     *
-     */
-    useMapReducedData: <C extends Record<string, any>>(opts: {
-        chains: Record<string, Omit<Hooks.Data.MapReduceChain, 'predicateFunc'> & {
-            predicateFunc: string;
-        }>;
-    }) => ValueHook<C>;
-    /**
-     * As useMapReducedData, but in the shape of a regular async function.
-     */
-    getMapReducedData: <C extends Record<string, any>>(opts: {
-        chains: Record<string, Hooks.Data.MapReduceChain>;
-    }) => Promise<C>;
-    usePersistentDatasetStateReducer: Hooks.UsePersistentDatasetStateReducer<any, any>;
-    useTimeTravelingPersistentDatasetStateReducer: Hooks.UseTimeTravelingPersistentDatasetStateReducer<any, any>;
-    /**
-     * Invokes the bundled Metanorma binary with given arguments, and returns subprocess description.
-     *
-     * For ongoing monitoring of invocation status, use `useMetanormaInvocationStatus()`.
-     *
-     * NOTE: It may be available even if Metanorma binary does not exist, in which case invocation will throw an error.
-     */
-    invokeMetanorma?: (opts: {
-        cliArgs: string[];
-    }) => Promise<SubprocessDescription>;
-    /**
-     * Query Metanorma subprocess execution status.
-     *
-     * - Will return null if Metanorma subprocess cannot be found.
-     *
-     * - Will auto-refresh returned subprocess description.
-     */
-    useMetanormaInvocationStatus?: () => ValueHook<SubprocessDescription | null>;
-    operationKey?: string;
-    /**
-     * Provides access to remote username, as configured in Paneron settings.
-     *
-     * NOTE: Dataset extension *could* use it to infer author’s role by comparing with some list.
-     * However, this is not a security measure and must be used for sensitive access control
-     * in place of Git server-level authentication.
-     *
-     * This hook can be used for informative purposes to show role-appropriate GUIs
-     * to already trusted users who will abide
-     * despite technically being able to sidestep the comparison.
-     */
-    useRemoteUsername: RemoteUsernameHook;
-    copyObjects: (objects: ObjectDataset) => Promise<void>;
-    requestCopiedObjects: () => Promise<ObjectDataset>;
-    /**
-     * Returns Paneron-global settings that may make sense for extensions
-     * (e.g., sidebar positioning).
-     *
-     * TODO: Allow overriding global settings with scoped?
-     */
-    useGlobalSettings: Hooks.Settings.UseGlobalSettings;
-    /** Returns arbitrary settings scoped to current dataset. */
-    useSettings: Hooks.Settings.UseSettings;
-    /** Updates a given setting in dataset scope. */
-    updateSetting: Hooks.Settings.UpdateSetting;
-    /** TODO: Provisional; for the new extension architecture */
-    getObjectView: (opts: {
-        objectPath: string;
-        viewID: ObjectSpecViewID;
-    }) => React.FC<ObjectViewProps> | undefined;
-    /** Returns a string value obtained from a binary blob given as Uint8Array. */
-    useDecodedBlob: Hooks.UseDecodedBlob;
-    /** Given a string, will return a binary blob as Uint8Array. */
-    getBlob?: (fromStringValue: string) => Promise<Uint8Array>;
-    /**
-     * Generates a UUID (not really useful in read-only mode, so is optional)
-     *
-     * @deprecated use browser’s `crypto.randomUUID()` instead?
-     */
-    makeRandomID?: () => Promise<string>;
-    /**
-     * Commits changes to the dataset on per-object level.
-     */
-    updateObjects?: Hooks.Data.UpdateObjects;
-    /**
-     * Manipulates repository data (within the dataset) on subtree level (delete or move subtree).
-     *
-     * NOTE: Does not do integrity checks. Dangerous.
-     */
-    updateTree?: Hooks.Data.UpdateObjectTree;
-    /**
-     * Invokes file selection dialog and returns file data as object dataset when user confirms.
-     * This does not mutate dataset / Git repo contents, updateObjects still
-     * must be invoked later in order to commit newly added or replaced file.
-     */
-    requestFileFromFilesystem?: (opts: OpenFileDialogProps, cb?: (data: ObjectDataset) => void) => Promise<ObjectDataset>;
-    /**
-     * Invokes file save dialog,
-     * writes provided buffer data to chosen file path,
-     * and returns that path.
-     *
-     * Note: currently this does not yet check selected path for sanity,
-     * so the user can write to repository’s own working directory
-     * and mess things up.
-     */
-    writeFileToFilesystem?: (opts: {
-        dialogOpts: SaveFileDialogProps;
-        bufferData: Uint8Array;
-    }) => Promise<{
-        success: true;
-        savedToFileAtPath: string;
-    }>;
-    /**
-     * List available export options.
-     * Some may be registered by dataset extension,
-     * some may be default provided by host app itself.
-     */
-    listExporters: () => {
-        [exporter: string]: ExportFormatInfo;
-    };
-    /**
-     * Invokes file selection dialog,
-     * if any files were selected adds them to dataset at specified path,
-     * and makes a commit with specified commit message.
-     *
-     * For performance, this function breaks the logical object layer abstraction:
-     * it does not deserialize buffers and treats selected files
-     * as pre-serialized low-level repository buffers.
-     *
-     * If object(s) with same names already exist at the path,
-     * will overwrite them with new versions.
-     *
-     * `opts` can modify that behavior,
-     * see its member documentation for details.
-     *
-     * Returned commit outcome can be null if no objects were selected.
-     */
-    addFromFilesystem?: (
-    /**
-     * Options to pass to OS file selection dialog.
-     *
-     * NOTE: `allowMultiple` has no effect
-     * if `opts.replaceTarget` is set.
-     */
-    dialogOpts: OpenFileDialogProps, commitMessage: string, 
-    /**
-     * Default behavior is to preserve original filenames
-     * and treat `targetPath` as a tree root under which
-     * new objects will be written as leaf objects with full contents.
-     * If target path exists and is a leaf object (file),
-     * or a leaf object exists with the same name as one of the selected files,
-     * the call will fail.
-     *
-     * Note: `opts.replaceTarget` changes this behavior.
-     */
-    targetPath: string, opts: {
-        /**
-         * Whether to replace `targetPath`.
-         *
-         * Treat `targetPath` as a leaf buffer (file) and replace it.
-         * The user will be able to select only one file in this case
-         * (`dialogOpts.allowMultiple` will have no effect).
-         *
-         * Any existing object at `targetPath` will be replaced.
-         * Original filename will be ignored.
-         * If target path exists and is a tree (directory), the call will fail.
-         */
-        replaceTarget?: true;
-        /**
-         * If specified as true, selected file(s) will be uploaded to LFS,
-         * and only after successful upload LFS pointer files will be committed
-         * in place of actual file contents.
-         *
-         * If upload fails, an error will be thrown.
-         *
-         * NOTE: If some LFS upload succeeds but subsequent commit fails
-         * (or is later reverted), or upload for another object fails,
-         * already uploaded data may remain on LFS and keep costing storage.
-         *
-         * NOTE: If repository does not have the remote configured,
-         * this option will have no effect
-         * (actual blobs will be stored directly in repository).
-         *
-         * NOTE: Regarding authentication, LFS is expected to use the same
-         * credentials as Git. If Git authentication details
-         * (both username and password) cannot be retrieved
-         * from OS credential storage, the call will throw an error.
-         */
-        offloadToLFS?: true;
-    }) => Promise<{
-        commitOutcome: CommitOutcome | null;
-    }>;
-}
-/**
- * A hook that contains the result of calling some endpoint
- * and a way of refreshing the result.
- */
-export interface ValueHook<T> {
-    /** The value returned from the call. */
-    value: T;
-    /**
-     * A list of errors, usually one item, as strings.
-     * Non-empty if there were errors thrown by IPC handler.
-     */
-    errors: string[];
-    /**
-     * Whether the value is currently being updated
-     * (handler response is being awaited).
-     */
-    isUpdating: boolean;
-    /**
-     * Can be used to imperatively refresh returned value
-     * by calling handler.
-     *
-     * Generally, it’s better to pass the appropriate memoize arguments instead.
-     */
-    refresh: () => void;
-    _reqCounter: number;
-}
-export declare type FilteredObjectPathRequest = {
-    /**
-     * The ID of the filtered object index from which the object is requested.
-     * Index ID is returned by `useFilteredIndex()` hook.
-     */
-    indexID: string;
-    /**
-     * Numerical position of object path in this index.
-     *
-     * Filter description hook will return the total number of objects in this index,
-     * and that can be used as the upper bound for position.
-     */
-    position: number;
-};
-export declare type FilteredObjectPathResponse = {
-    /**
-     * Object path at requested position in the index.
-     * This path can be passed to, e.g., `useObjectData()` to obtain actual deserialized object.
-     *
-     * NOTE: there are some edge cases where objectPath can be empty, and those need to be documented.
-     * However, `useObjectData()` will not cause a loud error if an empty path is passed.
-     */
-    objectPath: string;
-};
-export declare type FilteredObjectIndexPositionRequest = {
-    /** The ID of the filtered object index from which object position is requested. */
-    indexID: string;
-    /** Object path, for which position is requested. */
-    objectPath: string;
-};
-export declare type FilteredObjectIndexPositionResponse = {
-    /**
-     * Position of given object in the index.
-     * Can be null if object path was not found in the index.
-     */
-    position: number | null;
-};
-export declare type ObjectDatasetRequest = {
-    /** A list of dataset-relative object paths to fetch. */
-    objectPaths: string[];
-    /**
-     * Whether or not to attempt to resolve large file storage pointers.
-     *
-     * The behavior for an unresolved LFS pointer is to return
-     * an object with a single `lfsPointerInfo` property
-     * instead of actual object data for that path.
-     * (You can test for that property when displaying the object.)
-     *
-     * With this flag, when an LFS pointer is encountered,
-     * Paneron will attempt to download the full blob
-     * if it is not cached yet. This may take some time.
-     *
-     * NOTE: this flag does not guarantee all pointers will be resolved.
-     *
-     * - A failed download will cause an unresolved pointer to be returned.
-     *
-     * - If repository does not have remote configured,
-     *   this flag will not have effect (unresolved pointers will be returned).
-     *
-     * NOTE: Regarding authentication, LFS is expected to use the same
-     * credentials as Git. If Git authentication details
-     * (both username and password) cannot be retrieved
-     * from OS credential storage, the call will throw an error.
-     */
-    resolveLFS?: true;
-};
-export declare type ObjectDatasetResponse = {
-    /**
-     * A map of requested object paths to deserialized object data, except:
-     *
-     * - If no object data could be retrieved for given object path,
-     *   object path will be mapped to `null`.
-     *
-     * - If `resolveLFS` was not set,
-     *   objects that are pointers to LFS will be returned as is
-     *   (they will not contain the actual deserialized object data).
-    */
-    data: ObjectDataset;
-};
-export declare namespace Hooks {
-    type UseDecodedBlob = (opts: {
-        blob: Uint8Array;
-    }) => {
-        asString: string;
-    };
-    type UsePersistentDatasetStateReducer<S, A extends BaseAction> = PersistentStateReducerHook<S, A>;
-    type UseTimeTravelingPersistentDatasetStateReducer<S, A extends BaseAction> = TimeTravelingPersistentStateReducerHook<S, A>;
-    namespace Settings {
-        type UseGlobalSettings = () => ValueHook<{
-            settings: GlobalSettings;
-        }>;
-        type UseSettings = () => ValueHook<{
-            settings: Settings;
-        }>;
-        type UpdateSetting = (opts: {
-            key: string;
-            value: any;
-        }) => Promise<{
-            success: true;
-        }>;
-    }
-    namespace Indexes {
-        type Describe = (opts: {
-            /** Filtered object index ID. Is returned by `useFilteredIndex()`. */
-            indexID?: string;
-        }) => ValueHook<{
-            status: IndexStatus;
-        }>;
-        type GetOrCreateFiltered = (opts: {
-            /**
-             * Query expression for the index.
-             *
-             * This must be a string containing a valid function definition.
-             * The function will be constructed from this definition once,
-             * and invoked against every object in default index.
-             *
-             * The function must return either true or false. Objects for which
-             * `queryExpression` returns true will be included in this index.
-             *
-             * The function will receive two positional arguments, called:
-             * 1. `objPath` (dataset-relative path to the object, including file extension if any)
-             * 2. `obj` (deserialized object data, as a JavaScript object)
-             *
-             * Thus, the function can do simple tests against object path,
-             * like returning all objects that end with index.yaml and are in some subdirectory:
-             *
-             *     `return objPath.startsWith('/some/subdirectory/') && objPath.endsWith('index.yaml')`
-             *
-             * as well as do slightly more complex investigation of deserialized object properties,
-             * like finding all objects which contain `published` property set to `true`):
-             *
-             *     `return obj.published === true`
-             *
-             * or both.
-             */
-            queryExpression: string;
-            keyExpression?: string;
-        }) => ValueHook<{
-            indexID: string | undefined;
-        }>;
-        type GetFilteredObject = (opts: FilteredObjectPathRequest) => ValueHook<FilteredObjectPathResponse>;
-        type GetFilteredObjectIndexPosition = (opts: FilteredObjectIndexPositionRequest) => ValueHook<FilteredObjectIndexPositionResponse>;
-        type ListenToFilteredIndexUpdates = (eventCallback: (evt: {
-            indexID: string;
-        }) => Promise<void>, args: any[]) => void;
-        type ListenToIndexStatusChanges = (eventCallback: (evt: {
-            indexID?: string;
-            status: IndexStatus;
-        }) => Promise<void>, args: any[]) => void;
-    }
-    namespace Data {
-        type GetObjectDataset = (opts: ObjectDatasetRequest & {
-            nounLabel?: string;
-        }) => ValueHook<ObjectDatasetResponse>;
-        type UpdateObjects = (opts: {
-            objectChangeset: ObjectChangeset;
-            commitMessage: string;
-            /** Disables the checks against oldValue keys in the changeset. */
-            _dangerouslySkipValidation?: true;
-        }) => Promise<CommitOutcome>;
-        type UpdateObjectTree = (opts: {
-            /** Old subtree root, dataset-relative. */
-            subtreeRoot: string;
-            /** New subtree root, dataset-relative. If null, tree will be deleted. */
-            newSubtreeRoot: string | null;
-            commitMessage: string;
-        }) => Promise<CommitOutcome>;
-        interface MapReduceChain {
-            predicateFunc?: string;
-            /**
-             * Definition of the map function as a string.
-             *
-             * Available arguments:
-             * `key` (string, object path),
-             * `value` (anything, deserialized object data),
-             * `emit` (call instead of return, possibly multiple times).
-             */
-            mapFunc: string;
-            /**
-             * Definition of the reduce function as a string,
-             * complete with return statement.
-             * Doesn’t have to be provided.
-             *
-             * Available arguments:
-             * `accumulator` (data reduced so far),
-             * `value` (next value emitted by the mapper).
-             */
-            reduceFunc?: string;
-        }
-        type MapReduceChains = Record<string, MapReduceChain>;
-    }
-}
-export declare type RemoteUsernameHook = () => ValueHook<{
-    /**
-     * Remote Git username,
-     * as specified for this repository by the user in Paneron settings.
-     */
-    username?: string;
-}>;

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

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Hooks = void 0;
-var Hooks;
-exports.Hooks = Hooks;
-
-(function (Hooks) {
-  let Data;
-
-  (function (Data) {
-    ;
-  })(Data = Hooks.Data || (Hooks.Data = {}));
-})(Hooks || (exports.Hooks = Hooks = {}));

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

@@ -1 +0,0 @@
-{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../../src/types/renderer.ts"],"names":[],"mappings":"AAudA,MAAM,KAAW,KAAK,CAmJrB;AAnJD,WAAiB,KAAK;IAoFpB,IAAiB,IAAI,CA6DpB;IA7DD,WAAiB,IAAI;QAyDlB,CAAC;IAIJ,CAAC,EA7DgB,IAAI,GAAJ,UAAI,KAAJ,UAAI,QA6DpB;AAEH,CAAC,EAnJgB,KAAK,KAAL,KAAK,QAmJrB","sourcesContent":["//import type { FileFilter } from 'electron';\n/** Mimics FileFilter from electron without having to import Electron. */\nexport interface FileFilter {\n  /** NOTE: Extensions should not contain the leading separator (dot/period). */\n  extensions: string[];\n\n  /** Name to be shown to the user for this filter. */\n  name: string;\n}\n\nimport type { ObjectDataset, ObjectChangeset } from './objects';\nimport type { CommitOutcome } from './changes';\nimport type { IndexStatus } from './indexes';\nimport type { BaseAction, PersistentStateReducerHook } from '../usePersistentStateReducer';\nimport type { TimeTravelingPersistentStateReducerHook } from '../useTimeTravelingPersistentStateReducer';\nimport type { Settings, GlobalSettings } from '../settings';\nimport type { OpenFileDialogProps, SaveFileDialogProps } from './dialogs';\nimport type { SubprocessDescription } from './binary-invocation';\nimport type { ExportFormatInfo } from './export-formats';\nimport type { ObjectSpecViewID, ObjectViewProps } from './object-spec';\n\nimport type { ContextSpec as OperationContext } from '../widgets/OperationQueue/context';\n\n\n/** A specification of context available to extension component. */\nexport interface DatasetContext extends OperationContext {\n  /** Dataset title, as specified by dataset manifest/metadata YAML file in the repository. */\n  title: string\n\n  logger: { log: Console[\"log\"], error: Console[\"error\"], debug: Console[\"debug\"] }\n\n  /** Launches specified URI in OS’s default browser. */\n  openExternalLink: (opts: { uri: string }) => Promise<void>\n\n  // Below functions, when take or return object paths, use dataset-relative paths\n  // and convert them to and from repo-relative paths under the hood as needed.\n\n  /** Retrieves object data, and does its best to auto-refresh hook value if objects change. */\n  useObjectData: Hooks.Data.GetObjectDataset\n\n  /**\n   * Retrieves object data, as a simple async function.\n   * Generally it’s recommended to use the `useObjectData` hook instead.\n   *\n   * Request parameters are the same as to the hook.\n   */\n  getObjectData: (opts: ObjectDatasetRequest) => Promise<ObjectDatasetResponse>\n\n  /**\n   * Builds (or reuses) custom dataset index for windowed data access.\n   *\n   * Filtered indexes are based on *query expressions*.\n   * A query expression is a small predicate function that returns true or false for each object\n   * in the dataset; objects for which true is returned are included in the filtered index.\n   *\n   * Whenever dataset contents change,\n   * Paneron calculates (using query expression)\n   * which filtered object indexes were affected by the change,\n   * performs relevant updates on those indexes\n   * and issues events triggering requisite hook refreshes & dependent GUI updates.\n   *\n   * NOTE: In some cases Paneron may fail to react to underlying object change,\n   * resulting in stale indexes. In such cases, the user can refresh indexes.\n   *\n   * This hook will not unnecessarily create filtered index\n   * if it already exists for given query expression.\n   *\n   * This hook returns filtered object index ID,\n   * which is intended to be used for further calls:\n   *\n   * - Filtered index status can be obtained using `useIndexDescription()`.\n   *\n   * - Filtered object paths can be subsequently obtained\n   *   via `useObjectPathFromFilteredIndex()`,\n   *   which in turn can be passed to `useObjectData()`\n   *   in order to obtain actual deserialized obejct data.\n   */\n  useFilteredIndex: Hooks.Indexes.GetOrCreateFiltered\n\n  /** Describes a filtered object index: provides indexing status and object count. */\n  useIndexDescription: Hooks.Indexes.Describe\n\n  /**\n   * Retrieve an object from a filtered index by its position in the index.\n   * Used for efficient data windowing.\n   */\n  useObjectPathFromFilteredIndex: Hooks.Indexes.GetFilteredObject\n\n  /** Non-hook equivalent of `useObjectPathFromFilteredIndex()` as plain async function. */\n  getObjectPathFromFilteredIndex: (opts: FilteredObjectPathRequest) =>\n    Promise<FilteredObjectPathResponse>\n\n  /**\n   * Given object path, retrieve its position in given filtered object index.\n   * NOTE: The primary use case of this hook is workaround-ish, so it may be deprecated in future.\n   */\n  useFilteredIndexPosition: Hooks.Indexes.GetFilteredObjectIndexPosition\n\n  /** Non-hook equivalent of `useFilteredIndexPosition()` as plain async function. */\n  getFilteredIndexPosition: (opts: FilteredObjectIndexPositionRequest) =>\n    Promise<FilteredObjectIndexPositionResponse>\n\n  /**\n   * Runs a set of map-reduce chains over the entire dataset.\n   * The final result is an object where each key is one of given chain IDs,\n   * and the value corresponding to the output of map-reduce chain\n   * (if `reduceFunc` is not provided, the corresponding value is always a list).\n   * `predicateFunc` is required.\n   *\n   */\n  useMapReducedData:\n    <C extends Record<string, any>>\n    (opts: { chains: Record<string, Omit<Hooks.Data.MapReduceChain, 'predicateFunc'> & { predicateFunc: string }> }) => ValueHook<C>\n\n  /**\n   * As useMapReducedData, but in the shape of a regular async function.\n   */\n  getMapReducedData:\n    <C extends Record<string, any>>\n    (opts: { chains: Record<string, Hooks.Data.MapReduceChain> }) => Promise<C>\n\n  // TODO: Document state reducer hooks available to extensions.\n\n  usePersistentDatasetStateReducer: Hooks.UsePersistentDatasetStateReducer<any, any>\n  useTimeTravelingPersistentDatasetStateReducer: Hooks.UseTimeTravelingPersistentDatasetStateReducer<any, any>\n\n  /**\n   * Invokes the bundled Metanorma binary with given arguments, and returns subprocess description.\n   *\n   * For ongoing monitoring of invocation status, use `useMetanormaInvocationStatus()`.\n   *\n   * NOTE: It may be available even if Metanorma binary does not exist, in which case invocation will throw an error.\n   */\n  invokeMetanorma?: (opts: { cliArgs: string[] }) => Promise<SubprocessDescription>\n\n  /**\n   * Query Metanorma subprocess execution status.\n   *\n   * - Will return null if Metanorma subprocess cannot be found.\n   *\n   * - Will auto-refresh returned subprocess description.\n   */\n  useMetanormaInvocationStatus?: () => ValueHook<SubprocessDescription | null>\n\n  operationKey?: string\n\n  /**\n   * Provides access to remote username, as configured in Paneron settings.\n   *\n   * NOTE: Dataset extension *could* use it to infer author’s role by comparing with some list.\n   * However, this is not a security measure and must be used for sensitive access control\n   * in place of Git server-level authentication.\n   *\n   * This hook can be used for informative purposes to show role-appropriate GUIs\n   * to already trusted users who will abide\n   * despite technically being able to sidestep the comparison.\n   */\n  useRemoteUsername: RemoteUsernameHook\n\n  // Paneron internal clipboard (provisional)\n  copyObjects: (objects: ObjectDataset) => Promise<void>\n  requestCopiedObjects: () => Promise<ObjectDataset>\n\n  // Settings\n\n  /**\n   * Returns Paneron-global settings that may make sense for extensions\n   * (e.g., sidebar positioning).\n   *\n   * TODO: Allow overriding global settings with scoped?\n   */\n  useGlobalSettings: Hooks.Settings.UseGlobalSettings\n\n  /** Returns arbitrary settings scoped to current dataset. */\n  useSettings: Hooks.Settings.UseSettings\n\n  /** Updates a given setting in dataset scope. */\n  updateSetting: Hooks.Settings.UpdateSetting\n\n  //useObjectChangeStatus: ObjectChangeStatusHook\n\n  /** TODO: Provisional; for the new extension architecture */\n  getObjectView:\n    (opts: { objectPath: string, viewID: ObjectSpecViewID }) =>\n      React.FC<ObjectViewProps> | undefined\n\n  // /**\n  //  * Provides a full system-absolute path to a path given relative to dataset root,\n  //  * which is useful in rare cases.\n  //  * \n  //  * NOTE: Does not resolve LFS references. If target object path is an LFS pointer,\n  //  * the returned absolute path will also to the LFS pointer file.\n  //  *\n  //  * @deprecated not applicable in browser.\n  //  */\n  // makeAbsolutePath?: (path: string) => string\n\n  // /**\n  //  * Provides a full system-absolute path to a path given relative to dataset root;\n  //  * if referenced object is an LFS pointer, returns path to LFS blob in Git cache.\n  //  */\n  // useAbsolutePath: (opts: { objectPath: string, resolveLFS?: true }) => Promise<string>\n\n  // /**\n  //  * This may be useful in rare cases with poorly-integrated third-party libraries.\n  //  *\n  //  * NOTE: only works for dependencies with corresponding `unpackAsar` entries\n  //  * in Paneron’s electron-builder config.\n  //  */\n  // getRuntimeNodeModulePath?: (moduleName: string) => string\n\n  /** Returns a string value obtained from a binary blob given as Uint8Array. */\n  useDecodedBlob: Hooks.UseDecodedBlob\n\n  /** Given a string, will return a binary blob as Uint8Array. */\n  getBlob?: (fromStringValue: string) => Promise<Uint8Array>\n\n\n  // Below are generally useful for write-enabled repositories only:\n\n  /**\n   * Generates a UUID (not really useful in read-only mode, so is optional)\n   *\n   * @deprecated use browser’s `crypto.randomUUID()` instead?\n   */\n  makeRandomID?: () => Promise<string>\n\n  /** \n   * Commits changes to the dataset on per-object level.\n   */\n  updateObjects?: Hooks.Data.UpdateObjects\n\n  /** \n   * Manipulates repository data (within the dataset) on subtree level (delete or move subtree).\n   *\n   * NOTE: Does not do integrity checks. Dangerous.\n   */\n  updateTree?: Hooks.Data.UpdateObjectTree\n\n\n  // Tools for working with local filesystem\n\n  /**\n   * Invokes file selection dialog and returns file data as object dataset when user confirms.\n   * This does not mutate dataset / Git repo contents, updateObjects still\n   * must be invoked later in order to commit newly added or replaced file.\n   */ \n  requestFileFromFilesystem?: (opts: OpenFileDialogProps, cb?: (data: ObjectDataset) => void) => Promise<ObjectDataset>\n\n  /**\n   * Invokes file save dialog,\n   * writes provided buffer data to chosen file path,\n   * and returns that path.\n   *\n   * Note: currently this does not yet check selected path for sanity,\n   * so the user can write to repository’s own working directory\n   * and mess things up.\n   */\n  writeFileToFilesystem?:\n    (opts: { dialogOpts: SaveFileDialogProps, bufferData: Uint8Array }) =>\n      Promise<{ success: true, savedToFileAtPath: string }>\n\n  /**\n   * List available export options.\n   * Some may be registered by dataset extension,\n   * some may be default provided by host app itself.\n   */\n  listExporters: () => { [exporter: string]: ExportFormatInfo }\n\n  /**\n   * Invokes file selection dialog,\n   * if any files were selected adds them to dataset at specified path,\n   * and makes a commit with specified commit message.\n   *\n   * For performance, this function breaks the logical object layer abstraction:\n   * it does not deserialize buffers and treats selected files\n   * as pre-serialized low-level repository buffers.\n   *\n   * If object(s) with same names already exist at the path,\n   * will overwrite them with new versions.\n   *\n   * `opts` can modify that behavior,\n   * see its member documentation for details.\n   *\n   * Returned commit outcome can be null if no objects were selected.\n   */\n  addFromFilesystem?: (\n    /**\n     * Options to pass to OS file selection dialog.\n     *\n     * NOTE: `allowMultiple` has no effect\n     * if `opts.replaceTarget` is set.\n     */\n    dialogOpts: OpenFileDialogProps,\n\n    commitMessage: string,\n\n    /**\n     * Default behavior is to preserve original filenames\n     * and treat `targetPath` as a tree root under which\n     * new objects will be written as leaf objects with full contents.\n     * If target path exists and is a leaf object (file),\n     * or a leaf object exists with the same name as one of the selected files,\n     * the call will fail.\n     *\n     * Note: `opts.replaceTarget` changes this behavior.\n     */\n    targetPath: string,\n\n    opts: {\n      /**\n       * Whether to replace `targetPath`.\n       *\n       * Treat `targetPath` as a leaf buffer (file) and replace it.\n       * The user will be able to select only one file in this case\n       * (`dialogOpts.allowMultiple` will have no effect).\n       * \n       * Any existing object at `targetPath` will be replaced.\n       * Original filename will be ignored.\n       * If target path exists and is a tree (directory), the call will fail.\n       */\n      replaceTarget?: true\n\n      /**\n       * If specified as true, selected file(s) will be uploaded to LFS,\n       * and only after successful upload LFS pointer files will be committed\n       * in place of actual file contents.\n       *\n       * If upload fails, an error will be thrown.\n       *\n       * NOTE: If some LFS upload succeeds but subsequent commit fails\n       * (or is later reverted), or upload for another object fails,\n       * already uploaded data may remain on LFS and keep costing storage.\n       *\n       * NOTE: If repository does not have the remote configured,\n       * this option will have no effect\n       * (actual blobs will be stored directly in repository).\n       *\n       * NOTE: Regarding authentication, LFS is expected to use the same\n       * credentials as Git. If Git authentication details\n       * (both username and password) cannot be retrieved\n       * from OS credential storage, the call will throw an error.\n       */\n      offloadToLFS?: true\n    },\n  ) => Promise<{ commitOutcome: CommitOutcome | null }>\n}\n\n\n/**\n * A hook that contains the result of calling some endpoint\n * and a way of refreshing the result.\n */\nexport interface ValueHook<T> {\n  /** The value returned from the call. */\n  value: T\n\n  /**\n   * A list of errors, usually one item, as strings.\n   * Non-empty if there were errors thrown by IPC handler.\n   */\n  errors: string[]\n\n  /**\n   * Whether the value is currently being updated\n   * (handler response is being awaited).\n   */\n  isUpdating: boolean\n\n  /**\n   * Can be used to imperatively refresh returned value\n   * by calling handler.\n   *\n   * Generally, it’s better to pass the appropriate memoize arguments instead.\n   */\n  refresh: () => void\n\n  _reqCounter: number\n}\n\n\nexport type FilteredObjectPathRequest = {\n  /**\n   * The ID of the filtered object index from which the object is requested.\n   * Index ID is returned by `useFilteredIndex()` hook.\n   */\n  indexID: string\n\n  /**\n   * Numerical position of object path in this index.\n   *\n   * Filter description hook will return the total number of objects in this index,\n   * and that can be used as the upper bound for position.\n   */\n  position: number\n};\n\nexport type FilteredObjectPathResponse = {\n  /**\n   * Object path at requested position in the index.\n   * This path can be passed to, e.g., `useObjectData()` to obtain actual deserialized object.\n   *\n   * NOTE: there are some edge cases where objectPath can be empty, and those need to be documented.\n   * However, `useObjectData()` will not cause a loud error if an empty path is passed.\n   */\n  objectPath: string\n};\n\nexport type FilteredObjectIndexPositionRequest = {\n  /** The ID of the filtered object index from which object position is requested. */\n  indexID: string\n\n  /** Object path, for which position is requested. */\n  objectPath: string\n};\n\nexport type FilteredObjectIndexPositionResponse = {\n  /**\n   * Position of given object in the index.\n   * Can be null if object path was not found in the index.\n   */\n  position: number | null\n};\n\nexport type ObjectDatasetRequest = {\n  /** A list of dataset-relative object paths to fetch. */\n  objectPaths: string[]\n\n  /**\n   * Whether or not to attempt to resolve large file storage pointers.\n   *\n   * The behavior for an unresolved LFS pointer is to return\n   * an object with a single `lfsPointerInfo` property\n   * instead of actual object data for that path.\n   * (You can test for that property when displaying the object.)\n   *\n   * With this flag, when an LFS pointer is encountered,\n   * Paneron will attempt to download the full blob\n   * if it is not cached yet. This may take some time.\n   *\n   * NOTE: this flag does not guarantee all pointers will be resolved.\n   *\n   * - A failed download will cause an unresolved pointer to be returned.\n   *\n   * - If repository does not have remote configured,\n   *   this flag will not have effect (unresolved pointers will be returned).\n   *\n   * NOTE: Regarding authentication, LFS is expected to use the same\n   * credentials as Git. If Git authentication details\n   * (both username and password) cannot be retrieved\n   * from OS credential storage, the call will throw an error.\n   */\n  resolveLFS?: true\n};\nexport type ObjectDatasetResponse = {\n  /**\n   * A map of requested object paths to deserialized object data, except:\n   *\n   * - If no object data could be retrieved for given object path,\n   *   object path will be mapped to `null`.\n   *\n   * - If `resolveLFS` was not set,\n   *   objects that are pointers to LFS will be returned as is\n   *   (they will not contain the actual deserialized object data).\n  */\n  data: ObjectDataset\n};\n\n\n\n\nexport namespace Hooks {\n\n  export type UseDecodedBlob =\n    (opts: { blob: Uint8Array }) =>\n      { asString: string }\n\n  export type UsePersistentDatasetStateReducer<S, A extends BaseAction> = PersistentStateReducerHook<S, A>\n  export type UseTimeTravelingPersistentDatasetStateReducer<S, A extends BaseAction> = TimeTravelingPersistentStateReducerHook<S, A>\n\n  export namespace Settings {\n    export type UseGlobalSettings =\n      () => ValueHook<{ settings: GlobalSettings }>\n\n    export type UseSettings =\n      () => ValueHook<{ settings: Settings }>\n\n    export type UpdateSetting =\n      (opts: { key: string, value: any }) => Promise<{ success: true }>\n  }\n\n  export namespace Indexes {\n\n    export type Describe =\n      (opts: {\n        /** Filtered object index ID. Is returned by `useFilteredIndex()`. */\n        indexID?: string\n      }) => ValueHook<{ status: IndexStatus }>\n\n    export type GetOrCreateFiltered =\n      (opts: {\n        /**\n         * Query expression for the index.\n         *\n         * This must be a string containing a valid function definition.\n         * The function will be constructed from this definition once,\n         * and invoked against every object in default index.\n         * \n         * The function must return either true or false. Objects for which\n         * `queryExpression` returns true will be included in this index.\n         *\n         * The function will receive two positional arguments, called:\n         * 1. `objPath` (dataset-relative path to the object, including file extension if any)\n         * 2. `obj` (deserialized object data, as a JavaScript object)\n         *\n         * Thus, the function can do simple tests against object path,\n         * like returning all objects that end with index.yaml and are in some subdirectory:\n         * \n         *     `return objPath.startsWith('/some/subdirectory/') && objPath.endsWith('index.yaml')`\n         * \n         * as well as do slightly more complex investigation of deserialized object properties,\n         * like finding all objects which contain `published` property set to `true`):\n         * \n         *     `return obj.published === true`\n         * \n         * or both.\n         */\n        queryExpression: string\n        keyExpression?: string\n      }) => ValueHook<{ indexID: string | undefined }>;\n\n    export type GetFilteredObject =\n      (opts: FilteredObjectPathRequest) =>\n        ValueHook<FilteredObjectPathResponse>\n\n    export type GetFilteredObjectIndexPosition =\n      (opts: FilteredObjectIndexPositionRequest) =>\n        ValueHook<FilteredObjectIndexPositionResponse>\n\n    export type ListenToFilteredIndexUpdates = (\n      eventCallback:\n        (evt: { indexID: string }) =>\n          Promise<void>,\n      args: any[],\n    ) => void\n\n    export type ListenToIndexStatusChanges = (\n      eventCallback:\n        (evt: { indexID?: string, status: IndexStatus }) =>\n          Promise<void>,\n      args: any[],\n    ) => void\n\n  }\n\n  export namespace Data {\n\n    export type GetObjectDataset =\n      (opts: ObjectDatasetRequest & { nounLabel?: string }) =>\n        ValueHook<ObjectDatasetResponse>\n\n    export type UpdateObjects = (opts: {\n      objectChangeset: ObjectChangeset\n      commitMessage: string\n\n      /** Disables the checks against oldValue keys in the changeset. */\n      _dangerouslySkipValidation?: true \n    }) => Promise<CommitOutcome>\n\n    export type UpdateObjectTree = (opts: {\n      /** Old subtree root, dataset-relative. */\n      subtreeRoot: string\n\n      /** New subtree root, dataset-relative. If null, tree will be deleted. */\n      newSubtreeRoot: string | null\n\n      commitMessage: string\n    }) => Promise<CommitOutcome>\n\n    // export type ListenToObjectChanges = (\n    //   eventCallback:\n    //     (evt: { objects?: { [objectPath: string]: ChangeStatus | true } }) =>\n    //       Promise<void>,\n    //   args: any[],\n    // ) => void\n\n    export interface MapReduceChain {\n      /*\n       * `predicateFunc` is supported in order to detect changes to matching objects\n       * and update response. `predicateFunc` should be as lightweight as possible.\n       */\n      predicateFunc?: string\n\n      /**\n       * Definition of the map function as a string.\n       *\n       * Available arguments:\n       * `key` (string, object path),\n       * `value` (anything, deserialized object data),\n       * `emit` (call instead of return, possibly multiple times).\n       */\n      mapFunc: string\n      /**\n       * Definition of the reduce function as a string,\n       * complete with return statement.\n       * Doesn’t have to be provided.\n       *\n       * Available arguments:\n       * `accumulator` (data reduced so far),\n       * `value` (next value emitted by the mapper).\n       */\n      reduceFunc?: string,\n    };\n\n    export type MapReduceChains = Record<string, MapReduceChain>;\n\n  }\n\n}\n\n\nexport type RemoteUsernameHook = () => ValueHook<{\n  /**\n   * Remote Git username,\n   * as specified for this repository by the user in Paneron settings.\n   */\n  username?: string\n}>\n"]}

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

@@ -1,5 +0,0 @@
-/**
- * @deprecated it’s recommended to use the `use-debounce` NPM package instead.
- */
-export declare function useDebounce<T>(value: T, wait: number): T;
-export default useDebounce;

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

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useDebounce = useDebounce;
-exports.default = void 0;
-
-var _react = require("react");
-
-/**
- * @deprecated it’s recommended to use the `use-debounce` NPM package instead.
- */
-function useDebounce(value, wait) {
-  let [debouncedValue, setDebouncedValue] = (0, _react.useState)(value);
-  const setDebounced = (0, _react.useCallback)(() => setDebouncedValue(value), [value]);
-  (0, _react.useEffect)(() => {
-    let timeout = setTimeout(setDebounced, wait);
-    return () => clearTimeout(timeout);
-  }, [value, wait]);
-  return debouncedValue;
-}
-
-var _default = useDebounce;
-exports.default = _default;

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

@@ -1 +0,0 @@
-{"version":3,"file":"useDebounce.js","sourceRoot":"","sources":["../src/useDebounce.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGzD;;GAEG;AACH,MAAM,UAAU,WAAW,CAAI,KAAQ,EAAE,IAAY;IACnD,IAAI,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1D,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAE1E,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,OAAO,GAAG,UAAU,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAElB,OAAO,cAAc,CAAC;AACxB,CAAC;AAGD,eAAe,WAAW,CAAC","sourcesContent":["import { useCallback, useEffect, useState } from 'react';\n\n\n/**\n * @deprecated it’s recommended to use the `use-debounce` NPM package instead.\n */\nexport function useDebounce<T>(value: T, wait: number): T {\n  let [debouncedValue, setDebouncedValue] = useState(value);\n  const setDebounced = useCallback(() => setDebouncedValue(value), [value]);\n\n  useEffect(() => {\n    let timeout = setTimeout(setDebounced, wait);\n    return () => clearTimeout(timeout);\n  }, [value, wait]);\n\n  return debouncedValue;\n}\n\n\nexport default useDebounce;\n"]}

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

@@ -1,39 +0,0 @@
-/**
- * An (abstract) hook that wraps React’s useReducer hook and handles storing and loading reducer state
- * using provided functions.
- */
-import type { Reducer, Dispatch } from 'react';
-declare const LOAD_STATE_ACTION_TYPE: "loadedState";
-export interface BaseAction {
-    type: string;
-    payload?: any;
-}
-/** Action issued when previously stored state is loaded. */
-export interface LoadStateAction<S> extends BaseAction {
-    type: typeof LOAD_STATE_ACTION_TYPE;
-    /** Loaded state. */
-    payload: S;
-}
-export declare type StateReducerHook<S, A extends BaseAction> = (reducer: Reducer<S, A>, initialState: S, initializer: ((initialState: S) => S) | null) => [state: S, dispatch: Dispatch<A>];
-export declare type PersistentStateReducerHook<S, A extends BaseAction> = (
-/** Each component should specify a unique storage key. */
-storageKey: string, 
-/**
- * Calls to store state will be debounced according to this delay
- * in case state change too often.
- */
-storageDebounceMS?: number, validateLoadedState?: (loadedValue: Partial<S> & any) => loadedValue is S, ...args: Parameters<StateReducerHook<S, A>>) => [state: S, dispatch: Dispatch<A>, stateRecalled: boolean];
-/**
- * A reducer that persists each new state,
- * and attempts to load persisted state when component is mounted.
- *
- * During the initial load, `initialized` is set to false.
- *
- * `storeState` is called on each change of state but debounced.
- *
- * NOTE: that state S cannot be an empty object,
- * in such a case `initialState` will always be used.
- */
-declare function usePersistentStateReducer<S, A extends BaseAction>(storeState: (key: string, newState: S) => void, loadState: (key: string) => Promise<S | undefined>, ...args: Parameters<PersistentStateReducerHook<S, A>>): [state: S, dispatch: Dispatch<A>, initialized: boolean];
-export default usePersistentStateReducer;
-export declare const initialHook: PersistentStateReducerHook<any, any>;