merge 036, everything broken

sdk/lib/interfaces/AddressReceipt.ts

@@ -0,0 +1,4 @@
+declare const AddressProof: unique symbol
+export type AddressReceipt = {
+  [AddressProof]: never
+}

sdk/lib/interfaces/Host.ts

@@ -0,0 +1,205 @@
+import { object, string } from "ts-matches"
+import { Effects } from "../types"
+import { Origin } from "./Origin"
+
+const knownProtocols = {
+  http: {
+    secure: false,
+    ssl: false,
+    defaultPort: 80,
+    withSsl: "https",
+  },
+  https: {
+    secure: true,
+    ssl: true,
+    defaultPort: 443,
+  },
+  ws: {
+    secure: false,
+    ssl: false,
+    defaultPort: 80,
+    withSsl: "wss",
+  },
+  wss: {
+    secure: true,
+    ssl: true,
+    defaultPort: 443,
+  },
+  ssh: {
+    secure: true,
+    ssl: false,
+    defaultPort: 22,
+  },
+  bitcoin: {
+    secure: true,
+    ssl: false,
+    defaultPort: 8333,
+  },
+  lightning: {
+    secure: true,
+    ssl: true,
+    defaultPort: 9735,
+  },
+  grpc: {
+    secure: true,
+    ssl: true,
+    defaultPort: 50051,
+  },
+  dns: {
+    secure: true,
+    ssl: false,
+    defaultPort: 53,
+  },
+} as const
+
+export type Scheme = string | null
+
+type AddSslOptions = {
+  scheme: Scheme
+  preferredExternalPort: number
+  addXForwardedHeaders: boolean | null /** default: false */
+}
+type Security = { ssl: boolean }
+export type BindOptions = {
+  scheme: Scheme
+  preferredExternalPort: number
+  addSsl: AddSslOptions | null
+  secure: Security | null
+}
+type KnownProtocols = typeof knownProtocols
+type ProtocolsWithSslVariants = {
+  [K in keyof KnownProtocols]: KnownProtocols[K] extends {
+    withSsl: string
+  }
+    ? K
+    : never
+}[keyof KnownProtocols]
+type NotProtocolsWithSslVariants = Exclude<
+  keyof KnownProtocols,
+  ProtocolsWithSslVariants
+>
+
+type BindOptionsByKnownProtocol =
+  | {
+      protocol: ProtocolsWithSslVariants
+      preferredExternalPort?: number
+      scheme?: Scheme
+      addSsl?: Partial<AddSslOptions>
+    }
+  | {
+      protocol: NotProtocolsWithSslVariants
+      preferredExternalPort?: number
+      scheme?: Scheme
+      addSsl?: AddSslOptions
+    }
+type BindOptionsByProtocol = BindOptionsByKnownProtocol | BindOptions
+
+export type HostKind = "static" | "single" | "multi"
+
+const hasStringProtocol = object({
+  protocol: string,
+}).test
+
+export class Host {
+  constructor(
+    readonly options: {
+      effects: Effects
+      kind: HostKind
+      id: string
+    },
+  ) {}
+
+  async bindPort(
+    internalPort: number,
+    options: BindOptionsByProtocol,
+  ): Promise<Origin<this>> {
+    if (hasStringProtocol(options)) {
+      return await this.bindPortForKnown(options, internalPort)
+    } else {
+      return await this.bindPortForUnknown(internalPort, options)
+    }
+  }
+
+  private async bindPortForUnknown(
+    internalPort: number,
+    options: {
+      scheme: Scheme
+      preferredExternalPort: number
+      addSsl: AddSslOptions | null
+      secure: { ssl: boolean } | null
+    },
+  ) {
+    await this.options.effects.bind({
+      kind: this.options.kind,
+      id: this.options.id,
+      internalPort: internalPort,
+      ...options,
+    })
+
+    return new Origin(this, options)
+  }
+
+  private async bindPortForKnown(
+    options: BindOptionsByKnownProtocol,
+    internalPort: number,
+  ) {
+    const scheme =
+      options.scheme === undefined ? options.protocol : options.scheme
+    const protoInfo = knownProtocols[options.protocol]
+    const preferredExternalPort =
+      options.preferredExternalPort ||
+      knownProtocols[options.protocol].defaultPort
+    const addSsl = this.getAddSsl(options, protoInfo)
+
+    const secure: Security | null = !protoInfo.secure ? null : { ssl: false }
+
+    const newOptions = {
+      scheme,
+      preferredExternalPort,
+      addSsl,
+      secure,
+    }
+
+    await this.options.effects.bind({
+      kind: this.options.kind,
+      id: this.options.id,
+      internalPort,
+      ...newOptions,
+    })
+
+    return new Origin(this, newOptions)
+  }
+
+  private getAddSsl(
+    options: BindOptionsByKnownProtocol,
+    protoInfo: KnownProtocols[keyof KnownProtocols],
+  ): AddSslOptions | null {
+    if ("noAddSsl" in options && options.noAddSsl) return null
+    if ("withSsl" in protoInfo && protoInfo.withSsl)
+      return {
+        addXForwardedHeaders: null,
+        preferredExternalPort: knownProtocols[protoInfo.withSsl].defaultPort,
+        scheme: protoInfo.withSsl,
+        ...("addSsl" in options ? options.addSsl : null),
+      }
+    return null
+  }
+}
+
+export class StaticHost extends Host {
+  constructor(options: { effects: Effects; id: string }) {
+    super({ ...options, kind: "static" })
+  }
+}
+
+export class SingleHost extends Host {
+  constructor(options: { effects: Effects; id: string }) {
+    super({ ...options, kind: "single" })
+  }
+}
+
+export class MultiHost extends Host {
+  constructor(options: { effects: Effects; id: string }) {
+    super({ ...options, kind: "multi" })
+  }
+}

