@highstate/library 0.9.7 → 0.9.9

package/dist/highstate.manifest.json

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

package/dist/index.js

@@ -2231,12 +2231,11 @@ import { defineEntity as defineEntity9, defineUnit as defineUnit8, Type as Type1
 var repoEntity = defineEntity9({
   type: "restic.repo",
   schema: Type10.Object({
-    password: Type10.String(),
-    remoteEndpoints: Type10.Array(Type10.String()),
+    remoteEndpoints: Type10.Array(Type10.Union([l3EndpointEntity.schema, l4EndpointEntity.schema])),
     type: Type10.Literal("rclone"),
     rcloneConfig: Type10.String(),
     remoteName: Type10.String(),
-    basePath: Type10.String()
+    pathPattern: Type10.String()
   }),
   meta: {
     color: "#e56901"
@@ -2245,12 +2244,47 @@ var repoEntity = defineEntity9({
 var repo = defineUnit8({
   type: "restic.repo",
   args: {
-    remoteDomains: Type10.Optional(Type10.Array(Type10.String())),
-    basePath: Type10.Optional(Type10.String())
+    remoteEndpoints: Type10.Default(Type10.Array(Type10.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: {
+      ...Type10.Default(Type10.String(), "backups/$clusterName/$appName"),
+      description: `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\`.`
+    }
   },
   secrets: {
-    password: Type10.Optional(Type10.String()),
-    rcloneConfig: Type10.String({ multiline: true })
+    rcloneConfig: Type10.String({ language: "ini" })
+  },
+  inputs: {
+    remoteL3Endpoints: {
+      entity: l3EndpointEntity,
+      multiple: true,
+      required: false
+    },
+    remoteL4Endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+      required: false
+    }
   },
   outputs: {
     repo: repoEntity
@@ -2282,6 +2316,16 @@ var extraArgsDefinitions = {
     required: false
   }
 };
+var extraSecretsDefinitions = {
+  rootPassword: {
+    schema: Type11.String(),
+    required: false
+  },
+  backupPassword: {
+    schema: Type11.String(),
+    required: false
+  }
+};
 var eagerExtraInputDefinitions = {
   accessPoint: {
     entity: accessPointEntity
@@ -2332,6 +2376,29 @@ function createArgs2(defaultAppName, extraArgs) {
     ...dynamicArgs
   };
 }
+function createSecrets(extraSecrets) {
+  const dynamicSecrets = {};
+  if (Array.isArray(extraSecrets)) {
+    for (const name of extraSecrets) {
+      dynamicSecrets[name] = extraSecretsDefinitions[name];
+    }
+  } else {
+    const { required, optional } = extraSecrets ?? {};
+    for (const name of required ?? []) {
+      dynamicSecrets[name] = {
+        ...extraSecretsDefinitions[name],
+        required: true
+      };
+    }
+    for (const name of optional ?? []) {
+      dynamicSecrets[name] = {
+        ...extraSecretsDefinitions[name],
+        required: false
+      };
+    }
+  }
+  return dynamicSecrets;
+}
 function createInputs(inputs2) {
   const base = {
     k8sCluster: clusterEntity2
@@ -2384,9 +2451,7 @@ var mariadbEntity = defineEntity10({
 var mariadb = defineUnit9({
   type: "apps.mariadb",
   args: createArgs2("mariadb", ["external"]),
-  secrets: {
-    rootPassword: Type12.Optional(Type12.String())
-  },
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo"]),
   outputs: {
     mariadb: mariadbEntity,
@@ -2437,9 +2502,7 @@ var postgresqlEntity = defineEntity11({
 var postgresql = defineUnit10({
   type: "apps.postgresql",
   args: createArgs2("postgresql", ["external"]),
-  secrets: {
-    rootPassword: Type13.Optional(Type13.String())
-  },
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo", "dnsProviders"]),
   outputs: {
     postgresql: postgresqlEntity,
@@ -2508,9 +2571,7 @@ var mongodbEntity = defineEntity12({
 var mongodb = defineUnit12({
   type: "apps.mongodb",
   args: createArgs2("mongodb", ["external"]),
-  secrets: {
-    rootPassword: Type15.Optional(Type15.String())
-  },
+  secrets: createSecrets(["rootPassword", "backupPassword"]),
   inputs: createInputs(["resticRepo"]),
   outputs: {
     mongodb: mongodbEntity,
@@ -2704,7 +2765,11 @@ var traefikGateway = defineUnit15({
   inputs: createInputs(),
   outputs: {
     gateway: gatewayEntity,
-    service: serviceEntity
+    service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true
+    }
   },
   meta: {
     displayName: "Traefik Gateway",
@@ -2739,6 +2804,7 @@ import { defineUnit as defineUnit17 } from "@highstate/contract";
 var grocy = defineUnit17({
   type: "apps.grocy",
   args: createArgs2("grocy", ["fqdn"]),
+  secrets: createSecrets(["backupPassword"]),
   inputs: createInputs(["accessPoint", "resticRepo"]),
   meta: {
     displayName: "Grocy",
@@ -2755,6 +2821,7 @@ var maybe = defineUnit18({
   type: "apps.maybe",
   args: createArgs2("maybe", ["fqdn"]),
   secrets: {
+    ...createSecrets(["backupPassword"]),
     postgresqlPassword: Type19.Optional(Type19.String()),
     secretKey: Type19.Optional(Type19.String())
   },
@@ -2840,6 +2907,7 @@ var syncthing = defineUnit20({
      */
     backupMode: Type21.Default(backupModeSchema, "state")
   },
+  secrets: createSecrets(["backupPassword"]),
   inputs: createInputs(["accessPoint", "resticRepo", "dnsProviders", "volume"]),
   outputs: {
     service: serviceEntity,
@@ -2860,6 +2928,7 @@ var codeServer = defineUnit21({
   type: "apps.code-server",
   args: createArgs2("code-server", ["fqdn"]),
   secrets: {
+    ...createSecrets(["backupPassword"]),
     password: Type22.Optional(Type22.String()),
     sudoPassword: Type22.Optional(Type22.String())
   },
@@ -2982,10 +3051,17 @@ var peer2 = defineUnit24({
      * The network to use for the WireGuard peer.
      *
      * If not provided, the peer will use default network configuration.
+     *
+     * @schema
      */
     network: {
-      entity: networkEntity,
-      required: false
+      ...{
+        entity: networkEntity,
+        required: false
+      },
+      description: `The network to use for the WireGuard peer.
+
+ If not provided, the peer will use default network configuration.`
     }
   },
   outputs: {