@researchdatabox/sails-ng-common 0.0.1-beta.8936

package/dist/src/config/visitor/base.outline.d.ts

@@ -0,0 +1,140 @@
+import { SimpleInputFieldComponentDefinitionOutline, SimpleInputFieldModelDefinitionOutline, SimpleInputFormComponentDefinitionOutline } from '../component/simple-input.outline';
+import { ContentFieldComponentDefinitionOutline, ContentFormComponentDefinitionOutline } from '../component/content.outline';
+import { RepeatableElementFieldLayoutDefinitionOutline, RepeatableFieldComponentDefinitionOutline, RepeatableFieldModelDefinitionOutline, RepeatableFormComponentDefinitionOutline } from '../component/repeatable.outline';
+import { ValidationSummaryFieldComponentDefinitionOutline, ValidationSummaryFormComponentDefinitionOutline } from '../component/validation-summary.outline';
+import { GroupFieldComponentDefinitionOutline, GroupFieldModelDefinitionOutline, GroupFormComponentDefinitionOutline } from '../component/group.outline';
+import { TabFieldComponentDefinitionOutline, TabFieldLayoutDefinitionOutline, TabFormComponentDefinitionOutline } from '../component/tab.outline';
+import { AccordionFieldComponentDefinitionOutline, AccordionFieldLayoutDefinitionOutline, AccordionFormComponentDefinitionOutline, AccordionPanelFieldComponentDefinitionOutline, AccordionPanelFieldLayoutDefinitionOutline, AccordionPanelFormComponentDefinitionOutline } from '../component/accordion.outline';
+import { TabContentFieldComponentDefinitionOutline, TabContentFieldLayoutDefinitionOutline, TabContentFormComponentDefinitionOutline } from '../component/tab-content.outline';
+import { SaveButtonFieldComponentDefinitionOutline, SaveButtonFormComponentDefinitionOutline } from '../component/save-button.outline';
+import { SaveStatusFieldComponentDefinitionOutline, SaveStatusFormComponentDefinitionOutline } from '../component/save-status.outline';
+import { CancelButtonFieldComponentDefinitionOutline, CancelButtonFormComponentDefinitionOutline } from '../component/cancel-button.outline';
+import { DeleteButtonFieldComponentDefinitionOutline, DeleteButtonFormComponentDefinitionOutline } from '../component/delete-button.outline';
+import { TabNavButtonFieldComponentDefinitionOutline, TabNavButtonFormComponentDefinitionOutline } from '../component/tab-nav-button.outline';
+import { TextAreaFieldComponentDefinitionOutline, TextAreaFieldModelDefinitionOutline, TextAreaFormComponentDefinitionOutline } from '../component/text-area.outline';
+import { DefaultFieldLayoutDefinitionOutline } from '../component/default-layout.outline';
+import { ActionRowFieldLayoutDefinitionOutline } from '../component/action-row-layout.outline';
+import { InlineFieldLayoutDefinitionOutline } from '../component/inline-layout.outline';
+import { CheckboxInputFieldComponentDefinitionOutline, CheckboxInputFieldModelDefinitionOutline, CheckboxInputFormComponentDefinitionOutline } from '../component/checkbox-input.outline';
+import { DropdownInputFieldComponentDefinitionOutline, DropdownInputFieldModelDefinitionOutline, DropdownInputFormComponentDefinitionOutline } from '../component/dropdown-input.outline';
+import { RadioInputFieldComponentDefinitionOutline, RadioInputFieldModelDefinitionOutline, RadioInputFormComponentDefinitionOutline } from '../component/radio-input.outline';
+import { DateInputFieldComponentDefinitionOutline, DateInputFieldModelDefinitionOutline, DateInputFormComponentDefinitionOutline } from '../component/date-input.outline';
+import { ReusableFieldComponentDefinitionOutline, ReusableFormComponentDefinitionOutline } from '../component/reusable.outline';
+import { QuestionTreeFieldComponentDefinitionOutline, QuestionTreeFieldModelDefinitionOutline, QuestionTreeFormComponentDefinitionOutline } from '../component/question-tree.outline';
+import { CheckboxTreeFieldComponentDefinitionOutline, CheckboxTreeFieldModelDefinitionOutline, CheckboxTreeFormComponentDefinitionOutline } from '../component/checkbox-tree.outline';
+import { RecordSelectorFieldComponentDefinitionOutline, RecordSelectorFieldModelDefinitionOutline, RecordSelectorFormComponentDefinitionOutline } from '../component/record-selector.outline';
+import { TypeaheadInputFieldComponentDefinitionOutline, TypeaheadInputFieldModelDefinitionOutline, TypeaheadInputFormComponentDefinitionOutline } from '../component/typeahead-input.outline';
+import { RichTextEditorFieldComponentDefinitionOutline, RichTextEditorFieldModelDefinitionOutline, RichTextEditorFormComponentDefinitionOutline } from '../component/rich-text-editor.outline';
+import { MapFieldComponentDefinitionOutline, MapFieldModelDefinitionOutline, MapFormComponentDefinitionOutline } from '../component/map.outline';
+import { FileUploadFieldComponentDefinitionOutline, FileUploadFieldModelDefinitionOutline, FileUploadFormComponentDefinitionOutline } from '../component/file-upload.outline';
+import { PDFListFieldComponentDefinitionOutline, PDFListFieldModelDefinitionOutline, PDFListFormComponentDefinitionOutline } from '../component/pdf-list.outline';
+import { RecordMetadataRetrieverFieldComponentDefinitionOutline, RecordMetadataRetrieverFormComponentDefinitionOutline } from '../component/record-metadata-retriever.outline';
+import { DataLocationFieldComponentDefinitionOutline, DataLocationFieldModelDefinitionOutline, DataLocationFormComponentDefinitionOutline } from '../component/data-location.outline';
+import { PublishDataLocationSelectorFieldComponentDefinitionOutline, PublishDataLocationSelectorFieldModelDefinitionOutline, PublishDataLocationSelectorFormComponentDefinitionOutline } from '../component/publish-data-location-selector.outline';
+import { PublishDataLocationRefreshFieldComponentDefinitionOutline, PublishDataLocationRefreshFormComponentDefinitionOutline } from '../component/publish-data-location-refresh.outline';
+/**
+ * Interface for classes that can be visited by a visitor.
+ */
+export interface CanVisit {
+    /**
+     * Accept a visitor to this form field definition.
+     */
+    accept(visitor: FormConfigVisitorOutline): void;
+}
+/**
+ * Visitors must implement this structure.
+ */
+export interface FormConfigVisitorOutline {
+    visitFormConfig(item: CanVisit): void;
+    visitSimpleInputFieldComponentDefinition(item: SimpleInputFieldComponentDefinitionOutline): void;
+    visitSimpleInputFieldModelDefinition(item: SimpleInputFieldModelDefinitionOutline): void;
+    visitSimpleInputFormComponentDefinition(item: SimpleInputFormComponentDefinitionOutline): void;
+    visitContentFormComponentDefinition(item: ContentFormComponentDefinitionOutline): void;
+    visitContentFieldComponentDefinition(item: ContentFieldComponentDefinitionOutline): void;
+    visitContentFormComponentDefinition(item: ContentFormComponentDefinitionOutline): void;
+    visitRepeatableFieldComponentDefinition(item: RepeatableFieldComponentDefinitionOutline): void;
+    visitRepeatableFieldModelDefinition(item: RepeatableFieldModelDefinitionOutline): void;
+    visitRepeatableElementFieldLayoutDefinition(item: RepeatableElementFieldLayoutDefinitionOutline): void;
+    visitRepeatableFormComponentDefinition(item: RepeatableFormComponentDefinitionOutline): void;
+    visitValidationSummaryFieldComponentDefinition(item: ValidationSummaryFieldComponentDefinitionOutline): void;
+    visitValidationSummaryFormComponentDefinition(item: ValidationSummaryFormComponentDefinitionOutline): void;
+    visitGroupFieldComponentDefinition(item: GroupFieldComponentDefinitionOutline): void;
+    visitGroupFieldModelDefinition(item: GroupFieldModelDefinitionOutline): void;
+    visitGroupFormComponentDefinition(item: GroupFormComponentDefinitionOutline): void;
+    visitTabFieldComponentDefinition(item: TabFieldComponentDefinitionOutline): void;
+    visitTabFieldLayoutDefinition(item: TabFieldLayoutDefinitionOutline): void;
+    visitTabFormComponentDefinition(item: TabFormComponentDefinitionOutline): void;
+    visitAccordionFieldComponentDefinition(item: AccordionFieldComponentDefinitionOutline): void;
+    visitAccordionFieldLayoutDefinition(item: AccordionFieldLayoutDefinitionOutline): void;
+    visitAccordionFormComponentDefinition(item: AccordionFormComponentDefinitionOutline): void;
+    visitAccordionPanelFieldComponentDefinition(item: AccordionPanelFieldComponentDefinitionOutline): void;
+    visitAccordionPanelFieldLayoutDefinition(item: AccordionPanelFieldLayoutDefinitionOutline): void;
+    visitAccordionPanelFormComponentDefinition(item: AccordionPanelFormComponentDefinitionOutline): void;
+    visitTabContentFieldComponentDefinition(item: TabContentFieldComponentDefinitionOutline): void;
+    visitTabContentFieldLayoutDefinition(item: TabContentFieldLayoutDefinitionOutline): void;
+    visitTabContentFormComponentDefinition(item: TabContentFormComponentDefinitionOutline): void;
+    visitSaveButtonFieldComponentDefinition(item: SaveButtonFieldComponentDefinitionOutline): void;
+    visitSaveButtonFormComponentDefinition(item: SaveButtonFormComponentDefinitionOutline): void;
+    visitSaveStatusFieldComponentDefinition(item: SaveStatusFieldComponentDefinitionOutline): void;
+    visitSaveStatusFormComponentDefinition(item: SaveStatusFormComponentDefinitionOutline): void;
+    visitCancelButtonFieldComponentDefinition(item: CancelButtonFieldComponentDefinitionOutline): void;
+    visitCancelButtonFormComponentDefinition(item: CancelButtonFormComponentDefinitionOutline): void;
+    visitDeleteButtonFieldComponentDefinition(item: DeleteButtonFieldComponentDefinitionOutline): void;
+    visitDeleteButtonFormComponentDefinition(item: DeleteButtonFormComponentDefinitionOutline): void;
+    visitTabNavButtonFieldComponentDefinition(item: TabNavButtonFieldComponentDefinitionOutline): void;
+    visitTabNavButtonFormComponentDefinition(item: TabNavButtonFormComponentDefinitionOutline): void;
+    visitTextAreaFieldComponentDefinition(item: TextAreaFieldComponentDefinitionOutline): void;
+    visitTextAreaFieldModelDefinition(item: TextAreaFieldModelDefinitionOutline): void;
+    visitTextAreaFormComponentDefinition(item: TextAreaFormComponentDefinitionOutline): void;
+    visitDefaultFieldLayoutDefinition(item: DefaultFieldLayoutDefinitionOutline): void;
+    visitInlineFieldLayoutDefinition(item: InlineFieldLayoutDefinitionOutline): void;
+    visitActionRowFieldLayoutDefinition(item: ActionRowFieldLayoutDefinitionOutline): void;
+    visitCheckboxInputFieldComponentDefinition(item: CheckboxInputFieldComponentDefinitionOutline): void;
+    visitCheckboxInputFieldModelDefinition(item: CheckboxInputFieldModelDefinitionOutline): void;
+    visitCheckboxInputFormComponentDefinition(item: CheckboxInputFormComponentDefinitionOutline): void;
+    visitDropdownInputFieldComponentDefinition(item: DropdownInputFieldComponentDefinitionOutline): void;
+    visitDropdownInputFieldModelDefinition(item: DropdownInputFieldModelDefinitionOutline): void;
+    visitDropdownInputFormComponentDefinition(item: DropdownInputFormComponentDefinitionOutline): void;
+    visitRadioInputFieldComponentDefinition(item: RadioInputFieldComponentDefinitionOutline): void;
+    visitRadioInputFieldModelDefinition(item: RadioInputFieldModelDefinitionOutline): void;
+    visitRadioInputFormComponentDefinition(item: RadioInputFormComponentDefinitionOutline): void;
+    visitDateInputFieldComponentDefinition(item: DateInputFieldComponentDefinitionOutline): void;
+    visitDateInputFieldModelDefinition(item: DateInputFieldModelDefinitionOutline): void;
+    visitDateInputFormComponentDefinition(item: DateInputFormComponentDefinitionOutline): void;
+    visitReusableFieldComponentDefinition(item: ReusableFieldComponentDefinitionOutline): void;
+    visitReusableFormComponentDefinition(item: ReusableFormComponentDefinitionOutline): void;
+    visitQuestionTreeFieldComponentDefinition(item: QuestionTreeFieldComponentDefinitionOutline): void;
+    visitQuestionTreeFieldModelDefinition(item: QuestionTreeFieldModelDefinitionOutline): void;
+    visitQuestionTreeFormComponentDefinition(item: QuestionTreeFormComponentDefinitionOutline): void;
+    visitCheckboxTreeFieldComponentDefinition(item: CheckboxTreeFieldComponentDefinitionOutline): void;
+    visitCheckboxTreeFieldModelDefinition(item: CheckboxTreeFieldModelDefinitionOutline): void;
+    visitCheckboxTreeFormComponentDefinition(item: CheckboxTreeFormComponentDefinitionOutline): void;
+    visitRecordSelectorFieldComponentDefinition(item: RecordSelectorFieldComponentDefinitionOutline): void;
+    visitRecordSelectorFieldModelDefinition(item: RecordSelectorFieldModelDefinitionOutline): void;
+    visitRecordSelectorFormComponentDefinition(item: RecordSelectorFormComponentDefinitionOutline): void;
+    visitTypeaheadInputFieldComponentDefinition(item: TypeaheadInputFieldComponentDefinitionOutline): void;
+    visitTypeaheadInputFieldModelDefinition(item: TypeaheadInputFieldModelDefinitionOutline): void;
+    visitTypeaheadInputFormComponentDefinition(item: TypeaheadInputFormComponentDefinitionOutline): void;
+    visitRichTextEditorFieldComponentDefinition(item: RichTextEditorFieldComponentDefinitionOutline): void;
+    visitRichTextEditorFieldModelDefinition(item: RichTextEditorFieldModelDefinitionOutline): void;
+    visitRichTextEditorFormComponentDefinition(item: RichTextEditorFormComponentDefinitionOutline): void;
+    visitMapFieldComponentDefinition(item: MapFieldComponentDefinitionOutline): void;
+    visitMapFieldModelDefinition(item: MapFieldModelDefinitionOutline): void;
+    visitMapFormComponentDefinition(item: MapFormComponentDefinitionOutline): void;
+    visitFileUploadFieldComponentDefinition(item: FileUploadFieldComponentDefinitionOutline): void;
+    visitFileUploadFieldModelDefinition(item: FileUploadFieldModelDefinitionOutline): void;
+    visitFileUploadFormComponentDefinition(item: FileUploadFormComponentDefinitionOutline): void;
+    visitPDFListFieldComponentDefinition(item: PDFListFieldComponentDefinitionOutline): void;
+    visitPDFListFieldModelDefinition(item: PDFListFieldModelDefinitionOutline): void;
+    visitPDFListFormComponentDefinition(item: PDFListFormComponentDefinitionOutline): void;
+    visitRecordMetadataRetrieverFieldComponentDefinition(item: RecordMetadataRetrieverFieldComponentDefinitionOutline): void;
+    visitRecordMetadataRetrieverFormComponentDefinition(item: RecordMetadataRetrieverFormComponentDefinitionOutline): void;
+    visitDataLocationFieldComponentDefinition(item: DataLocationFieldComponentDefinitionOutline): void;
+    visitDataLocationFieldModelDefinition(item: DataLocationFieldModelDefinitionOutline): void;
+    visitDataLocationFormComponentDefinition(item: DataLocationFormComponentDefinitionOutline): void;
+    visitPublishDataLocationRefreshFieldComponentDefinition(item: PublishDataLocationRefreshFieldComponentDefinitionOutline): void;
+    visitPublishDataLocationRefreshFormComponentDefinition(item: PublishDataLocationRefreshFormComponentDefinitionOutline): void;
+    visitPublishDataLocationSelectorFieldComponentDefinition(item: PublishDataLocationSelectorFieldComponentDefinitionOutline): void;
+    visitPublishDataLocationSelectorFieldModelDefinition(item: PublishDataLocationSelectorFieldModelDefinitionOutline): void;
+    visitPublishDataLocationSelectorFormComponentDefinition(item: PublishDataLocationSelectorFormComponentDefinitionOutline): void;
+}

