@highstate/library 0.9.18 → 0.9.19

package/src/apps/gitea.ts

@@ -1,18 +0,0 @@
-import { defineUnit } from "@highstate/contract"
-import { createArgs, createInputs, createSource } from "./shared"
-
-export const gitea = defineUnit({
-  type: "apps.gitea",
-
-  args: createArgs("gitea"),
-  inputs: createInputs(["accessPoint", "mariadb"]),
-
-  meta: {
-    title: "Gitea",
-    description: "The Gitea Git server deployed on Kubernetes.",
-    icon: "simple-icons:gitea",
-    category: "Development",
-  },
-
-  source: createSource("gitea"),
-})

package/src/apps/grocy.ts

@@ -1,20 +0,0 @@
-import { defineUnit } from "@highstate/contract"
-import { createArgs, createInputs, createSecrets, createSource } from "./shared"
-
-export const grocy = defineUnit({
-  type: "apps.grocy",
-
-  args: createArgs("grocy", ["fqdn"]),
-  secrets: createSecrets(["backupPassword"]),
-  inputs: createInputs(["accessPoint", "resticRepo"]),
-
-  meta: {
-    title: "Grocy",
-    description:
-      "Grocy is a web-based self-hosted groceries & household management solution for your home.",
-    icon: "simple-icons:grocy",
-    category: "Productivity",
-  },
-
-  source: createSource("grocy"),
-})

package/src/apps/hubble.ts

@@ -1,20 +0,0 @@
-import { defineUnit } from "@highstate/contract"
-import { createArgs, createInputs, createSource } from "./shared"
-
-export const hubble = defineUnit({
-  type: "apps.hubble",
-
-  args: createArgs("hubble", ["fqdn"]),
-  inputs: createInputs(["accessPoint"]),
-
-  meta: {
-    title: "Hubble",
-    description:
-      "Exposes Hubble UI to the user. It must be already installed in the cluster as part of the Cilium.",
-    icon: "mdi:eye",
-    secondaryIcon: "simple-icons:cilium",
-    category: "Observability",
-  },
-
-  source: createSource("hubble"),
-})

package/src/apps/kubernetes-dashboard.ts

@@ -1,19 +0,0 @@
-import { defineUnit } from "@highstate/contract"
-import { createArgs, createInputs, createSource } from "./shared"
-
-export const kubernetesDashboard = defineUnit({
-  type: "apps.kubernetes-dashboard",
-
-  args: createArgs("kubernetes-dashboard", ["fqdn"]),
-  inputs: createInputs(["accessPoint"]),
-
-  meta: {
-    title: "Kubernetes Dashboard",
-    description: "The Kubernetes Dashboard deployed on Kubernetes.",
-    icon: "devicon:kubernetes",
-    secondaryIcon: "material-symbols:dashboard",
-    category: "Kubernetes",
-  },
-
-  source: createSource("kubernetes-dashboard"),
-})

package/src/apps/mariadb.ts

