@homeflare/distilled-unifi-network 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,125 @@
+# @homeflare/distilled-unifi-network
+
+This package is **not a HomeFlare SDK**. It is an unmodified copy of
+`@distilled.cloud/unifi-network`, generated by the
+[distilled](https://github.com/alchemy-run/distilled) pipeline from
+Ubiquiti's own **UniFi Network Integration API** OpenAPI 3.1.0 document
+(10.4.57 — an operator export from a console's own web UI; the vendor
+publishes no stable, anonymously-fetchable spec URL), published here under
+its own name only because `@distilled.cloud/unifi-network` does not exist
+on npm yet — the kit builds it in a local clone of `alchemy-run/distilled`
+but, per house policy, never pushes to that upstream. See
+[`../alchemy/docs/distilled-interim.md`](../alchemy/docs/distilled-interim.md)
+for the full route every distilled-sourced vendor package follows, and why
+this one exists at all.
+
+⛔ **Do not hand-edit anything under `src/`.** The whole point of the route
+above is that this directory is _copied_, not written — a fix belongs in
+the distilled clone's `packages/unifi-network/`, regenerated, then copied
+back here.
+
+⚠️ **License.** Apache-2.0, not the kit's usual MIT — this content is a
+redistribution of `alchemy-run/distilled`'s own Apache-2.0-licensed output,
+and relicensing a copy would misstate what it is. See `LICENSE`.
+
+## What's in it
+
+13 service modules, one per UniFi Network API tag — `sites`,
+`unifiDevices`, `clients`, `networks`, `wifiBroadcasts`, `hotspot`,
+`firewall`, `accessControlAclRules`, `switching`, `dnsPolicies`,
+`trafficMatchingLists`, `supportingResources`, plus the single-endpoint
+`applicationInfo` — an Effect-typed operation per API endpoint (73 total
+across 44 paths), with `catchTag`-able errors for every HTTP status the
+protocol layer dispatches on (the spec documents **zero** error responses
+on any operation — see `docs/codegen-notes.md#typed-errors` for what that
+means for this package's error channel).
+
+```ts
+import * as UnifiNetwork from '@distilled.cloud/unifi-network'; // aliased onto this package — see docs/distilled-interim.md
+import * as Effect from 'effect/Effect';
+
+const program = UnifiNetwork.Services.sites.getSiteOverviewPage({}).pipe(
+  Effect.provide(
+    UnifiNetwork.credentials({
+      // Local console: "https://<console-ip>/proxy/network/integration"
+      // Cloud connector: "https://api.ui.com/v1/connector/consoles/<consoleId>/proxy/network/integration"
+      apiBaseUrl: process.env.UNIFI_NETWORK_API_BASE_URL!,
+      apiKey: process.env.UNIFI_NETWORK_API_KEY!,
+    }),
+  ),
+);
+```
+
+Kit code never imports `@homeflare/distilled-unifi-network` directly —
+always `@distilled.cloud/unifi-network`, aliased in the consuming package's
+`package.json`
+(`"@distilled.cloud/unifi-network": "npm:@homeflare/distilled-unifi-network@<version>"`),
+so the eventual cutover to the real published package is a one-line alias
+swap with no import changes anywhere in the kit.
+
+### Authentication is NOT documented in the spec
+
+`components.securitySchemes` is absent and no operation carries a
+`security` requirement. The `X-API-KEY` header this SDK sends comes from
+[Ubiquiti's own Integration API guide](https://developer.ui.com/unifi-integration-api-guide/),
+not the machine-readable description — **unverified against a live
+console as of this package's creation**; see the auth-probe handoff this
+package shipped alongside, and re-verify before depending on it for
+anything that writes.
+
+## Resource-level traps a future provider must not ignore
+
+These are NOT solved in this SDK. Full detail in `src/credentials.ts`'s
+own doc comment and `docs/codegen-notes.md`; the headlines:
+
+- **Whole-object PUT.** Nine endpoints (`updateNetwork`,
+  `updateFirewallPolicy`, `updateAclRule`, …) silently _disable_ any field
+  the caller omits — DHCP, IPv4, IPv6 config each say so in the vendor's
+  own schema. A Resource must read-merge-write the whole object and fail
+  closed on a partial read.
+- **Ordering endpoints replace the whole list.** `acl-rules/ordering` and
+  `firewall/policies/ordering` take the entire ordered list; a partial
+  list drops or reorders rules.
+- **Adopt-only objects.** Sites have no create/delete endpoint at all. The
+  default network is undeletable and has live dependents. `removeDevice`
+  does not delete — it unadopts and factory-resets an online device.
+- **Writes that power-cycle or reboot hardware** hide behind ordinary
+  verbs (`executeAdoptedDeviceAction`'s `RESTART`, `executePortAction`'s
+  `POWER_CYCLE`) — treat as gated commands, never declared props.
+- **Secrets never become attributes.** The controller API key and the WLAN
+  pre-shared key (`passphrase` — not caught by core's generic
+  `SENSITIVE_FIELD_PATTERNS`) are both write-only, sourced from OpenBao at
+  call time, never read back as plan attributes.
+
+## Scope and next steps
+
+The **UniFi Site Manager API** (a different, cloud-hosted product) is out
+of scope for this package and belongs in its own — see the distilled
+clone's `packages/unifi-network/docs/scope-and-next-steps.md`. This
+package has no kit provider yet; its first resources should be
+read/adopt-only (`Site`, `Network`, `FirewallZone`/`FirewallPolicy`)
+before any resource attempts a write that has to honor the whole-object-PUT
+and ordering-list traps above.
+
+## Updating it
+
+From the distilled clone's `homeflare/unifi-network` worktree:
+
+```sh
+DISTILLED_SPECS_LOCAL=1 pnpm --filter @distilled.cloud/unifi-network run generate
+pnpm --filter @distilled.cloud/unifi-network run typecheck
+pnpm format && pnpm specs:check
+```
+
+Then copy `src/` here verbatim, bump this package's own `version` (a patch
+release — the generated content changed, not this package's own shape),
+add a changeset, and let the kit's normal release flow publish it.
+Regenerate against the pinned schema version (10.4.57) only.
+
+## License
+
+Apache-2.0 (see `LICENSE`) — not the kit's usual MIT. `src/` is an
+unmodified copy of `@distilled.cloud/unifi-network`'s own output from
+`alchemy-run/distilled`, which is itself Apache-2.0; this package's own
+files (`package.json`, `tsconfig.json`, `scripts/smoke.ts`, this README)
+are offered under the same terms.

package/dist/credentials.d.ts

@@ -0,0 +1,24 @@
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+export interface Config {
+    readonly apiKey: Redacted.Redacted<string>;
+    /**
+     * Fully-qualified integration API root for one console, e.g.
+     * `https://192.168.1.1/proxy/network/integration`. No default: every
+     * caller names its own console.
+     */
+    readonly apiBaseUrl: string;
+}
+declare const Credentials_base: Context.ServiceClass<Credentials, "UnifiNetworkCredentials", Effect.Effect<Config, never, never>>;
+export declare class Credentials extends Credentials_base {
+}
+export declare const CredentialsFromEnv: Layer.Layer<Credentials, never, never>;
+/** Convenience layer from a plain API key and the console's integration API root. */
+export declare const credentials: (config: {
+    readonly apiKey: string | Redacted.Redacted<string>;
+    readonly apiBaseUrl: string;
+}) => Layer.Layer<Credentials>;
+export {};
+//# sourceMappingURL=credentials.d.ts.map

package/dist/credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../src/credentials.ts"],"names":[],"mappings":"AA0CA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAG5C,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;;AAaD,qBAAa,WAAY,SAAQ,gBAGH;CAAG;AAOjC,eAAO,MAAM,kBAAkB,wCAgB9B,CAAC;AAEF,qFAAqF;AACrF,eAAO,MAAM,WAAW,WAAY;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAUxB,CAAC"}

package/dist/credentials.js

@@ -0,0 +1,78 @@
+/**
+ * UniFi Network credentials — hand-written.
+ *
+ * The `Credentials` service resolves `{ apiKey, apiBaseUrl }` per request;
+ * the protocol layer sends it as the `X-API-KEY` header. UniFi Network is
+ * console-hosted (a local controller, or Ubiquiti's cloud connector proxying
+ * to one), so — like Forgejo — there is no default API root: the console's
+ * address IS part of the credential, and the caller supplies it exactly.
+ *
+ * Two console shapes exist, both valid `apiBaseUrl` values (the generated
+ * operations' routes already start with `/v1/...`, matching the OpenAPI
+ * document's `paths`, so nothing is appended here):
+ *
+ *   - Local console:    `https://<console-ip>/proxy/network/integration`
+ *   - Cloud connector:  `https://api.ui.com/v1/connector/consoles/<consoleId>/proxy/network/integration`
+ *
+ * `<consoleId>` is an account identifier — never log, commit, or otherwise
+ * persist an `apiBaseUrl` that contains one outside of the caller's own
+ * runtime configuration.
+ *
+ * ⛔ AUTHENTICATION IS NOT DOCUMENTED IN THE SPEC: `network_v10.4.57_openapi.json`
+ * declares no `components.securitySchemes` and no operation carries a
+ * `security` requirement — the `X-API-KEY` header below comes from
+ * Ubiquiti's own Integration API guide (https://developer.ui.com/unifi-integration-api-guide/),
+ * not from the machine-readable description. Re-verify this against a live
+ * console (a request without it should 401) before depending on it in
+ * anything that writes.
+ *
+ * The key itself is an Integrations → API Key created in the console's own
+ * UI (Settings → Control Plane → Integrations on a local console). It is a
+ * SECRET: callers that adopt this package into the kit read it from OpenBao
+ * at call time and pass a reference, never a literal value in state — see
+ * the package README's "Secrets" section.
+ *
+ * ⚠️ TLS is this package's caller's problem, not this package's: a local
+ * console's certificate is self-signed by default (the cloud connector's is
+ * not). `Credentials` carries no TLS configuration — trust decisions belong
+ * to the `HttpClient` layer the caller provides (a custom agent pinning the
+ * console's cert, or an explicit opt-in to skip verification for a known
+ * LAN address), never hard-coded here.
+ */
+import * as EffectConfig from "effect/Config";
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import { ConfigError } from "@distilled.cloud/core/errors";
+/**
+ * Drop trailing slashes; the base URL carries no other structure to fix up.
+ * A loop, not `/\/+$/`: that regex backtracks polynomially on a long run of
+ * `/` (CodeQL js/polynomial-redos), the same fix as distilled-netbox's.
+ */
+const normalizeBaseUrl = (baseUrl) => {
+    let end = baseUrl.length;
+    while (end > 0 && baseUrl.charCodeAt(end - 1) === 47)
+        end--;
+    return baseUrl.slice(0, end);
+};
+export class Credentials extends Context.Service()("UnifiNetworkCredentials") {
+}
+const envConfig = EffectConfig.all({
+    apiKey: EffectConfig.String("UNIFI_NETWORK_API_KEY"),
+    apiBaseUrl: EffectConfig.String("UNIFI_NETWORK_API_BASE_URL"),
+});
+export const CredentialsFromEnv = Layer.succeed(Credentials, envConfig.pipe(Effect.mapError(() => new ConfigError({
+    message: "UNIFI_NETWORK_API_BASE_URL and UNIFI_NETWORK_API_KEY environment variables are required",
+})), Effect.map(({ apiKey, apiBaseUrl }) => ({
+    apiKey: Redacted.make(apiKey),
+    apiBaseUrl: normalizeBaseUrl(apiBaseUrl),
+})), Effect.orDie));
+/** Convenience layer from a plain API key and the console's integration API root. */
+export const credentials = (config) => Layer.succeed(Credentials, Effect.succeed({
+    apiKey: typeof config.apiKey === "string"
+        ? Redacted.make(config.apiKey)
+        : config.apiKey,
+    apiBaseUrl: normalizeBaseUrl(config.apiBaseUrl),
+}));
+//# sourceMappingURL=credentials.js.map

package/dist/credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../src/credentials.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAY3D;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAU,EAAE;IACnD,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IACzB,OAAO,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE;QAAE,GAAG,EAAE,CAAC;IAC5D,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,OAAO,WAAY,SAAQ,OAAO,CAAC,OAAO,EAG7C,CAAC,yBAAyB,CAAC;CAAG;AAEjC,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;IACjC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,uBAAuB,CAAC;IACpD,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC,4BAA4B,CAAC;CAC9D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAC7C,WAAW,EACX,SAAS,CAAC,IAAI,CACZ,MAAM,CAAC,QAAQ,CACb,GAAG,EAAE,CACH,IAAI,WAAW,CAAC;IACd,OAAO,EACL,yFAAyF;CAC5F,CAAC,CACL,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IACtC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;IAC7B,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;CACzC,CAAC,CAAC,EACH,MAAM,CAAC,KAAK,CACb,CACF,CAAC;AAEF,qFAAqF;AACrF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAG3B,EAA4B,EAAE,CAC7B,KAAK,CAAC,OAAO,CACX,WAAW,EACX,MAAM,CAAC,OAAO,CAAC;IACb,MAAM,EACJ,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ;QAC/B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;QAC9B,CAAC,CAAC,MAAM,CAAC,MAAM;IACnB,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,UAAU,CAAC;CAChD,CAAC,CACH,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,74 @@
+/**
+ * UniFi Network-specific error types.
+ *
+ * ⛔ THE SPEC DOCUMENTS ZERO ERROR RESPONSES. Every one of the 73 operations
+ * in `network_v10.4.57_openapi.json` declares only its success status (65
+ * carry `200`, 8 carry `201`) — there is no per-operation 4xx/5xx, and
+ * unlike Hetzner's spec there isn't even a blanket `4xx`/`5xx` wildcard to
+ * signal "any of these can happen." So there is nothing for the OpenAPI→
+ * Smithy converter to type per operation (see `scripts/convert.ts`'s
+ * `statusToErrorClass: {}`), and every generated operation's error channel
+ * is the SAME open set below, dispatched purely by HTTP status at runtime
+ * (`src/protocol.ts`, `@distilled.cloud/core/errors#HTTP_STATUS_MAP`) —
+ * exactly the situation core's shared map exists for, just with less
+ * upstream signal than usual to say which statuses are actually reachable.
+ *
+ * Re-exports the common HTTP errors from core (nothing UniFi-specific to
+ * add to the status→class mapping — no documented error envelope shape,
+ * either, so `UnknownUnifiNetworkError` below carries the raw body rather
+ * than any parsed `code`/`message` pair) plus the unknown-error and
+ * parse-error wrappers every package needs.
+ *
+ * Known unknowns — confirm against a live console before hardening on them:
+ *   - Exact body shape of a failure (no operation's `responses` gives one).
+ *   - Whether 429 carries `Retry-After` (assume not; see `src/retry.ts`).
+ *   - Whether a bad/missing `X-API-KEY` answers 401 or 403 (both are wired
+ *     through `HTTP_STATUS_MAP`; only one will actually fire).
+ */
+export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, NotFound, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity, HTTP_STATUS_MAP, DEFAULT_ERRORS, API_ERRORS, } from "@distilled.cloud/core/errors";
+import type { BadRequest as CoreBadRequest, Conflict as CoreConflict, DefaultErrors as CoreDefaultErrors, Forbidden as CoreForbidden, NotFound as CoreNotFound, UnprocessableEntity as CoreUnprocessableEntity } from "@distilled.cloud/core/errors";
+import * as Schema from "effect/Schema";
+declare const UnknownUnifiNetworkError_base: Schema.Class<UnknownUnifiNetworkError, Schema.TaggedStruct<"UnknownUnifiNetworkError", {
+    readonly code: Schema.optional<Schema.String>;
+    readonly message: Schema.optional<Schema.String>;
+    readonly body: Schema.Unknown;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        ServerError: true;
+    };
+});
+/**
+ * Unknown UniFi Network error — returned when a failed response's HTTP
+ * status has no mapped error class, OR (given the spec's total silence on
+ * error shapes) as the fallback for any status this SDK has not been told
+ * about by a real failure yet. Carries the raw body for later cataloging.
+ */
+export declare class UnknownUnifiNetworkError extends UnknownUnifiNetworkError_base {
+}
+declare const UnifiNetworkParseError_base: Schema.Class<UnifiNetworkParseError, Schema.TaggedStruct<"UnifiNetworkParseError", {
+    readonly body: Schema.Unknown;
+    readonly cause: Schema.Unknown;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        ParseError: true;
+    };
+});
+/** Schema parse error wrapper. */
+export declare class UnifiNetworkParseError extends UnifiNetworkParseError_base {
+}
+/**
+ * Errors any UniFi Network operation may surface in addition to the shared
+ * HTTP status errors.
+ */
+export type ClientErrors = UnknownUnifiNetworkError | UnifiNetworkParseError;
+/**
+ * Default UniFi Network operation errors.
+ *
+ * EVERY operation carries the whole set — the spec types no failure at all,
+ * per-operation or wildcard, so the error channel says a `404` (site or
+ * object not found), `400` (a malformed whole-object PUT — see the
+ * package README) or `409` is possible on any call rather than pretending
+ * only the statuses core marks "default" (401/429/5xx) can happen.
+ */
+export type DefaultErrors = CoreDefaultErrors | CoreBadRequest | CoreForbidden | CoreNotFound | CoreConflict | CoreUnprocessableEntity | ClientErrors;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACV,UAAU,IAAI,cAAc,EAC5B,QAAQ,IAAI,YAAY,EACxB,aAAa,IAAI,iBAAiB,EAClC,SAAS,IAAI,aAAa,EAC1B,QAAQ,IAAI,YAAY,EACxB,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;;;;;;;;;;AAGxC;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,6BAOd;CAAG;;;;;;;;;AAEnC,kCAAkC;AAClC,qBAAa,sBAAuB,SAAQ,2BAMb;CAAG;AAElC;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,wBAAwB,GAAG,sBAAsB,CAAC;AAE7E;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GACrB,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,uBAAuB,GACvB,YAAY,CAAC"}

