@highstate/library 0.9.8 → 0.9.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@highstate/library",
-  "version": "0.9.8",
+  "version": "0.9.10",
   "type": "module",
   "files": [
     "dist",
@@ -19,12 +19,12 @@
     "build": "highstate build --library"
   },
   "dependencies": {
-    "@highstate/contract": "^0.9.8",
+    "@highstate/contract": "^0.9.10",
     "@sinclair/typebox": "^0.34.11",
     "remeda": "^2.21.0"
   },
   "devDependencies": {
-    "@highstate/cli": "^0.9.8"
+    "@highstate/cli": "^0.9.10"
   },
-  "gitHead": "036db4d9937ff30edf15f143482c5702e5b7a7fb"
+  "gitHead": "aacf8837fdf40f2bb2f83d4c11b35a358e26ec33"
 }

package/src/apps/code-server.ts

@@ -1,6 +1,6 @@
 import { defineUnit, Type } from "@highstate/contract"
 import { persistentVolumeClaimEntity, statefulSetEntity } from "../k8s"
-import { createArgs, createInputs } from "./shared"
+import { createArgs, createInputs, createSecrets } from "./shared"
 
 export const codeServer = defineUnit({
   type: "apps.code-server",
@@ -8,6 +8,7 @@ export const codeServer = defineUnit({
   args: createArgs("code-server", ["fqdn"]),
 
   secrets: {
+    ...createSecrets(["backupPassword"]),
     password: Type.Optional(Type.String()),
     sudoPassword: Type.Optional(Type.String()),
   },

package/src/apps/grocy.ts

@@ -1,10 +1,11 @@
 import { defineUnit } from "@highstate/contract"
-import { createArgs, createInputs, createSource } from "./shared"
+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: {

package/src/apps/mariadb.ts

@@ -1,8 +1,10 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
+import { l4EndpointEntity } from "../network"
 import {
   createArgs,
   createInputs,
+  createSecrets,
   createSource,
   databaseSchema,
   extraInputDefinitions,
@@ -22,16 +24,16 @@ export const mariadb = defineUnit({
   type: "apps.mariadb",
 
   args: createArgs("mariadb", ["external"]),
-
-  secrets: {
-    rootPassword: Type.Optional(Type.String()),
-  },
-
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo"]),
 
   outputs: {
     mariadb: mariadbEntity,
     service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
   },
 
   meta: {

package/src/apps/maybe.ts

@@ -1,5 +1,5 @@
 import { defineUnit, Type } from "@highstate/contract"
-import { createArgs, createInputs, createSource } from "./shared"
+import { createArgs, createInputs, createSecrets, createSource } from "./shared"
 
 export const maybe = defineUnit({
   type: "apps.maybe",
@@ -7,6 +7,7 @@ export const maybe = defineUnit({
   args: createArgs("maybe", ["fqdn"]),
 
   secrets: {
+    ...createSecrets(["backupPassword"]),
     postgresqlPassword: Type.Optional(Type.String()),
     secretKey: Type.Optional(Type.String()),
   },

package/src/apps/mongodb.ts

@@ -1,8 +1,10 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
+import { l4EndpointEntity } from "../network"
 import {
   createArgs,
   createInputs,
+  createSecrets,
   createSource,
   databaseSchema,
   extraInputDefinitions,
@@ -22,16 +24,16 @@ export const mongodb = defineUnit({
   type: "apps.mongodb",
 
   args: createArgs("mongodb", ["external"]),
-
-  secrets: {
-    rootPassword: Type.Optional(Type.String()),
-  },
-
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo"]),
 
   outputs: {
     mongodb: mongodbEntity,
     service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
   },
 
   meta: {

package/src/apps/postgresql.ts

@@ -1,8 +1,10 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
 import { serviceEntity } from "../k8s"
+import { l4EndpointEntity } from "../network"
 import {
   createArgs,
   createInputs,
+  createSecrets,
   createSource,
   databaseSchema,
   extraInputDefinitions,
@@ -22,16 +24,16 @@ export const postgresql = defineUnit({
   type: "apps.postgresql",
 
   args: createArgs("postgresql", ["external"]),
-
-  secrets: {
-    rootPassword: Type.Optional(Type.String()),
-  },
-
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo", "dnsProviders"]),
 
   outputs: {
     postgresql: postgresqlEntity,
     service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
   },
 
   meta: {

package/src/apps/shared.ts

@@ -27,6 +27,17 @@ const extraArgsDefinitions = {
   },
 } as const
 
+const extraSecretsDefinitions = {
+  rootPassword: {
+    schema: Type.String(),
+    required: false,
+  },
+  backupPassword: {
+    schema: Type.String(),
+    required: false,
+  },
+}
+
 type LazyExtraInputDefinitions = {
   mariadb: {
     entity: typeof mariadbEntity
@@ -66,13 +77,23 @@ export const extraInputDefinitions = {
 } 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,
@@ -134,6 +155,58 @@ export function createArgs<
   }
 }
 
+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
 

package/src/apps/syncthing.ts

@@ -1,6 +1,7 @@
 import { defineUnit, Type } from "@highstate/contract"
 import { persistentVolumeClaimEntity, serviceEntity } from "../k8s"
-import { createArgs, createInputs, createSource } from "./shared"
+import { l4EndpointEntity } from "../network"
+import { createArgs, createInputs, createSecrets, createSource } from "./shared"
 
 export const backupModeSchema = Type.StringEnum(["state", "full"])
 
@@ -8,7 +9,7 @@ export const syncthing = defineUnit({
   type: "apps.syncthing",
 
   args: {
-    ...createArgs("syncthing", ["fqdn"]),
+    ...createArgs("syncthing", ["fqdn", "external"]),
 
     /**
      * The FQDN of the Syncthing instance used to sync with other devices.
@@ -30,11 +31,16 @@ export const syncthing = defineUnit({
     backupMode: Type.Default(backupModeSchema, "state"),
   },
 
-  inputs: createInputs(["accessPoint", "resticRepo", "dnsProviders", "volume"]),
+  secrets: createSecrets(["backupPassword"]),
+  inputs: createInputs(["accessPoint", "resticRepo", "volume"]),
 
   outputs: {
-    service: serviceEntity,
     volume: persistentVolumeClaimEntity,
+    service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
   },
 
   meta: {

package/src/apps/traefik.ts

@@ -1,5 +1,6 @@
 import { defineUnit, Type } from "@highstate/contract"
 import { gatewayEntity, serviceEntity } from "../k8s"
+import { l4EndpointEntity } from "../network"
 import { createArgs, createInputs } from "./shared"
 
 export const traefikGateway = defineUnit({
@@ -15,6 +16,10 @@ export const traefikGateway = defineUnit({
   outputs: {
     gateway: gatewayEntity,
     service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
   },
 
   meta: {

package/src/mullvad.ts

@@ -21,6 +21,8 @@ export const peer = defineUnit({
      * The network to use for the WireGuard peer.
      *
      * If not provided, the peer will use default network configuration.
+     *
+     * @schema
      */
     network: {
       entity: networkEntity,

package/src/restic.ts

@@ -1,16 +1,16 @@
 import { defineEntity, defineUnit, Type, type Static } from "@highstate/contract"
+import { l3EndpointEntity, l4EndpointEntity } from "./network"
 
 export const repoEntity = defineEntity({
   type: "restic.repo",
 
   schema: Type.Object({
-    password: Type.String(),
-    remoteEndpoints: Type.Array(Type.String()),
+    remoteEndpoints: Type.Array(Type.Union([l3EndpointEntity.schema, l4EndpointEntity.schema])),
 
     type: Type.Literal("rclone"),
     rcloneConfig: Type.String(),
     remoteName: Type.String(),
-    basePath: Type.String(),
+    pathPattern: Type.String(),
   }),
 
   meta: {
@@ -22,13 +22,39 @@ export const repo = defineUnit({
   type: "restic.repo",
 
   args: {
-    remoteDomains: Type.Optional(Type.Array(Type.String())),
-    basePath: Type.Optional(Type.String()),
+    remoteEndpoints: Type.Default(Type.Array(Type.String()), []),
+
+    /**
+     * The pattern for the path where backups will be stored for the specific application.
+     *
+     * Available variables:
+     *
+     * - `$clusterName`: The name of the Kubernetes cluster where the application is deployed.
+     * - `$appName`: The name of the application for which the backups are being created. Corresponds to the `appName` argument of the unit.
+     * - `$unitName`: The name of the unit, which deploys the application, provided by the user.
+     *
+     * By default, the path pattern is `backups/$clusterName/$appName`.
+     *
+     * @schema
+     */
+    pathPattern: Type.Default(Type.String(), "backups/$clusterName/$appName"),
   },
 
   secrets: {
-    password: Type.Optional(Type.String()),
-    rcloneConfig: Type.String({ multiline: true }),
+    rcloneConfig: Type.String({ language: "ini" }),
+  },
+
+  inputs: {
+    remoteL3Endpoints: {
+      entity: l3EndpointEntity,
+      multiple: true,
+      required: false,
+    },
+    remoteL4Endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+      required: false,
+    },
   },
 
   outputs: {

package/dist/highstate.manifest.json

@@ -1,5 +0,0 @@
-{
-  "sourceHashes": {
-    "./dist/index.js": "7e27bae537314a0fd9379cd60166c5042e6c10ba797885ecfabfafbfdf2a92b0"
-  }
-}