@umbraco-forms/backoffice 16.3.1 → 16.4.0-rc2

package/package.json

@@ -9,7 +9,7 @@
     "url": "https://umbraco.com"
   },
   "type": "module",
-  "version": "16.3.1",
+  "version": "16.4.0-rc2",
   "types": "./types/umbraco-forms-public.d.ts",
   "exports": {
     ".": {
@@ -25,7 +25,7 @@
     "npm": ">=10.9"
   },
   "peerDependencies": {
-    "@umbraco-cms/backoffice": ">= 16.3.0 < 17",
+    "@umbraco-cms/backoffice": ">= 16.4.0 < 17",
     "aspnet-client-validation": "^0.11.1",
     "json-logic-js": "^2.0.5",
     "moment": "^2.30.1"

package/types/umbraco-forms-public.d.ts

@@ -11,15 +11,15 @@ import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
 import type { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
 import { UmbDataSourceResponse } from '@umbraco-cms/backoffice/repository';
 import { UmbDetailRepositoryBase } from '@umbraco-cms/backoffice/repository';
-import { UmbError } from '@umbraco-cms/backoffice/resources';
+import { UmbEntityDetailWorkspaceContextCreateArgs } from '@umbraco-cms/backoffice/workspace';
+import { UmbEntityNamedDetailWorkspaceContextBase } from '@umbraco-cms/backoffice/workspace';
 import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
 import { UmbPagedModel } from '@umbraco-cms/backoffice/repository';
 import type { UmbPropertyEditorConfig } from '@umbraco-cms/backoffice/property-editor';
 import { UmbPropertyEditorConfigCollection } from '@umbraco-cms/backoffice/property-editor';
 import type { UmbPropertyValueData } from '@umbraco-cms/backoffice/property';
-import type { UmbRoutableWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
-import type { UmbSaveableWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
-import { UmbSubmittableWorkspaceContextBase } from '@umbraco-cms/backoffice/workspace';
+import { UmbRoutableWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
+import { UmbSaveableWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
 import type { UmbWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
 
 export declare interface ActionType {
@@ -96,15 +96,19 @@ export declare type FieldCondition = {
     rules: Array<FieldConditionRule>;
 };
 
-export declare enum FieldConditionActionType {
-    SHOW = "Show",
-    HIDE = "Hide"
-}
+export declare const FieldConditionActionType: {
+    readonly SHOW: "Show";
+    readonly HIDE: "Hide";
+};
 
-export declare enum FieldConditionLogicType {
-    ALL = "All",
-    ANY = "Any"
-}
+export declare type FieldConditionActionType = (typeof FieldConditionActionType)[keyof typeof FieldConditionActionType];
+
+export declare const FieldConditionLogicType: {
+    readonly ALL: "All";
+    readonly ANY: "Any";
+};
+
+export declare type FieldConditionLogicType = (typeof FieldConditionLogicType)[keyof typeof FieldConditionLogicType];
 
 export declare type FieldConditionRule = {
     id: string;
@@ -113,32 +117,36 @@ export declare type FieldConditionRule = {
     value: string;
 };
 
-export declare enum FieldConditionRuleOperator {
-    IS = "Is",
-    IS_NOT = "IsNot",
-    GREATER_THEN = "GreaterThen",
-    LESS_THEN = "LessThen",
-    CONTAINS = "Contains",
-    CONTAINS_IGNORE_CASE = "ContainsIgnoreCase",
-    STARTS_WITH = "StartsWith",
-    STARTS_WITH_IGNORE_CASE = "StartsWithIgnoreCase",
-    ENDS_WITH = "EndsWith",
-    ENDS_WITH_IGNORE_CASE = "EndsWithIgnoreCase",
-    NOT_CONTAINS = "NotContains",
-    NOT_CONTAINS_IGNORE_CASE = "NotContainsIgnoreCase",
-    NOT_STARTS_WITH = "NotStartsWith",
-    NOT_STARTS_WITH_IGNORE_CASE = "NotStartsWithIgnoreCase",
-    NOT_ENDS_WITH = "NotEndsWith",
-    NOT_ENDS_WITH_IGNORE_CASE = "NotEndsWithIgnoreCase"
-}
+export declare const FieldConditionRuleOperator: {
+    readonly IS: "Is";
+    readonly IS_NOT: "IsNot";
+    readonly GREATER_THEN: "GreaterThen";
+    readonly LESS_THEN: "LessThen";
+    readonly CONTAINS: "Contains";
+    readonly CONTAINS_IGNORE_CASE: "ContainsIgnoreCase";
+    readonly STARTS_WITH: "StartsWith";
+    readonly STARTS_WITH_IGNORE_CASE: "StartsWithIgnoreCase";
+    readonly ENDS_WITH: "EndsWith";
+    readonly ENDS_WITH_IGNORE_CASE: "EndsWithIgnoreCase";
+    readonly NOT_CONTAINS: "NotContains";
+    readonly NOT_CONTAINS_IGNORE_CASE: "NotContainsIgnoreCase";
+    readonly NOT_STARTS_WITH: "NotStartsWith";
+    readonly NOT_STARTS_WITH_IGNORE_CASE: "NotStartsWithIgnoreCase";
+    readonly NOT_ENDS_WITH: "NotEndsWith";
+    readonly NOT_ENDS_WITH_IGNORE_CASE: "NotEndsWithIgnoreCase";
+};
 
-export declare enum FieldDataType {
-    STRING = "String",
-    LONG_STRING = "LongString",
-    INTEGER = "Integer",
-    DATE_TIME = "DateTime",
-    BIT = "Bit"
-}
+export declare type FieldConditionRuleOperator = (typeof FieldConditionRuleOperator)[keyof typeof FieldConditionRuleOperator];
+
+export declare const FieldDataType: {
+    readonly STRING: "String";
+    readonly LONG_STRING: "LongString";
+    readonly INTEGER: "Integer";
+    readonly DATE_TIME: "DateTime";
+    readonly BIT: "Bit";
+};
+
+export declare type FieldDataType = (typeof FieldDataType)[keyof typeof FieldDataType];
 
 export declare type FieldPrevalue = {
     value: string;
@@ -282,11 +290,13 @@ export declare type FormEntityType = typeof FORMS_FORM_ENTITY_TYPE;
 
 export declare type FormEntryEntityType = typeof FORMS_FORM_ENTRY_ENTITY_TYPE;
 
-export declare enum FormFieldIndication {
-    NO_INDICATOR = "NoIndicator",
-    MARK_MANDATORY_FIELDS = "MarkMandatoryFields",
-    MARK_OPTIONAL_FIELDS = "MarkOptionalFields"
-}
+export declare const FormFieldIndication: {
+    readonly NO_INDICATOR: "NoIndicator";
+    readonly MARK_MANDATORY_FIELDS: "MarkMandatoryFields";
+    readonly MARK_OPTIONAL_FIELDS: "MarkOptionalFields";
+};
+
+export declare type FormFieldIndication = (typeof FormFieldIndication)[keyof typeof FormFieldIndication];
 
 export declare type FormFolderEntityType = typeof FORMS_FORM_FOLDER_ENTITY_TYPE;
 
@@ -323,11 +333,13 @@ export declare type FormSecurityForUser = {
     formsSecurity: Array<UserFormSecurity>;
 };
 
-export declare enum FormSecurityType {
-    FULL = "Full",
-    READ_ONLY_VIEW_AND_EXPORT_ENTRIES = "ReadOnlyViewAndExportEntries",
-    READ_ONLY_VIEW_ENTRIES = "ReadOnlyViewEntries"
-}
+export declare const FormSecurityType: {
+    readonly FULL: "Full";
+    readonly READ_ONLY_VIEW_AND_EXPORT_ENTRIES: "ReadOnlyViewAndExportEntries";
+    readonly READ_ONLY_VIEW_ENTRIES: "ReadOnlyViewEntries";
+};
+
+export declare type FormSecurityType = (typeof FormSecurityType)[keyof typeof FormSecurityType];
 
 export declare interface FormsFieldPreviewApi extends UmbApi {
     getSettingValue(alias: string): string;
@@ -344,7 +356,7 @@ export declare class FormsFieldPreviewBaseElement extends UmbLitElement {
 export declare class FormsFieldTypeDetailRepository extends UmbDetailRepositoryBase<FieldTypeWithSettings> {
     constructor(host: UmbControllerHost);
     requestValidationPatterns(): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: ValidationPattern[];
@@ -355,49 +367,49 @@ export declare class FormsFieldTypeDetailRepository extends UmbDetailRepositoryB
 export declare class FormsFormDetailRepository extends UmbDetailRepositoryBase<FormDesign> {
     constructor(host: UmbControllerHost);
     requestRecordsMetaData(unique: string): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: EntrySearchResultMetadata;
         error?: undefined;
     }>;
     requestHasRelations(unique: string): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: boolean;
         error?: undefined;
     }>;
     requestTemplates(): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: FormTemplateBase[];
         error?: undefined;
     }>;
     requestFormScaffold(template: string): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: FormDesign;
         error?: undefined;
     }>;
     copyForm(unique: string, copyWorkflows: boolean, newName?: string, copyToFolderId?: string): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: unknown;
         error?: undefined;
     }>;
     copyFormWorkflows(sourceId: string, destinationId: string, workflowIds: Array<string>): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: unknown;
         error?: undefined;
     }>;
     moveForm(unique: string, newParentId: string): Promise<{
-        error: UmbError | UmbApiError | UmbCancelError | Error;
+        error: UmbApiError | UmbCancelError;
         data?: undefined;
     } | {
         data: unknown;
@@ -405,35 +417,22 @@ export declare class FormsFormDetailRepository extends UmbDetailRepositoryBase<F
     }>;
 }
 
-export declare class FormsFormWorkspaceContext extends UmbSubmittableWorkspaceContextBase<FormDesign> implements UmbSaveableWorkspaceContext, UmbRoutableWorkspaceContext {
+export declare class FormsFormWorkspaceContext extends UmbEntityNamedDetailWorkspaceContextBase<FormDesign, FormsFormDetailRepository, FormsFormWorkspaceCreateArgs> implements UmbSaveableWorkspaceContext, UmbRoutableWorkspaceContext {
     #private;
-    readonly formRepository: FormsFormDetailRepository;
     readonly fieldTypeRepository: FormsFieldTypeDetailRepository;
     readonly workflowTypeRepository: FormsWorkflowTypeDetailRepository;
     readonly prevalueSourceCollectionRepository: FormsPrevalueSourceCollectionRepository;
-    readonly data: Observable<FormDesign | undefined>;
-    readonly unique: Observable<string | undefined>;
-    readonly name: Observable<string | undefined>;
+    get formRepository(): FormsFormDetailRepository;
     readonly id: Observable<string | undefined>;
+    getUnique(): string;
     constructor(host: UmbControllerHostElement);
-    load(id: string): Promise<void>;
-    create(parent: {
-        entityType: string;
-        unique: string | null;
-    }, template: string | null): Promise<{
-        data: FormDesign;
-    }>;
+    createScaffold(args: FormsFormWorkspaceCreateArgs): Promise<FormDesign | undefined>;
     requestSave(): Promise<void>;
     submit(): Promise<void>;
     loadFieldType(id: string): Promise<FieldTypeWithSettings | undefined>;
     loadWorkflowType(id: string): Promise<WorkflowTypeWithSettings | undefined>;
     loadValidationPatterns(): Promise<ValidationPattern[] | undefined>;
     loadPrevalueSources(): Promise<FieldPreValueSource[] | undefined>;
-    getData(): FormDesign | undefined;
-    getUnique(): string;
-    getEntityType(): string;
-    getName(): string | undefined;
-    setName(name: string): void;
     setFormProperty(alias: string, value: unknown): void;
     getFormProperty(alias: string): any;
     setPageProperty(pageIndex: number, alias: string, value: unknown): void;
@@ -454,7 +453,10 @@ export declare class FormsFormWorkspaceContext extends UmbSubmittableWorkspaceCo
     getConditionLogicTypes: Array<LogicType>;
     getConditionOperators: Array<OperatorType>;
     getRichTextConfiguration(): Promise<UmbPropertyEditorConfigCollection>;
-    destroy(): void;
+}
+
+export declare interface FormsFormWorkspaceCreateArgs extends UmbEntityDetailWorkspaceContextCreateArgs<FormDesign> {
+    template?: string;
 }
 
 export declare interface FormsPrevalueSourceCollectionFilterModel {
@@ -533,11 +535,13 @@ export declare type GetFormTemplateResponses = {
 
 export declare const GUID_EMPTY: string;
 
-export declare enum IncludeSensitiveData {
-    FALSE = "False",
-    TRUE = "True",
-    UNDEFINED = "Undefined"
-}
+export declare const IncludeSensitiveData: {
+    readonly FALSE: "False";
+    readonly TRUE: "True";
+    readonly UNDEFINED: "Undefined";
+};
+
+export declare type IncludeSensitiveData = (typeof IncludeSensitiveData)[keyof typeof IncludeSensitiveData];
 
 export declare interface LogicType {
     name: string;
@@ -555,11 +559,13 @@ export declare interface ManifestFormsSettingValueConverterPreview extends Manif
     api: ApiLoaderProperty<FormsSettingValueConverterApi>;
 }
 
-export declare enum MultiPageNavigationOption {
-    NONE = "None",
-    SHOW_AT_TOP = "ShowAtTop",
-    SHOW_AT_BOTTOM = "ShowAtBottom"
-}
+export declare const MultiPageNavigationOption: {
+    readonly NONE: "None";
+    readonly SHOW_AT_TOP: "ShowAtTop";
+    readonly SHOW_AT_BOTTOM: "ShowAtBottom";
+};
+
+export declare type MultiPageNavigationOption = (typeof MultiPageNavigationOption)[keyof typeof MultiPageNavigationOption];
 
 export declare interface OperatorType {
     name: string;
@@ -581,11 +587,13 @@ export declare type RecordFieldDisplay = {
     isSystem: boolean;
 };
 
-export declare enum RenderInputType {
-    SINGLE = "Single",
-    MULTIPLE = "Multiple",
-    CUSTOM = "Custom"
-}
+export declare const RenderInputType: {
+    readonly SINGLE: "Single";
+    readonly MULTIPLE: "Multiple";
+    readonly CUSTOM: "Custom";
+};
+
+export declare type RenderInputType = (typeof RenderInputType)[keyof typeof RenderInputType];
 
 export declare type Setting = {
     name: string;