Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-04-04 22:39:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

sdk input spec improvements (#2785)

Browse Source 
* sdk input spec improvements

* more sdk changes

* fe changes

* alpha.14

* fix tests

* separate validator in filehelper

* use deeppartial for getinput

* fix union type and update ts-matches

* alpha.15

* alpha.16

* alpha.17

---------

Co-authored-by: Matt Hill <mattnine@protonmail.com>
This commit is contained in:
Aiden McClelland
2024-11-19 11:25:43 -07:00
committed by GitHub
parent 46179f5c83
commit 1771797453
24 changed files with 550 additions and 512 deletions
Download Patch File Download Diff File Expand all files Collapse all files

294
sdk/base/lib/actions/input/builder/value.ts
View File

@@ -1,6 +1,6 @@
import { InputSpec, LazyBuild } from "./inputSpec"
import { List } from "./list"
import { Variants } from "./variants"
import { PartialUnionRes, UnionRes, Variants } from "./variants"
import {
FilePath,
Pattern,
@@ -26,37 +26,14 @@ import {
string,
unknown,
} from "ts-matches"
import { DeepPartial } from "../../../types"
export type RequiredDefault<A> =
| false
| {
default: A | null
}
function requiredLikeToAbove<Input extends RequiredDefault<A>, A>(
requiredLike: Input,
) {
// prettier-ignore
return {
required: (typeof requiredLike === 'object' ? true : requiredLike) as (
Input extends { default: unknown} ? true:
Input extends true ? true :
false
),
default:(typeof requiredLike === 'object' ? requiredLike.default : null) as (
Input extends { default: infer Default } ? Default :
null
)
};
}
type AsRequired<Type, MaybeRequiredType> = MaybeRequiredType extends
| { default: unknown }
| never
? Type
: Type | null | undefined
type AsRequired<T, Required extends boolean> = Required extends true
? T
: T | null | undefined
const testForAsRequiredParser = once(
() => object({ required: object({ default: unknown }) }).test,
() => object({ required: literal(true) }).test,
)
function asRequiredParser<
Type,
@@ -69,6 +46,13 @@ function asRequiredParser<
return parser.optional() as any
}
export type PartialValue<T> =
T extends UnionRes<infer A, infer B>
? PartialUnionRes<A, B>
: T extends {}
? { [P in keyof T]?: PartialValue<T[P]> }
: T
export class Value<Type, Store> {
protected constructor(
public build: LazyBuild<Store, ValueSpec>,
@@ -122,19 +106,19 @@ export class Value<Type, Store> {
boolean,
)
}
static text<Required extends RequiredDefault<DefaultString>>(a: {
static text<Required extends boolean>(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 } }
* provide a default value.
* @type { string | RandomString | null }
* @example default: null
* @example default: 'World'
* @example default: { charset: 'abcdefg', len: 16 }
*/
default: string | RandomString | null
required: Required
/**
* @description Mask (aka camouflage) text input with dots: ● ● ●
@@ -188,7 +172,6 @@ export class Value<Type, Store> {
immutable: a.immutable ?? false,
generate: a.generate ?? null,
...a,
...requiredLikeToAbove(a.required),
}),
asRequiredParser(string, a),
)
@@ -200,7 +183,8 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: RequiredDefault<DefaultString>
default: DefaultString | null
required: boolean
masked?: boolean
placeholder?: string | null
minLength?: number | null
@@ -228,19 +212,16 @@ export class Value<Type, Store> {
immutable: false,
generate: a.generate ?? null,
...a,
...requiredLikeToAbove(a.required),
}
}, string.optional())
}
static textarea(a: {
static textarea<Required extends boolean>(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
default: string | null
required: Required
minLength?: number | null
maxLength?: number | null
placeholder?: string | null
@@ -250,20 +231,23 @@ export class Value<Type, Store> {
*/
immutable?: boolean
}) {
return new Value<string, never>(async () => {
const built: ValueSpecTextarea = {
description: null,
warning: null,
minLength: null,
maxLength: null,
placeholder: null,
type: "textarea" as const,
disabled: false,
immutable: a.immutable ?? false,
...a,
}
return built
}, string)
return new Value<AsRequired<string, Required>, never>(
async () => {
const built: ValueSpecTextarea = {
description: null,
warning: null,
minLength: null,
maxLength: null,
placeholder: null,
type: "textarea" as const,
disabled: false,
immutable: a.immutable ?? false,
...a,
}
return built
},
asRequiredParser(string, a),
)
}
static dynamicTextarea<Store = never>(
getA: LazyBuild<
@@ -272,6 +256,7 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
default: string | null
required: boolean
minLength?: number | null
maxLength?: number | null
@@ -280,7 +265,7 @@ export class Value<Type, Store> {
}
>,
) {
return new Value<string, Store>(async (options) => {
return new Value<string | null | undefined, Store>(async (options) => {
const a = await getA(options)
return {
description: null,
@@ -293,20 +278,20 @@ export class Value<Type, Store> {
immutable: false,
...a,
}
}, string)
}, string.optional())
}
static number<Required extends RequiredDefault<number>>(a: {
static number<Required extends boolean>(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 }
* @description optionally provide a default value.
* @type { default: number | null }
* @example default: null
* @example default: 7
*/
default: number | null
required: Required
min?: number | null
max?: number | null
@@ -343,7 +328,6 @@ export class Value<Type, Store> {
disabled: false,
immutable: a.immutable ?? false,
...a,
...requiredLikeToAbove(a.required),
}),
asRequiredParser(number, a),
)
@@ -355,7 +339,8 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: RequiredDefault<number>
default: number | null
required: boolean
min?: number | null
max?: number | null
step?: number | null
@@ -380,22 +365,21 @@ export class Value<Type, Store> {
disabled: false,
immutable: false,
...a,
...requiredLikeToAbove(a.required),
}
}, number.optional())
}
static color<Required extends RequiredDefault<string>>(a: {
static color<Required extends boolean>(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' }
* @description optionally provide a default value.
* @type { default: string | null }
* @example default: null
* @example default: 'ffffff'
*/
default: string | null
required: Required
/**
* @description Once set, the value can never be changed.
@@ -411,9 +395,7 @@ export class Value<Type, Store> {
disabled: false,
immutable: a.immutable ?? false,
...a,
...requiredLikeToAbove(a.required),
}),
asRequiredParser(string, a),
)
}
@@ -425,7 +407,8 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: RequiredDefault<string>
default: string | null
required: boolean
disabled?: false | string
}
>,
@@ -439,22 +422,21 @@ export class Value<Type, Store> {
disabled: false,
immutable: false,
...a,
...requiredLikeToAbove(a.required),
}
}, string.optional())
}
static datetime<Required extends RequiredDefault<string>>(a: {
static datetime<Required extends boolean>(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' }
* @description optionally provide a default value.
* @type { default: string | null }
* @example default: null
* @example default: '1985-12-16 18:00:00.000'
*/
default: string | null
required: Required
/**
* @description Informs the browser how to behave and which date/time component to display.
@@ -481,7 +463,6 @@ export class Value<Type, Store> {
disabled: false,
immutable: a.immutable ?? false,
...a,
...requiredLikeToAbove(a.required),
}),
asRequiredParser(string, a),
)
@@ -493,7 +474,8 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: RequiredDefault<string>
default: string | null
required: boolean
inputmode?: ValueSpecDatetime["inputmode"]
min?: string | null
max?: string | null
@@ -513,26 +495,21 @@ export class Value<Type, Store> {
disabled: false,
immutable: false,
...a,
...requiredLikeToAbove(a.required),
}
}, string.optional())
}
static select<
Required extends RequiredDefault<string>,
Values extends Record<string, string>,
>(a: {
static select<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' }
* @type { (keyof Values & string) | null }
* @example default: null
* @example default: 'radio1'
*/
required: Required
default: keyof Values & string
/**
* @description A mapping of unique radio options to their human readable display format.
* @example
@@ -551,7 +528,7 @@ export class Value<Type, Store> {
*/
immutable?: boolean
}) {
return new Value<AsRequired<keyof Values, Required>, never>(
return new Value<keyof Values & string, never>(
() => ({
description: null,
warning: null,
@@ -559,16 +536,10 @@ export class Value<Type, Store> {
disabled: false,
immutable: a.immutable ?? false,
...a,
...requiredLikeToAbove(a.required),
}),
asRequiredParser(
anyOf(
...Object.keys(a.values).map((x: keyof Values & string) =>
literal(x),
),
),
a,
) as any,
anyOf(
...Object.keys(a.values).map((x: keyof Values & string) => literal(x)),
),
)
}
static dynamicSelect<Store = never>(
@@ -578,13 +549,13 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: RequiredDefault<string>
default: string
values: Record<string, string>
disabled?: false | string | string[]
}
>,
) {
return new Value<string | null | undefined, Store>(async (options) => {
return new Value<string, Store>(async (options) => {
const a = await getA(options)
return {
description: null,
@@ -593,9 +564,8 @@ export class Value<Type, Store> {
disabled: false,
immutable: false,
...a,
...requiredLikeToAbove(a.required),
}
}, string.optional())
}, string)
}
static multiselect<Values extends Record<string, string>>(a: {
name: string
@@ -605,7 +575,7 @@ export class Value<Type, Store> {
/**
* @description A simple list of which options should be checked by default.
*/
default: string[]
default: (keyof Values & string)[]
/**
* @description A mapping of checkbox options to their human readable display format.
* @example
@@ -689,11 +659,11 @@ export class Value<Type, Store> {
}
}, spec.validator)
}
// static file<Store>(a: {
// static file<Store, Required extends boolean>(a: {
// name: string
// description?: string | null
// extensions: string[]
// required: boolean
// required: Required
// }) {
// const buildValue = {
// type: "file" as const,
@@ -701,14 +671,14 @@ export class Value<Type, Store> {
// warning: null,
// ...a,
// }
// return new Value<FilePath, Store>(
// return new Value<AsRequired<FilePath, Required>, Store>(
// () => ({
// ...buildValue,
// }),
// asRequiredParser(object({ filePath: string }), a),
// )
// }
// static dynamicFile<Required extends boolean, Store>(
// static dynamicFile<Store>(
// a: LazyBuild<
// Store,
// {
@@ -716,43 +686,49 @@ export class Value<Type, Store> {
// description?: string | null
// warning?: string | null
// extensions: string[]
// required: Required
// required: boolean
// }
// >,
// ) {
// return new Value<string | null | undefined, Store>(
// return new Value<FilePath | null | undefined, Store>(
// async (options) => ({
// type: "file" as const,
// description: null,
// warning: null,
// ...(await a(options)),
// }),
// string.optional(),
// object({ filePath: string }).optional(),
// )
// }
static union<Required extends RequiredDefault<string>, Type, Store>(
static union<
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
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' }
* @description Provide a default value from the list of variants.
* @type { string }
* @example default: 'variant1'
*/
required: Required
default: keyof VariantValues & string
/**
* @description Once set, the value can never be changed.
* @default false
*/
immutable?: boolean
},
aVariants: Variants<Type, Store>,
aVariants: Variants<VariantValues, Store>,
) {
return new Value<AsRequired<Type, Required>, Store>(
return new Value<typeof aVariants.validator._TYPE, Store>(
async (options) => ({
type: "union" as const,
description: null,
@@ -760,44 +736,50 @@ export class Value<Type, Store> {
disabled: false,
...a,
variants: await aVariants.build(options as any),
...requiredLikeToAbove(a.required),
immutable: a.immutable ?? false,
}),
asRequiredParser(aVariants.validator, a),
aVariants.validator,
)
}
static filteredUnion<
Required extends RequiredDefault<string>,
Type extends Record<string, any>,
Store = never,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
Store,
>(
getDisabledFn: LazyBuild<Store, string[] | false | string>,
a: {
name: string
description?: string | null
warning?: string | null
required: Required
default: keyof VariantValues & string
},
aVariants: Variants<Type, Store> | Variants<Type, never>,
aVariants: Variants<VariantValues, Store> | Variants<VariantValues, never>,
) {
return new Value<AsRequired<Type, Required>, Store>(
return new Value<typeof aVariants.validator._TYPE, Store>(
async (options) => ({
type: "union" as const,
description: null,
warning: null,
...a,
variants: await aVariants.build(options as any),
...requiredLikeToAbove(a.required),
disabled: (await getDisabledFn(options)) || false,
immutable: false,
}),
asRequiredParser(aVariants.validator, a),
aVariants.validator,
)
}
static dynamicUnion<
Required extends RequiredDefault<string>,
Type extends Record<string, any>,
Store = never,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
Store,
>(
getA: LazyBuild<
Store,
@@ -805,24 +787,26 @@ export class Value<Type, Store> {
name: string
description?: string | null
warning?: string | null
required: Required
default: keyof VariantValues & string
disabled: string[] | false | string
}
>,
aVariants: Variants<Type, Store> | Variants<Type, never>,
aVariants: Variants<VariantValues, Store> | Variants<VariantValues, never>,
) {
return new Value<Type | null | undefined, Store>(async (options) => {
const newValues = await getA(options)
return {
type: "union" as const,
description: null,
warning: null,
...newValues,
variants: await aVariants.build(options as any),
...requiredLikeToAbove(newValues.required),
immutable: false,
}
}, aVariants.validator.optional())
return new Value<typeof aVariants.validator._TYPE, Store>(
async (options) => {
const newValues = await getA(options)
return {
type: "union" as const,
description: null,
warning: null,
...newValues,
variants: await aVariants.build(options as any),
immutable: false,
}
},
aVariants.validator,
)
}
static list<Type, Store>(a: List<Type, Store>) {