@highstate/library 0.18.0 → 0.20.0

package/src/network/address-space.ts

@@ -1,8 +1,14 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
-import { l3EndpointEntity } from "./endpoint"
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
 import { subnetEntity } from "./subnet"
 
-export type AddressSpace = z.infer<typeof addressSpaceEntity.schema>
+export type AddressSpace = EntityValue<typeof addressSpaceEntity>
+export type AddressSpaceInput = EntityInput<typeof addressSpaceEntity>
 
 /**
  * The entity representing a network address space.
@@ -17,6 +23,7 @@ export const addressSpaceEntity = defineEntity({
     subnets: {
       entity: subnetEntity,
       multiple: true,
+      required: false,
     },
   },
 
@@ -24,6 +31,9 @@ export const addressSpaceEntity = defineEntity({
 
   meta: {
     color: "#3F51B5",
+    title: "Address Space",
+    icon: "mdi:network",
+    iconColor: "#3F51B5",
   },
 })
 
@@ -56,19 +66,19 @@ export const addressSpace = defineUnit({
 
   inputs: {
     /**
-     * The endpoints to include in the address space.
+     * The subnets to include in the address space.
      */
     included: {
-      entity: l3EndpointEntity,
+      entity: subnetEntity,
       multiple: true,
       required: false,
     },
 
     /**
-     * The endpoints to exclude from the `included` list.
+     * The subnets to exclude from the `included` list.
      */
     excluded: {
-      entity: l3EndpointEntity,
+      entity: subnetEntity,
       multiple: true,
       required: false,
     },

package/src/network/address.ts

@@ -1,7 +1,8 @@
-import { defineEntity, z } from "@highstate/contract"
+import { defineEntity, type EntityInput, type EntityValue, z } from "@highstate/contract"
 import { addressTypeSchema, subnetEntity } from "./subnet"
 
