@difizen/libro-common 0.1.0 → 0.1.1

package/es/path.d.ts

@@ -0,0 +1,97 @@
+/**
+ * The namespace for path-related functions.
+ *
+ * Note that Jupyter server paths do not start with a leading slash.
+ */
+export declare namespace PathExt {
+    /**
+     * Join all arguments together and normalize the resulting path.
+     * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
+     *
+     * @param paths - The string paths to join.
+     */
+    function join(...paths: string[]): string;
+    /**
+     * Return the last portion of a path. Similar to the Unix basename command.
+     * Often used to extract the file name from a fully qualified path.
+     *
+     * @param path - The path to evaluate.
+     *
+     * @param ext - An extension to remove from the result.
+     */
+    function basename(path: string, ext?: string): string;
+    /**
+     * Get the directory name of a path, similar to the Unix dirname command.
+     * When an empty path is given, returns the root path.
+     *
+     * @param path - The file path.
+     */
+    function dirname(path: string): string;
+    /**
+     * Get the extension of the path.
+     *
+     * @param path - The file path.
+     *
+     * @returns the extension of the file.
+     *
+     * #### Notes
+     * The extension is the string from the last occurrence of the `.`
+     * character to end of string in the last portion of the path, inclusive.
+     * If there is no `.` in the last portion of the path, or if the first
+     * character of the basename of path [[basename]] is `.`, then an
+     * empty string is returned.
+     */
+    function extname(path: string): string;
+    /**
+     * Normalize a string path, reducing '..' and '.' parts.
+     * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
+     * When an empty path is given, returns the root path.
+     *
+     * @param path - The string path to normalize.
+     */
+    function normalize(path: string): string;
+    /**
+     * Resolve a sequence of paths or path segments into an absolute path.
+     * The root path in the application has no leading slash, so it is removed.
+     *
+     * @param parts - The paths to join.
+     *
+     * #### Notes
+     * The right-most parameter is considered {to}.  Other parameters are considered an array of {from}.
+     *
+     * Starting from leftmost {from} parameter, resolves {to} to an absolute path.
+     *
+     * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.
+     */
+    function resolve(...parts: string[]): string;
+    /**
+     * Solve the relative path from {from} to {to}.
+     *
+     * @param from - The source path.
+     *
+     * @param to - The target path.
+     *
+     * #### Notes
+     * If from and to each resolve to the same path (after calling
+     * path.resolve() on each), a zero-length string is returned.
+     * If a zero-length string is passed as from or to, `/`
+     * will be used instead of the zero-length strings.
+     */
+    function relative(from: string, to: string): string;
+    /**
+     * Normalize a file extension to be of the type `'.foo'`.
+     *
+     * @param extension - the file extension.
+     *
+     * #### Notes
+     * Adds a leading dot if not present and converts to lower case.
+     */
+    function normalizeExtension(extension: string): string;
+    /**
+     * Remove the leading slash from a path.
+     *
+     * @param path: the path from which to remove a leading slash.
+     */
+    function removeSlash(path: string): string;
+}
+//# sourceMappingURL=path.d.ts.map

package/es/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;OAKG;IACH,SAAgB,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAG/C;IAED;;;;;;;OAOG;IACH,SAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAE3D;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG5C;IAED;;;;;;;;;;;;;OAaG;IACH,SAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;IAED;;;;;;OAMG;IACH,SAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK9C;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,OAAO,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAElD;IAED;;;;;;;;;;;;OAYG;IACH,SAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAEzD;IAED;;;;;;;OAOG;IACH,SAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAK5D;IAED;;;;OAIG;IACH,SAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKhD;CACF"}

package/es/polling/index.d.ts

@@ -0,0 +1,3 @@
+export { Poll } from './poll.js';
+export * from './protocol.js';
+//# sourceMappingURL=index.d.ts.map

package/es/polling/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/polling/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,cAAc,eAAe,CAAC"}

package/es/polling/poll.d.ts

