@highstate/library 0.15.0 → 0.17.0

package/src/ssh.ts

@@ -4,11 +4,8 @@ import { l4EndpointEntity, portSchema } from "./network"
 
 export const keyTypeSchema = z.enum(["ed25519"])
 
-/**
- * The entity representing an SSH key pair.
- */
-export const keyPairEntity = defineEntity({
-  type: "ssh.key-pair.v1",
+export const publicKeyEntity = defineEntity({
+  type: "ssh.public-key.v1",
 
   schema: z.object({
     /**
@@ -19,15 +16,30 @@ export const keyPairEntity = defineEntity({
     type: keyTypeSchema,
 
     /**
-     * The fingerprint of the SSH key.
+     * The public key in OpenSSH format.
      */
-    fingerprint: z.string(),
+    publicKey: z.string(),
 
     /**
-     * The public key in OpenSSH format.
+     * The fingerprint of the SSH key.
      */
-    publicKey: z.string(),
+    fingerprint: z.string(),
+  }),
 
+  meta: {
+    color: "#2b5797",
+  },
+})
+
+/**
+ * The entity representing an SSH key pair.
+ */
+export const keyPairEntity = defineEntity({
+  type: "ssh.key-pair.v1",
+
+  extends: { publicKeyEntity },
+
+  schema: z.object({
     /**
      * The private key in PEM format.
      */
@@ -109,12 +121,55 @@ export const secrets = $secrets({
 
 export const inputs = $inputs({
   /**
-   * The SSH key pair to use for authentication.
+   * The SSH key pair to use for authentication by Highstate.
    */
   sshKeyPair: {
     entity: keyPairEntity,
     required: false,
   },
+
+  /**
+   * The extra SSH public keys to add to the server's `authorized_keys` file.
+   *
+   * Will not (and cannot) be used for authentication by Highstate.
+   */
+  sshPublicKeys: {
+    entity: publicKeyEntity,
+    required: false,
+    multiple: true,
+  },
+})
+
+/**
+ * Provides existing SSH public key.
+ */
+export const publicKey = defineUnit({
+  type: "ssh.public-key.v1",
+
+  args: {
+    /**
+     * The public key in OpenSSH format.
+     */
+    publicKey: z.string().meta({ multiline: true }),
+  },
+
+  outputs: {
+    publicKey: publicKeyEntity,
+  },
+
+  meta: {
+    title: "SSH Public Key",
+    category: "ssh",
+    icon: "charm:key",
+    iconColor: "#ffffff",
+    secondaryIcon: "mdi:lock-open",
+    secondaryIconColor: "#ffffff",
+  },
+
+  source: {
+    package: "@highstate/common",
+    path: "units/ssh/public-key",
+  },
 })
 
 /**
@@ -154,5 +209,6 @@ 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>

package/src/third-party/cloudflare.ts

@@ -47,6 +47,7 @@ export const connection = defineUnit({
   meta: {
     title: "Cloudflare Connection",
     icon: "simple-icons:cloudflare",
+    iconColor: "#F38020",
     category: "Cloudflare",
   },
 

package/src/utils.ts

@@ -1,4 +1,5 @@
-import { z } from "@highstate/contract"
+import { type FullComponentArgumentOptions, genericNameSchema, z } from "@highstate/contract"
+import { mapValues } from "remeda"
 
 type PrefixWith<TString extends string, TPrefix extends string> = TPrefix extends ""
   ? TString
@@ -37,16 +38,7 @@ export function prefixKeysWith<T extends Record<string, unknown>, Prefix extends
   ) as PrefixedKeys<T, Prefix>
 }
 
-export const arrayPatchModeSchema = z.enum(["prepend", "replace"])
-export const booleanPatchSchema = z.enum(["keep", "true", "false"])
-
-/**
- * The mode to use when patching some array:
- *
- * - `prepend`: prepend the values of the new array to the existing array;
- * - `replace`: replace the existing array with the new array.
- */
-export type ArrayPatchMode = z.infer<typeof arrayPatchModeSchema>
+export const booleanPatchSchema = z.enum(["keep", "true", "false"]).default("keep")
 
 /**
  * The boolean patch:
@@ -56,3 +48,41 @@ export type ArrayPatchMode = z.infer<typeof arrayPatchModeSchema>
  * - `false`: set the value to `false`.
  */
 export type BooleanPatch = z.infer<typeof booleanPatchSchema>
+
+export function toPatchArgs<T extends Record<string, FullComponentArgumentOptions>>(
+  args: T,
+): {
+  [K in keyof T]: T[K]["schema"] extends z.ZodBoolean
+    ? Omit<T[K], "schema"> & { schema: typeof booleanPatchSchema }
+    : T[K]
+} {
+  return mapValues(args, arg => {
+    if (
+      arg.schema instanceof z.ZodBoolean ||
+      (arg.schema instanceof z.ZodDefault && arg.schema.unwrap() instanceof z.ZodBoolean) ||
+      (arg.schema instanceof z.ZodOptional && arg.schema.unwrap() instanceof z.ZodBoolean)
+    ) {
+      return { ...arg, schema: booleanPatchSchema }
+    }
+
+    return arg
+    // biome-ignore lint/suspicious/noExplicitAny: already typed
+  }) as any
+}
+
+/**
+ * The schema for a metadata key.
+ *
+ * Follows the same conventions as Highstate generic name, but requires at least two segments separated by a dot.
+ */
+export const metadataKeySchema = z.templateLiteral([
+  genericNameSchema,
+  z.literal("."),
+  genericNameSchema,
+])
+
+export const metadataSchema = z.record(metadataKeySchema, z.unknown())
+
+export type Metadata = z.infer<typeof metadataSchema>
+export type MetadataKey = z.infer<typeof metadataKeySchema>
+export type MetadataContainer = { metadata?: Metadata }