-export type Address = z.infer<typeof addressEntity.schema>
+export type Address = EntityValue<typeof addressEntity>
+export type AddressInput = EntityInput<typeof addressEntity>
 
 export const addressEntity = defineEntity({
   type: "network.address.v1",
@@ -11,6 +12,12 @@ export const addressEntity = defineEntity({
      * The subnet to which the address belongs.
      */
     subnet: subnetEntity,
+
+    /**
+     * The subnet containing the single address.
+     * Can be used to provide address entity where subnet entity is expected.
+     */
+    asSubnet: subnetEntity,
   },
 
   schema: z.object({
@@ -30,4 +37,9 @@ export const addressEntity = defineEntity({
      */
     value: z.string(),
   }),
+
+  meta: {
+    title: "Address",
+    icon: "mdi:ip",
+  },
 })

package/src/network/endpoint-container.ts

@@ -0,0 +1,235 @@
+import {
+  $args,
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
+import { pick } from "remeda"
+import { addressEntity } from "./address"
+import {
+  l3EndpointEntity,
+  l4EndpointEntity,
+  l7EndpointEntity,
+  optionalNetworkArgs,
+} from "./endpoint"
+
+export const l3EndpointContainer = defineEntity({
+  type: "network.l3-endpoint-container.v1",
+
+  includes: {
+    endpoints: {
+      entity: l3EndpointEntity,
+      multiple: true,
+    },
+  },
+
+  schema: z.unknown(),
+
+  meta: {
+    color: "#4CAF50",
+    title: "L3 Endpoint Container",
+    icon: "mdi:network-outline",
+    iconColor: "#4CAF50",
+  },
+})
+
+export const l4EndpointContainer = defineEntity({
+  type: "network.l4-endpoint-container.v1",
+
+  includes: {
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
+  },
+
+  schema: z.unknown(),
+
+  meta: {
+    color: "#2196F3",
+    title: "L4 Endpoint Container",
+    icon: "mdi:network-outline",
+    iconColor: "#2196F3",
+  },
+})
+
+export const l7EndpointContainer = defineEntity({
+  type: "network.l7-endpoint-container.v1",
+
+  includes: {
+    endpoints: {
+      entity: l7EndpointEntity,
+      multiple: true,
+    },
+  },
+
+  schema: z.unknown(),
+
+  meta: {
+    color: "#FF9800",
+    title: "L7 Endpoint Container",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
+  },
+})
+
+const endpointReplacerArgs = $args({
+  /**
+   * The strings to parse as endpoints and add to the replacement list.
+   */
+  endpoints: z.string().array().default([]),
+
+  /**
+   * Whether to add current endpoints of the entity to the replacement list.
+   *
+   * Defaults to `true`.
+   */
+  includeCurrent: z.boolean().default(true),
+
+  ...pick(optionalNetworkArgs, ["endpointFilter"]),
+})
+
+/**
+ * Replaces the L3 endpoints in the entity.
+ */
+export const l3EndpointReplacer = defineUnit({
+  type: "network.l3-endpoint-replacer.v1",
+
+  args: endpointReplacerArgs,
+
+  inputs: {
+    /**
+     * The entity containing the "endpoints" inclusion to replace.
+     */
+    entity: l3EndpointContainer,
+
+    /**
+     * The endpoints to add to the replacement list.
+     */
+    endpoints: {
+      entity: l3EndpointEntity,
+      multiple: true,
+      required: false,
+    },
+
+    /**
+     * The IP addresses to parse as endpoints and add to the replacement list.
+     */
+    addresses: {
+      entity: addressEntity,
+      multiple: true,
+      required: false,
+    },
+  },
+
+  outputs: {
+    entity: { fromInput: "entity" },
+  },
+
+  meta: {
+    title: "L3 Endpoint Replacer",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
+    secondaryIcon: "mdi:swap-horizontal-bold",
+    category: "Network",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/network/l3-endpoint-replacer",
+  },
+})
+
+/**
+ * Replaces the L4 endpoints in the entity.
+ */
+export const l4EndpointReplacer = defineUnit({
+  type: "network.l4-endpoint-replacer.v1",
+
+  args: endpointReplacerArgs,
+
+  inputs: {
+    /**
+     * The entity containing the "endpoints" inclusion to replace.
+     */
+    entity: l4EndpointContainer,
+
+    /**
+     * The endpoints to add to the replacement list.
+     */
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+      required: false,
+    },
+  },
+
+  outputs: {
+    entity: { fromInput: "entity" },
+  },
+
+  meta: {
+    title: "L4 Endpoint Replacer",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
+    secondaryIcon: "mdi:swap-horizontal-bold",
+    category: "Network",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/network/l4-endpoint-replacer",
+  },
+})
+
+/**
+ * Replaces the L7 endpoints in the entity.
+ */
+export const l7EndpointReplacer = defineUnit({
+  type: "network.l7-endpoint-replacer.v1",
+
+  args: endpointReplacerArgs,
+
+  inputs: {
+    /**
+     * The entity containing the "endpoints" inclusion to replace.
+     */
+    entity: l7EndpointContainer,
+
+    /**
+     * The endpoints to add to the replacement list.
+     */
+    endpoints: {
+      entity: l7EndpointEntity,
+      multiple: true,
+      required: false,
+    },
+  },
+
+  outputs: {
+    entity: { fromInput: "entity" },
+  },
+
+  meta: {
+    title: "L7 Endpoint Replacer",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
+    secondaryIcon: "mdi:swap-horizontal-bold",
+    category: "Network",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/network/l7-endpoint-replacer",
+  },
+})
+
+export type L3EndpointContainer = EntityValue<typeof l3EndpointContainer>
+export type L4EndpointContainer = EntityValue<typeof l4EndpointContainer>
+export type L7EndpointContainer = EntityValue<typeof l7EndpointContainer>
+
+export type L3EndpointContainerInput = EntityInput<typeof l3EndpointContainer>
+export type L4EndpointContainerInput = EntityInput<typeof l4EndpointContainer>
+export type L7EndpointContainerInput = EntityInput<typeof l7EndpointContainer>

package/src/network/endpoint-schema.ts

@@ -1,4 +1,5 @@
 import { z } from "@highstate/contract"
+import { implementationReferenceSchema } from "../impl-ref"
 import { metadataSchema } from "../utils"
 import { addressEntity } from "./address"
 
@@ -33,6 +34,13 @@ function createEndpointSchema<TLevel extends number, TShape extends z.core.$ZodS
         }),
       ),
 
