Start9/start-os
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-os.git synced 2026-03-26 02:11:53 +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

6
container-runtime/src/Adapters/Systems/SystemForEmbassy/__snapshots__/transformConfigSpec.test.ts.snap
View File

@@ -264,7 +264,6 @@ exports[`transformConfigSpec transformConfigSpec(bitcoind) 1`] = `
"disabled": false,
"immutable": false,
"name": "Pruning Mode",
"required": true,
"type": "union",
"variants": {
"automatic": {
@@ -524,7 +523,6 @@ exports[`transformConfigSpec transformConfigSpec(embassyPages) 1`] = `
"disabled": false,
"immutable": false,
"name": "Type",
"required": true,
"type": "union",
"variants": {
"index": {
@@ -589,7 +587,6 @@ exports[`transformConfigSpec transformConfigSpec(embassyPages) 1`] = `
"disabled": false,
"immutable": false,
"name": "Folder Location",
"required": false,
"type": "select",
"values": {
"filebrowser": "filebrowser",
@@ -644,7 +641,6 @@ exports[`transformConfigSpec transformConfigSpec(embassyPages) 1`] = `
"disabled": false,
"immutable": false,
"name": "Type",
"required": true,
"type": "union",
"variants": {
"redirect": {
@@ -705,7 +701,6 @@ exports[`transformConfigSpec transformConfigSpec(embassyPages) 1`] = `
"disabled": false,
"immutable": false,
"name": "Folder Location",
"required": false,
"type": "select",
"values": {
"filebrowser": "filebrowser",
@@ -758,7 +753,6 @@ exports[`transformConfigSpec transformConfigSpec(nostr2) 1`] = `
"disabled": false,
"immutable": false,
"name": "Relay Type",
"required": true,
"type": "union",
"variants": {
"private": {

2
container-runtime/src/Adapters/Systems/SystemForEmbassy/transformConfigSpec.ts
View File

@@ -43,7 +43,6 @@ export function transformConfigSpec(oldSpec: OldConfigSpec): IST.InputSpec {
}),
{},
),
required: false,
disabled: false,
immutable: false,
}
@@ -127,7 +126,6 @@ export function transformConfigSpec(oldSpec: OldConfigSpec): IST.InputSpec {
{} as Record<string, { name: string; spec: IST.InputSpec }>,
),
disabled: false,
required: true,
default: oldVal.default,
immutable: false,
}

45
sdk/base/lib/actions/index.ts
View File

@@ -1,6 +1,7 @@
import * as T from "../types"
import * as IST from "../actions/input/inputSpecTypes"
import { Action } from "./setupActions"
import { ExtractInputSpecType } from "./input/builder/inputSpec"
export type RunActionInput<Input> =
| Input
@@ -44,36 +45,32 @@ export const runAction = async <
})
}
}
type GetActionInputType<
A extends Action<T.ActionId, any, any, Record<string, unknown>>,
> = A extends Action<T.ActionId, any, any, infer I> ? I : never
type GetActionInputType<A extends Action<T.ActionId, any, any>> =
A extends Action<T.ActionId, any, infer I> ? ExtractInputSpecType<I> : never
type ActionRequestBase = {
reason?: string
replayId?: string
}
type ActionRequestInput<
T extends Action<T.ActionId, any, any, Record<string, unknown>>,
> = {
type ActionRequestInput<T extends Action<T.ActionId, any, any>> = {
kind: "partial"
value: Partial<GetActionInputType<T>>
}
export type ActionRequestOptions<
T extends Action<T.ActionId, any, any, Record<string, unknown>>,
> = ActionRequestBase &
(
| {
when?: Exclude<
T.ActionRequestTrigger,
{ condition: "input-not-matches" }
>
input?: ActionRequestInput<T>
}
| {
when: T.ActionRequestTrigger & { condition: "input-not-matches" }
input: ActionRequestInput<T>
}
)
export type ActionRequestOptions<T extends Action<T.ActionId, any, any>> =
ActionRequestBase &
(
| {
when?: Exclude<
T.ActionRequestTrigger,
{ condition: "input-not-matches" }
>
input?: ActionRequestInput<T>
}
| {
when: T.ActionRequestTrigger & { condition: "input-not-matches" }
input: ActionRequestInput<T>
}
)
const _validate: T.ActionRequest = {} as ActionRequestOptions<any> & {
actionId: string
@@ -81,9 +78,7 @@ const _validate: T.ActionRequest = {} as ActionRequestOptions<any> & {
severity: T.ActionSeverity
}
export const requestAction = <
T extends Action<T.ActionId, any, any, Record<string, unknown>>,
>(options: {
export const requestAction = <T extends Action<T.ActionId, any, any>>(options: {
effects: T.Effects
packageId: T.PackageId
action: T

13
sdk/base/lib/actions/input/builder/inputSpec.ts
View File

@@ -1,5 +1,5 @@
import { ValueSpec } from "../inputSpecTypes"
import { Value } from "./value"
import { PartialValue, Value } from "./value"
import { _ } from "../../../util"
import { Effects } from "../../../Effects"
import { Parser, object } from "ts-matches"
@@ -16,6 +16,15 @@ export type ExtractInputSpecType<A extends Record<string, any> | InputSpec<Recor
A extends InputSpec<infer B, any> | InputSpec<infer B, never> ? B :
A
export type ExtractPartialInputSpecType<
A extends
| Record<string, any>
| InputSpec<Record<string, any>, any>
| InputSpec<Record<string, any>, never>,
> = A extends InputSpec<infer B, any> | InputSpec<infer B, never>
? PartialValue<B>
: PartialValue<A>
export type InputSpecOf<A extends Record<string, any>, Store = never> = {
[K in keyof A]: Value<A[K], Store>
}
@@ -84,6 +93,8 @@ export class InputSpec<Type extends Record<string, any>, Store = never> {
},
public validator: Parser<unknown, Type>,
) {}
_TYPE: Type = null as any as Type
_PARTIAL: PartialValue<Type> = null as any as PartialValue<Type>
async build(options: LazyBuildOptions<Store>) {
const answer = {} as {
[K in keyof Type]: ValueSpec

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>) {

85
sdk/base/lib/actions/input/builder/variants.ts
View File

@@ -1,6 +1,54 @@
import { DeepPartial } from "../../../types"
import { ValueSpec, ValueSpecUnion } from "../inputSpecTypes"
import { LazyBuild, InputSpec } from "./inputSpec"
import { Parser, anyOf, literals, object } from "ts-matches"
import {
LazyBuild,
InputSpec,
ExtractInputSpecType,
ExtractPartialInputSpecType,
} from "./inputSpec"
import { Parser, anyOf, literal, object } from "ts-matches"
export type UnionRes<
Store,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
K extends keyof VariantValues & string = keyof VariantValues & string,
> = {
[key in keyof VariantValues]: {
selection: key
value: ExtractInputSpecType<VariantValues[key]["spec"]>
other?: {
[key2 in Exclude<keyof VariantValues & string, key>]?: DeepPartial<
ExtractInputSpecType<VariantValues[key2]["spec"]>
>
}
}
}[K]
export type PartialUnionRes<
Store,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
K extends keyof VariantValues & string = keyof VariantValues & string,
> = {
[key in keyof VariantValues]: {
selection?: key
value?: ExtractPartialInputSpecType<VariantValues[key]["spec"]>
other?: {
[key2 in Exclude<keyof VariantValues & string, key>]?: DeepPartial<
ExtractInputSpecType<VariantValues[key2]["spec"]>
>
}
}
}[K]
/**
* Used in the the Value.select { @link './value.ts' }
@@ -44,18 +92,24 @@ export const pruning = Value.union(
description:
'- Disabled: Disable pruning\n- Automatic: Limit blockchain size on disk to a certain number of megabytes\n- Manual: Prune blockchain with the "pruneblockchain" RPC\n',
warning: null,
required: true,
default: "disabled",
},
pruningSettingsVariants
);
```
*/
export class Variants<Type, Store> {
static text: any
export class Variants<
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
Store,
> {
private constructor(
public build: LazyBuild<Store, ValueSpecUnion["variants"]>,
public validator: Parser<unknown, Type>,
public validator: Parser<unknown, UnionRes<Store, VariantValues>>,
) {}
static of<
VariantValues extends {
@@ -67,26 +121,15 @@ export class Variants<Type, Store> {
Store = never,
>(a: VariantValues) {
const validator = anyOf(
...Object.entries(a).map(([name, { spec }]) =>
...Object.entries(a).map(([id, { spec }]) =>
object({
selection: literals(name),
selection: literal(id),
value: spec.validator,
}),
),
) as Parser<unknown, any>
return new Variants<
{
[K in keyof VariantValues]: {
selection: K
// prettier-ignore
value:
VariantValues[K]["spec"] extends (InputSpec<infer B, Store> | InputSpec<infer B, never>) ? B :
never
}
}[keyof VariantValues],
Store
>(async (options) => {
return new Variants<VariantValues, Store>(async (options) => {
const variants = {} as {
[K in keyof VariantValues]: {
name: string
@@ -118,6 +161,6 @@ export class Variants<Type, Store> {
```
*/
withStore<NewStore extends Store extends never ? any : Store>() {
return this as any as Variants<Type, NewStore>
return this as any as Variants<VariantValues, NewStore>
}
}

22
sdk/base/lib/actions/input/inputSpecConstants.ts
View File

@@ -10,35 +10,34 @@ import { Variants } from "./builder/variants"
export const customSmtp = InputSpec.of<InputSpecOf<SmtpValue>, never>({
server: Value.text({
name: "SMTP Server",
required: {
default: null,
},
required: true,
default: null,
}),
port: Value.number({
name: "Port",
required: { default: 587 },
required: true,
default: 587,
min: 1,
max: 65535,
integer: true,
}),
from: Value.text({
name: "From Address",
required: {
default: null,
},
required: true,
default: null,
placeholder: "<name>test@example.com",
inputmode: "email",
patterns: [Patterns.email],
}),
login: Value.text({
name: "Login",
required: {
default: null,
},
required: true,
default: null,
}),
password: Value.text({
name: "Password",
required: false,
default: null,
masked: true,
}),
})
@@ -54,7 +53,7 @@ export const smtpInputSpec = Value.filteredUnion(
{
name: "SMTP",
description: "Optionally provide an SMTP server for sending emails",
required: { default: "disabled" },
default: "disabled",
},
Variants.of({
disabled: { name: "Disabled", spec: InputSpec.of({}) },
@@ -66,6 +65,7 @@ export const smtpInputSpec = Value.filteredUnion(
description:
"A custom from address for this service. If not provided, the system from address will be used.",
required: false,
default: null,
placeholder: "<name>test@example.com",
inputmode: "email",
patterns: [Patterns.email],

2
sdk/base/lib/actions/input/inputSpecTypes.ts
View File

@@ -115,7 +115,6 @@ export type ValueSpecSelect = {
description: string | null
warning: string | null
type: "select"
required: boolean
default: string | null
disabled: false | string | string[]
immutable: boolean
@@ -158,7 +157,6 @@ export type ValueSpecUnion = {
}
>
disabled: false | string | string[]
required: boolean
default: string | null
immutable: boolean
}

32
sdk/base/lib/actions/setupActions.ts
View File

@@ -1,5 +1,8 @@
import { InputSpec } from "./input/builder"
import { ExtractInputSpecType } from "./input/builder/inputSpec"
import {
ExtractInputSpecType,
ExtractPartialInputSpecType,
} from "./input/builder/inputSpec"
import * as T from "../types"
import { once } from "../util"
@@ -20,7 +23,10 @@ export type GetInput<
> = (options: {
effects: T.Effects
}) => Promise<
null | void | undefined | (ExtractInputSpecType<A> & Record<string, any>)
| null
| void
| undefined
| (ExtractPartialInputSpecType<A> & Record<string, any>)
>
export type MaybeFn<T> = T | ((options: { effects: T.Effects }) => Promise<T>)
@@ -52,15 +58,13 @@ export class Action<
| Record<string, any>
| InputSpec<any, Store>
| InputSpec<any, never>,
Type extends
ExtractInputSpecType<InputSpecType> = ExtractInputSpecType<InputSpecType>,
> {
private constructor(
readonly id: Id,
private readonly metadataFn: MaybeFn<T.ActionMetadata>,
private readonly inputSpec: InputSpecType,
private readonly getInputFn: GetInput<Type>,
private readonly runFn: Run<Type>,
private readonly getInputFn: GetInput<ExtractInputSpecType<InputSpecType>>,
private readonly runFn: Run<ExtractInputSpecType<InputSpecType>>,
) {}
static withInput<
Id extends T.ActionId,
@@ -69,15 +73,13 @@ export class Action<
| Record<string, any>
| InputSpec<any, Store>
| InputSpec<any, never>,
Type extends
ExtractInputSpecType<InputSpecType> = ExtractInputSpecType<InputSpecType>,
>(
id: Id,
metadata: MaybeFn<Omit<T.ActionMetadata, "hasInput">>,
inputSpec: InputSpecType,
getInput: GetInput<Type>,
run: Run<Type>,
): Action<Id, Store, InputSpecType, Type> {
getInput: GetInput<ExtractInputSpecType<InputSpecType>>,
run: Run<ExtractInputSpecType<InputSpecType>>,
): Action<Id, Store, InputSpecType> {
return new Action(
id,
mapMaybeFn(metadata, (m) => ({ ...m, hasInput: true })),
@@ -90,7 +92,7 @@ export class Action<
id: Id,
metadata: MaybeFn<Omit<T.ActionMetadata, "hasInput">>,
run: Run<{}>,
): Action<Id, Store, {}, {}> {
): Action<Id, Store, {}> {
return new Action(
id,
mapMaybeFn(metadata, (m) => ({ ...m, hasInput: false })),
@@ -114,7 +116,7 @@ export class Action<
}
async run(options: {
effects: T.Effects
input: Type
input: ExtractInputSpecType<InputSpecType>
}): Promise<T.ActionResult | null> {
return (await this.runFn(options)) || null
}
@@ -122,13 +124,13 @@ export class Action<
export class Actions<
Store,
AllActions extends Record<T.ActionId, Action<T.ActionId, Store, any, any>>,
AllActions extends Record<T.ActionId, Action<T.ActionId, Store, any>>,
> {
private constructor(private readonly actions: AllActions) {}
static of<Store>(): Actions<Store, {}> {
return new Actions({})
}
addAction<A extends Action<T.ActionId, Store, any, any>>(
addAction<A extends Action<T.ActionId, Store, any>>(
action: A,
): Actions<Store, AllActions & { [id in A["id"]]: A }> {
return new Actions({ ...this.actions, [action.id]: action })

2
sdk/base/lib/types.ts
View File

@@ -86,7 +86,7 @@ export namespace ExpectedExports {
export type actions = Actions<
any,
Record<ActionId, Action<ActionId, any, any, any>>
Record<ActionId, Action<ActionId, any, any>>
>
}
export type ABI = {

9
sdk/base/package-lock.json generated
View File

@@ -14,7 +14,7 @@
"isomorphic-fetch": "^3.0.0",
"lodash.merge": "^4.6.2",
"mime-types": "^2.1.35",
"ts-matches": "^5.5.1",
"ts-matches": "^6.0.0",
"yaml": "^2.2.2"
},
"devDependencies": {
@@ -3897,9 +3897,10 @@
"dev": true
},
"node_modules/ts-matches": {
"version": "5.5.1",
"resolved": "https://registry.npmjs.org/ts-matches/-/ts-matches-5.5.1.tgz",
"integrity": "sha512-UFYaKgfqlg9FROK7bdpYqFwG1CJvP4kOJdjXuWoqxo9jCmANoDw1GxkSCpJgoTeIiSTaTH5Qr1klSspb8c+ydg=="
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/ts-matches/-/ts-matches-6.0.0.tgz",
"integrity": "sha512-vR4hhz9bYMW30qIJUuLaeAWlsR54vse6ZI2riVhVLMBE6/vss43jwrOvbHheiyU7e26ssT/yWx69aJHD2REJSA==",
"license": "MIT"
},
"node_modules/ts-morph": {
"version": "18.0.0",

2
sdk/base/package.json
View File

@@ -27,7 +27,7 @@
"isomorphic-fetch": "^3.0.0",
"lodash.merge": "^4.6.2",
"mime-types": "^2.1.35",
"ts-matches": "^5.5.1",
"ts-matches": "^6.0.0",
"yaml": "^2.2.2"
},
"prettier": {

124
sdk/package/lib/StartSdk.ts
View File

@@ -1,7 +1,4 @@
import {
RequiredDefault,
Value,
} from "../../base/lib/actions/input/builder/value"
import { Value } from "../../base/lib/actions/input/builder/value"
import {
InputSpec,
ExtractInputSpecType,
@@ -141,9 +138,7 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
...startSdkEffectWrapper,
action: {
run: actions.runAction,
request: <
T extends Action<T.ActionId, any, any, Record<string, unknown>>,
>(
request: <T extends Action<T.ActionId, any, any>>(
effects: T.Effects,
packageId: T.PackageId,
action: T,
@@ -157,9 +152,7 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
severity,
options: options,
}),
requestOwn: <
T extends Action<T.ActionId, Store, any, Record<string, unknown>>,
>(
requestOwn: <T extends Action<T.ActionId, Store, any>>(
effects: T.Effects,
action: T,
severity: T.ActionSeverity,
@@ -1060,14 +1053,14 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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 } }
* @description optionally provide a default value.
* @type { string | RandomString | null }
* @example default: null
* @example default: 'World'
* @example default: { charset: 'abcdefg', len: 16 }
*/
required: RequiredDefault<DefaultString>
default: DefaultString | null
required: boolean
/**
* @description Mask (aka camouflage) text input with dots: ● ● ●
* @default false
@@ -1110,15 +1103,12 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
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.
*/
default: string | null
required: boolean
minLength?: number | null
maxLength?: number | null
placeholder?: string | null
disabled?: false | string
generate?: null | RandomString
}
>,
) => Value.dynamicTextarea<Store>(getA),
@@ -1131,13 +1121,13 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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 { number | null }
* @example default: null
* @example default: 7
*/
required: RequiredDefault<number>
default: number | null
required: boolean
min?: number | null
max?: number | null
/**
@@ -1167,13 +1157,13 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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 { string | null }
* @example default: null
* @example default: 'ffffff'
*/
required: RequiredDefault<string>
default: string | null
required: boolean
disabled?: false | string
}
>,
@@ -1187,13 +1177,13 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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 { string | null }
* @example default: null
* @example default: '1985-12-16 18:00:00.000'
*/
required: RequiredDefault<string>
default: string
required: boolean
/**
* @description Informs the browser how to behave and which date/time component to display.
* @default "datetime-local"
@@ -1205,7 +1195,7 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
}
>,
) => Value.dynamicDatetime<Store>(getA),
dynamicSelect: (
dynamicSelect: <Variants extends Record<string, string>>(
getA: LazyBuild<
Store,
{
@@ -1214,13 +1204,12 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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' }
* @description provide a default value from the list of values.
* @type { default: string }
* @example default: 'radio1'
*/
required: RequiredDefault<string>
default: keyof Variants & string
required: boolean
/**
* @description A mapping of unique radio options to their human readable display format.
* @example
@@ -1232,7 +1221,7 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
}
* ```
*/
values: Record<string, string>
values: Variants
/**
* @options
* - false - The field can be modified.
@@ -1282,27 +1271,37 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
>,
) => Value.dynamicMultiselect<Store>(getA),
filteredUnion: <
Required extends RequiredDefault<string>,
Type extends Record<string, any>,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
>(
getDisabledFn: LazyBuild<Store, 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>,
) =>
Value.filteredUnion<Required, Type, Store>(
Value.filteredUnion<VariantValues, Store>(
getDisabledFn,
a,
aVariants,
),
dynamicUnion: <
Required extends RequiredDefault<string>,
Type extends Record<string, any>,
VariantValues extends {
[K in string]: {
name: string
spec: InputSpec<any, Store> | InputSpec<any, never>
}
},
>(
getA: LazyBuild<
Store,
@@ -1312,13 +1311,12 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
/** 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
required: boolean
/**
* @options
* - false - The field can be modified.
@@ -1329,8 +1327,10 @@ export class StartSdk<Manifest extends T.SDKManifest, Store> {
disabled: false | string | string[]
}
>,
aVariants: Variants<Type, Store> | Variants<Type, never>,
) => Value.dynamicUnion<Required, Type, Store>(getA, aVariants),
aVariants:
| Variants<VariantValues, Store>
| Variants<VariantValues, never>,
) => Value.dynamicUnion<VariantValues, Store>(getA, aVariants),
},
Variants: {
of: <

130
sdk/package/lib/test/inputSpecBuilder.test.ts
View File

@@ -17,7 +17,8 @@ describe("builder tests", () => {
"peer-tor-address": Value.text({
name: "Peer tor address",
description: "The Tor address of the peer interface",
required: { default: null },
required: true,
default: null,
}),
}).build({} as any)
expect(bitcoinPropertiesBuilt).toMatchObject({
@@ -55,7 +56,8 @@ describe("values", () => {
test("text", async () => {
const value = Value.text({
name: "Testing",
required: { default: null },
required: true,
default: null,
})
const validator = value.validator
const rawIs = await value.build({} as any)
@@ -66,7 +68,8 @@ describe("values", () => {
test("text with default", async () => {
const value = Value.text({
name: "Testing",
required: { default: "this is a default value" },
required: true,
default: "this is a default value",
})
const validator = value.validator
const rawIs = await value.build({} as any)
@@ -78,6 +81,7 @@ describe("values", () => {
const value = Value.text({
name: "Testing",
required: false,
default: null,
})
const validator = value.validator
const rawIs = await value.build({} as any)
@@ -89,6 +93,7 @@ describe("values", () => {
const value = Value.color({
name: "Testing",
required: false,
default: null,
description: null,
warning: null,
})
@@ -99,7 +104,8 @@ describe("values", () => {
test("datetime", async () => {
const value = Value.datetime({
name: "Testing",
required: { default: null },
required: true,
default: null,
description: null,
warning: null,
inputmode: "date",
@@ -114,6 +120,7 @@ describe("values", () => {
const value = Value.datetime({
name: "Testing",
required: false,
default: null,
description: null,
warning: null,
inputmode: "date",
@@ -128,6 +135,7 @@ describe("values", () => {
const value = Value.textarea({
name: "Testing",
required: false,
default: null,
description: null,
warning: null,
minLength: null,
@@ -136,12 +144,13 @@ describe("values", () => {
})
const validator = value.validator
validator.unsafeCast("test text")
testOutput<typeof validator._TYPE, string>()(null)
testOutput<typeof validator._TYPE, string | null | undefined>()(null)
})
test("number", async () => {
const value = Value.number({
name: "Testing",
required: { default: null },
required: true,
default: null,
integer: false,
description: null,
warning: null,
@@ -159,6 +168,7 @@ describe("values", () => {
const value = Value.number({
name: "Testing",
required: false,
default: null,
integer: false,
description: null,
warning: null,
@@ -175,7 +185,7 @@ describe("values", () => {
test("select", async () => {
const value = Value.select({
name: "Testing",
required: { default: null },
default: "a",
values: {
a: "A",
b: "B",
@@ -192,7 +202,7 @@ describe("values", () => {
test("nullable select", async () => {
const value = Value.select({
name: "Testing",
required: false,
default: "a",
values: {
a: "A",
b: "B",
@@ -203,8 +213,7 @@ describe("values", () => {
const validator = value.validator
validator.unsafeCast("a")
validator.unsafeCast("b")
validator.unsafeCast(null)
testOutput<typeof validator._TYPE, "a" | "b" | null | undefined>()(null)
testOutput<typeof validator._TYPE, "a" | "b">()(null)
})
test("multiselect", async () => {
const value = Value.multiselect({
@@ -250,7 +259,7 @@ describe("values", () => {
const value = Value.union(
{
name: "Testing",
required: { default: null },
default: "a",
description: null,
warning: null,
},
@@ -271,7 +280,16 @@ describe("values", () => {
const validator = value.validator
validator.unsafeCast({ selection: "a", value: { b: false } })
type Test = typeof validator._TYPE
testOutput<Test, { selection: "a"; value: { b: boolean } }>()(null)
testOutput<
Test,
{
selection: "a"
value: {
b: boolean
}
other?: {}
}
>()(null)
})
describe("dynamic", () => {
@@ -301,7 +319,8 @@ describe("values", () => {
test("text", async () => {
const value = Value.dynamicText(async () => ({
name: "Testing",
required: { default: null },
required: true,
default: null,
}))
const validator = value.validator
const rawIs = await value.build({} as any)
@@ -317,7 +336,8 @@ describe("values", () => {
test("text with default", async () => {
const value = Value.dynamicText(async () => ({
name: "Testing",
required: { default: "this is a default value" },
required: true,
default: "this is a default value",
}))
const validator = value.validator
validator.unsafeCast("test text")
@@ -333,6 +353,7 @@ describe("values", () => {
const value = Value.dynamicText(async () => ({
name: "Testing",
required: false,
default: null,
}))
const validator = value.validator
const rawIs = await value.build({} as any)
@@ -349,6 +370,7 @@ describe("values", () => {
const value = Value.dynamicColor(async () => ({
name: "Testing",
required: false,
default: null,
description: null,
warning: null,
}))
@@ -414,7 +436,8 @@ describe("values", () => {
return {
name: "Testing",
required: { default: null },
required: true,
default: null,
inputmode: "date",
}
},
@@ -436,6 +459,7 @@ describe("values", () => {
const value = Value.dynamicTextarea(async () => ({
name: "Testing",
required: false,
default: null,
description: null,
warning: null,
minLength: null,
@@ -444,8 +468,7 @@ describe("values", () => {
}))
const validator = value.validator
validator.unsafeCast("test text")
expect(() => validator.unsafeCast(null)).toThrowError()
testOutput<typeof validator._TYPE, string>()(null)
testOutput<typeof validator._TYPE, string | null | undefined>()(null)
expect(await value.build(fakeOptions)).toMatchObject({
name: "Testing",
required: false,
@@ -454,7 +477,8 @@ describe("values", () => {
test("number", async () => {
const value = Value.dynamicNumber(() => ({
name: "Testing",
required: { default: null },
required: true,
default: null,
integer: false,
description: null,
warning: null,
@@ -477,7 +501,7 @@ describe("values", () => {
test("select", async () => {
const value = Value.dynamicSelect(() => ({
name: "Testing",
required: { default: null },
default: "a",
values: {
a: "A",
b: "B",
@@ -489,11 +513,9 @@ describe("values", () => {
validator.unsafeCast("a")
validator.unsafeCast("b")
validator.unsafeCast("c")
validator.unsafeCast(null)
testOutput<typeof validator._TYPE, string | null | undefined>()(null)
testOutput<typeof validator._TYPE, string>()(null)
expect(await value.build(fakeOptions)).toMatchObject({
name: "Testing",
required: true,
})
})
test("multiselect", async () => {
@@ -529,7 +551,7 @@ describe("values", () => {
() => ["a", "c"],
{
name: "Testing",
required: { default: null },
default: "a",
description: null,
warning: null,
},
@@ -563,8 +585,28 @@ describe("values", () => {
type Test = typeof validator._TYPE
testOutput<
Test,
| { selection: "a"; value: { b: boolean } }
| { selection: "b"; value: { b: boolean } }
| {
selection: "a"
value: {
b: boolean
}
other?: {
b?: {
b?: boolean
}
}
}
| {
selection: "b"
value: {
b: boolean
}
other?: {
a?: {
b?: boolean
}
}
}
>()(null)
const built = await value.build({} as any)
@@ -596,7 +638,7 @@ describe("values", () => {
() => ({
disabled: ["a", "c"],
name: "Testing",
required: { default: null },
default: "b",
description: null,
warning: null,
}),
@@ -630,10 +672,28 @@ describe("values", () => {
type Test = typeof validator._TYPE
testOutput<
Test,
| { selection: "a"; value: { b: boolean } }
| { selection: "b"; value: { b: boolean } }
| null
| undefined
| {
selection: "a"
value: {
b: boolean
}
other?: {
b?: {
b?: boolean
}
}
}
| {
selection: "b"
value: {
b: boolean
}
other?: {
a?: {
b?: boolean
}
}
}
>()(null)
const built = await value.build({} as any)
@@ -728,6 +788,7 @@ describe("Nested nullable values", () => {
description:
"If no name is provided, the name from inputSpec will be used",
required: false,
default: null,
}),
})
const validator = value.validator
@@ -743,6 +804,7 @@ describe("Nested nullable values", () => {
description:
"If no name is provided, the name from inputSpec will be used",
required: false,
default: null,
warning: null,
placeholder: null,
integer: false,
@@ -765,6 +827,7 @@ describe("Nested nullable values", () => {
description:
"If no name is provided, the name from inputSpec will be used",
required: false,
default: null,
warning: null,
}),
})
@@ -780,7 +843,7 @@ describe("Nested nullable values", () => {
name: "Temp Name",
description:
"If no name is provided, the name from inputSpec will be used",
required: false,
default: "a",
warning: null,
values: {
a: "A",
@@ -791,7 +854,7 @@ describe("Nested nullable values", () => {
name: "Temp Name",
description:
"If no name is provided, the name from inputSpec will be used",
required: false,
default: "a",
warning: null,
values: {
a: "A",
@@ -799,10 +862,9 @@ describe("Nested nullable values", () => {
}).build({} as any)
const validator = value.validator
validator.unsafeCast({ a: null })
validator.unsafeCast({ a: "a" })
expect(() => validator.unsafeCast({ a: "4" })).toThrowError()
testOutput<typeof validator._TYPE, { a: "a" | null | undefined }>()(null)
testOutput<typeof validator._TYPE, { a: "a" }>()(null)
})
test("Testing multiselect", async () => {
const value = InputSpec.of({

2
sdk/package/lib/test/output.test.ts
View File

@@ -87,7 +87,7 @@ describe("Inputs", () => {
dbcache: 5,
pruning: {
selection: "disabled",
value: {},
value: { disabled: {} },
},
blockfilters: {
blockfilterindex: false,

61
sdk/package/lib/util/fileHelper.ts
View File

@@ -80,7 +80,8 @@ export class FileHelper<A> {
protected constructor(
readonly path: string,
readonly writeData: (dataIn: A) => string,
readonly readData: (stringValue: string) => A,
readonly readData: (stringValue: string) => unknown,
readonly validate: (value: unknown) => A,
) {}
/**
@@ -97,10 +98,7 @@ export class FileHelper<A> {
return null
}
/**
* Reads the file from disk and converts it to structured data.
*/
private async readOnce(): Promise<A | null> {
private async readFile(): Promise<unknown> {
if (!(await exists(this.path))) {
return null
}
@@ -109,6 +107,15 @@ export class FileHelper<A> {
)
}
/**
* Reads the file from disk and converts it to structured data.
*/
private async readOnce(): Promise<A | null> {
const data = await this.readFile()
if (!data) return null
return this.validate(data)
}
private async readConst(effects: T.Effects): Promise<A | null> {
const watch = this.readWatch()
const res = await watch.next()
@@ -156,22 +163,22 @@ export class FileHelper<A> {
* Accepts full structured data and performs a merge with the existing file on disk if it exists.
*/
async write(data: A) {
const fileData = (await this.readOnce()) || {}
const fileData = (await this.readFile()) || {}
const mergeData = merge({}, fileData, data)
return await this.writeFile(mergeData)
return await this.writeFile(this.validate(mergeData))
}
/**
* Accepts partial structured data and performs a merge with the existing file on disk.
*/
async merge(data: Partial<A>) {
async merge(data: T.DeepPartial<A>) {
const fileData =
(await this.readOnce()) ||
(await this.readFile()) ||
(() => {
throw new Error(`${this.path}: does not exist`)
})()
const mergeData = merge({}, fileData, data)
return await this.writeFile(mergeData)
return await this.writeFile(this.validate(mergeData))
}
/**
@@ -179,7 +186,7 @@ export class FileHelper<A> {
* Like one behaviour of another dependency or something similar.
*/
withPath(path: string) {
return new FileHelper<A>(path, this.writeData, this.readData)
return new FileHelper<A>(path, this.writeData, this.readData, this.validate)
}
/**
@@ -190,9 +197,10 @@ export class FileHelper<A> {
static raw<A>(
path: string,
toFile: (dataIn: A) => string,
fromFile: (rawData: string) => A,
fromFile: (rawData: string) => unknown,
validate: (data: unknown) => A,
) {
return new FileHelper<A>(path, toFile, fromFile)
return new FileHelper<A>(path, toFile, fromFile, validate)
}
/**
* Create a File Helper for a .json file.
@@ -200,12 +208,9 @@ export class FileHelper<A> {
static json<A>(path: string, shape: matches.Validator<unknown, A>) {
return new FileHelper<A>(
path,
(inData) => {
return JSON.stringify(inData, null, 2)
},
(inString) => {
return shape.unsafeCast(JSON.parse(inString))
},
(inData) => JSON.stringify(inData, null, 2),
(inString) => JSON.parse(inString),
(data) => shape.unsafeCast(data),
)
}
/**
@@ -217,12 +222,9 @@ export class FileHelper<A> {
) {
return new FileHelper<A>(
path,
(inData) => {
return TOML.stringify(inData as any)
},
(inString) => {
return shape.unsafeCast(TOML.parse(inString))
},
(inData) => TOML.stringify(inData as any),
(inString) => TOML.parse(inString),
(data) => shape.unsafeCast(data),
)
}
/**
@@ -234,12 +236,9 @@ export class FileHelper<A> {
) {
return new FileHelper<A>(
path,
(inData) => {
return YAML.stringify(inData, null, 2)
},
(inString) => {
return shape.unsafeCast(YAML.parse(inString))
},
(inData) => YAML.stringify(inData, null, 2),
(inString) => YAML.parse(inString),
(data) => shape.unsafeCast(data),
)
}
}

13
sdk/package/package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "@start9labs/start-sdk",
"version": "0.3.6-alpha.13",
"version": "0.3.6-alpha.16",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@start9labs/start-sdk",
"version": "0.3.6-alpha.13",
"version": "0.3.6-alpha.16",
"license": "MIT",
"dependencies": {
"@iarna/toml": "^2.2.5",
@@ -15,7 +15,7 @@
"isomorphic-fetch": "^3.0.0",
"lodash.merge": "^4.6.2",
"mime-types": "^2.1.35",
"ts-matches": "^5.5.1",
"ts-matches": "^6.0.0",
"yaml": "^2.2.2"
},
"devDependencies": {
@@ -3918,9 +3918,10 @@
"dev": true
},
"node_modules/ts-matches": {
"version": "5.5.1",
"resolved": "https://registry.npmjs.org/ts-matches/-/ts-matches-5.5.1.tgz",
"integrity": "sha512-UFYaKgfqlg9FROK7bdpYqFwG1CJvP4kOJdjXuWoqxo9jCmANoDw1GxkSCpJgoTeIiSTaTH5Qr1klSspb8c+ydg=="
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/ts-matches/-/ts-matches-6.0.0.tgz",
"integrity": "sha512-vR4hhz9bYMW30qIJUuLaeAWlsR54vse6ZI2riVhVLMBE6/vss43jwrOvbHheiyU7e26ssT/yWx69aJHD2REJSA==",
"license": "MIT"
},
"node_modules/ts-morph": {
"version": "18.0.0",

4
sdk/package/package.json
View File

@@ -1,6 +1,6 @@
{
"name": "@start9labs/start-sdk",
"version": "0.3.6-alpha.13",
"version": "0.3.6-alpha.17",
"description": "Software development kit to facilitate packaging services for StartOS",
"main": "./package/lib/index.js",
"types": "./package/lib/index.d.ts",
@@ -33,7 +33,7 @@
"isomorphic-fetch": "^3.0.0",
"lodash.merge": "^4.6.2",
"mime-types": "^2.1.35",
"ts-matches": "^5.5.1",
"ts-matches": "^6.0.0",
"yaml": "^2.2.2",
"@iarna/toml": "^2.2.5",
"@noble/curves": "^1.4.0",

41
sdk/package/scripts/oldSpecToBuilder.ts
View File

@@ -85,6 +85,7 @@ const {InputSpec, List, Value, Variants} = sdk
description: value.description || null,
warning: value.warning || null,
required: !(value.nullable || false),
default: value.default,
placeholder: value.placeholder || null,
maxLength: null,
minLength: null,
@@ -96,12 +97,8 @@ const {InputSpec, List, Value, Variants} = sdk
return `${rangeToTodoComment(value?.range)}Value.text(${JSON.stringify(
{
name: value.name || null,
// prettier-ignore
required: (
value.default != null ? {default: value.default} :
value.nullable === false ? {default: null} :
!value.nullable
),
default: value.default || null,
required: !value.nullable,
description: value.description || null,
warning: value.warning || null,
masked: value.masked || false,
@@ -130,12 +127,8 @@ const {InputSpec, List, Value, Variants} = sdk
name: value.name || null,
description: value.description || null,
warning: value.warning || null,
// prettier-ignore
required: (
value.default != null ? {default: value.default} :
value.nullable === false ? {default: null} :
!value.nullable
),
default: value.default || null,
required: !value.nullable,
min: null,
max: null,
step: null,
@@ -174,13 +167,7 @@ const {InputSpec, List, Value, Variants} = sdk
name: value.name || null,
description: value.description || null,
warning: value.warning || null,
// prettier-ignore
required:(
value.default != null ? {default: value.default} :
value.nullable === false ? {default: null} :
!value.nullable
),
default: value.default,
values,
},
null,
@@ -207,14 +194,7 @@ const {InputSpec, List, Value, Variants} = sdk
name: ${JSON.stringify(value.name || null)},
description: ${JSON.stringify(value.tag.description || null)},
warning: ${JSON.stringify(value.tag.warning || null)},
// prettier-ignore
required: ${JSON.stringify(
// prettier-ignore
value.default != null ? {default: value.default} :
value.nullable === false ? {default: null} :
!value.nullable,
)},
default: ${JSON.stringify(value.default)},
}, ${variants})`
}
case "list": {
@@ -341,12 +321,7 @@ const {InputSpec, List, Value, Variants} = sdk
value?.spec?.tag?.description || null,
)},
warning: ${JSON.stringify(value?.spec?.tag?.warning || null)},
required: ${JSON.stringify(
// prettier-ignore
'default' in value?.spec ? {default: value?.spec?.default} :
!!value?.spec?.tag?.nullable || false ? {default: null} :
false,
)},
default: ${JSON.stringify(value?.spec?.default || null)},
}, ${variants})
`,
)

10
web/projects/ui/src/app/components/backup-drives/backup-drives.component.ts
View File

@@ -268,25 +268,29 @@ const cifsSpec = ISB.InputSpec.of({
'The hostname of your target device on the Local Area Network.',
warning: null,
placeholder: `e.g. 'My Computer' OR 'my-computer.local'`,
required: { default: null },
required: true,
default: null,
patterns: [],
}),
path: ISB.Value.text({
name: 'Path',
description: `On Windows, this is the fully qualified path to the shared folder, (e.g. /Desktop/my-folder).\n\n On Linux and Mac, this is the literal name of the shared folder (e.g. my-shared-folder).`,
placeholder: 'e.g. my-shared-folder or /Desktop/my-folder',
required: { default: null },
required: true,
default: null,
}),
username: ISB.Value.text({
name: 'Username',
description: `On Linux, this is the samba username you created when sharing the folder.\n\n On Mac and Windows, this is the username of the user who is sharing the folder.`,
required: { default: null },
required: true,
default: null,
placeholder: 'My Network Folder',
}),
password: ISB.Value.text({
name: 'Password',
description: `On Linux, this is the samba password you created when sharing the folder.\n\n On Mac and Windows, this is the password of the user who is sharing the folder.`,
required: false,
default: null,
masked: true,
placeholder: 'My Network Folder',
}),

5
web/projects/ui/src/app/components/form/form-select/form-select.component.html
View File

@@ -2,13 +2,12 @@
[tuiHintContent]="spec | hint"
[disabled]="disabled"
[readOnly]="readOnly"
[tuiTextfieldCleaner]="!spec.required"
[tuiTextfieldCleaner]="false"
[pseudoInvalid]="invalid"
[(ngModel)]="selected"
(focusedChange)="onFocus($event)"
>
{{ spec.name }}
<span *ngIf="spec.required">*</span>
{{ spec.name }}*
<select
tuiSelect
[placeholder]="spec.name"

15
web/projects/ui/src/app/pages/server-routes/server-show/server-show.page.ts
View File

@@ -697,23 +697,20 @@ interface SettingBtn {
const passwordSpec = ISB.InputSpec.of({
currentPassword: ISB.Value.text({
name: 'Current Password',
required: {
default: null,
},
required: true,
default: null,
masked: true,
}),
newPassword1: ISB.Value.text({
name: 'New Password',
required: {
default: null,
},
required: true,
default: null,
masked: true,
}),
newPassword2: ISB.Value.text({
name: 'Retype New Password',
required: {
default: null,
},
required: true,
default: null,
masked: true,
}),
})

131
web/projects/ui/src/app/services/api/api.fixures.ts
View File

@@ -1151,7 +1151,7 @@ export module Mock {
name: 'P2P Settings',
description:
'<p>The Bitcoin Core node to connect to over the peer-to-peer (P2P) interface:</p><ul><li><strong>Bitcoin Core</strong>: The Bitcoin Core service installed on this device</li><li><strong>External Node</strong>: A Bitcoin node running on a different device</li></ul>',
required: { default: 'internal' },
default: 'internal',
},
ISB.Variants.of({
internal: { name: 'Bitcoin Core', spec: ISB.InputSpec.of({}) },
@@ -1160,9 +1160,8 @@ export module Mock {
spec: ISB.InputSpec.of({
'p2p-host': ISB.Value.text({
name: 'Public Address',
required: {
default: null,
},
required: false,
default: null,
description:
'The public address of your Bitcoin Core server',
}),
@@ -1170,9 +1169,8 @@ export module Mock {
name: 'P2P Port',
description:
'The port that your Bitcoin Core P2P server is bound to',
required: {
default: 8333,
},
required: true,
default: 8333,
min: 0,
max: 65535,
integer: true,
@@ -1186,10 +1184,12 @@ export module Mock {
color: ISB.Value.color({
name: 'Color',
required: false,
default: null,
}),
datetime: ISB.Value.datetime({
name: 'Datetime',
required: false,
default: null,
}),
// file: ISB.Value.file({
// name: 'File',
@@ -1221,9 +1221,8 @@ export module Mock {
ISB.InputSpec.of({
rpcuser2: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
},
required: false,
default: 'defaultrpcusername',
description: 'rpc username',
patterns: [
{
@@ -1234,9 +1233,8 @@ export module Mock {
}),
rpcuser: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
},
required: true,
default: 'defaultrpcusername',
description: 'rpc username',
patterns: [
{
@@ -1247,21 +1245,19 @@ export module Mock {
}),
rpcpass: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
required: true,
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
description: 'rpc password',
}),
rpcpass2: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
required: true,
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
description: 'rpc password',
}),
@@ -1294,14 +1290,14 @@ export module Mock {
name: 'First Name',
required: false,
description: 'User first name',
default: 'Matt',
}),
'last-name': ISB.Value.text({
name: 'Last Name',
required: {
default: {
charset: 'a-g,2-9',
len: 12,
},
required: true,
default: {
charset: 'a-g,2-9',
len: 12,
},
description: 'User first name',
patterns: [
@@ -1316,6 +1312,7 @@ export module Mock {
description: 'The age of the user',
warning: 'User must be at least 18.',
required: false,
default: null,
min: 18,
integer: false,
}),
@@ -1343,7 +1340,7 @@ export module Mock {
name: 'Preference',
description: null,
warning: null,
required: { default: 'summer' },
default: 'summer',
},
ISB.Variants.of({
summer: {
@@ -1351,17 +1348,14 @@ export module Mock {
spec: ISB.InputSpec.of({
'favorite-tree': ISB.Value.text({
name: 'Favorite Tree',
required: {
default: 'Maple',
},
required: true,
default: 'Maple',
description: 'What is your favorite tree?',
}),
'favorite-flower': ISB.Value.select({
name: 'Favorite Flower',
description: 'Select your favorite flower',
required: {
default: 'none',
},
default: 'none',
values: {
none: 'none',
red: 'red',
@@ -1392,9 +1386,7 @@ export module Mock {
name: 'Random select',
description: 'This is not even real.',
warning: 'Be careful changing this!',
required: {
default: null,
},
default: 'option1',
values: {
option1: 'option1',
option2: 'option2',
@@ -1409,9 +1401,8 @@ export module Mock {
description: 'Your favorite number of all time',
warning:
'Once you set this number, it can never be changed without severe consequences.',
required: {
default: 7,
},
required: false,
default: 7,
integer: false,
units: 'BTC',
},
@@ -1432,11 +1423,13 @@ export module Mock {
name: 'First Law',
required: false,
description: 'the first law',
default: null,
}),
law2: ISB.Value.text({
name: 'Second Law',
required: false,
description: 'the second law',
default: null,
}),
}),
),
@@ -1452,19 +1445,17 @@ export module Mock {
spec: ISB.InputSpec.of({
rulemakername: ISB.Value.text({
name: 'Rulemaker Name',
required: {
default: {
charset: 'a-g,2-9',
len: 12,
},
required: true,
default: {
charset: 'a-g,2-9',
len: 12,
},
description: 'the name of the rule maker',
}),
rulemakerip: ISB.Value.text({
name: 'Rulemaker IP',
required: {
default: '192.168.1.0',
},
required: true,
default: '192.168.1.0',
description: 'the ip of the rule maker',
patterns: [
{
@@ -1480,9 +1471,8 @@ export module Mock {
),
rpcuser: ISB.Value.text({
name: 'RPC Username',
required: {
default: 'defaultrpcusername',
},
required: true,
default: 'defaultrpcusername',
description: 'rpc username',
patterns: [
{
@@ -1493,11 +1483,10 @@ export module Mock {
}),
rpcpass: ISB.Value.text({
name: 'RPC User Password',
required: {
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
required: true,
default: {
charset: 'a-z,A-Z,2-9',
len: 20,
},
description: 'rpc password',
masked: true,
@@ -1509,7 +1498,7 @@ export module Mock {
name: 'Bitcoin Node',
description: 'Options<ul><li>Item 1</li><li>Item 2</li></ul>',
warning: 'Careful changing this',
required: { default: 'internal' },
default: 'internal',
},
ISB.Variants.of({
fake: {
@@ -1531,9 +1520,8 @@ export module Mock {
ISB.InputSpec.of({
name: ISB.Value.text({
name: 'Name',
required: {
default: null,
},
required: false,
default: null,
patterns: [
{
regex: '^[a-zA-Z]+$',
@@ -1544,17 +1532,15 @@ export module Mock {
email: ISB.Value.text({
name: 'Email',
inputmode: 'email',
required: {
default: null,
},
required: false,
default: null,
}),
}),
),
'public-domain': ISB.Value.text({
name: 'Public Domain',
required: {
default: 'bitcoinnode.com',
},
required: true,
default: 'bitcoinnode.com',
description: 'the public address of the node',
patterns: [
{
@@ -1565,9 +1551,8 @@ export module Mock {
}),
'private-domain': ISB.Value.text({
name: 'Private Domain',
required: {
default: null,
},
required: false,
default: null,
description: 'the private address of the node',
masked: true,
inputmode: 'url',
@@ -1580,9 +1565,8 @@ export module Mock {
name: 'Port',
description:
'the default port for your Bitcoin node. default: 8333, testnet: 18333, regtest: 18444',
required: {
default: 8333,
},
required: true,
default: 8333,
min: 1,
max: 9998,
step: 1,
@@ -1595,6 +1579,7 @@ export module Mock {
len: 20,
},
required: false,
default: null,
description:
'You most favorite slogan in the whole world, used for paying you.',
masked: true,

12
web/projects/ui/src/app/services/form.service.ts
View File

@@ -135,7 +135,7 @@ export class FormService {
return this.formBuilder.control(value)
case 'select':
value = currentValue === undefined ? spec.default : currentValue
return this.formBuilder.control(value, selectValidators(spec))
return this.formBuilder.control(value)
case 'multiselect':
value = currentValue === undefined ? spec.default : currentValue
return this.formBuilder.control(value, multiselectValidators(spec))
@@ -231,16 +231,6 @@ function numberValidators(spec: IST.ValueSpecNumber): ValidatorFn[] {
return validators
}
function selectValidators(spec: IST.ValueSpecSelect): ValidatorFn[] {
const validators: ValidatorFn[] = []
if (spec.required) {
validators.push(Validators.required)
}
return validators
}
function multiselectValidators(spec: IST.ValueSpecMultiselect): ValidatorFn[] {
const validators: ValidatorFn[] = []
validators.push(listInRange(spec.minLength, spec.maxLength))