@anchor-secrets/sdk 0.0.0-stage → 0.5.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Sota
+
+   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

@@ -1,3 +1,85 @@
-# Temporary Holding Version
+# @anchor-secrets/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Node client for [Anchor](https://sotarak.github.io/anchor/), a self-hosted secrets and
+configuration manager that runs on your own Cloudflare account. Use it to read a folder of
+secrets from your service, without wrapping the process in `anchor run`: values are cached,
+refreshed in the background, and kept when Anchor is unreachable. For NestJS, use
+[`@anchor-secrets/nestjs`](https://www.npmjs.com/package/@anchor-secrets/nestjs), which is built on
+this package.
+
+## Install
+
+```sh
+npm install @anchor-secrets/sdk
+```
+
+Requires Node.js 20 or later. ESM and CommonJS, with types; no runtime dependencies.
+
+## Use
+
+Create a `read` service token for the environment and folder (dashboard → project → Service
+tokens, or `anchor tokens create`), and give the service two variables:
+
+```sh
+ANCHOR_API_URL=https://anchor.example.com
+ANCHOR_TOKEN=anc_st_...
+```
+
+```ts
+import { createAnchorClient } from "@anchor-secrets/sdk";
+
+const anchor = createAnchorClient(); // reads ANCHOR_API_URL and ANCHOR_TOKEN
+const folder = await anchor.folder({ project: "shop", environment: "prod", path: "/api" });
+
+folder.get<string>("DATABASE_URL"); // synchronous, never waits for the network
+```
+
+- `client.folder(query)` loads once and returns an `AnchorFolder`: `get`, `getOrThrow`, `has`,
+  `keys`, `toObject` (frozen all the way down) and `refresh()`. A read of values older than the
+  cache ttl returns them at once and starts one background refresh; there is no timer.
+- A refresh sends the folder's last `ETag` as `If-None-Match`. When nothing changed, Anchor
+  answers `304` with no body and the cached values are kept. `cache: false` sends no
+  `If-None-Match`.
+- `loadSecrets(query)` returns `{ KEY: value }` with typed values decoded: `number` and `boolean`
+  become numbers and booleans, `json` and `list` are parsed, `string` and `pem` stay strings.
+  `listSecrets(query)` returns the secrets with their metadata (`key`, `path`, `type`,
+  `sensitive`, `version`, `value` as a string, `importedFrom`). Both take `{ signal, fresh }`.
+- `query` is `{ project, environment, path?, expand?, includeImports? }`. `path` defaults to `/`;
+  `${...}` references are expanded and folder imports are included unless you pass `false`.
+
+## Options
+
+```ts
+createAnchorClient({
+  apiUrl, // default ANCHOR_API_URL
+  token, // default ANCHOR_TOKEN
+  timeoutMs: 10_000, // per attempt
+  retry: { attempts: 3, baseDelayMs: 250, maxDelayMs: 5_000 }, // or false
+  cache: { ttlMs: 60_000, maxStaleMs: Infinity }, // or false; store: a custom CacheStore
+  onEvent: (event) => {}, // "retry", "refresh_failed" and "store_failed"
+  fetch, // replaces the global fetch
+});
+```
+
+- **Cache:** in memory, per client, keyed by a fingerprint of the token (never the token).
+  Concurrent reads of one folder share a request. A custom `CacheStore` receives plaintext
+  values: encrypt them. A store that throws never fails a read (`store_failed` is emitted).
+- **Failures:** network errors, timeouts and HTTP 429/502/503/504 are retried with jittered
+  backoff, honoring `Retry-After`. When a refresh fails, the last good values are served (up to
+  `maxStaleMs` past the ttl; past it a folder read throws code `stale`), `refresh_failed` is
+  emitted, and Anchor is not asked again for one ttl. The first load has nothing to fall back on
+  and throws.
+
+## Errors
+
+Every failure is an `AnchorError` with `status` (0 when there was no response), `code` and
+`retryable`: `config` (URL or token missing, before any request), `network`, `timeout`,
+`aborted`, `stale`, or the server's error code such as `unauthenticated`, `forbidden` or `not_found`.
+Messages and events never contain tokens or values.
+
+Every request that returns values is recorded in the project's audit log under the token's
+name. A `304` returns no values and is not recorded.
+
+## License
+
+Apache-2.0

package/dist/NOTICE

@@ -0,0 +1,18 @@
+Anchor
+Copyright 2026 Sota
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This repository also contains third-party material, distributed under its own license:
+
+- Agent skills vendored under .claude/skills/ from obra/superpowers
+  (https://github.com/obra/superpowers), Copyright (c) 2025 Jesse Vincent, MIT License.
+  See .claude/THIRD_PARTY_LICENSES/obra-superpowers-MIT.txt.
+- Agent skills vendored under .claude/skills/ from cloudflare/skills
+  (https://github.com/cloudflare/skills), (c) Cloudflare, Apache License 2.0.
+  See .claude/THIRD_PARTY_LICENSES/cloudflare-skills-Apache-2.0.txt.
+- Dashboard design token values and component recipes adapted from the Novu dashboard
+  (novuhq/novu, https://github.com/novuhq/novu, apps/dashboard), Copyright (c) 2019 Noti-fire
+  Apps Ltd., MIT License. See .claude/THIRD_PARTY_LICENSES/novu-MIT.txt.
+
+.claude/VENDORED.md lists the exact upstream commits and local modifications.

package/dist/cache.d.cts

@@ -0,0 +1,47 @@
+import type { AnchorEvent, AnchorSecret, CacheEntry, CacheOptions, CacheStore, ListQuery } from "./types.cjs";
+export type { CacheEntry, CacheOptions, CacheStore } from "./types.cjs";
+export type CachePolicy = Required<CacheOptions>;
+/** What a fetch got from Anchor: new secrets and their tag, or a 304 for the tag it sent. */
+export type Fetched = {
+    secrets: AnchorSecret[];
+    etag?: string;
+} | "unchanged";
+type FetchFn = (signal: AbortSignal, etag: string | undefined) => Promise<Fetched>;
+export declare function memoryStore(): CacheStore;
+/**
+ * The cache key of one folder as one token sees it. The token is reduced to a SHA-256
+ * fingerprint, so two tokens never share an entry and the key never holds a credential.
+ */
+export declare function cacheKey(origin: string, token: string, q: Required<ListQuery>): string;
+/**
+ * Serves folders from `store` while they are fresh, coalesces concurrent fetches of one folder,
+ * and falls back to the last good entry when a fetch fails. Coalescing and cooldowns are per
+ * instance, never in the store.
+ */
+export declare class SecretCache {
+    private readonly policy;
+    private readonly emit;
+    private readonly now;
+    private readonly inflight;
+    /** When the last fetch of a key failed; the stale entry is served without asking for one ttl. */
+    private readonly failedAt;
+    /** The newest entry this instance fetched per key, in case the store returns an older one. */
+    private readonly latest;
+    constructor(policy: CachePolicy, emit: (event: AnchorEvent) => void, now?: () => number);
+    /**
+     * The folder's entry. With `strict`, a failed fetch rejects instead of falling back, so a
+     * caller that asked for new values learns it did not get them.
+     */
+    load(key: string, fetch: FetchFn, opts?: {
+        fresh?: boolean;
+        signal?: AbortSignal;
+        strict?: boolean;
+    }): Promise<CacheEntry>;
+    private start;
+    /** A store that fails is a miss: Anchor stays reachable when Redis (or a file) is not. */
+    private read;
+    private write;
+    private servable;
+    private usable;
+    private fetch;
+}

package/dist/cache.d.ts

@@ -0,0 +1,47 @@
+import type { AnchorEvent, AnchorSecret, CacheEntry, CacheOptions, CacheStore, ListQuery } from "./types.js";
+export type { CacheEntry, CacheOptions, CacheStore } from "./types.js";
+export type CachePolicy = Required<CacheOptions>;
+/** What a fetch got from Anchor: new secrets and their tag, or a 304 for the tag it sent. */
+export type Fetched = {
+    secrets: AnchorSecret[];
+    etag?: string;
+} | "unchanged";
+type FetchFn = (signal: AbortSignal, etag: string | undefined) => Promise<Fetched>;
+export declare function memoryStore(): CacheStore;
+/**
+ * The cache key of one folder as one token sees it. The token is reduced to a SHA-256
+ * fingerprint, so two tokens never share an entry and the key never holds a credential.
+ */
+export declare function cacheKey(origin: string, token: string, q: Required<ListQuery>): string;
+/**
+ * Serves folders from `store` while they are fresh, coalesces concurrent fetches of one folder,
+ * and falls back to the last good entry when a fetch fails. Coalescing and cooldowns are per
+ * instance, never in the store.
+ */
+export declare class SecretCache {
+    private readonly policy;
+    private readonly emit;
+    private readonly now;
+    private readonly inflight;
+    /** When the last fetch of a key failed; the stale entry is served without asking for one ttl. */
+    private readonly failedAt;
+    /** The newest entry this instance fetched per key, in case the store returns an older one. */
+    private readonly latest;
+    constructor(policy: CachePolicy, emit: (event: AnchorEvent) => void, now?: () => number);
+    /**
+     * The folder's entry. With `strict`, a failed fetch rejects instead of falling back, so a
+     * caller that asked for new values learns it did not get them.
+     */
+    load(key: string, fetch: FetchFn, opts?: {
+        fresh?: boolean;
+        signal?: AbortSignal;
+        strict?: boolean;
+    }): Promise<CacheEntry>;
+    private start;
+    /** A store that fails is a miss: Anchor stays reachable when Redis (or a file) is not. */
+    private read;
+    private write;
+    private servable;
+    private usable;
+    private fetch;
+}

package/dist/client.d.cts

@@ -0,0 +1,14 @@
+import type { AnchorClient, AnchorEvent, CacheEntry, ClientOptions, ListQuery, RequestOptions } from "./types.cjs";
+/** The client's internals that `folder()` builds on. */
+export type ClientCore = {
+    /** `strict`: a failed fetch rejects instead of returning the cached fallback. */
+    loadEntry(q: ListQuery, o?: RequestOptions & {
+        strict?: boolean;
+    }): Promise<CacheEntry>;
+    ttlMs: number;
+    /** How long past `ttlMs` a folder may serve values after a failed refresh. */
+    maxStaleMs: number;
+    emit: (event: AnchorEvent) => void;
+};
+export declare function createClientCore(options: ClientOptions): ClientCore;
+export declare function createAnchorClient(options?: ClientOptions): AnchorClient;

package/dist/client.d.ts

@@ -0,0 +1,14 @@
+import type { AnchorClient, AnchorEvent, CacheEntry, ClientOptions, ListQuery, RequestOptions } from "./types.js";
+/** The client's internals that `folder()` builds on. */
+export type ClientCore = {
+    /** `strict`: a failed fetch rejects instead of returning the cached fallback. */
+    loadEntry(q: ListQuery, o?: RequestOptions & {
+        strict?: boolean;
+    }): Promise<CacheEntry>;
+    ttlMs: number;
+    /** How long past `ttlMs` a folder may serve values after a failed refresh. */
+    maxStaleMs: number;
+    emit: (event: AnchorEvent) => void;
+};
+export declare function createClientCore(options: ClientOptions): ClientCore;
+export declare function createAnchorClient(options?: ClientOptions): AnchorClient;

package/dist/config.d.cts

@@ -0,0 +1,23 @@
+import { type CachePolicy } from "./cache.cjs";
+import { type RetryPolicy } from "./retry.cjs";
+import type { AnchorEvent, CacheOptions, ClientOptions, RetryOptions } from "./types.cjs";
+export declare const DEFAULT_TIMEOUT_MS = 10000;
+export type Config = {
+    base: string;
+    origin: string;
+    token: string;
+    fetch: typeof fetch;
+    timeoutMs: number;
+    retry: RetryPolicy | false;
+    onEvent?: (event: AnchorEvent) => void;
+};
+export declare function resolveConfig(opts: ClientOptions): Config;
+/** The retry settings with defaults filled in, or `false` when retries are off. */
+export declare function retryPolicy(retry: RetryOptions | false | undefined): RetryPolicy | false;
+/** Checks every numeric option once, when the client is created. */
+export declare function validateOptions(opts: ClientOptions): void;
+/** Calls the event hook; a hook that throws never breaks a request. */
+export declare function emitSafely(onEvent: ((event: AnchorEvent) => void) | undefined, event: AnchorEvent): void;
+export declare const DEFAULT_TTL_MS = 60000;
+/** The cache settings with defaults filled in, or `false` when caching is off. */
+export declare function cachePolicy(cache: CacheOptions | false | undefined): CachePolicy | false;

package/dist/config.d.ts

@@ -0,0 +1,23 @@
+import { type CachePolicy } from "./cache.js";
+import { type RetryPolicy } from "./retry.js";
+import type { AnchorEvent, CacheOptions, ClientOptions, RetryOptions } from "./types.js";
+export declare const DEFAULT_TIMEOUT_MS = 10000;
+export type Config = {
+    base: string;
+    origin: string;
+    token: string;
+    fetch: typeof fetch;
+    timeoutMs: number;
+    retry: RetryPolicy | false;
+    onEvent?: (event: AnchorEvent) => void;
+};
+export declare function resolveConfig(opts: ClientOptions): Config;
+/** The retry settings with defaults filled in, or `false` when retries are off. */
+export declare function retryPolicy(retry: RetryOptions | false | undefined): RetryPolicy | false;
+/** Checks every numeric option once, when the client is created. */
+export declare function validateOptions(opts: ClientOptions): void;
+/** Calls the event hook; a hook that throws never breaks a request. */
+export declare function emitSafely(onEvent: ((event: AnchorEvent) => void) | undefined, event: AnchorEvent): void;
+export declare const DEFAULT_TTL_MS = 60000;
+/** The cache settings with defaults filled in, or `false` when caching is off. */
+export declare function cachePolicy(cache: CacheOptions | false | undefined): CachePolicy | false;

package/dist/decode.d.cts

@@ -0,0 +1,16 @@
+import type { AnchorSecret, AnchorValue, AnchorValueType } from "./types.cjs";
+export type WireSecret = {
+    key: string;
+    path: string;
+    type: AnchorValueType;
+    sensitive: boolean;
+    version: number;
+    value?: string;
+    importedFrom?: {
+        environment: string;
+        path: string;
+    };
+};
+export declare function toSecret(s: WireSecret): AnchorSecret;
+/** `{ KEY: value }` with typed values decoded. The first secret of a key wins. */
+export declare function decodeAll(secrets: AnchorSecret[]): Record<string, AnchorValue>;

package/dist/decode.d.ts

@@ -0,0 +1,16 @@
+import type { AnchorSecret, AnchorValue, AnchorValueType } from "./types.js";
+export type WireSecret = {
+    key: string;
+    path: string;
+    type: AnchorValueType;
+    sensitive: boolean;
+    version: number;
+    value?: string;
+    importedFrom?: {
+        environment: string;
+        path: string;
+    };
+};
+export declare function toSecret(s: WireSecret): AnchorSecret;
+/** `{ KEY: value }` with typed values decoded. The first secret of a key wins. */
+export declare function decodeAll(secrets: AnchorSecret[]): Record<string, AnchorValue>;

package/dist/errors.d.cts

@@ -0,0 +1,23 @@
+export type AnchorErrorOptions = {
+    cause?: unknown;
+    /** Whether repeating the request may succeed; default `false`. */
+    retryable?: boolean;
+    /** How long the server asked the client to wait (`Retry-After`). */
+    retryAfterMs?: number;
+};
+/**
+ * Every failure of the client. `code` is `config`, `network`, `timeout`, `aborted`, `stale`,
+ * `bad_response`, `http_error` or the API's error code (`unauthenticated`, `forbidden`,
+ * `not_found`, ...). `status` is the HTTP status, or 0 when there was no response. Messages never
+ * contain tokens or values.
+ */
+export declare class AnchorError extends Error {
+    readonly status: number;
+    readonly code: string;
+    /** Whether repeating the request may succeed (network, timeout, 429, 502, 503, 504). */
+    readonly retryable: boolean;
+    /** The server's `Retry-After`, in milliseconds, when it sent one. */
+    readonly retryAfterMs?: number;
+    constructor(status: number, code: string, message: string, options?: AnchorErrorOptions);
+}
+export declare const abortedError: () => AnchorError;

package/dist/errors.d.ts

@@ -0,0 +1,23 @@
+export type AnchorErrorOptions = {
+    cause?: unknown;
+    /** Whether repeating the request may succeed; default `false`. */
+    retryable?: boolean;
+    /** How long the server asked the client to wait (`Retry-After`). */
+    retryAfterMs?: number;
+};
+/**
+ * Every failure of the client. `code` is `config`, `network`, `timeout`, `aborted`, `stale`,
+ * `bad_response`, `http_error` or the API's error code (`unauthenticated`, `forbidden`,
+ * `not_found`, ...). `status` is the HTTP status, or 0 when there was no response. Messages never
+ * contain tokens or values.
+ */
+export declare class AnchorError extends Error {
+    readonly status: number;
+    readonly code: string;
+    /** Whether repeating the request may succeed (network, timeout, 429, 502, 503, 504). */
+    readonly retryable: boolean;
+    /** The server's `Retry-After`, in milliseconds, when it sent one. */
+    readonly retryAfterMs?: number;
+    constructor(status: number, code: string, message: string, options?: AnchorErrorOptions);
+}
+export declare const abortedError: () => AnchorError;

package/dist/folder.d.cts

@@ -0,0 +1,7 @@
+import type { ClientCore } from "./client.cjs";
+import type { AnchorFolder, ListQuery } from "./types.cjs";
+/** Freezes plain objects and arrays all the way down: one folder's values are shared by every reader. */
+export declare function deepFreeze<T>(value: T): T;
+export declare function openFolder(core: ClientCore, query: ListQuery, options?: {
+    signal?: AbortSignal;
+}): Promise<AnchorFolder>;

package/dist/folder.d.ts

@@ -0,0 +1,7 @@
+import type { ClientCore } from "./client.js";
+import type { AnchorFolder, ListQuery } from "./types.js";
+/** Freezes plain objects and arrays all the way down: one folder's values are shared by every reader. */
+export declare function deepFreeze<T>(value: T): T;
+export declare function openFolder(core: ClientCore, query: ListQuery, options?: {
+    signal?: AbortSignal;
+}): Promise<AnchorFolder>;