@rockrms/obsidian-framework 1.16.3-rc.1

package/types/Types/Controls/itemsWithPreAndPostHtml.d.ts

@@ -0,0 +1,5 @@
+export type ItemWithPreAndPostHtml = {
+    slotName: string;
+    preHtml: string;
+    postHtml: string;
+};

package/types/Types/Controls/keyValueItem.d.ts

@@ -0,0 +1,22 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+export type KeyValueItem = {
+    key?: string | null;
+
+    value?: string | null;
+};

package/types/Types/Controls/numberRangeBox.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The model value used by the NumberRangeBox element.
+ */
+export type NumberRangeModelValue = {
+    /** The lower number of the range. */
+    lower: number | null;
+
+    /** The upper number of the range. */
+    upper: number | null;
+};

package/types/Types/Controls/numberUpDownGroup.d.ts

@@ -0,0 +1,6 @@
+export type NumberUpDownGroupOption = {
+    key: string,
+    label: string,
+    min: number,
+    max: number
+};

package/types/Types/Controls/panelAction.d.ts

@@ -0,0 +1,47 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { LiteralUnion } from "@Obsidian/Types/Utility/support";
+
+/** The type to use for coloring and styling of the action. */
+export type PanelActionType = "default" | "primary" | "success" | "info" | "warning" | "danger" | "link";
+
+/** A function that will be called in response to an action. */
+export type PanelActionCallback = (event: Event) => void | Promise<void>;
+
+/** Defines a single action related to a Panel control. */
+export type PanelAction = {
+    /**
+     * The title of the action, this should be a very short (one or two words)
+     * description of the action that will be performed, such as "Delete".
+     */
+    title?: string;
+
+    /**
+     * The CSS class for the icon used when displaying this action.
+     */
+    iconCssClass?: string;
+
+    /** The type of action for styling. */
+    type: LiteralUnion<PanelActionType>;
+
+    /** The callback function that will handle the action. */
+    handler?: PanelActionCallback;
+
+    /** If true then the action will be disabled and not respond to clicks. */
+    disabled?: boolean;
+};

package/types/Types/Controls/progressTracker.d.ts

@@ -0,0 +1,6 @@
+/** The data needed to represent an item in a ProgressTracker */
+export type ProgressTrackerItem = {
+    title: string;
+    subtitle: string;
+    key: string;
+};

package/types/Types/Controls/valueDetailListItem.d.ts

@@ -0,0 +1,32 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * A single item that will be displayed in the valueDetailList control. This
+ * contains the title of the field to display as well as either the text or
+ * HTML content that will be displayed.
+ */
+export type ValueDetailListItem = {
+    /** The title of the field to be displayed. */
+    title: string;
+
+    /** The text value to be displayed. Any HTML characters will be escaped. */
+    textValue?: string;
+
+    /** The HTML value to be displayed. No escaping is performed. */
+    htmlValue?: string;
+};

package/types/Types/Core/personPreferences.d.ts

