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

package/dist/src/config/component/text-area.model.d.ts

@@ -0,0 +1,63 @@
+import { FieldComponentConfig, FieldComponentDefinition } from "../field-component.model";
+import { FieldModelConfig, FieldModelDefinition } from "../field-model.model";
+import { FormComponentDefinition } from "../form-component.model";
+import { FormConfigVisitorOutline } from "../visitor/base.outline";
+import { TextAreaFieldComponentConfigOutline, TextAreaFieldComponentDefinitionOutline, TextAreaFieldModelConfigOutline, TextAreaFieldModelDefinitionOutline, TextAreaFormComponentDefinitionOutline, TextAreaModelValueType } from "./text-area.outline";
+import { AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+export declare class TextAreaFieldComponentConfig extends FieldComponentConfig implements TextAreaFieldComponentConfigOutline {
+    rows: number;
+    cols: number;
+    placeholder?: string;
+    constructor();
+}
+export declare class TextAreaFieldComponentDefinition extends FieldComponentDefinition implements TextAreaFieldComponentDefinitionOutline {
+    class: "TextAreaComponent";
+    config?: TextAreaFieldComponentConfigOutline;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare class TextAreaFieldModelConfig extends FieldModelConfig<TextAreaModelValueType> implements TextAreaFieldModelConfigOutline {
+    constructor();
+}
+export declare class TextAreaFieldModelDefinition extends FieldModelDefinition<TextAreaModelValueType> implements TextAreaFieldModelDefinitionOutline {
+    class: "TextAreaModel";
+    config?: TextAreaFieldModelConfigOutline;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare class TextAreaFormComponentDefinition extends FormComponentDefinition implements TextAreaFormComponentDefinitionOutline {
+    component: TextAreaFieldComponentDefinitionOutline;
+    model?: TextAreaFieldModelDefinitionOutline;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare const TextAreaMap: ({
+    kind: "FieldComponentConfigKind";
+    def: typeof TextAreaFieldComponentConfig;
+    class?: undefined;
+} | {
+    kind: "FieldComponentDefinitionKind";
+    def: typeof TextAreaFieldComponentDefinition;
+    class: "TextAreaComponent";
+} | {
+    kind: "FieldModelConfigKind";
+    def: typeof TextAreaFieldModelConfig;
+    class?: undefined;
+} | {
+    kind: "FieldModelDefinitionKind";
+    def: typeof TextAreaFieldModelDefinition;
+    class: "TextAreaModel";
+} | {
+    kind: "FormComponentDefinitionKind";
+    def: typeof TextAreaFormComponentDefinition;
+    class: "TextAreaComponent";
+})[];
+export declare const TextAreaDefaults: {
+    FormComponentDefinitionKind: {
+        TextAreaComponent: {
+            FieldComponentDefinitionKind: "TextAreaComponent";
+            FieldModelDefinitionKind: "TextAreaModel";
+        };
+    };
+};

package/dist/src/config/component/text-area.model.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextAreaDefaults = exports.TextAreaMap = exports.TextAreaFormComponentDefinition = exports.TextAreaFieldModelDefinition = exports.TextAreaFieldModelConfig = exports.TextAreaFieldComponentDefinition = exports.TextAreaFieldComponentConfig = void 0;
+const field_component_model_1 = require("../field-component.model");
+const field_model_model_1 = require("../field-model.model");
+const form_component_model_1 = require("../form-component.model");
+const shared_outline_1 = require("../shared.outline");
+const text_area_outline_1 = require("./text-area.outline");
+/* Text Area Component */
+class TextAreaFieldComponentConfig extends field_component_model_1.FieldComponentConfig {
+    rows = 2;
+    cols = 20;
+    placeholder = '';
+    constructor() {
+        super();
+    }
+}
+exports.TextAreaFieldComponentConfig = TextAreaFieldComponentConfig;
+class TextAreaFieldComponentDefinition extends field_component_model_1.FieldComponentDefinition {
+    class = text_area_outline_1.TextAreaComponentName;
+    config;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTextAreaFieldComponentDefinition(this);
+    }
+}
+exports.TextAreaFieldComponentDefinition = TextAreaFieldComponentDefinition;
+/* Text Area Model */
+class TextAreaFieldModelConfig extends field_model_model_1.FieldModelConfig {
+    constructor() {
+        super();
+    }
+}
+exports.TextAreaFieldModelConfig = TextAreaFieldModelConfig;
+class TextAreaFieldModelDefinition extends field_model_model_1.FieldModelDefinition {
+    class = text_area_outline_1.TextAreaModelName;
+    config;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTextAreaFieldModelDefinition(this);
+    }
+}
+exports.TextAreaFieldModelDefinition = TextAreaFieldModelDefinition;
+/* Text Area Form Component */
+class TextAreaFormComponentDefinition extends form_component_model_1.FormComponentDefinition {
+    component;
+    model;
+    layout;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTextAreaFormComponentDefinition(this);
+    }
+}
+exports.TextAreaFormComponentDefinition = TextAreaFormComponentDefinition;
+exports.TextAreaMap = [
+    { kind: shared_outline_1.FieldComponentConfigKind, def: TextAreaFieldComponentConfig },
+    { kind: shared_outline_1.FieldComponentDefinitionKind, def: TextAreaFieldComponentDefinition, class: text_area_outline_1.TextAreaComponentName },
+    { kind: shared_outline_1.FieldModelConfigKind, def: TextAreaFieldModelConfig },
+    { kind: shared_outline_1.FieldModelDefinitionKind, def: TextAreaFieldModelDefinition, class: text_area_outline_1.TextAreaModelName },
+    { kind: shared_outline_1.FormComponentDefinitionKind, def: TextAreaFormComponentDefinition, class: text_area_outline_1.TextAreaComponentName },
+];
+exports.TextAreaDefaults = {
+    [shared_outline_1.FormComponentDefinitionKind]: {
+        [text_area_outline_1.TextAreaComponentName]: {
+            [shared_outline_1.FieldComponentDefinitionKind]: text_area_outline_1.TextAreaComponentName,
+            [shared_outline_1.FieldModelDefinitionKind]: text_area_outline_1.TextAreaModelName,
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGV4dC1hcmVhLm1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2NvbmZpZy9jb21wb25lbnQvdGV4dC1hcmVhLm1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLG9FQUdrQztBQUVsQyw0REFHOEI7QUFDOUIsa0VBQWlFO0FBRWpFLHNEQUsyQjtBQUMzQiwyREFNNkI7QUFJN0IseUJBQXlCO0FBR3pCLE1BQWEsNEJBQTZCLFNBQVEsNENBQW9CO0lBQzNELElBQUksR0FBVyxDQUFDLENBQUM7SUFDakIsSUFBSSxHQUFXLEVBQUUsQ0FBQztJQUNsQixXQUFXLEdBQVksRUFBRSxDQUFDO0lBRWpDO1FBQ0ksS0FBSyxFQUFFLENBQUM7SUFDWixDQUFDO0NBQ0o7QUFSRCxvRUFRQztBQUdELE1BQWEsZ0NBQWlDLFNBQVEsZ0RBQXdCO0lBQzFFLEtBQUssR0FBRyx5Q0FBcUIsQ0FBQztJQUM5QixNQUFNLENBQXVDO0lBRTdDO1FBQ0ksS0FBSyxFQUFFLENBQUM7SUFDWixDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFpQztRQUMxQyxNQUFNLE9BQU8sQ0FBQyxxQ0FBcUMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUM5RCxDQUFDO0NBQ0o7QUFYRCw0RUFXQztBQUdELHFCQUFxQjtBQUdyQixNQUFhLHdCQUF5QixTQUFRLG9DQUF3QztJQUNsRjtRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztDQUNKO0FBSkQsNERBSUM7QUFFRCxNQUFhLDRCQUE2QixTQUFRLHdDQUE0QztJQUMxRixLQUFLLEdBQUcscUNBQWlCLENBQUM7SUFDMUIsTUFBTSxDQUFtQztJQUV6QztRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztJQUVELEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBaUM7UUFDMUMsTUFBTSxPQUFPLENBQUMsaUNBQWlDLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUQsQ0FBQztDQUNKO0FBWEQsb0VBV0M7QUFFRCw4QkFBOEI7QUFHOUIsTUFBYSwrQkFBZ0MsU0FBUSw4Q0FBdUI7SUFDakUsU0FBUyxDQUEyQztJQUNwRCxLQUFLLENBQXVDO0lBQzVDLE1BQU0sQ0FBMEM7SUFFdkQ7UUFDSSxLQUFLLEVBQUUsQ0FBQztJQUNaLENBQUM7SUFFRCxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQWlDO1FBQzFDLE1BQU0sT0FBTyxDQUFDLG9DQUFvQyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQzdELENBQUM7Q0FDSjtBQVpELDBFQVlDO0FBRVksUUFBQSxXQUFXLEdBQUc7SUFDdkIsRUFBQyxJQUFJLEVBQUUseUNBQXdCLEVBQUUsR0FBRyxFQUFFLDRCQUE0QixFQUFDO0lBQ25FLEVBQUMsSUFBSSxFQUFFLDZDQUE0QixFQUFFLEdBQUcsRUFBRSxnQ0FBZ0MsRUFBRSxLQUFLLEVBQUUseUNBQXFCLEVBQUM7SUFDekcsRUFBQyxJQUFJLEVBQUUscUNBQW9CLEVBQUUsR0FBRyxFQUFFLHdCQUF3QixFQUFDO0lBQzNELEVBQUMsSUFBSSxFQUFFLHlDQUF3QixFQUFFLEdBQUcsRUFBRSw0QkFBNEIsRUFBRSxLQUFLLEVBQUUscUNBQWlCLEVBQUM7SUFDN0YsRUFBQyxJQUFJLEVBQUUsNENBQTJCLEVBQUUsR0FBRyxFQUFFLCtCQUErQixFQUFFLEtBQUssRUFBQyx5Q0FBcUIsRUFBQztDQUN6RyxDQUFDO0FBQ1csUUFBQSxnQkFBZ0IsR0FBRztJQUM1QixDQUFDLDRDQUEyQixDQUFDLEVBQUU7UUFDM0IsQ0FBQyx5Q0FBcUIsQ0FBQyxFQUFFO1lBQ3JCLENBQUMsNkNBQTRCLENBQUMsRUFBRSx5Q0FBcUI7WUFDckQsQ0FBQyx5Q0FBd0IsQ0FBQyxFQUFFLHFDQUFpQjtTQUNoRDtLQUNKO0NBQ0osQ0FBQyJ9

package/dist/src/config/component/text-area.outline.d.ts

@@ -0,0 +1,87 @@
+import { AvailableFieldLayoutDefinitionFrames, AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+import { FieldModelConfigFrame, FieldModelConfigOutline, FieldModelDefinitionFrame, FieldModelDefinitionOutline } from "../field-model.outline";
+import { FieldComponentConfigFrame, FieldComponentConfigOutline, FieldComponentDefinitionFrame, FieldComponentDefinitionOutline } from "../field-component.outline";
+import { FormComponentDefinitionFrame, FormComponentDefinitionOutline } from "../form-component.outline";
+import { FieldComponentConfigFrameKindType, FieldComponentConfigKindType, FieldComponentDefinitionFrameKindType, FieldComponentDefinitionKindType, FieldModelConfigFrameKindType, FieldModelConfigKindType, FieldModelDefinitionFrameKindType, FieldModelDefinitionKindType, FormComponentDefinitionFrameKindType, FormComponentDefinitionKindType } from "../shared.outline";
+export declare const TextAreaComponentName: "TextAreaComponent";
+export type TextAreaComponentNameType = typeof TextAreaComponentName;
+export interface TextAreaFieldComponentConfigFrame extends FieldComponentConfigFrame {
+    rows: number;
+    cols: number;
+    placeholder?: string;
+}
+export interface TextAreaFieldComponentConfigOutline extends TextAreaFieldComponentConfigFrame, FieldComponentConfigOutline {
+    rows: number;
+    cols: number;
+    placeholder?: string;
+}
+export interface TextAreaFieldComponentDefinitionFrame extends FieldComponentDefinitionFrame {
+    class: TextAreaComponentNameType;
+    config?: TextAreaFieldComponentConfigFrame;
+}
+export interface TextAreaFieldComponentDefinitionOutline extends TextAreaFieldComponentDefinitionFrame, FieldComponentDefinitionOutline {
+    class: TextAreaComponentNameType;
+    config?: TextAreaFieldComponentConfigOutline;
+}
+export declare const TextAreaModelName: "TextAreaModel";
+export type TextAreaModelNameType = typeof TextAreaModelName;
+export type TextAreaModelValueType = string;
+export interface TextAreaFieldModelConfigFrame extends FieldModelConfigFrame<TextAreaModelValueType> {
+}
+export interface TextAreaFieldModelConfigOutline extends TextAreaFieldModelConfigFrame, FieldModelConfigOutline<TextAreaModelValueType> {
+}
+export interface TextAreaFieldModelDefinitionFrame extends FieldModelDefinitionFrame<TextAreaModelValueType> {
+    class: TextAreaModelNameType;
+    config?: TextAreaFieldModelConfigFrame;
+}
+export interface TextAreaFieldModelDefinitionOutline extends TextAreaFieldModelDefinitionFrame, FieldModelDefinitionOutline<TextAreaModelValueType> {
+    class: TextAreaModelNameType;
+    config?: TextAreaFieldModelConfigOutline;
+}
+export interface TextAreaFormComponentDefinitionFrame extends FormComponentDefinitionFrame {
+    component: TextAreaFieldComponentDefinitionFrame;
+    model?: TextAreaFieldModelDefinitionFrame;
+    layout?: AvailableFieldLayoutDefinitionFrames;
+}
+/**
+ * Configures multiline plain-text entry and its model value.
+ *
+ * @extensionPoint Use `TextAreaComponent` with `TextAreaModel` for long-form unformatted text fields.
+ * @see https://github.com/redbox-mint/redbox-portal/wiki/Configuring-Record-Forms
+ */
+export interface TextAreaFormComponentDefinitionOutline extends TextAreaFormComponentDefinitionFrame, FormComponentDefinitionOutline {
+    component: TextAreaFieldComponentDefinitionOutline;
+    model?: TextAreaFieldModelDefinitionOutline;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+}
+export type TextAreaTypes = {
+    kind: FieldComponentConfigFrameKindType;
+    class: TextAreaFieldComponentConfigFrame;
+} | {
+    kind: FieldComponentDefinitionFrameKindType;
+    class: TextAreaFieldComponentDefinitionFrame;
+} | {
+    kind: FieldModelConfigFrameKindType;
+    class: TextAreaFieldModelConfigFrame;
+} | {
+    kind: FieldModelDefinitionFrameKindType;
+    class: TextAreaFieldModelDefinitionFrame;
+} | {
+    kind: FormComponentDefinitionFrameKindType;
+    class: TextAreaFormComponentDefinitionFrame;
+} | {
+    kind: FieldComponentConfigKindType;
+    class: TextAreaFieldComponentConfigOutline;
+} | {
+    kind: FieldComponentDefinitionKindType;
+    class: TextAreaFieldComponentDefinitionOutline;
+} | {
+    kind: FieldModelConfigKindType;
+    class: TextAreaFieldModelConfigOutline;
+} | {
+    kind: FieldModelDefinitionKindType;
+    class: TextAreaFieldModelDefinitionOutline;
+} | {
+    kind: FormComponentDefinitionKindType;
+    class: TextAreaFormComponentDefinitionOutline;
+};

package/dist/src/config/component/text-area.outline.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextAreaModelName = exports.TextAreaComponentName = void 0;
+/* Text Area Component */
+exports.TextAreaComponentName = "TextAreaComponent";
+/* Text Area Model */
+exports.TextAreaModelName = "TextAreaModel";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGV4dC1hcmVhLm91dGxpbmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvY29uZmlnL2NvbXBvbmVudC90ZXh0LWFyZWEub3V0bGluZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFzQkEseUJBQXlCO0FBRVosUUFBQSxxQkFBcUIsR0FBRyxtQkFBNEIsQ0FBQztBQTJCbEUscUJBQXFCO0FBRVIsUUFBQSxpQkFBaUIsR0FBRyxlQUF3QixDQUFDIn0=

package/dist/src/config/component/typeahead-input.model.d.ts

@@ -0,0 +1,83 @@
+import { FieldModelConfig, FieldModelDefinition } from "../field-model.model";
+import { FormComponentDefinition } from "../form-component.model";
+import { FormConfigVisitorOutline } from "../visitor/base.outline";
+import { FieldComponentConfig, FieldComponentDefinition } from "../field-component.model";
+import { AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+import type { HistoricalVocabMode } from "./dropdown-input.outline";
+import { TypeaheadInputFieldComponentConfigOutline, TypeaheadInputFieldComponentDefinitionOutline, TypeaheadInputFieldModelConfigOutline, TypeaheadInputFieldModelDefinitionOutline, TypeaheadInputFormComponentDefinitionOutline, TypeaheadInputPermissiveFieldComponentConfigOutline, TypeaheadInputModelValueType, TypeaheadOption, TypeaheadSourceType, TypeaheadValueMode } from "./typeahead-input.outline";
+export declare class TypeaheadInputFieldComponentConfig extends FieldComponentConfig implements TypeaheadInputPermissiveFieldComponentConfigOutline {
+    sourceType: TypeaheadSourceType;
+    staticOptions: TypeaheadOption[];
+    vocabRef?: string;
+    queryId?: string;
+    serviceId?: string;
+    provider?: string;
+    resultArrayProperty?: string;
+    labelField?: string;
+    labelTemplate?: string;
+    valueField?: string;
+    minChars: number;
+    debounceMs: number;
+    maxResults: number;
+    requireSelection: boolean;
+    valueMode: TypeaheadValueMode;
+    optionObjectFields?: Record<string, string>;
+    cacheResults: boolean;
+    multiSelect: boolean;
+    placeholder?: string;
+    noResultsMessageKey: "@typeahead-no-matches-found";
+    readOnlyAfterSelect?: boolean;
+    historicalVocabMode?: HistoricalVocabMode;
+    constructor();
+}
+export declare class TypeaheadInputFieldComponentDefinition extends FieldComponentDefinition implements TypeaheadInputFieldComponentDefinitionOutline {
+    class: "TypeaheadInputComponent";
+    config?: TypeaheadInputFieldComponentConfigOutline;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare class TypeaheadInputFieldModelConfig extends FieldModelConfig<TypeaheadInputModelValueType> implements TypeaheadInputFieldModelConfigOutline {
+    constructor();
+}
+export declare class TypeaheadInputFieldModelDefinition extends FieldModelDefinition<TypeaheadInputModelValueType> implements TypeaheadInputFieldModelDefinitionOutline {
+    class: "TypeaheadInputModel";
+    config?: TypeaheadInputFieldModelConfigOutline;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare class TypeaheadInputFormComponentDefinition extends FormComponentDefinition implements TypeaheadInputFormComponentDefinitionOutline {
+    component: TypeaheadInputFieldComponentDefinitionOutline;
+    model?: TypeaheadInputFieldModelDefinitionOutline;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+    constructor();
+    accept(visitor: FormConfigVisitorOutline): Promise<void>;
+}
+export declare const TypeaheadInputMap: ({
+    kind: "FieldComponentConfigKind";
+    def: typeof TypeaheadInputFieldComponentConfig;
+    class?: undefined;
+} | {
+    kind: "FieldComponentDefinitionKind";
+    def: typeof TypeaheadInputFieldComponentDefinition;
+    class: "TypeaheadInputComponent";
+} | {
+    kind: "FieldModelConfigKind";
+    def: typeof TypeaheadInputFieldModelConfig;
+    class?: undefined;
+} | {
+    kind: "FieldModelDefinitionKind";
+    def: typeof TypeaheadInputFieldModelDefinition;
+    class: "TypeaheadInputModel";
+} | {
+    kind: "FormComponentDefinitionKind";
+    def: typeof TypeaheadInputFormComponentDefinition;
+    class: "TypeaheadInputComponent";
+})[];
+export declare const TypeaheadInputDefaults: {
+    FormComponentDefinitionKind: {
+        TypeaheadInputComponent: {
+            FieldComponentDefinitionKind: "TypeaheadInputComponent";
+            FieldModelDefinitionKind: "TypeaheadInputModel";
+        };
+    };
+};

package/dist/src/config/component/typeahead-input.model.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeaheadInputDefaults = exports.TypeaheadInputMap = exports.TypeaheadInputFormComponentDefinition = exports.TypeaheadInputFieldModelDefinition = exports.TypeaheadInputFieldModelConfig = exports.TypeaheadInputFieldComponentDefinition = exports.TypeaheadInputFieldComponentConfig = void 0;
+const field_model_model_1 = require("../field-model.model");
+const form_component_model_1 = require("../form-component.model");
+const shared_outline_1 = require("../shared.outline");
+const field_component_model_1 = require("../field-component.model");
+const typeahead_input_outline_1 = require("./typeahead-input.outline");
+/* Typeahead Input Component */
+class TypeaheadInputFieldComponentConfig extends field_component_model_1.FieldComponentConfig {
+    sourceType = "static";
+    staticOptions = [];
+    vocabRef;
+    queryId;
+    serviceId;
+    provider;
+    resultArrayProperty;
+    labelField;
+    labelTemplate;
+    valueField;
+    minChars = 2;
+    debounceMs = 250;
+    maxResults = 25;
+    requireSelection = false;
+    valueMode = "value";
+    // Optional projection used by optionObject mode when forms need a custom
+    // stored object instead of label/value/sourceType.
+    optionObjectFields;
+    cacheResults = true;
+    multiSelect = false;
+    placeholder;
+    noResultsMessageKey = typeahead_input_outline_1.TypeaheadInputDefaultNoResultsMessageKey;
+    readOnlyAfterSelect;
+    historicalVocabMode;
+    constructor() {
+        super();
+    }
+}
+exports.TypeaheadInputFieldComponentConfig = TypeaheadInputFieldComponentConfig;
+class TypeaheadInputFieldComponentDefinition extends field_component_model_1.FieldComponentDefinition {
+    class = typeahead_input_outline_1.TypeaheadInputComponentName;
+    config;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTypeaheadInputFieldComponentDefinition(this);
+    }
+}
+exports.TypeaheadInputFieldComponentDefinition = TypeaheadInputFieldComponentDefinition;
+/* Typeahead Input Model */
+class TypeaheadInputFieldModelConfig extends field_model_model_1.FieldModelConfig {
+    constructor() {
+        super();
+    }
+}
+exports.TypeaheadInputFieldModelConfig = TypeaheadInputFieldModelConfig;
+class TypeaheadInputFieldModelDefinition extends field_model_model_1.FieldModelDefinition {
+    class = typeahead_input_outline_1.TypeaheadInputModelName;
+    config;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTypeaheadInputFieldModelDefinition(this);
+    }
+}
+exports.TypeaheadInputFieldModelDefinition = TypeaheadInputFieldModelDefinition;
+/* Typeahead Input Form Component */
+class TypeaheadInputFormComponentDefinition extends form_component_model_1.FormComponentDefinition {
+    component;
+    model;
+    layout;
+    constructor() {
+        super();
+    }
+    async accept(visitor) {
+        await visitor.visitTypeaheadInputFormComponentDefinition(this);
+    }
+}
+exports.TypeaheadInputFormComponentDefinition = TypeaheadInputFormComponentDefinition;
+exports.TypeaheadInputMap = [
+    { kind: shared_outline_1.FieldComponentConfigKind, def: TypeaheadInputFieldComponentConfig },
+    { kind: shared_outline_1.FieldComponentDefinitionKind, def: TypeaheadInputFieldComponentDefinition, class: typeahead_input_outline_1.TypeaheadInputComponentName },
+    { kind: shared_outline_1.FieldModelConfigKind, def: TypeaheadInputFieldModelConfig },
+    { kind: shared_outline_1.FieldModelDefinitionKind, def: TypeaheadInputFieldModelDefinition, class: typeahead_input_outline_1.TypeaheadInputModelName },
+    { kind: shared_outline_1.FormComponentDefinitionKind, def: TypeaheadInputFormComponentDefinition, class: typeahead_input_outline_1.TypeaheadInputComponentName },
+];
+exports.TypeaheadInputDefaults = {
+    [shared_outline_1.FormComponentDefinitionKind]: {
+        [typeahead_input_outline_1.TypeaheadInputComponentName]: {
+            [shared_outline_1.FieldComponentDefinitionKind]: typeahead_input_outline_1.TypeaheadInputComponentName,
+            [shared_outline_1.FieldModelDefinitionKind]: typeahead_input_outline_1.TypeaheadInputModelName,
+        },
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWFoZWFkLWlucHV0Lm1vZGVsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2NvbmZpZy9jb21wb25lbnQvdHlwZWFoZWFkLWlucHV0Lm1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDREQUE4RTtBQUM5RSxrRUFBa0U7QUFFbEUsc0RBTTJCO0FBQzNCLG9FQUEwRjtBQUcxRix1RUFjbUM7QUFFbkMsK0JBQStCO0FBRS9CLE1BQWEsa0NBQW1DLFNBQVEsNENBQW9CO0lBQ3hFLFVBQVUsR0FBd0IsUUFBUSxDQUFDO0lBQzNDLGFBQWEsR0FBc0IsRUFBRSxDQUFDO0lBQ3RDLFFBQVEsQ0FBVTtJQUNsQixPQUFPLENBQVU7SUFDakIsU0FBUyxDQUFVO0lBQ25CLFFBQVEsQ0FBVTtJQUNsQixtQkFBbUIsQ0FBVTtJQUM3QixVQUFVLENBQVU7SUFDcEIsYUFBYSxDQUFVO0lBQ3ZCLFVBQVUsQ0FBVTtJQUNwQixRQUFRLEdBQUcsQ0FBQyxDQUFDO0lBQ2IsVUFBVSxHQUFHLEdBQUcsQ0FBQztJQUNqQixVQUFVLEdBQUcsRUFBRSxDQUFDO0lBQ2hCLGdCQUFnQixHQUFHLEtBQUssQ0FBQztJQUN6QixTQUFTLEdBQXVCLE9BQU8sQ0FBQztJQUN4Qyx5RUFBeUU7SUFDekUsbURBQW1EO0lBQ25ELGtCQUFrQixDQUEwQjtJQUM1QyxZQUFZLEdBQUcsSUFBSSxDQUFDO0lBQ3BCLFdBQVcsR0FBRyxLQUFLLENBQUM7SUFDcEIsV0FBVyxDQUFVO0lBQ3JCLG1CQUFtQixHQUFHLGtFQUF3QyxDQUFDO0lBQy9ELG1CQUFtQixDQUFXO0lBQzlCLG1CQUFtQixDQUF1QjtJQUUxQztRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztDQUNKO0FBN0JELGdGQTZCQztBQUVELE1BQWEsc0NBQXVDLFNBQVEsZ0RBQXdCO0lBQ2hGLEtBQUssR0FBRyxxREFBMkIsQ0FBQztJQUNwQyxNQUFNLENBQTZDO0lBRW5EO1FBQ0ksS0FBSyxFQUFFLENBQUM7SUFDWixDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FBQyxPQUFpQztRQUMxQyxNQUFNLE9BQU8sQ0FBQywyQ0FBMkMsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNwRSxDQUFDO0NBQ0o7QUFYRCx3RkFXQztBQUVELDJCQUEyQjtBQUUzQixNQUFhLDhCQUErQixTQUFRLG9DQUE4QztJQUM5RjtRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztDQUNKO0FBSkQsd0VBSUM7QUFFRCxNQUFhLGtDQUFtQyxTQUFRLHdDQUFrRDtJQUN0RyxLQUFLLEdBQUcsaURBQXVCLENBQUM7SUFDaEMsTUFBTSxDQUF5QztJQUUvQztRQUNJLEtBQUssRUFBRSxDQUFDO0lBQ1osQ0FBQztJQUVELEtBQUssQ0FBQyxNQUFNLENBQUMsT0FBaUM7UUFDMUMsTUFBTSxPQUFPLENBQUMsdUNBQXVDLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDaEUsQ0FBQztDQUNKO0FBWEQsZ0ZBV0M7QUFFRCxvQ0FBb0M7QUFFcEMsTUFBYSxxQ0FBc0MsU0FBUSw4Q0FBdUI7SUFDdkUsU0FBUyxDQUFpRDtJQUMxRCxLQUFLLENBQTZDO0lBQ2xELE1BQU0sQ0FBMEM7SUFFdkQ7UUFDSSxLQUFLLEVBQUUsQ0FBQztJQUNaLENBQUM7SUFFRCxLQUFLLENBQUMsTUFBTSxDQUFDLE9BQWlDO1FBQzFDLE1BQU0sT0FBTyxDQUFDLDBDQUEwQyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ25FLENBQUM7Q0FDSjtBQVpELHNGQVlDO0FBRVksUUFBQSxpQkFBaUIsR0FBRztJQUM3QixFQUFFLElBQUksRUFBRSx5Q0FBd0IsRUFBRSxHQUFHLEVBQUUsa0NBQWtDLEVBQUU7SUFDM0UsRUFBRSxJQUFJLEVBQUUsNkNBQTRCLEVBQUUsR0FBRyxFQUFFLHNDQUFzQyxFQUFFLEtBQUssRUFBRSxxREFBMkIsRUFBRTtJQUN2SCxFQUFFLElBQUksRUFBRSxxQ0FBb0IsRUFBRSxHQUFHLEVBQUUsOEJBQThCLEVBQUU7SUFDbkUsRUFBRSxJQUFJLEVBQUUseUNBQXdCLEVBQUUsR0FBRyxFQUFFLGtDQUFrQyxFQUFFLEtBQUssRUFBRSxpREFBdUIsRUFBRTtJQUMzRyxFQUFFLElBQUksRUFBRSw0Q0FBMkIsRUFBRSxHQUFHLEVBQUUscUNBQXFDLEVBQUUsS0FBSyxFQUFFLHFEQUEyQixFQUFFO0NBQ3hILENBQUM7QUFFVyxRQUFBLHNCQUFzQixHQUFHO0lBQ2xDLENBQUMsNENBQTJCLENBQUMsRUFBRTtRQUMzQixDQUFDLHFEQUEyQixDQUFDLEVBQUU7WUFDM0IsQ0FBQyw2Q0FBNEIsQ0FBQyxFQUFFLHFEQUEyQjtZQUMzRCxDQUFDLHlDQUF3QixDQUFDLEVBQUUsaURBQXVCO1NBQ3REO0tBQ0o7Q0FDSixDQUFDIn0=

package/dist/src/config/component/typeahead-input.outline.d.ts

@@ -0,0 +1,199 @@
+import { FieldComponentConfigFrameKindType, FieldComponentConfigKindType, FieldComponentDefinitionFrameKindType, FieldComponentDefinitionKindType, FieldModelConfigFrameKindType, FieldModelConfigKindType, FieldModelDefinitionFrameKindType, FieldModelDefinitionKindType, FormComponentDefinitionFrameKindType, FormComponentDefinitionKindType } from "../shared.outline";
+import { FieldComponentConfigFrame, FieldComponentConfigOutline, FieldComponentDefinitionFrame, FieldComponentDefinitionOutline } from "../field-component.outline";
+import { FieldModelConfigFrame, FieldModelConfigOutline, FieldModelDefinitionFrame, FieldModelDefinitionOutline } from "../field-model.outline";
+import { FormComponentDefinitionFrame, FormComponentDefinitionOutline } from "../form-component.outline";
+import { AvailableFieldLayoutDefinitionFrames, AvailableFieldLayoutDefinitionOutlines } from "../dictionary.outline";
+import type { HistoricalVocabMode } from "./dropdown-input.outline";
+export declare const TypeaheadInputComponentName: "TypeaheadInputComponent";
+export type TypeaheadInputComponentNameType = typeof TypeaheadInputComponentName;
+export declare const TypeaheadInputDefaultNoResultsMessageKey: "@typeahead-no-matches-found";
+export declare const TypeaheadSourceTypes: readonly ["static", "vocabulary", "namedQuery", "external", "service"];
+export type TypeaheadSourceType = typeof TypeaheadSourceTypes[number];
+export type TypeaheadValueMode = "value" | "optionObject";
+export type TypeaheadStoredSourceType = TypeaheadSourceType | "freeText";
+/**
+ * Maps stored object property names to paths on the selected option/raw result.
+ * Use this only with valueMode: "optionObject" when a form needs a domain-specific
+ * stored object, for example { dc_title: "dc_title", grant_number: "grant_number" }.
+ * When omitted, optionObject mode keeps the legacy label/value/sourceType shape.
+ */
+export type TypeaheadOptionObjectFields = Record<string, string>;
+export interface TypeaheadOption {
+    label: string;
+    value: string;
+    sourceType?: TypeaheadStoredSourceType;
+    /**
+     * Indicates the option came from a historical/deprecated vocabulary entry.
+     * This source metadata is preserved even when the option remains selectable.
+     */
+    historical?: boolean;
+    /**
+     * Indicates the option should be shown but cannot be selected in the current UI state.
+     * Historical vocabulary values are disabled in `historicalVocabMode: 'disable'`, but
+     * non-historical options may also be disabled for unrelated reasons.
+     */
+    disabled?: boolean;
+    raw?: unknown;
+}
+export interface TypeaheadInputFieldComponentConfigCommonFrame extends FieldComponentConfigFrame {
+    /**
+     * Static options are required for sourceType: "static"; remote configs may
+     * still carry an empty array from older defaults, so this remains common.
+     */
+    staticOptions?: TypeaheadOption[];
+    labelField?: string;
+    labelTemplate?: string;
+    valueField?: string;
+    minChars?: number;
+    debounceMs?: number;
+    maxResults?: number;
+    requireSelection?: boolean;
+    /**
+     * "value" stores the selected option value as a string.
+     * "optionObject" stores an object. Without optionObjectFields that object is
+     * { label, value, sourceType }; with optionObjectFields it uses the configured
+     * persisted property names and source paths.
+     */
+    valueMode?: TypeaheadValueMode;
+    optionObjectFields?: TypeaheadOptionObjectFields;
+    cacheResults?: boolean;
+    multiSelect?: boolean;
+    placeholder?: string;
+    /**
+     * Translation key rendered when a completed lookup returns no options.
+     * Omit it to use TypeaheadInputDefaultNoResultsMessageKey.
+     */
+    noResultsMessageKey?: string;
+    readOnlyAfterSelect?: boolean;
+    historicalVocabMode?: HistoricalVocabMode;
+}
+export interface TypeaheadStaticSourceConfigFrame extends TypeaheadInputFieldComponentConfigCommonFrame {
+    sourceType?: "static";
+}
+export interface TypeaheadVocabularySourceConfigFrame extends TypeaheadInputFieldComponentConfigCommonFrame {
+    sourceType: "vocabulary";
+    vocabRef?: string;
+}
+export interface TypeaheadNamedQuerySourceConfigFrame extends TypeaheadInputFieldComponentConfigCommonFrame {
+    sourceType: "namedQuery";
+    queryId?: string;
+    /**
+     * Some existing hooks use vocabRef as the domain identifier for namedQuery
+     * typeaheads, for example ROR-backed lookups. Runtime validation still keys
+     * namedQuery sources from queryId, but the frame accepts vocabRef so those
+     * configs remain type-safe and can be migrated without blocking compilation.
+     */
+    vocabRef?: string;
+}
+export interface TypeaheadExternalSourceConfigFrame extends TypeaheadInputFieldComponentConfigCommonFrame {
+    sourceType: "external";
+    provider?: string;
+    resultArrayProperty?: string;
+}
+export interface TypeaheadServiceSourceConfigFrame extends TypeaheadInputFieldComponentConfigCommonFrame {
+    sourceType: "service";
+    serviceId?: string;
+}
+/**
+ * Source-specific config shape for TypeScript-authored forms. The source-specific
+ * IDs remain optional so runtime validator tests can still exercise missing config.
+ */
+export type TypeaheadInputSourceConfigFrame = TypeaheadStaticSourceConfigFrame | TypeaheadVocabularySourceConfigFrame | TypeaheadNamedQuerySourceConfigFrame | TypeaheadExternalSourceConfigFrame | TypeaheadServiceSourceConfigFrame;
+/**
+ * The public config frame uses sourceType as a discriminant while keeping required
+ * source values runtime-validated for JSON, migrated, and intentionally invalid forms.
+ */
+export type TypeaheadInputFieldComponentConfigFrame = TypeaheadInputSourceConfigFrame;
+export type TypeaheadInputFieldComponentConfigOutline = TypeaheadInputFieldComponentConfigFrame & FieldComponentConfigOutline;
+/**
+ * Runtime defaults stay permissive because the constructed config class has to
+ * carry every possible source property before a concrete sourceType is known.
+ */
+export interface TypeaheadInputPermissiveFieldComponentConfigOutline extends TypeaheadInputFieldComponentConfigCommonFrame, FieldComponentConfigOutline {
+    sourceType?: TypeaheadSourceType;
+    vocabRef?: string;
+    queryId?: string;
+    serviceId?: string;
+    provider?: string;
+    resultArrayProperty?: string;
+}
+export interface TypeaheadInputFieldComponentDefinitionFrame extends FieldComponentDefinitionFrame {
+    class: TypeaheadInputComponentNameType;
+    config?: TypeaheadInputFieldComponentConfigFrame;
+}
+export interface TypeaheadInputFieldComponentDefinitionOutline extends TypeaheadInputFieldComponentDefinitionFrame, FieldComponentDefinitionOutline {
+    class: TypeaheadInputComponentNameType;
+    config?: TypeaheadInputFieldComponentConfigOutline;
+}
+export declare const TypeaheadInputModelName: "TypeaheadInputModel";
+export type TypeaheadInputModelNameType = typeof TypeaheadInputModelName;
+export interface TypeaheadInputModelOptionValue {
+    label?: string;
+    value?: string;
+    sourceType?: TypeaheadStoredSourceType;
+    /**
+     * Allows configured object-mode fields such as dc_title/grant_number while
+     * keeping backwards compatibility with legacy label/value/sourceType objects.
+     */
+    [key: string]: unknown;
+}
+export type TypeaheadInputModelValueType = string | TypeaheadInputModelOptionValue | null;
+export interface TypeaheadInputFieldModelConfigFrame extends FieldModelConfigFrame<TypeaheadInputModelValueType> {
+}
+export interface TypeaheadInputFieldModelConfigOutline extends TypeaheadInputFieldModelConfigFrame, FieldModelConfigOutline<TypeaheadInputModelValueType> {
+}
+export interface TypeaheadInputFieldModelDefinitionFrame extends FieldModelDefinitionFrame<TypeaheadInputModelValueType> {
+    class: TypeaheadInputModelNameType;
+    config?: TypeaheadInputFieldModelConfigFrame;
+}
+export interface TypeaheadInputFieldModelDefinitionOutline extends TypeaheadInputFieldModelDefinitionFrame, FieldModelDefinitionOutline<TypeaheadInputModelValueType> {
+    class: TypeaheadInputModelNameType;
+    config?: TypeaheadInputFieldModelConfigOutline;
+}
+export interface TypeaheadInputFormComponentDefinitionFrame extends FormComponentDefinitionFrame {
+    component: TypeaheadInputFieldComponentDefinitionFrame;
+    model?: TypeaheadInputFieldModelDefinitionFrame;
+    layout?: AvailableFieldLayoutDefinitionFrames;
+}
+/**
+ * Configures searchable typeahead selection from local or remote choices.
+ *
+ * @extensionPoint Use `TypeaheadInputComponent` with `TypeaheadInputModel` and the supported lookup configuration.
+ * @see https://github.com/redbox-mint/redbox-portal/wiki/Configuring-Record-Forms
+ */
+export interface TypeaheadInputFormComponentDefinitionOutline extends TypeaheadInputFormComponentDefinitionFrame, FormComponentDefinitionOutline {
+    component: TypeaheadInputFieldComponentDefinitionOutline;
+    model?: TypeaheadInputFieldModelDefinitionOutline;
+    layout?: AvailableFieldLayoutDefinitionOutlines;
+}
+export type TypeaheadInputTypes = {
+    kind: FieldComponentConfigFrameKindType;
+    class: TypeaheadInputFieldComponentConfigFrame;
+} | {
+    kind: FieldComponentDefinitionFrameKindType;
+    class: TypeaheadInputFieldComponentDefinitionFrame;
+} | {
+    kind: FieldModelConfigFrameKindType;
+    class: TypeaheadInputFieldModelConfigFrame;
+} | {
+    kind: FieldModelDefinitionFrameKindType;
+    class: TypeaheadInputFieldModelDefinitionFrame;
+} | {
+    kind: FormComponentDefinitionFrameKindType;
+    class: TypeaheadInputFormComponentDefinitionFrame;
+} | {
+    kind: FieldComponentConfigKindType;
+    class: TypeaheadInputFieldComponentConfigOutline;
+} | {
+    kind: FieldComponentDefinitionKindType;
+    class: TypeaheadInputFieldComponentDefinitionOutline;
+} | {
+    kind: FieldModelConfigKindType;
+    class: TypeaheadInputFieldModelConfigOutline;
+} | {
+    kind: FieldModelDefinitionKindType;
+    class: TypeaheadInputFieldModelDefinitionOutline;
+} | {
+    kind: FormComponentDefinitionKindType;
+    class: TypeaheadInputFormComponentDefinitionOutline;
+};

package/dist/src/config/component/typeahead-input.outline.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeaheadInputModelName = exports.TypeaheadSourceTypes = exports.TypeaheadInputDefaultNoResultsMessageKey = exports.TypeaheadInputComponentName = void 0;
+/* Typeahead Input Component */
+exports.TypeaheadInputComponentName = "TypeaheadInputComponent";
+exports.TypeaheadInputDefaultNoResultsMessageKey = "@typeahead-no-matches-found";
+exports.TypeaheadSourceTypes = ["static", "vocabulary", "namedQuery", "external", "service"];
+/* Typeahead Input Model */
+exports.TypeaheadInputModelName = "TypeaheadInputModel";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWFoZWFkLWlucHV0Lm91dGxpbmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvY29uZmlnL2NvbXBvbmVudC90eXBlYWhlYWQtaW5wdXQub3V0bGluZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUE0QkEsK0JBQStCO0FBQ2xCLFFBQUEsMkJBQTJCLEdBQUcseUJBQWtDLENBQUM7QUFFakUsUUFBQSx3Q0FBd0MsR0FBRyw2QkFBc0MsQ0FBQztBQUVsRixRQUFBLG9CQUFvQixHQUFHLENBQUMsUUFBUSxFQUFFLFlBQVksRUFBRSxZQUFZLEVBQUUsVUFBVSxFQUFFLFNBQVMsQ0FBVSxDQUFDO0FBMEkzRywyQkFBMkI7QUFDZCxRQUFBLHVCQUF1QixHQUFHLHFCQUE4QixDQUFDIn0=