@start9labs/start-sdk 0.3.6-alpha.10

package/base/lib/actions/input/builder/list.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.List = void 0;
+const ts_matches_1 = require("ts-matches");
+class List {
+    constructor(build, validator) {
+        this.build = build;
+        this.validator = validator;
+    }
+    static text(a, aSpec) {
+        return new List(() => {
+            const spec = {
+                type: "text",
+                placeholder: null,
+                minLength: null,
+                maxLength: null,
+                masked: false,
+                inputmode: "text",
+                generate: null,
+                patterns: aSpec.patterns || [],
+                ...aSpec,
+            };
+            const built = {
+                description: null,
+                warning: null,
+                default: [],
+                type: "list",
+                minLength: null,
+                maxLength: null,
+                disabled: false,
+                ...a,
+                spec,
+            };
+            return built;
+        }, (0, ts_matches_1.arrayOf)(ts_matches_1.string));
+    }
+    static dynamicText(getA) {
+        return new List(async (options) => {
+            const { spec: aSpec, ...a } = await getA(options);
+            const spec = {
+                type: "text",
+                placeholder: null,
+                minLength: null,
+                maxLength: null,
+                masked: false,
+                inputmode: "text",
+                generate: null,
+                patterns: aSpec.patterns || [],
+                ...aSpec,
+            };
+            const built = {
+                description: null,
+                warning: null,
+                default: [],
+                type: "list",
+                minLength: null,
+                maxLength: null,
+                disabled: false,
+                ...a,
+                spec,
+            };
+            return built;
+        }, (0, ts_matches_1.arrayOf)(ts_matches_1.string));
+    }
+    static obj(a, aSpec) {
+        return new List(async (options) => {
+            const { spec: previousSpecSpec, ...restSpec } = aSpec;
+            const specSpec = await previousSpecSpec.build(options);
+            const spec = {
+                type: "object",
+                displayAs: null,
+                uniqueBy: null,
+                ...restSpec,
+                spec: specSpec,
+            };
+            const value = {
+                spec,
+                default: [],
+                ...a,
+            };
+            return {
+                description: null,
+                warning: null,
+                minLength: null,
+                maxLength: null,
+                type: "list",
+                disabled: false,
+                ...value,
+            };
+        }, (0, ts_matches_1.arrayOf)(aSpec.spec.validator));
+    }
+    /**
+     * Use this during the times that the input needs a more specific type.
+     * Used in types that the value/ variant/ list/ inputSpec is constructed somewhere else.
+    ```ts
+    const a = InputSpec.text({
+      name: "a",
+      required: false,
+    })
+  
+    return InputSpec.of<Store>()({
+      myValue: a.withStore(),
+    })
+    ```
+     */
+    withStore() {
+        return this;
+    }
+}
+exports.List = List;
+//# sourceMappingURL=list.js.map