@@ -0,0 +1,101 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * Provides access to person preferences from inside a block.
+ */
+export interface IBlockPersonPreferencesProvider {
+    /** The preference collection that is scoped to the current block. */
+    blockPreferences: IPersonPreferenceCollection;
+
+    /**
+     * Gets a promise that resolves to the preference collection that is
+     * not scoped. These are the global per-person preferences.
+     *
+     * @returns A promise that resolves to the {@link IPersonPreferenceCollection} that handles preference access.
+     */
+    getGlobalPreferences(): Promise<IPersonPreferenceCollection>;
+
+    /**
+     * Gets the preference collection that is scoped to the specified entity
+     * identified by its {@link entityTypeKey} and {@link entityKey}.
+     *
+     * @param entityTypeKey The entity type to use when scoping preference values.
+     * @param entityKey The entity to use when scoping preference values.
+     *
+     * @returns A promise that resolves to the {@link IPersonPreferenceCollection} that handles preference access.
+     */
+    getEntityPreferences(entityTypeKey: string, entityKey: string): Promise<IPersonPreferenceCollection>;
+}
+
+/**
+ * The interface that handles all the logic of accessing person preferences
+ * and keeping them in sync with the server.
+ */
+export interface IPersonPreferenceCollection {
+    /**
+     * Gets the preference value for the key.
+     *
+     * @param key The key whose value should be returned.
+     *
+     * @returns A string that represents the value. An empty string is
+     * returned if the key was not found.
+     */
+    getValue(key: string): string;
+
+    /**
+     * Sets the preference value for the key.
+     *
+     * @param key The key whose value should be set.
+     * @param value The new value. An empty string will delete the value.
+     */
+    setValue(key: string, value: string): void;
+
+    /**
+     * Gets all the keys currently in this collection.
+     *
+     * @returns An array of keys that exist in the collection.
+     */
+    getKeys(): string[];
+
+    /**
+     * Determines whether the specified key exists in the collection.
+     *
+     * @param key The key whose existence is to be checked.
+     *
+     * @returns True if the key exists and has a value, otherwise false.
+     */
+    containsKey(key: string): boolean;
+
+    /**
+     * Saves all the changes that have been made to the preference values.
+     *
+     * @returns A promise that indicates when the values have been saved.
+     */
+    save(): Promise<void>;
+
+    /**
+     * Gets a new {@link IPersonPreferenceCollection} with only the preferences
+     * that start with the given prefix. The new collection can then be accessed
+     * without including the prefix.
+     *
+     * @param prefix The prefix to filter preferences down by.
+     *
+     * @returns A new instance of {@link IPersonPreferenceCollection}.
+     */
+    withPrefix(prefix: string): IPersonPreferenceCollection;
+}

package/types/Types/Reporting/comparisonValue.d.ts

@@ -0,0 +1,28 @@
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ComparisonType } from "@Obsidian/Enums/Reporting/comparisonType";
+
+/**
+ * The comparison value for custom filtering.
+ */
+export type ComparisonValue = {
+    /** The type of comparison to be performed. */
+    comparisonType?: ComparisonType | null;
+
+    /** The right-hand value to be compared to. */
+    value: string;
+};

package/types/Types/Utility/block.d.ts

@@ -0,0 +1,42 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Ref } from "vue";
+import { Guid } from "..";
+import { HttpBodyData, HttpResult } from "./http";
+import { BlockActionContextBag } from "@Obsidian/ViewModels/Blocks/blockActionContextBag";
+
+/** A security grant generated by the server. */
+export type SecurityGrant = {
+    /** The token string that provides additional security access. */
+    token: Ref<string | null>;
+
+    /** Manually updates the token with a new one received from the server. */
+    updateToken: (newToken: string | null | undefined) => void;
+};
+
+/** The data contained in a block event. */
+export type BlockEvent<T = Record<string, unknown> | undefined> = {
+    /** The unique identifier of the block that dispatched the event. */
+    guid: Guid,
+
+    /** The custom data that was attached to the event. */
+    data: T
+};
+
+/** A function that will invoke a block action. */
+export type InvokeBlockActionFunc = <T>(actionName: string, data?: HttpBodyData, actionContext?: BlockActionContextBag) => Promise<HttpResult<T>>;

package/types/Types/Utility/component.d.ts

@@ -0,0 +1,29 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { Ref, UnwrapRef } from "vue";
+
+/** The data that can be made available to extended value references. */
+export type ExtendedRefContext = {
+    /** The name of the C# property this reference is associated with. */
+    propertyName?: string;
+};
+
+/** A standard Ref with extended data that provides additional context. */
+export type ExtendedRef<T> = Ref<UnwrapRef<T>> & {
+    context: ExtendedRefContext;
+};

package/types/Types/Utility/http.d.ts

@@ -0,0 +1,40 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+export type HttpUrlParams = Record<string, unknown> | undefined | null;
+export type HttpBodyData = Record<string, unknown> | undefined | null;
+
+export type HttpResult<T> = {
+    statusCode: number;
+    data: T | null;
+    isSuccess: boolean;
+    isError: boolean;
+    errorMessage: string | null;
+};
+
+export type HttpDoApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams , data?: HttpBodyData) => Promise<HttpResult<T>>;
+
+export type HttpGetFunc = <T>(url: string, params?: HttpUrlParams) => Promise<HttpResult<T>>;
+
+export type HttpPostFunc = <T>(url: string, params?: HttpUrlParams, data?: HttpBodyData) => Promise<HttpResult<T>>;
+
+export type HttpFunctions = {
+    doApiCall: HttpDoApiCallFunc;
+    get: HttpGetFunc;
+    post: HttpPostFunc;
+};

