start-os/sdk/lib/config/builder/list.ts

import { Config, LazyBuild } from "./config"
import {
  ListValueSpecText,
  Pattern,
  RandomString,
  UniqueBy,
  ValueSpecList,
  ValueSpecListOf,
  ValueSpecText,
} from "../configTypes"
import { Parser, arrayOf, number, string } from "ts-matches"
/**
 * Used as a subtype of Value.list
```ts
export const authorizationList = List.string({
  "name": "Authorization",
  "range": "[0,*)",
  "default": [],
  "description": "Username and hashed password for JSON-RPC connections. RPC clients connect using the usual http basic authentication.",
  "warning": null
}, {"masked":false,"placeholder":null,"pattern":"^[a-zA-Z0-9_-]+:([0-9a-fA-F]{2})+\\$([0-9a-fA-F]{2})+$","patternDescription":"Each item must be of the form \"<USERNAME>:<SALT>$<HASH>\"."});
export const auth = Value.list(authorizationList);
```
*/
export class List<Type, Store> {
  private constructor(
    public build: LazyBuild<Store, ValueSpecList>,
    public validator: Parser<unknown, Type>,
  ) {}
  static text(
    a: {
      name: string
      description?: string | null
      warning?: string | null
      /** Default = [] */
      default?: string[]
      minLength?: number | null
      maxLength?: number | null
    },
    aSpec: {
      /** Default = false */
      masked?: boolean
      placeholder?: string | null
      minLength?: number | null
      maxLength?: number | null
      patterns: Pattern[]
      /** Default = "text" */
      inputmode?: ListValueSpecText["inputmode"]
      generate?: null | RandomString
    },
  ) {
    return new List<string[], never>(() => {
      const spec = {
        type: "text" as const,
        placeholder: null,
        minLength: null,
        maxLength: null,
        masked: false,
        inputmode: "text" as const,
        generate: null,
        ...aSpec,
      }
      const built: ValueSpecListOf<"text"> = {
        description: null,
        warning: null,
        default: [],
        type: "list" as const,
        minLength: null,
        maxLength: null,
        disabled: false,
        ...a,
        spec,
      }
      return built
    }, arrayOf(string))
  }
  static dynamicText<Store = never>(
    getA: LazyBuild<
      Store,
      {
        name: string
        description?: string | null
        warning?: string | null
        /** Default = [] */
        default?: string[]
        minLength?: number | null
        maxLength?: number | null
        disabled?: false | string
        generate?: null | RandomString
        spec: {
          /** Default = false */
          masked?: boolean
          placeholder?: string | null
          minLength?: number | null
          maxLength?: number | null
          patterns: Pattern[]
          /** Default = "text" */
          inputmode?: ListValueSpecText["inputmode"]
        }
      }
    >,
  ) {
    return new List<string[], Store>(async (options) => {
      const { spec: aSpec, ...a } = await getA(options)
      const spec = {
        type: "text" as const,
        placeholder: null,
        minLength: null,
        maxLength: null,
        masked: false,
        inputmode: "text" as const,
        generate: null,
        ...aSpec,
      }
      const built: ValueSpecListOf<"text"> = {
        description: null,
        warning: null,
        default: [],
        type: "list" as const,
        minLength: null,
        maxLength: null,
        disabled: false,
        ...a,
        spec,
      }
      return built
    }, arrayOf(string))
  }
  static number(
    a: {
      name: string
      description?: string | null
      warning?: string | null
      /** Default = [] */
      default?: string[]
      minLength?: number | null
      maxLength?: number | null
    },
    aSpec: {
      integer: boolean
      min?: number | null
      max?: number | null
      step?: number | null
      units?: string | null
      placeholder?: string | null
    },
  ) {
    return new List<number[], never>(() => {
      const spec = {
        type: "number" as const,
        placeholder: null,
        min: null,
        max: null,
        step: null,
        units: null,
        ...aSpec,
      }
      const built: ValueSpecListOf<"number"> = {
        description: null,
        warning: null,
        minLength: null,
        maxLength: null,
        default: [],
        type: "list" as const,
        disabled: false,
        ...a,
        spec,
      }
      return built
    }, arrayOf(number))
  }
  static dynamicNumber<Store = never>(
    getA: LazyBuild<
      Store,
      {
        name: string
        description?: string | null
        warning?: string | null
        /** Default = [] */
        default?: string[]
        minLength?: number | null
        maxLength?: number | null
        disabled?: false | string
        spec: {
          integer: boolean
          min?: number | null
          max?: number | null
          step?: number | null
          units?: string | null
          placeholder?: string | null
        }
      }
    >,
  ) {
    return new List<number[], Store>(async (options) => {
      const { spec: aSpec, ...a } = await getA(options)
      const spec = {
        type: "number" as const,
        placeholder: null,
        min: null,
        max: null,
        step: null,
        units: null,
        ...aSpec,
      }
      return {
        description: null,
        warning: null,
        minLength: null,
        maxLength: null,
        default: [],
        type: "list" as const,
        disabled: false,
        ...a,
        spec,
      }
    }, arrayOf(number))
  }
  static obj<Type extends Record<string, any>, Store>(
    a: {
      name: string
      description?: string | null
      warning?: string | null
      /** Default [] */
      default?: []
      minLength?: number | null
      maxLength?: number | null
    },
    aSpec: {
      spec: Config<Type, Store>
      displayAs?: null | string
      uniqueBy?: null | UniqueBy
    },
  ) {
    return new List<Type[], Store>(async (options) => {
      const { spec: previousSpecSpec, ...restSpec } = aSpec
      const specSpec = await previousSpecSpec.build(options)
      const spec = {
        type: "object" as const,
        displayAs: null,
        uniqueBy: null,
        ...restSpec,
        spec: specSpec,
      }
      const value = {
        spec,
        default: [],
        ...a,
      }
      return {
        description: null,
        warning: null,
        minLength: null,
        maxLength: null,
        type: "list" as const,
        disabled: false,
        ...value,
      }
    }, arrayOf(aSpec.spec.validator))
  }

  /**
   * Use this during the times that the input needs a more specific type.
   * Used in types that the value/ variant/ list/ config is constructed somewhere else.
  ```ts
  const a = Config.text({
    name: "a",
    required: false,
  })

  return Config.of<Store>()({
    myValue: a.withStore(),
  })
  ```
   */
  withStore<NewStore extends Store extends never ? any : Store>() {
    return this as any as List<Type, NewStore>
  }
}