mirror of
https://github.com/Start9Labs/start-sdk.git
synced 2026-04-02 05:23:21 +00:00
chore: Fix the tests and add new types for raw
This commit is contained in:
162
lib/config/configTypesRaw.ts
Normal file
162
lib/config/configTypesRaw.ts
Normal file
@@ -0,0 +1,162 @@
|
||||
export type InputSpecRaw = Record<string, ValueSpec>;
|
||||
export type ValueType =
|
||||
| "string"
|
||||
| "textarea"
|
||||
| "number"
|
||||
| "boolean"
|
||||
| "select"
|
||||
| "multiselect"
|
||||
| "list"
|
||||
| "object"
|
||||
| "file"
|
||||
| "union";
|
||||
export type ValueSpec = ValueSpecOf<ValueType>;
|
||||
/** core spec types. These types provide the metadata for performing validations */
|
||||
export type ValueSpecOf<T extends ValueType> = T extends "string"
|
||||
? ValueSpecString
|
||||
: T extends "number"
|
||||
? ValueSpecTextarea
|
||||
: T extends "textarea"
|
||||
? ValueSpecNumber
|
||||
: T extends "boolean"
|
||||
? ValueSpecBoolean
|
||||
: T extends "select"
|
||||
? ValueSpecSelect
|
||||
: T extends "multiselect"
|
||||
? ValueSpecMultiselect
|
||||
: T extends "list"
|
||||
? ValueSpecList
|
||||
: T extends "object"
|
||||
? ValueSpecObject
|
||||
: T extends "file"
|
||||
? ValueSpecFile
|
||||
: T extends "union"
|
||||
? ValueSpecUnion
|
||||
: never;
|
||||
export interface ValueSpecString extends ListValueSpecString, WithStandalone {
|
||||
required: boolean;
|
||||
default?: DefaultString | null;
|
||||
}
|
||||
export interface ValueSpecTextarea extends WithStandalone {
|
||||
type: "textarea";
|
||||
placeholder?: string | null;
|
||||
required: boolean;
|
||||
}
|
||||
export interface ValueSpecNumber extends ListValueSpecNumber, WithStandalone {
|
||||
required: boolean;
|
||||
default?: number | null;
|
||||
}
|
||||
export interface ValueSpecSelect extends SelectBase, WithStandalone {
|
||||
type: "select";
|
||||
required: boolean;
|
||||
default?: string | null;
|
||||
}
|
||||
export interface ValueSpecMultiselect extends SelectBase, WithStandalone {
|
||||
type: "multiselect";
|
||||
/**'[0,1]' (inclusive) OR '[0,*)' (right unbounded), normal math rules */
|
||||
range?: string;
|
||||
default?: string[];
|
||||
}
|
||||
export interface ValueSpecBoolean extends WithStandalone {
|
||||
type: "boolean";
|
||||
default?: boolean | null;
|
||||
}
|
||||
export interface ValueSpecUnion extends WithStandalone {
|
||||
type: "union";
|
||||
variants: Record<
|
||||
string,
|
||||
{
|
||||
name: string;
|
||||
spec: InputSpecRaw;
|
||||
}
|
||||
>;
|
||||
required: boolean;
|
||||
default?: string | null;
|
||||
}
|
||||
export interface ValueSpecFile extends WithStandalone {
|
||||
type: "file";
|
||||
extensions: string[];
|
||||
required: boolean;
|
||||
}
|
||||
export interface ValueSpecObject extends WithStandalone {
|
||||
type: "object";
|
||||
spec: InputSpecRaw;
|
||||
}
|
||||
export interface WithStandalone {
|
||||
name: string;
|
||||
description?: string | null;
|
||||
warning?: string | null;
|
||||
}
|
||||
export interface SelectBase {
|
||||
values: Record<string, string>;
|
||||
}
|
||||
export type ListValueSpecType = "string" | "number" | "object";
|
||||
/** represents a spec for the values of a list */
|
||||
export type ListValueSpecOf<T extends ListValueSpecType> = T extends "string"
|
||||
? ListValueSpecString
|
||||
: T extends "number"
|
||||
? ListValueSpecNumber
|
||||
: T extends "object"
|
||||
? ListValueSpecObject
|
||||
: never;
|
||||
/** represents a spec for a list */
|
||||
export type ValueSpecList = ValueSpecListOf<ListValueSpecType>;
|
||||
export interface ValueSpecListOf<T extends ListValueSpecType> extends WithStandalone {
|
||||
type: "list";
|
||||
spec: ListValueSpecOf<T>;
|
||||
range?: string;
|
||||
default?:
|
||||
| string[]
|
||||
| number[]
|
||||
| DefaultString[]
|
||||
| Record<string, unknown>[]
|
||||
| readonly string[]
|
||||
| readonly number[]
|
||||
| readonly DefaultString[]
|
||||
| readonly Record<string, unknown>[];
|
||||
}
|
||||
export declare function isValueSpecListOf<S extends ListValueSpecType>(
|
||||
t: ValueSpecListOf<ListValueSpecType>,
|
||||
s: S
|
||||
): t is ValueSpecListOf<S> & {
|
||||
spec: ListValueSpecOf<S>;
|
||||
};
|
||||
export interface ListValueSpecString {
|
||||
type: "string";
|
||||
pattern?: string | null;
|
||||
patternDescription?: string | null;
|
||||
masked?: boolean;
|
||||
inputmode?: "text" | "email" | "tel" | "url";
|
||||
placeholder?: string | null;
|
||||
}
|
||||
export interface ListValueSpecNumber {
|
||||
type: "number";
|
||||
range?: string;
|
||||
integral: boolean;
|
||||
units?: string | null;
|
||||
placeholder?: string | null;
|
||||
}
|
||||
export interface ListValueSpecObject {
|
||||
type: "object";
|
||||
/** this is a mapped type of the config object at this level, replacing the object's values with specs on those values */
|
||||
spec: InputSpecRaw;
|
||||
/** indicates whether duplicates can be permitted in the list */
|
||||
uniqueBy: UniqueBy;
|
||||
/** this should be a handlebars template which can make use of the entire config which corresponds to 'spec' */
|
||||
displayAs?: string | null;
|
||||
}
|
||||
export type UniqueBy =
|
||||
| null
|
||||
| string
|
||||
| {
|
||||
any: readonly UniqueBy[] | UniqueBy[];
|
||||
}
|
||||
| {
|
||||
all: readonly UniqueBy[] | UniqueBy[];
|
||||
};
|
||||
export type DefaultString =
|
||||
| string
|
||||
| {
|
||||
charset: string;
|
||||
len: number;
|
||||
};
|
||||
Reference in New Issue
Block a user