@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Utility/browserBus.d.ts

@@ -1,207 +1,207 @@
-import { Guid } from "@Obsidian/Types";
-import { BlockBeginEditData, BlockEndEditData, BrowserBusCallback, BrowserBusOptions, Message, QueryStringChangedData } from "@Obsidian/Types/Utility/browserBus";
-/**
- * Framework messages that will be sent for pages.
- */
-export declare const PageMessages: {
-    /**
-     * Sent when the query string is changed outside the context of a page load.
-     */
-    readonly QueryStringChanged: "page.core.queryStringChanged";
-};
-/**
- * Framework messages that will be sent for blocks.
- */
-export declare const BlockMessages: {
-    /**
-     * Sent just before a block switches into edit mode.
-     */
-    readonly BeginEdit: "block.core.beginEdit";
-    /**
-     * Sent just after a block switches out of edit mode.
-     */
-    readonly EndEdit: "block.core.endEdit";
-};
-/**
- * Gets an object that will provide access to the browser bus. This bus will
- * allow different code on the page to send and receive messages betwen each
- * other as well as plain JavaScript. This bus does not cross page boundaries.
- *
- * Meaning, if you publish a message in one tab it will not show up in another
- * tab in the same (or a different) browser. Neither will messages magically
- * persist across page loads.
- *
- * If you call this method you are responsible for calling the {@link BrowserBus.dispose}
- * function when you are done with the bus. If you do not then your component
- * will probably never be garbage collected and your subscribed event handlers
- * will continue to be called.
- *
- * @param options Custom options to construct the {@link BrowserBus} object with. This should normally not be needed.
- *
- * @returns The object that provides access to the browser bus.
- */
-export declare function useBrowserBus(options?: BrowserBusOptions): BrowserBus;
-/**
- * The main browser bus implementation. This uses a shared method to publish
- * and subscribe to messages such that if you create two BrowserBus instances on
- * the same page they will still be able to talk to each other.
- *
- * However, they will not be able to talk to instances on other pages such as
- * in other browser tabs.
- */
-export declare class BrowserBus {
-    /** The registered handlers that will potentially be invoked. */
-    private handlers;
-    /** The options we were created with. */
-    private options;
-    /** The event listener. Used so we can remove the listener later. */
-    private eventListener;
-    /**
-     * Creates a new instance of the bus and prepares it to receive messages.
-     *
-     * This should be considered an internal constructor and not used by plugins.
-     *
-     * @param options The options that describe how this instance should operate.
-     */
-    constructor(options: BrowserBusOptions);
-    /**
-     * Called when an event is received from the document listener.
-     *
-     * @param event The low level JavaScript even that was received.
-     */
-    private onEvent;
-    /**
-     * Called when a browser bus message is received from the bus.
-     *
-     * @param message The message that was received.
-     */
-    private onMessage;
-    /**
-     * Frees up any resources used by this browser bus instance.
-     */
-    dispose(): void;
-    /**
-     * Publishes a named message without any data.
-     *
-     * @param messageName The name of the message to publish.
-     */
-    publish(messageName: string): void;
-    /**
-     * Publishes a named message with some custom data.
-     *
-     * @param messageName The name of the message to publish.
-     * @param data The custom data to include with the message.
-     */
-    publish(messageName: string, data: unknown): void;
-    /**
-     * Publishes a message to the browser bus. No changes are made to the
-     * message object.
-     *
-     * Do not use this message to publish a block message unless you have
-     * manually filled in the {@link Message.blockType} and
-     * {@link Message.block} properties.
-     *
-     * @param message The message to publish.
-     */
-    publishMessage(message: Message): void;
-    /**
-     * Subscribes to the named message from any source.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribe<TData = unknown>(messageName: string, callback: BrowserBusCallback<TData>): void;
-    /**
-     * Subscribes to the named message from any source.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribe(messageName: "page.core.queryStringChanged", callback: BrowserBusCallback<QueryStringChangedData>): void;
-    /**
-     * Subscribes to the named message from any source.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribe(messageName: "block.core.beginEdit", callback: BrowserBusCallback<BlockBeginEditData>): void;
-    /**
-     * Subscribes to the named message from any source.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribe(messageName: "block.core.endEdit", callback: BrowserBusCallback<BlockEndEditData>): void;
-    /**
-     * Subscribes to any message that is sent.
-     *
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribe(callback: BrowserBusCallback): void;
-    /**
-     * Subscribes to the named message from any block instance with a matching
-     * block type identifier.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param blockType The identifier of the block type.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlockType<TData = unknown>(messageName: string, blockType: Guid, callback: BrowserBusCallback<TData>): void;
-    /**
-     * Subscribes to the named message from any block instance with a matching
-     * block type identifier.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param blockType The identifier of the block type.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlockType(messageName: "block.core.beginEdit", blockType: Guid, callback: BrowserBusCallback<BlockBeginEditData>): void;
-    /**
-     * Subscribes to the named message from any block instance with a matching
-     * block type identifier.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param blockType The identifier of the block type.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlockType(messageName: "block.core.endEdit", blockType: Guid, callback: BrowserBusCallback<BlockEndEditData>): void;
-    /**
-     * Subscribes to any message that is sent from any block instance with a
-     * matching block type identifier.
-     *
-     * @param blockType The identifier of the block type.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlockType(blockType: Guid, callback: BrowserBusCallback): void;
-    /**
-     * Subscribes to the named message from a single block instance.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param block The identifier of the block.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlock<TData = unknown>(messageName: string, block: Guid, callback: BrowserBusCallback<TData>): void;
-    /**
-     * Subscribes to the named message from a single block instance.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param block The identifier of the block.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlock(messageName: "block.core.beginEdit", block: Guid, callback: BrowserBusCallback<BlockBeginEditData>): void;
-    /**
-     * Subscribes to the named message from a single block instance.
-     *
-     * @param messageName The name of the message to subscribe to.
-     * @param block The identifier of the block.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlock(messageName: "block.core.endEdit", block: Guid, callback: BrowserBusCallback<BlockEndEditData>): void;
-    /**
-     * Subscribes to any message that is sent from a single block instance.
-     *
-     * @param block The identifier of the block.
-     * @param callback The callback to invoke when the message is received.
-     */
-    subscribeToBlock(block: Guid, callback: BrowserBusCallback): void;
-}
+import { Guid } from "@Obsidian/Types";
+import { BlockBeginEditData, BlockEndEditData, BrowserBusCallback, BrowserBusOptions, Message, QueryStringChangedData } from "@Obsidian/Types/Utility/browserBus";
+/**
+ * Framework messages that will be sent for pages.
+ */
+export declare const PageMessages: {
+    /**
+     * Sent when the query string is changed outside the context of a page load.
+     */
+    readonly QueryStringChanged: "page.core.queryStringChanged";
+};
+/**
+ * Framework messages that will be sent for blocks.
+ */
+export declare const BlockMessages: {
+    /**
+     * Sent just before a block switches into edit mode.
+     */
+    readonly BeginEdit: "block.core.beginEdit";
+    /**
+     * Sent just after a block switches out of edit mode.
+     */
+    readonly EndEdit: "block.core.endEdit";
+};
+/**
+ * Gets an object that will provide access to the browser bus. This bus will
+ * allow different code on the page to send and receive messages betwen each
+ * other as well as plain JavaScript. This bus does not cross page boundaries.
+ *
+ * Meaning, if you publish a message in one tab it will not show up in another
+ * tab in the same (or a different) browser. Neither will messages magically
+ * persist across page loads.
+ *
+ * If you call this method you are responsible for calling the {@link BrowserBus.dispose}
+ * function when you are done with the bus. If you do not then your component
+ * will probably never be garbage collected and your subscribed event handlers
+ * will continue to be called.
+ *
+ * @param options Custom options to construct the {@link BrowserBus} object with. This should normally not be needed.
+ *
+ * @returns The object that provides access to the browser bus.
+ */
+export declare function useBrowserBus(options?: BrowserBusOptions): BrowserBus;
+/**
+ * The main browser bus implementation. This uses a shared method to publish
+ * and subscribe to messages such that if you create two BrowserBus instances on
+ * the same page they will still be able to talk to each other.
+ *
+ * However, they will not be able to talk to instances on other pages such as
+ * in other browser tabs.
+ */
+export declare class BrowserBus {
+    /** The registered handlers that will potentially be invoked. */
+    private handlers;
+    /** The options we were created with. */
+    private options;
+    /** The event listener. Used so we can remove the listener later. */
+    private eventListener;
+    /**
+     * Creates a new instance of the bus and prepares it to receive messages.
+     *
+     * This should be considered an internal constructor and not used by plugins.
+     *
+     * @param options The options that describe how this instance should operate.
+     */
+    constructor(options: BrowserBusOptions);
+    /**
+     * Called when an event is received from the document listener.
+     *
+     * @param event The low level JavaScript even that was received.
+     */
+    private onEvent;
+    /**
+     * Called when a browser bus message is received from the bus.
+     *
+     * @param message The message that was received.
+     */
+    private onMessage;
+    /**
+     * Frees up any resources used by this browser bus instance.
+     */
+    dispose(): void;
+    /**
+     * Publishes a named message without any data.
+     *
+     * @param messageName The name of the message to publish.
+     */
+    publish(messageName: string): void;
+    /**
+     * Publishes a named message with some custom data.
+     *
+     * @param messageName The name of the message to publish.
+     * @param data The custom data to include with the message.
+     */
+    publish(messageName: string, data: unknown): void;
+    /**
+     * Publishes a message to the browser bus. No changes are made to the
+     * message object.
+     *
+     * Do not use this message to publish a block message unless you have
+     * manually filled in the {@link Message.blockType} and
+     * {@link Message.block} properties.
+     *
+     * @param message The message to publish.
+     */
+    publishMessage(message: Message): void;
+    /**
+     * Subscribes to the named message from any source.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribe<TData = unknown>(messageName: string, callback: BrowserBusCallback<TData>): void;
+    /**
+     * Subscribes to the named message from any source.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribe(messageName: "page.core.queryStringChanged", callback: BrowserBusCallback<QueryStringChangedData>): void;
+    /**
+     * Subscribes to the named message from any source.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribe(messageName: "block.core.beginEdit", callback: BrowserBusCallback<BlockBeginEditData>): void;
+    /**
+     * Subscribes to the named message from any source.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribe(messageName: "block.core.endEdit", callback: BrowserBusCallback<BlockEndEditData>): void;
+    /**
+     * Subscribes to any message that is sent.
+     *
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribe(callback: BrowserBusCallback): void;
+    /**
+     * Subscribes to the named message from any block instance with a matching
+     * block type identifier.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param blockType The identifier of the block type.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlockType<TData = unknown>(messageName: string, blockType: Guid, callback: BrowserBusCallback<TData>): void;
+    /**
+     * Subscribes to the named message from any block instance with a matching
+     * block type identifier.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param blockType The identifier of the block type.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlockType(messageName: "block.core.beginEdit", blockType: Guid, callback: BrowserBusCallback<BlockBeginEditData>): void;
+    /**
+     * Subscribes to the named message from any block instance with a matching
+     * block type identifier.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param blockType The identifier of the block type.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlockType(messageName: "block.core.endEdit", blockType: Guid, callback: BrowserBusCallback<BlockEndEditData>): void;
+    /**
+     * Subscribes to any message that is sent from any block instance with a
+     * matching block type identifier.
+     *
+     * @param blockType The identifier of the block type.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlockType(blockType: Guid, callback: BrowserBusCallback): void;
+    /**
+     * Subscribes to the named message from a single block instance.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param block The identifier of the block.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlock<TData = unknown>(messageName: string, block: Guid, callback: BrowserBusCallback<TData>): void;
+    /**
+     * Subscribes to the named message from a single block instance.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param block The identifier of the block.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlock(messageName: "block.core.beginEdit", block: Guid, callback: BrowserBusCallback<BlockBeginEditData>): void;
+    /**
+     * Subscribes to the named message from a single block instance.
+     *
+     * @param messageName The name of the message to subscribe to.
+     * @param block The identifier of the block.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlock(messageName: "block.core.endEdit", block: Guid, callback: BrowserBusCallback<BlockEndEditData>): void;
+    /**
+     * Subscribes to any message that is sent from a single block instance.
+     *
+     * @param block The identifier of the block.
+     * @param callback The callback to invoke when the message is received.
+     */
+    subscribeToBlock(block: Guid, callback: BrowserBusCallback): void;
+}