+      /**
+       * The implementation reference that will be used to resolve the endpoint at runtime.
+       *
+       * Used primarily to expose endpoints from private networks to the Pulumi program.
+       */
+      implRef: implementationReferenceSchema.optional(),
+
       ...shape,
     }),
     z.union([

package/src/network/endpoint.ts

@@ -1,13 +1,15 @@
 import type { Simplify } from "type-fest"
-import { $args, defineEntity, defineUnit, z } from "@highstate/contract"
+import {
+  $args,
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
 import { mapValues, pick } from "remeda"
 import { metadataSchema } from "../utils"
 import { addressEntity } from "./address"
-import {
-  dynamicL3EndpointEntity,
-  dynamicL4EndpointEntity,
-  dynamicL7EndpointEntity,
-} from "./dynamic-endpoint"
 import {
   l3EndpointSchema,
   l4EndpointSchema,
@@ -46,22 +48,15 @@ export const l3EndpointEntity = defineEntity({
       entity: addressEntity,
       required: false,
     },
-
-    /**
-     * The dynamic endpoint which statically resolves to this endpoint.
-     *
-     * Allows to use any static endpoint as a dynamic without extra units.
-     */
-    dynamic: {
-      entity: dynamicL3EndpointEntity,
-      required: false,
-    },
   },
 
   schema: l3EndpointSchema,
 
   meta: {
     color: "#4CAF50",
+    title: "L3 Endpoint",
+    icon: "mdi:network-outline",
+    iconColor: "#4CAF50",
   },
 })
 
@@ -84,20 +79,13 @@ export const l4EndpointEntity = defineEntity({
   type: "network.l4-endpoint.v1",
 
   extends: { l3EndpointEntity },
-
-  includes: {
-    /**
-     * The dynamic endpoint which statically resolves to this endpoint.
-     *
-     * Allows to use any static endpoint as a dynamic without extra units.
-     */
-    dynamic: dynamicL4EndpointEntity,
-  },
-
   schema: l4EndpointSchema,
 
   meta: {
     color: "#2196F3",
+    title: "L4 Endpoint",
+    icon: "mdi:network-outline",
+    iconColor: "#2196F3",
   },
 })
 
@@ -110,20 +98,13 @@ export const l7EndpointEntity = defineEntity({
   type: "network.l7-endpoint.v1",
 
   extends: { l4EndpointEntity },
-
-  includes: {
-    /**
-     * The dynamic endpoint which statically resolves to this endpoint.
-     *
-     * Allows to use any static endpoint as a dynamic without extra units.
-     */
-    dynamic: dynamicL7EndpointEntity,
-  },
-
   schema: l7EndpointSchema,
 
   meta: {
     color: "#FF9800",
+    title: "L7 Endpoint",
+    icon: "mdi:network-outline",
+    iconColor: "#FF9800",
   },
 })
 
@@ -331,11 +312,14 @@ export const endpointFilter = defineUnit({
   },
 })
 
-export type L3Endpoint = Simplify<z.infer<typeof l3EndpointEntity.schema>>
-export type L4Endpoint = Simplify<z.infer<typeof l4EndpointEntity.schema>>
+export type L3Endpoint = Simplify<EntityValue<typeof l3EndpointEntity>>
+export type L3EndpointInput = EntityInput<typeof l3EndpointEntity>
+export type L4Endpoint = Simplify<EntityValue<typeof l4EndpointEntity>>
+export type L4EndpointInput = EntityInput<typeof l4EndpointEntity>
 export type L4Protocol = z.infer<typeof l4ProtocolSchema>
 export type L4PortInfo = z.infer<typeof l4PortInfoSchema>
-export type L7Endpoint = Simplify<z.infer<typeof l7EndpointEntity.schema>>
+export type L7Endpoint = Simplify<EntityValue<typeof l7EndpointEntity>>
+export type L7EndpointInput = EntityInput<typeof l7EndpointEntity>
 export type L7AppInfo = z.infer<typeof l7AppInfoSchema>
 
 export type EndpointLevel = L3Endpoint["level"]

package/src/network/index.ts

@@ -1,6 +1,6 @@
 export * from "./address"
 export * from "./address-space"
-export * from "./dynamic-endpoint"
 export * from "./endpoint"
+export * from "./endpoint-container"
 export * from "./endpoint-schema"
 export * from "./subnet"

package/src/network/subnet.ts

@@ -1,6 +1,7 @@
-import { defineEntity, z } from "@highstate/contract"
+import { defineEntity, type EntityInput, type EntityValue, z } from "@highstate/contract"
 
-export type Subnet = z.infer<typeof subnetEntity.schema>
+export type Subnet = EntityValue<typeof subnetEntity>
+export type SubnetInput = EntityInput<typeof subnetEntity>
 export type AddressType = z.infer<typeof addressTypeSchema>
 
 export const addressTypeSchema = z.enum(["ipv4", "ipv6"])
@@ -26,6 +27,8 @@ export const subnetEntity = defineEntity({
   }),
 
   meta: {
+    title: "Subnet",
+    icon: "ri:network-line",
     color: "#3F51B5",
   },
 })

