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

package/types/Utility/screenSize.d.ts

@@ -0,0 +1,9 @@
+import { Ref } from "vue";
+export declare function useScreenSize(mobileThreshold?: number): {
+    isMobile: Ref<boolean>;
+    screenSize: Ref<number>;
+};
+export declare function useViewportWidth(mobileThreshold?: number): {
+    isMobile: Ref<boolean>;
+    viewportWidth: Ref<number>;
+};

package/types/Utility/slidingDateRange.d.ts

@@ -1,82 +1,82 @@
-import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
-import { SlidingDateRangeType as RangeType } from "@Obsidian/Enums/Controls/slidingDateRangeType";
-import { TimeUnitType as TimeUnit } from "@Obsidian/Enums/Controls/timeUnitType";
-import { RockDateTime } from "./rockDateTime";
-/**
- * The enums have been moved to separate files in order to share with the back end. We import them
- * above (with the names used by the definitions that used to exist in this file) so they can be
- * used below and we export them here so that any files previously importing them from here
- * do not break.
- */
-export { SlidingDateRangeType as RangeType } from "@Obsidian/Enums/Controls/slidingDateRangeType";
-export { TimeUnitType as TimeUnit } from "@Obsidian/Enums/Controls/timeUnitType";
-/**
- * Specifies the information required to track a sliding date range.
- */
-export declare type SlidingDateRange = {
-    /** The type of sliding date range represented by this instance. */
-    rangeType: RangeType;
-    /** The unit of time represented by the timeValue property. */
-    timeUnit?: TimeUnit;
-    /** The number of time units used when calculating the date range. */
-    timeValue?: number;
-    /** The lower value of a specific date range. */
-    lowerDate?: string;
-    /** The upper value of a specific date range. */
-    upperDate?: string;
-};
-/**
- * The sliding date range types represented as an array of ListItemBag objects.
- * These are ordered correctly and can be used in pickers.
- */
-export declare const rangeTypeOptions: ListItemBag[];
-/**
- * The sliding date range time units represented as an array of ListItemBag objects.
- * These are ordered correctly and can be used in pickers.
- */
-export declare const timeUnitOptions: ListItemBag[];
-/**
- * Gets the user friendly text that represents the RangeType value.
- *
- * @param rangeType The RangeType value to be represented.
- *
- * @returns A human readable string that represents the RangeType value.
- */
-export declare function getRangeTypeText(rangeType: RangeType): string;
-/**
- * Gets the user friendly text that represents the TimeUnit value.
- *
- * @param timeUnit The TimeUnit value to be represented.
- *
- * @returns A human readable string that represents the TimeUnit value.
- */
-export declare function getTimeUnitText(timeUnit: TimeUnit): string;
-/**
- * Parses a pipe delimited string into a SlidingDateRange native object. The
- * delimited string is a format used by attribute values and other places.
- *
- * @param value The pipe delimited string that should be parsed.
- *
- * @returns A SlidingDaterange object or null if the string could not be parsed.
- */
-export declare function parseSlidingDateRangeString(value: string): SlidingDateRange | null;
-/**
- * Formats the pipe delimited string.
- *
- * @param value The pipe delimited string that should be formatted.
- *
- * @returns A string that formats the sliding date range.
- */
-export declare function slidingDateRangeToString(value: SlidingDateRange): string;
-/**
- * Calculates the start and end dates in a sliding date range.
- *
- * @param value The sliding date range to use when calculating dates.
- * @param currentDateTime The date and time to use in any "now" calculations.
- *
- * @returns An object that contains the start and end dates and times.
- */
-export declare function calculateSlidingDateRange(value: SlidingDateRange, currentDateTime?: RockDateTime | null | undefined): {
-    start: RockDateTime | null;
-    end: RockDateTime | null;
-};
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { SlidingDateRangeType as RangeType } from "@Obsidian/Enums/Controls/slidingDateRangeType";
+import { TimeUnitType as TimeUnit } from "@Obsidian/Enums/Controls/timeUnitType";
+import { RockDateTime } from "./rockDateTime";
+/**
+ * The enums have been moved to separate files in order to share with the back end. We import them
+ * above (with the names used by the definitions that used to exist in this file) so they can be
+ * used below and we export them here so that any files previously importing them from here
+ * do not break.
+ */
+export { SlidingDateRangeType as RangeType } from "@Obsidian/Enums/Controls/slidingDateRangeType";
+export { TimeUnitType as TimeUnit } from "@Obsidian/Enums/Controls/timeUnitType";
+/**
+ * Specifies the information required to track a sliding date range.
+ */
+export type SlidingDateRange = {
+    /** The type of sliding date range represented by this instance. */
+    rangeType: RangeType;
+    /** The unit of time represented by the timeValue property. */
+    timeUnit?: TimeUnit;
+    /** The number of time units used when calculating the date range. */
+    timeValue?: number;
+    /** The lower value of a specific date range. */
+    lowerDate?: string;
+    /** The upper value of a specific date range. */
+    upperDate?: string;
+};
+/**
+ * The sliding date range types represented as an array of ListItemBag objects.
+ * These are ordered correctly and can be used in pickers.
+ */
+export declare const rangeTypeOptions: ListItemBag[];
+/**
+ * The sliding date range time units represented as an array of ListItemBag objects.
+ * These are ordered correctly and can be used in pickers.
+ */
+export declare const timeUnitOptions: ListItemBag[];
+/**
+ * Gets the user friendly text that represents the RangeType value.
+ *
+ * @param rangeType The RangeType value to be represented.
+ *
+ * @returns A human readable string that represents the RangeType value.
+ */
+export declare function getRangeTypeText(rangeType: RangeType): string;
+/**
+ * Gets the user friendly text that represents the TimeUnit value.
+ *
+ * @param timeUnit The TimeUnit value to be represented.
+ *
+ * @returns A human readable string that represents the TimeUnit value.
+ */
+export declare function getTimeUnitText(timeUnit: TimeUnit): string;
+/**
+ * Parses a pipe delimited string into a SlidingDateRange native object. The
+ * delimited string is a format used by attribute values and other places.
+ *
+ * @param value The pipe delimited string that should be parsed.
+ *
+ * @returns A SlidingDaterange object or null if the string could not be parsed.
+ */
+export declare function parseSlidingDateRangeString(value: string): SlidingDateRange | null;
+/**
+ * Formats the pipe delimited string.
+ *
+ * @param value The pipe delimited string that should be formatted.
+ *
+ * @returns A string that formats the sliding date range.
+ */
+export declare function slidingDateRangeToString(value: SlidingDateRange): string;
+/**
+ * Calculates the start and end dates in a sliding date range.
+ *
+ * @param value The sliding date range to use when calculating dates.
+ * @param currentDateTime The date and time to use in any "now" calculations.
+ *
+ * @returns An object that contains the start and end dates and times.
+ */
+export declare function calculateSlidingDateRange(value: SlidingDateRange, currentDateTime?: RockDateTime | null | undefined): {
+    start: RockDateTime | null;
+    end: RockDateTime | null;
+};