@@ -1,81 +0,0 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
-import { serviceEntity } from "../k8s"
-import { l4EndpointEntity } from "../network"
-import {
-  createArgs,
-  createInputs,
-  createSecrets,
-  createSource,
-  databaseSchema,
-  extraInputDefinitions,
-} from "./shared"
-
-export const mariadbEntity = defineEntity({
-  type: "apps.mariadb",
-
-  schema: databaseSchema,
-
-  meta: {
-    color: "#f06292",
-  },
-})
-
-export const mariadb = defineUnit({
-  type: "apps.mariadb",
-
-  args: createArgs("mariadb", ["external"]),
-  secrets: createSecrets(["rootPassword", "backupPassword"]),
-  inputs: createInputs(["resticRepo"]),
-
-  outputs: {
-    mariadb: mariadbEntity,
-    service: serviceEntity,
-    endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-    },
-  },
-
-  meta: {
-    title: "MariaDB",
-    description: "The MariaDB database deployed on Kubernetes.",
-    icon: "simple-icons:mariadb",
-    secondaryIcon: "mdi:database",
-    category: "Databases",
-  },
-
-  source: createSource("mariadb/app"),
-})
-
-extraInputDefinitions.mariadb = {
-  entity: mariadbEntity,
-  title: "MariaDB",
-}
-
-export const mariadbDatabase = defineUnit({
-  type: "apps.mariadb.database",
-
-  args: {
-    database: z.string().optional(),
-    username: z.string().optional(),
-  },
-
-  inputs: createInputs(["mariadb"]),
-
-  secrets: {
-    password: z.string().optional(),
-  },
-
-  meta: {
-    title: "MariaDB Database",
-    description:
-      "The virtual MariaDB database created on the MariaDB instance. Works only for MariaDB instances deployed on Kubernetes.",
-    icon: "simple-icons:mariadb",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: createSource("mariadb/database"),
-})
-
-export type MariaDB = z.infer<typeof mariadbEntity.schema>

package/src/apps/maybe.ts

@@ -1,25 +0,0 @@
-import { defineUnit, z } from "@highstate/contract"
-import { createArgs, createInputs, createSecrets, createSource } from "./shared"
-
-export const maybe = defineUnit({
-  type: "apps.maybe",
-
-  args: createArgs("maybe", ["fqdn"]),
-
-  secrets: {
-    ...createSecrets(["backupPassword"]),
-    postgresqlPassword: z.string().optional(),
-    secretKey: z.string().optional(),
-  },
-
-  inputs: createInputs(["accessPoint", "resticRepo", "postgresql"]),
-
-  meta: {
-    title: "Maybe",
-    description: "The OS for your personal finances.",
-    icon: "arcticons:finance-manager",
-    category: "Finance",
-  },
-
-  source: createSource("maybe"),
-})

package/src/apps/mongodb.ts

@@ -1,81 +0,0 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
-import { serviceEntity } from "../k8s"
-import { l4EndpointEntity } from "../network"
-import {
-  createArgs,
-  createInputs,
-  createSecrets,
-  createSource,
-  databaseSchema,
-  extraInputDefinitions,
-} from "./shared"
-
-export const mongodbEntity = defineEntity({
-  type: "apps.mongodb",
-
-  schema: databaseSchema,
-
-  meta: {
-    color: "#13aa52",
-  },
-})
-
-export const mongodb = defineUnit({
-  type: "apps.mongodb",
-
-  args: createArgs("mongodb", ["external"]),
-  secrets: createSecrets(["rootPassword", "backupPassword"]),
-  inputs: createInputs(["resticRepo"]),
-
-  outputs: {
-    mongodb: mongodbEntity,
-    service: serviceEntity,
-    endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-    },
-  },
-
-  meta: {
-    title: "MongoDB",
-    description: "The MongoDB instance deployed on Kubernetes.",
-    icon: "simple-icons:mongodb",
-    secondaryIcon: "mdi:database",
-    category: "Databases",
-  },
-
-  source: createSource("mongodb/app"),
-})
-
-extraInputDefinitions.mongodb = {
-  entity: mongodbEntity,
-  title: "MongoDB",
-}
-
-export const mongodbDatabase = defineUnit({
-  type: "apps.mongodb.database",
-
-  args: {
-    database: z.string().optional(),
-    username: z.string().optional(),
-  },
-
-  secrets: {
-    password: z.string().optional(),
-  },
-
-  inputs: createInputs(["mongodb"]),
-
-  meta: {
-    title: "MongoDB Database",
-    description:
-      "The virtual MongoDB database created on the MongoDB instance. Works only for MongoDB instances deployed on Kubernetes.",
-    icon: "simple-icons:mongodb",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: createSource("mongodb/database"),
-})
-
-export type MongoDB = z.infer<typeof mongodbEntity.schema>

package/src/apps/network.ts

@@ -1,55 +0,0 @@
-import { defineUnit, z } from "@highstate/contract"
-import { l3EndpointEntity, l4EndpointEntity } from "../network"
-import { createSource } from "./shared"
-
-export const explicitEndpointFilterSchema = z.enum(["public", "external", "internal"])
-
-export const endpointFilter = defineUnit({
-  type: "apps.endpoint-filter",
-
-  args: {
-    /**
-     * The filter to apply to the endpoints.
-     *
-     * - `public`: Only public endpoints accessible from the internet.
-     * - `external`: Only external endpoints (e.g. NodePort, LoadBalancer) accessible from outside the cluster, but not from the internet.
-     * - `internal`: Only internal endpoints (e.g. ClusterIP) accessible from within the cluster.
-     */
-    filter: explicitEndpointFilterSchema.default("public"),
-  },
-
-  inputs: {
-    l3Endpoints: {
-      entity: l3EndpointEntity,
-      multiple: true,
-      required: false,
-    },
-    l4Endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-      required: false,
-    },
-  },
-
-  outputs: {
-    l3Endpoints: {
-      entity: l3EndpointEntity,
-      multiple: true,
-    },
-    l4Endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-    },
-  },
-
-  meta: {
-    title: "Endpoint Filter",
-    description: "Explicitly filter endpoints by their accessibility.",
-    icon: "mdi:network-outline",
-    iconColor: "#FF9800",
-    secondaryIcon: "mdi:filter-outline",
-    category: "Network",
-  },
-
-  source: createSource("endpoint-filter"),
-})

