@homeflare/distilled-proxmox 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,87 @@
+# @homeflare/distilled-proxmox
+
+This package is **not a HomeFlare SDK**. It is an unmodified copy of
+`@distilled.cloud/proxmox`, generated by the [distilled](https://github.com/alchemy-run/distilled)
+pipeline from Proxmox VE's own `apidata.js` (the api-viewer's schema — PVE
+publishes no OpenAPI document, so this is a hand-written converter over the
+vendor's own tree, not the shared OpenAPI dialect every other distilled
+package uses), pinned to the vendor's GitHub mirror commit matching this
+estate's `pve-manager` 9.2.11, published here under its own name only
+because `@distilled.cloud/proxmox` 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/proxmox/`, 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
+
+6 service modules, one per PVE top-level path segment — `access`,
+`cluster`, `nodes`, `pools`, `storage`, `version` — an Effect-typed
+operation per PVE REST endpoint (680 total, 0 skipped), with `catchTag`-able
+errors: the shared HTTP status classes, PVE's global
+`ParameterVerificationFailed` (the `{"errors": {field: message}}` envelope
+every failed write can carry) and non-retryable `BadRequest` fallback, and
+`ClusterNodeUnreachable` (PVE's non-standard 595 for a cluster-forwarded
+request that couldn't reach its target node) on the task-management
+operations the vendor schema itself marks `proxyto: "node"`.
+
+Also ships `awaitTask` (`./Task`), because a PVE POST/PUT/DELETE that
+queues a long-running action answers 200 with a bare task id the moment it
+is QUEUED, not once it finishes — `awaitTask` polls the generated
+`getNodeTaskStatus` operation until an `exitstatus` appears, and fails
+unless it is EXACTLY `"OK"` (PVE also answers `"OK (warnings)"`, which is
+not success).
+
+```ts
+import * as Proxmox from '@distilled.cloud/proxmox'; // aliased onto this package — see docs/distilled-interim.md
+import * as Effect from 'effect/Effect';
+
+const program = Proxmox.Services.version.getVersion({}).pipe(
+  Effect.provide(Proxmox.ProxmoxProtocol),
+  Effect.provide(
+    Proxmox.credentials({
+      tokenId: 'root@pam!terraform',
+      secret: '...',
+      baseUrl: 'https://pve1.example.com:8006',
+    }),
+  ),
+);
+```
+
+Kit code never imports `@homeflare/distilled-proxmox` directly — always
+`@distilled.cloud/proxmox`, aliased in the consuming package's `package.json`
+(`"@distilled.cloud/proxmox": "npm:@homeflare/distilled-proxmox@<version>"`),
+so the eventual cutover to the real published package is a one-line alias
+swap with no import changes anywhere in the kit.
+
+## Updating it
+
+From the distilled clone's `homeflare/proxmox` worktree:
+
+```sh
+DISTILLED_SPECS_LOCAL=1 pnpm --filter @distilled.cloud/proxmox run convert
+DISTILLED_SPECS_LOCAL=1 pnpm --filter @distilled.cloud/proxmox run generate
+pnpm --filter @distilled.cloud/proxmox 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.
+
+## License
+
+Apache-2.0 (see `LICENSE`) — not the kit's usual MIT. `src/` is an
+unmodified copy of `@distilled.cloud/proxmox`'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,41 @@
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+/** PVE's own API root, relative to the node origin. Always port 8006, always `/api2/json`. */
+export declare const API_PATH = "/api2/json";
+/**
+ * Normalize a node origin (or an already-complete API root) into the API
+ * base URL: trailing slashes dropped, {@link API_PATH} appended exactly
+ * once. Does NOT default the port — `https://pve.example.com:8006` (or a
+ * bare host, which the caller must have already put a scheme+port on) is
+ * expected, matching how the kit's own `PveTarget` is built per node/vip.
+ *
+ * ⛔ THE TRIM IS A LOOP, NEVER `/\/+$/`. That regex backtracks
+ *   polynomially on a long run of trailing `/` (CodeQL `js/polynomial-
+ *   redos`) — caller input, so a real DoS surface, not a hypothetical one.
+ *   Measured the same fix already landed in `@homeflare/distilled-netbox`'s
+ *   identical trim (`taslabs-net/homeflare-kit` PR 184): 0 mismatches
+ *   against the old regex over 13 edge cases and 20,000 random inputs, a
+ *   100,000-slash input in 0.01ms linear.
+ */
+export declare const normalizeBaseUrl: (baseUrl: string) => string;
+export interface Config {
+    /** The full `<user>@<realm>!<tokenid>` string, e.g. `root@pam!terraform`. */
+    readonly tokenId: string;
+    readonly secret: Redacted.Redacted<string>;
+    /** Fully-qualified API root, e.g. `https://pve1.example.com:8006/api2/json`. */
+    readonly apiBaseUrl: string;
+}
+declare const Credentials_base: Context.ServiceClass<Credentials, "ProxmoxCredentials", 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 token and the node origin (or API root). */
+export declare const credentials: (config: {
+    readonly tokenId: string;
+    readonly secret: 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":"AAeA,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,8FAA8F;AAC9F,eAAO,MAAM,QAAQ,eAAe,CAAC;AAErC;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,YAAa,MAAM,KAAG,MAKlD,CAAC;AAEF,MAAM,WAAW,MAAM;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;;AAED,qBAAa,WAAY,SAAQ,gBAGR;CAAG;AAQ5B,eAAO,MAAM,kBAAkB,wCAiB9B,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,WAAW,WAAY;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAWxB,CAAC"}

package/dist/credentials.js

@@ -0,0 +1,67 @@
+/**
+ * Proxmox VE credentials — hand-written.
+ *
+ * The `Credentials` service resolves `{ tokenId, secret, apiBaseUrl }` per
+ * request; the protocol layer formats the `Authorization:
+ * PVEAPIToken=<tokenId>=<secret>` header from it.
+ *
+ * PVE is self-hosted (a cluster node, not a single-tenant SaaS), so — like
+ * `@distilled.cloud/forgejo` — there is no default API root: the instance
+ * URL is part of the credential. `tokenId` is the FULL
+ * `<user>@<realm>!<tokenid>` string PVE prints when an API token is
+ * created (`pveum user token add …`); `secret` is the value shown exactly
+ * once at creation time.
+ */
+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";
+/** PVE's own API root, relative to the node origin. Always port 8006, always `/api2/json`. */
+export const API_PATH = "/api2/json";
+/**
+ * Normalize a node origin (or an already-complete API root) into the API
+ * base URL: trailing slashes dropped, {@link API_PATH} appended exactly
+ * once. Does NOT default the port — `https://pve.example.com:8006` (or a
+ * bare host, which the caller must have already put a scheme+port on) is
+ * expected, matching how the kit's own `PveTarget` is built per node/vip.
+ *
+ * ⛔ THE TRIM IS A LOOP, NEVER `/\/+$/`. That regex backtracks
+ *   polynomially on a long run of trailing `/` (CodeQL `js/polynomial-
+ *   redos`) — caller input, so a real DoS surface, not a hypothetical one.
+ *   Measured the same fix already landed in `@homeflare/distilled-netbox`'s
+ *   identical trim (`taslabs-net/homeflare-kit` PR 184): 0 mismatches
+ *   against the old regex over 13 edge cases and 20,000 random inputs, a
+ *   100,000-slash input in 0.01ms linear.
+ */
+export const normalizeBaseUrl = (baseUrl) => {
+    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 : `${trimmed}${API_PATH}`;
+};
+export class Credentials extends Context.Service()("ProxmoxCredentials") {
+}
+const envConfig = EffectConfig.all({
+    tokenId: EffectConfig.String("PROXMOX_TOKEN_ID"),
+    secret: EffectConfig.Redacted("PROXMOX_TOKEN_SECRET"),
+    baseUrl: EffectConfig.String("PROXMOX_URL"),
+});
+export const CredentialsFromEnv = Layer.succeed(Credentials, envConfig.pipe(Effect.mapError(() => new ConfigError({
+    message: "PROXMOX_URL, PROXMOX_TOKEN_ID and PROXMOX_TOKEN_SECRET environment variables are required",
+})), Effect.map(({ tokenId, secret, baseUrl }) => ({
+    tokenId,
+    secret,
+    apiBaseUrl: normalizeBaseUrl(baseUrl),
+})), Effect.orDie));
+/** Convenience layer from a plain token and the node origin (or API root). */
+export const credentials = (config) => Layer.succeed(Credentials, Effect.succeed({
+    tokenId: config.tokenId,
+    secret: typeof config.secret === "string"
+        ? Redacted.make(config.secret)
+        : config.secret,
+    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;;;;;;;;;;;;;GAaG;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,8FAA8F;AAC9F,MAAM,CAAC,MAAM,QAAQ,GAAG,YAAY,CAAC;AAErC;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAU,EAAE;IAC1D,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IACzB,OAAO,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,SAAS;QAAE,GAAG,EAAE,CAAC;IACtE,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACtC,OAAO,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,QAAQ,EAAE,CAAC;AACxE,CAAC,CAAC;AAUF,MAAM,OAAO,WAAY,SAAQ,OAAO,CAAC,OAAO,EAG7C,CAAC,oBAAoB,CAAC;CAAG;AAE5B,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;IACjC,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,kBAAkB,CAAC;IAChD,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC;IACrD,OAAO,EAAE,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC;CAC5C,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,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5C,OAAO;IACP,MAAM;IACN,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC;CACtC,CAAC,CAAC,EACH,MAAM,CAAC,KAAK,CACb,CACF,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAI3B,EAA4B,EAAE,CAC7B,KAAK,CAAC,OAAO,CACX,WAAW,EACX,MAAM,CAAC,OAAO,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,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,OAAO,CAAC;CAC7C,CAAC,CACH,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Proxmox VE-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds PVE's own failure
+ * shapes — see `src/protocol.ts` for how each is recognized on the wire.
+ *
+ * ★ TWO DIFFERENT WIRING STYLES, ON PURPOSE:
+ *   - `ParameterVerificationFailed` (and the plain `BadRequest` fallback
+ *     for a 400 PVE didn't attach an `errors` object to) is GLOBAL
+ *     (`commonErrorClasses`) — recognized generically in `protocol.ts`'s
+ *     `unknownError`, which core's `makeRestProtocol` reaches LAST, after
+ *     per-op `matchTypedError` and the status map both miss (never
+ *     "before per-op matching runs" — 400 is deliberately absent from
+ *     `PROXMOX_STATUS_MAP` so it always lands there). ANY write can fail
+ *     parameter verification, so patching all 680 generated operations
+ *     with the same error shape would be the RFC-6902 equivalent of
+ *     copy-pasting one line 680 times for no additional truth. `BadRequest`
+ *     matters here specifically because it is NOT retryable
+ *     (`Category.withBadRequestError`) where `UnknownProxmoxError`'s
+ *     `Category.withServerError` IS (core's default retry policy treats
+ *     `ServerError` as transient) — see `protocol.ts`'s `unknownError` for
+ *     the incident this prevents: a permanent 400 must never be retried.
+ *   - `ClusterNodeUnreachable` is added via an ACTUAL RFC-6902 patch —
+ *     `patches/nodes/task-polling.json` — to the four `/nodes/{node}/
+ *     tasks/…` operations the vendor schema itself marks `proxyto: "node"`
+ *     (this package's own `src/task.ts` polls one of them). It is NOT
+ *     global: most PVE calls are answered by the node you connected to
+ *     directly and never proxy at all, so declaring a 595 possible on
+ *     every operation would be a claim the schema does not support for
+ *     most of them. Matched purely by status (never a guessed message —
+ *     see the patch file).
+ */
+export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, Locked, NotFound, ServiceUnavailable, TooManyRequests, Unauthorized, UnprocessableEntity, HTTP_STATUS_MAP, DEFAULT_ERRORS, API_ERRORS, } from "@distilled.cloud/core/errors";
+import type { BadRequest, DefaultErrors as CoreDefaultErrors } from "@distilled.cloud/core/errors";
+import * as Schema from "effect/Schema";
+import * as Category from "@distilled.cloud/core/category";
+declare const ParameterVerificationFailed_base: Schema.Class<ParameterVerificationFailed, Schema.TaggedStruct<"ParameterVerificationFailed", {
+    readonly message: Schema.String;
+    readonly errors: Schema.$Record<Schema.String, Schema.String>;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        BadRequestError: true;
+    };
+});
+/**
+ * PVE's generic parameter-validation failure: `400` with `{"data":null,
+ * "errors":{"<param>":"<message>", …}, "message":"Parameter verification
+ * failed."}` — measured in `taslabs-net/homeflare-kit`'s
+ * `codegen/README.md` (the incident that package's whole vendor-schema
+ * pipeline exists to prevent): `PVE POST config/verify -> 400: parameter
+ * verification failed - comment: value may only be 128 characters long`.
+ * `errors` carries the per-field messages verbatim.
+ */
+export declare class ParameterVerificationFailed extends ParameterVerificationFailed_base {
+}
+declare const ClusterNodeUnreachable_base: Schema.Class<ClusterNodeUnreachable, Schema.TaggedStruct<"ClusterNodeUnreachable", {
+    readonly message: Schema.String;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        ServerError: true;
+    };
+}) & (new (...args: any[]) => {
+    "@distilled.cloud/error/retryable": Category.RetryableInfo;
+});
+/**
+ * PVE's non-standard status for a cluster-forwarded request whose target
+ * node could not be reached (`pveproxy`/`pvedaemon` proxying — every
+ * endpoint the vendor schema marks `proxyto` can answer this). Standard
+ * HTTP has no 595; this is PVE's own convention, matched purely by status
+ * (never guessed message text — see `protocol.ts`). Treated as transient:
+ * the node the request was forwarded to may simply be mid-reboot or
+ * between cluster-membership changes.
+ */
+export declare class ClusterNodeUnreachable extends ClusterNodeUnreachable_base {
+}
+declare const UnknownProxmoxError_base: Schema.Class<UnknownProxmoxError, Schema.TaggedStruct<"UnknownProxmoxError", {
+    readonly status: Schema.optional<Schema.Number>;
+    readonly message: Schema.optional<Schema.String>;
+    readonly body: Schema.Unknown;
+}>, import("effect/Cause").YieldableError> & (new (...args: any[]) => {
+    "@distilled.cloud/error/categories": {
+        ServerError: true;
+    };
+});
+/**
+ * Unknown Proxmox error — returned when a failed response's HTTP status has
+ * no mapped error class. Carries the raw body for later cataloging.
+ */
+export declare class UnknownProxmoxError extends UnknownProxmoxError_base {
+}
+declare const ProxmoxParseError_base: Schema.Class<ProxmoxParseError, Schema.TaggedStruct<"ProxmoxParseError", {
+    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 ProxmoxParseError extends ProxmoxParseError_base {
+}
+declare const ProxmoxTaskFailed_base: Schema.Class<ProxmoxTaskFailed, Schema.TaggedStruct<"ProxmoxTaskFailed", {
+    readonly node: Schema.String;
+    readonly upid: Schema.String;
+    readonly exitstatus: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * A polled task ended with an `exitstatus` other than exactly `"OK"` — see
+ * `src/task.ts`. `exitstatus` carries PVE's own failure text verbatim
+ * (e.g. `"job errors"`, `"OK (warnings)"` — the latter is why the compare
+ * is exact-equality against `"OK"`, never a prefix/substring check).
+ */
+export declare class ProxmoxTaskFailed extends ProxmoxTaskFailed_base {
+}
+/**
+ * Errors any Proxmox operation may surface in addition to the per-operation
+ * typed status errors.
+ */
+export type ClientErrors = UnknownProxmoxError | ProxmoxParseError;
+/**
+ * Default Proxmox operation errors: the shared HTTP status errors from
+ * core, PVE's global parameter-verification failure, plus the client-level
+ * fallback/decode errors. `ClusterNodeUnreachable` is NOT here — see the
+ * header: it rides only the specific operations `patches/nodes/
+ * task-polling.json` adds it to.
+ */
+export type DefaultErrors = CoreDefaultErrors | BadRequest | ParameterVerificationFailed | 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AAOtC,OAAO,KAAK,EACV,UAAU,EACV,aAAa,IAAI,iBAAiB,EACnC,MAAM,8BAA8B,CAAC;AAEtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,gCAAgC,CAAC;;;;;;;;;AAE3D;;;;;;;;GAQG;AACH,qBAAa,2BAA4B,SAAQ,gCAMb;CAAG;;;;;;;;;;AAEvC;;;;;;;;GAQG;AACH,qBAAa,sBAAuB,SAAQ,2BAKc;CAAG;;;;;;;;;;AAE7D;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,wBAOT;CAAG;;;;;;;;;AAEnC,kCAAkC;AAClC,qBAAa,iBAAkB,SAAQ,sBAMR;CAAG;;;;;;AAElC;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,sBAOtC;CAAG;AAEJ;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GACrB,iBAAiB,GACjB,UAAU,GACV,2BAA2B,GAC3B,YAAY,CAAC"}

package/dist/errors.js

@@ -0,0 +1,91 @@
+/**
+ * Proxmox VE-specific error types.
+ *
+ * Re-exports the common HTTP errors from core and adds PVE's own failure
+ * shapes — see `src/protocol.ts` for how each is recognized on the wire.
+ *
+ * ★ TWO DIFFERENT WIRING STYLES, ON PURPOSE:
+ *   - `ParameterVerificationFailed` (and the plain `BadRequest` fallback
+ *     for a 400 PVE didn't attach an `errors` object to) is GLOBAL
+ *     (`commonErrorClasses`) — recognized generically in `protocol.ts`'s
+ *     `unknownError`, which core's `makeRestProtocol` reaches LAST, after
+ *     per-op `matchTypedError` and the status map both miss (never
+ *     "before per-op matching runs" — 400 is deliberately absent from
+ *     `PROXMOX_STATUS_MAP` so it always lands there). ANY write can fail
+ *     parameter verification, so patching all 680 generated operations
+ *     with the same error shape would be the RFC-6902 equivalent of
+ *     copy-pasting one line 680 times for no additional truth. `BadRequest`
+ *     matters here specifically because it is NOT retryable
+ *     (`Category.withBadRequestError`) where `UnknownProxmoxError`'s
+ *     `Category.withServerError` IS (core's default retry policy treats
+ *     `ServerError` as transient) — see `protocol.ts`'s `unknownError` for
+ *     the incident this prevents: a permanent 400 must never be retried.
+ *   - `ClusterNodeUnreachable` is added via an ACTUAL RFC-6902 patch —
+ *     `patches/nodes/task-polling.json` — to the four `/nodes/{node}/
+ *     tasks/…` operations the vendor schema itself marks `proxyto: "node"`
+ *     (this package's own `src/task.ts` polls one of them). It is NOT
+ *     global: most PVE calls are answered by the node you connected to
+ *     directly and never proxy at all, so declaring a 595 possible on
+ *     every operation would be a claim the schema does not support for
+ *     most of them. Matched purely by status (never a guessed message —
+ *     see the patch file).
+ */
+export { BadGateway, BadRequest, Conflict, ConfigError, Forbidden, GatewayTimeout, InternalServerError, Locked, 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";
+/**
+ * PVE's generic parameter-validation failure: `400` with `{"data":null,
+ * "errors":{"<param>":"<message>", …}, "message":"Parameter verification
+ * failed."}` — measured in `taslabs-net/homeflare-kit`'s
+ * `codegen/README.md` (the incident that package's whole vendor-schema
+ * pipeline exists to prevent): `PVE POST config/verify -> 400: parameter
+ * verification failed - comment: value may only be 128 characters long`.
+ * `errors` carries the per-field messages verbatim.
+ */
+export class ParameterVerificationFailed extends Schema.TaggedError()("ParameterVerificationFailed", {
+    message: Schema.String,
+    errors: Schema.Record(Schema.String, Schema.String),
+}).pipe(Category.withBadRequestError) {
+}
+/**
+ * PVE's non-standard status for a cluster-forwarded request whose target
+ * node could not be reached (`pveproxy`/`pvedaemon` proxying — every
+ * endpoint the vendor schema marks `proxyto` can answer this). Standard
+ * HTTP has no 595; this is PVE's own convention, matched purely by status
+ * (never guessed message text — see `protocol.ts`). Treated as transient:
+ * the node the request was forwarded to may simply be mid-reboot or
+ * between cluster-membership changes.
+ */
+export class ClusterNodeUnreachable extends Schema.TaggedError()("ClusterNodeUnreachable", {
+    message: Schema.String,
+}).pipe(Category.withServerError, Category.withRetryable()) {
+}
+/**
+ * Unknown Proxmox error — returned when a failed response's HTTP status has
+ * no mapped error class. Carries the raw body for later cataloging.
+ */
+export class UnknownProxmoxError extends Schema.TaggedError()("UnknownProxmoxError", {
+    status: Schema.optional(Schema.Number),
+    message: Schema.optional(Schema.String),
+    body: Schema.Unknown,
+}).pipe(Category.withServerError) {
+}
+/** Schema parse error wrapper. */
+export class ProxmoxParseError extends Schema.TaggedError()("ProxmoxParseError", {
+    body: Schema.Unknown,
+    cause: Schema.Unknown,
+}).pipe(Category.withParseError) {
+}
+/**
+ * A polled task ended with an `exitstatus` other than exactly `"OK"` — see
+ * `src/task.ts`. `exitstatus` carries PVE's own failure text verbatim
+ * (e.g. `"job errors"`, `"OK (warnings)"` — the latter is why the compare
+ * is exact-equality against `"OK"`, never a prefix/substring check).
+ */
+export class ProxmoxTaskFailed extends Schema.TaggedError()("ProxmoxTaskFailed", {
+    node: Schema.String,
+    upid: Schema.String,
+    exitstatus: Schema.String,
+}) {
+}
+//# 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,UAAU,GACX,MAAM,8BAA8B,CAAC;AAYtC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,gCAAgC,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,OAAO,2BAA4B,SAAQ,MAAM,CAAC,WAAW,EAA+B,CAChG,6BAA6B,EAC7B;IACE,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;CACpD,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAAG;AAEvC;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAuB,SAAQ,MAAM,CAAC,WAAW,EAA0B,CACtF,wBAAwB,EACxB;IACE,OAAO,EAAE,MAAM,CAAC,MAAM;CACvB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,aAAa,EAAE,CAAC;CAAG;AAE7D;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,MAAM,CAAC,WAAW,EAAuB,CAChF,qBAAqB,EACrB;IACE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,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,iBAAkB,SAAQ,MAAM,CAAC,WAAW,EAAqB,CAC5E,mBAAmB,EACnB;IACE,IAAI,EAAE,MAAM,CAAC,OAAO;IACpB,KAAK,EAAE,MAAM,CAAC,OAAO;CACtB,CACF,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;CAAG;AAElC;;;;;GAKG;AACH,MAAM,OAAO,iBAAkB,SAAQ,MAAM,CAAC,WAAW,EAAqB,CAC5E,mBAAmB,EACnB;IACE,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,UAAU,EAAE,MAAM,CAAC,MAAM;CAC1B,CACF;CAAG"}