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

package/types/Utility/block.d.ts

@@ -1,285 +1,285 @@
-import { BlockEvent, InvokeBlockActionFunc, SecurityGrant } from "@Obsidian/Types/Utility/block";
-import { IBlockPersonPreferencesProvider } from "@Obsidian/Types/Core/personPreferences";
-import { ExtendedRef } from "@Obsidian/Types/Utility/component";
-import { Ref } from "vue";
-import { Guid } from "@Obsidian/Types";
-import { HttpPostFunc } from "@Obsidian/Types/Utility/http";
-import { ValidPropertiesBox } from "@Obsidian/ViewModels/Utility/validPropertiesBox";
-import { IEntity } from "@Obsidian/ViewModels/entity";
-import { BrowserBus } from "./browserBus";
-/**
- * Maps the block configuration values to the expected type.
- *
- * @returns The configuration values for the block.
- */
-export declare function useConfigurationValues<T>(): T;
-/**
- * Gets the function that will be used to invoke block actions.
- *
- * @returns An instance of @see {@link InvokeBlockActionFunc}.
- */
-export declare function useInvokeBlockAction(): InvokeBlockActionFunc;
-/**
- * Gets the function that will return the URL for a block action.
- *
- * @returns A function that can be called to determine the URL for a block action.
- */
-export declare function useBlockActionUrl(): (actionName: string) => string;
-/**
- * Creates a function that can be provided to the block that allows calling
- * block actions.
- *
- * @private This should not be used by plugins.
- *
- * @param post The function to handle the post operation.
- * @param pageGuid The unique identifier of the page.
- * @param blockGuid The unique identifier of the block.
- * @param pageParameters The parameters to include with the block action calls.
- *
- * @returns A function that can be used to provide the invoke block action.
- */
-export declare function createInvokeBlockAction(post: HttpPostFunc, pageGuid: Guid, blockGuid: Guid, pageParameters: Record<string, string>, interactionGuid: Guid): InvokeBlockActionFunc;
-/**
- * Provides the reload block callback function for a block. This is an internal
- * method and should not be used by plugins.
- *
- * @param callback The callback that will be called when a block wants to reload itself.
- */
-export declare function provideReloadBlock(callback: () => void): void;
-/**
- * Gets a function that can be called when a block wants to reload itself.
- *
- * @returns A function that will cause the block component to be reloaded.
- */
-export declare function useReloadBlock(): () => void;
-/**
- * Provides the data for a block to be notified when its configuration values
- * have changed. This is an internal method and should not be used by plugins.
- *
- * @returns An object with an invoke and reset function.
- */
-export declare function provideConfigurationValuesChanged(): {
-    invoke: () => void;
-    reset: () => void;
-};
-/**
- * Registered a function to be called when the block configuration values have
- * changed.
- *
- * @param callback The function to be called when the configuration values have changed.
- */
-export declare function onConfigurationValuesChanged(callback: () => void): void;
-/**
- * Provides the static content that the block provided on the server.
- *
- * @param content The static content from the server.
- */
-export declare function provideStaticContent(content: Ref<Node[]>): void;
-/**
- * Gets the static content that was provided by the block on the server.
- *
- * @returns A string of HTML content or undefined.
- */
-export declare function useStaticContent(): Node[];
-/**
- * Provides the browser bus configured to publish messages for the current
- * block.
- *
- * @param bus The browser bus.
- */
-export declare function provideBlockBrowserBus(bus: BrowserBus): void;
-/**
- * Gets the browser bus configured for use by the current block. If available
- * this will be properly configured to publish messages with the correct block
- * and block type. If this is called outside the context of a block then a
- * generic use {@link BrowserBus} will be returned.
- *
- * @returns An instance of {@link BrowserBus}.
- */
-export declare function useBlockBrowserBus(): BrowserBus;
-/**
- * A type that returns the keys of a child property.
- */
-declare type ChildKeys<T extends Record<string, unknown>, PropertyName extends string> = keyof NonNullable<T[PropertyName]> & string;
-/**
- * A valid properties box that uses the specified name for the content bag.
- */
-declare type ValidPropertiesSettingsBox = {
-    validProperties?: string[] | null;
-} & {
-    settings?: Record<string, unknown> | null;
-};
-/**
- * Sets the a value for a custom settings box. This will set the value and then
- * add the property name to the list of valid properties.
- *
- * @param box The box whose custom setting value will be set.
- * @param propertyName The name of the custom setting property to set.
- * @param value The new value of the custom setting.
- */
-export declare function setCustomSettingsBoxValue<T extends ValidPropertiesSettingsBox, S extends NonNullable<T["settings"]>, K extends ChildKeys<T, "settings">>(box: T, propertyName: K, value: S[K]): void;
-/**
- * Sets the a value for a property box. This will set the value and then
- * add the property name to the list of valid properties.
- *
- * @param box The box whose property value will be set.
- * @param propertyName The name of the property on the bag to set.
- * @param value The new value of the property.
- */
-export declare function setPropertiesBoxValue<T extends Record<string, unknown>, K extends keyof T & string>(box: ValidPropertiesBox<T>, propertyName: K, value: T[K]): void;
-/**
- * Dispatches a block event to the document.
- *
- * @deprecated Do not use this function anymore, it will be removed in the future.
- * Use the BrowserBus instead.
- *
- * @param eventName The name of the event to be dispatched.
- * @param eventData The custom data to be attached to the event.
- *
- * @returns true if preventDefault() was called on the event, otherwise false.
- */
-export declare function dispatchBlockEvent(eventName: string, blockGuid: Guid, eventData?: unknown): boolean;
-/**
- * Tests if the given event is a custom block event. This does not ensure
- * that the event data is the correct type, only the event itself.
- *
- * @param event The event to be tested.
- *
- * @returns true if the event is a block event.
- */
-export declare function isBlockEvent<TData = undefined>(event: Event): event is CustomEvent<BlockEvent<TData>>;
-declare type UseEntityDetailBlockOptions = {
-    /** The block configuration. */
-    blockConfig: Record<string, unknown>;
-    /**
-     * The entity that will be used by the block, this will cause the
-     * onPropertyChanged logic to be generated.
-     */
-    entity?: Ref<ValidPropertiesBox<IEntity>>;
-};
-declare type UseEntityDetailBlockResult = {
-    /** The onPropertyChanged handler for the edit panel. */
-    onPropertyChanged?(propertyName: string): void;
-};
-/**
- * Performs any framework-level initialization of an entity detail block.
- *
- * @param options The options to use when initializing the detail block logic.
- *
- * @returns An object that contains information which can be used by the block.
- */
-export declare function useEntityDetailBlock(options: UseEntityDetailBlockOptions): UseEntityDetailBlockResult;
-/**
- * Provides the entity type name to child components.
- *
- * @param name The entity type name in PascalCase, such as `GroupMember`.
- */
-export declare function provideEntityTypeName(name: string): void;
-/**
- * Gets the entity type name provided from a parent component.
- *
- * @returns The entity type name in PascalCase, such as `GroupMember` or undefined.
- */
-export declare function useEntityTypeName(): string | undefined;
-/**
- * Provides the entity type unique identifier to child components.
- *
- * @param guid The entity type unique identifier.
- */
-export declare function provideEntityTypeGuid(guid: Guid): void;
-/**
- * Gets the entity type unique identifier provided from a parent component.
- *
- * @returns The entity type unique identifier or undefined.
- */
-export declare function useEntityTypeGuid(): Guid | undefined;
-/**
- * Use a security grant token value provided by the server. This returns a reference
- * to the actual value and will automatically handle renewing the token and updating
- * the value. This function is meant to be used by blocks. Controls should use the
- * useSecurityGrant() function instead.
- *
- * @param token The token provided by the server.
- *
- * @returns A reference to the security grant that will be updated automatically when it has been renewed.
- */
-export declare function getSecurityGrant(token: string | null | undefined): SecurityGrant;
-/**
- * Provides the security grant to child components to use in their API calls.
- *
- * @param grant The grant ot provide to child components.
- */
-export declare function provideSecurityGrant(grant: SecurityGrant): void;
-/**
- * Uses a previously provided security grant token by a parent component.
- * This function is meant to be used by controls that need to obtain a security
- * grant from a parent component.
- *
- * @returns A string reference that contains the security grant token.
- */
-export declare function useSecurityGrantToken(): Ref<string | null>;
-/** An emit object that conforms to having a propertyChanged event. */
-export declare type PropertyChangedEmitFn<E extends "propertyChanged"> = E extends Array<infer EE> ? (event: EE, ...args: any[]) => void : (event: E, ...args: any[]) => void;
-/**
- * Watches for changes to the given Ref objects and emits a special event to
- * indicate that a given property has changed.
- *
- * @param propertyRefs The ExtendedRef objects to watch for changes.
- * @param emit The emit function for the component.
- */
-export declare function watchPropertyChanges<E extends "propertyChanged">(propertyRefs: ExtendedRef<unknown>[], emit: PropertyChangedEmitFn<E>): void;
-/**
- * Requests an updated attribute list from the server based on the
- * current UI selections made.
- *
- * @param bag The entity bag that will be used to determine current property values
- * and then updated with the new attributes and values.
- * @param validProperties The properties that are considered valid on the bag when
- * the server will read the bag.
- * @param invokeBlockAction The function to use when calling the block action.
- */
-export declare function refreshDetailAttributes<TEntityBag>(bag: Ref<TEntityBag>, validProperties: string[], invokeBlockAction: InvokeBlockActionFunc): Promise<void>;
-/**
- * Provides the block unique identifier to all child components.
- * This is an internal method and should not be used by plugins.
- *
- * @param blockGuid The unique identifier of the block.
- */
-export declare function provideBlockGuid(blockGuid: string): void;
-/**
- * Gets the unique identifier of the current block in this component chain.
- *
- * @returns The unique identifier of the block.
- */
-export declare function useBlockGuid(): Guid | undefined;
-/**
- * Provides the block type unique identifier to all child components.
- * This is an internal method and should not be used by plugins.
- *
- * @param blockTypeGuid The unique identifier of the block type.
- */
-export declare function provideBlockTypeGuid(blockTypeGuid: string): void;
-/**
- * Gets the block type unique identifier of the current block in this component
- * chain.
- *
- * @returns The unique identifier of the block type.
- */
-export declare function useBlockTypeGuid(): Guid | undefined;
-/**
- * Provides the person preferences provider that will be used by components
- * to access the person preferences associated with their block.
- *
- * @private This is an internal method and should not be used by plugins.
- *
- * @param blockGuid The unique identifier of the block.
- */
-export declare function providePersonPreferences(provider: IBlockPersonPreferencesProvider): void;
-/**
- * Gets the person preference provider that can be used to access block
- * preferences as well as other preferences.
- *
- * @returns An object that implements {@link IBlockPersonPreferencesProvider}.
- */
-export declare function usePersonPreferences(): IBlockPersonPreferencesProvider;
-export {};
+import { BlockEvent, InvokeBlockActionFunc, SecurityGrant } from "@Obsidian/Types/Utility/block";
+import { IBlockPersonPreferencesProvider } from "@Obsidian/Types/Core/personPreferences";
+import { ExtendedRef } from "@Obsidian/Types/Utility/component";
+import { Ref } from "vue";
+import { Guid } from "@Obsidian/Types";
+import { HttpPostFunc } from "@Obsidian/Types/Utility/http";
+import { ValidPropertiesBox } from "@Obsidian/ViewModels/Utility/validPropertiesBox";
+import { IEntity } from "@Obsidian/ViewModels/entity";
+import { BrowserBus } from "./browserBus";
+/**
+ * Maps the block configuration values to the expected type.
+ *
+ * @returns The configuration values for the block.
+ */
+export declare function useConfigurationValues<T>(): T;
+/**
+ * Gets the function that will be used to invoke block actions.
+ *
+ * @returns An instance of @see {@link InvokeBlockActionFunc}.
+ */
+export declare function useInvokeBlockAction(): InvokeBlockActionFunc;
+/**
+ * Gets the function that will return the URL for a block action.
+ *
+ * @returns A function that can be called to determine the URL for a block action.
+ */
+export declare function useBlockActionUrl(): (actionName: string) => string;
+/**
+ * Creates a function that can be provided to the block that allows calling
+ * block actions.
+ *
+ * @private This should not be used by plugins.
+ *
+ * @param post The function to handle the post operation.
+ * @param pageGuid The unique identifier of the page.
+ * @param blockGuid The unique identifier of the block.
+ * @param pageParameters The parameters to include with the block action calls.
+ *
+ * @returns A function that can be used to provide the invoke block action.
+ */
+export declare function createInvokeBlockAction(post: HttpPostFunc, pageGuid: Guid, blockGuid: Guid, pageParameters: Record<string, string>, interactionGuid: Guid): InvokeBlockActionFunc;
+/**
+ * Provides the reload block callback function for a block. This is an internal
+ * method and should not be used by plugins.
+ *
+ * @param callback The callback that will be called when a block wants to reload itself.
+ */
+export declare function provideReloadBlock(callback: () => void): void;
+/**
+ * Gets a function that can be called when a block wants to reload itself.
+ *
+ * @returns A function that will cause the block component to be reloaded.
+ */
+export declare function useReloadBlock(): () => void;
+/**
+ * Provides the data for a block to be notified when its configuration values
+ * have changed. This is an internal method and should not be used by plugins.
+ *
+ * @returns An object with an invoke and reset function.
+ */
+export declare function provideConfigurationValuesChanged(): {
+    invoke: () => void;
+    reset: () => void;
+};
+/**
+ * Registered a function to be called when the block configuration values have
+ * changed.
+ *
+ * @param callback The function to be called when the configuration values have changed.
+ */
+export declare function onConfigurationValuesChanged(callback: () => void): void;
+/**
+ * Provides the static content that the block provided on the server.
+ *
+ * @param content The static content from the server.
+ */
+export declare function provideStaticContent(content: Ref<Node[]>): void;
+/**
+ * Gets the static content that was provided by the block on the server.
+ *
+ * @returns A string of HTML content or undefined.
+ */
+export declare function useStaticContent(): Node[];
+/**
+ * Provides the browser bus configured to publish messages for the current
+ * block.
+ *
+ * @param bus The browser bus.
+ */
+export declare function provideBlockBrowserBus(bus: BrowserBus): void;
+/**
+ * Gets the browser bus configured for use by the current block. If available
+ * this will be properly configured to publish messages with the correct block
+ * and block type. If this is called outside the context of a block then a
+ * generic use {@link BrowserBus} will be returned.
+ *
+ * @returns An instance of {@link BrowserBus}.
+ */
+export declare function useBlockBrowserBus(): BrowserBus;
+/**
+ * A type that returns the keys of a child property.
+ */
+type ChildKeys<T extends Record<string, unknown>, PropertyName extends string> = keyof NonNullable<T[PropertyName]> & string;
+/**
+ * A valid properties box that uses the specified name for the content bag.
+ */
+type ValidPropertiesSettingsBox = {
+    validProperties?: string[] | null;
+} & {
+    settings?: Record<string, unknown> | null;
+};
+/**
+ * Sets the a value for a custom settings box. This will set the value and then
+ * add the property name to the list of valid properties.
+ *
+ * @param box The box whose custom setting value will be set.
+ * @param propertyName The name of the custom setting property to set.
+ * @param value The new value of the custom setting.
+ */
+export declare function setCustomSettingsBoxValue<T extends ValidPropertiesSettingsBox, S extends NonNullable<T["settings"]>, K extends ChildKeys<T, "settings">>(box: T, propertyName: K, value: S[K]): void;
+/**
+ * Sets the a value for a property box. This will set the value and then
+ * add the property name to the list of valid properties.
+ *
+ * @param box The box whose property value will be set.
+ * @param propertyName The name of the property on the bag to set.
+ * @param value The new value of the property.
+ */
+export declare function setPropertiesBoxValue<T extends Record<string, unknown>, K extends keyof T & string>(box: ValidPropertiesBox<T>, propertyName: K, value: T[K]): void;
+/**
+ * Dispatches a block event to the document.
+ *
+ * @deprecated Do not use this function anymore, it will be removed in the future.
+ * Use the BrowserBus instead.
+ *
+ * @param eventName The name of the event to be dispatched.
+ * @param eventData The custom data to be attached to the event.
+ *
+ * @returns true if preventDefault() was called on the event, otherwise false.
+ */
+export declare function dispatchBlockEvent(eventName: string, blockGuid: Guid, eventData?: unknown): boolean;
+/**
+ * Tests if the given event is a custom block event. This does not ensure
+ * that the event data is the correct type, only the event itself.
+ *
+ * @param event The event to be tested.
+ *
+ * @returns true if the event is a block event.
+ */
+export declare function isBlockEvent<TData = undefined>(event: Event): event is CustomEvent<BlockEvent<TData>>;
+type UseEntityDetailBlockOptions = {
+    /** The block configuration. */
+    blockConfig: Record<string, unknown>;
+    /**
+     * The entity that will be used by the block, this will cause the
+     * onPropertyChanged logic to be generated.
+     */
+    entity?: Ref<ValidPropertiesBox<IEntity>>;
+};
+type UseEntityDetailBlockResult = {
+    /** The onPropertyChanged handler for the edit panel. */
+    onPropertyChanged?(propertyName: string): void;
+};
+/**
+ * Performs any framework-level initialization of an entity detail block.
+ *
+ * @param options The options to use when initializing the detail block logic.
+ *
+ * @returns An object that contains information which can be used by the block.
+ */
+export declare function useEntityDetailBlock(options: UseEntityDetailBlockOptions): UseEntityDetailBlockResult;
+/**
+ * Provides the entity type name to child components.
+ *
+ * @param name The entity type name in PascalCase, such as `GroupMember`.
+ */
+export declare function provideEntityTypeName(name: string): void;
+/**
+ * Gets the entity type name provided from a parent component.
+ *
+ * @returns The entity type name in PascalCase, such as `GroupMember` or undefined.
+ */
+export declare function useEntityTypeName(): string | undefined;
+/**
+ * Provides the entity type unique identifier to child components.
+ *
+ * @param guid The entity type unique identifier.
+ */
+export declare function provideEntityTypeGuid(guid: Guid): void;
+/**
+ * Gets the entity type unique identifier provided from a parent component.
+ *
+ * @returns The entity type unique identifier or undefined.
+ */
+export declare function useEntityTypeGuid(): Guid | undefined;
+/**
+ * Use a security grant token value provided by the server. This returns a reference
+ * to the actual value and will automatically handle renewing the token and updating
+ * the value. This function is meant to be used by blocks. Controls should use the
+ * useSecurityGrant() function instead.
+ *
+ * @param token The token provided by the server.
+ *
+ * @returns A reference to the security grant that will be updated automatically when it has been renewed.
+ */
+export declare function getSecurityGrant(token: string | null | undefined): SecurityGrant;
+/**
+ * Provides the security grant to child components to use in their API calls.
+ *
+ * @param grant The grant to provide to child components.
+ */
+export declare function provideSecurityGrant(grant: SecurityGrant): void;
+/**
+ * Uses a previously provided security grant token by a parent component.
+ * This function is meant to be used by controls that need to obtain a security
+ * grant from a parent component.
+ *
+ * @returns A string reference that contains the security grant token.
+ */
+export declare function useSecurityGrantToken(): Ref<string | null>;
+/** An emit object that conforms to having a propertyChanged event. */
+export type PropertyChangedEmitFn<E extends "propertyChanged"> = E extends Array<infer EE> ? (event: EE, ...args: any[]) => void : (event: E, ...args: any[]) => void;
+/**
+ * Watches for changes to the given Ref objects and emits a special event to
+ * indicate that a given property has changed.
+ *
+ * @param propertyRefs The ExtendedRef objects to watch for changes.
+ * @param emit The emit function for the component.
+ */
+export declare function watchPropertyChanges<E extends "propertyChanged">(propertyRefs: ExtendedRef<unknown>[], emit: PropertyChangedEmitFn<E>): void;
+/**
+ * Requests an updated attribute list from the server based on the
+ * current UI selections made.
+ *
+ * @param bag The entity bag that will be used to determine current property values
+ * and then updated with the new attributes and values.
+ * @param validProperties The properties that are considered valid on the bag when
+ * the server will read the bag.
+ * @param invokeBlockAction The function to use when calling the block action.
+ */
+export declare function refreshDetailAttributes<TEntityBag>(bag: Ref<TEntityBag>, validProperties: string[], invokeBlockAction: InvokeBlockActionFunc): Promise<void>;
+/**
+ * Provides the block unique identifier to all child components.
+ * This is an internal method and should not be used by plugins.
+ *
+ * @param blockGuid The unique identifier of the block.
+ */
+export declare function provideBlockGuid(blockGuid: string): void;
+/**
+ * Gets the unique identifier of the current block in this component chain.
+ *
+ * @returns The unique identifier of the block.
+ */
+export declare function useBlockGuid(): Guid | undefined;
+/**
+ * Provides the block type unique identifier to all child components.
+ * This is an internal method and should not be used by plugins.
+ *
+ * @param blockTypeGuid The unique identifier of the block type.
+ */
+export declare function provideBlockTypeGuid(blockTypeGuid: string): void;
+/**
+ * Gets the block type unique identifier of the current block in this component
+ * chain.
+ *
+ * @returns The unique identifier of the block type.
+ */
+export declare function useBlockTypeGuid(): Guid | undefined;
+/**
+ * Provides the person preferences provider that will be used by components
+ * to access the person preferences associated with their block.
+ *
+ * @private This is an internal method and should not be used by plugins.
+ *
+ * @param blockGuid The unique identifier of the block.
+ */
+export declare function providePersonPreferences(provider: IBlockPersonPreferencesProvider): void;
+/**
+ * Gets the person preference provider that can be used to access block
+ * preferences as well as other preferences.
+ *
+ * @returns An object that implements {@link IBlockPersonPreferencesProvider}.
+ */
+export declare function usePersonPreferences(): IBlockPersonPreferencesProvider;
+export {};