package/types/Utility/stringUtils.d.ts

@@ -1,136 +1,175 @@
-/**
- * Is the value an empty string?
- * @param val
- */
-export declare function isEmpty(val: unknown): boolean;
-/**
- * Is the value an empty string?
- * @param val
- */
-export declare function isWhiteSpace(val: unknown): boolean;
-/**
- * Is the value null, undefined or whitespace?
- * @param val
- */
-export declare function isNullOrWhiteSpace(val: unknown): boolean;
-/**
- * Turns camelCase or PascalCase strings into separate strings - "MyCamelCaseString" turns into "My Camel Case String"
- * @param val
- */
-export declare function splitCase(val: string): string;
-/**
- * Returns a string that has each item comma separated except for the last
- * which will use the word "and".
- *
- * @example
- * ['a', 'b', 'c'] => 'a, b and c'
- *
- * @param strs The strings to be joined.
- * @param andStr The custom string to use instead of the word "and".
- *
- * @returns A string that represents all the strings.
- */
-export declare function asCommaAnd(strs: string[], andStr?: string): string;
-/**
- * Convert the string to the title case.
- * hellO worlD => Hello World
- * @param str
- */
-export declare function toTitleCase(str: string | null): string;
-/**
- * Capitalize the first character
- */
-export declare function upperCaseFirstCharacter(str: string | null): string;
-/**
- * Pluralizes the given word. If count is specified and is equal to 1 then
- * the singular form of the word is returned. This will also de-pluralize a
- * word if required.
- *
- * @param word The word to be pluralized or singularized.
- * @param count An optional count to indicate when the word should be singularized.
- *
- * @returns The word in plural or singular form depending on the options.
- */
-export declare function pluralize(word: string, count?: number): string;
-/**
- * Returns a singular or plural phrase depending on if the number is 1.
- * (0, Cat, Cats) => Cats
- * (1, Cat, Cats) => Cat
- * (2, Cat, Cats) => Cats
- * @param num
- * @param singular
- * @param plural
- */
-export declare function pluralConditional(num: number, singular: string, plural: string): string;
-/**
- * Pad the left side of a string so it is at least length characters long.
- *
- * @param str The string to be padded.
- * @param length The minimum length to make the string.
- * @param padCharacter The character to use to pad the string.
- */
-export declare function padLeft(str: string | undefined | null, length: number, padCharacter?: string): string;
-/**
- * Pad the right side of a string so it is at least length characters long.
- *
- * @param str The string to be padded.
- * @param length The minimum length to make the string.
- * @param padCharacter The character to use to pad the string.
- */
-export declare function padRight(str: string | undefined | null, length: number, padCharacter?: string): string;
-export declare type TruncateOptions = {
-    ellipsis?: boolean;
-};
-/**
- * Ensure a string does not go over the character limit. Truncation happens
- * on word boundaries.
- *
- * @param str The string to be truncated.
- * @param limit The maximum length of the resulting string.
- * @param options Additional options that control how truncation will happen.
- *
- * @returns The truncated string.
- */
-export declare function truncate(str: string, limit: number, options?: TruncateOptions): string;
-/**
- * Escapes a string so it can be used in HTML. This turns things like the <
- * character into the &lt; sequence so it will still render as "<".
- *
- * @param str The string to be escaped.
- * @returns A string that has all HTML entities escaped.
- */
-export declare function escapeHtml(str: string): string;
-/**
- * The default compare value function for UI controls. This checks if both values
- * are GUIDs and if so does a case-insensitive compare, otherwise it does a
- * case-sensitive compare of the two values.
- *
- * @param value The value selected in the UI.
- * @param itemValue The item value to be compared against.
- *
- * @returns true if the two values are considered equal; otherwise false.
- */
-export declare function defaultControlCompareValue(value: string, itemValue: string): boolean;
-/**
- * Determins whether or not a given string contains any HTML tags in.
- *
- * @param value The string potentially containing HTML
- *
- * @returns true if it contains HTML, otherwise false
- */
-export declare function containsHtmlTag(value: string): boolean;
-declare const _default: {
-    asCommaAnd: typeof asCommaAnd;
-    containsHtmlTag: typeof containsHtmlTag;
-    escapeHtml: typeof escapeHtml;
-    splitCase: typeof splitCase;
-    isNullOrWhiteSpace: typeof isNullOrWhiteSpace;
-    isWhiteSpace: typeof isWhiteSpace;
-    isEmpty: typeof isEmpty;
-    toTitleCase: typeof toTitleCase;
-    pluralConditional: typeof pluralConditional;
-    padLeft: typeof padLeft;
-    padRight: typeof padRight;
-    truncate: typeof truncate;
-};
-export default _default;
+/**
+ * Is the value an empty string?
+ * @param val
+ */
+export declare function isEmpty(val: unknown): boolean;
+/**
+ * Is the value an empty string?
+ * @param val
+ */
+export declare function isWhiteSpace(val: unknown): boolean;
+/**
+ * Is the value null, undefined or whitespace?
+ * @param val
+ */
+export declare function isNullOrWhiteSpace(val: unknown): boolean;
+/**
+ * Turns camelCase or PascalCase strings into separate strings - "MyCamelCaseString" turns into "My Camel Case String"
+ * @param val
+ */
+export declare function splitCase(val: string): string;
+/**
+ * Returns a string that has each item comma separated except for the last
+ * which will use the word "and".
+ *
+ * @example
+ * ['a', 'b', 'c'] => 'a, b and c'
+ *
+ * @param strs The strings to be joined.
+ * @param andStr The custom string to use instead of the word "and".
+ *
+ * @returns A string that represents all the strings.
+ */
+export declare function asCommaAnd(strs: string[], andStr?: string): string;
+/**
+ * Convert the string to the title case.
+ * hellO worlD => Hello World
+ * @param str
+ */
+export declare function toTitleCase(str: string | null): string;
+type KebabCaseOptions = {
+    /** Keep intentional multiple dashes. */
+    preserveMultipleDashes?: boolean;
+    /** Allow a leading dashes. */
+    allowLeadingDashes?: boolean;
+    /** Allow a trailing dashes. */
+    allowTrailingDashes?: boolean;
+    /** Keep special characters (except spaces). */
+    allowSpecialChars?: boolean;
+};
+/**
+ * Converts the string to kebab-case.
+ *
+ * @example
+ * toKebabCase("helloWorLd") // "hello-wor-ld"
+ *
+ * @param str
+ */
+export declare function toKebabCase(str: string, options?: KebabCaseOptions): string;
+/**
+ * Capitalize the first character
+ */
+export declare function upperCaseFirstCharacter(str: string | null): string;
+/**
+ * Pluralizes the given word. If count is specified and is equal to 1 then
+ * the singular form of the word is returned. This will also de-pluralize a
+ * word if required.
+ *
+ * @param word The word to be pluralized or singularized.
+ * @param count An optional count to indicate when the word should be singularized.
+ *
+ * @returns The word in plural or singular form depending on the options.
+ */
+export declare function pluralize(word: string, count?: number): string;
+/**
+ * Returns a singular or plural phrase depending on if the number is 1.
+ * (0, Cat, Cats) => Cats
+ * (1, Cat, Cats) => Cat
+ * (2, Cat, Cats) => Cats
+ * @param num
+ * @param singular
+ * @param plural
+ */
+export declare function pluralConditional(num: number, singular: string, plural: string): string;
+/**
+ * Pad the left side of a string so it is at least length characters long.
+ *
+ * @param str The string to be padded.
+ * @param length The minimum length to make the string.
+ * @param padCharacter The character to use to pad the string.
+ */
+export declare function padLeft(str: string | undefined | null, length: number, padCharacter?: string): string;
+/**
+ * Pad the right side of a string so it is at least length characters long.
+ *
+ * @param str The string to be padded.
+ * @param length The minimum length to make the string.
+ * @param padCharacter The character to use to pad the string.
+ */
+export declare function padRight(str: string | undefined | null, length: number, padCharacter?: string): string;
+export type TruncateOptions = {
+    ellipsis?: boolean;
+};
+/**
+ * Ensure a string does not go over the character limit. Truncation happens
+ * on word boundaries.
+ *
+ * @param str The string to be truncated.
+ * @param limit The maximum length of the resulting string.
+ * @param options Additional options that control how truncation will happen.
+ *
+ * @returns The truncated string.
+ */
+export declare function truncate(str: string, limit: number, options?: TruncateOptions): string;
+/**
+ * Escapes a string so it can be used in HTML. This turns things like the <
+ * character into the &lt; sequence so it will still render as "<".
+ *
+ * @param str The string to be escaped.
+ * @returns A string that has all HTML entities escaped.
+ */
+export declare function escapeHtml(str: string): string;
+/**
+ * The default compare value function for UI controls. This checks if both values
+ * are GUIDs and if so does a case-insensitive compare, otherwise it does a
+ * case-sensitive compare of the two values.
+ *
+ * @param value The value selected in the UI.
+ * @param itemValue The item value to be compared against.
+ *
+ * @returns true if the two values are considered equal; otherwise false.
+ */
+export declare function defaultControlCompareValue(value: string, itemValue: string): boolean;
+/**
+ * Determins whether or not a given string contains any HTML tags in.
+ *
+ * @param value The string potentially containing HTML
+ *
+ * @returns true if it contains HTML, otherwise false
+ */
+export declare function containsHtmlTag(value: string): boolean;
+/**
+ * Create a 32-bit integer hash representation of a string.
+ *
+ * @param str The string to be hashed
+ *
+ * @returns The 32-bit integer hash representation of the string.
+ */
+export declare function createHash(str: string): number;
+/**
+ * Replaces all instances of `search` in `str` with `replace`.
+ * @param str The source string.
+ * @param search The string to search for.
+ * @param replace The string to replace with.
+ */
+export declare function replaceAll(str: string, search: string, replace: string): string;
+declare const _default: {
+    asCommaAnd: typeof asCommaAnd;
+    containsHtmlTag: typeof containsHtmlTag;
+    escapeHtml: typeof escapeHtml;
+    splitCase: typeof splitCase;
+    isNullOrWhiteSpace: typeof isNullOrWhiteSpace;
+    isWhiteSpace: typeof isWhiteSpace;
+    isEmpty: typeof isEmpty;
+    toKebabCase: typeof toKebabCase;
+    toTitleCase: typeof toTitleCase;
+    upperCaseFirstCharacter: typeof upperCaseFirstCharacter;
+    pluralize: typeof pluralize;
+    pluralConditional: typeof pluralConditional;
+    padLeft: typeof padLeft;
+    padRight: typeof padRight;
+    truncate: typeof truncate;
+    createHash: typeof createHash;
+    replaceAll: typeof replaceAll;
+};
+export default _default;