@@ -0,0 +1,193 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { Event } from '@difizen/mana-common';
+import { Emitter, Deferred } from '@difizen/mana-common';
+import type { IPoll } from './protocol.js';
+/**
+ * A class that wraps an asynchronous function to poll at a regular interval
+ * with exponential increases to the interval length if the poll fails.
+ *
+ * @typeparam T - The resolved type of the factory's promises.
+ * Defaults to `any`.
+ *
+ * @typeparam U - The rejected type of the factory's promises.
+ * Defaults to `any`.
+ *
+ * @typeparam V - An optional type to extend the phases supported by a poll.
+ * Defaults to `standby`, which already exists in the `Phase` type.
+ */
+export declare class Poll<T = any, U = any, V extends string = 'standby'> implements IPoll<T, U, V> {
+    protected disposeEmitter: Emitter<void>;
+    protected _factory: Poll.Factory<T, U, V>;
+    protected _frequency: IPoll.Frequency;
+    protected _standby: Poll.Standby | (() => boolean | Poll.Standby);
+    protected _state: IPoll.State<T, U, V>;
+    protected _tick: Deferred<this>;
+    protected tickedEmitter: Emitter<IPoll.State<T, U, V>>;
+    protected _timeout?: NodeJS.Timeout | undefined;
+    disposed: boolean;
+    /**
+     * Instantiate a new poll with exponential backoff in case of failure.
+     *
+     * @param options - The poll instantiation options.
+     */
+    constructor(options: Poll.IOptions<T, U, V>);
+    /**
+     * The name of the poll.
+     */
+    readonly name: string;
+    /**
+     * A signal emitted when the poll is disposed.
+     */
+    get onDispose(): Event<void>;
+    /**
+     * The polling frequency parameters.
+     */
+    get frequency(): IPoll.Frequency;
+    set frequency(frequency: IPoll.Frequency);
+    /**
+     * Whether the poll is disposed.
+     */
+    get isDisposed(): boolean;
+    /**
+     * Indicates when the poll switches to standby.
+     */
+    get standby(): Poll.Standby | (() => boolean | Poll.Standby);
+    set standby(standby: Poll.Standby | (() => boolean | Poll.Standby));
+    /**
+     * The poll state, which is the content of the current poll tick.
+     */
+    get state(): IPoll.State<T, U, V>;
+    /**
+     * A promise that resolves when the poll next ticks.
+     */
+    get tick(): Promise<this>;
+    /**
+     * A signal emitted when the poll ticks and fires off a new request.
+     */
+    get ticked(): Event<IPoll.State<T, U, V>>;
+    /**
+     * Return an async iterator that yields every tick.
+     */
+    [Symbol.asyncIterator](): AsyncIterableIterator<IPoll.State<T, U, V>>;
+    /**
+     * Dispose the poll.
+     */
+    dispose(): void;
+    /**
+     * Refreshes the poll. Schedules `refreshed` tick if necessary.
+     *
+     * @returns A promise that resolves after tick is scheduled and never rejects.
+     *
+     * #### Notes
+     * The returned promise resolves after the tick is scheduled, but before
+     * the polling action is run. To wait until after the poll action executes,
+     * await the `poll.tick` promise: `await poll.refresh(); await poll.tick;`
+     */
+    refresh(): Promise<void>;
+    /**
+     * Schedule the next poll tick.
+     *
+     * @param next - The next poll state data to schedule. Defaults to standby.
+     *
+     * @param next.cancel - Cancels state transition if function returns `true`.
+     *
+     * @returns A promise that resolves when the next poll state is active.
+     *
+     * #### Notes
+     * This method is not meant to be invoked by user code typically. It is public
+     * to allow poll instances to be composed into classes that schedule ticks.
+     */
+    schedule(next?: Partial<IPoll.State<T, U, V> & {
+        cancel: (last: IPoll.State<T, U, V>) => boolean;
+    }>): Promise<void>;
+    /**
+     * Starts the poll. Schedules `started` tick if necessary.
+     *
+     * @returns A promise that resolves after tick is scheduled and never rejects.
+     */
+    start(): Promise<void>;
+    /**
+     * Stops the poll. Schedules `stopped` tick if necessary.
+     *
+     * @returns A promise that resolves after tick is scheduled and never rejects.
+     */
+    stop(): Promise<void>;
+    /**
+     * Execute a new poll factory promise or stand by if necessary.
+     */
+    protected _execute(): void;
+}
+/**
+ * A namespace for `Poll` types, interfaces, and statics.
+ */
+export declare namespace Poll {
+    /**
+     * A promise factory that returns an individual poll request.
+     *
+     * @typeparam T - The resolved type of the factory's promises.
+     *
+     * @typeparam U - The rejected type of the factory's promises.
+     *
+     * @typeparam V - The type to extend the phases supported by a poll.
+     */
+    type Factory<T, U, V extends string> = (state: IPoll.State<T, U, V>) => Promise<T>;
+    /**
+     * Indicates when the poll switches to standby.
+     */
+    type Standby = 'never' | 'when-hidden';
+    /**
+     * Instantiation options for polls.
+     *
+     * @typeparam T - The resolved type of the factory's promises.
+     *
+     * @typeparam U - The rejected type of the factory's promises.
+     *
+     * @typeparam V - The type to extend the phases supported by a poll.
+     */
+    interface IOptions<T, U, V extends string> {
+        /**
+         * Whether to begin polling automatically; defaults to `true`.
+         */
+        auto?: boolean;
+        /**
+         * A factory function that is passed a poll tick and returns a poll promise.
+         */
+        factory: Factory<T, U, V>;
+        /**
+         * The polling frequency parameters.
+         */
+        frequency?: Partial<IPoll.Frequency>;
+        /**
+         * The name of the poll.
+         * Defaults to `'unknown'`.
+         */
+        name?: string;
+        /**
+         * Indicates when the poll switches to standby or a function that returns
+         * a boolean or a `Poll.Standby` value to indicate whether to stand by.
+         * Defaults to `'when-hidden'`.
+         *
+         * #### Notes
+         * If a function is passed in, for any given context, it should be
+         * idempotent and safe to call multiple times. It will be called before each
+         * tick execution, but may be called by clients as well.
+         */
+        standby?: Standby | (() => boolean | Standby);
+    }
+    /**
+     * An interval value (0ms) that indicates the poll should tick immediately.
+     */
+    const IMMEDIATE = 0;
+    /**
+     * Delays are 32-bit integers in many browsers so intervals need to be capped.
+     *
+     * #### Notes
+     * https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/setTimeout#Maximum_delay_value
+     */
+    const MAX_INTERVAL = 2147483647;
+    /**
+     * An interval value that indicates the poll should never tick.
+     */
+    const NEVER: number;
+}
+//# sourceMappingURL=poll.d.ts.map