package/base/lib/actions/input/builder/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","sourceRoot":"","sources":["../../../../../../base/lib/actions/input/builder/list.ts"],"names":[],"mappings":";;;AASA,2CAAoD;AAEpD,MAAa,IAAI;IACf,YACS,KAAsC,EACtC,SAAgC;QADhC,UAAK,GAAL,KAAK,CAAiC;QACtC,cAAS,GAAT,SAAS,CAAuB;IACtC,CAAC;IAEJ,MAAM,CAAC,IAAI,CACT,CAOC,EACD,KAgCC;QAED,OAAO,IAAI,IAAI,CAAkB,GAAG,EAAE;YACpC,MAAM,IAAI,GAAG;gBACX,IAAI,EAAE,MAAe;gBACrB,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,MAAe;gBAC1B,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,EAAE;gBAC9B,GAAG,KAAK;aACT,CAAA;YACD,MAAM,KAAK,GAA4B;gBACrC,WAAW,EAAE,IAAI;gBACjB,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,EAAE;gBACX,IAAI,EAAE,MAAe;gBACrB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,KAAK;gBACf,GAAG,CAAC;gBACJ,IAAI;aACL,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC,EAAE,IAAA,oBAAO,EAAC,mBAAM,CAAC,CAAC,CAAA;IACrB,CAAC;IAED,MAAM,CAAC,WAAW,CAChB,IAoBC;QAED,OAAO,IAAI,IAAI,CAAkB,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAA;YACjD,MAAM,IAAI,GAAG;gBACX,IAAI,EAAE,MAAe;gBACrB,WAAW,EAAE,IAAI;gBACjB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,MAAe;gBAC1B,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,EAAE;gBAC9B,GAAG,KAAK;aACT,CAAA;YACD,MAAM,KAAK,GAA4B;gBACrC,WAAW,EAAE,IAAI;gBACjB,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,EAAE;gBACX,IAAI,EAAE,MAAe;gBACrB,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,KAAK;gBACf,GAAG,CAAC;gBACJ,IAAI;aACL,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC,EAAE,IAAA,oBAAO,EAAC,mBAAM,CAAC,CAAC,CAAA;IACrB,CAAC;IAED,MAAM,CAAC,GAAG,CACR,CAOC,EACD,KAIC;QAED,OAAO,IAAI,IAAI,CAAgB,KAAK,EAAE,OAAO,EAAE,EAAE;YAC/C,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAA;YACrD,MAAM,QAAQ,GAAG,MAAM,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACtD,MAAM,IAAI,GAAG;gBACX,IAAI,EAAE,QAAiB;gBACvB,SAAS,EAAE,IAAI;gBACf,QAAQ,EAAE,IAAI;gBACd,GAAG,QAAQ;gBACX,IAAI,EAAE,QAAQ;aACf,CAAA;YACD,MAAM,KAAK,GAAG;gBACZ,IAAI;gBACJ,OAAO,EAAE,EAAE;gBACX,GAAG,CAAC;aACL,CAAA;YACD,OAAO;gBACL,WAAW,EAAE,IAAI;gBACjB,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,IAAI;gBACf,SAAS,EAAE,IAAI;gBACf,IAAI,EAAE,MAAe;gBACrB,QAAQ,EAAE,KAAK;gBACf,GAAG,KAAK;aACT,CAAA;QACH,CAAC,EAAE,IAAA,oBAAO,EAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;IACnC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS;QACP,OAAO,IAAmC,CAAA;IAC5C,CAAC;CACF;AA1LD,oBA0LC"}

package/base/lib/actions/input/builder/value.d.ts

