@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/ViewModels/Blocks/Security/ChangePassword/changePasswordBag.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>
+//
+
+/** A box containing the required information to render the Change Password block. */
+export type ChangePasswordBag = {
+    /** The optional message to display on first render. */
+    alertMessage?: string | null;
+
+    /** The alert type for Rock.ViewModels.Blocks.Security.ChangePassword.ChangePasswordBag.AlertMessage. */
+    alertType?: string | null;
+
+    /** Gets or sets a value indicating whether captcha verification should be disabled. */
+    disableCaptchaSupport: boolean;
+
+    /** Gets or sets a value indicating whether the change password form should be shown. */
+    isChangePasswordVisible: boolean;
+};

package/types/ViewModels/Blocks/Security/ChangePassword/changePasswordRequestBag.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>
+//
+
+/** A bag containing the required request values to change the current user's password. */
+export type ChangePasswordRequestBag = {
+    /** The new password. */
+    newPassword?: string | null;
+
+    /** The existing password. */
+    oldPassword?: string | null;
+};

package/types/ViewModels/Blocks/Security/ChangePassword/changePasswordResponseBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 bag containing the result of a change password request. */
+export type ChangePasswordResponseBag = {
+    /** Gets or sets the optional alert message. */
+    alertMessage?: string | null;
+
+    /** Gets or sets the alert type for Rock.ViewModels.Blocks.Security.ChangePassword.ChangePasswordResponseBag.AlertMessage (success/info/warning/danger). */
+    alertType?: string | null;
+
+    /** Gets or sets the optional redirect URL to navigate to after success. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/Logout/logoutBag.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>
+//
+
+/** A box containing the required information to render the Logout block. */
+export type LogoutBag = {
+    /** Gets or sets the rendered HTML message to display after logging out. */
+    message?: string | null;
+
+    /** Gets or sets the URL to redirect to after logging out. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/Logout/logoutOptionsBag.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>
+//
+
+/** Additional configuration options for the Logout block. */
+export type LogoutOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether the current user is an admin
+     * with edit access who should be prompted before logging out.
+     */
+    isAdminUser: boolean;
+};

package/types/ViewModels/Blocks/Security/PersonViewedDetail/personViewedDetailOptionsBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** The additional configuration options for the Person Viewed Detail block. */
+export type PersonViewedDetailOptionsBag = {
+    /** The title of the block based on target person viewed or target person viewing. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Security/PersonViewedSummary/personViewedSummaryOptionsBag.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>
+//
+
+/** The additional configuration options for the Person Viewed List block. */
+export type PersonViewedSummaryOptionsBag = {
+    /**
+     * Determines if profiles that have been viewed by the person
+     * should be displayed.
+     */
+    seeProfilesViewed: boolean;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/installedPackageBag.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 an installed package instance. */
+export type InstalledPackageBag = {
+    /** The ID of the installed package version. */
+    versionId: number;
+
+    /** The display label of the installed version. */
+    versionLabel?: string | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/latestVersionDisplayBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <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 { ScreenshotBag } from "@Obsidian/ViewModels/Blocks/Store/PackageDetail/screenshotBag";
+
+/** Aggregated display data for the latest compatible package version. */
+export type LatestVersionDisplayBag = {
+    /** Pre-formatted added date string (e.g., "March 4, 2025"). */
+    addedDateDisplay?: string | null;
+
+    /** Description of the version. */
+    description?: string | null;
+
+    /** Documentation link for this version. */
+    documentationUrl?: string | null;
+
+    /** Version identifier. */
+    id: number;
+
+    /** Pre-formatted Rock version requirement string. */
+    requiredRockVersionDisplay?: string | null;
+
+    /** Screenshots associated with this version. */
+    screenshots?: ScreenshotBag[] | null;
+
+    /** Display label for the version. */
+    versionLabel?: string | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/packageBag.d.ts

@@ -0,0 +1,128 @@
+//------------------------------------------------------------------------------
+// <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 { PackageVersionBag } from "@Obsidian/ViewModels/Blocks/Store/PackageDetail/packageVersionBag";
+import { PackageVersionRatingBag } from "@Obsidian/ViewModels/Blocks/Store/PackageDetail/packageVersionRatingBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Package Detail block. */
+export type PackageBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * The current Rock semantic version running on the system.
+     * Used to determine compatibility.
+     */
+    currentRockSemanticVersion?: string | null;
+
+    /** Long-form description shown on the package detail page. */
+    description?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** status of package installation, such as "Installed", "Update", or "Not Installed". */
+    installedStatusMessage?: string | null;
+
+    /** alled version identifier, if the package is currently installed. */
+    installedVersionId?: number | null;
+
+    /** installed version label, if the package is currently installed. */
+    installedVersionLabel?: string | null;
+
+    /**
+     * Indicates whether the package is free.
+     * Determines pricing label and install/buy behavior.
+     */
+    isFree: boolean;
+
+    /** Indicates whether the current organization has purchased the package. */
+    isPurchased: boolean;
+
+    /**
+     * Pre-selected and formatted information about the
+     * latest compatible version of the package.
+     */
+    latestVersion?: PackageVersionBag | null;
+
+    /** Ratings and reviews for the latest compatible version. */
+    latestVersionRatings?: PackageVersionRatingBag[] | null;
+
+    /** The display name of the package. */
+    name?: string | null;
+
+    /** Image URL for the package icon. */
+    packageIconImageUrl?: string | null;
+
+    /**
+     * Price of the package, if not free.
+     * Null means price is unknown or unavailable.
+     */
+    price?: number | null;
+
+    /**
+     * Date the package was purchased, if applicable.
+     * Used for "Purchased on" messaging.
+     */
+    purchasedDate?: string | null;
+
+    /** Rock-generated postback URL used for rating submissions. */
+    ratePostBackUrl?: string | null;
+
+    /**
+     * rating for the package (0–5).
+     * Used to render star icons.
+     */
+    rating?: number | null;
+
+    /** Indicates whether the package requires a Rock update to install or use. */
+    requiresRockUpdate: boolean;
+
+    /** Will store the value of the rock version requirement if RequiresRockUpdate is true. */
+    rockUpdateRequirement?: string | null;
+
+    /**
+     * Organization store key used when generating Rock postback URLs
+     * (e.g., rating links).
+     */
+    storeKey?: string | null;
+
+    /**
+     * URL to the vendor's support page for this package.
+     * Used for both the main package link and support link.
+     */
+    supportUrl?: string | null;
+
+    /** Vendor display name. */
+    vendorName?: string | null;
+
+    /** Vendor website or profile URL. */
+    vendorUrl?: string | null;
+
+    /** All versions of the package, ordered or filtered as needed. */
+    versions?: PackageVersionBag[] | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/packageDetailOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** The additional configuration options for the Package Detail block. */
+export type PackageDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Store/PackageDetail/packageVersionBag.d.ts

@@ -0,0 +1,52 @@
+//------------------------------------------------------------------------------
+// <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 single package version. */
+export type PackageVersionBag = {
+    /** Date the version was added to the store. */
+    date?: string | null;
+
+    /** Release notes or description for the version. */
+    description?: string | null;
+
+    /** Display version of the date */
+    displayDate?: string | null;
+
+    /** URL to documentation specific to this version. */
+    documentationUrl?: string | null;
+
+    /** Unique identifier for the version. */
+    id: number;
+
+    /** Rating of the specific version */
+    rating?: number | null;
+
+    /** Pre-formatted Rock version requirement string. */
+    requiredRockVersionDisplay?: string | null;
+
+    /** Screenshots associated with this version. */
+    screenshotURLs?: string[] | null;
+
+    /** Human-readable version label (e.g., "1.2.0"). */
+    versionLabel?: string | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/packageVersionRatingBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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 user-submitted rating for a package version. */
+export type PackageVersionRatingBag = {
+    /** Review text. */
+    comment?: string | null;
+
+    /** Date the rating was created. */
+    createdDate?: string | null;
+
+    /** Rating identifier. */
+    id: number;
+
+    /** Star rating value. */
+    rating?: number | null;
+
+    /** Name of the reviewer. */
+    reviewerName?: string | null;
+
+    /** Photo of the reviewer */
+    reviewerPhoto?: string | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/rockSemanticVersionBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Simplified semantic version representation for Rock. */
+export type RockSemanticVersionBag = {
+    /** Major version number. */
+    major: number;
+
+    /** Minor version number. */
+    minor: number;
+
+    /** Patch version number. */
+    patch: number;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/screenshotBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <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 screenshot image for a package version. */
+export type ScreenshotBag = {
+    /** URL to the screenshot image. */
+    imageUrl?: string | null;
+};

package/types/ViewModels/Blocks/Store/PackageDetail/vendorBag.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 package vendor or author. */
+export type VendorBag = {
+    /** Vendor display name. */
+    name?: string | null;
+
+    /** Vendor website or profile URL. */
+    url?: string | null;
+};