@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/ViewModels/Blocks/Workflow/FormBuilder/FormList/formListBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+import { FormListItemBag } from "@Obsidian/ViewModels/Blocks/WorkFlow/FormBuilder/FormList/formListItemBag";
+
+/** Represents the data for the Form List block. */
+export type FormListBag = {
+    /** Gets or sets a value indicating whether the current user can add a new category. */
+    canAddNewCategory: boolean;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the collection of forms grouped by their category Guid. */
+    forms?: Record<Guid, FormListItemBag[]> | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Workflow/FormBuilder/FormList/formListCategorySecurityBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Contains security information for a category in the form list. */
+export type FormListCategorySecurityBag = {
+    /** Gets or sets a value indicating whether the current user can delete the category. */
+    canDelete: boolean;
+
+    /** Gets or sets a value indicating whether the current user can edit the category. */
+    canEdit: boolean;
+};

package/types/ViewModels/Blocks/Workflow/FormBuilder/FormList/formListItemBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+
+export type FormListItemBag = {
+    /** Gets or sets a value indicating whether the current person can edit this form. */
+    canEdit: boolean;
+
+    /** Gets or sets the category Guid. */
+    categoryGuid?: Guid | null;
+
+    /** Gets or sets the name of who created the form. */
+    createdByPersonName?: string | null;
+
+    /** Gets or sets when the form (workflow type) was created. */
+    createdDateTime?: string | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the workflow type Guid. */
+    guid: Guid;
+
+    /** Gets or sets the workflow type identifier. */
+    id: number;
+
+    /** Gets or sets the form name. */
+    name?: string | null;
+
+    /** Gets or sets the slug of the workflow type (used for sharing routes). */
+    slug?: string | null;
+
+    /** Gets or sets the number of submissions (workflows) for this type. */
+    submissionCount: number;
+};

package/types/ViewModels/Blocks/Workflow/FormBuilder/FormList/formListLinkToFormBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents a page that can be linked to for a form. */
+export type FormListLinkToFormBag = {
+    /** Gets or sets the friendly route URL. */
+    friendlyRouteUrl?: string | null;
+
+    /** Gets or sets the page identifier. */
+    pageId: number;
+
+    /** Gets or sets the route URL with parameters. */
+    routeUrl?: string | null;
+
+    /** Gets or sets the site and page name. */
+    siteAndPage?: string | null;
+};

package/types/ViewModels/Blocks/Workflow/FormBuilder/FormList/updateFormCategoryBag.d.ts

@@ -0,0 +1,45 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+
+/** Represents the data needed to update a form category. */
+export type UpdateFormCategoryBag = {
+    /** Gets or sets the category GUID. */
+    categoryGuid?: Guid | null;
+
+    /** Gets or sets the category description. */
+    description?: string | null;
+
+    /** Gets or sets the highlight color. */
+    highlightColor?: string | null;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the category name. */
+    name?: string | null;
+
+    /** Gets or sets the parent category GUID. */
+    parentCategoryGuid?: Guid | null;
+};

package/types/ViewModels/Blocks/customBlockBox.d.ts

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 box that contains the required information to render a custom
+ * block component in the rare case that a block does not conform
+ * to an Entity.
+ */
+export type CustomBlockBox<TCustomBag, TOptions> = {
+    /** Gets or sets a custom bag of data required by the block. */
+    bag?: TCustomBag | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the block properties and common data options. */
+    options?: TOptions | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Cms/obsidianBlockConfigBag.d.ts

@@ -66,6 +66,13 @@ export type ObsidianBlockConfigBag = {
      */
     initialContent?: string | null;
 
+    /**
+     * The parent trace for this block load operation. This is used to
+     * link block actions back to the original trace. This must be in
+     * the W3C format '{version}-{trace_id}-{span_id}-{trace_flags}'.
+     */
+    parentTrace?: string | null;
+
     /** Gets or sets the person preferences associated with this block. */
     preferences?: ObsidianBlockPreferencesBag | null;
 

package/types/ViewModels/Controls/fieldTypeEditorUpdateAttributeConfigurationResultBag.d.ts

@@ -49,4 +49,10 @@ export type FieldTypeEditorUpdateAttributeConfigurationResultBag = {
      * when it is in edit mode (such as the default control).
      */
     editConfigurationValues?: Record<string, string> | null;
+
+    /**
+     * A string that describes the format of the raw value stored in the
+     * database.
+     */
+    valueFormat?: string | null;
 };

package/types/ViewModels/Core/Grid/groupingFieldBag.d.ts

@@ -0,0 +1,58 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/**
+ * Represents a grouping of data in a grid. This is used by a few special
+ * blocks that show grouped data in multiple grids.
+ */
+export type GroupingFieldBag = {
+    /** The icon that should be displayed for this data group. */
+    iconCssClass?: string | null;
+
+    /** The unique key that identifies this data group. */
+    key?: string | null;
+
+    /** The label that should be displayed for this data group. */
+    label?: string | null;
+
+    /**
+     * The order that this group should be displayed in, if no manual
+     * ordering has been applied.
+     */
+    order?: number | null;
+
+    /**
+     * A URL to display a small photo icon that represents the grouped
+     * data.
+     */
+    photoUrl?: string | null;
+
+    /** Additional CSS classes that will be applied to the text component. */
+    textColorCssClass?: string | null;
+
+    /**
+     * Identifies the type of grouping operation that was used to create
+     * this group.
+     */
+    type?: string | null;
+};

package/types/ViewModels/Rest/Controls/captchaConfigurationBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { CaptchaMode } from "@Obsidian/Enums/Cms/captchaMode";
+
+/** The options that can be passed to the CaptchaGetConfiguration API action of the Captcha control. */
+export type CaptchaConfigurationBag = {
+    /** Gets or sets the captcha mode. */
+    captchaMode: CaptchaMode;
+};

package/types/ViewModels/Rest/Controls/captchaInitializeProofOfWorkBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents a configuration bag for initializing proof-of-work challenges in a CAPTCHA system. */
+export type CaptchaInitializeProofOfWorkBag = {
+    /** Gets or sets the number of challenges to generate. */
+    challengeCount: number;
+
+    /** Gets or sets the difficulty level of the challenge. */
+    challengeDifficulty: number;
+
+    /** Gets or sets the size of each challenge in bytes. */
+    challengeSize: number;
+
+    /** Gets or sets the challenge token that should be redeemed, along with the challenge solution, for a verified token. */
+    challengeToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/captchaInitializeResultBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { CaptchaInitializeProofOfWorkBag } from "@Obsidian/ViewModels/Rest/Controls/captchaInitializeProofOfWorkBag";
+
+/** The results of the CaptchaInitialize API action of the Captcha control. */
+export type CaptchaInitializeResultBag = {
+    /** Gets or sets the bag containing proof-of-work CAPTCHA initialization information. */
+    pow?: CaptchaInitializeProofOfWorkBag | null;
+};

package/types/ViewModels/Rest/Controls/captchaProofOfWorkChallengeBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents a collection of parameters for generating proof-of-work challenges used in CAPTCHA verification. */
+export type CaptchaProofOfWorkChallengeBag = {
+    /** Gets or sets the number of challenges to generate. */
+    challengeCount: number;
+
+    /** Gets or sets the difficulty level of the challenge. */
+    challengeDifficulty: number;
+
+    /** Gets or sets the size of each challenge in bytes. */
+    challengeSize: number;
+
+    /** Gets or sets the challenge token that should be redeemed, along with the challenge solution, for a verified token. */
+    challengeToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/captchaProofOfWorkVerifyOptionsBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents the options used to verify a proof-of-work CAPTCHA challenge. */
+export type CaptchaProofOfWorkVerifyOptionsBag = {
+    /** Gets or sets the collection of client-calculated challenge solutions. */
+    challengeSolutions?: number[] | null;
+
+    /** Gets or sets the challenge token provided by the client. */
+    challengeToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/captchaTokenBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { Guid } from "@Obsidian/Types";
+
+/** Represents a captcha token. */
+export type CaptchaTokenBag = {
+    /** Gets or sets the unix timestamp when the captcha token expires. */
+    expires: number;
+
+    /** Gets or sets the unique identifier for the captcha token. */
+    guid: Guid;
+};

package/types/ViewModels/Rest/Controls/{captchaControlValidateTokenOptionsBag.d.ts → captchaValidateTokenOptionsBag.d.ts}

@@ -21,7 +21,8 @@
 // </copyright>
 //
 
-export type CaptchaControlValidateTokenOptionsBag = {
+/** Represents the options for validating a captcha token. */
+export type CaptchaValidateTokenOptionsBag = {
     /** Gets or sets the solved captcha token. */
     token?: string | null;
 };

package/types/ViewModels/Rest/Controls/{captchaControlTokenValidateTokenResultBag.d.ts → captchaValidateTokenResultBag.d.ts}

@@ -22,7 +22,7 @@
 //
 
 /** The results from the Validate Token API action of the Captcha control. */
-export type CaptchaControlTokenValidateTokenResultBag = {
+export type CaptchaValidateTokenResultBag = {
     /** Gets or sets a value indicating whether the solved token is valid. */
     isTokenValid: boolean;
 };

package/types/ViewModels/Rest/Controls/captchaVerifyOptionsBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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 { CaptchaVerifyProofOfWorkOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/captchaVerifyProofOfWorkOptionsBag";
+
+/**
+ * The options that can be passed to the CaptchaRedeemChallenge API action of
+ * the Captcha control.
+ */
+export type CaptchaVerifyOptionsBag = {
+    /** Gets or sets the proof-of-work CAPTCHA verification options. */
+    powOptions?: CaptchaVerifyProofOfWorkOptionsBag | null;
+};

package/types/ViewModels/Rest/Controls/captchaVerifyProofOfWorkOptionsBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents the options used to verify a proof-of-work CAPTCHA challenge. */
+export type CaptchaVerifyProofOfWorkOptionsBag = {
+    /** Gets or sets the collection of client-calculated challenge solutions. */
+    challengeSolutions?: number[] | null;
+
+    /** Gets or sets the challenge token provided by the client. */
+    challengeToken?: string | null;
+};