@@ -0,0 +1,384 @@
+import { InputSpec, LazyBuild } from "./inputSpec";
+import { List } from "./list";
+import { Variants } from "./variants";
+import { FilePath, Pattern, RandomString, ValueSpec, ValueSpecDatetime, ValueSpecText } from "../inputSpecTypes";
+import { DefaultString } from "../inputSpecTypes";
+import { Parser } from "ts-matches";
+export type RequiredDefault<A> = false | {
+    default: A | null;
+};
+type AsRequired<Type, MaybeRequiredType> = MaybeRequiredType extends {
+    default: unknown;
+} | never ? Type : Type | null | undefined;
+export declare class Value<Type, Store> {
+    build: LazyBuild<Store, ValueSpec>;
+    validator: Parser<unknown, Type>;
+    protected constructor(build: LazyBuild<Store, ValueSpec>, validator: Parser<unknown, Type>);
+    static toggle(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        default: boolean;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<boolean, never>;
+    static dynamicToggle<Store = never>(a: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        default: boolean;
+        disabled?: false | string;
+    }>): Value<boolean, Store>;
+    static text<Required extends RequiredDefault<DefaultString>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value.
+         * @type { false | { default: string | RandomString | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: 'World' }
+         * @example required: { default: { charset: 'abcdefg', len: 16 } }
+         */
+        required: Required;
+        /**
+         * @description Mask (aka camouflage) text input with dots: ● ● ●
+         * @default false
+         */
+        masked?: boolean;
+        placeholder?: string | null;
+        minLength?: number | null;
+        maxLength?: number | null;
+        /**
+         * @description A list of regular expressions to which the text must conform to pass validation. A human readable description is provided in case the validation fails.
+         * @default []
+         * @example
+         * ```
+          [
+            {
+              regex: "[a-z]",
+              description: "May only contain lower case letters from the English alphabet."
+            }
+          ]
+         * ```
+         */
+        patterns?: Pattern[];
+        /**
+         * @description Informs the browser how to behave and which keyboard to display on mobile
+         * @default "text"
+         */
+        inputmode?: ValueSpecText["inputmode"];
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+        /**
+         * @description Displays a button that will generate a random string according to the provided charset and len attributes.
+         */
+        generate?: RandomString | null;
+    }): Value<AsRequired<string, Required>, never>;
+    static dynamicText<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: RequiredDefault<DefaultString>;
+        masked?: boolean;
+        placeholder?: string | null;
+        minLength?: number | null;
+        maxLength?: number | null;
+        patterns?: Pattern[];
+        inputmode?: ValueSpecText["inputmode"];
+        disabled?: string | false;
+        generate?: null | RandomString;
+    }>): Value<string | null | undefined, Store>;
+    static textarea(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Unlike other "required" fields, for textarea this is a simple boolean.
+         */
+        required: boolean;
+        minLength?: number | null;
+        maxLength?: number | null;
+        placeholder?: string | null;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<string, never>;
+    static dynamicTextarea<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: boolean;
+        minLength?: number | null;
+        maxLength?: number | null;
+        placeholder?: string | null;
+        disabled?: false | string;
+    }>): Value<string, Store>;
+    static number<Required extends RequiredDefault<number>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value.
+         * @type { false | { default: number | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: 7 }
+         */
+        required: Required;
+        min?: number | null;
+        max?: number | null;
+        /**
+         * @description How much does the number increase/decrease when using the arrows provided by the browser.
+         * @default 1
+         */
+        step?: number | null;
+        /**
+         * @description Requires the number to be an integer.
+         */
+        integer: boolean;
+        /**
+         * @description Optionally display units to the right of the input box.
+         */
+        units?: string | null;
+        placeholder?: string | null;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<AsRequired<number, Required>, never>;
+    static dynamicNumber<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: RequiredDefault<number>;
+        min?: number | null;
+        max?: number | null;
+        step?: number | null;
+        integer: boolean;
+        units?: string | null;
+        placeholder?: string | null;
+        disabled?: false | string;
+    }>): Value<number | null | undefined, Store>;
+    static color<Required extends RequiredDefault<string>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value.
+         * @type { false | { default: string | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: 'ffffff' }
+         */
+        required: Required;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<AsRequired<string, Required>, never>;
+    static dynamicColor<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: RequiredDefault<string>;
+        disabled?: false | string;
+    }>): Value<string | null | undefined, Store>;
+    static datetime<Required extends RequiredDefault<string>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value.
+         * @type { false | { default: string | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: '1985-12-16 18:00:00.000' }
+         */
+        required: Required;
+        /**
+         * @description Informs the browser how to behave and which date/time component to display.
+         * @default "datetime-local"
+         */
+        inputmode?: ValueSpecDatetime["inputmode"];
+        min?: string | null;
+        max?: string | null;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<AsRequired<string, Required>, never>;
+    static dynamicDatetime<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: RequiredDefault<string>;
+        inputmode?: ValueSpecDatetime["inputmode"];
+        min?: string | null;
+        max?: string | null;
+        disabled?: false | string;
+    }>): Value<string | null | undefined, Store>;
+    static select<Required extends RequiredDefault<string>, Values extends Record<string, string>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value from the list of values.
+         * @type { false | { default: string | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: 'radio1' }
+         */
+        required: Required;
+        /**
+         * @description A mapping of unique radio options to their human readable display format.
+         * @example
+         * ```
+          {
+            radio1: "Radio 1"
+            radio2: "Radio 2"
+            radio3: "Radio 3"
+          }
+         * ```
+         */
+        values: Values;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<AsRequired<keyof Values, Required>, never>;
+    static dynamicSelect<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: RequiredDefault<string>;
+        values: Record<string, string>;
+        disabled?: false | string | string[];
+    }>): Value<string | null | undefined, Store>;
+    static multiselect<Values extends Record<string, string>>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description A simple list of which options should be checked by default.
+         */
+        default: string[];
+        /**
+         * @description A mapping of checkbox options to their human readable display format.
+         * @example
+         * ```
+          {
+            option1: "Option 1"
+            option2: "Option 2"
+            option3: "Option 3"
+          }
+         * ```
+         */
+        values: Values;
+        minLength?: number | null;
+        maxLength?: number | null;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }): Value<(keyof Values)[], never>;
+    static dynamicMultiselect<Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        default: string[];
+        values: Record<string, string>;
+        minLength?: number | null;
+        maxLength?: number | null;
+        disabled?: false | string | string[];
+    }>): Value<string[], Store>;
+    static object<Type extends Record<string, any>, Store>(a: {
+        name: string;
+        description?: string | null;
+    }, spec: InputSpec<Type, Store>): Value<Type, Store>;
+    static file<Store>(a: {
+        name: string;
+        description?: string | null;
+        extensions: string[];
+        required: boolean;
+    }): Value<FilePath, Store>;
+    static dynamicFile<Required extends boolean, Store>(a: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        extensions: string[];
+        required: Required;
+    }>): Value<string | null | undefined, Store>;
+    static union<Required extends RequiredDefault<string>, Type, Store>(a: {
+        name: string;
+        description?: string | null;
+        /** Presents a warning prompt before permitting the value to change. */
+        warning?: string | null;
+        /**
+         * @description Determines if the field is required. If so, optionally provide a default value from the list of variants.
+         * @type { false | { default: string | null } }
+         * @example required: false
+         * @example required: { default: null }
+         * @example required: { default: 'variant1' }
+         */
+        required: Required;
+        /**
+         * @description Once set, the value can never be changed.
+         * @default false
+         */
+        immutable?: boolean;
+    }, aVariants: Variants<Type, Store>): Value<AsRequired<Type, Required>, Store>;
+    static filteredUnion<Required extends RequiredDefault<string>, Type extends Record<string, any>, Store = never>(getDisabledFn: LazyBuild<Store, string[] | false | string>, a: {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: Required;
+    }, aVariants: Variants<Type, Store> | Variants<Type, never>): Value<AsRequired<Type, Required>, Store>;
+    static dynamicUnion<Required extends RequiredDefault<string>, Type extends Record<string, any>, Store = never>(getA: LazyBuild<Store, {
+        name: string;
+        description?: string | null;
+        warning?: string | null;
+        required: Required;
+        disabled: string[] | false | string;
+    }>, aVariants: Variants<Type, Store> | Variants<Type, never>): Value<Type | null | undefined, Store>;
+    static list<Type, Store>(a: List<Type, Store>): Value<Type, Store>;
+    static hidden<T>(parser?: Parser<unknown, T>): Value<T, never>;
+    /**
+     * Use this during the times that the input needs a more specific type.
+     * Used in types that the value/ variant/ list/ inputSpec is constructed somewhere else.
+    ```ts
+    const a = InputSpec.text({
+      name: "a",
+      required: false,
+    })
+  
+    return InputSpec.of<Store>()({
+      myValue: a.withStore(),
+    })
+    ```
+     */
+    withStore<NewStore extends Store extends never ? any : Store>(): Value<Type, NewStore>;
+}
+export {};