@highstate/library 0.12.0 → 0.12.1

package/dist/index.js

@@ -1149,9 +1149,15 @@ __export(databases_exports, {
   existingMariadb: () => existingMariadb,
   existingMongodb: () => existingMongodb,
   existingPostgresql: () => existingPostgresql,
+  existingRedis: () => existingRedis,
+  existingS3: () => existingS3,
   mariadbEntity: () => mariadbEntity,
   mongodbEntity: () => mongodbEntity,
   postgresqlEntity: () => postgresqlEntity,
+  redisEntity: () => redisEntity,
+  s3BucketPolicySchema: () => s3BucketPolicySchema,
+  s3BucketSchema: () => s3BucketSchema,
+  s3Entity: () => s3Entity,
   sharedArgs: () => sharedArgs,
   sharedInputs: () => sharedInputs,
   sharedSchema: () => sharedSchema,
@@ -1295,6 +1301,132 @@ var existingPostgresql = defineUnit({
     category: "Databases"
   }
 });
+var redisEntity = defineEntity({
+  type: "databases.redis.v1",
+  schema: sharedSchema.pick({ endpoints: true }).extend({
+    /**
+     * The number of the database to use.
+     */
+    database: z.number().default(0)
+  }),
+  meta: {
+    description: `Represents the Redis database or virtual database behind it.`,
+    color: "#dc382d"
+  }
+});
+var existingRedis = defineUnit({
+  type: "databases.redis.existing.v1",
+  args: sharedArgs,
+  inputs: sharedInputs,
+  outputs: {
+    redis: redisEntity
+  },
+  source: {
+    package: "@highstate/common",
+    path: "units/databases/existing-redis"
+  },
+  meta: {
+    description: `The existing Redis database or virtual database behind it.`,
+    title: "Existing Redis Database",
+    icon: "simple-icons:redis",
+    secondaryIcon: "mdi:database",
+    category: "Databases"
+  }
+});
+var s3BucketPolicySchema = z.enum(["none", "download", "upload", "public"]);
+var s3BucketSchema = z.object({
+  /**
+   * The name of the bucket.
+   */
+  name: z.string().meta({ title: camelCaseToHumanReadable("name"), description: `The name of the bucket.` }),
+  /**
+   * The optional policy applied to the bucket.
+   */
+  policy: s3BucketPolicySchema.optional().meta({ title: camelCaseToHumanReadable("policy"), description: `The optional policy applied to the bucket.` })
+});
+var s3Args = $args({
+  /**
+   * The endpoints to connect to the S3-compatible API in form of `host:port`.
+   */
+  endpoints: $addArgumentDescription(z.string().array().min(1), `The endpoints to connect to the S3-compatible API in form of \`host:port\`.`),
+  /**
+   * The access key used to authenticate against the S3-compatible API.
+   */
+  accessKey: $addArgumentDescription(z.string(), `The access key used to authenticate against the S3-compatible API.`),
+  /**
+   * The region associated with the S3-compatible deployment.
+   */
+  region: $addArgumentDescription(z.string().optional(), `The region associated with the S3-compatible deployment.`),
+  /**
+   * The buckets that must exist on the instance.
+   */
+  buckets: $addArgumentDescription(s3BucketSchema.array().default([]), `The buckets that must exist on the instance.`)
+});
+var s3Secrets = $secrets({
+  /**
+   * The secret key used to authenticate against the S3-compatible API.
+   */
+  secretKey: $addArgumentDescription(z.string(), `The secret key used to authenticate against the S3-compatible API.`)
+});
+var s3Inputs = $inputs({
+  /**
+   * The endpoints to connect to the S3-compatible API.
+   */
+  endpoints: $addInputDescription({
+    entity: l4EndpointEntity,
+    multiple: true,
+    required: false
+  }, `The endpoints to connect to the S3-compatible API.`)
+});
+var s3Entity = defineEntity({
+  type: "databases.s3.v1",
+  schema: z.object({
+    /**
+     * The endpoints that expose the S3-compatible API.
+     */
+    endpoints: l4EndpointEntity.schema.array().meta({ title: camelCaseToHumanReadable("endpoints"), description: `The endpoints that expose the S3-compatible API.` }),
+    /**
+     * The region associated with the object storage instance.
+     */
+    region: z.string().optional().meta({ title: camelCaseToHumanReadable("region"), description: `The region associated with the object storage instance.` }),
+    /**
+     * The access key used to authenticate against the API.
+     */
+    accessKey: z.string().meta({ title: camelCaseToHumanReadable("accessKey"), description: `The access key used to authenticate against the API.` }),
+    /**
+     * The secret key used to authenticate against the API.
+     */
+    secretKey: z.string().meta({ title: camelCaseToHumanReadable("secretKey"), description: `The secret key used to authenticate against the API.` }),
+    /**
+     * The buckets that must exist on the instance.
+     */
+    buckets: s3BucketSchema.array().meta({ title: camelCaseToHumanReadable("buckets"), description: `The buckets that must exist on the instance.` })
+  }),
+  meta: {
+    description: `Represents an S3-compatible object storage endpoint.`,
+    color: "#ff9900"
+  }
+});
+var existingS3 = defineUnit({
+  type: "databases.s3.existing.v1",
+  args: s3Args,
+  secrets: s3Secrets,
+  inputs: s3Inputs,
+  outputs: {
+    s3: s3Entity
+  },
+  source: {
+    package: "@highstate/common",
+    path: "units/databases/existing-s3"
+  },
+  meta: {
+    description: `The existing S3-compatible object storage instance.`,
+    title: "Existing S3-Compatible Storage",
+    icon: "simple-icons:amazons3",
+    secondaryIcon: "mdi:bucket",
+    category: "Databases"
+  }
+});
 
 // src/distributions/index.ts
 var distributions_exports = {};
@@ -1914,6 +2046,7 @@ __export(apps_exports, {
   mariadb: () => mariadb,
   mariadbDatabase: () => mariadbDatabase,
   maybe: () => maybe,
+  minio: () => minio,
   mongodb: () => mongodb,
   mongodbDatabase: () => mongodbDatabase,
   optionalSharedArgs: () => optionalSharedArgs,
@@ -1925,6 +2058,7 @@ __export(apps_exports, {
   sharedSecrets: () => sharedSecrets2,
   syncthing: () => syncthing,
   traefik: () => traefik,
+  valkey: () => valkey,
   vaultwarden: () => vaultwarden,
   workload: () => workload
 });
@@ -2220,6 +2354,9 @@ var sharedInputs2 = $inputs({
   },
   mongodb: {
     entity: mongodbEntity
+  },
+  redis: {
+    entity: redisEntity
   }
 });
 var optionalSharedInputs = mapValues(sharedInputs2, (input) => ({
@@ -2386,7 +2523,7 @@ var maybe = defineUnit({
     secretKey: z.string().optional()
   },
   inputs: {
-    ...pick(sharedInputs2, ["k8sCluster", "accessPoint", "postgresql"]),
+    ...pick(sharedInputs2, ["k8sCluster", "accessPoint", "postgresql", "redis"]),
     ...pick(optionalSharedInputs, ["resticRepo"])
   },
   meta: {
@@ -2397,6 +2534,68 @@ var maybe = defineUnit({
   },
   source: source("maybe")
 });
+var minioSecrets = $secrets({
+  /**
+   * The secret key used to authenticate with MinIO.
+   */
+  secretKey: $addArgumentDescription(z.string().optional(), `The secret key used to authenticate with MinIO.`),
+  /**
+   * The key that protects Restic backups.
+   */
+  backupKey: $addArgumentDescription(z.string().optional(), `The key that protects Restic backups.`)
+});
+var minio = defineUnit({
+  type: "k8s.apps.minio.v1",
+  args: {
+    ...appName("minio"),
+    ...pick(sharedArgs2, ["external"]),
+    accessKey: {
+      schema: z.string().default("admin"),
+      meta: {
+        description: text`
+          The access key used to authenticate with MinIO.
+          If not provided, defaults to "admin".
+        `
+      }
+    },
+    region: {
+      schema: z.string().optional(),
+      meta: {
+        description: text`The region associated with the MinIO deployment.`
+      }
+    },
+    buckets: {
+      schema: s3BucketSchema.array().default([]),
+      meta: {
+        description: text`
+          The buckets that must exist on the MinIO instance.
+          Each entry can optionally include a bucket policy: none, download, upload, or public.
+        `
+      }
+    }
+  },
+  secrets: minioSecrets,
+  inputs: {
+    ...pick(sharedInputs2, ["k8sCluster"]),
+    ...pick(optionalSharedInputs, ["resticRepo"])
+  },
+  outputs: {
+    s3: s3Entity,
+    service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true
+    }
+  },
+  meta: {
+    description: `The MinIO object storage deployed on Kubernetes.`,
+    title: "MinIO",
+    icon: "simple-icons:minio",
+    secondaryIcon: "mdi:bucket",
+    category: "Databases"
+  },
+  source: source("minio/app")
+});
 var mongodb = defineUnit({
   type: "k8s.apps.mongodb.v1",
   args: {
@@ -2564,7 +2763,14 @@ var traefik = defineUnit({
   args: {
     ...appName("traefik"),
     ...pick(sharedArgs2, ["external", "replicas", "endpoints"]),
-    className: z.string().optional()
+    /**
+     * The name of the class to configure for ingress and gateway resources.
+     *
+     * Defaults to "traefik".
+     */
+    className: $addArgumentDescription(z.string().default("traefik"), `The name of the class to configure for ingress and gateway resources.
+
+ Defaults to "traefik".`)
   },
   inputs: {
     ...pick(sharedInputs2, ["k8sCluster"])
@@ -2585,6 +2791,36 @@ var traefik = defineUnit({
   },
   source: source("traefik")
 });
+var valkey = defineUnit({
+  type: "k8s.apps.valkey.v1",
+  args: {
+    ...appName("valkey"),
+    ...pick(sharedArgs2, ["external"])
+  },
+  secrets: {
+    ...pick(sharedSecrets2, ["backupKey"])
+  },
+  inputs: {
+    ...pick(sharedInputs2, ["k8sCluster"]),
+    ...pick(optionalSharedInputs, ["resticRepo"])
+  },
+  outputs: {
+    redis: databases_exports.redisEntity,
+    service: serviceEntity,
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true
+    }
+  },
+  meta: {
+    description: `The Valkey instance deployed on Kubernetes.`,
+    title: "Valkey (Redis)",
+    icon: "simple-icons:redis",
+    secondaryIcon: "mdi:database",
+    category: "Databases"
+  },
+  source: source("valkey/app")
+});
 var vaultwarden = defineUnit({
   type: "k8s.apps.vaultwarden.v1",
   args: {
@@ -3664,6 +3900,14 @@ var existingImage = defineUnit({
 var virtualMachine = defineUnit({
   type: "proxmox.virtual-machine.v1",
   args: {
+    /**
+     * The name of the virtual machine.
+     *
+     * If not specified, the unit name will be used.
+     */
+    vmName: $addArgumentDescription(z.string().optional(), `The name of the virtual machine.
+
+ If not specified, the unit name will be used.`),
     /**
      * The name of the node to create the virtual machine on.
      *
@@ -4810,6 +5054,14 @@ var connection3 = defineUnit({
 var virtualMachine2 = defineUnit({
   type: "timeweb.virtual-machine.v1",
   args: {
+    /**
+     * The name of the virtual machine.
+     *
+     * If not provided, the name of the unit will be used.
+     */
+    vmName: $addArgumentDescription(z.string().optional(), `The name of the virtual machine.
+
+ If not provided, the name of the unit will be used.`),
     /**
      * The ID of the preset to use for the virtual machine.
      *
@@ -5165,7 +5417,19 @@ var virtualMachine3 = defineUnit({
       /**
        * Whether to assign a public IP.
        */
-      assignPublicIp: z.boolean().default(true).meta({ title: camelCaseToHumanReadable("assignPublicIp"), description: `Whether to assign a public IP.` })
+      assignPublicIp: z.boolean().default(true).meta({ title: camelCaseToHumanReadable("assignPublicIp"), description: `Whether to assign a public IP.` }),
+      /**
+       * Whether to reserve the public IP permanently.
+       *
+       * If not set, the public IP can be changed when the VM is stopped and started again.
+       *
+       * Makes no sense if `assignPublicIp` is false.
+       */
+      reservePublicIp: z.boolean().default(true).meta({ title: camelCaseToHumanReadable("reservePublicIp"), description: `Whether to reserve the public IP permanently.
+
+ If not set, the public IP can be changed when the VM is stopped and started again.
+
+ Makes no sense if \`assignPublicIp\` is false.` })
     }).prefault({}), `The network configuration.`),
     /**
      * The SSH configuration.