@homeflare/alchemy 0.31.2 → 0.32.0

package/src/proxmox/storage.ts

@@ -12,19 +12,48 @@
  * ⛔ ONE PRIVILEGE COVERS THIS WHOLE FAMILY AND IT IS `Datastore.Allocate` ON `/storage`. Create,
  *   update, delete AND the single-object read all check it — `Datastore.Audit` is not enough for
  *   any of them. MEASURED: `GET /storage/local` under the auditor-scoped `read` lease answers 403
- *   "Permission check failed (/storage/local, Datastore.Allocate)". `pveOperations.read` folds
- *   every failure into `undefined`, i.e. "absent", because a 404 is a legitimate answer there and
- *   it cannot tell the two apart — so under that lease this resource NEVER CONVERGES, in two
- *   directions: reconcile reads "absent" and POSTs a create over a storage that is already defined,
- *   and where a create does land the read-back is 403 too, so reconcile dies with "the write
- *   returned no error but the object is still absent" about an object it has just built. Both
- *   messages point away from the cause.
- *   ★ SO WIDEN OR RE-POINT BEFORE THE FIRST PLAN, outside this file: give the credential mount's
- *     `read` role `Datastore.Allocate` on `/storage`, or read this family with `provision`. The
- *     provision role in the estate this was written for held only `Datastore.AllocateSpace` and
- *     `Datastore.Audit`, and NEITHER IS IT — AllocateSpace writes volumes INTO a storage, Allocate
- *     DEFINES one — so it 403'd here until widened the way `Pool.Allocate` was for `Proxmox.Pool`.
- *     The provisioning baseline (`provision-baseline.ts`) carries `Datastore.Allocate`.
+ *   "Permission check failed (/storage/local, Datastore.Allocate)". So this family reads with
+ *   `provision`, same as acl.ts and unlike group.ts/user.ts — `provision-baseline.ts` carries
+ *   `Datastore.Allocate`.
+ *
+ * ⛔ ON A LANE WHOSE CREDENTIAL CANNOT MINT `provision` (the agent's `read`-role lane), THIS
+ *   FAMILY SHIPPED WITH THE ORIGINAL CRIES-WOLF BUG — measured live, 2026-09-24: `bun run plan`
+ *   showed all 5 storages (`cephfs-tb4`, `cephtb4`, `local`, `local-zfs`, `pbs`) as `update`, with
+ *   no warning, because `client.ts`'s `pveOperations.read` folded the REFUSED mint into `undefined`
+ *   the same way it folds a genuine absence — `unreadable-read.ts`'s own header names this family
+ *   by name as one of the two the fix was written for. Migrated here the way acl.ts/group.ts/
+ *   user.ts were (kit 0.31.1/0.31.2): a refused `provision` mint now reports `noop` with a logged
+ *   warning instead of forcing `update` with nothing compared.
+ *
+ * ⛔ A MISSING STORAGE IS A 500, NOT A 404 — MEASURED against the live cluster (TB4, 2026-09-24,
+ *   admin lane, read-only `GET /storage/hf-measure-nonexistent-probe`): `{"message":"storage
+ *   '...' does not exist\n"}` at HTTP 500. `storage-wire.ts`'s `readStorageOrFail`/`readStorage`
+ *   carry the same dual-path split as user.ts/group.ts for exactly this reason — see that file.
+ *
+ * ⛔ `maxfiles` IS GONE — A MEASURED `@distilled.cloud/proxmox` SDK GAP, NOT A SCOPE TRIM. The
+ *   vendor's generated `CreateStorageRequest`/`PutStorageRequest` (storage-wire.ts's `mutable`)
+ *   have no `maxfiles` field at all — grepped across the whole package, not just this endpoint —
+ *   where `prune-backups`, its documented replacement, is present and correctly wired
+ *   (`T.Body("prune-backups")` on the generated `prune_backups` property). Silently dropping a
+ *   declared `maxfiles` value would have been the same class of bug this whole migration exists to
+ *   close: a write that looks like it landed and did not. So `maxfiles?: never` below, the same
+ *   COMPILE-ERROR treatment `StorageLocator`'s `password`/`keyring`/`encryption-key` already get —
+ *   a declaration that sets it is refused before a plan ever runs, not silently ignored by one.
+ *   None of this cluster's 5 live storages set it (measured, live response bodies below). If a
+ *   consumer genuinely needs it, the fix belongs in `@distilled.cloud/proxmox`'s generator, not a
+ *   hand-rolled bypass here — see the provider-walk-down doctrine on vendor gaps.
+ *
+ * ⛔ EVERY HYPHENATED PVE FIELD NAME BECOMES AN UNDERSCORE IN DISTILLED'S GENERATED TYPESCRIPT —
+ *   MEASURED across the WHOLE generated `CreateStorageRequest`/`PutStorageRequest`, not one field:
+ *   `prune-backups` -> `prune_backups`, `fs-name` -> `fs_name`, `max-protected-backups` ->
+ *   `max_protected_backups`, and so on for every plugin field `StorageLocator`'s free-form bag can
+ *   carry (`cephfs-tb4`'s own live locator uses `fs-name`, measured below). No other family
+ *   migrated so far has a hyphenated field at all, so this is new here. `storage-wire.ts`'s
+ *   `underscored` translates a form BUILT with PVE's own names into distilled's shape, but ONLY
+ *   for the actual SDK call (`toDistilledCreate`/`toDistilledUpdate`) — never for the form
+ *   `guardWrite` checks (`createForm`/`updateForm`), which the generated vendor-constraint tables
+ *   key by PVE's own hyphenated names. Running the translation before that check would make it
+ *   silently stop inspecting the very fields it exists to catch.
  *
  * ⛔ THERE IS NO `password` PROP AND THERE MUST NEVER BE ONE. PBS and CIFS storages take one at
  *   create time, and Alchemy persists attributes UNENCRYPTED — a secret in props is one careless
@@ -33,28 +62,36 @@
  *   a COMPILE ERROR rather than a leak somebody finds in a backup months later. Set it once out of
  *   band (`pvesm set <id> --password`); PVE never returns it on read, so nothing here could diff it
  *   anyway.
+ *
+ * ★ MIGRATED OFF `client.ts`'s generic `pve()`/`pveHandlers` (`resource.ts`) ONTO
+ *   `@distilled.cloud/proxmox`'s typed `storage.getStorage`/`createStorage`/`putStorage`/
+ *   `deleteStorage` (2026-09-24, decision 43's proxmox walk-down, nodes/storage sub-area, first
+ *   resource). `distilled-pve.ts`'s `runPve` replaces `pve()`; the cries-wolf fix is wired the
+ *   same way as acl.ts/group.ts/user.ts.
  */
 import { Resource } from 'alchemy';
+import { isResolved } from 'alchemy/Diff';
 import * as Provider from 'alchemy/Provider';
+import * as storage from '@distilled.cloud/proxmox/storage';
 import * as Effect from 'effect/Effect';
-import { type PveRequirements, type WithTarget, pveHandlers } from './resource.ts';
-import { bool, flag } from './values.ts';
+import { guardWrite } from './distilled-guard.ts';
+import type { PveRequirements, WithTarget } from './resource-spec.ts';
+import { runPve } from './distilled-pve.ts';
+import {
+  STORAGE_CREATE,
+  STORAGE_UPDATE,
+  createForm,
+  toDistilledCreate,
+  toDistilledUpdate,
+  updateForm,
+} from './storage-form.ts';
+import { dropUnreadable, matches, readStorage, readStorageOrFail } from './storage-wire.ts';
+import { UNREADABLE, unreadableWarning } from './unreadable-read.ts';
+import type { StorageAttributes } from './storage-wire.ts';
+import type { StorageLocator } from './storage-form.ts';
 
-/**
- * The create-time, plugin-specific half of a storage: `dir` wants `path`, `nfs` `server`+`export`,
- * `cifs` `server`+`share`, `pbs` `server`+`datastore`, `rbd` `pool`+`monhost`, `lvmthin`
- * `vgname`+`thinpool`, `zfspool` `pool`. A bag rather than two dozen named fields, because PVE
- * ships about that many plugins and each brings its own locator. ⚠️ Never diffed — see `matches`.
- *
- * ⛔ `password`, `keyring` AND `encryption-key` ARE `never` ON PURPOSE — see the ⛔ in the header.
- *   POSITIVE-CONTROLLED rather than assumed: all three are a compile error, `TS2322: Type 'string'
- *   is not assignable to type 'undefined'`.
- */
-export type StorageLocator = Record<string, string> & {
-  password?: never;
-  keyring?: never;
-  'encryption-key'?: never;
-};
+/** Re-exported so a caller of this file still finds them here, unchanged by the split below. */
+export type { StorageAttributes, StorageLocator };
 
 export interface StorageProps extends WithTarget {
   /** PVE's primary key, cluster-wide — the string an LXC's `storage` and `ostemplate` name. */
@@ -85,26 +122,8 @@ export interface StorageProps extends WithTarget {
    */
   'prune-backups'?: string;
   comment?: string;
-  /**
-   * ⚠️ THE DEPRECATED PREDECESSOR OF `prune-backups`, and the two do not mix — declare one or the
-   *   other. `0` means UNLIMITED to PVE rather than "unset", hence the `-1` in the attribute.
-   */
-  maxfiles?: number;
-}
-
-export interface StorageAttributes {
-  storage: string;
-  /** Reported so a plan can show what it points at; never diffed — see `type` above. */
-  type: string;
-  content: string;
-  nodes: string;
-  disable: boolean;
-  shared: boolean;
-  preallocation: string;
-  'prune-backups': string;
-  comment: string;
-  /** ⚠️ `-1` means "no maxfiles in storage.cfg". `0` is a real setting meaning unlimited. */
-  maxfiles: number;
+  /** ⛔ REMOVED — a measured `@distilled.cloud/proxmox` gap, not a scope trim. See the header. */
+  maxfiles?: never;
 }
 
 export interface ProxmoxStorage extends Resource<
@@ -120,129 +139,100 @@ export const ProxmoxStorage = Resource<ProxmoxStorage>('Proxmox.Storage', {
   defaultRemovalPolicy: 'retain',
 });
 
-const str = (value: unknown, fallback = '') => (typeof value === 'string' ? value : fallback);
-
-const field = (name: string, value: string | undefined): Record<string, string> =>
-  value === undefined ? {} : { [name]: value };
-
-/**
- * ⚠️ THE CAST DROPS THE THREE `never` GUARDS AND NOTHING ELSE, and it is load-bearing rather than
- *   lazy: an intersection carrying OPTIONAL properties is not assignable to `Record<string,string>`
- *   at all, so the guards and the form body cannot both exist without one conversion. At runtime a
- *   locator is a plain string map; the guards only ever existed to fail a declaration.
- */
-const locatorForm = (locator: StorageLocator | undefined) =>
-  ({ ...locator }) as Record<string, string>;
-
-/**
- * ⚠️ PVE RE-SERIALISES ITS LIST FIELDS IN ITS OWN ORDER — `content` and `nodes` are parsed into a
- *   set and written back sorted, `prune-backups` is a property string that comes back in schema
- *   order. Comparing raw strings would report an update for `iso,backup` against `backup,iso` on
- *   every plan, and the PUT would "fix" it into the identical string. Trimming matters too: a
- *   declared `iso, backup` would otherwise never equal what PVE stores.
- */
-const tokens = (value: string) =>
-  value
-    .split(',')
-    .map((part) => part.trim())
-    .filter((part) => part !== '')
-    .sort()
-    .join(',');
-
-const sameList = (declared: string | undefined, live: string) =>
-  declared === undefined || tokens(declared) === tokens(live);
-
-const same = <T>(declared: T | undefined, live: T) => declared === undefined || declared === live;
-
-/**
- * The mutable half, for create and update alike.
- *
- * ⚠️ AN UNDECLARED FIELD IS NEITHER SENT NOR COMPARED: undeclared means UNMANAGED here, unlike
- *   `Proxmox.Pool` where an absent comment means `''`. A storage has no single default to fall back
- *   on — `content` defaults per plugin, and clearing a field needs an explicit `delete=` parameter
- *   rather than an empty value — so a guessed default would rewrite a storage somebody tuned by
- *   hand, and comparing one would report drift nobody declared.
- *
- * ⚠️ RECONCILE PUTs UNCONDITIONALLY whenever the object exists (resource.ts), so this form must be
- *   safe to re-apply to a storage that already matches. It is: the declared set and nothing else,
- *   and PVE leaves absent parameters alone.
- */
-const mutable = (props: StorageProps): Record<string, string> => ({
-  ...field('comment', props.comment),
-  ...field('content', props.content),
-  ...field('disable', flag(props.disable)),
-  ...field('maxfiles', props.maxfiles === undefined ? undefined : String(props.maxfiles)),
-  ...field('nodes', props.nodes),
-  ...field('preallocation', props.preallocation),
-  ...field('prune-backups', props['prune-backups']),
-  ...field('shared', flag(props.shared)),
-});
-
-const handlers = pveHandlers<StorageProps, StorageAttributes>({
-  // ⛔ PVE gates this family's ITEM read on the allocate privilege, not the audit one — see
-  //   `readRole` in resource.ts. The auditor-shaped lease reads 403, which `read` turns into
-  //   "absent", and the plan then says create for an object that is plainly there.
-  readRole: 'provision',
-  /**
-   * ⚠️ `digest` IS DELIBERATELY NOT AN ATTRIBUTE. PVE returns one on every storage read and it
-   *   covers storage.cfg as a FILE, not this section of it, so keeping it would rewrite this
-   *   resource's state whenever an unrelated storage was edited — churn that reads like drift.
-   */
-  attributes: (live, props) => ({
-    comment: str(live['comment']),
-    content: str(live['content']),
-    disable: bool(live['disable']),
-    maxfiles: typeof live['maxfiles'] === 'number' ? live['maxfiles'] : -1,
-    nodes: str(live['nodes']),
-    preallocation: str(live['preallocation']),
-    'prune-backups': str(live['prune-backups']),
-    shared: bool(live['shared']),
-    storage: props.storage,
-    type: str(live['type'], props.type),
-  }),
-  collection: () => 'storage',
-  /**
-   * ⚠️ THE BAG IS SPREAD FIRST SO NOTHING IN IT CAN SHADOW A FIELD THIS RESOURCE MANAGES. A stray
-   *   `storage` or `type` in a locator would otherwise rename the object being created, and PVE
-   *   would build the wrong thing under a name Alchemy then records as the declared one.
-   */
-  createForm: (props) => ({
-    ...locatorForm(props.locator),
-    ...mutable(props),
-    storage: props.storage,
-    type: props.type,
-  }),
-  /**
-   * ⚠️ `type` AND THE LOCATOR ARE NEVER COMPARED, AND AN UNDECLARED FIELD IS NOT COMPARED EITHER.
-   *   PVE returns the create-only fields on read but refuses them on PUT, so diffing one could only
-   *   plan an update that no write can apply: a plan that reports work on every run, forever.
-   */
-  /** The vendor rules these forms are checked against at plan time — resource-spec.ts. */
-  endpoint: { create: 'pve:POST /storage', update: 'pve:PUT /storage/{storage}' },
-  matches: (attributes, props) =>
-    sameList(props.content, attributes.content) &&
-    sameList(props.nodes, attributes.nodes) &&
-    sameList(props['prune-backups'], attributes['prune-backups']) &&
-    same(props.disable, attributes.disable) &&
-    same(props.shared, attributes.shared) &&
-    same(props.preallocation, attributes.preallocation) &&
-    same(props.comment, attributes.comment) &&
-    same(props.maxfiles, attributes.maxfiles),
-  path: (props) => `storage/${props.storage}`,
-  updateForm: mutable,
-});
-
-/**
-* ⛔ EMPTY, AND HERE IT MATTERS MORE THAN ANYWHERE ELSE IN THIS PACKAGE. `GET /storage`
-*   returns every definition on the cluster, `local` and `local-lvm`/`local-zfs` included:
-*   the installer's own, that every guest's rootfs sits on. Adopting those would put
-*   Alchemy one `delete` away from the cluster's disks. Adoption is explicit, always.
- 
- *
-* ⚠️ THIS REMOVES THE DEFINITION, NOT THE DATA. PVE drops the section from storage.cfg and
-*   leaves the volumes on disk untouched — so the loss is not the bytes, it is that guests
-*   whose config still names this storage can no longer resolve their own disks.
- 
- */
 export const ProxmoxStorageProvider = () =>
-  Provider.effect(ProxmoxStorage, Effect.succeed(ProxmoxStorage.Provider.of(handlers)));
+  Provider.effect(
+    ProxmoxStorage,
+    Effect.succeed(
+      ProxmoxStorage.Provider.of({
+        /**
+         * ⛔ EMPTY, AND HERE IT MATTERS MORE THAN ANYWHERE ELSE IN THIS PACKAGE. `GET /storage`
+         *   returns every definition on the cluster, `local` and `local-lvm`/`local-zfs` included:
+         *   the installer's own, that every guest's rootfs sits on. Adopting those would put
+         *   Alchemy one `delete` away from the cluster's disks. Adoption is explicit, always.
+         */
+        list: () => Effect.succeed([]),
+        // ⚠️ FOLDS ONLY WHEN `output` IS `undefined` — user.ts's/group.ts's own ⚠️, applied here
+        //   from the start rather than found by a later review: the engine calls this hook from
+        //   Plan.ts's adoption probe and interrupted-create recovery and Apply.ts's delete
+        //   recovery (all `output: undefined`, nothing confirmed exists yet — `readStorage`'s fold
+        //   is still needed) as well as Drift.ts (`output: old.attr`, an ALREADY-CONFIRMED row,
+        //   `diff`'s own situation — `readStorageOrFail` there instead, or a transient failure
+        //   reports a silent `{action: 'missing'}` with no error at all).
+        read: Effect.fn(function* ({ olds, output }) {
+          return dropUnreadable(
+            yield* output === undefined ? readStorage(olds) : readStorageOrFail(olds),
+          );
+        }),
+        diff: Effect.fn(function* ({ news, output }) {
+          if (!isResolved(news)) return undefined;
+          yield* guardWrite(STORAGE_CREATE, createForm(news), output === undefined);
+          yield* guardWrite(STORAGE_UPDATE, updateForm(news), false);
+          if (output === undefined) return undefined;
+          // ⚠️ `readStorageOrFail`, NOT `readStorage` — see that function's own ⛔ in
+          //   storage-wire.ts. A genuine TRANSIENT failure here propagates and fails the whole
+          //   plan loudly instead of folding to "absent" and forcing a false update.
+          const live = yield* readStorageOrFail(news);
+          // ⛔ THE CRIES-WOLF FIX: a refused read used to fall into `undefined` below and force
+          //   `update` on a storage that was plainly there — see unreadable-read.ts.
+          if (live === UNREADABLE) {
+            yield* unreadableWarning('Proxmox.Storage', news.storage);
+            return { action: 'noop' } as const;
+          }
+          if (live === undefined) {
+            yield* guardWrite(STORAGE_CREATE, createForm(news), true);
+            return { action: 'update' } as const;
+          }
+          return matches(live, news)
+            ? ({ action: 'noop' } as const)
+            : ({ action: 'update' } as const);
+        }),
+        reconcile: Effect.fn(function* ({ news }) {
+          // ⚠️ `dropUnreadable`: reconcile only runs once `provision` already minted for the
+          //   write below, so `UNREADABLE` here is a narrow race, not the routine case `diff`
+          //   handles — group.ts's/user.ts's reconcile have the same note.
+          const before = dropUnreadable(yield* readStorage(news));
+          yield* guardWrite(STORAGE_CREATE, createForm(news), before === undefined);
+          yield* guardWrite(STORAGE_UPDATE, updateForm(news), false);
+          if (before === undefined) {
+            yield* runPve(
+              news.target,
+              'provision',
+              true,
+              storage.createStorage(toDistilledCreate(news)),
+            );
+          } else if (!matches(before, news)) {
+            yield* runPve(
+              news.target,
+              'provision',
+              true,
+              storage.putStorage(toDistilledUpdate(news)),
+            );
+          }
+          const after = dropUnreadable(yield* readStorage(news));
+          if (after === undefined) {
+            return yield* Effect.die(
+              new Error(
+                `storage/${news.storage}: the write returned no error but the storage is still ` +
+                  'absent. PVE wraps every answer in {"data":...} and can report success on a ' +
+                  'call that did nothing -- read back rather than trusting the status code.',
+              ),
+            );
+          }
+          return after;
+        }),
+        /**
+         * ⚠️ THIS REMOVES THE DEFINITION, NOT THE DATA. PVE drops the section from storage.cfg and
+         *   leaves the volumes on disk untouched — so the loss is not the bytes, it is that guests
+         *   whose config still names this storage can no longer resolve their own disks.
+         */
+        delete: Effect.fn(function* ({ olds }) {
+          yield* runPve(
+            olds.target,
+            'provision',
+            true,
+            storage.deleteStorage({ storage: olds.storage }),
+          );
+        }),
+      }),
+    ),
+  );

package/src/unifi/fake-unifi.ts

@@ -0,0 +1,60 @@
+/**
+ * A minimal in-memory UniFi Network API for this family's tests — an in-memory `fetch` handed to
+ * Effect's real `FetchHttpClient` through its `Fetch` reference, mirroring `../netbox/fake-netbox.ts`
+ * (itself mirroring `../forgejo/fake-forgejo.ts`). Tests exercise distilled's REAL path assembly,
+ * JSON encode/decode and status→typed-error matching — nothing about that matching is
+ * re-implemented here, only the wire responses a scenario needs.
+ *
+ * ⛔ TEST-ONLY, AND NO NETWORK. No provider imports this file. The base URL is RFC 2606
+ *   `unifi.example.com` and the key is a placeholder — never a real console address: a cloud
+ *   connector's base URL embeds the account's Console ID, which must never appear in this repo
+ *   (`docs/unifi.md`).
+ */
+import { type Credentials, credentials } from '@distilled.cloud/unifi-network/Credentials';
+import * as Layer from 'effect/Layer';
+import * as FetchHttpClient from 'effect/unstable/http/FetchHttpClient';
+
+export const FAKE_BASE = 'https://unifi.example.com/proxy/network/integration';
+export const FAKE_KEY = 'placeholder-unifi-key';
+
+export type Seen = { readonly method: string; readonly path: string };
+
+/** No documented failure envelope (see `protocol.ts`) — plain text is all a failure needs. */
+export const fakeFailure = (status: number, detail: string) => new Response(detail, { status });
+
+/**
+ * `route` decides every response; this wrapper only records what was sent and adapts to
+ * `globalThis.fetch`'s signature.
+ *
+ * ★ THE WRITE-REFUSAL PROOF USES `seen` DIRECTLY, NOT A THROWING ROUTE. `resource.test.ts`'s
+ *   "no SDK write operation is reachable" test asserts `seen.every(s => s.method === 'GET')`
+ *   after driving every handler — a request this family's engine was never supposed to send
+ *   shows up in `seen` as a fact, rather than depending on an exception surviving Effect's own
+ *   error handling on its way back out of a fake `fetch`.
+ */
+export const fakeUnifi = (route: (method: string, url: URL) => Response) => {
+  const seen: Seen[] = [];
+  const fetch = (async (input: string | URL | Request, init?: RequestInit) => {
+    const request =
+      input instanceof Request ? new Request(input, init) : new Request(String(input), init);
+    const url = new URL(request.url);
+    seen.push({ method: request.method, path: `${url.pathname}${url.search}` });
+    return route(request.method, url);
+  }) as typeof globalThis.fetch;
+  return { fetch, seen };
+};
+
+/**
+ * distilled Credentials + the real FetchHttpClient over the fake — `UnifiNetworkOpContext`, what
+ * every resource file's exported `spec.fetchLive` needs.
+ *
+ * ⚠️ NOT PAIRED WITH `handlers`. `handlers` (each resource file's `unifiHandlers(spec)` export)
+ *   bakes in `CredentialsFromEnv`, which resolves `UNIFI_NETWORK_API_KEY`/`_API_BASE_URL` through
+ *   Effect's `Config` — whose default provider snapshots `process.env` once and never re-reads it
+ *   (the same seam `netbox/fake-netbox.ts` documents). Tests call `spec.fetchLive`/`spec.attributes`
+ *   directly instead, with this explicit layer.
+ */
+export const fakeUnifiLayer = (
+  fetchFn: typeof globalThis.fetch,
+  creds: Layer.Layer<Credentials> = credentials({ apiBaseUrl: FAKE_BASE, apiKey: FAKE_KEY }),
+) => Layer.mergeAll(creds, FetchHttpClient.layer, Layer.succeed(FetchHttpClient.Fetch, fetchFn));

package/src/unifi/firewall-zone-form.ts

@@ -0,0 +1,65 @@
+/**
+ * `Unifi.FirewallZone`'s wire shape — the declarable subset of `FirewallZone`, and how a live
+ * read becomes both plan attributes and a rendered declaration.
+ *
+ * ⚠️ ONLY `name` AND `networkIds` ARE DECLARABLE. `CreateFirewallZoneRequest`
+ *   (`firewall.ts`) accepts exactly those two beyond `siteId`; `metadata` (origin/source) and
+ *   `id` are server-derived, so — same split as `network-form.ts`'s `default`/`metadata` —
+ *   they are attributes-only, reported but never compared or declared.
+ *
+ * ⛔ `networkIds` ORDER IS NOT PART OF IDENTITY. The vendor document gives no indication the
+ *   list is ordered (it is a set of attached networks, not a sequence like the ordering
+ *   endpoints' rule lists), so `matches` compares it as a set — sorted before comparing —
+ *   the same reasoning `proxmox/user-wire.ts`'s `groupSet` gives for PVE's `groups`.
+ */
+import type * as firewall from '@distilled.cloud/unifi-network/firewall';
+
+export interface FirewallZoneProps {
+  siteId: string;
+  firewallZoneId: string;
+  /** Name of a firewall zone. */
+  name: string;
+  /** Network IDs attached to this zone — compared as a set, see the header. */
+  networkIds: string[];
+}
+
+export interface FirewallZoneAttributes {
+  siteId: string;
+  firewallZoneId: string;
+  name: string;
+  networkIds: string[];
+  /** `origin`/`source` (e.g. `SDWAN`) — server-derived, never declared. */
+  metadataOrigin: string;
+}
+
+const sortedSet = (values: readonly string[]): string[] => [...new Set(values)].sort();
+
+export const attributesOf = (
+  live: firewall.FirewallZone,
+  props: FirewallZoneProps,
+): FirewallZoneAttributes => ({
+  siteId: props.siteId,
+  firewallZoneId: live.id,
+  name: live.name,
+  networkIds: sortedSet(live.networkIds),
+  metadataOrigin: live.metadata.origin,
+});
+
+export const matches = (attributes: FirewallZoneAttributes, props: FirewallZoneProps): boolean =>
+  attributes.name === props.name &&
+  attributes.networkIds.join(',') === sortedSet(props.networkIds).join(',');
+
+/**
+ * The declaration renderer (task spec: "given one live object, return the props a declaration
+ * needs so its plan is noop"). `matches(attributesOf(live, props), declareFirewallZone(live,
+ * siteId))` is `true` by construction (`firewall-zone.test.ts` proves it).
+ */
+export const declareFirewallZone = (
+  live: firewall.FirewallZone,
+  siteId: string,
+): FirewallZoneProps => ({
+  siteId,
+  firewallZoneId: live.id,
+  name: live.name,
+  networkIds: sortedSet(live.networkIds),
+});

package/src/unifi/firewall-zone.test.ts

@@ -0,0 +1,88 @@
+/**
+ * `Unifi.FirewallZone`'s `spec` against a fake UniFi Network API — mirrors `network.test.ts`.
+ */
+import { describe, expect, test } from 'bun:test';
+import type * as firewall from '@distilled.cloud/unifi-network/firewall';
+import * as Effect from 'effect/Effect';
+import { fakeFailure, fakeUnifi, fakeUnifiLayer } from './fake-unifi.ts';
+import { attributesOf, matches } from './firewall-zone-form.ts';
+import { type FirewallZoneProps, declareFirewallZone, spec } from './firewall-zone.ts';
+import { unifiOperations } from './resource.ts';
+
+const ZONE_PATH = '/proxy/network/integration/v1/sites/site-1/firewall/zones/zone-1';
+
+const liveZone = (overrides: Partial<firewall.FirewallZone> = {}): firewall.FirewallZone => ({
+  id: 'zone-1',
+  metadata: { origin: 'USER' },
+  name: 'Cameras',
+  networkIds: ['net-2', 'net-1'],
+  ...overrides,
+});
+
+const PROPS: FirewallZoneProps = {
+  siteId: 'site-1',
+  firewallZoneId: 'zone-1',
+  name: 'Cameras',
+  networkIds: ['net-1', 'net-2'],
+};
+
+describe('Unifi.FirewallZone spec.fetchLive', () => {
+  test('a real GET response decodes, and networkIds order does not affect matches', async () => {
+    const fake = fakeUnifi((method, url) =>
+      method === 'GET' && url.pathname === ZONE_PATH
+        ? Response.json(liveZone())
+        : fakeFailure(400, 'unexpected request'),
+    );
+    const live = await Effect.runPromise(
+      spec.fetchLive(PROPS).pipe(Effect.provide(fakeUnifiLayer(fake.fetch))),
+    );
+    expect(live?.id).toBe('zone-1');
+    const attrs = attributesOf(live as firewall.FirewallZone, PROPS);
+    expect(matches(attrs, PROPS)).toBe(true);
+  });
+
+  test('a genuine 404 folds to undefined', async () => {
+    const fake = fakeUnifi(() => fakeFailure(404, 'not found'));
+    const live = await Effect.runPromise(
+      spec.fetchLive(PROPS).pipe(Effect.provide(fakeUnifiLayer(fake.fetch))),
+    );
+    expect(live).toBeUndefined();
+  });
+});
+
+describe('declareFirewallZone -- the declaration renderer', () => {
+  test('its output matches attributesOf(live) by construction, for any live object', () => {
+    const live = liveZone({ networkIds: ['net-9', 'net-3', 'net-3'] });
+    const declared = declareFirewallZone(live, 'site-1');
+    const attrs = attributesOf(live, declared);
+    expect(matches(attrs, declared)).toBe(true);
+  });
+});
+
+describe('Unifi.FirewallZone write paths never reach the vendor API', () => {
+  test('reconcile on an exact-match adoption (H6) sends only the one read', async () => {
+    const fake = fakeUnifi((method, url) =>
+      method === 'GET' && url.pathname === ZONE_PATH
+        ? Response.json(liveZone())
+        : fakeFailure(400, 'unexpected request'),
+    );
+    const exit = await Effect.runPromiseExit(
+      unifiOperations(spec)
+        .reconcile(PROPS)
+        .pipe(Effect.provide(fakeUnifiLayer(fake.fetch))),
+    );
+    expect(exit._tag).toBe('Success');
+    expect(fake.seen.every((s) => s.method === 'GET')).toBe(true);
+  });
+
+  test('delete always refuses -- no DELETE is ever sent', async () => {
+    const fake = fakeUnifi(() => fakeFailure(400, 'unexpected request'));
+    const exit = await Effect.runPromiseExit(
+      unifiOperations(spec)
+        .destroy(PROPS)
+        .pipe(Effect.provide(fakeUnifiLayer(fake.fetch))),
+    );
+    expect(exit._tag).toBe('Failure');
+    expect(fake.seen).toEqual([]);
+  });
+});

package/src/unifi/firewall-zone.ts

@@ -0,0 +1,66 @@
+/**
+ * `Unifi.FirewallZone` — one firewall zone on a UniFi Network site, READ-ONLY (`policy.ts`).
+ *
+ * ★ WHY FIREWALL ZONE IS IN THE FIRST IMPORT SET AND `Unifi.FirewallPolicy` IS NOT.
+ *   `getFirewallZone`/`getFirewallZones` (`firewall.ts`) is a list+get pair over genuine,
+ *   simply-shaped configuration: `{id, metadata, name, networkIds}`, four fields, no nested
+ *   discriminated filter. `FirewallPolicy` (same file) is also list+get and also configuration,
+ *   but its `source`/`destination`/`ipProtocolScope` fields carry several of `docs/unifi-api-notes.md`'s
+ *   "converter-flattened discriminator variants" each, and `firewall/policies/ordering` replaces
+ *   the whole ordered list — modelling those correctly is a bigger, separate PR (`network.ts`'s
+ *   header note names it explicitly) rather than something to rush alongside this one.
+ */
+import { Resource } from 'alchemy';
+import { adopt } from 'alchemy/AdoptPolicy';
+import * as Provider from 'alchemy/Provider';
+import * as firewall from '@distilled.cloud/unifi-network/firewall';
+import * as Effect from 'effect/Effect';
+import {
+  type FirewallZoneAttributes,
+  type FirewallZoneProps,
+  attributesOf,
+  matches,
+} from './firewall-zone-form.ts';
+import type { UnifiRequirements, UnifiSpec } from './resource.ts';
+import { unifiHandlers } from './resource.ts';
+
+export type { FirewallZoneAttributes, FirewallZoneProps } from './firewall-zone-form.ts';
+export { declareFirewallZone } from './firewall-zone-form.ts';
+
+export interface UnifiFirewallZone extends Resource<
+  'Unifi.FirewallZone',
+  FirewallZoneProps,
+  FirewallZoneAttributes,
+  never,
+  UnifiRequirements
+> {}
+
+export const UnifiFirewallZone = Resource<UnifiFirewallZone>('Unifi.FirewallZone', {
+  defaultRemovalPolicy: 'retain',
+});
+
+/** `firewallZone('lan', props)` — `adopt(true)` piped on by default (H5); see `network.ts`. */
+export const firewallZone = (id: string, props: FirewallZoneProps) =>
+  UnifiFirewallZone(id, props).pipe(adopt(true));
+
+/** ★ EXPORTED for direct testing against a fake `Credentials` layer — see `network.ts`'s own. */
+export const spec: UnifiSpec<
+  FirewallZoneProps,
+  firewall.FirewallZone,
+  FirewallZoneAttributes,
+  firewall.GetFirewallZoneError
+> = {
+  type: 'Unifi.FirewallZone',
+  describe: (props) => `sites/${props.siteId}/firewall/zones/${props.firewallZoneId}`,
+  fetchLive: (props) =>
+    firewall
+      .getFirewallZone({ siteId: props.siteId, firewallZoneId: props.firewallZoneId })
+      .pipe(Effect.catchTag('NotFound', () => Effect.succeed(undefined))),
+  attributes: attributesOf,
+  matches,
+};
+
+export const handlers = unifiHandlers(spec);
+
+export const UnifiFirewallZoneProvider = () =>
+  Provider.effect(UnifiFirewallZone, Effect.succeed(UnifiFirewallZone.Provider.of(handlers)));