@highstate/library 0.9.15 → 0.9.18

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@highstate/library",
-  "version": "0.9.15",
+  "version": "0.9.18",
   "type": "module",
+  "highstate": {
+    "type": "library"
+  },
   "files": [
     "dist",
     "src"
@@ -16,15 +19,14 @@
     "access": "public"
   },
   "scripts": {
-    "build": "highstate build --library"
+    "build": "highstate build"
   },
   "dependencies": {
-    "@highstate/contract": "^0.9.15",
-    "@sinclair/typebox": "^0.34.11",
+    "@highstate/contract": "^0.9.18",
     "remeda": "^2.21.0"
   },
   "devDependencies": {
-    "@highstate/cli": "^0.9.15"
+    "@highstate/cli": "^0.9.18"
   },
-  "gitHead": "f61b9905d4cd50511b03331411f42595403ebc06"
+  "gitHead": "9ebcd7da56b00b8ca08bf52cc8438f527338cd64"
 }

package/src/abbreviations.ts

@@ -0,0 +1,35 @@
+import { registerKnownAbbreviations } from "@highstate/contract"
+
+registerKnownAbbreviations([
+  "ID",
+  "URL",
+  "IP",
+  "IPs",
+  "IPv4",
+  "IPv6",
+  "DNS",
+  "FQDN",
+  "SSH",
+  "WireGuard",
+  "API",
+  "k8s",
+  "TLS",
+  "HTTP",
+  "HTTPS",
+  "TCP",
+  "UDP",
+  "CIDR",
+  "CPU",
+  "RAM",
+  "GPU",
+  "SSD",
+  "HDD",
+  "VM",
+  "CNI",
+  "CSI",
+  "MariaDB",
+  "PostgreSQL",
+  "MongoDB",
+])
+
+export const noop = () => {}

package/src/apps/code-server.ts

@@ -1,4 +1,4 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { persistentVolumeClaimEntity, statefulSetEntity } from "../k8s"
 import { createArgs, createInputs, createSecrets } from "./shared"
 