package/src/apps/postgresql.ts

@@ -1,81 +0,0 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
-import { serviceEntity } from "../k8s"
-import { l4EndpointEntity } from "../network"
-import {
-  createArgs,
-  createInputs,
-  createSecrets,
-  createSource,
-  databaseSchema,
-  extraInputDefinitions,
-} from "./shared"
-
-export const postgresqlEntity = defineEntity({
-  type: "apps.postgresql",
-
-  schema: databaseSchema,
-
-  meta: {
-    color: "#336791",
-  },
-})
-
-export const postgresql = defineUnit({
-  type: "apps.postgresql",
-
-  args: createArgs("postgresql", ["external"]),
-  secrets: createSecrets(["rootPassword", "backupPassword"]),
-  inputs: createInputs(["resticRepo", "dnsProviders"]),
-
-  outputs: {
-    postgresql: postgresqlEntity,
-    service: serviceEntity,
-    endpoints: {
-      entity: l4EndpointEntity,
-      multiple: true,
-    },
-  },
-
-  meta: {
-    title: "PostgreSQL",
-    description: "The PostgreSQL database deployed on Kubernetes.",
-    icon: "simple-icons:postgresql",
-    secondaryIcon: "mdi:database",
-    category: "Databases",
-  },
-
-  source: createSource("postgresql/app"),
-})
-
-extraInputDefinitions.postgresql = {
-  entity: postgresqlEntity,
-  title: "PostgreSQL",
-}
-
-export const postgresqlDatabase = defineUnit({
-  type: "apps.postgresql.database",
-
-  args: {
-    database: z.string().optional(),
-    username: z.string().optional(),
-  },
-
-  secrets: {
-    password: z.string().optional(),
-  },
-
-  inputs: createInputs(["postgresql"]),
-
-  meta: {
-    title: "PostgreSQL Database",
-    description:
-      "The virtual PostgreSQL database created on the PostgreSQL instance. Works only for PostgreSQL instances deployed on Kubernetes.",
-    icon: "simple-icons:postgresql",
-    secondaryIcon: "mdi:database-plus",
-    category: "Databases",
-  },
-
-  source: createSource("postgresql/database"),
-})
-
-export type PostgreSQL = z.infer<typeof postgresqlEntity.schema>

package/src/apps/shared.ts

