@umbraco-forms/backoffice 16.2.0

package/README.md

@@ -0,0 +1,7 @@
+# @umbraco-forms/backoffice
+This package contains the TypeScript type definitions for the Umbraco Forms Backoffice.
+
+## Installation
+```bash
+npm install -D @umbraco-forms/backoffice
+```

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@umbraco-forms/backoffice",
+  "bugs": {
+    "url": "https://github.com/umbraco/Umbraco.Forms.Issues/issues"
+  },
+  "author": {
+    "name": "Umbraco A/S",
+    "email": "dxp@umbraco.com",
+    "url": "https://umbraco.com"
+  },
+  "type": "module",
+  "version": "16.2.0",
+  "types": "./types/umbraco-forms-public.d.ts",
+  "files": [
+    "README.md",
+    "types/umbraco-forms-public.d.ts"
+  ],
+  "engines": {
+    "node": ">=22",
+    "npm": ">=10.9"
+  },
+  "peerDependencies": {
+    "@umbraco-cms/backoffice": ">= 16.0.0 < 17",
+    "aspnet-client-validation": "^0.11.1",
+    "json-logic-js": "^2.0.5",
+    "moment": "^2.30.1"
+  },
+  "overrides": {
+    "@umbraco-cms/backoffice": {
+      "@hey-api/client-fetch": "^0.13.1"
+    }
+  }
+}

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