package/es/polling/poll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poll.d.ts","sourceRoot":"","sources":["../../src/polling/poll.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAIzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;;;;;;;;GAYG;AACH,qBAAa,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,GAAG,SAAS,CAC9D,YAAW,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAEzB,SAAS,CAAC,cAAc,gBAAuB;IAC/C,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1C,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;IACtC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAClE,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,SAAS,CAAC,KAAK,iBAAwB;IACvC,SAAS,CAAC,aAAa,gCAAuC;IAC9D,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;IAChD,QAAQ,UAAS;IACjB;;;;OAIG;gBACS,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAyB3C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS,CAE/B;IACD,IAAI,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,EAwBvC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAE3D;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,EAMjE;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAEhC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAExC;IAED;;OAEG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAO5E;;OAEG;IACH,OAAO,IAAI,IAAI;IAiBf;;;;;;;;;OASG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQxB;;;;;;;;;;;;OAYG;IACG,QAAQ,CACZ,IAAI,GAAE,OAAO,CACX,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAA;KAAE,CACtE,GACL,OAAO,CAAC,IAAI,CAAC;IA+ChB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAStB;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrB;;OAEG;IACH,SAAS,CAAC,QAAQ,IAAI,IAAI;CA6C3B;AAED;;GAEG;AACH,yBAAiB,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACH,KAAY,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI,CAC5C,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KACxB,OAAO,CAAC,CAAC,CAAC,CAAC;IAEhB;;OAEG;IACH,KAAY,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;IAE9C;;;;;;;;OAQG;IACH,UAAiB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM;QAC9C;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAErC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;;;;;;WASG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC;KAC/C;IACD;;OAEG;IACI,MAAM,SAAS,IAAI,CAAC;IAE3B;;;;;OAKG;IACI,MAAM,YAAY,aAAa,CAAC;IAEvC;;OAEG;IACI,MAAM,KAAK,QAAW,CAAC;CAC/B"}

