@platforma-sdk/model 1.58.3 → 1.58.9

package/dist/block_api_v1.d.ts

@@ -1,62 +1,66 @@
-import type { BlockOutputsBase, BlockState, NavigationState } from "@milaboratories/pl-model-common";
-import type { BlockStatePatch } from "./block_state_patch";
+import { BlockStatePatch } from "./block_state_patch.js";
+import { BlockOutputsBase, BlockState, NavigationState } from "@milaboratories/pl-model-common";
+
+//#region src/block_api_v1.d.ts
 /** Returned by state subscription methods to be able to cancel the subscription. */
-export type CancelSubscription = () => void;
+type CancelSubscription = () => void;
 /** Defines methods to read and write current block data. */
-export interface BlockApiV1<Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, UiState = unknown, Href extends `/${string}` = `/${string}`> {
-    /**
-     * Use this method to retrieve block state during UI initialization. Then use
-     * {@link onStateUpdates} method to subscribe for updates.
-     * */
-    loadBlockState(): Promise<BlockState<Args, Outputs, UiState, Href>>;
-    /**
-     * Subscribe to updates of block state.
-     *
-     * This method internally have several ways to limit the rate at which new
-     * states are pushed to the corresponding callback. Among other rate limiting
-     * approaches it guarantees that new state will never be pushed to the
-     * supplied async callback until the previous call returns.
-     *
-     * It is a good idea to develop the callback in such a way that it will wait
-     * until the given state propagates all the way to the DOM. See for example
-     * nextTick() method from Vue framework to achieve this.
-     *
-     * This method will only push args and uiState patches if changes were made
-     * externally, i.e. by another user editing the same block.
-     *
-     * @return function that cancels created subscription
-     * */
-    onStateUpdates(cb: (updates: BlockStatePatch<Args, Outputs, UiState, Href>[]) => Promise<void>): CancelSubscription;
-    /**
-     * Sets block args.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * arguments.
-     * */
-    setBlockArgs(args: Args): Promise<void>;
-    /**
-     * Sets block ui state.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * values.
-     * */
-    setBlockUiState(state: UiState): Promise<void>;
-    /**
-     * Sets block args and ui state.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * values.
-     * */
-    setBlockArgsAndUiState(args: Args, state: UiState): Promise<void>;
-    /**
-     * Sets block navigation state.
-     * */
-    setNavigationState(state: NavigationState<Href>): Promise<void>;
+interface BlockApiV1<Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, UiState = unknown, Href extends `/${string}` = `/${string}`> {
+  /**
+   * Use this method to retrieve block state during UI initialization. Then use
+   * {@link onStateUpdates} method to subscribe for updates.
+   * */
+  loadBlockState(): Promise<BlockState<Args, Outputs, UiState, Href>>;
+  /**
+   * Subscribe to updates of block state.
+   *
+   * This method internally have several ways to limit the rate at which new
+   * states are pushed to the corresponding callback. Among other rate limiting
+   * approaches it guarantees that new state will never be pushed to the
+   * supplied async callback until the previous call returns.
+   *
+   * It is a good idea to develop the callback in such a way that it will wait
+   * until the given state propagates all the way to the DOM. See for example
+   * nextTick() method from Vue framework to achieve this.
+   *
+   * This method will only push args and uiState patches if changes were made
+   * externally, i.e. by another user editing the same block.
+   *
+   * @return function that cancels created subscription
+   * */
+  onStateUpdates(cb: (updates: BlockStatePatch<Args, Outputs, UiState, Href>[]) => Promise<void>): CancelSubscription;
+  /**
+   * Sets block args.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * arguments.
+   * */
+  setBlockArgs(args: Args): Promise<void>;
+  /**
+   * Sets block ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockUiState(state: UiState): Promise<void>;
+  /**
+   * Sets block args and ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockArgsAndUiState(args: Args, state: UiState): Promise<void>;
+  /**
+   * Sets block navigation state.
+   * */
+  setNavigationState(state: NavigationState<Href>): Promise<void>;
 }
+//#endregion
+export { BlockApiV1, CancelSubscription };
 //# sourceMappingURL=block_api_v1.d.ts.map

package/dist/block_api_v2.d.ts

@@ -1,50 +1,54 @@
-import type { BlockOutputsBase, BlockState, NavigationState, ValueWithUTag, ValueWithUTagAndAuthor, AuthorMarker, ResultOrError } from "@milaboratories/pl-model-common";
-import type { Operation } from "fast-json-patch";
+import { AuthorMarker, BlockOutputsBase, BlockState, NavigationState, ResultOrError, ValueWithUTag, ValueWithUTagAndAuthor } from "@milaboratories/pl-model-common";
+import { Operation } from "fast-json-patch";
+
+//#region src/block_api_v2.d.ts
 /** Defines methods to read and write current block data. */
-export interface BlockApiV2<Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, UiState = unknown, Href extends `/${string}` = `/${string}`> {
-    /**
-     * Use this method to retrieve block state during UI initialization. Then use
-     * {@link onStateUpdates} method to subscribe for updates.
-     * */
-    loadBlockState(): Promise<ResultOrError<ValueWithUTag<BlockState<Args, Outputs, UiState, Href>>>>;
-    /**
-     * Get all json patches (rfc6902) that were applied to the block state.
-     * */
-    getPatches(uTag: string): Promise<ResultOrError<ValueWithUTagAndAuthor<Operation[]>>>;
-    /**
-     * Sets block args.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * arguments.
-     * */
-    setBlockArgs(args: Args, author?: AuthorMarker): Promise<ResultOrError<void>>;
-    /**
-     * Sets block ui state.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * values.
-     * */
-    setBlockUiState(state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
-    /**
-     * Sets block args and ui state.
-     *
-     * This method returns when corresponding arguments are safely saved so in
-     * case the window is closed there will be no information losses. This
-     * function under the hood may delay actual persistence of the supplied
-     * values.
-     * */
-    setBlockArgsAndUiState(args: Args, state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
-    /**
-     * Sets block navigation state.
-     * */
-    setNavigationState(state: NavigationState<Href>): Promise<ResultOrError<void>>;
-    /**
-     * Disposes the block API.
-     * */
-    dispose(): Promise<ResultOrError<void>>;
+interface BlockApiV2<Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, UiState = unknown, Href extends `/${string}` = `/${string}`> {
+  /**
+   * Use this method to retrieve block state during UI initialization. Then use
+   * {@link onStateUpdates} method to subscribe for updates.
+   * */
+  loadBlockState(): Promise<ResultOrError<ValueWithUTag<BlockState<Args, Outputs, UiState, Href>>>>;
+  /**
+   * Get all json patches (rfc6902) that were applied to the block state.
+   * */
+  getPatches(uTag: string): Promise<ResultOrError<ValueWithUTagAndAuthor<Operation[]>>>;
+  /**
+   * Sets block args.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * arguments.
+   * */
+  setBlockArgs(args: Args, author?: AuthorMarker): Promise<ResultOrError<void>>;
+  /**
+   * Sets block ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockUiState(state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
+  /**
+   * Sets block args and ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockArgsAndUiState(args: Args, state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
+  /**
+   * Sets block navigation state.
+   * */
+  setNavigationState(state: NavigationState<Href>): Promise<ResultOrError<void>>;
+  /**
+   * Disposes the block API.
+   * */
+  dispose(): Promise<ResultOrError<void>>;
 }
+//#endregion
+export { BlockApiV2 };
 //# sourceMappingURL=block_api_v2.d.ts.map

package/dist/block_api_v3.d.ts

@@ -1,32 +1,36 @@
-import type { BlockOutputsBase, NavigationState, ValueWithUTag, ValueWithUTagAndAuthor, AuthorMarker, ResultOrError, BlockStateV3 } from "@milaboratories/pl-model-common";
-import type { Operation } from "fast-json-patch";
-import type { MutateStoragePayload } from "./block_storage";
+import { MutateStoragePayload } from "./block_storage.js";
+import { AuthorMarker, BlockOutputsBase, BlockStateV3, NavigationState, ResultOrError, ValueWithUTag, ValueWithUTagAndAuthor } from "@milaboratories/pl-model-common";
+import { Operation } from "fast-json-patch";
+
+//#region src/block_api_v3.d.ts
 /** Defines methods to read and write current block data. */
-export interface BlockApiV3<_Data = unknown, _Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, Href extends `/${string}` = `/${string}`> {
-    /**
-     * Use this method to retrieve block state during UI initialization. Then use
-     * {@link onStateUpdates} method to subscribe for updates.
-     * */
-    loadBlockState(): Promise<ResultOrError<ValueWithUTag<BlockStateV3<_Data, Outputs, Href>>>>;
-    /**
-     * Get all json patches (rfc6902) that were applied to the block state.
-     * */
-    getPatches(uTag: string): Promise<ResultOrError<ValueWithUTagAndAuthor<Operation[]>>>;
-    /**
-     * Mutates block storage with the given operation.
-     *
-     * This method returns when the data is safely saved so in case the window is
-     * closed there will be no information losses. This function under the hood
-     * may delay actual persistence of the supplied values.
-     * */
-    mutateStorage(payload: MutateStoragePayload, author?: AuthorMarker): Promise<ResultOrError<void>>;
-    /**
-     * Sets block navigation state.
-     * */
-    setNavigationState(state: NavigationState<Href>): Promise<ResultOrError<void>>;
-    /**
-     * Disposes the block API.
-     * */
-    dispose(): Promise<ResultOrError<void>>;
+interface BlockApiV3<_Data = unknown, _Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, Href extends `/${string}` = `/${string}`> {
+  /**
+   * Use this method to retrieve block state during UI initialization. Then use
+   * {@link onStateUpdates} method to subscribe for updates.
+   * */
+  loadBlockState(): Promise<ResultOrError<ValueWithUTag<BlockStateV3<_Data, Outputs, Href>>>>;
+  /**
+   * Get all json patches (rfc6902) that were applied to the block state.
+   * */
+  getPatches(uTag: string): Promise<ResultOrError<ValueWithUTagAndAuthor<Operation[]>>>;
+  /**
+   * Mutates block storage with the given operation.
+   *
+   * This method returns when the data is safely saved so in case the window is
+   * closed there will be no information losses. This function under the hood
+   * may delay actual persistence of the supplied values.
+   * */
+  mutateStorage(payload: MutateStoragePayload, author?: AuthorMarker): Promise<ResultOrError<void>>;
+  /**
+   * Sets block navigation state.
+   * */
+  setNavigationState(state: NavigationState<Href>): Promise<ResultOrError<void>>;
+  /**
+   * Disposes the block API.
+   * */
+  dispose(): Promise<ResultOrError<void>>;
 }
+//#endregion
+export { BlockApiV3 };
 //# sourceMappingURL=block_api_v3.d.ts.map