@@ -1,289 +0,0 @@
-import type { mariadbEntity } from "./mariadb"
-import type { postgresqlEntity } from "./postgresql"
-import type { mongodbEntity } from "./mongodb"
-import { z } from "@highstate/contract"
-import {
-  accessPointEntity,
-  clusterEntity,
-  persistentVolumeClaimEntity,
-  serviceEntity,
-} from "../k8s"
-import { repositoryEntity } from "../restic"
-import { providerEntity } from "../dns"
-import { l4EndpointEntity } from "../network"
-
-const extraArgsDefinitions = {
-  fqdn: {
-    schema: z.string(),
-  },
-  endpoints: {
-    schema: z.string().array(),
-    required: false,
-  },
-  external: {
-    schema: z.boolean(),
-    required: false,
-  },
-} as const
-
-const extraSecretsDefinitions = {
-  rootPassword: {
-    schema: z.string(),
-    required: false,
-  },
-  backupPassword: {
-    schema: z.string(),
-    required: false,
-  },
-}
-
-type LazyExtraInputDefinitions = {
-  mariadb: {
-    entity: typeof mariadbEntity
-    title: "MariaDB"
-  }
-  postgresql: {
-    entity: typeof postgresqlEntity
-    title: "PostgreSQL"
-  }
-  mongodb: {
-    entity: typeof mongodbEntity
-    title: "MongoDB"
-  }
-}
-
-const eagerExtraInputDefinitions = {
-  accessPoint: {
-    entity: accessPointEntity,
-  },
-  resticRepo: {
-    entity: repositoryEntity,
-    required: false,
-  },
-  dnsProviders: {
-    entity: providerEntity,
-    required: false,
-    multiple: true,
-  },
-  volume: {
-    entity: persistentVolumeClaimEntity,
-    required: false,
-  },
-} as const
-
-export const extraInputDefinitions = {
-  ...eagerExtraInputDefinitions,
-} as typeof eagerExtraInputDefinitions & LazyExtraInputDefinitions
-
-type ExtraArgsDefinitions = typeof extraArgsDefinitions
-type ExtraSecretsDefinitions = typeof extraSecretsDefinitions
-type ExtraArgsName = keyof ExtraArgsDefinitions
-type ExtraSecretsName = keyof ExtraSecretsDefinitions
-
-type CreateArgsOptions<R extends readonly ExtraArgsName[], O extends readonly ExtraArgsName[]> = {
-  required?: R
-  optional?: O
-}
-
-type CreateSecretsOptions<
-  R extends readonly ExtraSecretsName[],
-  O extends readonly ExtraSecretsName[],
-> = {
-  required?: R
-  optional?: O
-}
-
-export function createArgs<T extends readonly ExtraArgsName[] = []>(
-  defaultAppName: string,
-  extraArgs?: T,
-): {
-  appName: z.ZodDefault<z.ZodString>
-} & {
-  [K in T[number]]: ExtraArgsDefinitions[K]
-}
-
-export function createArgs<
-  R extends readonly ExtraArgsName[] = [],
-  O extends readonly ExtraArgsName[] = [],
->(
-  defaultAppName: string,
-  extraArgs?: CreateArgsOptions<R, O>,
-): {
-  appName: z.ZodDefault<z.ZodString>
-} & {
-  [K in R[number]]: ExtraArgsDefinitions[K] & { required: true }
-} & {
-  [K in O[number]]: ExtraArgsDefinitions[K] & { required: false }
-}
-
-export function createArgs<
-  R extends readonly ExtraArgsName[] = [],
-  O extends readonly ExtraArgsName[] = [],
->(defaultAppName: string, extraArgs?: readonly ExtraArgsName[] | CreateArgsOptions<R, O>) {
-  const base = {
-    appName: z.string().default(defaultAppName),
-  }
-
-  const dynamicArgs: Partial<Record<ExtraArgsName, object>> = {}
-
-  if (Array.isArray(extraArgs)) {
-    for (const name of extraArgs as readonly ExtraArgsName[]) {
-      dynamicArgs[name] = extraArgsDefinitions[name]
-    }
-  } else {
-    const { required, optional } = (extraArgs as CreateArgsOptions<R, O>) ?? {}
-
-    for (const name of required ?? []) {
-      dynamicArgs[name] = {
-        ...extraArgsDefinitions[name],
-        required: true,
-      }
-    }
-
-    for (const name of optional ?? []) {
-      dynamicArgs[name] = {
-        ...extraArgsDefinitions[name],
-        required: false,
-      }
-    }
-  }
-
-  return {
-    ...base,
-    ...dynamicArgs,
-  }
-}
-
-export function createSecrets<T extends readonly ExtraSecretsName[] = []>(
-  extraSecrets?: T,
-): {
-  [K in T[number]]: ExtraSecretsDefinitions[K]
-}
-
-export function createSecrets<
-  R extends readonly ExtraSecretsName[] = [],
-  O extends readonly ExtraSecretsName[] = [],
->(
-  extraSecrets?: CreateSecretsOptions<R, O>,
-): {
-  [K in R[number]]: ExtraSecretsDefinitions[K] & { required: true }
-} & {
-  [K in O[number]]: ExtraSecretsDefinitions[K] & { required: false }
-}
-
-export function createSecrets<
-  R extends readonly ExtraSecretsName[] = [],
-  O extends readonly ExtraSecretsName[] = [],
->(extraSecrets?: readonly ExtraSecretsName[] | CreateSecretsOptions<R, O>) {
-  const dynamicSecrets: Partial<Record<ExtraSecretsName, object>> = {}
-
-  if (Array.isArray(extraSecrets)) {
-    for (const name of extraSecrets as readonly ExtraSecretsName[]) {
-      dynamicSecrets[name] = extraSecretsDefinitions[name]
-    }
-  } else {
-    const { required, optional } = (extraSecrets as CreateSecretsOptions<R, O>) ?? {}
-
-    for (const name of required ?? []) {
-      dynamicSecrets[name] = {
-        ...extraSecretsDefinitions[name],
-        required: true,
-      }
-    }
-
-    for (const name of optional ?? []) {
-      dynamicSecrets[name] = {
-        ...extraSecretsDefinitions[name],
-        required: false,
-      }
-    }
-  }
-
-  return dynamicSecrets as {
-    [K in R[number]]: ExtraSecretsDefinitions[K] & { required: true }
-  } & {
-    [K in O[number]]: ExtraSecretsDefinitions[K] & { required: false }
-  }
-}
-
-type ExtraInputDefinitions = typeof extraInputDefinitions
-type ExtraInputName = keyof ExtraInputDefinitions
-
-type CreateInputsOptions<
-  R extends readonly ExtraInputName[],
-  O extends readonly ExtraInputName[],
-> = {
-  required?: R
-  optional?: O
-}
-
-export function createInputs<T extends readonly ExtraInputName[] = []>(
-  inputs?: T,
-): {
-  k8sCluster: typeof clusterEntity
-} & {
-  [K in T[number]]: ExtraInputDefinitions[K]
-}
-
-export function createInputs<
-  R extends readonly ExtraInputName[] = [],
-  O extends readonly ExtraInputName[] = [],
->(
-  inputs?: CreateInputsOptions<R, O>,
-): {
-  k8sCluster: typeof clusterEntity
-} & {
-  [K in R[number]]: ExtraInputDefinitions[K] & { required: true }
-} & {
-  [K in O[number]]: ExtraInputDefinitions[K] & { required: false }
-}
-
-export function createInputs<
-  R extends readonly ExtraInputName[] = [],
-  O extends readonly ExtraInputName[] = [],
->(inputs?: readonly ExtraInputName[] | CreateInputsOptions<R, O>) {
-  const base = {
-    k8sCluster: clusterEntity,
-  }
-
-  const dynamicInputs: Partial<Record<ExtraInputName, object>> = {}
-
-  if (Array.isArray(inputs)) {
-    for (const name of inputs as readonly ExtraInputName[]) {
-      dynamicInputs[name] = extraInputDefinitions[name]
-    }
-  } else {
-    const { required, optional } = (inputs as CreateInputsOptions<R, O>) ?? {}
-
-    for (const name of required ?? []) {
-      dynamicInputs[name] = {
-        ...extraInputDefinitions[name],
-        required: true,
-      }
-    }
-    for (const name of optional ?? []) {
-      dynamicInputs[name] = {
-        ...extraInputDefinitions[name],
-        required: false,
-      }
-    }
-  }
-
-  return {
-    ...base,
-    ...dynamicInputs,
-  }
-}
-
-export function createSource(path: string) {
-  return {
-    package: "@highstate/apps",
-    path,
-  }
-}
-
-export const databaseSchema = z.object({
-  endpoints: l4EndpointEntity.schema.array(),
-  service: serviceEntity.schema.optional(),
-  rootPassword: z.string(),
-})