package/types/Utility/cache.d.ts

@@ -1,32 +1,33 @@
-import { RockDateTime } from "./rockDateTime";
-/**
-* Stores the value using the given key. The cache will expire at the expiration or in
-* 1 minute if none is provided
-* @param key
-* @param value
-* @param expiration
-*/
-declare function set<T>(key: string, value: T, expirationDT?: RockDateTime | null): void;
-/**
- * Gets a stored cache value if there is one that has not yet expired.
- * @param key
- */
-declare function get<T>(key: string): T | null;
-/**
- * Since Promises can't be cached, we need to store them in memory until we get the result back. This wraps
- * a function in another function that returns a promise and...
- * - If there's a cached result, return it
- * - Otherwise if there's a cached Promise, return it
- * - Otherwise call the given function and cache it's promise and return it. Once the the Promise resolves, cache its result
- *
- * @param key Key for identifying the cached values
- * @param fn Function that returns a Promise that we want to cache the value of
- *
- */
-declare function cachePromiseFactory<T>(key: string, fn: () => Promise<T>, expiration?: RockDateTime | null): () => Promise<T>;
-declare const _default: {
-    set: typeof set;
-    get: typeof get;
-    cachePromiseFactory: typeof cachePromiseFactory;
-};
-export default _default;
+/**
+* Stores the value using the given key. The cache will expire at the expiration or in
+* 1 minute if none is provided
+* @param key Unique key to store the value under
+* @param value Value to store
+* @param ttl Time to live in seconds (how long the cached value is valid for). Defaults to 60 if not provided.
+*/
+declare function set<T>(key: string, value: T, ttl?: number): void;
+/**
+ * Gets a stored cache value if there is one that has not yet expired.
+ * @param key
+ */
+declare function get<T>(key: string): T | null;
+/**
+ * Since Promises can't be cached, we need to store them in memory until we get the result back. This wraps
+ * a function in another function that returns a promise and...
+ * - If there's a cached result, return it
+ * - Otherwise if there's a cached Promise, return it
+ * - Otherwise call the given function and cache it's promise and return it. Once the the Promise resolves, cache its result
+ *
+ * @param key Key for identifying the cached values
+ * @param fn Function that returns a Promise that we want to cache the value of
+ * @param ttl Time to live in seconds (how long the cached value is valid for)
+ *
+ * @returns A function that wraps the given function, that can be called instead of the given function and that will use the cache when appropriate.
+ */
+declare function cachePromiseFactory<T>(key: string, fn: () => Promise<T>, ttl?: number): () => Promise<T>;
+declare const _default: {
+    set: typeof set;
+    get: typeof get;
+    cachePromiseFactory: typeof cachePromiseFactory;
+};
+export default _default;

