@researchdatabox/sails-ng-common 0.2.0 → 5.0.0-RC1

package/dist/src/config/form-config.outline.d.ts

@@ -0,0 +1,111 @@
+import { FormValidationGroups, FormValidatorTargetFieldConfig } from '../validation/form.model';
+import { AvailableFormComponentDefinitionFrames, AvailableFormComponentDefinitionOutlines } from './dictionary.outline';
+import { CanVisit } from './visitor/base.outline';
+import { KeyValueStringNested, KeyValueStringProperty } from './shared.outline';
+import { FormExpressionsConfigOutline } from './form-component.outline';
+import { FormBehaviourConfigFrame } from './form-behaviour.outline';
+/**
+ * The top-level form config interface that provides typing for the object literal and schema.
+ *
+ * @extensionPoint Hook form registrations provide objects conforming to this contract; component definitions must use registered component, model, and layout class names.
+ * @remarks The generated JSON Schema validates the serializable frame. Runtime construction also applies defaults and visitor transformations.
+ * @see https://github.com/redbox-mint/redbox-portal/wiki/Configuring-Record-Forms
+ */
+export interface FormConfigFrame {
+    /**
+     * optional form name, will be used to identify the form in the config
+     */
+    name: string;
+    /**
+     * the record type
+     */
+    type?: string;
+    /**
+     * the dom element type to inject, e.g. div, span, etc. leave empty to use 'ng-container'
+     */
+    domElementType?: string;
+    /**
+     * optional form dom id property. When set, value will be injected into the overall dom node
+     */
+    domId?: string;
+    /**
+     * the optional css clases to be applied to the form dom node in view / read-only mode
+     */
+    viewCssClasses?: KeyValueStringProperty;
+    /**
+     * the optional css clases to be applied to the form dom node in edit mode
+     */
+    editCssClasses?: KeyValueStringProperty;
+    /**
+     * optional configuration to set in each component
+     */
+    defaultComponentConfig?: KeyValueStringNested;
+    /**
+     * The validation groups to enable for the form.
+     * The validation groups will be set as part of loading the form.
+     * Default ["all"] if none specified.
+     *
+     * In the angular form:
+     * - The available validation groups cannot change.
+     * - The groups a validator belongs to cannot change.
+     * - The currently enabled validation groups can change.
+     *
+     * It is possible to change the enabled validation groups after the form has loaded.
+     * This is done by changing this property in the Form Component config.
+     * Use component expressions with target 'form.enabledValidationGroups' to trigger the event.
+     *
+     * Use Cases for whether a validator is enabled or disabled in the angular form.
+     *
+     * Must change as the user is interacting with the form:
+     *  - Enabled only when a component is visible (or hidden), and disabled otherwise.
+     *  - Enabled based on the value in another component.
+     *  - Enabled when a particular system integration / external state is activated or changed, and disabled otherwise.
+     *
+     *  Change based on state provided from the server that does not change in the angular form:
+     *  - Disabled for a new form, but enabled for a saved form.
+     *  - Enabled for some workflow stages, but disabled in other stages.
+     */
+    enabledValidationGroups?: string[];
+    /**
+     * The validators that are configured at the form level, usually because they involve two or more fields.
+     */
+    validators?: FormValidatorTargetFieldConfig[];
+    /**
+     * The validation groups available in this form.
+     * These are the only validation group names that can be used in the validator config.
+     */
+    validationGroups?: FormValidationGroups;
+    /**
+     * TODO: the default layout component
+     */
+    defaultLayoutComponent?: string;
+    /**
+     * the components of this form
+     */
+    componentDefinitions: AvailableFormComponentDefinitionFrames[];
+    /**
+     * debug: show the form JSON
+     * Default false.
+     */
+    debugValue?: boolean;
+    /**
+     * A record with string keys and expression template values for defining expressions.
+     */
+    expressions?: FormExpressionsConfigOutline[];
+    /**
+     * Form-level automation rules introduced by the form behaviours v1 feature.
+     *
+     * Behaviours complement, rather than replace, component expressions:
+     * expressions remain component-scoped and mostly synchronous, while behaviours
+     * operate at form scope and may run async processor/action pipelines.
+     */
+    behaviours?: FormBehaviourConfigFrame[];
+    /**
+     * The list of fields that are attachments.
+     * This is automatically populated by the form config visitor.
+     */
+    attachmentFields?: string[];
+}
+export interface FormConfigOutline extends FormConfigFrame, CanVisit {
+    componentDefinitions: AvailableFormComponentDefinitionOutlines[];
+}

