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

package/dist/src/config/component/validation-summary.model.d.ts

@@ -0,0 +1,42 @@
+import { FormConfigVisitorOutline } from "../visitor/base.outline";
+import { FieldComponentConfig, FieldComponentDefinition } from "../field-component.model";
+import { ValidationSummaryFieldComponentConfigOutline, ValidationSummaryFieldComponentDefinitionOutline, ValidationSummaryFormComponentDefinitionOutline } from "./validation-summary.outline";
+import { FormComponentDefinition } from "../form-component.model";
+import { AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+export declare class ValidationSummaryFieldComponentConfig extends FieldComponentConfig implements ValidationSummaryFieldComponentConfigOutline {
+    showWhenValid: boolean;
+    constructor();
+}
+export declare class ValidationSummaryFieldComponentDefinition extends FieldComponentDefinition implements ValidationSummaryFieldComponentDefinitionOutline {
+    class: "ValidationSummaryComponent";
+    config?: ValidationSummaryFieldComponentConfigOutline;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare class ValidationSummaryFormComponentDefinition extends FormComponentDefinition implements ValidationSummaryFormComponentDefinitionOutline {
+    component: ValidationSummaryFieldComponentDefinitionOutline;
+    model?: never;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare const ValidationSummaryMap: ({
+    kind: "FieldComponentConfigKind";
+    def: typeof ValidationSummaryFieldComponentConfig;
+    class?: undefined;
+} | {
+    kind: "FieldComponentDefinitionKind";
+    def: typeof ValidationSummaryFieldComponentDefinition;
+    class: "ValidationSummaryComponent";
+} | {
+    kind: "FormComponentDefinitionKind";
+    def: typeof ValidationSummaryFormComponentDefinition;
+    class: "ValidationSummaryComponent";
+})[];
+export declare const ValidationSummaryDefaults: {
+    FormComponentDefinitionKind: {
+        ValidationSummaryComponent: {
+            FieldComponentDefinitionKind: "ValidationSummaryComponent";
+        };
+    };
+};

package/dist/src/config/component/validation-summary.model.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationSummaryDefaults = exports.ValidationSummaryMap = exports.ValidationSummaryFormComponentDefinition = exports.ValidationSummaryFieldComponentDefinition = exports.ValidationSummaryFieldComponentConfig = void 0;
+const shared_outline_1 = require("../shared.outline");
+const field_component_model_1 = require("../field-component.model");
+const validation_summary_outline_1 = require("./validation-summary.outline");
+const form_component_model_1 = require("../form-component.model");
+/*  Validation Summary Component */
+class ValidationSummaryFieldComponentConfig extends field_component_model_1.FieldComponentConfig {
+    showWhenValid = false;
+    constructor() {
+        super();
+    }
+}
+exports.ValidationSummaryFieldComponentConfig = ValidationSummaryFieldComponentConfig;
+class ValidationSummaryFieldComponentDefinition extends field_component_model_1.FieldComponentDefinition {
+    class = validation_summary_outline_1.ValidationSummaryComponentName;
+    config;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitValidationSummaryFieldComponentDefinition(this);
+    }
+}
+exports.ValidationSummaryFieldComponentDefinition = ValidationSummaryFieldComponentDefinition;
+/* Validation Summary Form Component */
+class ValidationSummaryFormComponentDefinition extends form_component_model_1.FormComponentDefinition {
+    component;
+    model;
+    layout;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitValidationSummaryFormComponentDefinition(this);
+    }
+}
+exports.ValidationSummaryFormComponentDefinition = ValidationSummaryFormComponentDefinition;
+exports.ValidationSummaryMap = [
+    { kind: shared_outline_1.FieldComponentConfigKind, def: ValidationSummaryFieldComponentConfig },
+    {
+        kind: shared_outline_1.FieldComponentDefinitionKind,
+        def: ValidationSummaryFieldComponentDefinition,
+        class: validation_summary_outline_1.ValidationSummaryComponentName
+    },
+    {
+        kind: shared_outline_1.FormComponentDefinitionKind,
+        def: ValidationSummaryFormComponentDefinition,
+        class: validation_summary_outline_1.ValidationSummaryComponentName
+    },
+];
+exports.ValidationSummaryDefaults = {
+    [shared_outline_1.FormComponentDefinitionKind]: {
+        [validation_summary_outline_1.ValidationSummaryComponentName]: {
+            [shared_outline_1.FieldComponentDefinitionKind]: validation_summary_outline_1.ValidationSummaryComponentName,
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi1zdW1tYXJ5Lm1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2NvbmZpZy9jb21wb25lbnQvdmFsaWRhdGlvbi1zdW1tYXJ5Lm1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLHNEQUFzSDtBQUN0SCxvRUFBd0Y7QUFDeEYsNkVBSXNDO0FBQ3RDLGtFQUFnRTtBQUtoRSxtQ0FBbUM7QUFFbkMsTUFBYSxxQ0FBc0MsU0FBUSw0Q0FBb0I7SUFDM0UsYUFBYSxHQUFHLEtBQUssQ0FBQztJQUV0QjtRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztDQUNKO0FBTkQsc0ZBTUM7QUFHRCxNQUFhLHlDQUEwQyxTQUFRLGdEQUF3QjtJQUNuRixLQUFLLEdBQUcsMkRBQThCLENBQUM7SUFDdkMsTUFBTSxDQUFnRDtJQUV0RDtRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztJQUdELEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBaUM7UUFDMUMsTUFBTSxPQUFPLENBQUMsOENBQThDLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDdkUsQ0FBQztDQUNKO0FBWkQsOEZBWUM7QUFFRCx1Q0FBdUM7QUFHdkMsTUFBYSx3Q0FBeUMsU0FBUSw4Q0FBdUI7SUFDakYsU0FBUyxDQUFvRDtJQUM3RCxLQUFLLENBQVM7SUFDZCxNQUFNLENBQTBDO0lBRWhEO1FBQ0ksS0FBSyxFQUFFLENBQUM7SUFDWixDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFpQztRQUMxQyxNQUFNLE9BQU8sQ0FBQyw2Q0FBNkMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUN0RSxDQUFDO0NBQ0o7QUFaRCw0RkFZQztBQUVZLFFBQUEsb0JBQW9CLEdBQUc7SUFDaEMsRUFBQyxJQUFJLEVBQUUseUNBQXdCLEVBQUUsR0FBRyxFQUFFLHFDQUFxQyxFQUFDO0lBQzVFO1FBQ0ksSUFBSSxFQUFFLDZDQUE0QjtRQUNsQyxHQUFHLEVBQUUseUNBQXlDO1FBQzlDLEtBQUssRUFBRSwyREFBOEI7S0FDeEM7SUFDRDtRQUNJLElBQUksRUFBRSw0Q0FBMkI7UUFDakMsR0FBRyxFQUFFLHdDQUF3QztRQUM3QyxLQUFLLEVBQUUsMkRBQThCO0tBQ3hDO0NBQ0osQ0FBQztBQUNXLFFBQUEseUJBQXlCLEdBQUc7SUFDckMsQ0FBQyw0Q0FBMkIsQ0FBQyxFQUFFO1FBQzNCLENBQUMsMkRBQThCLENBQUMsRUFBRTtZQUM5QixDQUFDLDZDQUE0QixDQUFDLEVBQUUsMkRBQThCO1NBQ2pFO0tBQ0o7Q0FDSixDQUFDIn0=

package/dist/src/config/component/validation-summary.outline.d.ts

@@ -0,0 +1,63 @@
+import { FieldComponentConfigFrame, FieldComponentConfigOutline, FieldComponentDefinitionFrame, FieldComponentDefinitionOutline } from "../field-component.outline";
+import { FormComponentDefinitionFrame, FormComponentDefinitionOutline } from "../form-component.outline";
+import { AvailableFieldLayoutDefinitionFrames, AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+import { FieldComponentConfigFrameKindType, FieldComponentConfigKindType, FieldComponentDefinitionFrameKindType, FieldComponentDefinitionKindType, FormComponentDefinitionFrameKindType, FormComponentDefinitionKindType } from "../shared.outline";
+export declare const ValidationSummaryComponentName: "ValidationSummaryComponent";
+export type ValidationSummaryComponentNameType = typeof ValidationSummaryComponentName;
+export interface ValidationSummaryFieldComponentConfigFrame extends FieldComponentConfigFrame {
+    /**
+     * Whether to include tab labels in validation summary labels.
+     * Group labels are always included.
+     */
+    includeTabLabel?: boolean;
+    /**
+     * Whether to render the informational success message when the form has no validation errors.
+     * Defaults to false.
+     */
+    showWhenValid?: boolean;
+}
+export interface ValidationSummaryFieldComponentConfigOutline extends ValidationSummaryFieldComponentConfigFrame, FieldComponentConfigOutline {
+}
+export interface ValidationSummaryFieldComponentDefinitionFrame extends FieldComponentDefinitionFrame {
+    class: ValidationSummaryComponentNameType;
+    config?: ValidationSummaryFieldComponentConfigFrame;
+}
+export interface ValidationSummaryFieldComponentDefinitionOutline extends ValidationSummaryFieldComponentDefinitionFrame, FieldComponentDefinitionOutline {
+    class: ValidationSummaryComponentNameType;
+    config?: ValidationSummaryFieldComponentConfigOutline;
+}
+export interface ValidationSummaryFormComponentDefinitionFrame extends FormComponentDefinitionFrame {
+    component: ValidationSummaryFieldComponentDefinitionFrame;
+    model?: never;
+    layout?: AvailableFieldLayoutDefinitionFrames;
+}
+/**
+ * Displays the form's current blocking validation errors.
+ *
+ * @extensionPoint Use `ValidationSummaryComponent` to provide a consolidated accessible validation summary.
+ * @see https://github.com/redbox-mint/redbox-portal/wiki/Configuring-Record-Forms
+ */
+export interface ValidationSummaryFormComponentDefinitionOutline extends ValidationSummaryFormComponentDefinitionFrame, FormComponentDefinitionOutline {
+    component: ValidationSummaryFieldComponentDefinitionOutline;
+    model?: never;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+}
+export type ValidationSummaryTypes = {
+    kind: FieldComponentConfigFrameKindType;
+    class: ValidationSummaryFieldComponentConfigFrame;
+} | {
+    kind: FieldComponentDefinitionFrameKindType;
+    class: ValidationSummaryFieldComponentDefinitionFrame;
+} | {
+    kind: FormComponentDefinitionFrameKindType;
+    class: ValidationSummaryFormComponentDefinitionFrame;
+} | {
+    kind: FieldComponentConfigKindType;
+    class: ValidationSummaryFieldComponentConfigOutline;
+} | {
+    kind: FieldComponentDefinitionKindType;
+    class: ValidationSummaryFieldComponentDefinitionOutline;
+} | {
+    kind: FormComponentDefinitionKindType;
+    class: ValidationSummaryFormComponentDefinitionOutline;
+};

package/dist/src/config/component/validation-summary.outline.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationSummaryComponentName = void 0;
+/*  Validation Summary Component */
+exports.ValidationSummaryComponentName = "ValidationSummaryComponent";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi1zdW1tYXJ5Lm91dGxpbmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvY29uZmlnL2NvbXBvbmVudC92YWxpZGF0aW9uLXN1bW1hcnkub3V0bGluZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFhQSxtQ0FBbUM7QUFFdEIsUUFBQSw4QkFBOEIsR0FBRyw0QkFBcUMsQ0FBQyJ9