package/es/polling/protocol.d.ts

@@ -0,0 +1,120 @@
+import type { Event } from '@difizen/mana-common';
+/**
+ * A readonly poll that calls an asynchronous function with each tick.
+ *
+ * @typeparam T - The resolved type of the factory's promises.
+ *
+ * @typeparam U - The rejected type of the factory's promises.
+ *
+ * @typeparam V - The type to extend the phases supported by a poll.
+ */
+export interface IPoll<T, U, V extends string> extends AsyncIterable<IPoll.State<T, U, V>> {
+    /**
+     * A signal emitted when the poll is disposed.
+     */
+    readonly onDispose: Event<void>;
+    /**
+     * The polling frequency data.
+     */
+    readonly frequency: IPoll.Frequency;
+    /**
+     * Whether the poll is disposed.
+     */
+    readonly disposed: boolean;
+    /**
+     * The name of the poll.
+     */
+    readonly name: string;
+    /**
+     * The poll state, which is the content of the currently-scheduled poll tick.
+     */
+    readonly state: IPoll.State<T, U, V>;
+    /**
+     * A promise that resolves when the currently-scheduled tick completes.
+     *
+     * #### Notes
+     * Usually this will resolve after `state.interval` milliseconds from
+     * `state.timestamp`. It can resolve earlier if the user starts or refreshes
+     * the poll, etc.
+     */
+    readonly tick: Promise<IPoll<T, U, V>>;
+    /**
+     * A signal emitted when the poll state changes, i.e., a new tick is scheduled.
+     */
+    readonly ticked: Event<IPoll.State<T, U, V>>;
+}
+/**
+ * A namespace for `IPoll` types.
+ */
+export declare namespace IPoll {
+    /**
+     * The polling frequency parameters.
+     *
+     * #### Notes
+     * We implement the "decorrelated jitter" strategy from
+     * https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/.
+     * Essentially, if consecutive retries are needed, we choose an integer:
+     * `sleep = min(max, rand(interval, backoff * sleep))`
+     * This ensures that the poll is never less than `interval`, and nicely
+     * spreads out retries for consecutive tries. Over time, if (interval < max),
+     * the random number will be above `max` about (1 - 1/backoff) of the time
+     * (sleeping the `max`), and the rest of the time the sleep will be a random
+     * number below `max`, decorrelating our trigger time from other pollers.
+     */
+    type Frequency = {
+        /**
+         * Whether poll frequency backs off (boolean) or the backoff growth rate
+         * (float > 1).
+         *
+         * #### Notes
+         * If `true`, the default backoff growth rate is `3`.
+         */
+        readonly backoff: boolean | number;
+        /**
+         * The basic polling interval in milliseconds (integer).
+         */
+        readonly interval: number;
+        /**
+         * The maximum milliseconds (integer) between poll requests.
+         */
+        readonly max: number;
+    };
+    /**
+     * The phase of the poll when the current tick was scheduled.
+     *
+     * @typeparam T - A type for any additional tick phases a poll supports.
+     */
+    type Phase<T extends string> = T | 'constructed' | 'disposed' | 'reconnected' | 'refreshed' | 'rejected' | 'resolved' | 'standby' | 'started' | 'stopped';
+    /**
+     * Definition of poll state at any given time.
+     *
+     * @typeparam T - The resolved type of the factory's promises.
+     *
+     * @typeparam U - The rejected type of the factory's promises.
+     *
+     * @typeparam V - The type to extend the phases supported by a poll.
+     */
+    type State<T, U, V extends string> = {
+        /**
+         * The number of milliseconds until the current tick resolves.
+         */
+        readonly interval: number;
+        /**
+         * The payload of the last poll resolution or rejection.
+         *
+         * #### Notes
+         * The payload is `null` unless the `phase` is `'reconnected`, `'resolved'`,
+         * or `'rejected'`. Its type is `T` for resolutions and `U` for rejections.
+         */
+        readonly payload: T | U | null;
+        /**
+         * The current poll phase.
+         */
+        readonly phase: Phase<V>;
+        /**
+         * The timestamp for when this tick was scheduled.
+         */
+        readonly timestamp: number;
+    };
+}
+//# sourceMappingURL=protocol.d.ts.map