package/dist/src/config/form-config.outline.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybS1jb25maWcub3V0bGluZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb25maWcvZm9ybS1jb25maWcub3V0bGluZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

package/dist/src/config/form-override.model.d.ts

@@ -0,0 +1,146 @@
+import { AllFormComponentDefinitionOutlines, AvailableFormComponentDefinitionFrames, ReusableFormDefinitions } from './dictionary.outline';
+import { ReusableFormComponentDefinitionFrame } from './component/reusable.outline';
+import { FormModesConfig } from './shared.outline';
+import { ILogger } from '../logger.interface';
+import { QuestionTreeFieldComponentDefinitionOutline } from './component/question-tree.outline';
+import { LineagePaths } from './names/naming-helpers';
+export declare class FormOverride {
+    private logName;
+    private propertiesHelper;
+    private logger;
+    private activeReusableFormDefs;
+    private readonly reusableFragmentSlotNames;
+    private readonly reusableViewTemplateKeys;
+    private readonly linkLeafFallbackTemplate;
+    private readonly dataLocationLeafFallbackTemplate;
+    private readonly pdfListLeafFallbackTemplate;
+    private readonly publishDataLocationSelectorLeafFallbackTemplate;
+    private readonly questionTreeHelper;
+    private readonly forcedViewTransformOverrideKey;
+    constructor(logger: ILogger);
+    /**
+     * Defines the known transforms between two form components.
+     * @private
+     */
+    private knownTransforms;
+    /**
+     * Specifies the 'default' transforms that will be done without needing to be specified.
+     * The defaults can be overridden by specifying the transform in overrides.formModeClasses.
+     * @private
+     */
+    private defaultTransforms;
+    private readonly tableCompatibleLeafComponentNames;
+    hasDefaultViewTransform(className: string | undefined): boolean;
+    /**
+     * Apply any reusable form configs in the form component definitions.
+     * @param items The form component definitions.
+     * @param reusableFormDefs
+     * @protected
+     */
+    applyOverridesReusable(items: AvailableFormComponentDefinitionFrames[], reusableFormDefs: ReusableFormDefinitions, visitedReusableFormNames?: Set<string>): AvailableFormComponentDefinitionFrames[];
+    /**
+     * Expand a reusable form config definition to the actual form component definition(s).
+     * @param item The reusable form component definition.
+     * @param reusableFormDefs
+     * @protected
+     */
+    protected applyOverrideReusableExpand(item: ReusableFormComponentDefinitionFrame, reusableFormDefs: ReusableFormDefinitions, visitedReusableFormNames?: Set<string>): AvailableFormComponentDefinitionFrames[];
+    /**
+     * Apply any overrides that transform a component into another component.
+     * @param source The original component.
+     * @param formMode The current form mode.
+     * @param options Additional options for applying override transforms.
+     * @param options.phase The phase of the form config processing to run.
+     * @param options.reusableFormDefs The available reusable form definitions.
+     * @param options.removeOverrides True to remove all overrides, false to retain the overrides that the client visitor might use.
+     * @returns The transformed form component.
+     */
+    applyOverrideTransform(source: AllFormComponentDefinitionOutlines, formMode: FormModesConfig, options?: {
+        phase?: 'construct' | 'client';
+        reusableFormDefs?: ReusableFormDefinitions;
+        removeOverrides?: boolean;
+    }): AllFormComponentDefinitionOutlines;
+    /**
+     * Create reusable components from the question tree questions DSL.
+     * @param name The form component name.
+     * @param lineagePath The form component lineage path.
+     * @param item The question tree component.
+     * @param modelData The question tree model data.
+     * @private
+     */
+    applyQuestionTreeDsl(name: string | null, lineagePath: LineagePaths, item: QuestionTreeFieldComponentDefinitionOutline, modelData?: unknown): AvailableFormComponentDefinitionFrames[];
+    /**
+     * Check that only the allowed form component frames have been used.
+     * @param items The form components after reusable components have been applied.
+     * @private
+     */
+    applyQuestionTreeFrames(items: AvailableFormComponentDefinitionFrames[]): AvailableFormComponentDefinitionFrames[];
+    private resolveReusableViewTemplate;
+    private substituteReusableTemplateSlots;
+    private sourceSimpleInputComponentTargetContentComponent;
+    private sourceTextAreaComponentTargetContentComponent;
+    private sourceDropdownInputComponentTargetContentComponent;
+    private sourceCheckboxInputComponentTargetContentComponent;
+    private sourceRadioInputComponentTargetContentComponent;
+    private sourceDateInputComponentTargetContentComponent;
+    private sourceTypeaheadInputComponentTargetContentComponent;
+    private resolveTypeaheadContentValue;
+    private getConfiguredTypeaheadStoredValue;
+    private getTypeaheadOptionObjectFields;
+    private isConfiguredTypeaheadLabelField;
+    private isConfiguredTypeaheadValueField;
+    private sourceRichTextEditorComponentTargetContentComponent;
+    private resolveDateInputFormat;
+    private resolveRichTextOutputFormat;
+    private sourceFileUploadComponentTargetContentComponent;
+    private sourceDataLocationComponentTargetContentComponent;
+    private sourcePDFListComponentTargetContentComponent;
+    private sourcePublishDataLocationSelectorComponentTargetContentComponent;
+    private sourceCheckboxTreeComponentTargetContentComponent;
+    private sourceQuestionTreeComponentTargetContentComponent;
+    private isDeepEmpty;
+    private buildQuestionTreeViewRows;
+    private normaliseQuestionTreeAnswerValues;
+    private resolveQuestionTreeQuestionLabel;
+    private resolveQuestionTreeAnswerLabel;
+    private resolveQuestionTreeAnswerLabelFromConfig;
+    private sourceRepeatableComponentTargetContentComponent;
+    private extractDescendantValues;
+    private pruneGroupValue;
+    private sourceGroupComponentTargetContentComponent;
+    private generateTemplateForComponent;
+    private generateRepeatableTemplate;
+    private generateGroupTemplate;
+    private renderRepeatableTable;
+    private renderRepeatableFallback;
+    private effectiveViewTargetsContentComponent;
+    private renderComponentBody;
+    private renderLabelValueRow;
+    private renderLeafValue;
+    private renderDateInputValue;
+    private renderRichTextEditorValue;
+    private renderTypeaheadValue;
+    private renderTypeaheadScalarValue;
+    private renderDisplayValue;
+    private renderDisplayScalarValue;
+    private getTypeaheadDisplayFields;
+    private getCommonDisplayFields;
+    private getOptionLabelPairs;
+    private renderOptionSingleValue;
+    private renderOptionListValue;
+    private getGroupChildren;
+    private isViewRenderableComponent;
+    private getRenderableGroupChildren;
+    private isTableEligibleGroupChildren;
+    private resolveTranslatedLabel;
+    private safeValueExpression;
+    private buildNestedExpression;
+    private escapeForHandlebarsLiteral;
+    private sourceTabComponentTargetAccordionComponent;
+    private isModeAllowed;
+    private hasExplicitAllowedMode;
+    private forceAllowModeForTransformedTree;
+    private commonContentComponent;
+    private commonContentOptionList;
+    private commonContentPlain;
+}