package/types/Types/Utility/support.d.ts

@@ -0,0 +1,26 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+/**
+ * This is a helper type that allows you to get intellisense on a value but
+ * still allow any other value to be supplied.
+ * 
+ * For example, doing LiteralUnion<"success", "fail"> would mean the editor
+ * will suggest the value "success" and "fail", but you can still put in any
+ * other string value you want.
+ */
+export type LiteralUnion<T extends U, U = string> = T | (U & Record<never, never>);

package/types/Types/fieldType.d.ts

@@ -0,0 +1,173 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ComparisonType } from "@Obsidian/Enums/Reporting/comparisonType";
+import { ComparisonValue } from "@Obsidian/Types/Reporting/comparisonValue";
+import { Component } from "vue";
+/**
+ * Handles the conversion of an attribute value into one that can be displayed
+ * in various ways.
+ *
+ * Note to plugins: Do not implement this interface directly or your implementation
+ * may break if we add new required methods.
+ */
+export interface IFieldType {
+    /**
+     * Attempts to convert the value into a text value that can be used to
+     * represent the attribute value. If no conversion is possible then the
+     * original value should be returned.
+     *
+     * @param value The raw value that needs to be formatted.
+     * @param configurationValues The configuration values that will provide the necessary information to format the value.
+     *
+     * @returns A string that contains a user-friendly text representation of the value.
+     */
+    getTextValue(value: string, configurationValues: Record<string, string>): string;
+
+    /**
+     * Get the HTML representation of the attribute value. This will be used
+     * as literal HTML so if you are returning plain text it must be encoded
+     * for HTML entities first.
+     *
+     * @param value The attribute value.
+     * @param configurationValues The configuration values that will provide the necessary information to format the value.
+     *
+     * @returns A string that contains a user-friendly HTML representation of the value.
+     */
+    getHtmlValue(value: string, configurationValues: Record<string, string>): string;
+
+    /**
+     * Get the condensed plain text representation of the attribute value.
+     * The text should probably be no more than 100 characters, though you
+     * can also alter the format entirely.
+     *
+     * @param value The attribute value.
+     * @param configurationValues The configuration values that will provide the necessary information to format the value.
+     *
+     * @returns A string that contains a condensed version of {@link FieldType.getTextValue getTextValue()}.
+     */
+    getCondensedTextValue(value: string, configurationValues: Record<string, string>): string;
+
+    /**
+     * Get the condensed HTML representation of the attribute value. This will
+     * be used as literal HTML so if you are returning plain text it must be
+     * encoded for HTML entities first. This should be a more concise
+     * representation of the {@link FieldType.getHtmlValue getHtmlValue()}.
+     *
+     * @param value The attribute value.
+     * @param configurationValues The configuration values that will provide the necessary information to format the value.
+     *
+     * @returns A string that contains a condensed version of {@link FieldType.getHtmlValue getHtmlValue()}.
+     */
+    getCondensedHtmlValue(value: string, configurationValues: Record<string, string>): string;
+
+    /**
+     * Get the component that will be used to display the formatted value.
+     *
+     * @returns A component that is already configured to show the value.
+     */
+    getFormattedComponent(): Component;
+
+    /**
+     * Get the component that will be used to display the condensed formatted value.
+     *
+     * @returns A component that is already configured to show the condensed value.
+     */
+    getCondensedFormattedComponent(): Component;
+
+    /**
+     * Get the component that will be used to edit the value. It will receive
+     * the modelValue property which contains the {@link PublicAttributeValueViewModel.value}.
+     *
+     * @returns A component that is already configured to edit the value.
+     */
+    getEditComponent(): Component;
+
+    /**
+     * Get the component that will be used to configure the field. It will receive
+     * the modelValue property which contains a Record<string, string> object
+     * with the configuration values. It will also receive a configurationProperties
+     * value of type Record<string, string>.
+     *
+     * @returns A component that is already configured to edit the value.
+     */
+    getConfigurationComponent(): Component;
+
+    /**
+     * Determines if this field type supports a default value component when
+     * editing the configuration. It is rare for a field type to not support
+     * this but there are some edge cases.
+     *
+     * @returns true if a default value component should be rendered when editing
+     * the field configuration; otherwise false.
+     */
+    hasDefaultComponent(): boolean;
+
+    /**
+     * Determines if this field type supports filtering. By returning true it is
+     * assumed that a filter component is available.
+     *
+     * @returns true if this field type supports filtering and has a filter
+     * component; otherwise false.
+     */
+    isFilterable(): boolean;
+
+    /**
+     * Get the component that will be used to configure a filter rule for the
+     * field.
+     *
+     * @returns A component that can be used to edit a filter value or null if not supported.
+     */
+    getFilterComponent(): Component | null;
+
+    /**
+     * Get the comparison types that are supported by this field type. All
+     * supported types should be OR'd together into a single value.
+     *
+     * @returns The bit flags that make up the supported comparison types.
+     */
+    getSupportedComparisonTypes(): ComparisonType;
+
+    /**
+     * Get a human friendly description of the configured filter value. Such as
+     * "equal to 3". It should not include the name of the attribute.
+     *
+     * @param value The comparison value to be formatted.
+     * @param configurationValues The configuration of the field type to use when formatting the value.
+     */
+    getFilterValueDescription(value: ComparisonValue, configurationValues: Record<string, string>): string;
+
+    /**
+     * Gets a human friendly string of text that represents the comparison
+     * value. This should not include the comparison type.
+     *
+     * @param value The comparison value to be formatted.
+     * @param configurationValues The configuration of the field type to use when formatting the value.
+     */
+    getFilterValueText(value: ComparisonValue, configurationValues: Record<string, string>): string;
+
+    /**
+     * Determines if the value matches the filter value for this field type.
+     *
+     * @param value The value to be compared with this filter value.
+     * @param filterValue The comparison value specified by the filter.
+     * @param configurationValues The configuration of the field type to use when formatting the value.
+     *
+     * @returns True if the value matches the comparison value; otherwise false.
+     */
+    doesValueMatchFilter(value: string, filterValue: ComparisonValue, configurationValues: Record<string, string>): boolean;
+}