package/dist/src/config/visitor/base.outline.js

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

package/dist/src/config/visitor/common.model.d.ts

@@ -0,0 +1,119 @@
+import { ILogger } from '../../logger.interface';
+import { FieldLayoutConfigFrame } from '../field-layout.outline';
+import { FieldComponentConfigFrame } from '../field-component.outline';
+import { FieldModelConfigFrame } from '../field-model.outline';
+import { FormComponentDefinitionFrame, FormComponentDefinitionOutline } from '../form-component.outline';
+import { CanVisit, FormConfigVisitorOutline } from './base.outline';
+import { LineagePath, LineagePaths, LineagePathsPartial } from '../names/naming-helpers';
+import { AllFormComponentDefinitionOutlines } from '../dictionary.outline';
+export declare class PropertiesHelper {
+    private fieldComponentMap;
+    private fieldModelMap;
+    private fieldLayoutMap;
+    private formComponentMap;
+    private kindNameDefaultsMap;
+    constructor();
+    /**
+     * Create a new instance of a form component.
+     * Populate the common form component properties.
+     * @param currentData The form component definition.
+     */
+    sharedConstructFormComponent(currentData: FormComponentDefinitionFrame): AllFormComponentDefinitionOutlines;
+    /**
+     * Set the common field component config properties.
+     * @param item Set the value of the named properties on this item.
+     * @param config Get the value of the named properties from this config.
+     */
+    sharedPopulateFieldComponentConfig(item: FieldComponentConfigFrame, config?: FieldComponentConfigFrame): void;
+    /**
+     * Set the common field model config properties.
+     * @param item Set the value of the named properties on this item.
+     * @param config Get the value of the named properties from this config.
+     */
+    sharedPopulateFieldModelConfig(item: FieldModelConfigFrame<unknown>, config?: FieldModelConfigFrame<unknown>): void;
+    /**
+     * Set the common field layout config properties.
+     * @param item Set the value of the named properties on this item.
+     * @param config Get the value of the named properties from this config.
+     */
+    sharedPopulateFieldLayoutConfig(item: FieldLayoutConfigFrame, config?: FieldLayoutConfigFrame): void;
+    /**
+     * Set the property on target.
+     * Retain the target property value if it is not undefined.
+     * Use the value of the property from the first source with a non-undefined property of the same name.
+     *
+     * @param target Set the name property on the target.
+     * @param name The property to set.
+     * @param sources The sources that might have the name property.
+     */
+    setPropDefault(name: string, target: {
+        [x: string]: any;
+    }, ...sources: ({
+        [x: string]: any;
+    } | null | undefined)[]): void;
+    /**
+     * Set the property on target.
+     * Override the value of the property from the last source with a non-undefined property of the same name.
+     * @param name The property to set.
+     * @param target Set the name property on the target.
+     * @param sources The sources that might have the name property.
+     */
+    setPropOverride(name: string, target: {
+        [x: string]: any;
+    }, ...sources: ({
+        [x: string]: any;
+    } | null | undefined)[]): void;
+    /**
+     * Convert a value to a field reference that can be used in a JSONata expression.
+     * @param value The value to convert.
+     * @return The value ready to be used as a field reference in a JSON expression.
+     */
+    toFieldReference(value: unknown): string;
+    /**
+     * Convert a lineage path to a set of dot-separated field references for a JSONata expression.
+     * @param path The lineage path to convert.
+     * @return The path ready to be used as field references in a JSON expression.
+     */
+    lineagePathToExpressionIdentifiers(path: LineagePath): string;
+    private setFieldClassName;
+}
+export declare class FormPathHelper {
+    protected logName: string;
+    protected logger: ILogger;
+    private visitor;
+    private _formPath;
+    constructor(logger: ILogger, visitor: FormConfigVisitorOutline);
+    /**
+       * Get the current form paths.
+       */
+    get formPath(): LineagePaths;
+    /**
+     * Get the current model name.
+     */
+    get modelName(): string | null;
+    reset(): void;
+    /**
+     * Call accept on the provided item and set the current path with the given suffix.
+     * Set the current path to the previous value after the accept method is done.
+     * @param item The item to visit.
+     * @param more The lineage paths to add to the end of the current paths.
+     */
+    acceptFormPath(item: CanVisit, more?: LineagePathsPartial): void;
+    /**
+     * Call accept on the properties of the form component definition outline that can be visited.
+     * @param item The form component definition outline.
+     */
+    acceptFormComponentDefinition(item: FormComponentDefinitionOutline): void;
+    lineagePathsForFormConfigComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForGroupFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForTabFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForTabContentFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForAccordionFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForAccordionPanelFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForRepeatableFieldComponentDefinition(item: FormComponentDefinitionOutline): LineagePathsPartial;
+    lineagePathsForReusableFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    lineagePathsForQuestionTreeFieldComponentDefinition(item: FormComponentDefinitionOutline, index: number): LineagePathsPartial;
+    private getFormPathDataModel;
+    private getFormPathAngularComponents;
+    private getFormPathLayout;
+}