package/dist/errors.js

@@ -0,0 +1,49 @@
+/**
+ * UniFi Network-specific error types.
+ *
+ * ⛔ THE SPEC DOCUMENTS ZERO ERROR RESPONSES. Every one of the 73 operations
+ * in `network_v10.4.57_openapi.json` declares only its success status (65
+ * carry `200`, 8 carry `201`) — there is no per-operation 4xx/5xx, and
+ * unlike Hetzner's spec there isn't even a blanket `4xx`/`5xx` wildcard to
+ * signal "any of these can happen." So there is nothing for the OpenAPI→
+ * Smithy converter to type per operation (see `scripts/convert.ts`'s
+ * `statusToErrorClass: {}`), and every generated operation's error channel
+ * is the SAME open set below, dispatched purely by HTTP status at runtime
+ * (`src/protocol.ts`, `@distilled.cloud/core/errors#HTTP_STATUS_MAP`) —
+ * exactly the situation core's shared map exists for, just with less
+ * upstream signal than usual to say which statuses are actually reachable.
+ *
+ * Re-exports the common HTTP errors from core (nothing UniFi-specific to
+ * add to the status→class mapping — no documented error envelope shape,
+ * either, so `UnknownUnifiNetworkError` below carries the raw body rather
+ * than any parsed `code`/`message` pair) plus the unknown-error and
+ * parse-error wrappers every package needs.
+ *
+ * Known unknowns — confirm against a live console before hardening on them:
+ *   - Exact body shape of a failure (no operation's `responses` gives one).
+ *   - Whether 429 carries `Retry-After` (assume not; see `src/retry.ts`).
+ *   - Whether a bad/missing `X-API-KEY` answers 401 or 403 (both are wired
+ *     through `HTTP_STATUS_MAP`; only one will actually fire).
+ */
+export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, NotFound, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity, HTTP_STATUS_MAP, DEFAULT_ERRORS, API_ERRORS, } from "@distilled.cloud/core/errors";
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+/**
+ * Unknown UniFi Network error — returned when a failed response's HTTP
+ * status has no mapped error class, OR (given the spec's total silence on
+ * error shapes) as the fallback for any status this SDK has not been told
+ * about by a real failure yet. Carries the raw body for later cataloging.
+ */
+export class UnknownUnifiNetworkError extends Schema.TaggedError()("UnknownUnifiNetworkError", {
+    code: Schema.optional(Schema.String),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+}).pipe(Category.withServerError) {
+}
+/** Schema parse error wrapper. */
+export class UnifiNetworkParseError extends Schema.TaggedError()("UnifiNetworkParseError", {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+}).pipe(Category.withParseError) {
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AAUtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,gCAAgC,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,OAAO,wBAAyB,SAAQ,MAAM,CAAC,WAAW,EAA4B,CAC1F,0BAA0B,EAC1B;IACE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,MAAM,CAAC,OAAO;CACrB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;CAAG;AAEnC,kCAAkC;AAClC,MAAM,OAAO,sBAAuB,SAAQ,MAAM,CAAC,WAAW,EAA0B,CACtF,wBAAwB,EACxB;IACE,IAAI,EAAE,MAAM,CAAC,OAAO;IACpB,KAAK,EAAE,MAAM,CAAC,OAAO;CACtB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;CAAG"}

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @distilled.cloud/unifi-network — UniFi Network Integration API SDK for
+ * Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy models
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * document at `specs/spec-mirror-unifi-network/specs/openapi.json`).
+ * Everything else in this folder is hand-written.
+ *
+ * One module per UniFi Network API tag (Sites, UniFi Devices, Clients,
+ * Networks, WiFi Broadcasts, Hotspot, Firewall, Access Control, Switching,
+ * DNS Policies, Traffic Matching Lists, Supporting Resources, Application
+ * Info) — the same split the API reference uses.
+ *
+ * ⛔ READ THE PACKAGE README before writing a Resource against this SDK: it
+ * documents traps this SDK does NOT paper over on purpose (whole-object PUT
+ * semantics, ordering endpoints, adopt-only objects, hardware-affecting
+ * writes) — this package is the API walk-down, not a provider.
+ *
+ * @example
+ * ```ts
+ * import * as UnifiNetwork from "@distilled.cloud/unifi-network";
+ *
+ * const { data: sites } = yield* UnifiNetwork.Services.sites.getSiteOverviewPage({});
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export { UnifiNetworkProtocol, type UnifiNetworkOpError, type UnifiNetworkOpContext, } from "./protocol.ts";
+export * as Retry from "./retry.ts";
+export * as Services from "./services/index.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,oBAAoB,EACpB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,GAC3B,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -0,0 +1,33 @@
+/**
+ * @distilled.cloud/unifi-network — UniFi Network Integration API SDK for
+ * Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy models
+ * in `.generated-specs` (written by `scripts/convert.ts` from the OpenAPI
+ * document at `specs/spec-mirror-unifi-network/specs/openapi.json`).
+ * Everything else in this folder is hand-written.
+ *
+ * One module per UniFi Network API tag (Sites, UniFi Devices, Clients,
+ * Networks, WiFi Broadcasts, Hotspot, Firewall, Access Control, Switching,
+ * DNS Policies, Traffic Matching Lists, Supporting Resources, Application
+ * Info) — the same split the API reference uses.
+ *
+ * ⛔ READ THE PACKAGE README before writing a Resource against this SDK: it
+ * documents traps this SDK does NOT paper over on purpose (whole-object PUT
+ * semantics, ordering endpoints, adopt-only objects, hardware-affecting
+ * writes) — this package is the API walk-down, not a provider.
+ *
+ * @example
+ * ```ts
+ * import * as UnifiNetwork from "@distilled.cloud/unifi-network";
+ *
+ * const { data: sites } = yield* UnifiNetwork.Services.sites.getSiteOverviewPage({});
+ * ```
+ */
+export * from "./credentials.js";
+export * from "./errors.js";
+export * as T from "./traits.js";
+export { UnifiNetworkProtocol, } from "./protocol.js";
+export * as Retry from "./retry.js";
+export * as Services from "./services/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,oBAAoB,GAGrB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC"}