radosgw-admin 0.1.0 → 0.2.0

package/LICENSE

@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -32,9 +33,10 @@
       not limited to compiled object code, generated documentation,
       and conversions to other media types.
 
-      "Work" shall mean the work of authorship 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).
+      "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
@@ -44,21 +46,23 @@
       separable from, or merely link (or bind by name) to the interfaces of,
       the Work and Derivative Works thereof.
 
-      "Contribution" shall mean, as submitted to the 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 designated in writing by the copyright owner as "Not a
-      Contribution."
-
-      "Contributor" shall mean Licensor and any Legal Entity on behalf of
-      whom a Contribution has been received by the Licensor and included
-      within the Work.
+      "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,
@@ -72,21 +76,24 @@
       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 contributions
-      Licensors made to the Work. 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.
+      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
+      (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
@@ -98,26 +105,28 @@
           the Derivative Works; and
 
       (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, You must include a readable copy of the
-          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
-      may provide additional grant of rights to use, copy, modify, merge,
-      publish, distribute, sublicense, and/or sell copies of the
-      Derivative Works, and to permit persons to whom the Derivative Works
-      is furnished to do so, subject to Your own terms and conditions.
+          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
@@ -139,7 +148,7 @@
       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 reproducing the Work and assume any
+      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,
@@ -147,27 +156,38 @@
       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 exemplary damages of any character arising as a
+      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 all other
-      commercial damages or losses), even if such Contributor has been
-      advised of the possibility of such damages.
+      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 offer such
-      conditions 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.
+      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
 
-   Copyright 2026 nycanshu <hkg43700@gmail.com>
+   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.

package/README.md

@@ -1,9 +1,11 @@
 # radosgw-admin
 
-> Modern, zero-dependency TypeScript client for the Ceph RADOS Gateway Admin Ops API.
+> Node.js SDK for the Ceph RADOS Gateway Admin Ops API — manage users, buckets, quotas, rate limits and access keys programmatically.
 
 [![CI](https://github.com/nycanshu/radosgw-admin/actions/workflows/ci.yml/badge.svg)](https://github.com/nycanshu/radosgw-admin/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/nycanshu/radosgw-admin/graph/badge.svg)](https://codecov.io/gh/nycanshu/radosgw-admin)
 [![npm version](https://img.shields.io/npm/v/radosgw-admin)](https://www.npmjs.com/package/radosgw-admin)
+[![npm downloads](https://img.shields.io/npm/dm/radosgw-admin)](https://www.npmjs.com/package/radosgw-admin)
 [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue)](https://www.typescriptlang.org/)
 
@@ -15,17 +17,25 @@ The only existing npm package for RGW Admin Ops (`rgw-admin-client`) was last pu
 
 **What you get:**
 
-- [RGW Admin Ops API](https://docs.ceph.com/en/latest/radosgw/adminops/) coverage — users, keys, subusers, buckets, quotas, rate limits
-- Strict TypeScript with zero `any` — every request and response is fully typed
+- Full [RGW Admin Ops API](https://docs.ceph.com/en/latest/radosgw/adminops/) coverage — users, keys, subusers, buckets, quotas, rate limits
 - Zero runtime dependencies — AWS SigV4 signing uses only `node:crypto`
-- Dual ESM + CJS build — works in every Node.js environment
-- Automatic snake_case/camelCase conversion — idiomatic JS API over RGW's REST interface
+- Request hooks — add logging, Prometheus metrics, or audit trails via `onBeforeRequest`/`onAfterResponse`
+- Health check — `rgw.healthCheck()` for one-liner connectivity verification
 - Structured error hierarchy — catch specific failures, not generic HTTP errors
+- Automatic snake_case/camelCase conversion — idiomatic JS API over RGW's REST interface
+- TypeScript with strict types and zero `any` — every request and response is fully typed
+- Dual ESM + CJS build — works in every Node.js environment
 
 ## Install
 
 ```bash
 npm install radosgw-admin
+# or
+yarn add radosgw-admin
+# or
+pnpm add radosgw-admin
+# or
+bun add radosgw-admin
 ```
 
 Requires **Node.js >= 18** and a Ceph RGW instance with the Admin Ops API enabled.
@@ -78,7 +88,10 @@ const rgw = new RadosGWAdminClient({
   insecure: false, // Optional — skip TLS verification (default: false)
   debug: false, // Optional — enable request/response logging (default: false)
   maxRetries: 3, // Optional — retry transient errors (default: 0)
-  retryDelay: 200, // Optional — base delay for exponential backoff in ms (default: 200)
+  retryDelay: 200, // Optional — base delay for exponential backoff w/ jitter in ms (default: 200)
+  userAgent: 'my-app/1.0', // Optional — custom User-Agent (default: "radosgw-admin/<ver> node/<ver>")
+  onBeforeRequest: [(ctx) => {}], // Optional — hooks called before each request
+  onAfterResponse: [(ctx) => {}], // Optional — hooks called after each response
 });
 ```
 
@@ -369,16 +382,67 @@ try {
 }
 ```
 
-| Error Class          | HTTP Status     | Condition                                |
-| -------------------- | --------------- | ---------------------------------------- |
-| `RGWValidationError` | _(pre-request)_ | Invalid input (missing uid, bad params)  |
-| `RGWNotFoundError`   | 404             | Resource does not exist                  |
-| `RGWConflictError`   | 409             | Resource already exists                  |
-| `RGWAuthError`       | 403             | Insufficient credentials or capabilities |
-| `RGWError`           | 5xx             | Server-side failure                      |
+| Error Class          | HTTP Status     | Retryable | Condition                                |
+| -------------------- | --------------- | --------- | ---------------------------------------- |
+| `RGWValidationError` | 400 / _(pre-request)_ | No        | Invalid input (missing uid, bad params)  |
+| `RGWNotFoundError`   | 404             | No        | Resource does not exist                  |
+| `RGWConflictError`   | 409             | No        | Resource already exists                  |
+| `RGWAuthError`       | 403             | No        | Insufficient credentials or capabilities |
+| `RGWRateLimitError`  | 429             | Yes       | Rate limit exceeded                      |
+| `RGWServiceError`    | 5xx             | Yes       | RGW server error                         |
+
+All errors include a `code` field with the RGW error code (e.g., `NoSuchUser`, `BucketAlreadyExists`, `SlowDown`).
 
 > **Note:** Destructive operations (`purgeData`, `purgeObjects`) emit a `console.warn` before executing. To suppress in CI/automation, redirect stderr or patch `console.warn`.
 
+## Health Check
+
+Verify RGW connectivity before running operations:
+
+```typescript
+const ok = await rgw.healthCheck();
+if (!ok) throw new Error('Cannot reach RGW');
+```
+
+## Request Hooks
+
+Add logging, metrics, or telemetry without modifying the SDK:
+
+```typescript
+const rgw = new RadosGWAdminClient({
+  host: 'http://rgw:8080',
+  accessKey: '...',
+  secretKey: '...',
+  onBeforeRequest: [
+    (ctx) => console.log(`→ ${ctx.method} ${ctx.path}`),
+  ],
+  onAfterResponse: [
+    (ctx) => console.log(`← ${ctx.status} in ${ctx.durationMs}ms`),
+  ],
+});
+```
+
+Hooks run on **every request across all modules**. If a hook throws, the error is swallowed — hooks never break RGW operations.
+
+Hook context includes: `method`, `path`, `url`, `query`, `attempt` (retry number), `startTime`, and for after-hooks: `status`, `durationMs`, `error`.
+
+> **Security note:** Hook context includes the full request URL which may contain sensitive query parameters (e.g. `secret-key` when creating users with pre-specified credentials). If you log or send hook data to external systems, redact sensitive fields. The SDK already redacts `secret-key` from its own debug logs, but hooks receive the raw URL.
+
+## Request Cancellation
+
+Pass an `AbortSignal` to cancel in-flight requests:
+
+```typescript
+const controller = new AbortController();
+setTimeout(() => controller.abort(), 5000);
+
+await rgw._client.request({
+  method: 'GET',
+  path: '/user',
+  signal: controller.signal,
+});
+```
+
 ## Compatibility
 
 Tested against Ceph **Quincy (v17)** and **Reef (v18)**. The Admin Ops API is available in all Ceph releases with RGW.
@@ -389,6 +453,102 @@ Tested against Ceph **Quincy (v17)** and **Reef (v18)**. The Admin Ops API is av
 - Admin Ops API must be accessible (default path: `/admin`)
 - For `insecure: true` — only use with self-signed certificates in dev/test environments
 
+## FAQ
+
+<details>
+<summary><strong>How do I connect to an RGW with a self-signed certificate?</strong></summary>
+
+Set `insecure: true` in the client config. This skips TLS certificate verification — use only in dev/test environments:
+
+```typescript
+const rgw = new RadosGWAdminClient({
+  host: 'https://rgw.internal',
+  accessKey: '...',
+  secretKey: '...',
+  insecure: true, // skips TLS verification
+});
+```
+
+</details>
+
+<details>
+<summary><strong>Which Ceph versions are supported?</strong></summary>
+
+The Admin Ops API has been available since Ceph **Luminous (v12)**. This package is tested against **Quincy (v17)** and **Reef (v18)**.
+
+| Feature | Minimum Ceph Version |
+|---|---|
+| Users, keys, subusers, buckets | Luminous (v12) |
+| Quotas | Luminous (v12) |
+| Rate limits | Pacific (v16) |
+| Usage logging | Luminous (v12) |
+
+</details>
+
+<details>
+<summary><strong>How do I troubleshoot connection issues?</strong></summary>
+
+Enable debug mode to see full HTTP request/response details:
+
+```typescript
+const rgw = new RadosGWAdminClient({
+  host: 'http://rgw.example.com',
+  accessKey: '...',
+  secretKey: '...',
+  debug: true, // logs request method, URL, headers, and response
+});
+```
+
+Common issues:
+- **403 AccessDenied** — admin user lacks required capabilities. Grant with: `radosgw-admin caps add --uid=admin --caps="users=*;buckets=*"`
+- **Connection refused** — check host/port and that the RGW daemon is running
+- **Timeout** — increase the `timeout` value (default: 10000ms) or check network connectivity
+
+</details>
+
+<details>
+<summary><strong>Can I use this with Rook-Ceph on Kubernetes?</strong></summary>
+
+Yes. Port-forward or expose the RGW service, then point the client at it:
+
+```bash
+kubectl port-forward svc/rook-ceph-rgw-my-store 8080:80 -n rook-ceph
+```
+
+```typescript
+const rgw = new RadosGWAdminClient({
+  host: 'http://localhost',
+  port: 8080,
+  accessKey: '...',
+  secretKey: '...',
+});
+```
+
+To get admin credentials from Rook:
+```bash
+kubectl get secret rook-ceph-dashboard-admin-gateway -n rook-ceph -o jsonpath='{.data.accessKey}' | base64 -d
+kubectl get secret rook-ceph-dashboard-admin-gateway -n rook-ceph -o jsonpath='{.data.secretKey}' | base64 -d
+```
+
+</details>
+
+<details>
+<summary><strong>Does this package work with OpenShift Data Foundation (ODF)?</strong></summary>
+
+Yes. ODF uses Ceph under the hood. Point the client at the RGW route or service endpoint. The admin credentials are stored in the `ocs-storagecluster-ceph-rgw-admin-ops-user` secret in the `openshift-storage` namespace.
+
+</details>
+
+<details>
+<summary><strong>Why zero dependencies?</strong></summary>
+
+AWS SigV4 signing is implemented using only `node:crypto` (built-in). No `aws-sdk`, no `axios`, no `node-fetch`. This means:
+- Smaller `node_modules` footprint
+- No supply chain risk from transitive dependencies
+- No version conflicts with other packages in your project
+
+</details>
+
 ## Development
 
 ```bash