@misofm/api-client 0.5.1 → 0.5.3

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 2026 Miso Labs, Inc.
+
+   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,13 +1,179 @@
 # `@misofm/api-client`
 
-Typed client, schemas, and response contracts for the Miso API read layer.
+Typed ESM client, Zod schemas, and response types for the Miso read API. Every
+successful response is validated before it reaches application code, and u64/u128
+values stay decimal strings so JavaScript never silently loses precision.
+
+## Install
+
+```sh
+npm install @misofm/api-client
+```
+
+The package ships JavaScript and declarations and works directly in modern Node,
+browsers, Bun, and Workers. It requires a global `fetch`, or an injected compatible
+implementation.
+
+## Create a client
 
 ```ts
 import { createMisoApiClient } from "@misofm/api-client";
 
-const client = createMisoApiClient({ baseUrl: "https://api.testnet.miso.fm" });
+const api = createMisoApiClient({
+  baseUrl: "https://api.testnet.miso.fm",
+});
+
+const pressing = await api.getPressing(pressingId);
+if (pressing) {
+  console.log(pressing.releaseId, BigInt(pressing.supply));
+}
+```
+
+Reads for resources that may legitimately be absent return `null` on 404.
+Collection and required wallet reads return their body or throw.
+
+## Methods
+
+Singular resources use `get…`; collections use `list…`:
+
+| Area | Canonical methods |
+| --- | --- |
+| Catalog | `getPressing`, `getPressingListing`, `getRelease`, `getRecordAlbum` |
+| Artists | `getArtist`, `listArtists` |
+| Wallet | `listWalletRecords`, `listWalletParties`, `listWalletPendingMemberships`, `listWalletWorks`, `getWalletBalance`, `getWalletOwnership`, `getWalletPartyOwnership`, `getWalletRecordOwnership` |
+| Works and receipts | `getWork`, `getPurchaseReceipt` |
+
+Older names (`getListing`, `getArtists`, `getWalletRecords`,
+`getWalletParties`, `getPendingMemberships`, `getWalletWorks`, `getBalance`,
+`ownsParty`, `ownsRecord`, and `getReceipt`) remain backward-compatible aliases
+and are marked deprecated for editor-assisted migration.
+
+Relationship expansions live in the method options:
+
+```ts
+const release = await api.getRelease(releaseId, {
+  include: ["trackCredits"],
+});
+
+const album = await api.getRecordAlbum(recordId, {
+  include: ["release", "trackCredits"],
+});
+```
+
+## Cancellation and request headers
+
+Every method accepts per-call request options. Methods with relationship options
+use the same options object; `getWalletBalance` keeps its existing optional coin
+type argument and accepts request options third.
+
+```ts
+const controller = new AbortController();
+
+const profile = await api.getArtist(partyId, {
+  include: ["roles"],
+  signal: controller.signal,
+  headers: { "X-Request-ID": crypto.randomUUID() },
+});
+
+const balance = await api.getWalletBalance(address, coinType, {
+  signal: AbortSignal.timeout(5_000),
+});
+```
+
+## Errors
+
+API failures throw `MisoApiError`. Contract mismatches throw
+`MisoApiContractError`, which generally means the deployed API and client package
+need to be brought to compatible versions.
+
+```ts
+import { MisoApiContractError, MisoApiError } from "@misofm/api-client";
+
+try {
+  await api.getWalletBalance(address);
+} catch (error) {
+  if (error instanceof MisoApiError) {
+    console.error(error.status, error.code, error.message);
+    console.error("request", error.requestId);
+    if (error.retryAfter !== undefined) {
+      console.error(`retry after ${error.retryAfter} seconds`);
+    }
+  } else if (error instanceof MisoApiContractError) {
+    console.error(error.issues);
+  } else {
+    throw error;
+  }
+}
+```
+
+## Read-after-write and caching
+
+There is no global purge layer. Applications that have just completed a write can
+bump one long-lived client so its next mutable public read bypasses a pre-write
+edge entry:
+
+```ts
+import { cacheBuster, createMisoApiClient } from "@misofm/api-client";
+
+let version: string | undefined;
+const api = createMisoApiClient({
+  baseUrl: "https://api.testnet.miso.fm",
+  version: () => version,
+});
+
+await submitWrite();
+version = cacheBuster();
+const updated = await api.getArtist(partyId);
+```
+
+The `v` parameter is intentionally resource-scoped. It is added to mutable public
+reads such as artists, pressings, listings, releases, and expanded record albums.
+It is not added to private wallet reads, immutable purchase receipts, or the bare
+record-to-release relation, preventing useless cache namespaces.
+
+Use `cacheBuster()` rather than inventing a version string. The gateway accepts
+its timestamp-plus-random-nonce token through the longest public cache window,
+then safely returns to the unversioned entry. Generate it once per completed
+write and reuse it for that post-write read burst. Arbitrary strings used by
+0.5.1 clients remain compatible through one shared no-store namespace, but do
+not create attacker-controlled cache keys.
+
+For TanStack Query, use the shared cache helpers:
+
+```ts
+import {
+  READ_CACHE_CLASS,
+  queryPolicy,
+  recordAlbumQueryPolicy,
+  workCacheClass,
+} from "@misofm/api-client/cache";
+
+queryPolicy(READ_CACHE_CLASS.getPressing);
+queryPolicy(workCacheClass(release?.state));
+recordAlbumQueryPolicy(album, { include: ["release"] });
+```
+
+`READ_CACHE_CLASS.getRecordAlbum` is retained for compatibility and describes
+only an unexpanded response. Expanded release metadata is response-dependent, so
+use `recordAlbumQueryPolicy` for that case.
+
+## Schemas and types
+
+All documented subpaths are stable package exports:
+
+```ts
+import { schemas } from "@misofm/api-client";
+import { pressingViewSchema } from "@misofm/api-client/schemas";
+import { browserCacheControl, cacheControl } from "@misofm/api-client/cache";
+import type { PressingView } from "@misofm/api-client/types";
+
+const parsed: PressingView = pressingViewSchema.parse(payload);
+schemas.pressingViewSchema.parse(parsed);
+cacheControl("sale");
+browserCacheControl("sale"); // pair with the CDN-only policy in edge runtimes
 ```
 