package/types/Utility/booleanUtils.d.ts

@@ -1,16 +1,16 @@
-/**
- * Transform the value into true, false, or null
- * @param val
- */
-export declare function asBooleanOrNull(val: unknown): boolean | null;
-/**
- * Transform the value into true or false
- * @param val
- */
-export declare function asBoolean(val: unknown): boolean;
-/** Transform the value into the strings "Yes", "No", or null */
-export declare function asYesNoOrNull(val: unknown): "Yes" | "No" | null;
-/** Transform the value into the strings "True", "False", or null */
-export declare function asTrueFalseOrNull(val: unknown): "True" | "False" | null;
-/** Transform the value into the strings "True" if truthy or "False" if falsey */
-export declare function asTrueOrFalseString(val: unknown): "True" | "False";
+/**
+ * Transform the value into true, false, or null
+ * @param val
+ */
+export declare function asBooleanOrNull(val: unknown): boolean | null;
+/**
+ * Transform the value into true or false
+ * @param val
+ */
+export declare function asBoolean(val: unknown): boolean;
+/** Transform the value into the strings "Yes", "No", or null */
+export declare function asYesNoOrNull(val: unknown): "Yes" | "No" | null;
+/** Transform the value into the strings "True", "False", or null */
+export declare function asTrueFalseOrNull(val: unknown): "True" | "False" | null;
+/** Transform the value into the strings "True" if truthy or "False" if falsey */
+export declare function asTrueOrFalseString(val: unknown): "True" | "False";