@homeflare/distilled-opnsense 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,95 @@
+# @homeflare/distilled-opnsense
+
+This package is **not a HomeFlare SDK**. It is an unmodified copy of
+`@distilled.cloud/opnsense`, generated by the
+[distilled](https://github.com/alchemy-run/distilled) pipeline from
+OPNsense's own MVC model XML and API controller PHP — OPNsense publishes no
+OpenAPI/Smithy/GraphQL description of its API at all, so this converter
+reads `opnsense/core`'s `mvc/app/models/OPNsense/<Module>/<Model>.xml` and
+`.../controllers/OPNsense/<Module>/Api/*Controller.php` directly, not the
+shared OpenAPI dialect every other distilled package uses. Published here
+under its own name only because `@distilled.cloud/opnsense` 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/opnsense/`, 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`.
+
+## Provenance and version pin
+
+Generated against `opnsense/core` and `opnsense/plugins` tag `26.7.2`. The
+edge firewall's exact installed version has **never been measured live**
+(SSH to the edge is forbidden by house policy; CrowdSec bans the caller's
+IP on a failed probe) — `26.7.2` is inferred, read-only, from a captured
+package list (`os-frr-1.54` matches that one tag's plugin tree exactly) and
+a runbook stating the box runs "26.7.x". See the distilled clone's
+`packages/opnsense/README.md` for the full evidence chain. Patch releases
+inside one OPNsense series essentially never change model/controller shape,
+so this pin's model XML/controller PHP is very likely correct even if the
+edge sits on a different `26.7.x` patch — but it is an inference, not a
+measurement, and should be confirmed on the box before this package is
+trusted for anything consequential.
+
+## What's in it
+
+8 API controllers, 83 operations — Firewall Alias/Category/Group/Filter
+(rules), Routing (Gateways), and the `os-frr` plugin's Quagga/BGP — not
+OPNsense's full ~80 configured modules; see the distilled clone's
+`packages/opnsense/README.md` for the scope table and what was mechanically
+excluded per controller (decorated `get<Item>Action`s, bespoke lifecycle
+actions). `catchTag`-able errors cover OPNsense's three-shape
+200-with-failure vendor pattern (`{result:"failed"}` validation errors,
+`UserWarningException`/`UserInformationalException` at 200) plus the
+genuine non-2xx shapes (`UserException`, `DispatchException` 404, the
+401/403/400 auth gate) — see `src/protocol.ts` and `src/errors.ts` for the
+full mapping with citations back to OPNsense's own PHP source.
+
+```ts
+import * as Opnsense from '@distilled.cloud/opnsense'; // aliased onto this package — see docs/distilled-interim.md
+import * as Effect from 'effect/Effect';
+
+const program = Opnsense.Services.quagga_general.get({}).pipe(
+  Effect.provide(
+    Opnsense.credentials({
+      apiKey: 'key',
+      apiSecret: 'secret',
+      baseUrl: 'https://edge.example.com',
+    }),
+  ),
+);
+```
+
+Kit code never imports `@homeflare/distilled-opnsense` directly — always
+`@distilled.cloud/opnsense` (the alias in `docs/distilled-interim.md`'s
+step 5), once that alias exists. This PR does not add that alias and does
+not declare any Alchemy `Resource`s on top — see "Not done here" below.
+
+## Not done here
+
+- **No alias, no Alchemy `Resource`s.** The alias can only resolve once
+  this package is actually published to npm; adding Firewall
+  Alias/Category/Group/Rule (and later Gateways/BGP) resources on top is a
+  follow-up PR, gated in part on two open intent questions in
+  `docs/alchemy-ledger-network.md` in the landscape repo.
+- **No live calls of any kind.** This package has never been pointed at a
+  real OPNsense instance; `src/protocol.ts`'s decode logic is grounded in
+  vendor source and docs, not runtime-verified. `docs/design.md` in the
+  distilled clone's `packages/opnsense/` flags a behavioral trap worth
+  reading before building a `Resource` around `setAlias`/`setCategory`/
+  `setGroup`: renaming an item through those endpoints triggers a
+  server-side cascade that rewrites the old name everywhere it's
+  referenced elsewhere in `config.xml`, not just inside the renamed row.
+
+## License
+
+Apache-2.0 — see `LICENSE`. This package is a redistribution of
+`alchemy-run/distilled`'s own generated output, unmodified.

package/dist/credentials.d.ts

@@ -0,0 +1,39 @@
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+/**
+ * OPNsense's own path prefix; every generated route's `T.Http({ uri })`
+ * already carries it (e.g. `/api/quagga/general/get` — see any
+ * `src/services/*.ts`), because it is the vendor's own real wire path, not
+ * an artifact of this converter. `buildRequest` in
+ * `@distilled.cloud/core/protocol-http` concatenates `baseUrl + uri`
+ * verbatim with no de-duplication, so `apiBaseUrl` MUST be the bare origin
+ * — appending `API_PATH` here as well produced a real, smoke-test-caught
+ * `/api/api/...` request (see `../scripts/smoke.ts` and
+ * `../README.md`'s "Known limitations"). `normalizeBaseUrl` therefore
+ * STRIPS a trailing `/api` a caller may have included (the doc comment on
+ * `Config.apiBaseUrl` below used to invite exactly that input), rather than
+ * adding one.
+ */
+export declare const API_PATH = "/api";
+/** Normalize an OPNsense origin (or an already-complete `/api` root, accepted for caller convenience) down to the bare origin every generated route's own `uri` already assumes. */
+export declare const normalizeBaseUrl: (baseUrl: string) => string;
+export interface Config {
+    readonly apiKey: string;
+    readonly apiSecret: Redacted.Redacted<string>;
+    /** Bare origin, e.g. `https://edge.homeflare.dev` or `https://10.20.10.1` — a trailing `/api` is accepted and stripped, never doubled with a route's own `/api/...` prefix. */
+    readonly apiBaseUrl: string;
+}
+declare const Credentials_base: Context.ServiceClass<Credentials, "OpnsenseCredentials", 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 key/secret and the box's origin (or API root). */
+export declare const credentials: (config: {
+    readonly apiKey: string;
+    readonly apiSecret: string | Redacted.Redacted<string>;
+    readonly baseUrl: 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":"AAoBA,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;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,SAAS,CAAC;AAE/B,oLAAoL;AACpL,eAAO,MAAM,gBAAgB,YAAa,MAAM,KAAG,MASlD,CAAC;AAEF,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC9C,+KAA+K;IAC/K,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;;AAED,qBAAa,WAAY,SAAQ,gBAGP;CAAG;AAW7B,eAAO,MAAM,kBAAkB,wCAiB9B,CAAC;AAEF,oFAAoF;AACpF,eAAO,MAAM,WAAW,WAAY;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAWxB,CAAC"}

package/dist/credentials.js

@@ -0,0 +1,78 @@
+/**
+ * OPNsense credentials — hand-written.
+ *
+ * OPNsense authenticates its `/api/*` surface with a key/secret pair sent
+ * as HTTP Basic auth: `Authorization: Basic base64(key:secret)` — verified
+ * both in source (`ApiControllerBase::beforeExecuteRoute`, mirrored at
+ * `specs/core/models/Base/ApiControllerBase.php`: it splits the decoded
+ * Basic-auth payload on `:` into `apiKey`/`apiSecret`, and works with ANY
+ * scheme word before the base64 blob, not just literally `Basic`) and in
+ * the vendor's own docs (`opnsense/docs`, `source/development/how-tos/
+ * api.rst`: a `curl -u <api-key>:<api-secret>` example against `.../api/...`,
+ * and the Python sample's `requests.get(..., auth=(api_key, api_secret))` — `requests`'
+ * `auth=` tuple IS HTTP Basic). The secret is generated once per key in the
+ * user manager and cannot be re-downloaded, so it is credential-shaped, not
+ * password-shaped — `Redacted` like a token, never compared or logged.
+ *
+ * Self-hosted, like Forgejo: there is no default host, so the edge/router's
+ * origin is part of the credential, not a hardcoded base URL.
+ */
+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";
+/**
+ * OPNsense's own path prefix; every generated route's `T.Http({ uri })`
+ * already carries it (e.g. `/api/quagga/general/get` — see any
+ * `src/services/*.ts`), because it is the vendor's own real wire path, not
+ * an artifact of this converter. `buildRequest` in
+ * `@distilled.cloud/core/protocol-http` concatenates `baseUrl + uri`
+ * verbatim with no de-duplication, so `apiBaseUrl` MUST be the bare origin
+ * — appending `API_PATH` here as well produced a real, smoke-test-caught
+ * `/api/api/...` request (see `../scripts/smoke.ts` and
+ * `../README.md`'s "Known limitations"). `normalizeBaseUrl` therefore
+ * STRIPS a trailing `/api` a caller may have included (the doc comment on
+ * `Config.apiBaseUrl` below used to invite exactly that input), rather than
+ * adding one.
+ */
+export const API_PATH = "/api";
+/** Normalize an OPNsense origin (or an already-complete `/api` root, accepted for caller convenience) down to the bare origin every generated route's own `uri` already assumes. */
+export const normalizeBaseUrl = (baseUrl) => {
+    // A loop, not a trailing-slash regex: that backtracks polynomially on a long
+    // run of "/" (CodeQL js/polynomial-redos), the same fix as distilled-netbox's.
+    let end = baseUrl.length;
+    while (end > 0 && baseUrl.charCodeAt(end - 1) === 47)
+        end--;
+    const trimmed = baseUrl.slice(0, end);
+    return trimmed.endsWith(API_PATH)
+        ? trimmed.slice(0, -API_PATH.length)
+        : trimmed;
+};
+export class Credentials extends Context.Service()("OpnsenseCredentials") {
+}
+const envConfig = EffectConfig.all({
+    // No vendor-standard env var names exist for OPNsense's API (unlike
+    // Forgejo's own `FORGEJO_URL`/`FORGEJO_TOKEN`) — these follow this SDK's
+    // own naming.
+    apiKey: EffectConfig.String("OPNSENSE_API_KEY"),
+    apiSecret: EffectConfig.String("OPNSENSE_API_SECRET"),
+    baseUrl: EffectConfig.String("OPNSENSE_URL"),
+});
+export const CredentialsFromEnv = Layer.succeed(Credentials, envConfig.pipe(Effect.mapError(() => new ConfigError({
+    message: "OPNSENSE_URL, OPNSENSE_API_KEY and OPNSENSE_API_SECRET environment variables are required",
+})), Effect.map(({ apiKey, apiSecret, baseUrl }) => ({
+    apiKey,
+    apiSecret: Redacted.make(apiSecret),
+    apiBaseUrl: normalizeBaseUrl(baseUrl),
+})), Effect.orDie));
+/** Convenience layer from a plain key/secret and the box's origin (or API root). */
+export const credentials = (config) => Layer.succeed(Credentials, Effect.succeed({
+    apiKey: config.apiKey,
+    apiSecret: typeof config.apiSecret === "string"
+        ? Redacted.make(config.apiSecret)
+        : config.apiSecret,
+    apiBaseUrl: normalizeBaseUrl(config.baseUrl),
+}));
+//# 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;;;;;;;;;;;;;;;;;;GAkBG;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;AAE3D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE/B,oLAAoL;AACpL,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAU,EAAE;IAC1D,6EAA6E;IAC7E,+EAA+E;IAC/E,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,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtC,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC/B,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC;QACpC,CAAC,CAAC,OAAO,CAAC;AACd,CAAC,CAAC;AASF,MAAM,OAAO,WAAY,SAAQ,OAAO,CAAC,OAAO,EAG7C,CAAC,qBAAqB,CAAC;CAAG;AAE7B,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;IACjC,oEAAoE;IACpE,yEAAyE;IACzE,cAAc;IACd,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAC/C,SAAS,EAAE,YAAY,CAAC,MAAM,CAAC,qBAAqB,CAAC;IACrD,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,cAAc,CAAC;CAC7C,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,2FAA2F;CAC9F,CAAC,CACL,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC9C,MAAM;IACN,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;IACnC,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC;CACtC,CAAC,CAAC,EACH,MAAM,CAAC,KAAK,CACb,CACF,CAAC;AAEF,oFAAoF;AACpF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAI3B,EAA4B,EAAE,CAC7B,KAAK,CAAC,OAAO,CACX,WAAW,EACX,MAAM,CAAC,OAAO,CAAC;IACb,MAAM,EAAE,MAAM,CAAC,MAAM;IACrB,SAAS,EACP,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ;QAClC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;QACjC,CAAC,CAAC,MAAM,CAAC,SAAS;IACtB,UAAU,EAAE,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC;CAC7C,CAAC,CACH,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,110 @@
+/**
+ * OPNsense-specific error types — hand-written.
+ *
+ * OPNsense is a 200-with-failure vendor (see `protocol.ts`'s module doc):
+ * most of what a caller needs to `catchTag` on never reaches an HTTP error
+ * status at all. This module's classes are read directly off
+ * `src/opnsense/www/api.php` (the `/api/*` front controller — mirrored at
+ * `specs/core/models/Base/` is the controller CONTRACT those bodies come
+ * from; `api.php` itself is not mirrored, since it is not model/controller
+ * source the converter reads, but its four `catch` clauses are exactly the
+ * four non-2xx/vendor-exception shapes below):
+ *
+ *   catch UserException            → getHttpCode() (500 unless a subclass
+ *                                     overrides it) + {errorMessage,
+ *                                     errorTitle, errorLevel} — a real
+ *                                     business-rule denial (Alias/Category/
+ *                                     Group's "in use" checks, Filter's
+ *                                     "cannot move" checks), NOT a server
+ *                                     fault: never retried.
+ *   catch DispatchException        → 404 {errorMessage} (route/controller/
+ *                                     action not found — e.g. a plugin
+ *                                     module that isn't installed).
+ *   catch Error|Exception          → 500 {errorMessage: "Unexpected error,
+ *                                     check log for details"} (a PHP fault).
+ *   (not sent)                     → the ORIGINAL response, when none of
+ *                                     the above threw — this is everything
+ *                                     else: the 401/403/400 auth/CSRF/JSON
+ *                                     shapes from `ApiControllerBase::before
+ *                                     ExecuteRoute` ({status:<code>,
+ *                                     message}, `status` a NUMBER — do not
+ *                                     confuse with the unrelated string
+ *                                     `status` OPNsense's OWN operations
+ *                                     return, e.g. service status/
+ *                                     reconfigure) and the 200
+ *                                     `{result:"failed", validations?}`
+ *                                     shape every `ApiMutableModelController
+ *                                     Base` mutation can answer with.
+ */
+import * as Schema from "effect/Schema";
+import { ConfigError, Unauthorized, Forbidden, BadRequest, NotFound, InternalServerError } from "@distilled.cloud/core/errors";
+export { ConfigError, Unauthorized, Forbidden, BadRequest, NotFound, InternalServerError, };
+declare const ValidationFailed_base: Schema.Class<ValidationFailed, Schema.TaggedStruct<"ValidationFailed", {
+    readonly validations: Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.$Array<Schema.String>]>>;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        BadRequestError: true;
+    };
+});
+/** `{"result":"failed", validations?: {...}}` from `ApiMutableModelControllerBase::validate()`/`setBase`/`addBase`/`delBase`/`toggleBase` — always HTTP 200. `validations` is absent for a non-field failure (bad uuid, wrong verb); present and keyed `<prefix>.<field>` → one message or several for a real field error. */
+export declare class ValidationFailed extends ValidationFailed_base {
+}
+declare const OpnsenseUserError_base: Schema.Class<OpnsenseUserError, Schema.TaggedStruct<"OpnsenseUserError", {
+    readonly title: Schema.optional<Schema.String>;
+    readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        BadRequestError: true;
+    };
+});
+/** A plain `UserException` (`errorLevel: "error"`, default HTTP 500) — a business-rule denial such as "Alias in use" or "cannot move to the same spot", not a server fault: `Category.withBadRequestError`, never retried. */
+export declare class OpnsenseUserError extends OpnsenseUserError_base {
+}
+declare const OpnsenseUserWarning_base: Schema.Class<OpnsenseUserWarning, Schema.TaggedStruct<"OpnsenseUserWarning", {
+    readonly title: Schema.optional<Schema.String>;
+    readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        BadRequestError: true;
+    };
+});
+/** A `UserWarningException` — HTTP 200, but the request did NOT do what was asked (`UserWarningException::getHttpCode()` is hard-coded 200). */
+export declare class OpnsenseUserWarning extends OpnsenseUserWarning_base {
+}
+declare const OpnsenseUserNotice_base: Schema.Class<OpnsenseUserNotice, Schema.TaggedStruct<"OpnsenseUserNotice", {
+    readonly title: Schema.optional<Schema.String>;
+    readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        BadRequestError: true;
+    };
+});
+/** A `UserInformationalException` — HTTP 200, an informational abort (e.g. "nothing to do"). */
+export declare class OpnsenseUserNotice extends OpnsenseUserNotice_base {
+}
+declare const UnknownOpnsenseError_base: Schema.Class<UnknownOpnsenseError, Schema.TaggedStruct<"UnknownOpnsenseError", {
+    readonly status: Schema.Number;
+    readonly body: Schema.Unknown;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        ServerError: true;
+    };
+});
+/** Unmapped failure — a response this SDK's protocol layer could not classify into any of the above (non-JSON body, a shape none of the known cases match). Carries the raw body for later cataloging. */
+export declare class UnknownOpnsenseError extends UnknownOpnsenseError_base {
+}
+declare const OpnsenseParseError_base: Schema.Class<OpnsenseParseError, Schema.TaggedStruct<"OpnsenseParseError", {
+    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 OpnsenseParseError extends OpnsenseParseError_base {
+}
+export type ClientErrors = ValidationFailed | OpnsenseUserError | OpnsenseUserWarning | OpnsenseUserNotice | UnknownOpnsenseError | OpnsenseParseError;
+/** Default errors every generated OPNsense operation carries — see the module doc for where each one comes from. */
+export type DefaultErrors = Unauthorized | Forbidden | BadRequest | NotFound | InternalServerError | ConfigError | 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,SAAS,EACT,UAAU,EACV,QAAQ,EACR,mBAAmB,EACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,SAAS,EACT,UAAU,EACV,QAAQ,EACR,mBAAmB,GACpB,CAAC;;;;;;;;AAEF,8TAA8T;AAC9T,qBAAa,gBAAiB,SAAQ,qBAQF;CAAG;;;;;;;;;AAEvC,8NAA8N;AAC9N,qBAAa,iBAAkB,SAAQ,sBAGH;CAAG;;;;;;;;;AAEvC,gJAAgJ;AAChJ,qBAAa,mBAAoB,SAAQ,wBAGL;CAAG;;;;;;;;;AAEvC,gGAAgG;AAChG,qBAAa,kBAAmB,SAAQ,uBAGJ;CAAG;;;;;;;;;AAEvC,0MAA0M;AAC1M,qBAAa,oBAAqB,SAAQ,yBAGV;CAAG;;;;;;;;;AAEnC,kCAAkC;AAClC,qBAAa,kBAAmB,SAAQ,uBAGT;CAAG;AAElC,MAAM,MAAM,YAAY,GACpB,gBAAgB,GAChB,iBAAiB,GACjB,mBAAmB,GACnB,kBAAkB,GAClB,oBAAoB,GACpB,kBAAkB,CAAC;AAEvB,oHAAoH;AACpH,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,SAAS,GACT,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAC"}

package/dist/errors.js

@@ -0,0 +1,63 @@
+/**
+ * OPNsense-specific error types — hand-written.
+ *
+ * OPNsense is a 200-with-failure vendor (see `protocol.ts`'s module doc):
+ * most of what a caller needs to `catchTag` on never reaches an HTTP error
+ * status at all. This module's classes are read directly off
+ * `src/opnsense/www/api.php` (the `/api/*` front controller — mirrored at
+ * `specs/core/models/Base/` is the controller CONTRACT those bodies come
+ * from; `api.php` itself is not mirrored, since it is not model/controller
+ * source the converter reads, but its four `catch` clauses are exactly the
+ * four non-2xx/vendor-exception shapes below):
+ *
+ *   catch UserException            → getHttpCode() (500 unless a subclass
+ *                                     overrides it) + {errorMessage,
+ *                                     errorTitle, errorLevel} — a real
+ *                                     business-rule denial (Alias/Category/
+ *                                     Group's "in use" checks, Filter's
+ *                                     "cannot move" checks), NOT a server
+ *                                     fault: never retried.
+ *   catch DispatchException        → 404 {errorMessage} (route/controller/
+ *                                     action not found — e.g. a plugin
+ *                                     module that isn't installed).
+ *   catch Error|Exception          → 500 {errorMessage: "Unexpected error,
+ *                                     check log for details"} (a PHP fault).
+ *   (not sent)                     → the ORIGINAL response, when none of
+ *                                     the above threw — this is everything
+ *                                     else: the 401/403/400 auth/CSRF/JSON
+ *                                     shapes from `ApiControllerBase::before
+ *                                     ExecuteRoute` ({status:<code>,
+ *                                     message}, `status` a NUMBER — do not
+ *                                     confuse with the unrelated string
+ *                                     `status` OPNsense's OWN operations
+ *                                     return, e.g. service status/
+ *                                     reconfigure) and the 200
+ *                                     `{result:"failed", validations?}`
+ *                                     shape every `ApiMutableModelController
+ *                                     Base` mutation can answer with.
+ */
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+import { ConfigError, Unauthorized, Forbidden, BadRequest, NotFound, InternalServerError, } from "@distilled.cloud/core/errors";
+export { ConfigError, Unauthorized, Forbidden, BadRequest, NotFound, InternalServerError, };
+/** `{"result":"failed", validations?: {...}}` from `ApiMutableModelControllerBase::validate()`/`setBase`/`addBase`/`delBase`/`toggleBase` — always HTTP 200. `validations` is absent for a non-field failure (bad uuid, wrong verb); present and keyed `<prefix>.<field>` → one message or several for a real field error. */
+export class ValidationFailed extends Schema.TaggedError()("ValidationFailed", {
+    validations: Schema.Record(Schema.String, Schema.Union([Schema.String, Schema.Array(Schema.String)])),
+}).pipe(Category.withBadRequestError) {
+}
+/** A plain `UserException` (`errorLevel: "error"`, default HTTP 500) — a business-rule denial such as "Alias in use" or "cannot move to the same spot", not a server fault: `Category.withBadRequestError`, never retried. */
+export class OpnsenseUserError extends Schema.TaggedError()("OpnsenseUserError", { title: Schema.optional(Schema.String), message: Schema.String }).pipe(Category.withBadRequestError) {
+}
+/** A `UserWarningException` — HTTP 200, but the request did NOT do what was asked (`UserWarningException::getHttpCode()` is hard-coded 200). */
+export class OpnsenseUserWarning extends Schema.TaggedError()("OpnsenseUserWarning", { title: Schema.optional(Schema.String), message: Schema.String }).pipe(Category.withBadRequestError) {
+}
+/** A `UserInformationalException` — HTTP 200, an informational abort (e.g. "nothing to do"). */
+export class OpnsenseUserNotice extends Schema.TaggedError()("OpnsenseUserNotice", { title: Schema.optional(Schema.String), message: Schema.String }).pipe(Category.withBadRequestError) {
+}
+/** Unmapped failure — a response this SDK's protocol layer could not classify into any of the above (non-JSON body, a shape none of the known cases match). Carries the raw body for later cataloging. */
+export class UnknownOpnsenseError extends Schema.TaggedError()("UnknownOpnsenseError", { status: Schema.Number, body: Schema.Unknown }).pipe(Category.withServerError) {
+}
+/** Schema parse error wrapper. */
+export class OpnsenseParseError extends Schema.TaggedError()("OpnsenseParseError", { 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,gCAAgC,CAAC;AAC3D,OAAO,EACL,WAAW,EACX,YAAY,EACZ,SAAS,EACT,UAAU,EACV,QAAQ,EACR,mBAAmB,GACpB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,WAAW,EACX,YAAY,EACZ,SAAS,EACT,UAAU,EACV,QAAQ,EACR,mBAAmB,GACpB,CAAC;AAEF,8TAA8T;AAC9T,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAC1E,kBAAkB,EAClB;IACE,WAAW,EAAE,MAAM,CAAC,MAAM,CACxB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAC3D;CACF,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAAG;AAEvC,8NAA8N;AAC9N,MAAM,OAAO,iBAAkB,SAAQ,MAAM,CAAC,WAAW,EAAqB,CAC5E,mBAAmB,EACnB,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAClE,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAAG;AAEvC,gJAAgJ;AAChJ,MAAM,OAAO,mBAAoB,SAAQ,MAAM,CAAC,WAAW,EAAuB,CAChF,qBAAqB,EACrB,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAClE,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAAG;AAEvC,gGAAgG;AAChG,MAAM,OAAO,kBAAmB,SAAQ,MAAM,CAAC,WAAW,EAAsB,CAC9E,oBAAoB,EACpB,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAClE,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAAG;AAEvC,0MAA0M;AAC1M,MAAM,OAAO,oBAAqB,SAAQ,MAAM,CAAC,WAAW,EAAwB,CAClF,sBAAsB,EACtB,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,CAChD,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;CAAG;AAEnC,kCAAkC;AAClC,MAAM,OAAO,kBAAmB,SAAQ,MAAM,CAAC,WAAW,EAAsB,CAC9E,oBAAoB,EACpB,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAChD,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;CAAG"}

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @distilled.cloud/opnsense — OPNsense firewall API SDK for Effect.
+ *
+ * `./services` is generated by `scripts/generate.ts` from the Smithy models
+ * in `.generated-specs` (written by `scripts/convert.ts` from OPNsense's own
+ * model XML + API controller PHP, mirrored under `specs/`). Everything else
+ * in this folder is hand-written.
+ *
+ * One module per API controller in scope — `firewall_alias`,
+ * `firewall_category`, `firewall_group`, `firewall_filter`,
+ * `routing_settings`, `quagga_general`, `quagga_bgp`, `quagga_service` — see
+ * the package README for what each one covers and what was left out.
+ *
+ * @example
+ * ```ts
+ * import * as Opnsense from "@distilled.cloud/opnsense";
+ *
+ * const alias = yield* Opnsense.Services.firewall_alias.addAlias({
+ *   alias: { name: "homeflare_edge", type: "host", content: "10.20.10.1" },
+ * });
+ * ```
+ */
+export * from "./credentials.ts";
+export * from "./errors.ts";
+export * as T from "./traits.ts";
+export { OpnsenseProtocol, type OpnsenseOpError, type OpnsenseOpContext, } 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;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AACjC,OAAO,EACL,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,iBAAiB,GACvB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC"}