@nilovonjs/hcloud-js 1.0.0

package/src/apis/firewalls/schemas.ts

@@ -0,0 +1,274 @@
+/**
+ * Zod schemas for Hetzner Cloud Firewalls API
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls
+ */
+
+import { z } from "zod";
+import { actionSchema, actionResourceSchema } from "../../apis/actions/schemas";
+import { paginationMetaSchema } from "../../apis/common/schemas";
+
+/**
+ * Firewall rule direction schema
+ */
+export const firewallRuleDirectionSchema = z.enum(["in", "out"]);
+
+/**
+ * Firewall rule protocol schema
+ */
+export const firewallRuleProtocolSchema = z.enum(["tcp", "udp", "icmp", "esp", "gre"]);
+
+/**
+ * Firewall rule port schema
+ */
+export const firewallRulePortSchema = z.string().regex(/^\d+(-\d+)?$/);
+
+/**
+ * Firewall rule source IPs schema
+ * Accepts IP addresses and CIDR notation
+ */
+export const firewallRuleSourceIpsSchema = z.array(z.string());
+
+/**
+ * Firewall rule destination IPs schema
+ * Accepts IP addresses and CIDR notation
+ */
+export const firewallRuleDestinationIpsSchema = z.array(z.string());
+
+/**
+ * Firewall rule schema
+ */
+export const firewallRuleSchema = z
+  .object({
+    direction: firewallRuleDirectionSchema,
+    source_ips: firewallRuleSourceIpsSchema.optional(),
+    destination_ips: firewallRuleDestinationIpsSchema.optional(),
+    protocol: firewallRuleProtocolSchema,
+    port: firewallRulePortSchema.nullable().optional(),
+    description: z.string().nullable().optional(),
+  })
+  .passthrough();
+
+/**
+ * Firewall applied to resource schema
+ */
+export const firewallAppliedToResourceSchema = z.object({
+  type: z.enum(["server", "label_selector"]),
+  server: z
+    .object({
+      id: z.number(),
+    })
+    .optional(),
+  label_selector: z
+    .object({
+      selector: z.string(),
+    })
+    .optional(),
+});
+
+/**
+ * Firewall schema
+ */
+export const firewallSchema = z
+  .object({
+    id: z.number(),
+    name: z.string(),
+    labels: z.record(z.string(), z.string()),
+    created: z.string(),
+    rules: z
+      .object({
+        inbound: z.array(firewallRuleSchema).optional(),
+        outbound: z.array(firewallRuleSchema).optional(),
+      })
+      .optional(),
+    applied_to: z.array(firewallAppliedToResourceSchema).optional(),
+  })
+  .passthrough();
+
+/**
+ * List Firewalls response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-firewalls
+ */
+export const listFirewallsResponseSchema = z.object({
+  firewalls: z.array(firewallSchema),
+  meta: z
+    .object({
+      pagination: paginationMetaSchema,
+    })
+    .optional(),
+});
+
+/**
+ * Create Firewall request schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-create-a-firewall
+ */
+export const createFirewallRequestSchema = z.object({
+  name: z.string().min(1),
+  labels: z.record(z.string(), z.string()).optional(),
+  rules: z
+    .object({
+      inbound: z.array(firewallRuleSchema).optional(),
+      outbound: z.array(firewallRuleSchema).optional(),
+    })
+    .optional(),
+  apply_to: z
+    .array(
+      z.object({
+        type: z.enum(["server", "label_selector"]),
+        server: z
+          .object({
+            id: z.number(),
+          })
+          .optional(),
+        label_selector: z
+          .object({
+            selector: z.string(),
+          })
+          .optional(),
+      }),
+    )
+    .optional(),
+});
+
+/**
+ * Create Firewall response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-create-a-firewall
+ */
+export const createFirewallResponseSchema = z.object({
+  firewall: firewallSchema,
+  action: actionSchema.optional(),
+});
+
+/**
+ * Get Firewall response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-get-a-firewall
+ */
+export const getFirewallResponseSchema = z.object({
+  firewall: firewallSchema,
+});
+
+/**
+ * Update Firewall request schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-update-a-firewall
+ */
+export const updateFirewallRequestSchema = z.object({
+  name: z.string().min(1).optional(),
+  labels: z.record(z.string(), z.string()).optional(),
+});
+
+/**
+ * Update Firewall response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-update-a-firewall
+ */
+export const updateFirewallResponseSchema = z.object({
+  firewall: firewallSchema,
+});
+
+/**
+ * Delete Firewall response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-delete-a-firewall
+ */
+export const deleteFirewallResponseSchema = z.object({
+  action: actionSchema.optional(),
+});
+
+/**
+ * List Firewall Actions response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-actions-for-a-firewall
+ */
+export const listFirewallActionsResponseSchema = z.object({
+  actions: z.array(actionSchema),
+  meta: z
+    .object({
+      pagination: paginationMetaSchema,
+    })
+    .optional(),
+});
+
+/**
+ * Get Firewall Action response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-get-an-action-for-a-firewall
+ */
+export const getFirewallActionResponseSchema = z.object({
+  action: actionSchema,
+});
+
+/**
+ * Apply Firewall to Resources request schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-apply-to-resources
+ */
+export const applyFirewallToResourcesRequestSchema = z.object({
+  apply_to: z.array(
+    z.object({
+      type: z.enum(["server", "label_selector"]),
+      server: z
+        .object({
+          id: z.number(),
+        })
+        .optional(),
+      label_selector: z
+        .object({
+          selector: z.string(),
+        })
+        .optional(),
+    }),
+  ),
+});
+
+/**
+ * Apply Firewall to Resources response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-apply-to-resources
+ */
+export const applyFirewallToResourcesResponseSchema = z.object({
+  actions: z.array(actionSchema),
+});
+
+/**
+ * Remove Firewall from Resources request schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-remove-from-resources
+ */
+export const removeFirewallFromResourcesRequestSchema = z.object({
+  remove_from: z.array(
+    z.object({
+      type: z.enum(["server", "label_selector"]),
+      server: z
+        .object({
+          id: z.number(),
+        })
+        .optional(),
+      label_selector: z
+        .object({
+          selector: z.string(),
+        })
+        .optional(),
+    }),
+  ),
+});
+
+/**
+ * Remove Firewall from Resources response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-remove-from-resources
+ */
+export const removeFirewallFromResourcesResponseSchema = z.object({
+  actions: z.array(actionSchema),
+});
+
+/**
+ * Set Firewall Rules request schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-set-rules
+ */
+export const setFirewallRulesRequestSchema = z.object({
+  rules: z
+    .object({
+      inbound: z.array(firewallRuleSchema).optional(),
+      outbound: z.array(firewallRuleSchema).optional(),
+    })
+    .optional(),
+});
+
+/**
+ * Set Firewall Rules response schema
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-set-rules
+ */
+export const setFirewallRulesResponseSchema = z.object({
+  actions: z.array(actionSchema),
+});