package/types/Utility/structuredContentEditor.d.ts

@@ -1,8 +1,8 @@
-import { StructuredContentEditorConfigurationBag } from "@Obsidian/ViewModels/Rest/Controls/structuredContentEditorConfigurationBag";
-import { StructuredContentEditorGetConfigurationOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/structuredContentEditorGetConfigurationOptionsBag";
-/** Fetches the configuration for the structured content editor. */
-export declare function getStructuredContentEditorConfiguration(options: StructuredContentEditorGetConfigurationOptionsBag): Promise<StructuredContentEditorConfigurationBag>;
-declare const _default: {
-    getStructuredContentEditorConfiguration: typeof getStructuredContentEditorConfiguration;
-};
-export default _default;
+import { StructuredContentEditorConfigurationBag } from "@Obsidian/ViewModels/Rest/Controls/structuredContentEditorConfigurationBag";
+import { StructuredContentEditorGetConfigurationOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/structuredContentEditorGetConfigurationOptionsBag";
+/** Fetches the configuration for the structured content editor. */
+export declare function getStructuredContentEditorConfiguration(options: StructuredContentEditorGetConfigurationOptionsBag): Promise<StructuredContentEditorConfigurationBag>;
+declare const _default: {
+    getStructuredContentEditorConfiguration: typeof getStructuredContentEditorConfiguration;
+};
+export default _default;