@@ -9,8 +9,8 @@ export const codeServer = defineUnit({
 
   secrets: {
     ...createSecrets(["backupPassword"]),
-    password: Type.Optional(Type.String()),
-    sudoPassword: Type.Optional(Type.String()),
+    password: z.string().optional(),
+    sudoPassword: z.string().optional(),
   },
 
   inputs: createInputs(["accessPoint", "resticRepo", "dnsProviders", "volume"]),
@@ -21,9 +21,9 @@ export const codeServer = defineUnit({
   },
 
   meta: {
-    displayName: "Code Server",
+    title: "Code Server",
     description: "The Code Server instance deployed on Kubernetes.",
-    primaryIcon: "material-icon-theme:vscode",
+    icon: "material-icon-theme:vscode",
     category: "Development",
   },
 

package/src/apps/deployment.ts

@@ -1,4 +1,4 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { deploymentEntity, serviceEntity, serviceTypeSchema } from "../k8s"
 import { createInputs, createSource } from "./shared"
 
@@ -6,32 +6,32 @@ export const deployment = defineUnit({
   type: "apps.deployment",
 
   args: {
-    appName: Type.Optional(Type.String()),
+    appName: z.string().optional(),
 
-    fqdn: Type.Optional(Type.String()),
-    serviceType: Type.Optional(serviceTypeSchema),
+    fqdn: z.string().optional(),
+    serviceType: serviceTypeSchema.optional(),
 
-    image: Type.Optional(Type.String()),
-    port: Type.Optional(Type.Number()),
-    replicas: Type.Optional(Type.Number()),
+    image: z.string().optional(),
+    port: z.number().optional(),
+    replicas: z.number().optional(),
 
-    dataPath: Type.Optional(Type.String()),
+    dataPath: z.string().optional(),
 
-    env: Type.Optional(Type.Record(Type.String(), Type.Any())),
+    env: z.record(z.string(), z.any()).optional(),
 
-    mariadbEnvMapping: Type.Optional(Type.Record(Type.String(), Type.Any())),
-    postgresqlEnvMapping: Type.Optional(Type.Record(Type.String(), Type.Any())),
-    mongodbEnvMapping: Type.Optional(Type.Record(Type.String(), Type.Any())),
+    mariadbEnvMapping: z.record(z.string(), z.any()).optional(),
+    postgresqlEnvMapping: z.record(z.string(), z.any()).optional(),
+    mongodbEnvMapping: z.record(z.string(), z.any()).optional(),
 
-    manifest: Type.Optional(Type.Record(Type.String(), Type.Any())),
-    serviceManifest: Type.Optional(Type.Record(Type.String(), Type.Any())),
-    httpRouteManifest: Type.Optional(Type.Record(Type.String(), Type.Any())),
+    manifest: z.record(z.string(), z.any()).optional(),
+    serviceManifest: z.record(z.string(), z.any()).optional(),
+    httpRouteManifest: z.record(z.string(), z.any()).optional(),
   },
 
   secrets: {
-    mariadbPassword: Type.Optional(Type.String()),
-    postgresqlPassword: Type.Optional(Type.String()),
-    mongodbPassword: Type.Optional(Type.String()),
+    mariadbPassword: z.string().optional(),
+    postgresqlPassword: z.string().optional(),
+    mongodbPassword: z.string().optional(),
   },
 
   inputs: createInputs([
@@ -49,9 +49,9 @@ export const deployment = defineUnit({
   },
 
   meta: {
-    displayName: "Kubernetes Deployment",
+    title: "Kubernetes Deployment",
     description: "A generic Kubernetes deployment with optional service and gateway routes.",
-    primaryIcon: "devicon:kubernetes",
+    icon: "devicon:kubernetes",
     secondaryIcon: "mdi:cube-outline",
     category: "Kubernetes",
   },

package/src/apps/dns.ts

@@ -1,9 +1,9 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { l3EndpointEntity, l4EndpointEntity } from "../network"
 import { providerEntity } from "../dns"
 import { createSource } from "./shared"
 
-const endpointFilterSchema = Type.StringEnum(["all", "public", "external", "internal"])
+const endpointFilterSchema = z.enum(["all", "public", "external", "internal"])
 
 export const recordSet = defineUnit({
   type: "apps.dns-record-set",
@@ -14,36 +14,36 @@ export const recordSet = defineUnit({
      *
      * If not provided, will use the name of the unit.
      */
-    recordName: Type.Optional(Type.String()),
+    recordName: z.string().optional(),
 
     /**
      * The type of the DNS record.
      *
      * If not specified, will use the default type for the provider.
      */
-    type: Type.Optional(Type.String()),
+    type: z.string().optional(),
 
     /**
      * The values of the DNS record.
      */
-    values: Type.Array(Type.String()),
+    values: z.string().array(),
 
     /**
      * The TTL of the DNS record.
      */
-    ttl: Type.Optional(Type.Number()),
+    ttl: z.number().optional(),
 
     /**
      * The priority of the DNS record.
      */
-    priority: Type.Optional(Type.Number()),
+    priority: z.number().optional(),
 
     /**
      * Whether the DNS record is proxied.
      *
      * Available only for public IPs and some DNS providers like Cloudflare.
      */
-    proxied: Type.Optional(Type.Boolean()),
+    proxied: z.boolean().optional(),
 
     /**
      * The filter to apply to the endpoints.
@@ -53,7 +53,7 @@ export const recordSet = defineUnit({
      * - `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.
      */
-    endpointFilter: Type.Default(endpointFilterSchema, "public"),
+    endpointFilter: endpointFilterSchema.default("public"),
   },
 
   inputs: {
@@ -89,9 +89,9 @@ export const recordSet = defineUnit({
   },
 
   meta: {
-    displayName: "DNS Record Set",
+    title: "DNS Record Set",
     description: "A set of DNS records to be created.",
-    primaryIcon: "mdi:server",
+    icon: "mdi:server",
     defaultNamePrefix: "record",
     category: "Network",
   },
@@ -102,8 +102,6 @@ export const recordSet = defineUnit({
 export const sharedArgs = {
   /**
    * The FQDN to register the cluster nodes with.
-   *
-   * @schema
    */
-  fqdn: Type.Optional(Type.String()),
+  fqdn: z.string().optional(),
 }

package/src/apps/gitea.ts

@@ -8,9 +8,9 @@ export const gitea = defineUnit({
   inputs: createInputs(["accessPoint", "mariadb"]),
 
   meta: {
-    displayName: "Gitea",
+    title: "Gitea",
     description: "The Gitea Git server deployed on Kubernetes.",
-    primaryIcon: "simple-icons:gitea",
+    icon: "simple-icons:gitea",
     category: "Development",
   },
 

package/src/apps/grocy.ts

@@ -9,10 +9,10 @@ export const grocy = defineUnit({
   inputs: createInputs(["accessPoint", "resticRepo"]),
 
   meta: {
-    displayName: "Grocy",
+    title: "Grocy",
     description:
       "Grocy is a web-based self-hosted groceries & household management solution for your home.",
-    primaryIcon: "simple-icons:grocy",
+    icon: "simple-icons:grocy",
     category: "Productivity",
   },
 

package/src/apps/hubble.ts

@@ -8,10 +8,10 @@ export const hubble = defineUnit({
   inputs: createInputs(["accessPoint"]),
 
   meta: {
-    displayName: "Hubble",
+    title: "Hubble",
     description:
       "Exposes Hubble UI to the user. It must be already installed in the cluster as part of the Cilium.",
-    primaryIcon: "mdi:eye",
+    icon: "mdi:eye",
     secondaryIcon: "simple-icons:cilium",
     category: "Observability",
   },

package/src/apps/kubernetes-dashboard.ts

@@ -8,9 +8,9 @@ export const kubernetesDashboard = defineUnit({
   inputs: createInputs(["accessPoint"]),
 
   meta: {
-    displayName: "Kubernetes Dashboard",
+    title: "Kubernetes Dashboard",
     description: "The Kubernetes Dashboard deployed on Kubernetes.",
-    primaryIcon: "devicon:kubernetes",
+    icon: "devicon:kubernetes",
     secondaryIcon: "material-symbols:dashboard",
     category: "Kubernetes",
   },

package/src/apps/mariadb.ts

@@ -1,4 +1,4 @@
-import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
+import { defineEntity, defineUnit, z } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
 import { l4EndpointEntity } from "../network"
 import {
@@ -37,9 +37,9 @@ export const mariadb = defineUnit({
   },
 
   meta: {
-    displayName: "MariaDB",
+    title: "MariaDB",
     description: "The MariaDB database deployed on Kubernetes.",
-    primaryIcon: "simple-icons:mariadb",
+    icon: "simple-icons:mariadb",
     secondaryIcon: "mdi:database",
     category: "Databases",
   },
@@ -49,28 +49,28 @@ export const mariadb = defineUnit({
 
 extraInputDefinitions.mariadb = {
   entity: mariadbEntity,
-  displayName: "MariaDB",
+  title: "MariaDB",
 }
 
 export const mariadbDatabase = defineUnit({
   type: "apps.mariadb.database",
 
   args: {
-    database: Type.Optional(Type.String()),
-    username: Type.Optional(Type.String()),
+    database: z.string().optional(),
+    username: z.string().optional(),
   },
 
   inputs: createInputs(["mariadb"]),
 
   secrets: {
-    password: Type.Optional(Type.String()),
+    password: z.string().optional(),
   },
 
   meta: {
-    displayName: "MariaDB Database",
+    title: "MariaDB Database",
     description:
       "The virtual MariaDB database created on the MariaDB instance. Works only for MariaDB instances deployed on Kubernetes.",
-    primaryIcon: "simple-icons:mariadb",
+    icon: "simple-icons:mariadb",
     secondaryIcon: "mdi:database-plus",
     category: "Databases",
   },
@@ -78,4 +78,4 @@ export const mariadbDatabase = defineUnit({
   source: createSource("mariadb/database"),
 })
 
-export type MariaDB = Static<typeof mariadbEntity.schema>
+export type MariaDB = z.infer<typeof mariadbEntity.schema>

package/src/apps/maybe.ts

@@ -1,4 +1,4 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { createArgs, createInputs, createSecrets, createSource } from "./shared"
 
 export const maybe = defineUnit({
@@ -8,16 +8,16 @@ export const maybe = defineUnit({
 
   secrets: {
     ...createSecrets(["backupPassword"]),
-    postgresqlPassword: Type.Optional(Type.String()),
-    secretKey: Type.Optional(Type.String()),
+    postgresqlPassword: z.string().optional(),
+    secretKey: z.string().optional(),
   },
 
   inputs: createInputs(["accessPoint", "resticRepo", "postgresql"]),
 
   meta: {
-    displayName: "Maybe",
+    title: "Maybe",
     description: "The OS for your personal finances.",
-    primaryIcon: "arcticons:finance-manager",
+    icon: "arcticons:finance-manager",
     category: "Finance",
   },
 

package/src/apps/mongodb.ts

@@ -1,4 +1,4 @@
-import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
+import { defineEntity, defineUnit, z } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
 import { l4EndpointEntity } from "../network"
 import {
@@ -37,9 +37,9 @@ export const mongodb = defineUnit({
   },
 
   meta: {
-    displayName: "MongoDB",
+    title: "MongoDB",
     description: "The MongoDB instance deployed on Kubernetes.",
-    primaryIcon: "simple-icons:mongodb",
+    icon: "simple-icons:mongodb",
     secondaryIcon: "mdi:database",
     category: "Databases",
   },
@@ -49,28 +49,28 @@ export const mongodb = defineUnit({
 
 extraInputDefinitions.mongodb = {
   entity: mongodbEntity,
-  displayName: "MongoDB",
+  title: "MongoDB",
 }
 
 export const mongodbDatabase = defineUnit({
   type: "apps.mongodb.database",
 
   args: {
-    database: Type.Optional(Type.String()),
-    username: Type.Optional(Type.String()),
+    database: z.string().optional(),
+    username: z.string().optional(),
   },
 
   secrets: {
-    password: Type.Optional(Type.String()),
+    password: z.string().optional(),
   },
 
   inputs: createInputs(["mongodb"]),
 
   meta: {
-    displayName: "MongoDB Database",
+    title: "MongoDB Database",
     description:
       "The virtual MongoDB database created on the MongoDB instance. Works only for MongoDB instances deployed on Kubernetes.",
-    primaryIcon: "simple-icons:mongodb",
+    icon: "simple-icons:mongodb",
     secondaryIcon: "mdi:database-plus",
     category: "Databases",
   },
@@ -78,4 +78,4 @@ export const mongodbDatabase = defineUnit({
   source: createSource("mongodb/database"),
 })
 
-export type MongoDB = Static<typeof mongodbEntity.schema>
+export type MongoDB = z.infer<typeof mongodbEntity.schema>

package/src/apps/network.ts

@@ -1,8 +1,8 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { l3EndpointEntity, l4EndpointEntity } from "../network"
 import { createSource } from "./shared"
 
-export const explicitEndpointFilterSchema = Type.StringEnum(["public", "external", "internal"])
+export const explicitEndpointFilterSchema = z.enum(["public", "external", "internal"])
 
 export const endpointFilter = defineUnit({
   type: "apps.endpoint-filter",
@@ -15,7 +15,7 @@ export const endpointFilter = defineUnit({
      * - `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: Type.Default(explicitEndpointFilterSchema, "public"),
+    filter: explicitEndpointFilterSchema.default("public"),
   },
 
   inputs: {
@@ -43,10 +43,10 @@ export const endpointFilter = defineUnit({
   },
 
   meta: {
-    displayName: "Endpoint Filter",
+    title: "Endpoint Filter",
     description: "Explicitly filter endpoints by their accessibility.",
-    primaryIcon: "mdi:network-outline",
-    primaryIconColor: "#FF9800",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
     secondaryIcon: "mdi:filter-outline",
     category: "Network",
   },

package/src/apps/postgresql.ts

@@ -1,4 +1,4 @@
-import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
+import { defineEntity, defineUnit, z } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
 import { l4EndpointEntity } from "../network"
 import {
@@ -37,9 +37,9 @@ export const postgresql = defineUnit({
   },
 
   meta: {
-    displayName: "PostgreSQL",
+    title: "PostgreSQL",
     description: "The PostgreSQL database deployed on Kubernetes.",
-    primaryIcon: "simple-icons:postgresql",
+    icon: "simple-icons:postgresql",
     secondaryIcon: "mdi:database",
     category: "Databases",
   },
@@ -49,28 +49,28 @@ export const postgresql = defineUnit({
 
 extraInputDefinitions.postgresql = {
   entity: postgresqlEntity,
-  displayName: "PostgreSQL",
+  title: "PostgreSQL",
 }
 
 export const postgresqlDatabase = defineUnit({
   type: "apps.postgresql.database",
 
   args: {
-    database: Type.Optional(Type.String()),
-    username: Type.Optional(Type.String()),
+    database: z.string().optional(),
+    username: z.string().optional(),
   },
 
   secrets: {
-    password: Type.Optional(Type.String()),
+    password: z.string().optional(),
   },
 
   inputs: createInputs(["postgresql"]),
 
   meta: {
-    displayName: "PostgreSQL Database",
+    title: "PostgreSQL Database",
     description:
       "The virtual PostgreSQL database created on the PostgreSQL instance. Works only for PostgreSQL instances deployed on Kubernetes.",
-    primaryIcon: "simple-icons:postgresql",
+    icon: "simple-icons:postgresql",
     secondaryIcon: "mdi:database-plus",
     category: "Databases",
   },
@@ -78,4 +78,4 @@ export const postgresqlDatabase = defineUnit({
   source: createSource("postgresql/database"),
 })
 
-export type PostgreSQL = Static<typeof postgresqlEntity.schema>
+export type PostgreSQL = z.infer<typeof postgresqlEntity.schema>

package/src/apps/shared.ts

@@ -1,39 +1,38 @@
-import type { TString } from "@sinclair/typebox"
 import type { mariadbEntity } from "./mariadb"
 import type { postgresqlEntity } from "./postgresql"
 import type { mongodbEntity } from "./mongodb"
-import { Type } from "@highstate/contract"
+import { z } from "@highstate/contract"
 import {
   accessPointEntity,
   clusterEntity,
   persistentVolumeClaimEntity,
   serviceEntity,
 } from "../k8s"
-import { repoEntity } from "../restic"
+import { repositoryEntity } from "../restic"
 import { providerEntity } from "../dns"
 import { l4EndpointEntity } from "../network"
 
 const extraArgsDefinitions = {
   fqdn: {
-    schema: Type.String(),
+    schema: z.string(),
   },
   endpoints: {
-    schema: Type.Array(Type.String()),
+    schema: z.string().array(),
     required: false,
   },
   external: {
-    schema: Type.Boolean(),
+    schema: z.boolean(),
     required: false,
   },
 } as const
 
 const extraSecretsDefinitions = {
   rootPassword: {
-    schema: Type.String(),
+    schema: z.string(),
     required: false,
   },
   backupPassword: {
-    schema: Type.String(),
+    schema: z.string(),
     required: false,
   },
 }
@@ -41,15 +40,15 @@ const extraSecretsDefinitions = {
 type LazyExtraInputDefinitions = {
   mariadb: {
     entity: typeof mariadbEntity
-    displayName: "MariaDB"
+    title: "MariaDB"
   }
   postgresql: {
     entity: typeof postgresqlEntity
-    displayName: "PostgreSQL"
+    title: "PostgreSQL"
   }
   mongodb: {
     entity: typeof mongodbEntity
-    displayName: "MongoDB"
+    title: "MongoDB"
   }
 }
 
@@ -58,7 +57,7 @@ const eagerExtraInputDefinitions = {
     entity: accessPointEntity,
   },
   resticRepo: {
-    entity: repoEntity,
+    entity: repositoryEntity,
     required: false,
   },
   dnsProviders: {
@@ -98,7 +97,7 @@ export function createArgs<T extends readonly ExtraArgsName[] = []>(
   defaultAppName: string,
   extraArgs?: T,
 ): {
-  appName: TString & { default: string }
+  appName: z.ZodDefault<z.ZodString>
 } & {
   [K in T[number]]: ExtraArgsDefinitions[K]
 }
@@ -110,7 +109,7 @@ export function createArgs<
   defaultAppName: string,
   extraArgs?: CreateArgsOptions<R, O>,
 ): {
-  appName: TString & { default: string }
+  appName: z.ZodDefault<z.ZodString>
 } & {
   [K in R[number]]: ExtraArgsDefinitions[K] & { required: true }
 } & {
@@ -122,7 +121,7 @@ export function createArgs<
   O extends readonly ExtraArgsName[] = [],
 >(defaultAppName: string, extraArgs?: readonly ExtraArgsName[] | CreateArgsOptions<R, O>) {
   const base = {
-    appName: Type.Default(Type.String(), defaultAppName),
+    appName: z.string().default(defaultAppName),
   }
 
   const dynamicArgs: Partial<Record<ExtraArgsName, object>> = {}
@@ -283,8 +282,8 @@ export function createSource(path: string) {
   }
 }
 
-export const databaseSchema = Type.Object({
-  endpoints: Type.Array(l4EndpointEntity.schema),
-  service: Type.Optional(serviceEntity.schema),
-  rootPassword: Type.String(),
+export const databaseSchema = z.object({
+  endpoints: l4EndpointEntity.schema.array(),
+  service: serviceEntity.schema.optional(),
+  rootPassword: z.string(),
 })