package/types/Types/index.d.ts

@@ -0,0 +1,18 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+export type Guid = string;

package/types/Types/validationRules.d.ts

@@ -0,0 +1,44 @@
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import type { PropType } from "vue";
+
+/** The custom validation function signature. */
+export type ValidationRuleFunction = (value: unknown, params?: unknown[]) => ValidationResult;
+
+/** The return type allowed in a validation function. */
+export type ValidationResult = string | boolean;
+
+/**
+ * A reference to a defined validation rule with parameters. This is primarily
+ * an internal use type but is perfectly valid for public use as well.
+ */
+export type ValidationRuleReference = {
+    /** The name of the rule. */
+    name: string;
+
+    /** Any parameters that were found. */
+    params: unknown[];
+};
+
+/** The rule types that are valid to be processed during validation checks. */
+export type ValidationRule = string | ValidationRuleReference | ValidationRuleFunction;
+
+export type RulesPropType = {
+    type: PropType<ValidationRule | ValidationRule[]>,
+    default: ""
+};

package/types/Utility/address.d.ts

@@ -0,0 +1,6 @@
+import { HttpResult } from "@Obsidian/Types/Utility/http";
+import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
+import { AddressControlValidateAddressOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/AddressControlValidateAddressOptionsBag";
+import { AddressControlValidateAddressResultsBag } from "@Obsidian/ViewModels/Rest/Controls/AddressControlValidateAddressResultsBag";
+export declare function getDefaultAddressControlModel(): AddressControlBag;
+export declare function validateAddress(address: AddressControlValidateAddressOptionsBag): Promise<HttpResult<AddressControlValidateAddressResultsBag>>;

package/types/Utility/arrayUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Flatten a nested array down by the given number of levels.
+ * Meant to be a replacement for the official Array.prototype.flat, which isn't supported by all browsers we support.
+ * Adapted from Polyfill: https://github.com/behnammodi/polyfill/blob/master/array.polyfill.js#L591
+ *
+ * @param arr (potentially) nested array to be flattened
+ * @param depth The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ *
+ * @returns A new array with the sub-array elements concatenated into it.
+ */
+export declare const flatten: <T>(arr: T[][], depth?: number) => T[];