-The package is maintained in the [`misofm/api`](https://github.com/misofm/api)
-repository. Its Zod schemas are the source of truth for responses shared by the
-read service and browser clients.
+The schemas are the source of truth shared by the read service, generated API
+description, and consumers. The package is maintained in the
+[`misofm/api`](https://github.com/misofm/api) repository and licensed under
+Apache-2.0.

package/dist/cache.d.ts

@@ -0,0 +1,71 @@
+export type CacheClass = "immutable" | "published" | "draft" | "artist" | "sale" | "private";
+export interface CachePolicy {
+    /** Shared-cache lifetime in seconds (`s-maxage`). `null` for private. */
+    sMaxAge: number | null;
+    /**
+     * How long past `sMaxAge` the edge may serve the stale body while it
+     * revalidates behind the request. This is where the latency win lives: a
+     * visitor after expiry gets the old body instantly instead of waiting on a
+     * chain round-trip.
+     */
+    staleWhileRevalidate: number | null;
+    /** Browser lifetime (`max-age`). Deliberately shorter than the edge's. */
+    maxAge: number;
+    /** TanStack Query `staleTime`, in ms. Mirrors `maxAge`. */
+    staleTimeMs: number;
+}
+export declare const CACHE_POLICIES: Record<CacheClass, CachePolicy>;
+/**
+ * The complete historical `Cache-Control` policy for a class.
+ *
+ * `private, no-store` on the private class is doing real work: `private` alone
+ * would still let a browser (or a misconfigured intermediary) retain the body,
+ * and these responses describe one wallet's holdings.
+ */
+export declare function cacheControl(cls: CacheClass): string;
+/** Browser-only policy used when an edge-specific header is emitted beside it. */
+export declare function browserCacheControl(cls: CacheClass): string;
+/**
+ * Cloudflare's edge-only cache policy.
+ *
+ * Cloudflare disables stale-while-revalidate when `s-maxage` is present, so
+ * the CDN-specific header uses `max-age` for the shared lifetime. It does not
+ * reach browsers; their shorter policy remains in {@link browserCacheControl}.
+ */
+export declare function cdnCacheControl(cls: CacheClass): string | null;
+/** TanStack Query options for a class — spread straight into `useQuery`. */
+export declare function queryPolicy(cls: CacheClass): {
+    staleTime: number;
+};
+/**
+ * A work's class from its own state. This is why the middleware picks TTL from
+ * the RESPONSE rather than the route: the same `/releases/:id` path is a
+ * year-stable published record for one id and a live draft for another.
+ */
+export declare function workCacheClass(state: {
+    type: string;
+} | null | undefined): CacheClass;
+export interface RecordAlbumCacheOptions {
+    include?: readonly ("release" | "trackCredits")[];
+}
+export interface RecordAlbumCacheValue {
+    release?: {
+        state: {
+            type: string;
+        };
+    } | null;
+}
+/**
+ * Cache class for a record-album response.
+ *
+ * The bare `recordId -> releaseId` relation is fixed at mint and immutable.
+ * Asking for either expansion embeds release metadata that can still move; its
+ * response state then selects the same published/draft policy as `getRelease`.
+ * Missing expanded data fails toward freshness rather than being cached for a
+ * year under a misleading immutable label.
+ */
+export declare function recordAlbumCacheClass(album: RecordAlbumCacheValue | null | undefined, options?: RecordAlbumCacheOptions): CacheClass;
+/** Response/options-aware TanStack Query policy for `getRecordAlbum`. */
+export declare function recordAlbumQueryPolicy(album: RecordAlbumCacheValue | null | undefined, options?: RecordAlbumCacheOptions): {
+    staleTime: number;
+};

package/dist/cache.js

@@ -0,0 +1,119 @@
+// Copyright (c) Miso Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+//
+// How long each kind of read stays good. ONE table, shared by both ends:
+//
+//   miso-read-service  turns a class into `Cache-Control` and a Cache API entry
+//   this client        turns the same class into a TanStack Query `staleTime`
+//
+// They live together because a client that refetches every 30s in front of an
+// edge that caches for 60s is just serving itself the cached body twice. Reading
+// the same numbers keeps the browser's idea of "fresh" and the edge's identical.
+//
+// The classes are chosen by WHAT MOVES THE DATA, not by route:
+//
+//   immutable   nothing can change it, ever. A record's parent release is fixed
+//               at mint; a settled transaction is settled. Cache for a year.
+//   published   a published work. Its metadata only moves when an artist
+//               deliberately re-sets an extension — rare, and a minute of
+//               staleness costs nobody anything.
+//   draft       the same work before publication: actively being edited in
+//               studio, so the editor must see their own change land.
+//   artist      a profile page. Owner edits should surface within a minute.
+//   sale        a Pressing or Listing. Their state and the uncapped run's supply
+//               can move, so clients refresh them quickly. The chain remains the
+//               purchase gate when an edge response is briefly stale.
+//   private     address-scoped. Never enters a shared cache — the failure mode is
+//               serving one user's library to another.
+//
+// THERE IS NO INVALIDATION. These TTLs are the whole freshness story: the cache
+// is an optimization, never a source of truth, and the chain stays
+// authoritative. A writer who must see their OWN change immediately appends a
+// cache-buster param, which takes a bounded no-store path instead of evicting
+// the entry everybody else is reading.
+export const CACHE_POLICIES = {
+    immutable: { sMaxAge: 31_536_000, staleWhileRevalidate: null, maxAge: 31_536_000, staleTimeMs: Number.POSITIVE_INFINITY },
+    published: { sMaxAge: 3_600, staleWhileRevalidate: 86_400, maxAge: 300, staleTimeMs: 300_000 },
+    draft: { sMaxAge: 60, staleWhileRevalidate: 300, maxAge: 0, staleTimeMs: 0 },
+    artist: { sMaxAge: 60, staleWhileRevalidate: 600, maxAge: 30, staleTimeMs: 30_000 },
+    sale: { sMaxAge: 60, staleWhileRevalidate: 300, maxAge: 0, staleTimeMs: 0 },
+    private: { sMaxAge: null, staleWhileRevalidate: null, maxAge: 0, staleTimeMs: 0 },
+};
+/**
+ * The complete historical `Cache-Control` policy for a class.
+ *
+ * `private, no-store` on the private class is doing real work: `private` alone
+ * would still let a browser (or a misconfigured intermediary) retain the body,
+ * and these responses describe one wallet's holdings.
+ */
+export function cacheControl(cls) {
+    const p = CACHE_POLICIES[cls];
+    if (p.sMaxAge === null)
+        return "private, no-store";
+    const parts = ["public", `max-age=${p.maxAge}`, `s-maxage=${p.sMaxAge}`];
+    if (p.staleWhileRevalidate !== null) {
+        parts.push(`stale-while-revalidate=${p.staleWhileRevalidate}`);
+    }
+    if (cls === "immutable")
+        parts.push("immutable");
+    return parts.join(", ");
+}
+/** Browser-only policy used when an edge-specific header is emitted beside it. */
+export function browserCacheControl(cls) {
+    const p = CACHE_POLICIES[cls];
+    if (p.sMaxAge === null)
+        return "private, no-store";
+    const parts = ["public", `max-age=${p.maxAge}`];
+    if (cls === "immutable")
+        parts.push("immutable");
+    return parts.join(", ");
+}
+/**
+ * Cloudflare's edge-only cache policy.
+ *
+ * Cloudflare disables stale-while-revalidate when `s-maxage` is present, so
+ * the CDN-specific header uses `max-age` for the shared lifetime. It does not
+ * reach browsers; their shorter policy remains in {@link browserCacheControl}.
+ */
+export function cdnCacheControl(cls) {
+    const p = CACHE_POLICIES[cls];
+    if (p.sMaxAge === null)
+        return null;
+    const parts = ["public", `max-age=${p.sMaxAge}`];
+    if (p.staleWhileRevalidate !== null) {
+        parts.push(`stale-while-revalidate=${p.staleWhileRevalidate}`);
+    }
+    if (cls === "immutable")
+        parts.push("immutable");
+    return parts.join(", ");
+}
+/** TanStack Query options for a class — spread straight into `useQuery`. */
+export function queryPolicy(cls) {
+    return { staleTime: CACHE_POLICIES[cls].staleTimeMs };
+}
+/**
+ * A work's class from its own state. This is why the middleware picks TTL from
+ * the RESPONSE rather than the route: the same `/releases/:id` path is a
+ * year-stable published record for one id and a live draft for another.
+ */
+export function workCacheClass(state) {
+    return state?.type === "Published" ? "published" : "draft";
+}
+/**
+ * Cache class for a record-album response.
+ *
+ * The bare `recordId -> releaseId` relation is fixed at mint and immutable.
+ * Asking for either expansion embeds release metadata that can still move; its
+ * response state then selects the same published/draft policy as `getRelease`.
+ * Missing expanded data fails toward freshness rather than being cached for a
+ * year under a misleading immutable label.
+ */
+export function recordAlbumCacheClass(album, options = {}) {
+    if ((options.include?.length ?? 0) === 0)
+        return "immutable";
+    return workCacheClass(album?.release?.state);
+}
+/** Response/options-aware TanStack Query policy for `getRecordAlbum`. */
+export function recordAlbumQueryPolicy(album, options = {}) {
+    return queryPolicy(recordAlbumCacheClass(album, options));
+}