package/src/apis/firewalls/types.ts

@@ -0,0 +1,205 @@
+/**
+ * Types for Hetzner Cloud Firewalls API
+ * Types are inferred from Zod schemas
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls
+ */
+
+// biome-ignore assist/source/organizeImports: we need to import the schemas first
+import {
+  listFirewallsResponseSchema,
+  createFirewallRequestSchema,
+  createFirewallResponseSchema,
+  getFirewallResponseSchema,
+  updateFirewallRequestSchema,
+  updateFirewallResponseSchema,
+  deleteFirewallResponseSchema,
+  listFirewallActionsResponseSchema,
+  getFirewallActionResponseSchema,
+  applyFirewallToResourcesRequestSchema,
+  applyFirewallToResourcesResponseSchema,
+  removeFirewallFromResourcesRequestSchema,
+  removeFirewallFromResourcesResponseSchema,
+  setFirewallRulesRequestSchema,
+  setFirewallRulesResponseSchema,
+  firewallSchema,
+  firewallRuleSchema,
+  firewallRuleDirectionSchema,
+  firewallRuleProtocolSchema,
+  firewallAppliedToResourceSchema,
+} from "../../apis/firewalls/schemas";
+import type { z } from "zod";
+
+/**
+ * Firewall rule direction
+ */
+export type FirewallRuleDirection = z.infer<typeof firewallRuleDirectionSchema>;
+
+/**
+ * Firewall rule protocol
+ */
+export type FirewallRuleProtocol = z.infer<typeof firewallRuleProtocolSchema>;
+
+/**
+ * Firewall rule
+ */
+export type FirewallRule = z.infer<typeof firewallRuleSchema>;
+
+/**
+ * Firewall applied to resource
+ */
+export type FirewallAppliedToResource = z.infer<typeof firewallAppliedToResourceSchema>;
+
+/**
+ * Firewall
+ */
+export type Firewall = z.infer<typeof firewallSchema>;
+
+/**
+ * List Firewalls query parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-firewalls
+ */
+export interface ListFirewallsParams {
+  /**
+   * Can be used to filter Firewalls by their name. The response will only contain the Firewall matching the specified name.
+   */
+  name?: string;
+  /**
+   * Can be used multiple times. Choices: id, id:asc, id:desc, name, name:asc, name:desc, created, created:asc, created:desc
+   * @see https://docs.hetzner.cloud/reference/cloud#sorting
+   */
+  sort?: string | string[];
+  /**
+   * Can be used to filter Firewalls by labels. The response will only contain Firewalls matching the label selector.
+   */
+  label_selector?: string;
+  /**
+   * Page number to return. For more information, see [Pagination](https://docs.hetzner.cloud/reference/cloud#pagination).
+   */
+  page?: number;
+  /**
+   * Maximum number of entries returned per page. For more information, see [Pagination](https://docs.hetzner.cloud/reference/cloud#pagination).
+   */
+  per_page?: number;
+}
+
+/**
+ * List Firewalls response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-firewalls
+ */
+export type ListFirewallsResponse = z.infer<typeof listFirewallsResponseSchema>;
+
+/**
+ * Create Firewall parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-create-a-firewall
+ */
+export type CreateFirewallParams = z.infer<typeof createFirewallRequestSchema>;
+
+/**
+ * Create Firewall response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-create-a-firewall
+ */
+export type CreateFirewallResponse = z.infer<typeof createFirewallResponseSchema>;
+
+/**
+ * Get Firewall response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-get-a-firewall
+ */
+export type GetFirewallResponse = z.infer<typeof getFirewallResponseSchema>;
+
+/**
+ * Update Firewall parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-update-a-firewall
+ */
+export type UpdateFirewallParams = z.infer<typeof updateFirewallRequestSchema>;
+
+/**
+ * Update Firewall response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-update-a-firewall
+ */
+export type UpdateFirewallResponse = z.infer<typeof updateFirewallResponseSchema>;
+
+/**
+ * Delete Firewall response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-delete-a-firewall
+ */
+export type DeleteFirewallResponse = z.infer<typeof deleteFirewallResponseSchema>;
+
+/**
+ * List Firewall Actions query parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-actions-for-a-firewall
+ */
+export interface ListFirewallActionsParams {
+  /**
+   * Can be used multiple times. Choices: id, id:asc, id:desc, command, command:asc, command:desc, status, status:asc, status:desc, progress, progress:asc, progress:desc, started, started:asc, started:desc, finished, finished:asc, finished:desc
+   * @see https://docs.hetzner.cloud/reference/cloud#sorting
+   */
+  sort?: string | string[];
+  /**
+   * Can be used to filter Actions by status. The response will only contain Actions matching the status.
+   */
+  status?: string | string[];
+  /**
+   * Page number to return. For more information, see [Pagination](https://docs.hetzner.cloud/reference/cloud#pagination).
+   */
+  page?: number;
+  /**
+   * Maximum number of entries returned per page. For more information, see [Pagination](https://docs.hetzner.cloud/reference/cloud#pagination).
+   */
+  per_page?: number;
+}
+
+/**
+ * List Firewall Actions response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-list-actions-for-a-firewall
+ */
+export type ListFirewallActionsResponse = z.infer<typeof listFirewallActionsResponseSchema>;
+
+/**
+ * Get Firewall Action response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-get-an-action-for-a-firewall
+ */
+export type GetFirewallActionResponse = z.infer<typeof getFirewallActionResponseSchema>;
+
+/**
+ * Apply Firewall to Resources parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-apply-to-resources
+ */
+export type ApplyFirewallToResourcesParams = z.infer<
+  typeof applyFirewallToResourcesRequestSchema
+>;
+
+/**
+ * Apply Firewall to Resources response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-apply-to-resources
+ */
+export type ApplyFirewallToResourcesResponse = z.infer<
+  typeof applyFirewallToResourcesResponseSchema
+>;
+
+/**
+ * Remove Firewall from Resources parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-remove-from-resources
+ */
+export type RemoveFirewallFromResourcesParams = z.infer<
+  typeof removeFirewallFromResourcesRequestSchema
+>;
+
+/**
+ * Remove Firewall from Resources response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-remove-from-resources
+ */
+export type RemoveFirewallFromResourcesResponse = z.infer<
+  typeof removeFirewallFromResourcesResponseSchema
+>;
+
+/**
+ * Set Firewall Rules parameters
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-set-rules
+ */
+export type SetFirewallRulesParams = z.infer<typeof setFirewallRulesRequestSchema>;
+
+/**
+ * Set Firewall Rules response
+ * @see https://docs.hetzner.cloud/reference/cloud#firewalls-set-rules
+ */
+export type SetFirewallRulesResponse = z.infer<typeof setFirewallRulesResponseSchema>;