@highstate/library 0.9.3 → 0.9.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@highstate/library",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "type": "module",
   "files": [
     "dist",
@@ -19,12 +19,12 @@
     "build": "highstate build --library"
   },
   "dependencies": {
-    "@highstate/contract": "^0.9.3",
+    "@highstate/contract": "^0.9.5",
     "@sinclair/typebox": "^0.34.11",
     "remeda": "^2.21.0"
   },
   "devDependencies": {
-    "@highstate/cli": "^0.9.3"
+    "@highstate/cli": "^0.9.5"
   },
-  "gitHead": "cdd2bb1d9001ba4a39f64087eb29af6f50d82bec"
+  "gitHead": "93fa1e8b1189a5232055c852fd79a684d8b80444"
 }

package/src/apps/code-server.ts

@@ -1,37 +1,18 @@
 import { defineUnit, Type } from "@highstate/contract"
-import {
-  accessPointEntity,
-  clusterEntity,
-  persistentVolumeClaimEntity,
-  statefulSetEntity,
-} from "../k8s"
-import { repoEntity } from "../restic"
+import { persistentVolumeClaimEntity, statefulSetEntity } from "../k8s"
+import { createArgs, createInputs } from "./shared"
 
 export const codeServer = defineUnit({
   type: "apps.code-server",
 
-  args: {
-    fqdn: Type.String(),
-    appName: Type.Optional(Type.String()),
-  },
+  args: createArgs("code-server", ["fqdn"]),
 
   secrets: {
     password: Type.Optional(Type.String()),
     sudoPassword: Type.Optional(Type.String()),
   },
 
-  inputs: {
-    accessPoint: accessPointEntity,
-    k8sCluster: clusterEntity,
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-    volume: {
-      entity: persistentVolumeClaimEntity,
-      required: false,
-    },
-  },
+  inputs: createInputs(["accessPoint", "resticRepo", "dnsProviders", "volume"]),
 
   outputs: {
     statefulSet: statefulSetEntity,
@@ -42,6 +23,7 @@ export const codeServer = defineUnit({
     displayName: "Code Server",
     description: "The Code Server instance deployed on Kubernetes.",
     primaryIcon: "material-icon-theme:vscode",
+    category: "Development",
   },
 
   source: {

package/src/apps/deployment.ts

@@ -1,10 +1,6 @@
 import { defineUnit, Type } from "@highstate/contract"
-import { clusterEntity, deploymentEntity, serviceEntity, serviceTypeSchema } from "../k8s"
-import { repoEntity } from "../restic"
-import { providerEntity } from "../dns"
-import { mariadbEntity } from "./mariadb"
-import { postgresqlEntity } from "./postgresql"
-import { mongodbEntity } from "./mongodb"
+import { deploymentEntity, serviceEntity, serviceTypeSchema } from "../k8s"
+import { createInputs, createSource } from "./shared"
 
 export const deployment = defineUnit({
   type: "apps.deployment",
@@ -32,51 +28,33 @@ export const deployment = defineUnit({
     httpRouteManifest: Type.Optional(Type.Record(Type.String(), Type.Any())),
   },
 
-  inputs: {
-    k8sCluster: clusterEntity,
-
-    mariadb: {
-      entity: mariadbEntity,
-      required: false,
-    },
-    postgresql: {
-      entity: postgresqlEntity,
-      required: false,
-    },
-    mongodb: {
-      entity: mongodbEntity,
-      required: false,
-    },
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-    dnsProvider: {
-      entity: providerEntity,
-      required: false,
-    },
+  secrets: {
+    mariadbPassword: Type.Optional(Type.String()),
+    postgresqlPassword: Type.Optional(Type.String()),
+    mongodbPassword: Type.Optional(Type.String()),
   },
 
+  inputs: createInputs([
+    "accessPoint",
+    "mariadb",
+    "postgresql",
+    "mongodb",
+    "resticRepo",
+    "dnsProviders",
+  ]),
+
   outputs: {
     deployment: deploymentEntity,
     service: serviceEntity,
   },
 
-  secrets: {
-    mariadbPassword: Type.Optional(Type.String()),
-    postgresqlPassword: Type.Optional(Type.String()),
-    mongodbPassword: Type.Optional(Type.String()),
-  },
-
   meta: {
     displayName: "Kubernetes Deployment",
     description: "A generic Kubernetes deployment with optional service and gateway routes.",
-    primaryIcon: "mdi:kubernetes",
+    primaryIcon: "devicon:kubernetes",
     secondaryIcon: "mdi:cube-outline",
+    category: "Kubernetes",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "deployment",
-  },
+  source: createSource("deployment"),
 })

package/src/apps/dns.ts

@@ -0,0 +1,109 @@
+import { defineUnit, Type } from "@highstate/contract"
+import { l3EndpointEntity, l4EndpointEntity } from "../network"
+import { providerEntity } from "../dns"
+import { createSource } from "./shared"
+
+const endpointFilterSchema = Type.StringEnum(["all", "public", "external", "internal"])
+
+export const recordSet = defineUnit({
+  type: "apps.dns-record-set",
+
+  args: {
+    /**
+     * The name of the DNS record.
+     *
+     * If not provided, will use the name of the unit.
+     */
+    recordName: Type.Optional(Type.String()),
+
+    /**
+     * The type of the DNS record.
+     *
+     * If not specified, will use the default type for the provider.
+     */
+    type: Type.Optional(Type.String()),
+
+    /**
+     * The values of the DNS record.
+     */
+    values: Type.Array(Type.String()),
+
+    /**
+     * The TTL of the DNS record.
+     */
+    ttl: Type.Optional(Type.Number()),
+
+    /**
+     * The priority of the DNS record.
+     */
+    priority: Type.Optional(Type.Number()),
+
+    /**
+     * Whether the DNS record is proxied.
+     *
+     * Available only for public IPs and some DNS providers like Cloudflare.
+     */
+    proxied: Type.Optional(Type.Boolean()),
+
+    /**
+     * The filter to apply to the endpoints.
+     *
+     * - `all`: All endpoints.
+     * - `public`: Only public endpoints accessible from the internet (default).
+     * - `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"),
+  },
+
+  inputs: {
+    dnsProviders: {
+      entity: providerEntity,
+      multiple: true,
+    },
+    l3Endpoints: {
+      entity: l3EndpointEntity,
+      required: false,
+      multiple: true,
+    },
+    l4Endpoints: {
+      entity: l4EndpointEntity,
+      required: false,
+      multiple: true,
+    },
+  },
+
+  outputs: {
+    /**
+     * The single L3 endpoint representing created DNS records.
+     */
+    l3Endpoint: l3EndpointEntity,
+
+    /**
+     * Multiple L4 endpoints representing created DNS records for each unique port/protocol combination from the input L4 endpoints.
+     */
+    l4Endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
+  },
+
+  meta: {
+    displayName: "DNS Record Set",
+    description: "A set of DNS records to be created.",
+    primaryIcon: "mdi:server",
+    defaultNamePrefix: "record",
+    category: "Network",
+  },
+
+  source: createSource("dns-record-set"),
+})
+
+export const sharedArgs = {
+  /**
+   * The FQDN to register the cluster nodes with.
+   *
+   * @schema
+   */
+  fqdn: Type.Optional(Type.String()),
+}

package/src/apps/gitea.ts

@@ -1,31 +1,18 @@
-import { defineUnit, Type } from "@highstate/contract"
-import { accessPointEntity, clusterEntity } from "../k8s"
-import { mariadbEntity } from "./mariadb"
+import { defineUnit } from "@highstate/contract"
+import { createArgs, createInputs, createSource } from "./shared"
 
 export const gitea = defineUnit({
   type: "apps.gitea",
 
-  args: {
-    domain: Type.String(),
-  },
-
-  inputs: {
-    mariadb: {
-      entity: mariadbEntity,
-      displayName: "MariaDB",
-    },
-    accessPoint: accessPointEntity,
-    k8sCluster: clusterEntity,
-  },
+  args: createArgs("gitea"),
+  inputs: createInputs(["accessPoint", "mariadb"]),
 
   meta: {
     displayName: "Gitea",
     description: "The Gitea Git server deployed on Kubernetes.",
     primaryIcon: "simple-icons:gitea",
+    category: "Development",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "gitea",
-  },
+  source: createSource("gitea"),
 })

package/src/apps/grocy.ts

@@ -1,33 +1,19 @@
-import { defineUnit, Type } from "@highstate/contract"
-import { accessPointEntity, clusterEntity } from "../k8s"
-import { repoEntity } from "../restic"
+import { defineUnit } from "@highstate/contract"
+import { createArgs, createInputs, createSource } from "./shared"
 
 export const grocy = defineUnit({
   type: "apps.grocy",
 
-  args: {
-    fqdn: Type.String(),
-    appName: Type.Optional(Type.String()),
-  },
-
-  inputs: {
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-    accessPoint: accessPointEntity,
-    k8sCluster: clusterEntity,
-  },
+  args: createArgs("grocy", ["fqdn"]),
+  inputs: createInputs(["accessPoint", "resticRepo"]),
 
   meta: {
     displayName: "Grocy",
     description:
       "Grocy is a web-based self-hosted groceries & household management solution for your home.",
     primaryIcon: "simple-icons:grocy",
+    category: "Productivity",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "grocy",
-  },
+  source: createSource("grocy"),
 })

package/src/apps/index.ts

@@ -1,13 +1,17 @@
 export * from "./mariadb"
 export * from "./postgresql"
 export * from "./vaultwarden"
+export * from "./mongodb"
+export * from "./network"
+export * from "./dns"
 // export * from "./zitadel"
 // export * from "./gitea"
 export * from "./traefik"
 export * from "./kubernetes-dashboard"
 export * from "./grocy"
 export * from "./maybe"
-export * from "./mongodb"
 export * from "./deployment"
 export * from "./syncthing"
 export * from "./code-server"
+
+export { createArgs, createInputs } from "./shared"

package/src/apps/kubernetes-dashboard.ts

@@ -1,28 +1,19 @@
-import { defineUnit, Type } from "@highstate/contract"
-import { accessPointEntity, clusterEntity } from "../k8s"
+import { defineUnit } from "@highstate/contract"
+import { createArgs, createInputs, createSource } from "./shared"
 
 export const kubernetesDashboard = defineUnit({
   type: "apps.kubernetes-dashboard",
 
-  args: {
-    fqdn: Type.String(),
-    appName: Type.Optional(Type.String()),
-  },
-
-  inputs: {
-    k8sCluster: clusterEntity,
-    accessPoint: accessPointEntity,
-  },
+  args: createArgs("kubernetes-dashboard", ["fqdn"]),
+  inputs: createInputs(["accessPoint"]),
 
   meta: {
     displayName: "Kubernetes Dashboard",
     description: "The Kubernetes Dashboard deployed on Kubernetes.",
-    primaryIcon: "simple-icons:kubernetes",
-    secondaryIcon: "mdi:dashboard",
+    primaryIcon: "devicon:kubernetes",
+    secondaryIcon: "material-symbols:dashboard",
+    category: "Kubernetes",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "kubernetes-dashboard",
-  },
+  source: createSource("kubernetes-dashboard"),
 })

package/src/apps/mariadb.ts

@@ -1,18 +1,17 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
-import { clusterEntity, serviceEntity } from "../k8s"
-import { repoEntity } from "../restic"
-import { providerEntity } from "../dns"
+import { serviceEntity } from "../k8s"
+import {
+  createArgs,
+  createInputs,
+  createSource,
+  databaseSchema,
+  extraInputDefinitions,
+} from "./shared"
 
 export const mariadbEntity = defineEntity({
   type: "apps.mariadb",
 
-  schema: Type.Object({
-    service: Type.Optional(serviceEntity.schema),
-
-    host: Type.String(),
-    port: Type.Number(),
-    rootPassword: Type.String(),
-  }),
+  schema: databaseSchema,
 
   meta: {
     color: "#f06292",
@@ -22,26 +21,13 @@ export const mariadbEntity = defineEntity({
 export const mariadb = defineUnit({
   type: "apps.mariadb",
 
-  args: {
-    fqdn: Type.Optional(Type.String()),
-    appName: Type.Optional(Type.String()),
-  },
+  args: createArgs("mariadb", ["external"]),
 
   secrets: {
     rootPassword: Type.Optional(Type.String()),
   },
 
-  inputs: {
-    k8sCluster: clusterEntity,
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-    dnsProvider: {
-      entity: providerEntity,
-      required: false,
-    },
-  },
+  inputs: createInputs(["resticRepo"]),
 
   outputs: {
     mariadb: mariadbEntity,
@@ -53,14 +39,17 @@ export const mariadb = defineUnit({
     description: "The MariaDB database deployed on Kubernetes.",
     primaryIcon: "simple-icons:mariadb",
     secondaryIcon: "mdi:database",
+    category: "Databases",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "mariadb/app",
-  },
+  source: createSource("mariadb/app"),
 })
 
+extraInputDefinitions.mariadb = {
+  entity: mariadbEntity,
+  displayName: "MariaDB",
+}
+
 export const mariadbDatabase = defineUnit({
   type: "apps.mariadb.database",
 
@@ -69,27 +58,22 @@ export const mariadbDatabase = defineUnit({
     username: Type.Optional(Type.String()),
   },
 
+  inputs: createInputs(["mariadb"]),
+
   secrets: {
     password: Type.Optional(Type.String()),
   },
 
-  inputs: {
-    k8sCluster: clusterEntity,
-    mariadb: mariadbEntity,
-  },
-
   meta: {
     displayName: "MariaDB Database",
     description:
       "The virtual MariaDB database created on the MariaDB instance. Works only for MariaDB instances deployed on Kubernetes.",
     primaryIcon: "simple-icons:mariadb",
     secondaryIcon: "mdi:database-plus",
+    category: "Databases",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "mariadb/database",
-  },
+  source: createSource("mariadb/database"),
 })
 
 export type MariaDB = Static<typeof mariadbEntity.schema>

package/src/apps/maybe.ts

@@ -1,39 +1,24 @@
 import { defineUnit, Type } from "@highstate/contract"
-import { accessPointEntity, clusterEntity } from "../k8s"
-import { repoEntity } from "../restic"
-import { postgresqlEntity } from "./postgresql"
+import { createArgs, createInputs, createSource } from "./shared"
 
 export const maybe = defineUnit({
   type: "apps.maybe",
 
-  args: {
-    fqdn: Type.String(),
-    appName: Type.Optional(Type.String()),
-  },
-
-  inputs: {
-    postgresql: postgresqlEntity,
-    accessPoint: accessPointEntity,
-    k8sCluster: clusterEntity,
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-  },
+  args: createArgs("maybe", ["fqdn"]),
 
   secrets: {
     postgresqlPassword: Type.Optional(Type.String()),
     secretKey: Type.Optional(Type.String()),
   },
 
+  inputs: createInputs(["accessPoint", "resticRepo", "postgresql"]),
+
   meta: {
     displayName: "Maybe",
     description: "The OS for your personal finances.",
     primaryIcon: "arcticons:finance-manager",
+    category: "Finance",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "maybe",
-  },
+  source: createSource("maybe"),
 })

package/src/apps/mongodb.ts

@@ -1,18 +1,17 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
-import { clusterEntity, serviceEntity, serviceTypeSchema } from "../k8s"
-import { repoEntity } from "../restic"
-import { providerEntity } from "../dns"
+import { serviceEntity } from "../k8s"
+import {
+  createArgs,
+  createInputs,
+  createSource,
+  databaseSchema,
+  extraInputDefinitions,
+} from "./shared"
 
 export const mongodbEntity = defineEntity({
   type: "apps.mongodb",
 
-  schema: Type.Object({
-    service: Type.Optional(serviceEntity.schema),
-
-    host: Type.String(),
-    port: Type.Number(),
-    rootPassword: Type.String(),
-  }),
+  schema: databaseSchema,
 
   meta: {
     color: "#13aa52",
@@ -22,27 +21,13 @@ export const mongodbEntity = defineEntity({
 export const mongodb = defineUnit({
   type: "apps.mongodb",
 
-  args: {
-    fqdn: Type.Optional(Type.String()),
-    appName: Type.Optional(Type.String()),
-    serviceType: Type.Optional(serviceTypeSchema),
-  },
+  args: createArgs("mongodb", ["external"]),
 
   secrets: {
     rootPassword: Type.Optional(Type.String()),
   },
 
-  inputs: {
-    k8sCluster: clusterEntity,
-    resticRepo: {
-      entity: repoEntity,
-      required: false,
-    },
-    dnsProvider: {
-      entity: providerEntity,
-      required: false,
-    },
-  },
+  inputs: createInputs(["resticRepo"]),
 
   outputs: {
     mongodb: mongodbEntity,
@@ -54,14 +39,17 @@ export const mongodb = defineUnit({
     description: "The MongoDB instance deployed on Kubernetes.",
     primaryIcon: "simple-icons:mongodb",
     secondaryIcon: "mdi:database",
+    category: "Databases",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "mongodb/app",
-  },
+  source: createSource("mongodb/app"),
 })
 
+extraInputDefinitions.mongodb = {
+  entity: mongodbEntity,
+  displayName: "MongoDB",
+}
+
 export const mongodbDatabase = defineUnit({
   type: "apps.mongodb.database",
 
@@ -74,10 +62,7 @@ export const mongodbDatabase = defineUnit({
     password: Type.Optional(Type.String()),
   },
 
-  inputs: {
-    k8sCluster: clusterEntity,
-    mongodb: mongodbEntity,
-  },
+  inputs: createInputs(["mongodb"]),
 
   meta: {
     displayName: "MongoDB Database",
@@ -85,12 +70,10 @@ export const mongodbDatabase = defineUnit({
       "The virtual MongoDB database created on the MongoDB instance. Works only for MongoDB instances deployed on Kubernetes.",
     primaryIcon: "simple-icons:mongodb",
     secondaryIcon: "mdi:database-plus",
+    category: "Databases",
   },
 
-  source: {
-    package: "@highstate/apps",
-    path: "mongodb/database",
-  },
+  source: createSource("mongodb/database"),
 })
 
 export type MongoDB = Static<typeof mongodbEntity.schema>