@misofm/api-client 0.4.1 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@misofm/api-client",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Typed client and response contract for the Miso API read layer. The one definition of what a Miso read returns.",
   "license": "Apache-2.0",
   "repository": {

package/src/client.test.ts

@@ -79,30 +79,22 @@ describe("URL construction", () => {
   test("joins catalog relationship expansions into one param", async () => {
     const { fetch, calls } = stubFetch({ status: 404 });
     const client = createMisoApiClient({ baseUrl: BASE, fetch });
-    await client.getPressing("0xp", { include: ["trackCredits"] });
     await client.getRelease("0xl", { include: ["trackCredits"] });
     await client.getRecordAlbum("0xr", {
       include: ["release", "trackCredits"],
     });
     expect(calls[0]).toContain("include=trackCredits");
-    expect(calls[1]).toContain("include=trackCredits");
-    expect(calls[2]).toContain("include=release%2CtrackCredits");
+    expect(calls[1]).toContain("include=release%2CtrackCredits");
   });
 
-  test("uses the permanent pressing preview route", async () => {
+  test("passes the currency to the modular Listing route", async () => {
     const { fetch, calls } = stubFetch({ status: 404 });
-    await createMisoApiClient({ baseUrl: BASE, fetch }).getPressingPreview("0xp");
-    expect(calls[0]).toBe(`${BASE}/read/v1/pressings/0xp/preview`);
-  });
-
-  test("passes the Listing currency to the pressing sale route", async () => {
-    const { fetch, calls } = stubFetch({ status: 404 });
-    await createMisoApiClient({ baseUrl: BASE, fetch }).getPressingSale(
+    await createMisoApiClient({ baseUrl: BASE, fetch }).getListing(
       "0xp",
       "0x2::sui::SUI",
     );
     expect(calls[0]).toBe(
-      `${BASE}/read/v1/pressings/0xp/sale?currencyType=0x2%3A%3Asui%3A%3ASUI`,
+      `${BASE}/read/v1/pressings/0xp/listing?currencyType=0x2%3A%3Asui%3A%3ASUI`,
     );
   });
 
@@ -154,9 +146,9 @@ describe("error handling", () => {
       body: { error: { code: "rate-limited", message: "Too many requests." } },
     });
     const api = createMisoApiClient({ baseUrl: BASE, fetch });
-    await expect(api.getDiscover()).rejects.toThrow(MisoApiError);
+    await expect(api.getPressing("0xp")).rejects.toThrow(MisoApiError);
     try {
-      await api.getDiscover();
+      await api.getPressing("0xp");
     } catch (e) {
       expect(e).toBeInstanceOf(MisoApiError);
       expect((e as MisoApiError).status).toBe(429);
@@ -168,7 +160,7 @@ describe("error handling", () => {
   test("an error body in an unexpected shape still throws a usable error", async () => {
     const { fetch } = stubFetch({ status: 500, body: { oops: true } });
     try {
-      await createMisoApiClient({ baseUrl: BASE, fetch }).getDiscover();
+      await createMisoApiClient({ baseUrl: BASE, fetch }).getPressing("0xp");
       throw new Error("should have thrown");
     } catch (e) {
       expect(e).toBeInstanceOf(MisoApiError);
@@ -248,8 +240,8 @@ describe("READ_CACHE_CLASS", () => {
   });
 
   test("live sale reads are the sale class", () => {
-    expect(READ_CACHE_CLASS.getDiscover).toBe("sale");
     expect(READ_CACHE_CLASS.getPressing).toBe("sale");
+    expect(READ_CACHE_CLASS.getListing).toBe("sale");
   });
 });
 

package/src/client.ts

@@ -4,7 +4,7 @@
 // The typed client for the Miso read API. One of these per app.
 //
 //   const api = createMisoApiClient({ baseUrl: "https://api.testnet.miso.fm" })
-//   const shelf = await api.getDiscover()
+//   const pressing = await api.getPressing("0x…")
 //
 // Every method returns a PARSED, validated body. Validation on the client is not
 // paranoia about our own server — it is what turns a silent contract break into a
@@ -21,16 +21,14 @@ import { queryPolicy, type CacheClass } from "./cache.ts";
 import type {
   ArtistProfile,
   Balance,
-  DiscoverShelf,
-  PressingPreview,
+  ListingView,
   OwnedParty,
   PendingMembership,
   OwnedRecord,
   OwnedWork,
   Ownership,
   PartySummary,
-  PressingDetail,
-  SaleDetail,
+  PressingView,
   PurchaseReceipt,
   RecordAlbum,
   ReleaseDetail,
@@ -164,32 +162,24 @@ export function createMisoApiClient(options: MisoApiClientOptions) {
 
   return {
     // ── Catalog ─────────────────────────────────────────────────────────────
-    /** The records currently on sale. */
-    getDiscover: (): Promise<DiscoverShelf> =>
-      required(s.discoverShelfSchema, "/discover"),
-
-    /** A pressing and everything its buy page renders. `null` when there is no such pressing. */
-    getPressing: (
-      pressingId: string,
-      opts: { include?: readonly "trackCredits"[] } = {},
-    ): Promise<PressingDetail | null> =>
+    /** One permanent pressing resource. */
+    getPressing: (pressingId: string): Promise<PressingView | null> =>
       request(
-        s.pressingDetailSchema,
+        s.pressingViewSchema,
         `/pressings/${pressingId}`,
-        { include: opts.include?.join(",") },
+        {},
         { nullOn404: true },
       ),
 
-    /** One Pressing and its currency-specific Listing. */
-    getPressingSale: (
+    /** One currency-specific Listing derived from a permanent Pressing. */
+    getListing: (
       pressingId: string,
       currencyType: string,
-      opts: { include?: readonly "trackCredits"[] } = {},
-    ): Promise<SaleDetail | null> =>
+    ): Promise<ListingView | null> =>
       request(
-        s.saleDetailSchema,
-        `/pressings/${pressingId}/sale`,
-        { currencyType, include: opts.include?.join(",") },
+        s.listingViewSchema,
+        `/pressings/${pressingId}/listing`,
+        { currencyType },
         { nullOn404: true },
       ),
 
@@ -217,15 +207,6 @@ export function createMisoApiClient(options: MisoApiClientOptions) {
         { nullOn404: true },
       ),
 
-    /** Confirmation preview for a pasted pressing id. `null` when it isn't a pressing. */
-    getPressingPreview: (pressingId: string): Promise<PressingPreview | null> =>
-      request(
-        s.pressingPreviewSchema,
-        `/pressings/${pressingId}/preview`,
-        {},
-        { nullOn404: true },
-      ),
-
     // ── Artist ──────────────────────────────────────────────────────────────
     /** An artist plus optional relationship expansions. */
     getArtist: (
@@ -325,10 +306,8 @@ export function cacheBuster(nowMs: number = Date.now()): string {
  * it with `workCacheClass(release.state)`.
  */
 export const READ_CACHE_CLASS = {
-  getDiscover: "sale",
   getPressing: "sale",
-  getPressingSale: "sale",
-  getPressingPreview: "sale",
+  getListing: "sale",
   getRecordAlbum: "immutable",
   getReceipt: "immutable",
   getArtist: "artist",

package/src/schemas.ts

@@ -156,11 +156,6 @@ export const listingViewSchema = z.object({
   state: z.enum(["enabled", "disabled"]),
 });
 
-export const saleViewSchema = z.object({
-  pressing: pressingViewSchema,
-  listing: listingViewSchema,
-});
-
 export const pressingDetailSchema = z.object({
   pressing: pressingViewSchema,
   release: releaseDetailSchema,
@@ -171,27 +166,6 @@ export const pressingDetailWireSchema = z.object({
   release: releaseDetailWireSchema,
 });
 
-export const saleDetailSchema = z.object({
-  sale: saleViewSchema,
-  release: releaseDetailSchema,
-});
-
-export const saleDetailWireSchema = z.object({
-  sale: saleViewSchema,
-  release: releaseDetailWireSchema,
-});
-
-export const discoverItemSchema = z.object({
-  sale: saleViewSchema,
-  releaseId: suiIdSchema,
-  title: z.string(),
-  /** Primary artists joined for display. Empty when no credits are set. */
-  artist: z.string(),
-  coverUrl: z.string().url().nullable(),
-});
-
-export const discoverShelfSchema = z.array(discoverItemSchema);
-
 export const recordAlbumSchema = z.object({
   recordId: suiIdSchema,
   releaseId: suiIdSchema.nullable(),
@@ -205,16 +179,6 @@ export const recordAlbumWireSchema = z.object({
   release: releaseDetailWireSchema.nullable().optional(),
 });
 
-export const pressingPreviewSchema = z.object({
-  pressingId: suiIdSchema,
-  title: z.string(),
-  subtitle: z.string().nullable(),
-  coverUrl: z.string().url().nullable(),
-  state: pressingStateSchema,
-  supply: u64Schema,
-  trackCount: z.number().int().min(0),
-});
-
 // ── Artist ───────────────────────────────────────────────────────────────────
 
 export const partyMemberSchema = z.object({

package/src/types.ts

@@ -20,13 +20,8 @@ export type Currency = z.infer<typeof s.currencySchema>;
 export type PressingState = z.infer<typeof s.pressingStateSchema>;
 export type PressingView = z.infer<typeof s.pressingViewSchema>;
 export type ListingView = z.infer<typeof s.listingViewSchema>;
-export type SaleView = z.infer<typeof s.saleViewSchema>;
 export type PressingDetail = z.infer<typeof s.pressingDetailSchema>;
-export type SaleDetail = z.infer<typeof s.saleDetailSchema>;
-export type DiscoverItem = z.infer<typeof s.discoverItemSchema>;
-export type DiscoverShelf = z.infer<typeof s.discoverShelfSchema>;
 export type RecordAlbum = z.infer<typeof s.recordAlbumSchema>;
-export type PressingPreview = z.infer<typeof s.pressingPreviewSchema>;
 
 export type PartyMember = z.infer<typeof s.partyMemberSchema>;
 export type PlatformKey = z.infer<typeof s.platformKeySchema>;