@highstate/library 0.9.15 → 0.9.18

package/src/apps/syncthing.ts

@@ -1,9 +1,9 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { persistentVolumeClaimEntity, serviceEntity } from "../k8s"
 import { l4EndpointEntity } from "../network"
 import { createArgs, createInputs, createSecrets, createSource } from "./shared"
 
-export const backupModeSchema = Type.StringEnum(["state", "full"])
+export const backupModeSchema = z.enum(["state", "full"])
 
 export const syncthing = defineUnit({
   type: "apps.syncthing",
@@ -17,7 +17,7 @@ export const syncthing = defineUnit({
      * The `fqdn` argument unlike this one points to the gateway and used to
      * access the Syncthing Web UI.
      */
-    deviceFqdn: Type.Optional(Type.String()),
+    deviceFqdn: z.string().optional(),
 
     /**
      * The backup mode to use for the Syncthing instance.
@@ -28,7 +28,7 @@ export const syncthing = defineUnit({
      *
      * The default is `state`.
      */
-    backupMode: Type.Default(backupModeSchema, "state"),
+    backupMode: backupModeSchema.default("state"),
   },
 
   secrets: createSecrets(["backupPassword"]),
@@ -44,9 +44,9 @@ export const syncthing = defineUnit({
   },
 
   meta: {
-    displayName: "Syncthing",
+    title: "Syncthing",
     description: "The Syncthing instance deployed on Kubernetes.",
-    primaryIcon: "simple-icons:syncthing",
+    icon: "simple-icons:syncthing",
     category: "File Sync",
   },
 

package/src/apps/traefik.ts

@@ -1,4 +1,4 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { gatewayEntity, serviceEntity } from "../k8s"
 import { l4EndpointEntity } from "../network"
 import { createArgs, createInputs } from "./shared"
@@ -8,7 +8,7 @@ export const traefikGateway = defineUnit({
 
   args: {
     ...createArgs("traefik", ["external"]),
-    className: Type.Optional(Type.String()),
+    className: z.string().optional(),
   },
 
   inputs: createInputs(),
@@ -23,9 +23,9 @@ export const traefikGateway = defineUnit({
   },
 
   meta: {
-    displayName: "Traefik Gateway",
+    title: "Traefik Gateway",
     description: "A Traefik gateway for routing traffic to services.",
-    primaryIcon: "simple-icons:traefikproxy",
+    icon: "simple-icons:traefikproxy",
     category: "Network",
   },
 

package/src/apps/vaultwarden.ts

@@ -1,4 +1,4 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { createArgs, createInputs, createSource } from "./shared"
 
 export const vaultwarden = defineUnit({
@@ -7,15 +7,15 @@ export const vaultwarden = defineUnit({
   args: createArgs("vaultwarden", ["fqdn"]),
 
   secrets: {
-    mariadbPassword: Type.Optional(Type.String()),
+    mariadbPassword: z.string().optional(),
   },
 
   inputs: createInputs(["accessPoint", "mariadb"]),
 
   meta: {
-    displayName: "Vaultwarden",
+    title: "Vaultwarden",
     description: "The Vaultwarden password manager deployed on Kubernetes.",
-    primaryIcon: "simple-icons:vaultwarden",
+    icon: "simple-icons:vaultwarden",
     category: "Security",
   },
 

package/src/apps/zitadel.ts

@@ -9,9 +9,9 @@ export const zitadel = defineUnit({
   inputs: createInputs(["accessPoint", "postgresql"]),
 
   meta: {
-    displayName: "Zitadel",
+    title: "Zitadel",
     description: "The Zitadel IAM deployed on Kubernetes.",
-    primaryIcon: "hugeicons:access",
+    icon: "hugeicons:access",
   },
 
   source: {

package/src/cloudflare.ts

@@ -1,11 +1,11 @@
-import { defineUnit, Type } from "@highstate/contract"
+import { defineUnit, z } from "@highstate/contract"
 import { providerEntity } from "./dns"
 
 export const connection = defineUnit({
   type: "cloudflare.connection",
 
   secrets: {
-    apiToken: Type.String(),
+    apiToken: z.string(),
   },
 
   outputs: {
@@ -13,9 +13,9 @@ export const connection = defineUnit({
   },
 
   meta: {
-    displayName: "Cloudflare Connection",
+    title: "Cloudflare Connection",
     description: "Creates a new Cloudflare connection for one zone.",
-    primaryIcon: "simple-icons:cloudflare",
+    icon: "simple-icons:cloudflare",
     category: "Cloudflare",
   },
 

package/src/common.ts

@@ -1,4 +1,4 @@
-import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
+import { defineEntity, defineUnit, z } from "@highstate/contract"
 import { credentialsSchema, keyPairEntity } from "./ssh"
 import { l3EndpointEntity } from "./network"
 import * as dns from "./dns"
@@ -7,10 +7,10 @@ import { arrayPatchModeSchema } from "./utils"
 export const serverEntity = defineEntity({
   type: "common.server",
 
-  schema: Type.Object({
-    hostname: Type.String(),
-    endpoints: Type.Array(l3EndpointEntity.schema),
-    ssh: Type.Optional(credentialsSchema),
+  schema: z.object({
+    hostname: z.string(),
+    endpoints: l3EndpointEntity.schema.array(),
+    ssh: credentialsSchema.optional(),
   }),
 
   meta: {
@@ -35,22 +35,22 @@ export const existingServer = defineUnit({
      *
      * Takes precedence over the `endpoint` input.
      */
-    endpoint: Type.Optional(Type.String()),
+    endpoint: z.string().optional(),
 
     /**
      * The SSH user to use for connecting to the server.
      */
-    sshUser: Type.Default(Type.String(), "root"),
+    sshUser: z.string().default("root"),
 
     /**
      * The SSH port to use for connecting to the server.
      */
-    sshPort: Type.Default(Type.Number(), 22),
+    sshPort: z.number().default(22),
   },
 
   secrets: {
-    sshPassword: Type.Optional(Type.String()),
-    sshPrivateKey: Type.Optional(Type.String()),
+    sshPassword: z.string().optional(),
+    sshPrivateKey: z.string().optional(),
   },
 
   inputs: {
@@ -67,9 +67,9 @@ export const existingServer = defineUnit({
   outputs: serverOutputs,
 
   meta: {
-    displayName: "Existing Server",
+    title: "Existing Server",
     description: "An existing server that can be used in the configuration.",
-    primaryIcon: "mdi:server",
+    icon: "mdi:server",
     defaultNamePrefix: "server",
     category: "Infrastructure",
   },
@@ -90,10 +90,8 @@ export const serverPatch = defineUnit({
      * The entry may represent real node endpoint or virtual endpoint (like a load balancer).
      *
      * The same server may also be represented by multiple entries (e.g. a node with private and public IP).
-     *
-     * @schema
      */
-    endpoints: Type.Default(Type.Array(Type.String()), []),
+    endpoints: z.string().array().default([]),
 
     /**
      * The mode to use for patching the endpoints.
@@ -101,7 +99,7 @@ export const serverPatch = defineUnit({
      * - `prepend`: prepend the new endpoints to the existing ones (default);
      * - `replace`: replace the existing endpoints with the new ones.
      */
-    endpointsPatchMode: Type.Default(arrayPatchModeSchema, "prepend"),
+    endpointsPatchMode: arrayPatchModeSchema.default("prepend"),
   },
 
   inputs: {
@@ -122,9 +120,9 @@ export const serverPatch = defineUnit({
   },
 
   meta: {
-    displayName: "Server Patch",
+    title: "Server Patch",
     description: "Patches some properties of the server.",
-    primaryIcon: "mdi:server",
+    icon: "mdi:server",
     secondaryIcon: "fluent:patch-20-filled",
     category: "Infrastructure",
   },
@@ -154,9 +152,9 @@ export const serverDns = defineUnit({
   },
 
   meta: {
-    displayName: "Server DNS",
+    title: "Server DNS",
     description: "Creates DNS records for the server and updates endpoints.",
-    primaryIcon: "mdi:server",
+    icon: "mdi:server",
     secondaryIcon: "mdi:dns",
     category: "Infrastructure",
   },
@@ -171,9 +169,9 @@ export const script = defineUnit({
   type: "common.script",
 
   args: {
-    script: Type.String({ language: "shell" }),
-    updateScript: Type.Optional(Type.String({ language: "shell" })),
-    deleteScript: Type.Optional(Type.String({ language: "shell" })),
+    script: z.string().meta({ language: "shell" }),
+    updateScript: z.string().optional().meta({ language: "shell" }),
+    deleteScript: z.string().optional().meta({ language: "shell" }),
   },
 
   inputs: {
@@ -185,9 +183,9 @@ export const script = defineUnit({
   },
 
   meta: {
-    displayName: "Shell Script",
+    title: "Shell Script",
     description: "Run a shell script on the server.",
-    primaryIcon: "mdi:bash",
+    icon: "mdi:bash",
     category: "Infrastructure",
   },
 
@@ -197,57 +195,6 @@ export const script = defineUnit({
   },
 })
 
-export const fileMetaEntity = defineEntity({
-  type: "common.file-meta",
-
-  schema: Type.Object({
-    name: Type.String(),
-    size: Type.Number(),
-    mode: Type.Number(),
-    isBinary: Type.Optional(Type.Boolean()),
-  }),
-
-  meta: {
-    color: "#FF5722",
-    description: "Metadata for a file.",
-  },
-})
-
-export const fileContentEntity = defineEntity({
-  type: "common.file-content",
-
-  schema: Type.Union([
-    Type.Object({
-      type: Type.Literal("inline"),
-      content: Type.String(),
-    }),
-    Type.Object({
-      type: Type.Literal("remote"),
-      url: Type.String(),
-    }),
-  ]),
-
-  meta: {
-    color: "#FF5722",
-    description: "The content of a file.",
-  },
-})
-
-export const fileEntity = defineEntity({
-  type: "common.file",
-
-  schema: Type.Object({
-    meta: fileMetaEntity.schema,
-    content: fileContentEntity.schema,
-  }),
-
-  meta: {
-    color: "#FF5722",
-  },
-})
-
-export type Server = Static<typeof serverEntity.schema>
+export type Server = z.infer<typeof serverEntity.schema>
 
-export type File = Static<typeof fileEntity.schema>
-export type FileMeta = Static<typeof fileMetaEntity.schema>
-export type FileContent = Static<typeof fileContentEntity.schema>
+export * from "./files"

package/src/distributions/index.ts

@@ -0,0 +1 @@
+export * from "./ubuntu"

package/src/distributions/ubuntu.ts

@@ -0,0 +1,32 @@
+import { defineUnit, z } from "@highstate/contract"
+import { fileEntity } from "../files"
+
+export const ubuntuVersionSchema = z.enum(["22.04", "24.04", "24.10", "25.04", "25.10"])
+export const ubuntuArchitectureSchema = z.enum(["amd64", "arm64"])
+
+export const ubuntu = defineUnit({
+  type: "distributions.ubuntu",
+
+  args: {
+    version: ubuntuVersionSchema.default("24.04"),
+    architecture: ubuntuArchitectureSchema.default("amd64"),
+  },
+
+  outputs: {
+    image: fileEntity,
+    cloudConfig: fileEntity,
+  },
+
+  meta: {
+    title: "Ubuntu",
+    description: "Ubuntu distribution with image and cloud-config.",
+    icon: "mdi:ubuntu",
+    iconColor: "#E95420",
+    category: "Distributions",
+  },
+
+  source: {
+    package: "@highstate/distributions",
+    path: "ubuntu",
+  },
+})

package/src/dns.ts

@@ -1,15 +1,15 @@
-import { defineEntity, Type, type Static } from "@highstate/contract"
+import { defineEntity, z } from "@highstate/contract"
 import { endpointFilterSchema } from "./network"
 import { arrayPatchModeSchema, prefixKeysWith } from "./utils"
 
 export const providerEntity = defineEntity({
   type: "dns.provider",
 
-  schema: Type.Object({
-    name: Type.String(),
-    type: Type.String(),
-    data: Type.Record(Type.String(), Type.Unknown()),
-    domain: Type.String(),
+  schema: z.object({
+    name: z.string(),
+    type: z.string(),
+    data: z.record(z.string(), z.unknown()),
+    domain: z.string(),
   }),
 
   meta: {
@@ -25,10 +25,8 @@ export function createArgs<TPrefix extends string = "">(prefix?: TPrefix) {
      * Will be inserted at the beginning of the resulting endpoint list.
      *
      * Will throw an error if no matching provider is found.
-     *
-     * @schema
      */
-    fqdn: Type.Optional(Type.String()),
+    fqdn: z.string().optional(),
 
     /**
      * The endpoint filter to filter the endpoints before creating the DNS records.
@@ -46,10 +44,8 @@ export function createArgs<TPrefix extends string = "">(prefix?: TPrefix) {
      * - If any public endpoints exist, all public endpoints are selected;
      * - Otherwise, if any external endpoints exist, all external endpoints are selected;
      * - If neither exist, all internal endpoints are selected.
-     *
-     * @schema
      */
-    endpointFilter: Type.Default(endpointFilterSchema, []),
+    endpointFilter: endpointFilterSchema.default([]),
 
     /**
      * The mode to use for patching the existing endpoints.
@@ -58,10 +54,8 @@ export function createArgs<TPrefix extends string = "">(prefix?: TPrefix) {
      * - `replace`: Replace the existing endpoints with the FQDN. It will ensure that the only the FQDN is used.
      *
      * The default is `prepend`.
-     *
-     * @schema
      */
-    patchMode: Type.Default(arrayPatchModeSchema, "prepend"),
+    patchMode: arrayPatchModeSchema.default("prepend"),
   })
 }
 
@@ -70,8 +64,6 @@ export const inputs = {
    * The DNS providers to use to create the DNS records.
    *
    * If multiple providers match the domain, all of them will be used and multiple DNS records will be created.
-   *
-   * @schema
    */
   dnsProviders: {
     entity: providerEntity,
@@ -79,4 +71,4 @@ export const inputs = {
   },
 } as const
 
-export type Provider = Static<typeof providerEntity.schema>
+export type Provider = z.infer<typeof providerEntity.schema>

package/src/files.ts

@@ -0,0 +1,135 @@
+import {
+  defineEntity,
+  defineUnit,
+  z,
+  fileContentSchema as baseFileContentSchema,
+  fileMetaSchema as baseFileMetaSchema,
+  unitArtifactSchema,
+} from "@highstate/contract"
+import { l7EndpointEntity } from "./network"
+
+export const checksumAlgorithmSchema = z.enum(["md5", "sha1", "sha256", "sha384", "sha512"])
+
+export const checksumSchema = z.object({
+  algorithm: checksumAlgorithmSchema,
+  value: z.string(),
+})
+
+export const fileContentSchema = z.union([
+  baseFileContentSchema,
+  z.object({
+    type: z.literal("local"),
+    path: z.string(),
+  }),
+  z.object({
+    type: z.literal("remote"),
+    endpoint: l7EndpointEntity.schema,
+    checksum: checksumSchema.optional(),
+  }),
+])
+
+export const fileEntity = defineEntity({
+  type: "common.file",
+
+  schema: z.object({
+    meta: baseFileMetaSchema,
+    content: fileContentSchema,
+  }),
+
+  meta: {
+    color: "#FF5722",
+  },
+})
+
+export const folderMetaSchema = z.object({
+  name: z.string(),
+  mode: z.number().optional(),
+})
+
+export const folderContentSchema = z.union([
+  z.object({
+    type: z.literal("embedded"),
+    files: fileEntity.schema.array(),
+    folders: z
+      .object({
+        meta: folderMetaSchema,
+        get content() {
+          return folderContentSchema
+        },
+      })
+      .array(),
+  }),
+  z.object({
+    type: z.literal("artifact"),
+    ...unitArtifactSchema.shape,
+  }),
+  z.object({
+    type: z.literal("local"),
+    path: z.string(),
+  }),
+  z.object({
+    type: z.literal("remote"),
+    endpoint: l7EndpointEntity.schema,
+  }),
+])
+
+export const folderEntity = defineEntity({
+  type: "common.folder",
+
+  schema: z.object({
+    meta: folderMetaSchema,
+    content: folderContentSchema,
+  }),
+
+  meta: {
+    color: "#FF9800",
+  },
+})
+
+export const remoteFile = defineUnit({
+  type: "common.remote-file",
+
+  args: {
+    /**
+     * The URL of the remote file.
+     */
+    url: z.string().optional(),
+  },
+
+  inputs: {
+    /**
+     * The L7 endpoint of the remote file.
+     */
+    endpoint: {
+      entity: l7EndpointEntity,
+      required: false,
+    },
+  },
+
+  outputs: {
+    file: fileEntity,
+  },
+
+  meta: {
+    title: "Remote File",
+    description: "References a file from a remote URL.",
+    icon: "mdi:file-download",
+    category: "Files",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/remote-file",
+  },
+})
+
+export type File = z.infer<typeof fileEntity.schema>
+export type FileMeta = z.infer<typeof baseFileMetaSchema>
+export type FileContent = z.infer<typeof fileContentSchema>
+
+export type Folder = z.infer<typeof folderEntity.schema>
+export type FolderMeta = z.infer<typeof folderMetaSchema>
+export type FolderContent = z.infer<typeof folderContentSchema>
+
+export type Checksum = z.infer<typeof checksumSchema>
+export type ChecksumAlgorithm = z.infer<typeof checksumAlgorithmSchema>

package/src/git.ts

@@ -0,0 +1,58 @@
+import { defineUnit, z } from "@highstate/contract"
+import { l7EndpointEntity } from "./network"
+import { folderEntity } from "./files"
+
+export const remoteRepository = defineUnit({
+  type: "git.remote-repository",
+
+  args: {
+    /**
+     * The URL of the remote repository.
+     */
+    url: z.string().optional(),
+
+    /**
+     * The ref of the remote repository to checkout.
+     *
+     * If not specified, the default branch will be used.
+     */
+    ref: z.string().optional(),
+
+    /**
+     * Whether to include the .git directory in the packed artifact.
+     *
+     * Do not enable this unless you need the full git history.
+     */
+    includeGit: z.boolean().default(false),
+  },
+
+  inputs: {
+    /**
+     * The L7 endpoint of the remote repository.
+     */
+    endpoint: {
+      entity: l7EndpointEntity,
+      required: false,
+    },
+  },
+
+  outputs: {
+    /**
+     * The folder containing the repository content.
+     */
+    folder: folderEntity,
+  },
+
+  meta: {
+    title: "Git Remote Repository",
+    description: "References a remote Git repository.",
+    icon: "simple-icons:git",
+    iconColor: "#f1502f",
+    category: "Git",
+  },
+
+  source: {
+    package: "@highstate/git",
+    path: "remote-repository",
+  },
+})

package/src/index.ts

@@ -1,3 +1,6 @@
+import { noop } from "./abbreviations"
+noop()
+
 export * as common from "./common"
 export * as proxmox from "./proxmox"
 export * as ssh from "./ssh"
@@ -14,5 +17,7 @@ export * as timeweb from "./timeweb"
 export * as nixos from "./nixos"
 export * as sops from "./sops"
 export * as obfuscators from "./obfuscators"
+export * as distributions from "./distributions"
 export * as network from "./network"
+export * as git from "./git"
 export * from "./utils"