package/types/Utility/cancellation.d.ts

@@ -1,58 +1,58 @@
-/**
- * A cancellation token can be used to instruct some operation to run but abort
- * if a certain condition is met.
- */
-export interface ICancellationToken {
-    /**
-     * A flag signalling is cancellation has been requested.
-     */
-    readonly isCancellationRequested: boolean;
-    /**
-     * Registers a listener for when cancellation has been requested. This event
-     * only ever fires `once` as cancellation can only happen once. Listeners
-     * that are registered after cancellation will be called (next event loop run),
-     * but also only once.
-     *
-     * @param listener The function to be called when the token has been cancelled.
-     */
-    onCancellationRequested(listener: () => void): void;
-}
-/**
- * Determines if something is a cancellation token.
- *
- * @param thing The thing to be checked to see if it is a cancellation token.
- *
- * @returns true if the @{link thing} is a cancellation token, otherwise false.
- */
-export declare function isCancellationToken(thing: unknown): thing is ICancellationToken;
-/**
- * A cancellation token that will never be in a cancelled state.
- */
-export declare const CancellationTokenNone: Readonly<ICancellationToken>;
-/**
- * A cancellation token that is already in a cancelled state.
- */
-export declare const CancellationTokenCancelled: Readonly<ICancellationToken>;
-/**
- * Creates a source instance that can be used to trigger a cancellation
- * token into the cancelled state.
- */
-export declare class CancellationTokenSource {
-    /** The token that can be passed to functions. */
-    private internalToken?;
-    /**
-     * Creates a new instance of {@link CancellationTokenSource}.
-     *
-     * @param parent The parent cancellation token that will also cancel this source.
-     */
-    constructor(parent?: ICancellationToken);
-    /**
-     * The cancellation token that can be used to determine when the task
-     * should be cancelled.
-     */
-    get token(): ICancellationToken;
-    /**
-     * Moves the token into a cancelled state.
-     */
-    cancel(): void;
-}
+/**
+ * A cancellation token can be used to instruct some operation to run but abort
+ * if a certain condition is met.
+ */
+export interface ICancellationToken {
+    /**
+     * A flag signalling is cancellation has been requested.
+     */
+    readonly isCancellationRequested: boolean;
+    /**
+     * Registers a listener for when cancellation has been requested. This event
+     * only ever fires `once` as cancellation can only happen once. Listeners
+     * that are registered after cancellation will be called (next event loop run),
+     * but also only once.
+     *
+     * @param listener The function to be called when the token has been cancelled.
+     */
+    onCancellationRequested(listener: () => void): void;
+}
+/**
+ * Determines if something is a cancellation token.
+ *
+ * @param thing The thing to be checked to see if it is a cancellation token.
+ *
+ * @returns true if the @{link thing} is a cancellation token, otherwise false.
+ */
+export declare function isCancellationToken(thing: unknown): thing is ICancellationToken;
+/**
+ * A cancellation token that will never be in a cancelled state.
+ */
+export declare const CancellationTokenNone: Readonly<ICancellationToken>;
+/**
+ * A cancellation token that is already in a cancelled state.
+ */
+export declare const CancellationTokenCancelled: Readonly<ICancellationToken>;
+/**
+ * Creates a source instance that can be used to trigger a cancellation
+ * token into the cancelled state.
+ */
+export declare class CancellationTokenSource {
+    /** The token that can be passed to functions. */
+    private internalToken?;
+    /**
+     * Creates a new instance of {@link CancellationTokenSource}.
+     *
+     * @param parent The parent cancellation token that will also cancel this source.
+     */
+    constructor(parent?: ICancellationToken);
+    /**
+     * The cancellation token that can be used to determine when the task
+     * should be cancelled.
+     */
+    get token(): ICancellationToken;
+    /**
+     * Moves the token into a cancelled state.
+     */
+    cancel(): void;
+}