@@ -0,0 +1,630 @@
+import { Observable } from 'rxjs';
+import type { UmbApi } from '@umbraco-cms/backoffice/extension-api';
+import { UmbApiError } from '@umbraco-cms/backoffice/resources';
+import { UmbCancelError } from '@umbraco-cms/backoffice/resources';
+import type { UmbCollectionRepository } from '@umbraco-cms/backoffice/collection';
+import { UmbContextBase } from '@umbraco-cms/backoffice/class-api';
+import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
+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 { 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 type { UmbWorkspaceContext } from '@umbraco-cms/backoffice/workspace';
+
+export declare interface ActionType {
+    name: string;
+    value: string;
+}
+
+export declare type AllowedUploadType = {
+    type: string;
+    name: string;
+    checked: string;
+};
+
+export declare type BackOfficeConfig = {
+    maxNumberOfColumnsInFormGroup: number;
+    manageSecurityWithUserGroups: boolean;
+    scheduledRecordDeletionEnabled: boolean;
+    mandatoryFieldsetLegends: boolean;
+    disallowedFileUploadExtensions: string;
+    allowedFileUploadExtensions: string;
+    enableMultiPageFormSettings: boolean;
+    enableAdvancedValidationRules: boolean;
+};
+
+export declare type BasicForm = {
+    id: string;
+    name: string;
+    fields: string;
+    summary: string;
+};
+
+export declare type BasicFormExtended = BasicForm & {
+    gotEntries: boolean;
+    count: number;
+};
+
+export declare const DateOptions: Intl.DateTimeFormatOptions;
+
+export declare const DateTimeOptions: Intl.DateTimeFormatOptions;
+
+export declare type EntrySearchResultMetadata = {
+    count: number;
+    lastSubmittedDate: string;
+};
+
+export declare type Field = {
+    caption: string;
+    tooltip?: string | null;
+    cssClass?: string | null;
+    alias: string;
+    id: string;
+    fieldTypeId: string;
+    prevalueSourceId: string;
+    dataSourceFieldKey?: string | null;
+    containsSensitiveData: boolean;
+    mandatory: boolean;
+    regex?: string | null;
+    requiredErrorMessage?: string | null;
+    invalidErrorMessage?: string | null;
+    condition?: FieldCondition | null;
+    settings: {
+        [key: string]: string;
+    };
+    preValues: Array<FieldPrevalue>;
+    allowedUploadTypes?: Array<AllowedUploadType> | null;
+    allowMultipleFileUploads: boolean;
+};
+
+export declare type FieldCondition = {
+    id: string;
+    enabled: boolean;
+    actionType: FieldConditionActionType;
+    logicType: FieldConditionLogicType;
+    rules: Array<FieldConditionRule>;
+};
+
+export declare enum FieldConditionActionType {
+    SHOW = "Show",
+    HIDE = "Hide"
+}
+
+export declare enum FieldConditionLogicType {
+    ALL = "All",
+    ANY = "Any"
+}
+
+export declare type FieldConditionRule = {
+    id: string;
+    field: string;
+    operator: FieldConditionRuleOperator;
+    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 enum FieldDataType {
+    STRING = "String",
+    LONG_STRING = "LongString",
+    INTEGER = "Integer",
+    DATE_TIME = "DateTime",
+    BIT = "Bit"
+}
+
+export declare type FieldPrevalue = {
+    value: string;
+    caption?: string | null;
+};
+
+export declare interface FieldPrevalueDetail {
+    id: string;
+    prevalues: Array<FieldPrevalue>;
+    prevalueSourceId: string;
+}
+
+export declare type FieldPreValueSource = {
+    id: string;
+    readonly unique: string;
+    readonly entityType: string;
+    name: string;
+    created: string;
+    createdBy?: number | null;
+    createdByName?: string | null;
+    updated: string;
+    updatedBy?: number | null;
+    updatedByName?: string | null;
+    settings: {
+        [key: string]: string;
+    };
+    fieldPreValueSourceTypeId: string;
+    cachePrevaluesFor: string;
+};
+
+export declare type FieldSet = {
+    caption?: string | null;
+    sortOrder: number;
+    id: string;
+    page: string;
+    containers: Array<FieldsetContainer>;
+    condition?: FieldCondition | null;
+};
+
+export declare type FieldsetContainer = {
+    id: string;
+    caption?: string | null;
+    width: number;
+    fields: Array<Field>;
+};
+
+export declare type FieldTypeWithSettings = {
+    id: string;
+    readonly unique: string;
+    readonly entityType: string;
+    alias: string;
+    name: string;
+    icon: string;
+    group: string;
+    sortOrder: number;
+    description: string;
+    supportsPrevalues: boolean;
+    supportsUploadTypes: boolean;
+    supportsMandatory: boolean;
+    supportsRegex: boolean;
+    hideLabel: boolean;
+    renderInputType: RenderInputType;
+    settings: Array<Setting>;
+    view: string;
+    previewView: string;
+    mandatoryByDefault: boolean;
+};
+
+export declare type FormDataSourceDefinition = {
+    id: string;
+    mappings: Array<FormDataSourceMapping>;
+};
+
+export declare type FormDataSourceMapping = {
+    formId: string;
+    dataFieldKey: string;
+    prevalueKeyfield: string;
+    prevalueValueField: string;
+    prevalueTable: string;
+    dataType: FieldDataType;
+    defaultValue: string;
+};
+
+export declare type FormDesign = {
+    name: string;
+    created: string;
+    createdBy?: number | null;
+    createdByName?: string | null;
+    updated: string;
+    updatedBy?: number | null;
+    updatedByName?: string | null;
+    pages: Array<Page>;
+    validationRules: Array<ValidationRule>;
+    id: string;
+    readonly unique: string;
+    readonly parentUnique?: string | null;
+    readonly entityType: string;
+    fieldIndicationType: FormFieldIndication;
+    indicator: string;
+    showValidationSummary: boolean;
+    hideFieldValidation: boolean;
+    requiredErrorMessage: string;
+    invalidErrorMessage: string;
+    messageOnSubmit?: string | null;
+    messageOnSubmitIsHtml: boolean;
+    goToPageOnSubmit?: string | null;
+    xPathOnSubmit?: string | null;
+    manualApproval: boolean;
+    storeRecordsLocally: boolean;
+    autocompleteAttribute?: string | null;
+    displayDefaultFields: boolean;
+    selectedDisplayFields: Array<RecordFieldDisplay>;
+    daysToRetainSubmittedRecordsFor: number;
+    daysToRetainApprovedRecordsFor: number;
+    daysToRetainRejectedRecordsFor: number;
+    cssClass?: string | null;
+    disableDefaultStylesheet: boolean;
+    datasource?: FormDataSourceDefinition | null;
+    submitLabel?: string | null;
+    nextLabel?: string | null;
+    prevLabel?: string | null;
+    folderId?: string | null;
+    nodeId: number;
+    showPagingOnMultiPageForms: MultiPageNavigationOption;
+    pagingDetailsFormat: string;
+    pageCaptionFormat: string;
+    showSummaryPageOnMultiPageForms: boolean;
+    summaryLabel?: string | null;
+    formWorkflows: FormWorkflows;
+    path: string;
+};
+
+export declare interface FormDetailModel {
+    entityType: FormEntityType;
+    unique: string;
+    parentUnique: string | null;
+    name: string;
+}
+
+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 type FormFolderEntityType = typeof FORMS_FORM_FOLDER_ENTITY_TYPE;
+
+export declare type FormRootEntityType = typeof FORMS_FORM_ROOT_ENTITY_TYPE;
+
+export declare const FORMS_CONTEXT: UmbContextToken<FormsContext, FormsContext>;
+
+export declare const FORMS_FORM_ENTITY_TYPE = "forms-form";
+
+export declare const FORMS_FORM_ENTRY_ENTITY_TYPE = "forms-form-entry";
+
+export declare const FORMS_FORM_FOLDER_ENTITY_TYPE = "forms-folder";
+
+export declare const FORMS_FORM_ROOT_ENTITY_TYPE = "forms-form-root";
+
+export declare const FORMS_FORM_WORKSPACE_CONTEXT: UmbContextToken<UmbWorkspaceContext, FormsFormWorkspaceContext>;
+
+export declare class FormsContext extends UmbContextBase {
+    #private;
+    config: Observable<BackOfficeConfig | undefined>;
+    userSecurity: Observable<FormSecurityForUser | undefined>;
+    constructor(host: UmbControllerHost);
+    hostConnected(): Promise<void>;
+    getUserSecurity(): Promise<void>;
+}
+
+export declare type FormSecurityForUser = {
+    key: string;
+    name: string;
+    readonly unique: string;
+    readonly entityType: string;
+    userSecurity: UserSecurity;
+    startFolderIds: Array<string>;
+    formsSecurity: Array<UserFormSecurity>;
+};
+
+export declare enum FormSecurityType {
+    FULL = "Full",
+    READ_ONLY_VIEW_AND_EXPORT_ENTRIES = "ReadOnlyViewAndExportEntries",
+    READ_ONLY_VIEW_ENTRIES = "ReadOnlyViewEntries"
+}
+
+export declare interface FormsFieldPreviewApi extends UmbApi {
+    getSettingValue(alias: string): string;
+    settings: Record<string, string>;
+    prevalues: Array<FieldPrevalue>;
+}
+
+export declare class FormsFieldTypeDetailRepository extends UmbDetailRepositoryBase<FieldTypeWithSettings> {
+    constructor(host: UmbControllerHost);
+    requestValidationPatterns(): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: ValidationPattern[];
+        error?: undefined;
+    }>;
+}
+
+export declare class FormsFormDetailRepository extends UmbDetailRepositoryBase<FormDesign> {
+    constructor(host: UmbControllerHost);
+    requestRecordsMetaData(unique: string): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: EntrySearchResultMetadata;
+        error?: undefined;
+    }>;
+    requestHasRelations(unique: string): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: boolean;
+        error?: undefined;
+    }>;
+    requestTemplates(): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: FormTemplateBase[];
+        error?: undefined;
+    }>;
+    requestFormScaffold(template: string): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: FormDesign;
+        error?: undefined;
+    }>;
+    copyForm(unique: string, copyWorkflows: boolean, newName?: string, copyToFolderId?: string): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: unknown;
+        error?: undefined;
+    }>;
+    copyFormWorkflows(sourceId: string, destinationId: string, workflowIds: Array<string>): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: unknown;
+        error?: undefined;
+    }>;
+    moveForm(unique: string, newParentId: string): Promise<{
+        error: UmbError | UmbApiError | UmbCancelError | Error;
+        data?: undefined;
+    } | {
+        data: unknown;
+        error?: undefined;
+    }>;
+}
+
+export declare class FormsFormWorkspaceContext extends UmbSubmittableWorkspaceContextBase<FormDesign> 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>;
+    readonly id: Observable<string | undefined>;
+    constructor(host: UmbControllerHostElement);
+    load(id: string): Promise<void>;
+    create(parent: {
+        entityType: string;
+        unique: string | null;
+    }, template: string | null): Promise<{
+        data: FormDesign;
+    }>;
+    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;
+    setFieldsetProperty(pageIndex: number, fieldsetIndex: number, alias: string, value: unknown): void;
+    setContainerProperty(pageIndex: number, fieldsetIndex: number, containerIndex: number, alias: string, value: unknown): void;
+    setFieldProperty(pageIndex: number, fieldsetIndex: number, containerIndex: number, fieldIndex: number, alias: string, value: unknown): void;
+    setWorkflowProperty(collectionName: string, index: number, alias: string, value: unknown): void;
+    moveFieldSet(currentPageIndex: number, currentFieldsetIndex: number, newPageIndex: number): void;
+    moveField(fieldId: string, currentIndexPath: string, newIndexPath: string): void;
+    moveWorkflow(workflowIndex: number, fromCollectionName: string, toCollectionName: string): void;
+    getAllPages(): Page[];
+    getAllContainers(): FieldsetContainer[];
+    getAllFields(): Field[];
+    getAllFieldAliases(): string[];
+    getFieldsWithPrevalues(): Array<FieldPrevalueDetail>;
+    getContainerIndexPathForField(id: string): string;
+    getConditionActionTypes: Array<ActionType>;
+    getConditionLogicTypes: Array<LogicType>;
+    getConditionOperators: Array<OperatorType>;
+    getRichTextConfiguration(): Promise<UmbPropertyEditorConfigCollection>;
+    destroy(): void;
+}
+
+export declare interface FormsPrevalueSourceCollectionFilterModel {
+    skip?: number;
+    take?: number;
+}
+
+export declare class FormsPrevalueSourceCollectionRepository implements UmbCollectionRepository {
+    #private;
+    constructor(host: UmbControllerHost);
+    requestCollection(filter: FormsPrevalueSourceCollectionFilterModel): Promise<UmbDataSourceResponse<UmbPagedModel<FieldPreValueSource>>>;
+    destroy(): void;
+}
+
+export declare interface FormsSettingValueConverterApi extends UmbApi {
+    getSettingValueForEditor(setting: Setting, alias: string, value: string): Promise<unknown>;
+    getSettingValueForPersistence(setting: Setting, valueData: UmbPropertyValueData): Promise<string>;
+    getSettingPropertyConfig(setting: Setting, alias: string, values: Array<UmbPropertyValueData>): Promise<UmbPropertyEditorConfig>;
+}
+
+export declare class FormsWorkflowTypeDetailRepository extends UmbDetailRepositoryBase<WorkflowTypeWithSettings> {
+    constructor(host: UmbControllerHost);
+}
+
+export declare type FormTemplateBase = {
+    alias: string;
+    readonly unique: string;
+    readonly entityType: string;
+    name: string;
+    description: string;
+};
+
+export declare type FormWorkflows = {
+    onSubmit: Array<FormWorkflowWithTypeSettings>;
+    onApprove: Array<FormWorkflowWithTypeSettings>;
+    onReject: Array<FormWorkflowWithTypeSettings>;
+};
+
+export declare type FormWorkflowWithTypeSettings = {
+    id: string;
+    name: string;
+    form: string;
+    active: boolean;
+    includeSensitiveData: IncludeSensitiveData;
+    isDeleted: boolean;
+    sortOrder: number;
+    workflowTypeId: string;
+    workflowTypeName: string;
+    workflowTypeDescription: string;
+    workflowTypeIcon: string;
+    workflowTypeGroup: string;
+    settings: {
+        [key: string]: string;
+    };
+    isMandatory: boolean;
+    condition?: FieldCondition | null;
+};
+
+export declare type GetFieldTypeValidationPatternResponse = GetFieldTypeValidationPatternResponses[keyof GetFieldTypeValidationPatternResponses];
+
+export declare type GetFieldTypeValidationPatternResponses = {
+    /**
+     * OK
+     */
+    200: Array<ValidationPattern>;
+};
+
+export declare type GetFormTemplateResponse = GetFormTemplateResponses[keyof GetFormTemplateResponses];
+
+export declare type GetFormTemplateResponses = {
+    /**
+     * OK
+     */
+    200: Array<FormTemplateBase>;
+};
+
+export declare const GUID_EMPTY: string;
+
+export declare enum IncludeSensitiveData {
+    FALSE = "False",
+    TRUE = "True",
+    UNDEFINED = "Undefined"
+}
+
+export declare interface LogicType {
+    name: string;
+    value: string;
+}
+
+export declare enum MultiPageNavigationOption {
+    NONE = "None",
+    SHOW_AT_TOP = "ShowAtTop",
+    SHOW_AT_BOTTOM = "ShowAtBottom"
+}
+
+export declare interface OperatorType {
+    name: string;
+    value: string;
+}
+
+export declare type Page = {
+    fieldSets: Array<FieldSet>;
+    caption?: string | null;
+    sortOrder: number;
+    id: string;
+    form: string;
+    buttonCondition?: FieldCondition | null;
+};
+
+export declare type RecordFieldDisplay = {
+    alias: string;
+    caption: string;
+    isSystem: boolean;
+};
+
+export declare enum RenderInputType {
+    SINGLE = "Single",
+    MULTIPLE = "Multiple",
+    CUSTOM = "Custom"
+}
+
+export declare type Setting = {
+    name: string;
+    alias: string;
+    description: string;
+    prevalues: Array<string>;
+    view: string;
+    displayOrder: number;
+    defaultValue: string;
+    isReadOnly: boolean;
+    isMandatory: boolean;
+};
+
+export declare type UserFormSecurity = {
+    formName: string;
+    formCreated: string;
+    fields: string;
+    hasAccess: boolean;
+    securityType: FormSecurityType;
+    allowInEditor: boolean;
+    securityTypeInt: number;
+    id: number;
+    user: string;
+    form: string;
+};
+
+export declare type UserSecurity = {
+    manageDataSources: boolean;
+    managePreValueSources: boolean;
+    manageWorkflows: boolean;
+    manageForms: boolean;
+    viewEntries: boolean;
+    editEntries: boolean;
+    deleteEntries: boolean;
+    user: string;
+};
+
+export declare type ValidationPattern = {
+    name: string;
+    labelKey: string;
+    pattern: string;
+};
+
+export declare type ValidationRule = {
+    rule: string;
+    errorMessage: string;
+    fieldId: string;
+};
+
+export declare type WorkflowTypeWithSettings = {
+    id: string;
+    readonly unique: string;
+    readonly entityType: string;
+    alias: string;
+    name: string;
+    description: string;
+    icon: string;
+    group: string;
+    settings: Array<Setting>;
+};
+
+export { }