From 5414b301f3b4fddbeb4fd61dac2d5f125df08af7 Mon Sep 17 00:00:00 2001 From: BluJ Date: Wed, 5 Apr 2023 14:48:51 -0600 Subject: [PATCH] chore: Add changes --- lib/config/builder/config.ts | 10 ++- lib/config/builder/list.ts | 8 ++- lib/config/builder/value.ts | 11 +++- lib/config/builder/variants.ts | 5 +- lib/config/configTypes.ts | 12 +++- lib/config/configTypesRaw.ts | 3 +- lib/health/healthRunner.ts | 11 ++-- lib/test/configBuilder.test.ts | 5 +- lib/test/configTypes.test.ts | 10 ++- lib/test/makeOutput.ts | 42 ++++++++----- lib/test/output.test.ts | 43 ++++++++++--- lib/types.ts | 111 ++++++++++++++++++++++++++------- lib/util/propertiesMatcher.ts | 93 +++++++++++++++++++++------ package-lock.json | 4 +- scripts/oldSpecToBuilder.ts | 55 ++++++++++++---- 15 files changed, 326 insertions(+), 97 deletions(-) diff --git a/lib/config/builder/config.ts b/lib/config/builder/config.ts index e8b2d30..d63568a 100644 --- a/lib/config/builder/config.ts +++ b/lib/config/builder/config.ts @@ -63,10 +63,16 @@ export class Config extends IBuilder { static empty() { return new Config({}); } - static withValue(key: K, value: Value) { + static withValue( + key: K, + value: Value + ) { return Config.empty().withValue(key, value); } - static addValue(key: K, value: Value) { + static addValue( + key: K, + value: Value + ) { return Config.empty().withValue(key, value); } diff --git a/lib/config/builder/list.ts b/lib/config/builder/list.ts index d5627e6..d3686ce 100644 --- a/lib/config/builder/list.ts +++ b/lib/config/builder/list.ts @@ -1,6 +1,12 @@ import { BuilderExtract, IBuilder } from "./builder"; import { Config } from "./config"; -import { InputSpec, ListValueSpecNumber, ListValueSpecString, UniqueBy, ValueSpecList } from "../configTypes"; +import { + InputSpec, + ListValueSpecNumber, + ListValueSpecString, + UniqueBy, + ValueSpecList, +} from "../configTypes"; import { guardAll } from "../../util"; /** * Used as a subtype of Value.list diff --git a/lib/config/builder/value.ts b/lib/config/builder/value.ts index 507ed45..65576d6 100644 --- a/lib/config/builder/value.ts +++ b/lib/config/builder/value.ts @@ -35,7 +35,12 @@ const username = Value.string({ ``` */ export class Value extends IBuilder { - static boolean(a: { name: string; description?: string | null; warning?: string | null; default?: boolean | null }) { + static boolean(a: { + name: string; + description?: string | null; + warning?: string | null; + default?: boolean | null; + }) { return new Value({ description: null, warning: null, @@ -161,7 +166,9 @@ export class Value extends IBuilder { spec, }); } - static union>( + static union< + V extends Variants<{ [key: string]: { name: string; spec: InputSpec } }> + >( a: { name: string; description?: string | null; diff --git a/lib/config/builder/variants.ts b/lib/config/builder/variants.ts index 6819171..26bfc46 100644 --- a/lib/config/builder/variants.ts +++ b/lib/config/builder/variants.ts @@ -80,7 +80,10 @@ export class Variants< static empty() { return Variants.of({}); } - static withVariant(key: K, value: Config) { + static withVariant( + key: K, + value: Config + ) { return Variants.empty().withVariant(key, value); } diff --git a/lib/config/configTypes.ts b/lib/config/configTypes.ts index f5c018c..726d156 100644 --- a/lib/config/configTypes.ts +++ b/lib/config/configTypes.ts @@ -11,7 +11,9 @@ export type InputSpec = Record>; export type ValueSpec = WithOutOptionals; /** core spec types. These types provide the metadata for performing validations */ -export type ValueSpecOf = WithOutOptionals>; +export type ValueSpecOf = WithOutOptionals< + C.ValueSpecOf +>; export type ValueSpecString = WithOutOptionals; export type ValueSpecTextarea = WithOutOptionals; @@ -27,11 +29,15 @@ export type SelectBase = WithOutOptionals; export type ListValueSpecType = WithOutOptionals; /** represents a spec for the values of a list */ -export type ListValueSpecOf = WithOutOptionals>; +export type ListValueSpecOf = WithOutOptionals< + C.ListValueSpecOf +>; /** represents a spec for a list */ export type ValueSpecList = WithOutOptionals; -export type ValueSpecListOf = WithOutOptionals>; +export type ValueSpecListOf = WithOutOptionals< + C.ValueSpecListOf +>; // sometimes the type checker needs just a little bit of help export function isValueSpecListOf( diff --git a/lib/config/configTypesRaw.ts b/lib/config/configTypesRaw.ts index 7bef8e0..9b88911 100644 --- a/lib/config/configTypesRaw.ts +++ b/lib/config/configTypesRaw.ts @@ -101,7 +101,8 @@ export type ListValueSpecOf = T extends "string" : never; /** represents a spec for a list */ export type ValueSpecList = ValueSpecListOf; -export interface ValueSpecListOf extends WithStandalone { +export interface ValueSpecListOf + extends WithStandalone { type: "list"; spec: ListValueSpecOf; range?: string; diff --git a/lib/health/healthRunner.ts b/lib/health/healthRunner.ts index 4f84e85..c02449c 100644 --- a/lib/health/healthRunner.ts +++ b/lib/health/healthRunner.ts @@ -37,18 +37,15 @@ async function timeoutHealth( * The stop function is used to stop the health check. */ -export default function healthRunner( - name: string, - fn: HealthCheck, -) { +export default function healthRunner(name: string, fn: HealthCheck) { return { /** * All values in seconds. Defaults): - * + * * interval: 60s - * + * * timeout: 10s - * + * * delay: 10s */ create( diff --git a/lib/test/configBuilder.test.ts b/lib/test/configBuilder.test.ts index 509d3e4..bd098ca 100644 --- a/lib/test/configBuilder.test.ts +++ b/lib/test/configBuilder.test.ts @@ -141,7 +141,10 @@ describe("values", () => { const validator = value.validator(); validator.unsafeCast({ unionSelectKey: "a", unionValueKey: { b: false } }); type Test = typeof validator._TYPE; - testOutput()(null); + testOutput< + Test, + { unionSelectKey: "a" } & { unionValueKey: { b: boolean } } + >()(null); }); test("list", () => { const value = Value.list( diff --git a/lib/test/configTypes.test.ts b/lib/test/configTypes.test.ts index ae186b4..0e6cf55 100644 --- a/lib/test/configTypes.test.ts +++ b/lib/test/configTypes.test.ts @@ -1,4 +1,8 @@ -import { ListValueSpecOf, ValueSpecList, isValueSpecListOf } from "../config/configTypes"; +import { + ListValueSpecOf, + ValueSpecList, + isValueSpecListOf, +} from "../config/configTypes"; import { Config } from "../config/builder/config"; import { List } from "../config/builder/list"; import { Value } from "../config/builder/value"; @@ -16,7 +20,9 @@ describe("Config Types", () => { } else if (isValueSpecListOf(someList, "object")) { someList.spec satisfies ListValueSpecOf<"object">; } else { - throw new Error("Failed to figure out the type: " + JSON.stringify(someList)); + throw new Error( + "Failed to figure out the type: " + JSON.stringify(someList) + ); } } }); diff --git a/lib/test/makeOutput.ts b/lib/test/makeOutput.ts index 1180415..756ff56 100644 --- a/lib/test/makeOutput.ts +++ b/lib/test/makeOutput.ts @@ -18,7 +18,8 @@ writeConvertedFile( tag: { id: "type", name: "Type", - description: "- LND: Lightning Network Daemon from Lightning Labs\n- CLN: Core Lightning from Blockstream\n", + description: + "- LND: Lightning Network Daemon from Lightning Labs\n- CLN: Core Lightning from Blockstream\n", "variant-names": { lnd: "Lightning Network Daemon (LND)", "c-lightning": "Core Lightning (CLN)", @@ -57,7 +58,8 @@ writeConvertedFile( default: "bitcoin", masked: true, pattern: "^[a-zA-Z0-9_]+$", - "pattern-description": "Must be alphanumeric (can contain underscore).", + "pattern-description": + "Must be alphanumeric (can contain underscore).", }, password: { type: "string", @@ -69,7 +71,8 @@ writeConvertedFile( len: 20, }, pattern: '^[^\\n"]*$', - "pattern-description": "Must not contain newline or quote characters.", + "pattern-description": + "Must not contain newline or quote characters.", copyable: true, masked: true, }, @@ -81,7 +84,8 @@ writeConvertedFile( default: "bitcoin", masked: true, pattern: "^[a-zA-Z0-9_]+$", - "pattern-description": "Must be alphanumeric (can contain underscore).", + "pattern-description": + "Must be alphanumeric (can contain underscore).", textarea: true, }, advanced: { @@ -97,15 +101,18 @@ writeConvertedFile( subtype: "string", default: [], spec: { - pattern: "^[a-zA-Z0-9_-]+:([0-9a-fA-F]{2})+\\$([0-9a-fA-F]{2})+$", - "pattern-description": 'Each item must be of the form ":$".', + pattern: + "^[a-zA-Z0-9_-]+:([0-9a-fA-F]{2})+\\$([0-9a-fA-F]{2})+$", + "pattern-description": + 'Each item must be of the form ":$".', masked: false, }, range: "[0,*)", }, serialversion: { name: "Serialization Version", - description: "Return raw transaction or block hex with Segwit or non-SegWit serialization.", + description: + "Return raw transaction or block hex with Segwit or non-SegWit serialization.", type: "enum", values: ["non-segwit", "segwit"], "value-names": {}, @@ -113,7 +120,8 @@ writeConvertedFile( }, servertimeout: { name: "Rpc Server Timeout", - description: "Number of seconds after which an uncompleted RPC call will time out.", + description: + "Number of seconds after which an uncompleted RPC call will time out.", type: "number", nullable: false, range: "[5,300]", @@ -216,7 +224,8 @@ writeConvertedFile( type: "number", nullable: false, name: "Max Mempool Size", - description: "Keep the transaction memory pool below megabytes.", + description: + "Keep the transaction memory pool below megabytes.", range: "[1,*)", integral: true, units: "MiB", @@ -226,7 +235,8 @@ writeConvertedFile( type: "number", nullable: false, name: "Mempool Expiration", - description: "Do not keep transactions in the mempool longer than hours.", + description: + "Do not keep transactions in the mempool longer than hours.", range: "[1,*)", integral: true, units: "Hr", @@ -242,7 +252,8 @@ writeConvertedFile( listen: { type: "boolean", name: "Make Public", - description: "Allow other nodes to find your server on the network.", + description: + "Allow other nodes to find your server on the network.", default: true, }, onlyconnect: { @@ -282,7 +293,8 @@ writeConvertedFile( type: "number", nullable: true, name: "Port", - description: "Port that peer is listening on for inbound p2p connections", + description: + "Port that peer is listening on for inbound p2p connections", range: "[0,65535]", integral: true, }, @@ -306,7 +318,8 @@ writeConvertedFile( pruning: { type: "union", name: "Pruning Settings", - description: "Blockchain Pruning Options\nReduce the blockchain size on disk\n", + description: + "Blockchain Pruning Options\nReduce the blockchain size on disk\n", warning: "If you set pruning to Manual and your disk is smaller than the total size of the blockchain, you MUST have something running that prunes these blocks or you may overfill your disk!\nDisabling pruning will convert your node into a full archival node. This requires a resync of the entire blockchain, a process that may take several days. Make sure you have enough free disk space or you may fill up your disk.\n", tag: { @@ -328,7 +341,8 @@ writeConvertedFile( nullable: false, name: "Max Chain Size", description: "Limit of blockchain size on disk.", - warning: "Increasing this value will require re-syncing your node.", + warning: + "Increasing this value will require re-syncing your node.", default: 550, range: "[550,1000000)", integral: true, diff --git a/lib/test/output.test.ts b/lib/test/output.test.ts index e7d59dc..ed39cd5 100644 --- a/lib/test/output.test.ts +++ b/lib/test/output.test.ts @@ -1,8 +1,15 @@ import { Parser } from "ts-matches"; -import { UnionSelectKey, unionSelectKey, UnionValueKey, unionValueKey } from "../config/configTypes"; +import { + UnionSelectKey, + unionSelectKey, + UnionValueKey, + unionValueKey, +} from "../config/configTypes"; import { InputSpec, matchInputSpec, testListUnion } from "./output"; -export type IfEquals = (() => G extends T ? 1 : 2) extends () => G extends U ? 1 : 2 +export type IfEquals = (() => G extends T + ? 1 + : 2) extends () => G extends U ? 1 : 2 ? Y : N; export function testOutput(): (c: IfEquals) => null { @@ -12,7 +19,11 @@ export function testOutput(): (c: IfEquals) => null { function isObject(item: unknown): item is object { return !!(item && typeof item === "object" && !Array.isArray(item)); } -type UnionToIntersection = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never; +type UnionToIntersection = (T extends any ? (x: T) => any : never) extends ( + x: infer R +) => any + ? R + : never; export function mergeDeep(...sources: A) { return _mergeDeep({}, ...sources); } @@ -44,11 +55,21 @@ testOutput()(null); testOutput()(null); testOutput()(null); -testOutput()(null); +testOutput< + InputSpec["rpc"]["advanced"]["serialversion"], + "segwit" | "non-segwit" +>()(null); testOutput()(null); -testOutput()(null); -testOutput()(null); -testOutput()(null); +testOutput()( + null +); +testOutput< + InputSpec["testListUnion"][0]["union"][UnionValueKey]["name"], + string +>()(null); +testOutput()( + null +); // prettier-ignore // @ts-expect-error Expect that the string is the one above testOutput()(null); @@ -117,9 +138,13 @@ describe("Inputs", () => { }); test("test errors", () => { expect(() => - matchInputSpec.unsafeCast(mergeDeep(validInput, { rpc: { advanced: { threads: 0 } } })) + matchInputSpec.unsafeCast( + mergeDeep(validInput, { rpc: { advanced: { threads: 0 } } }) + ) + ).toThrowError(); + expect(() => + matchInputSpec.unsafeCast(mergeDeep(validInput, { rpc: { enable: 2 } })) ).toThrowError(); - expect(() => matchInputSpec.unsafeCast(mergeDeep(validInput, { rpc: { enable: 2 } }))).toThrowError(); expect(() => matchInputSpec.unsafeCast( diff --git a/lib/types.ts b/lib/types.ts index 774213f..00f7486 100644 --- a/lib/types.ts +++ b/lib/types.ts @@ -4,24 +4,39 @@ import { InputSpec } from "./config/configTypes"; export namespace ExpectedExports { version: 1; /** Set configuration is called after we have modified and saved the configuration in the embassy ui. Use this to make a file for the docker to read from for configuration. */ - export type setConfig = (options: { effects: Effects; input: Record }) => Promise; + export type setConfig = (options: { + effects: Effects; + input: Record; + }) => Promise; /** Get configuration returns a shape that describes the format that the embassy ui will generate, and later send to the set config */ - export type getConfig = (options: { effects: Effects; config: unknown }) => Promise; + export type getConfig = (options: { + effects: Effects; + config: unknown; + }) => Promise; /** These are how we make sure the our dependency configurations are valid and if not how to fix them. */ export type dependencies = Dependencies; /** For backing up service data though the embassyOS UI */ - export type createBackup = (options: { effects: Effects }) => Promise; + export type createBackup = (options: { + effects: Effects; + }) => Promise; /** For restoring service data that was previously backed up using the embassyOS UI create backup flow. Backup restores are also triggered via the embassyOS UI, or doing a system restore flow during setup. */ - export type restoreBackup = (options: { effects: Effects }) => Promise; + export type restoreBackup = (options: { + effects: Effects; + }) => Promise; /** Properties are used to get values from the docker, like a username + password, what ports we are hosting from */ - export type properties = (options: { effects: Effects }) => Promise; + export type properties = (options: { + effects: Effects; + }) => Promise; /** Health checks are used to determine if the service is working properly after starting * A good use case is if we are using a web server, seeing if we can get to the web server. */ export type health = { /** Should be the health check id */ - [id: string]: (options: { effects: Effects; input: TimeMs }) => Promise; + [id: string]: (options: { + effects: Effects; + input: TimeMs; + }) => Promise; }; /** @@ -30,24 +45,36 @@ export namespace ExpectedExports { * service starting, and that file would indicate that it would rescan all the data. */ export type action = { - [id: string]: (options: { effects: Effects; input?: Record }) => Promise; + [id: string]: (options: { + effects: Effects; + input?: Record; + }) => Promise; }; /** * This is the entrypoint for the main container. Used to start up something like the service that the * package represents, like running a bitcoind in a bitcoind-wrapper. */ - export type main = (options: { effects: Effects; started(onTerm: () => void): null }) => Promise; + export type main = (options: { + effects: Effects; + started(onTerm: () => void): null; + }) => Promise; /** * Every time a package completes an install, this function is called before the main. * Can be used to do migration like things. */ - export type init = (options: { effects: Effects; previousVersion: null | string }) => Promise; + export type init = (options: { + effects: Effects; + previousVersion: null | string; + }) => Promise; /** This will be ran during any time a package is uninstalled, for example during a update * this will be called. */ - export type uninit = (options: { effects: Effects; nextVersion: null | string }) => Promise; + export type uninit = (options: { + effects: Effects; + nextVersion: null | string; + }) => Promise; } export type TimeMs = number; export type VersionString = string; @@ -61,7 +88,11 @@ export type ConfigRes = { /** Used to reach out from the pure js runtime */ export type Effects = { /** Usable when not sandboxed */ - writeFile(input: { path: string; volumeId: string; toWrite: string }): Promise; + writeFile(input: { + path: string; + volumeId: string; + toWrite: string; + }): Promise; readFile(input: { volumeId: string; path: string }): Promise; metadata(input: { volumeId: string; path: string }): Promise; /** Create a directory. Usable when not sandboxed */ @@ -73,13 +104,27 @@ export type Effects = { removeFile(input: { volumeId: string; path: string }): Promise; /** Write a json file into an object. Usable when not sandboxed */ - writeJsonFile(input: { volumeId: string; path: string; toWrite: Record }): Promise; + writeJsonFile(input: { + volumeId: string; + path: string; + toWrite: Record; + }): Promise; /** Read a json file into an object */ - readJsonFile(input: { volumeId: string; path: string }): Promise>; + readJsonFile(input: { + volumeId: string; + path: string; + }): Promise>; - shell(command: string, options?: { timeoutMillis?: number | null }): Promise; - runCommand(input: { command: string; args?: string[]; timeoutMillis?: number }): Promise; + shell( + command: string, + options?: { timeoutMillis?: number | null } + ): Promise; + runCommand(input: { + command: string; + args?: string[]; + timeoutMillis?: number; + }): Promise; runDaemon(input: { command: string; args?: string[] }): { wait(): Promise; term(): Promise; @@ -109,9 +154,17 @@ export type Effects = { /** Check that a file exists or not */ exists(input: { volumeId: string; path: string }): Promise; /** Declaring that we are opening a interface on some protocal for local network */ - bindLocal(options: { internalPort: number; name: string; externalPort: number }): Promise; + bindLocal(options: { + internalPort: number; + name: string; + externalPort: number; + }): Promise; /** Declaring that we are opening a interface on some protocal for tor network */ - bindTor(options: { internalPort: number; name: string; externalPort: number }): Promise; + bindTor(options: { + internalPort: number; + name: string; + externalPort: number; + }): Promise; /** Similar to the fetch api via the mdn, this is simplified but the point is * to get something from some website, and return the response. @@ -159,13 +212,22 @@ export type Effects = { }): Promise; /** Get the address for another service for local internet*/ - getServiceLocalAddress(options: { packageId: string; interfaceName: string }): Promise; + getServiceLocalAddress(options: { + packageId: string; + interfaceName: string; + }): Promise; /** Get the address for another service for tor interfaces */ - getServiceTorAddress(options: { packageId: string; interfaceName: string }): Promise; + getServiceTorAddress(options: { + packageId: string; + interfaceName: string; + }): Promise; /** * Get the port address for another service */ - getServicePortForward(options: { packageId: string; internalPort: number }): Promise; + getServicePortForward(options: { + packageId: string; + internalPort: number; + }): Promise; /** When we want to create a link in the front end interfaces, and example is * exposing a url to view a web service @@ -221,7 +283,10 @@ export type Effects = { * * @returns PEM encoded fullchain (ecdsa) */ - getSslCertificate: (packageId: string, algorithm?: "ecdsa" | "ed25519") => [string, string, string]; + getSslCertificate: ( + packageId: string, + algorithm?: "ecdsa" | "ed25519" + ) => [string, string, string]; /** * @returns PEM encoded ssl key (ecdsa) */ @@ -349,4 +414,6 @@ export type Dependencies = { }; }; -export type DeepPartial = T extends {} ? { [P in keyof T]?: DeepPartial } : T; +export type DeepPartial = T extends {} + ? { [P in keyof T]?: DeepPartial } + : T; diff --git a/lib/util/propertiesMatcher.ts b/lib/util/propertiesMatcher.ts index 4299eab..efce533 100644 --- a/lib/util/propertiesMatcher.ts +++ b/lib/util/propertiesMatcher.ts @@ -10,7 +10,17 @@ import { ValueSpec as ValueSpecAny, } from "../config/configTypes"; -const { string, some, arrayOf, object, dictionary, unknown, number, literals, boolean } = matches; +const { + string, + some, + arrayOf, + object, + dictionary, + unknown, + number, + literals, + boolean, +} = matches; type TypeBoolean = "boolean"; type TypeString = "string"; @@ -132,18 +142,28 @@ function charRange(value = "") { * @param param1 * @returns */ -export function generateDefault(generate: { charset: string; len: number }, { random = () => Math.random() } = {}) { - const validCharSets: number[][] = generate.charset.split(",").map(charRange).filter(Array.isArray); +export function generateDefault( + generate: { charset: string; len: number }, + { random = () => Math.random() } = {} +) { + const validCharSets: number[][] = generate.charset + .split(",") + .map(charRange) + .filter(Array.isArray); if (validCharSets.length === 0) { throw new Error("Expecing that we have a valid charset"); } - const max = validCharSets.reduce((acc, x) => x.reduce((x, y) => Math.max(x, y), acc), 0); + const max = validCharSets.reduce( + (acc, x) => x.reduce((x, y) => Math.max(x, y), acc), + 0 + ); let i = 0; const answer: string[] = Array(generate.len); while (i < generate.len) { const nextValue = Math.round(random() * max); const inRange = validCharSets.reduce( - (acc, [lower, upper]) => acc || (nextValue >= lower && nextValue <= upper), + (acc, [lower, upper]) => + acc || (nextValue >= lower && nextValue <= upper), false ); if (!inRange) continue; @@ -160,8 +180,16 @@ export function matchNumberWithRange(range: string) { return number .validate( - leftValue === "*" ? (_) => true : left === "[" ? (x) => x >= Number(leftValue) : (x) => x > Number(leftValue), - leftValue === "*" ? "any" : left === "[" ? `greaterThanOrEqualTo${leftValue}` : `greaterThan${leftValue}` + leftValue === "*" + ? (_) => true + : left === "[" + ? (x) => x >= Number(leftValue) + : (x) => x > Number(leftValue), + leftValue === "*" + ? "any" + : left === "[" + ? `greaterThanOrEqualTo${leftValue}` + : `greaterThan${leftValue}` ) .validate( // prettier-ignore @@ -193,7 +221,9 @@ const isGenerator = object({ function defaultRequired(parser: Parser, value: unknown) { if (matchDefault.test(value)) { if (isGenerator(value.default)) { - return parser.defaultTo(parser.unsafeCast(generateDefault(value.default))); + return parser.defaultTo( + parser.unsafeCast(generateDefault(value.default)) + ); } return parser.defaultTo(value.default); } @@ -209,7 +239,9 @@ function defaultRequired(parser: Parser, value: unknown) { * @param value * @returns */ -export function guardAll(value: A): Parser> { +export function guardAll( + value: A +): Parser> { if (!isType.test(value)) { return unknown as any; } @@ -224,7 +256,10 @@ export function guardAll(value: A): Parser(value: A): Parser true); + const rangeValidate = + (matchRange.test(value) && matchNumberWithRange(value.range).test) || + (() => true); return defaultRequired( - matches.arrayOf(guardAll(spec as any)).validate((x) => rangeValidate(x.length), "valid length"), + matches + .arrayOf(guardAll(spec as any)) + .validate((x) => rangeValidate(x.length), "valid length"), value ) as any; } case "select": if (matchValues.test(value)) { const valueKeys = Object.keys(value.values); - return defaultRequired(literals(valueKeys[0], ...valueKeys), value) as any; + return defaultRequired( + literals(valueKeys[0], ...valueKeys), + value + ) as any; } return unknown as any; case "multiselect": if (matchValues.test(value)) { - const maybeAddRangeValidate = , B>(x: X) => { + const maybeAddRangeValidate = , B>( + x: X + ) => { if (!matchRange.test(value)) return x; - return x.validate((x) => matchNumberWithRange(value.range).test(x.length), "validLength"); + return x.validate( + (x) => matchNumberWithRange(value.range).test(x.length), + "validLength" + ); }; const valueKeys = Object.keys(value.values); - return defaultRequired(maybeAddRangeValidate(arrayOf(literals(valueKeys[0], ...valueKeys))), value) as any; + return defaultRequired( + maybeAddRangeValidate(arrayOf(literals(valueKeys[0], ...valueKeys))), + value + ) as any; } return unknown as any; @@ -286,9 +336,16 @@ export function guardAll(value: A): Parser(valueDictionary: A): Parser> { +export function typeFromProps( + valueDictionary: A +): Parser> { if (!recordString.test(valueDictionary)) return unknown as any; return object( - Object.fromEntries(Object.entries(valueDictionary).map(([key, value]) => [key, guardAll(value)])) + Object.fromEntries( + Object.entries(valueDictionary).map(([key, value]) => [ + key, + guardAll(value), + ]) + ) ) as any; } diff --git a/package-lock.json b/package-lock.json index e336efb..4f3c7c0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "start-sdk", - "version": "0.4.0-lib0.beta9", + "version": "0.4.0-lib0.charlie1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "start-sdk", - "version": "0.4.0-lib0.beta9", + "version": "0.4.0-lib0.charlie1", "license": "MIT", "dependencies": { "@iarna/toml": "^2.2.5", diff --git a/scripts/oldSpecToBuilder.ts b/scripts/oldSpecToBuilder.ts index 2444a4f..ccd0d9f 100644 --- a/scripts/oldSpecToBuilder.ts +++ b/scripts/oldSpecToBuilder.ts @@ -8,10 +8,15 @@ export async function writeConvertedFile( inputData: Promise | any, options: Parameters[1] ) { - await fs.writeFile(file, await makeFileContent(inputData, options), (err) => console.error(err)); + await fs.writeFile(file, await makeFileContent(inputData, options), (err) => + console.error(err) + ); } -export default async function makeFileContent(inputData: Promise | any, { startSdk = "start-sdk" } = {}) { +export default async function makeFileContent( + inputData: Promise | any, + { startSdk = "start-sdk" } = {} +) { const outputLines: string[] = []; outputLines.push(` import {Config, Value, List, Variants} from '${startSdk}/config/builder'; @@ -20,8 +25,13 @@ export default async function makeFileContent(inputData: Promise | any, { s const namedConsts = new Set(["Config", "Value", "List"]); const configName = newConst("InputSpec", convertInputSpec(data)); - const configMatcherName = newConst("matchInputSpec", `${configName}.validator()`); - outputLines.push(`export type InputSpec = typeof ${configMatcherName}._TYPE;`); + const configMatcherName = newConst( + "matchInputSpec", + `${configName}.validator()` + ); + outputLines.push( + `export type InputSpec = typeof ${configMatcherName}._TYPE;` + ); return outputLines.join("\n"); @@ -101,7 +111,10 @@ export default async function makeFileContent(inputData: Promise | any, { s )})`; } case "enum": { - const allValueNames = new Set([...(value?.["values"] || []), ...Object.keys(value?.["value-names"] || {})]); + const allValueNames = new Set([ + ...(value?.["values"] || []), + ...Object.keys(value?.["value-names"] || {}), + ]); const values = Object.fromEntries( Array.from(allValueNames) .filter(string.test) @@ -121,7 +134,10 @@ export default async function makeFileContent(inputData: Promise | any, { s )} as const)`; } case "object": { - const specName = newConst(value.name + "_spec", convertInputSpec(value.spec)); + const specName = newConst( + value.name + "_spec", + convertInputSpec(value.spec) + ); return `Value.object({ name: ${JSON.stringify(value.name || null)}, description: ${JSON.stringify(value.description || null)}, @@ -158,7 +174,9 @@ export default async function makeFileContent(inputData: Promise | any, { s function convertList(value: any) { switch (value.subtype) { case "string": { - return `List.${value?.spec?.textarea === true ? "textarea" : "string"}(${JSON.stringify( + return `List.${ + value?.spec?.textarea === true ? "textarea" : "string" + }(${JSON.stringify( { name: value.name || null, range: value.range || null, @@ -217,7 +235,10 @@ export default async function makeFileContent(inputData: Promise | any, { s )})`; } case "object": { - const specName = newConst(value.name + "_spec", convertInputSpec(value.spec.spec)); + const specName = newConst( + value.name + "_spec", + convertInputSpec(value.spec.spec) + ); return `List.obj({ name: ${JSON.stringify(value.name || null)}, range: ${JSON.stringify(value.range || null)}, @@ -233,14 +254,19 @@ export default async function makeFileContent(inputData: Promise | any, { s case "union": { const variants = newConst( value.name + "_variants", - convertVariants(value.spec.variants, value.spec["variant-names"] || {}) + convertVariants( + value.spec.variants, + value.spec["variant-names"] || {} + ) ); const unionValueName = newConst( value.name + "_union", ` Value.union({ name: ${JSON.stringify(value?.spec?.tag?.name || null)}, - description: ${JSON.stringify(value?.spec?.tag?.description || null)}, + description: ${JSON.stringify( + value?.spec?.tag?.description || null + )}, warning: ${JSON.stringify(value?.spec?.tag?.warning || null)}, required: ${JSON.stringify(!(value?.spec?.tag?.nullable || false))}, default: ${JSON.stringify(value?.spec?.default || null)}, @@ -271,11 +297,16 @@ export default async function makeFileContent(inputData: Promise | any, { s throw new Error(`Unknown subtype "${value.subtype}"`); } - function convertVariants(variants: Record, variantNames: Record): string { + function convertVariants( + variants: Record, + variantNames: Record + ): string { let answer = "Variants.of({"; for (const [key, value] of Object.entries(variants)) { const variantSpec = newConst(key, convertInputSpec(value)); - answer += `"${key}": {name: "${variantNames[key] || key}", spec: ${variantSpec}},`; + answer += `"${key}": {name: "${ + variantNames[key] || key + }", spec: ${variantSpec}},`; } return `${answer}})`; }