package/es/polling/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../../src/polling/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,CAC3C,SAAQ,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAErC;;;;;;;OAOG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC9C;AAED;;GAEG;AACH,yBAAiB,KAAK,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,KAAY,SAAS,GAAG;QACtB;;;;;;WAMG;QACH,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;;;OAIG;IACH,KAAY,KAAK,CAAC,CAAC,SAAS,MAAM,IAC9B,CAAC,GACD,aAAa,GACb,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,CAAC;IAEd;;;;;;;;OAQG;IACH,KAAY,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,MAAM,IAAI;QAC1C;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAE1B;;;;;;WAMG;QACH,QAAQ,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;KAC5B,CAAC;CACH"}

package/es/posix.d.ts

@@ -0,0 +1,2 @@
+export declare const join: (...args: string[]) => string;
+//# sourceMappingURL=posix.d.ts.map

package/es/posix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"posix.d.ts","sourceRoot":"","sources":["../src/posix.ts"],"names":[],"mappings":"AA0DA,eAAO,MAAM,IAAI,YAAsB,MAAM,EAAE,WAgB9C,CAAC"}

package/es/protocol/cell-protocol.d.ts

@@ -0,0 +1,181 @@
+import type { PartialJSONObject } from '../json.js';
+import type { ExecutionCount, IAttachments, MultilineString } from './notebook-protocol.js';
+import type { IOutput } from './output-protocol.js';
+/**
+ * A type which describes the type of cell.
+ */
+export type CellType = 'code' | 'markdown' | 'raw' | string;
+/**
+ * The Jupyter metadata namespace.
+ */
+export interface IBaseCellJupyterMetadata extends PartialJSONObject {
+    /**
+     * Whether the source is hidden.
+     */
+    source_hidden: boolean;
+}
+/**
+ * Cell-level metadata.
+ */
+export interface IBaseCellMetadata extends PartialJSONObject {
+    /**
+     * Whether the cell is trusted.
+     *
+     * #### Notes
+     * This is not strictly part of the nbformat spec, but it is added by
+     * the contents manager.
+     *
+     * See https://jupyter-server.readthedocs.io/en/latest/operators/security.html.
+     */
+    trusted: boolean;
+    /**
+     * The cell's name. If present, must be a non-empty string.
+     */
+    name: string;
+    /**
+     * The Jupyter metadata namespace
+     */
+    jupyter: Partial<IBaseCellJupyterMetadata>;
+    /**
+     * The cell's tags. Tags must be unique, and must not contain commas.
+     */
+    tags: string[];
+}
+/**
+ * The base cell interface.
+ */
+export interface IBaseCell extends PartialJSONObject {
+    /**
+     * String identifying the type of cell.
+     */
+    cell_type: string;
+    /**
+     * Contents of the cell, represented as an array of lines.
+     */
+    source: MultilineString;
+    /**
+     * Cell-level metadata.
+     */
+    metadata: Partial<ICellMetadata>;
+}
+/**
+ * Metadata for the raw cell.
+ */
+export interface IRawCellMetadata extends IBaseCellMetadata {
+    /**
+     * Raw cell metadata format for nbconvert.
+     */
+    format: string;
+}
+/**
+ * A raw cell.
+ */
+export interface IRawCell extends IBaseCell {
+    /**
+     * A string field representing the identifier of this particular cell.
+     *
+     * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+     * field. We need to handle both cases, so we make id optional here.
+     */
+    id?: string | undefined;
+    /**
+     * String identifying the type of cell.
+     */
+    cell_type: 'raw';
+    /**
+     * Cell-level metadata.
+     */
+    metadata: Partial<IRawCellMetadata>;
+    /**
+     * Cell attachments.
+     */
+    attachments?: IAttachments | undefined;
+}
+/**
+ * A markdown cell.
+ */
+export interface IMarkdownCell extends IBaseCell {
+    /**
+     * A string field representing the identifier of this particular cell.
+     *
+     * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+     * field. We need to handle both cases, so we make id optional here.
+     */
+    id?: string | undefined;
+    /**
+     * String identifying the type of cell.
+     */
+    cell_type: 'markdown';
+    /**
+     * Cell attachments.
+     */
+    attachments?: IAttachments | undefined;
+}
+/**
+ * The Jupyter metadata namespace for code cells.
+ */
+export interface ICodeCellJupyterMetadata extends IBaseCellJupyterMetadata {
+    /**
+     * Whether the outputs are hidden. See https://github.com/jupyter/nbformat/issues/137.
+     */
+    outputs_hidden: boolean;
+}
+/**
+ * Metadata for a code cell.
+ */
+export interface ICodeCellMetadata extends IBaseCellMetadata {
+    /**
+     * Whether the cell is collapsed/expanded.
+     */
+    collapsed: boolean;
+    /**
+     * The Jupyter metadata namespace
+     */
+    jupyter: Partial<ICodeCellJupyterMetadata>;
+    /**
+     * Whether the cell's output is scrolled, unscrolled, or autoscrolled.
+     */
+    scrolled: boolean | 'auto';
+}
+/**
+ * A code cell.
+ */
+export interface ICodeCell extends IBaseCell {
+    /**
+     * A string field representing the identifier of this particular cell.
+     *
+     * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+     * field. We need to handle both cases, so we make id optional here.
+     */
+    id?: string | undefined;
+    /**
+     * String identifying the type of cell.
+     * Changed in Libro: cell_type 不再限制只能是code，以便支持多种语言的cell
+     */
+    cell_type: string;
+    /**
+     * Cell-level metadata.
+     */
+    metadata: Partial<ICodeCellMetadata>;
+    /**
+     * Execution, display, or stream outputs.
+     */
+    outputs: IOutput[];
+    /**
+     * The code cell's prompt number. Will be null if the cell has not been run.
+     */
+    execution_count: ExecutionCount;
+}
+/**
+ * An unrecognized cell.
+ */
+export type IUnrecognizedCell = IBaseCell;
+/**
+ * A cell union type.
+ */
+export type ICell = IRawCell | IMarkdownCell | ICodeCell | IUnrecognizedCell;
+/**
+ * A union metadata type.
+ */
+export type ICellMetadata = IBaseCellMetadata | IRawCellMetadata | ICodeCellMetadata;
+//# sourceMappingURL=cell-protocol.d.ts.map

package/es/protocol/cell-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cell-protocol.d.ts","sourceRoot":"","sources":["../../src/protocol/cell-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,eAAe,EAChB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,GAAG,MAAM,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,iBAAiB;IACjE;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D;;;;;;;;OAQG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,wBAAwB;IACxE;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB;IAC1D;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE3C;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAGlB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAErC;;OAEG;IACH,OAAO,EAAE,OAAO,EAAE,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,QAAQ,GAAG,aAAa,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC"}

package/es/protocol/index.d.ts

@@ -0,0 +1,4 @@
+export * from './cell-protocol.js';
+export * from './notebook-protocol.js';
+export * from './output-protocol.js';
+//# sourceMappingURL=index.d.ts.map

package/es/protocol/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/protocol/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC"}