sdk/lib/interfaces/Origin.ts

@@ -0,0 +1,97 @@
+import { AddressInfo } from "../types"
+import { AddressReceipt } from "./AddressReceipt"
+import { Host, BindOptions, Scheme } from "./Host"
+import { ServiceInterfaceBuilder } from "./ServiceInterfaceBuilder"
+
+export class Origin<T extends Host> {
+  constructor(
+    readonly host: T,
+    readonly options: BindOptions,
+  ) {}
+
+  build({ username, path, search, schemeOverride }: BuildOptions): AddressInfo {
+    const qpEntries = Object.entries(search)
+      .map(
+        ([key, val]) => `${encodeURIComponent(key)}=${encodeURIComponent(val)}`,
+      )
+      .join("&")
+
+    const qp = qpEntries.length ? `?${qpEntries}` : ""
+
+    return {
+      hostId: this.host.options.id,
+      bindOptions: {
+        ...this.options,
+        scheme: schemeOverride ? schemeOverride.noSsl : this.options.scheme,
+        addSsl: this.options.addSsl
+          ? {
+              ...this.options.addSsl,
+              scheme: schemeOverride
+                ? schemeOverride.ssl
+                : this.options.addSsl.scheme,
+            }
+          : null,
+      },
+      suffix: `${path}${qp}`,
+      username,
+    }
+  }
+
+  /**
+   * A function to register a group of origins (<PROTOCOL> :// <HOSTNAME> : <PORT>) with StartOS
+   *
+   * The returned addressReceipt serves as proof that the addresses were registered
+   *
+   * @param addressInfo
+   * @returns
+   */
+  async export(
+    serviceInterfaces: ServiceInterfaceBuilder[],
+  ): Promise<AddressInfo[] & AddressReceipt> {
+    const addressesInfo = []
+    for (let serviceInterface of serviceInterfaces) {
+      const {
+        name,
+        description,
+        hasPrimary,
+        disabled,
+        id,
+        type,
+        username,
+        path,
+        search,
+        schemeOverride,
+        masked,
+      } = serviceInterface.options
+
+      const addressInfo = this.build({
+        username,
+        path,
+        search,
+        schemeOverride,
+      })
+
+      await serviceInterface.options.effects.exportServiceInterface({
+        id,
+        name,
+        description,
+        hasPrimary,
+        disabled,
+        addressInfo,
+        type,
+        masked,
+      })
+
+      addressesInfo.push(addressInfo)
+    }
+
+    return addressesInfo as AddressInfo[] & AddressReceipt
+  }
+}
+
+type BuildOptions = {
+  schemeOverride: { ssl: Scheme; noSsl: Scheme } | null
+  username: string | null
+  path: string
+  search: Record<string, string>
+}

sdk/lib/interfaces/ServiceInterfaceBuilder.ts

@@ -0,0 +1,33 @@
+import { ServiceInterfaceType } from "../StartSdk"
+import { Effects } from "../types"
+import { Scheme } from "./Host"
+
+/**
+ * A helper class for creating a Network Interface
+ *
+ * Network Interfaces are collections of web addresses that expose the same API or other resource,
+ * display to the user with under a common name and description.
+ *
+ * All URIs on an interface inherit the same ui: bool, basic auth credentials, path, and search (query) params
+ *
+ * @param options
+ * @returns
+ */
+export class ServiceInterfaceBuilder {
+  constructor(
+    readonly options: {
+      effects: Effects
+      name: string
+      id: string
+      description: string
+      hasPrimary: boolean
+      disabled: boolean
+      type: ServiceInterfaceType
+      username: string | null
+      path: string
+      search: Record<string, string>
+      schemeOverride: { ssl: Scheme; noSsl: Scheme } | null
+      masked: boolean
+    },
+  ) {}
+}

sdk/lib/interfaces/interfaceReceipt.ts

@@ -0,0 +1,4 @@
+declare const InterfaceProof: unique symbol
+export type InterfaceReceipt = {
+  [InterfaceProof]: never
+}

sdk/lib/interfaces/setupInterfaces.ts

@@ -0,0 +1,23 @@
+import { Config } from "../config/builder/config"
+import { SDKManifest } from "../manifest/ManifestTypes"
+import { AddressInfo, Effects } from "../types"
+import { AddressReceipt } from "./AddressReceipt"
+
+export type InterfacesReceipt = Array<AddressInfo[] & AddressReceipt>
+export type SetInterfaces<
+  Manifest extends SDKManifest,
+  Store,
+  ConfigInput extends Record<string, any>,
+  Output extends InterfacesReceipt,
+> = (opts: { effects: Effects; input: null | ConfigInput }) => Promise<Output>
+export type SetupInterfaces = <
+  Manifest extends SDKManifest,
+  Store,
+  ConfigInput extends Record<string, any>,
+  Output extends InterfacesReceipt,
+>(
+  config: Config<ConfigInput, Store>,
+  fn: SetInterfaces<Manifest, Store, ConfigInput, Output>,
+) => SetInterfaces<Manifest, Store, ConfigInput, Output>
+export const NO_INTERFACE_CHANGES = [] as InterfacesReceipt
+export const setupInterfaces: SetupInterfaces = (_config, fn) => fn