package/src/proxmox.ts

@@ -1,4 +1,11 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  secretSchema,
+  z,
+} from "@highstate/contract"
 import {
   checksumSchema,
   fileEntity,
@@ -13,6 +20,18 @@ import * as ssh from "./ssh"
 export const clusterEntity = defineEntity({
   type: "proxmox.cluster.v1",
 
+  includes: {
+    /**
+     * The SSH configuration for the Proxmox nodes.
+     *
+     * If not specified, it will be assumed that the nodes are not accessible via SSH.
+     */
+    ssh: {
+      entity: ssh.connectionEntity,
+      required: false,
+    },
+  },
+
   schema: z.object({
     endpoint: l7EndpointEntity.schema,
     insecure: z.boolean().optional(),
@@ -21,10 +40,8 @@ export const clusterEntity = defineEntity({
     defaultNodeName: z.string(),
     defaultDatastoreId: z.string(),
 
-    password: z.string().optional(),
-    apiToken: z.string().optional(),
-
-    ssh: ssh.connectionSchema.optional(),
+    password: secretSchema(z.string()).optional(),
+    apiToken: secretSchema(z.string()).optional(),
   }),
 
   meta: {
@@ -430,5 +447,8 @@ export const virtualMachine = defineUnit({
   },
 })
 
-export type Cluster = z.infer<typeof clusterEntity.schema>
-export type Image = z.infer<typeof imageEntity.schema>
+export type Cluster = EntityValue<typeof clusterEntity>
+export type Image = EntityValue<typeof imageEntity>
+
+export type ClusterInput = EntityInput<typeof clusterEntity>
+export type ImageInput = EntityInput<typeof imageEntity>

package/src/restic.ts

@@ -1,4 +1,10 @@
-import { defineEntity, defineUnit, z } from "@highstate/contract"
+import {
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  z,
+} from "@highstate/contract"
 import { l3EndpointEntity, l4EndpointEntity } from "./network"
 
 export const repositoryEntity = defineEntity({
@@ -82,4 +88,5 @@ export const repository = defineUnit({
   },
 })
 
-export type Repository = z.infer<typeof repositoryEntity.schema>
+export type Repository = EntityValue<typeof repositoryEntity>
+export type RepositoryInput = EntityInput<typeof repositoryEntity>

package/src/ssh.ts

@@ -1,5 +1,13 @@
-import { $inputs, $secrets, defineEntity, defineUnit, z } from "@highstate/contract"
-import { fileEntity } from "./common/files"
+import {
+  $inputs,
+  $secrets,
+  defineEntity,
+  defineUnit,
+  type EntityInput,
+  type EntityValue,
+  secretSchema,
+  z,
+} from "@highstate/contract"
 import { l4EndpointEntity, portSchema } from "./network"
 
 export const keyTypeSchema = z.enum(["ed25519"])
@@ -43,44 +51,66 @@ export const keyPairEntity = defineEntity({
     /**
      * The private key in PEM format.
      */
-    privateKey: z.string(),
+    privateKey: secretSchema(z.string()),
   }),
 
   meta: {
     color: "#2b5797",
+    title: "SSH Key Pair",
+    icon: "charm:key",
+    iconColor: "#ffffff",
+    secondaryIcon: "mdi:lock",
+    secondaryIconColor: "#ffffff",
   },
 })
 
 /**
- * The schema for the SSH connection configuration.
- *
- * Contains enough information to connect to an SSH server.
+ * The schema for the SSH connection credentials.
  */
-export const connectionSchema = z.object({
-  /**
-   * The list of L4 endpoints which can be used to connect to the SSH server.
-   */
-  endpoints: l4EndpointEntity.schema.array(),
+export const connectionEntity = defineEntity({
+  type: "ssh.connection.v1",
 
-  /**
-   * The host key of the SSH server which will be used to verify the server's identity.
-   */
-  hostKey: z.string(),
+  includes: {
+    /**
+     * The endpoints to connect to.
+     */
+    endpoints: {
+      entity: l4EndpointEntity,
+      multiple: true,
+    },
 
-  /**
-   * The user to connect as.
-   */
-  user: z.string(),
+    /**
+     * The SSH key pair to use for authentication.
+     */
+    keyPair: {
+      entity: keyPairEntity,
+      required: false,
+    },
+  },
 
-  /**
-   * The password to use for authentication.
-   */
-  password: z.string().optional(),
+  schema: z.object({
+    /**
+     * The host key of the SSH server which will be used to verify the server's identity.
+     */
+    hostKey: z.string(),
 
-  /**
-   * The SSH key pair to use for authentication.
-   */
-  keyPair: keyPairEntity.schema.optional(),
+    /**
+     * The user to connect as.
+     */
+    user: z.string(),
+
+    /**
+     * The password to use for authentication.
+     */
+    password: secretSchema(z.string()).optional(),
+  }),
+
+  meta: {
+    color: "#2b5797",
+    title: "SSH Connection",
+    icon: "mdi:terminal",
+    iconColor: "#2b5797",
+  },
 })
 
 export const argsSchema = z.object({
@@ -189,7 +219,6 @@ export const keyPair = defineUnit({
 
   outputs: {
     keyPair: keyPairEntity,
-    publicKeyFile: fileEntity,
   },
 
   meta: {
@@ -209,6 +238,9 @@ export const keyPair = defineUnit({
 
 export type Args = z.infer<typeof argsSchema>
 export type KeyType = z.infer<typeof keyTypeSchema>
-export type PublicKey = z.infer<typeof publicKeyEntity.schema>
-export type KeyPair = z.infer<typeof keyPairEntity.schema>
-export type Connection = z.infer<typeof connectionSchema>
+export type PublicKey = EntityValue<typeof publicKeyEntity>
+export type KeyPair = EntityValue<typeof keyPairEntity>
+export type Connection = EntityValue<typeof connectionEntity>
+
+export type PublicKeyInput = EntityInput<typeof publicKeyEntity>
+export type KeyPairInput = EntityInput<typeof keyPairEntity>