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

import { BuilderExtract, IBuilder } from "./builder";
import { Config } from "./config";
import {
  InputSpec,
  ListValueSpecNumber,
  ListValueSpecString,
  UniqueBy,
  ValueSpecList,
} from "../configTypes";
import { guardAll } from "../../util";
/**
 * 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<A extends ValueSpecList> extends IBuilder<A> {
  static string(
    a: {
      name: string;
      description?: string | null;
      warning?: string | null;
      /** Default = [] */
      default?: string[];
      /** Default = "(\*,\*)" */
      range?: string;
    },
    aSpec: {
      /** Default = false */
      masked?: boolean;
      placeholder?: string | null;
      pattern?: string | null;
      patternDescription?: string | null;
      /** Default = "text" */
      inputmode?: ListValueSpecString["inputmode"];
    }
  ) {
    const spec = {
      type: "string" as const,
      placeholder: null,
      pattern: null,
      patternDescription: null,
      masked: false,
      inputmode: "text" as const,
      ...aSpec,
    };
    return new List({
      description: null,
      warning: null,
      default: [],
      type: "list" as const,
      range: "(*,*)",
      ...a,
      spec,
    });
  }
  static number(
    a: {
      name: string;
      description?: string | null;
      warning?: string | null;
      /** Default = [] */
      default?: string[];
      /** Default = "(\*,\*)" */
      range?: string;
    },
    aSpec: {
      integral: boolean;
      /** Default = "(\*,\*)" */
      range?: string;
      units?: string | null;
      placeholder?: string | null;
    }
  ) {
    const spec = {
      type: "number" as const,
      placeholder: null,
      range: "(*,*)",
      units: null,
      ...aSpec,
    };
    return new List({
      description: null,
      warning: null,
      units: null,
      range: "(*,*)",
      default: [],
      type: "list" as const,
      ...a,
      spec,
    });
  }
  static obj<Spec extends Config<InputSpec>>(
    a: {
      name: string;
      description?: string | null;
      warning?: string | null;
      /** Default [] */
      default?: Record<string, unknown>[];
      /** Default = "(\*,\*)" */
      range?: string;
    },
    aSpec: {
      spec: Spec;
      displayAs?: null | string;
      uniqueBy?: null | UniqueBy;
    }
  ) {
    const { spec: previousSpecSpec, ...restSpec } = aSpec;
    const specSpec = previousSpecSpec.build() as BuilderExtract<Spec>;
    const spec = {
      type: "object" as const,
      displayAs: null,
      uniqueBy: null,
      ...restSpec,
      spec: specSpec,
    };
    const value = {
      spec,
      default: [],
      ...a,
    };
    return new List({
      description: null,
      warning: null,
      range: "(*,*)",
      type: "list" as const,
      ...value,
    });
  }

  public validator() {
    return guardAll(this.a);
  }
}