rename things and add new value spec types

This commit is contained in:
Matt Hill
2023-04-20 12:40:05 -06:00
parent e279711f8e
commit ce1c383944
11 changed files with 269 additions and 145 deletions

View File

@@ -2,8 +2,8 @@ import { BuilderExtract, IBuilder } from "./builder";
import { Config } from "./config"; import { Config } from "./config";
import { import {
InputSpec, InputSpec,
ListValueSpecNumber, ListValueSpecText,
ListValueSpecString, Pattern,
UniqueBy, UniqueBy,
ValueSpecList, ValueSpecList,
} from "../configTypes"; } from "../configTypes";
@@ -22,31 +22,33 @@ export const auth = Value.list(authorizationList);
``` ```
*/ */
export class List<A extends ValueSpecList> extends IBuilder<A> { export class List<A extends ValueSpecList> extends IBuilder<A> {
static string( static text(
a: { a: {
name: string; name: string;
description?: string | null; description?: string | null;
warning?: string | null; warning?: string | null;
/** Default = [] */ /** Default = [] */
default?: string[]; default?: string[];
/** Default = "(\*,\*)" */ /** Default = 0 */
range?: string; minLength?: number | null;
maxLength?: number | null;
}, },
aSpec: { aSpec: {
/** Default = false */ /** Default = false */
masked?: boolean; masked?: boolean;
placeholder?: string | null; placeholder?: string | null;
pattern?: string | null; minLength?: number | null;
patternDescription?: string | null; maxLength?: number | null;
patterns: Pattern[];
/** Default = "text" */ /** Default = "text" */
inputmode?: ListValueSpecString["inputmode"]; inputmode?: ListValueSpecText["inputmode"];
}, },
) { ) {
const spec = { const spec = {
type: "string" as const, type: "text" as const,
placeholder: null, placeholder: null,
pattern: null, minLength: null,
patternDescription: null, maxLength: null,
masked: false, masked: false,
inputmode: "text" as const, inputmode: "text" as const,
...aSpec, ...aSpec,
@@ -56,7 +58,8 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
warning: null, warning: null,
default: [], default: [],
type: "list" as const, type: "list" as const,
range: "(*,*)", minLength: 0,
maxLength: null,
...a, ...a,
spec, spec,
}); });
@@ -68,13 +71,15 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
warning?: string | null; warning?: string | null;
/** Default = [] */ /** Default = [] */
default?: string[]; default?: string[];
/** Default = "(\*,\*)" */ /** Default = 0 */
range?: string; minLength?: number | null;
maxLength?: number | null;
}, },
aSpec: { aSpec: {
integral: boolean; integer: boolean;
/** Default = "(\*,\*)" */ min?: number | null;
range?: string; max?: number | null;
step?: string | null;
units?: string | null; units?: string | null;
placeholder?: string | null; placeholder?: string | null;
}, },
@@ -82,15 +87,17 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
const spec = { const spec = {
type: "number" as const, type: "number" as const,
placeholder: null, placeholder: null,
range: "(*,*)", min: null,
max: null,
step: null,
units: null, units: null,
...aSpec, ...aSpec,
}; };
return new List({ return new List({
description: null, description: null,
warning: null, warning: null,
units: null, minLength: 0,
range: "(*,*)", maxLength: null,
default: [], default: [],
type: "list" as const, type: "list" as const,
...a, ...a,
@@ -104,8 +111,9 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
warning?: string | null; warning?: string | null;
/** Default [] */ /** Default [] */
default?: []; default?: [];
/** Default = "(\*,\*)" */ /** Default = 0 */
range?: string; minLength?: number | null;
maxLength?: number | null;
}, },
aSpec: { aSpec: {
spec: Spec; spec: Spec;
@@ -130,7 +138,8 @@ export class List<A extends ValueSpecList> extends IBuilder<A> {
return new List({ return new List({
description: null, description: null,
warning: null, warning: null,
range: "(*,*)", minLength: 0,
maxLength: null,
type: "list" as const, type: "list" as const,
...value, ...value,
}); });

View File

@@ -4,10 +4,13 @@ import { List } from "./list";
import { Variants } from "./variants"; import { Variants } from "./variants";
import { import {
InputSpec, InputSpec,
ListValueSpecString, Pattern,
ValueSpec, ValueSpec,
ValueSpecColor,
ValueSpecDatetime,
ValueSpecList, ValueSpecList,
ValueSpecNumber, ValueSpecNumber,
ValueSpecText,
ValueSpecTextarea, ValueSpecTextarea,
} from "../configTypes"; } from "../configTypes";
import { guardAll } from "../../util"; import { guardAll } from "../../util";
@@ -35,7 +38,7 @@ const username = Value.string({
``` ```
*/ */
export class Value<A extends ValueSpec> extends IBuilder<A> { export class Value<A extends ValueSpec> extends IBuilder<A> {
static boolean(a: { static toggle(a: {
name: string; name: string;
description?: string | null; description?: string | null;
warning?: string | null; warning?: string | null;
@@ -45,11 +48,11 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
description: null, description: null,
warning: null, warning: null,
default: null, default: null,
type: "boolean" as const, type: "toggle" as const,
...a, ...a,
}); });
} }
static string(a: { static text(a: {
name: string; name: string;
description?: string | null; description?: string | null;
warning?: string | null; warning?: string | null;
@@ -58,20 +61,22 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
/** Default = false */ /** Default = false */
masked?: boolean; masked?: boolean;
placeholder?: string | null; placeholder?: string | null;
pattern?: string | null; minLength?: number | null;
patternDescription?: string | null; maxLength?: number | null;
patterns?: Pattern[];
/** Default = 'text' */ /** Default = 'text' */
inputmode?: ListValueSpecString["inputmode"]; inputmode?: ValueSpecText["inputmode"];
}) { }) {
return new Value({ return new Value({
type: "string" as const, type: "text" as const,
default: null, default: null,
description: null, description: null,
warning: null, warning: null,
masked: false, masked: false,
placeholder: null, placeholder: null,
pattern: null, minLength: null,
patternDescription: null, maxLength: null,
patterns: [],
inputmode: "text", inputmode: "text",
...a, ...a,
}); });
@@ -81,11 +86,15 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
description?: string | null; description?: string | null;
warning?: string | null; warning?: string | null;
required: boolean; required: boolean;
minLength?: number | null;
maxLength?: number | null;
placeholder?: string | null; placeholder?: string | null;
}) { }) {
return new Value({ return new Value({
description: null, description: null,
warning: null, warning: null,
minLength: null,
maxLength: null,
placeholder: null, placeholder: null,
type: "textarea" as const, type: "textarea" as const,
...a, ...a,
@@ -97,9 +106,11 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
warning?: string | null; warning?: string | null;
required: boolean; required: boolean;
default?: number | null; default?: number | null;
/** default = "(\*,\*)" */ min?: number | null;
range?: string; max?: number | null;
integral: boolean; /** Default = '1' */
step?: string | null;
integer: boolean;
units?: string | null; units?: string | null;
placeholder?: string | null; placeholder?: string | null;
}) { }) {
@@ -108,12 +119,53 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
description: null, description: null,
warning: null, warning: null,
default: null, default: null,
range: "(*,*)", min: null,
max: null,
step: null,
units: null, units: null,
placeholder: null, placeholder: null,
...a, ...a,
} as ValueSpecNumber); } as ValueSpecNumber);
} }
static color(a: {
name: string;
description?: string | null;
warning?: string | null;
required: boolean;
default?: number | null;
}) {
return new Value({
type: "color" as const,
description: null,
warning: null,
default: null,
...a,
} as ValueSpecColor);
}
static datetime(a: {
name: string;
description?: string | null;
warning?: string | null;
required: boolean;
/** Default = 'datetime-local' */
inputMode?: ValueSpecDatetime['inputMode']
min?: string | null
max?: string | null
step?: string | null
default?: number | null;
}) {
return new Value({
type: "datetime" as const,
description: null,
warning: null,
inputMode: 'datetime-local',
min: null,
max: null,
step: null,
default: null,
...a,
} as ValueSpecDatetime);
}
static select<B extends Record<string, string>>(a: { static select<B extends Record<string, string>>(a: {
name: string; name: string;
description?: string | null; description?: string | null;
@@ -134,16 +186,16 @@ export class Value<A extends ValueSpec> extends IBuilder<A> {
name: string; name: string;
description?: string | null; description?: string | null;
warning?: string | null; warning?: string | null;
default?: string[]; default: string[];
values: Values; values: Values;
/** default = "(\*,\*)" */ minLength?: number | null;
range?: string; maxLength?: number | null;
}) { }) {
return new Value({ return new Value({
type: "multiselect" as const, type: "multiselect" as const,
range: "(*,*)", minLength: null,
maxLength: null,
warning: null, warning: null,
default: [],
description: null, description: null,
...a, ...a,
}); });

View File

@@ -1,9 +1,11 @@
export type InputSpec = Record<string, ValueSpec>; export type InputSpec = Record<string, ValueSpec>;
export type ValueType = export type ValueType =
| "string" | "text"
| "textarea" | "textarea"
| "number" | "number"
| "boolean" | "color"
| "datetime"
| "toggle"
| "select" | "select"
| "multiselect" | "multiselect"
| "list" | "list"
@@ -12,14 +14,18 @@ export type ValueType =
| "union"; | "union";
export type ValueSpec = ValueSpecOf<ValueType>; export type ValueSpec = ValueSpecOf<ValueType>;
/** core spec types. These types provide the metadata for performing validations */ /** core spec types. These types provide the metadata for performing validations */
export type ValueSpecOf<T extends ValueType> = T extends "string" export type ValueSpecOf<T extends ValueType> = T extends "text"
? ValueSpecString ? ValueSpecText
: T extends "number"
? ValueSpecTextarea
: T extends "textarea" : T extends "textarea"
? ValueSpecTextarea
: T extends "number"
? ValueSpecNumber ? ValueSpecNumber
: T extends "boolean" : T extends "color"
? ValueSpecBoolean ? ValueSpecColor
: T extends "datetime"
? ValueSpecDatetime
: T extends "toggle"
? ValueSpecToggle
: T extends "select" : T extends "select"
? ValueSpecSelect ? ValueSpecSelect
: T extends "multiselect" : T extends "multiselect"
@@ -34,19 +40,35 @@ export type ValueSpecOf<T extends ValueType> = T extends "string"
? ValueSpecUnion ? ValueSpecUnion
: never; : never;
export interface ValueSpecString extends ListValueSpecString, WithStandalone { export interface ValueSpecText extends ListValueSpecText, WithStandalone {
required: boolean; required: boolean;
default: DefaultString | null; default: DefaultString | null;
} }
export interface ValueSpecTextarea extends WithStandalone { export interface ValueSpecTextarea extends WithStandalone {
type: "textarea"; type: "textarea";
placeholder: string | null; placeholder: string | null;
minLength: number | null;
maxLength: number | null;
required: boolean; required: boolean;
} }
export interface ValueSpecNumber extends ListValueSpecNumber, WithStandalone { export interface ValueSpecNumber extends ListValueSpecNumber, WithStandalone {
required: boolean; required: boolean;
default: number | null; default: number | null;
} }
export interface ValueSpecColor extends WithStandalone {
type: "color"
required: boolean;
default: string | null;
}
export interface ValueSpecDatetime extends WithStandalone {
type: "datetime"
required: boolean;
inputMode: 'date' | 'time' | 'datetime-local'
min: string | null
max: string | null
step: string | null
default: string | null;
}
export interface ValueSpecSelect extends SelectBase, WithStandalone { export interface ValueSpecSelect extends SelectBase, WithStandalone {
type: "select"; type: "select";
required: boolean; required: boolean;
@@ -54,12 +76,12 @@ export interface ValueSpecSelect extends SelectBase, WithStandalone {
} }
export interface ValueSpecMultiselect extends SelectBase, WithStandalone { export interface ValueSpecMultiselect extends SelectBase, WithStandalone {
type: "multiselect"; type: "multiselect";
/**'[0,1]' (inclusive) OR '[0,*)' (right unbounded), normal math rules */ minLength: number | null;
range: string; maxLength: number | null;
default: string[]; default: string[];
} }
export interface ValueSpecBoolean extends WithStandalone { export interface ValueSpecToggle extends WithStandalone {
type: "boolean"; type: "toggle";
default: boolean | null; default: boolean | null;
} }
export interface ValueSpecUnion extends WithStandalone { export interface ValueSpecUnion extends WithStandalone {
@@ -91,10 +113,10 @@ export interface WithStandalone {
export interface SelectBase { export interface SelectBase {
values: Record<string, string>; values: Record<string, string>;
} }
export type ListValueSpecType = "string" | "number" | "object"; export type ListValueSpecType = "text" | "number" | "object";
/** represents a spec for the values of a list */ /** represents a spec for the values of a list */
export type ListValueSpecOf<T extends ListValueSpecType> = T extends "string" export type ListValueSpecOf<T extends ListValueSpecType> = T extends "text"
? ListValueSpecString ? ListValueSpecText
: T extends "number" : T extends "number"
? ListValueSpecNumber ? ListValueSpecNumber
: T extends "object" : T extends "object"
@@ -106,7 +128,8 @@ export interface ValueSpecListOf<T extends ListValueSpecType>
extends WithStandalone { extends WithStandalone {
type: "list"; type: "list";
spec: ListValueSpecOf<T>; spec: ListValueSpecOf<T>;
range: string; minLength: number | null;
maxLength: number | null;
default: default:
| string[] | string[]
| number[] | number[]
@@ -117,18 +140,25 @@ export interface ValueSpecListOf<T extends ListValueSpecType>
| readonly DefaultString[] | readonly DefaultString[]
| readonly Record<string, unknown>[]; | readonly Record<string, unknown>[];
} }
export interface ListValueSpecString { export interface Pattern {
type: "string"; regex: string
pattern: string | null; description: string
patternDescription: string | null; }
export interface ListValueSpecText {
type: "text";
patterns: Pattern[]
minLength: number | null
maxLength: number | null
masked: boolean; masked: boolean;
inputmode: "text" | "email" | "tel" | "url"; inputmode: "text" | "email" | "tel" | "url";
placeholder: string | null; placeholder: string | null;
} }
export interface ListValueSpecNumber { export interface ListValueSpecNumber {
type: "number"; type: "number";
range: string; min: number | null;
integral: boolean; max: number | null;
integer: boolean;
step: string | null;
units: string | null; units: string | null;
placeholder: string | null; placeholder: string | null;
} }

View File

@@ -2,7 +2,6 @@ import { Config } from "./builder";
import { import {
DeepPartial, DeepPartial,
Dependencies, Dependencies,
DependsOn,
Effects, Effects,
ExpectedExports, ExpectedExports,
} from "../types"; } from "../types";

View File

@@ -50,10 +50,12 @@ export async function specToBuilder(
} }
function convertValueSpec(value: C.ValueSpec): string { function convertValueSpec(value: C.ValueSpec): string {
switch (value.type) { switch (value.type) {
case "string": case "text":
case "textarea": case "textarea":
case "number": case "number":
case "boolean": case "color":
case "datetime":
case "toggle":
case "select": case "select":
case "multiselect": { case "multiselect": {
const { type, ...rest } = value; const { type, ...rest } = value;
@@ -91,11 +93,12 @@ export async function specToBuilder(
function convertList(valueSpecList: C.ValueSpecList) { function convertList(valueSpecList: C.ValueSpecList) {
const { spec, ...value } = valueSpecList; const { spec, ...value } = valueSpecList;
switch (spec.type) { switch (spec.type) {
case "string": { case "text": {
return `List.string(${JSON.stringify( return `List.text(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
range: value.range || null, minLength: value.minLength || null,
maxLength: value.maxLength || null,
default: value.default || null, default: value.default || null,
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
@@ -105,16 +108,16 @@ export async function specToBuilder(
)}, ${JSON.stringify({ )}, ${JSON.stringify({
masked: spec?.masked || false, masked: spec?.masked || false,
placeholder: spec?.placeholder || null, placeholder: spec?.placeholder || null,
pattern: spec?.pattern || null, pattern: spec?.patterns || [],
patternDescription: spec?.patternDescription || null, inputMode: spec?.inputmode || 'text',
inputMode: spec?.inputmode || null,
})})`; })})`;
} }
case "number": { case "number": {
return `List.number(${JSON.stringify( return `List.number(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
range: value.range || null, minLength: value.minLength || null,
maxLength: value.maxLength || null,
default: value.default || null, default: value.default || null,
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
@@ -122,8 +125,10 @@ export async function specToBuilder(
null, null,
2, 2,
)}, ${JSON.stringify({ )}, ${JSON.stringify({
range: spec?.range || null, integer: spec?.integer || false,
integral: spec?.integral || false, min: spec?.min || null,
max: spec?.max || null,
step: spec?.step || null,
units: spec?.units || null, units: spec?.units || null,
placeholder: spec?.placeholder || null, placeholder: spec?.placeholder || null,
})})`; })})`;
@@ -135,7 +140,8 @@ export async function specToBuilder(
); );
return `List.obj({ return `List.obj({
name: ${JSON.stringify(value.name || null)}, name: ${JSON.stringify(value.name || null)},
range: ${JSON.stringify(value.range || null)}, minLength: ${JSON.stringify(value.minLength || null)},
maxLength: ${JSON.stringify(value.maxLength || null)},
default: ${JSON.stringify(value.default || null)}, default: ${JSON.stringify(value.default || null)},
description: ${JSON.stringify(value.description || null)}, description: ${JSON.stringify(value.description || null)},
warning: ${JSON.stringify(value.warning || null)}, warning: ${JSON.stringify(value.warning || null)},

View File

@@ -3,40 +3,41 @@ import { Config } from "../config/builder/config";
import { List } from "../config/builder/list"; import { List } from "../config/builder/list";
import { Value } from "../config/builder/value"; import { Value } from "../config/builder/value";
import { Variants } from "../config/builder/variants"; import { Variants } from "../config/builder/variants";
import { Parser } from "ts-matches";
describe("builder tests", () => { describe("builder tests", () => {
test("String", () => { test("text", () => {
const bitcoinPropertiesBuilt: { const bitcoinPropertiesBuilt: {
"peer-tor-address": { "peer-tor-address": {
name: string; name: string;
description: string | null; description: string | null;
type: "string"; type: "text";
}; };
} = Config.of({ } = Config.of({
"peer-tor-address": Value.string({ "peer-tor-address": Value.text({
name: "Peer tor address", name: "Peer tor address",
default: "", default: null,
description: "The Tor address of the peer interface", description: "The Tor address of the peer interface",
warning: null, warning: null,
required: true, required: true,
masked: true, masked: true,
placeholder: null, placeholder: null,
pattern: null, minLength: null,
patternDescription: null, maxLength: null,
patterns: [],
}), }),
}).build(); }).build();
expect(JSON.stringify(bitcoinPropertiesBuilt)).toEqual( expect(JSON.stringify(bitcoinPropertiesBuilt)).toEqual(
/*json*/ `{ /*json*/ `{
"peer-tor-address": { "peer-tor-address": {
"type": "string", "type": "text",
"default": "", "default": null,
"description": "The Tor address of the peer interface", "description": "The Tor address of the peer interface",
"warning": null, "warning": null,
"masked": true, "masked": true,
"placeholder": null, "placeholder": null,
"pattern": null, "minLength": null,
"patternDescription": null, "maxLength": null,
"patterns": [],
"inputmode":"text", "inputmode":"text",
"name": "Peer tor address", "name": "Peer tor address",
"required": true "required": true
@@ -49,16 +50,16 @@ describe("builder tests", () => {
}); });
describe("values", () => { describe("values", () => {
test("boolean", () => { test("toggle", () => {
const value = Value.boolean({ const value = Value.toggle({
name: "Testing", name: "Testing",
}); });
const validator = value.validator(); const validator = value.validator();
validator.unsafeCast(false); validator.unsafeCast(false);
testOutput<typeof validator._TYPE, boolean>()(null); testOutput<typeof validator._TYPE, boolean>()(null);
}); });
test("string", () => { test("text", () => {
const value = Value.string({ const value = Value.text({
name: "Testing", name: "Testing",
required: false, required: false,
}); });
@@ -79,7 +80,7 @@ describe("values", () => {
const value = Value.number({ const value = Value.number({
name: "Testing", name: "Testing",
required: false, required: false,
integral: false, integer: false,
}); });
const validator = value.validator(); const validator = value.validator();
validator.unsafeCast(2); validator.unsafeCast(2);
@@ -106,6 +107,7 @@ describe("values", () => {
a: "A", a: "A",
b: "B", b: "B",
}, },
default: [],
}); });
const validator = value.validator(); const validator = value.validator();
validator.unsafeCast([]); validator.unsafeCast([]);
@@ -118,7 +120,7 @@ describe("values", () => {
name: "Testing", name: "Testing",
}, },
Config.of({ Config.of({
a: Value.boolean({ a: Value.toggle({
name: "test", name: "test",
}), }),
}), }),
@@ -136,7 +138,7 @@ describe("values", () => {
Variants.of({ Variants.of({
a: { a: {
name: "a", name: "a",
spec: Config.of({ b: Value.boolean({ name: "b" }) }), spec: Config.of({ b: Value.toggle({ name: "b" }) }),
}, },
}), }),
); );
@@ -155,7 +157,7 @@ describe("values", () => {
name: "test", name: "test",
}, },
{ {
integral: false, integer: false,
}, },
), ),
); );
@@ -173,7 +175,7 @@ describe("Builder List", () => {
name: "test", name: "test",
}, },
{ {
spec: Config.of({ test: Value.boolean({ name: "test" }) }), spec: Config.of({ test: Value.toggle({ name: "test" }) }),
}, },
), ),
); );
@@ -181,13 +183,15 @@ describe("Builder List", () => {
validator.unsafeCast([{ test: true }]); validator.unsafeCast([{ test: true }]);
testOutput<typeof validator._TYPE, { test: boolean }[]>()(null); testOutput<typeof validator._TYPE, { test: boolean }[]>()(null);
}); });
test("string", () => { test("text", () => {
const value = Value.list( const value = Value.list(
List.string( List.text(
{ {
name: "test", name: "test",
}, },
{}, {
patterns: [],
},
), ),
); );
const validator = value.validator(); const validator = value.validator();
@@ -200,7 +204,7 @@ describe("Builder List", () => {
{ {
name: "test", name: "test",
}, },
{ integral: true }, { integer: true },
), ),
); );
const validator = value.validator(); const validator = value.validator();

View File

@@ -1,6 +1,5 @@
import { import {
ListValueSpecOf, ListValueSpecOf,
ValueSpecList,
isValueSpecListOf, isValueSpecListOf,
} from "../config/configTypes"; } from "../config/configTypes";
import { Config } from "../config/builder/config"; import { Config } from "../config/builder/config";
@@ -9,12 +8,12 @@ import { Value } from "../config/builder/value";
describe("Config Types", () => { describe("Config Types", () => {
test("isValueSpecListOf", () => { test("isValueSpecListOf", () => {
const options = [List.obj, List.string, List.number]; const options = [List.obj, List.text, List.number];
for (const option of options) { for (const option of options) {
const test = option({} as any, { spec: Config.of({}) } as any) as any; const test = option({} as any, { spec: Config.of({}) } as any) as any;
const someList = Value.list(test).build(); const someList = Value.list(test).build();
if (isValueSpecListOf(someList, "string")) { if (isValueSpecListOf(someList, "text")) {
someList.spec satisfies ListValueSpecOf<"string">; someList.spec satisfies ListValueSpecOf<"text">;
} else if (isValueSpecListOf(someList, "number")) { } else if (isValueSpecListOf(someList, "number")) {
someList.spec satisfies ListValueSpecOf<"number">; someList.spec satisfies ListValueSpecOf<"number">;
} else if (isValueSpecListOf(someList, "object")) { } else if (isValueSpecListOf(someList, "object")) {

View File

@@ -1,4 +1,3 @@
import { Parser } from "ts-matches";
import { import {
UnionSelectKey, UnionSelectKey,
unionSelectKey, unionSelectKey,

View File

@@ -1,4 +1,4 @@
import { Parser, string } from "ts-matches"; import { Parser } from "ts-matches";
import * as T from "../types"; import * as T from "../types";
import FileHelper from "./fileHelper"; import FileHelper from "./fileHelper";
import nullIfEmpty from "./nullIfEmpty"; import nullIfEmpty from "./nullIfEmpty";

View File

@@ -19,14 +19,16 @@ const {
boolean, boolean,
} = matches; } = matches;
type TypeBoolean = "boolean"; type TypeToggle = "toggle";
type TypeString = "string"; type TypeText = "text";
type TypeTextarea = "textarea"; type TypeTextarea = "textarea";
type TypeNumber = "number"; type TypeNumber = "number";
type TypeObject = "object"; type TypeObject = "object";
type TypeList = "list"; type TypeList = "list";
type TypeSelect = "select"; type TypeSelect = "select";
type TypeMultiselect = "multiselect"; type TypeMultiselect = "multiselect";
type TypeColor = "color";
type TypeDatetime = "datetime";
type TypeUnion = "union"; type TypeUnion = "union";
// prettier-ignore // prettier-ignore
@@ -41,19 +43,17 @@ type GuardNumber<A> =
A extends { type: TypeNumber } ? GuardDefaultRequired<A, number> : A extends { type: TypeNumber } ? GuardDefaultRequired<A, number> :
unknown unknown
// prettier-ignore // prettier-ignore
type GuardString<A> = type GuardText<A> =
A extends { type: TypeString } ? GuardDefaultRequired<A, string> : A extends { type: TypeText } ? GuardDefaultRequired<A, string> :
unknown unknown
// prettier-ignore // prettier-ignore
type GuardTextarea<A> = type GuardTextarea<A> =
A extends { type: TypeTextarea } ? GuardDefaultRequired<A, string> : A extends { type: TypeTextarea } ? GuardDefaultRequired<A, string> :
unknown unknown
// prettier-ignore // prettier-ignore
type GuardBoolean<A> = type GuardToggle<A> =
A extends { type: TypeBoolean } ? GuardDefaultRequired<A, boolean> : A extends { type: TypeToggle } ? GuardDefaultRequired<A, boolean> :
unknown unknown
// prettier-ignore // prettier-ignore
type GuardObject<A> = type GuardObject<A> =
A extends { type: TypeObject, spec: infer B } ? ( A extends { type: TypeObject, spec: infer B } ? (
@@ -72,11 +72,18 @@ type GuardSelect<A> =
B extends Record<string, string> ? keyof B : never B extends Record<string, string> ? keyof B : never
) : ) :
unknown unknown
// prettier-ignore // prettier-ignore
type GuardMultiselect<A> = type GuardMultiselect<A> =
A extends { type: TypeMultiselect, values: infer B} ?(keyof B)[] : A extends { type: TypeMultiselect, values: infer B} ?(keyof B)[] :
unknown unknown
// prettier-ignore
type GuardColor<A> =
A extends { type: TypeColor } ? GuardDefaultRequired<A, string> :
unknown
// prettier-ignore
type GuardDatetime<A> =
A extends { type: TypeDatetime } ? GuardDefaultRequired<A, string> :
unknown
// prettier-ignore // prettier-ignore
type VariantValue<A> = type VariantValue<A> =
@@ -91,14 +98,16 @@ type GuardUnion<A> =
type _<T> = T; type _<T> = T;
export type GuardAll<A> = GuardNumber<A> & export type GuardAll<A> = GuardNumber<A> &
GuardString<A> & GuardText<A> &
GuardTextarea<A> & GuardTextarea<A> &
GuardBoolean<A> & GuardToggle<A> &
GuardObject<A> & GuardObject<A> &
GuardList<A> & GuardList<A> &
GuardUnion<A> & GuardUnion<A> &
GuardSelect<A> & GuardSelect<A> &
GuardMultiselect<A>; GuardMultiselect<A> &
GuardColor<A> &
GuardDatetime<A>;
// prettier-ignore // prettier-ignore
export type TypeFromProps<A> = export type TypeFromProps<A> =
A extends Record<string, unknown> ? { [K in keyof A & string]: _<GuardAll<A[K]>> } : A extends Record<string, unknown> ? { [K in keyof A & string]: _<GuardAll<A[K]>> } :
@@ -114,7 +123,7 @@ const matchDefault = object({ default: unknown });
const matchRequired = object({ required: literals(false) }); const matchRequired = object({ required: literals(false) });
const rangeRegex = /(\[|\()(\*|(\d|\.)+),(\*|(\d|\.)+)(\]|\))/; const rangeRegex = /(\[|\()(\*|(\d|\.)+),(\*|(\d|\.)+)(\]|\))/;
const matchRange = object({ range: string }); const matchRange = object({ range: string });
const matchIntegral = object({ integral: literals(true) }); const matchInteger = object({ integer: literals(true) });
const matchSpec = object({ spec: recordString }); const matchSpec = object({ spec: recordString });
const matchUnion = object({ const matchUnion = object({
variants: dictionary([string, matchVariant]), variants: dictionary([string, matchVariant]),
@@ -199,8 +208,8 @@ export function matchNumberWithRange(range: string) {
`lessThan${rightValue}`, `lessThan${rightValue}`,
); );
} }
function withIntegral(parser: Parser<unknown, number>, value: unknown) { function withInteger(parser: Parser<unknown, number>, value: unknown) {
if (matchIntegral.test(value)) { if (matchInteger.test(value)) {
return parser.validate(Number.isInteger, "isIntegral"); return parser.validate(Number.isInteger, "isIntegral");
} }
return parser; return parser;
@@ -243,18 +252,24 @@ export function guardAll<A extends ValueSpecAny>(
return unknown as any; return unknown as any;
} }
switch (value.type) { switch (value.type) {
case "boolean": case "toggle":
return defaultRequired(boolean, value) as any; return defaultRequired(boolean, value) as any;
case "string": case "text":
return defaultRequired(string, value) as any; return defaultRequired(string, value) as any;
case "textarea": case "textarea":
return defaultRequired(string, value) as any; return defaultRequired(string, value) as any;
case "color":
return defaultRequired(string, value) as any;
case "datetime":
return defaultRequired(string, value) as any;
case "number": case "number":
return defaultRequired( return defaultRequired(
withIntegral(withRange(value), value), withInteger(withRange(value), value),
value, value,
) as any; ) as any;

View File

@@ -1,7 +1,6 @@
import camelCase from "lodash/camelCase"; import camelCase from "lodash/camelCase";
import * as fs from "fs"; import * as fs from "fs";
import { string } from "ts-matches"; import { string } from "ts-matches";
import { unionSelectKey } from "../lib/config/configTypes";
export async function writeConvertedFile( export async function writeConvertedFile(
file: string, file: string,
@@ -65,7 +64,7 @@ export default async function makeFileContent(
2, 2,
)})`; )})`;
} }
return `Value.string(${JSON.stringify( return `Value.text(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
default: value.default || null, default: value.default || null,
@@ -74,8 +73,11 @@ export default async function makeFileContent(
required: !(value.nullable || false), required: !(value.nullable || false),
masked: value.masked || false, masked: value.masked || false,
placeholder: value.placeholder || null, placeholder: value.placeholder || null,
pattern: value.pattern || null, patterns: value.pattern ?
patternDescription: value["pattern-description"] || null, [{ regex: value.pattern, description: value["pattern-description"] }] :
[],
minLength: null,
maxLength: null,
}, },
null, null,
2, 2,
@@ -89,8 +91,10 @@ export default async function makeFileContent(
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
required: !(value.nullable || false), required: !(value.nullable || false),
range: value.range || null, min: null,
integral: value.integral || false, max: null,
step: null,
integer: value.integral || false,
units: value.units || null, units: value.units || null,
placeholder: value.placeholder || null, placeholder: value.placeholder || null,
}, },
@@ -99,7 +103,7 @@ export default async function makeFileContent(
)})`; )})`;
} }
case "boolean": { case "boolean": {
return `Value.boolean(${JSON.stringify( return `Value.toggle(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
default: value.default || false, default: value.default || false,
@@ -172,12 +176,11 @@ export default async function makeFileContent(
function convertList(value: any) { function convertList(value: any) {
switch (value.subtype) { switch (value.subtype) {
case "string": { case "string": {
return `List.${ return `List.text(${JSON.stringify(
value?.spec?.textarea === true ? "textarea" : "string"
}(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
range: value.range || null, minLength: null,
maxLength: null,
default: value.default || null, default: value.default || null,
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
@@ -187,15 +190,19 @@ export default async function makeFileContent(
)}, ${JSON.stringify({ )}, ${JSON.stringify({
masked: value?.spec?.masked || false, masked: value?.spec?.masked || false,
placeholder: value?.spec?.placeholder || null, placeholder: value?.spec?.placeholder || null,
pattern: value?.spec?.pattern || null, patterns: value?.spec?.pattern ?
patternDescription: value?.spec?.["pattern-description"] || null, [{ regex: value.spec.pattern, description: value?.spec?.["pattern-description"] }] :
[],
minLength: null,
maxLength: null,
})})`; })})`;
} }
case "number": { case "number": {
return `List.number(${JSON.stringify( return `List.number(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
range: value.range || null, minLength: null,
maxLength: null,
default: value.default || null, default: value.default || null,
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
@@ -203,8 +210,9 @@ export default async function makeFileContent(
null, null,
2, 2,
)}, ${JSON.stringify({ )}, ${JSON.stringify({
range: value?.spec?.range || null, integer: value?.spec?.integral || false,
integral: value?.spec?.integral || false, min: null,
max: null,
units: value?.spec?.units || null, units: value?.spec?.units || null,
placeholder: value?.spec?.placeholder || null, placeholder: value?.spec?.placeholder || null,
})})`; })})`;
@@ -225,7 +233,8 @@ export default async function makeFileContent(
return `Value.multiselect(${JSON.stringify( return `Value.multiselect(${JSON.stringify(
{ {
name: value.name || null, name: value.name || null,
range: value.range || null, minLength: null,
maxLength: null,
default: value.default || null, default: value.default || null,
description: value.description || null, description: value.description || null,
warning: value.warning || null, warning: value.warning || null,
@@ -242,7 +251,8 @@ export default async function makeFileContent(
); );
return `List.obj({ return `List.obj({
name: ${JSON.stringify(value.name || null)}, name: ${JSON.stringify(value.name || null)},
range: ${JSON.stringify(value.range || null)}, minLength: ${JSON.stringify(null)},
maxLength: ${JSON.stringify(null)},
default: ${JSON.stringify(value.default || null)}, default: ${JSON.stringify(value.default || null)},
description: ${JSON.stringify(value.description || null)}, description: ${JSON.stringify(value.description || null)},
warning: ${JSON.stringify(value.warning || null)}, warning: ${JSON.stringify(value.warning || null)},
@@ -284,7 +294,8 @@ export default async function makeFileContent(
); );
return `List.obj({ return `List.obj({
name:${JSON.stringify(value.name || null)}, name:${JSON.stringify(value.name || null)},
range:${JSON.stringify(value.range || null)}, minLength:${JSON.stringify(null)},
maxLength:${JSON.stringify(null)},
default: [], default: [],
description: ${JSON.stringify(value.description || null)}, description: ${JSON.stringify(value.description || null)},
warning: ${JSON.stringify(value.warning || null)}, warning: ${JSON.stringify(value.warning || null)},