@misofm/api-client 0.3.0 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@misofm/api-client",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "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/cache.ts

@@ -20,12 +20,9 @@
 //   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 live pressing. The only field that moves between reads is the
-//               copies-sold counter — and a pressing is UNCAPPED (one open run,
-//               no editions, no supply cap, no sold-out state), so that counter
-//               gates nothing. It is a display number, not a stock level, which
-//               is why a minute of staleness is cosmetic rather than a
-//               correctness problem.
+//   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.
 //

package/src/client.test.ts

@@ -71,9 +71,9 @@ describe("URL construction", () => {
   test("joins the artist include list into one param", async () => {
     const { fetch, calls } = stubFetch({ status: 404 });
     await createMisoApiClient({ baseUrl: BASE, fetch }).getArtist("0xp", {
-      include: ["roles", "tags", "featured"],
+      include: ["roles", "tags"],
     });
-    expect(calls[0]).toContain("include=roles%2Ctags%2Cfeatured");
+    expect(calls[0]).toContain("include=roles%2Ctags");
   });
 
   test("joins catalog relationship expansions into one param", async () => {
@@ -89,6 +89,23 @@ describe("URL construction", () => {
     expect(calls[2]).toContain("include=release%2CtrackCredits");
   });
 
+  test("uses the permanent pressing preview 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(
+      "0xp",
+      "0x2::sui::SUI",
+    );
+    expect(calls[0]).toBe(
+      `${BASE}/read/v1/pressings/0xp/sale?currencyType=0x2%3A%3Asui%3A%3ASUI`,
+    );
+  });
+
   test("a custom prefix is honored (self-hosted / direct-to-service)", async () => {
     const { fetch, calls } = stubFetch({ body: balance });
     await createMisoApiClient({
@@ -101,7 +118,7 @@ describe("URL construction", () => {
 });
 
 describe("not-found handling", () => {
-  test("a superseded pressing is null, not an error", async () => {
+  test("an unknown pressing is null, not an error", async () => {
     const { fetch } = stubFetch({
       status: 404,
       body: { error: { code: "not_found", message: "gone" } },

package/src/client.ts

@@ -22,7 +22,7 @@ import type {
   ArtistProfile,
   Balance,
   DiscoverShelf,
-  DropPreview,
+  PressingPreview,
   OwnedParty,
   PendingMembership,
   OwnedRecord,
@@ -30,6 +30,7 @@ import type {
   Ownership,
   PartySummary,
   PressingDetail,
+  SaleDetail,
   PurchaseReceipt,
   RecordAlbum,
   ReleaseDetail,
@@ -179,6 +180,19 @@ export function createMisoApiClient(options: MisoApiClientOptions) {
         { nullOn404: true },
       ),
 
+    /** One Pressing and its currency-specific Listing. */
+    getPressingSale: (
+      pressingId: string,
+      currencyType: string,
+      opts: { include?: readonly "trackCredits"[] } = {},
+    ): Promise<SaleDetail | null> =>
+      request(
+        s.saleDetailSchema,
+        `/pressings/${pressingId}/sale`,
+        { currencyType, include: opts.include?.join(",") },
+        { nullOn404: true },
+      ),
+
     /** A release with its cover, credits, and resolved tracklist. */
     getRelease: (
       releaseId: string,
@@ -204,10 +218,10 @@ export function createMisoApiClient(options: MisoApiClientOptions) {
       ),
 
     /** Confirmation preview for a pasted pressing id. `null` when it isn't a pressing. */
-    getDropPreview: (dropId: string): Promise<DropPreview | null> =>
+    getPressingPreview: (pressingId: string): Promise<PressingPreview | null> =>
       request(
-        s.dropPreviewSchema,
-        `/drops/${dropId}/preview`,
+        s.pressingPreviewSchema,
+        `/pressings/${pressingId}/preview`,
         {},
         { nullOn404: true },
       ),
@@ -216,7 +230,7 @@ export function createMisoApiClient(options: MisoApiClientOptions) {
     /** An artist plus optional relationship expansions. */
     getArtist: (
       partyId: string,
-      opts: { include?: readonly ("roles" | "tags" | "featured")[] } = {},
+      opts: { include?: readonly ("roles" | "tags")[] } = {},
     ): Promise<ArtistProfile | null> =>
       request(
         s.artistProfileSchema,
@@ -313,7 +327,8 @@ export function cacheBuster(nowMs: number = Date.now()): string {
 export const READ_CACHE_CLASS = {
   getDiscover: "sale",
   getPressing: "sale",
-  getDropPreview: "sale",
+  getPressingSale: "sale",
+  getPressingPreview: "sale",
   getRecordAlbum: "immutable",
   getReceipt: "immutable",
   getArtist: "artist",

package/src/schemas.ts

@@ -58,6 +58,8 @@ export const trackViewSchema = z.object({
   no: z.string(),
   title: z.string(),
   recordingId: suiIdSchema,
+  /** The composition underlying this track's recording. */
+  compositionId: suiIdSchema,
   /** This track's share of the release's revenue, in basis points. */
   splitBps: z.number().int().min(0).max(10_000),
   disc: z.number().int().min(1),
@@ -128,19 +130,35 @@ export const currencySchema = z.object({
   decimals: z.number().int().min(0).max(18),
 });
 
+export const pressingStateSchema = z.union([
+  z.object({
+    kind: z.literal("scheduled"),
+    startTimestampMs: z.number().int(),
+  }),
+  z.object({ kind: z.literal("active") }),
+  z.object({ kind: z.literal("paused") }),
+]);
+
 export const pressingViewSchema = z.object({
   id: suiIdSchema,
   releaseId: suiIdSchema,
-  edition: z.number().int().min(0),
+  state: pressingStateSchema,
+  /** Records pressed so far. The permanent run is intentionally uncapped. */
+  supply: u64Schema,
+});
+
+export const listingViewSchema = z.object({
+  id: suiIdSchema,
+  pressingId: suiIdSchema,
+  releaseId: suiIdSchema,
   price: priceSchema,
   currency: currencySchema,
-  quantitySold: u64Schema,
-  /** Null = uncapped (an open edition). */
-  maxSupply: u64Schema.nullable(),
-  startTimestampMs: z.number().int(),
-  /** Null = evergreen. */
-  endTimestampMs: z.number().int().nullable(),
-  soldOut: z.boolean(),
+  state: z.enum(["enabled", "disabled"]),
+});
+
+export const saleViewSchema = z.object({
+  pressing: pressingViewSchema,
+  listing: listingViewSchema,
 });
 
 export const pressingDetailSchema = z.object({
@@ -153,8 +171,18 @@ 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({
-  pressing: pressingViewSchema,
+  sale: saleViewSchema,
   releaseId: suiIdSchema,
   title: z.string(),
   /** Primary artists joined for display. Empty when no credits are set. */
@@ -177,13 +205,13 @@ export const recordAlbumWireSchema = z.object({
   release: releaseDetailWireSchema.nullable().optional(),
 });
 
-export const dropPreviewSchema = z.object({
+export const pressingPreviewSchema = z.object({
   pressingId: suiIdSchema,
-  currency: currencySchema,
   title: z.string(),
   subtitle: z.string().nullable(),
   coverUrl: z.string().url().nullable(),
-  price: priceSchema,
+  state: pressingStateSchema,
+  supply: u64Schema,
   trackCount: z.number().int().min(0),
 });
 
@@ -243,14 +271,6 @@ export const partyLinkSchema = z.object({
 
 export const partyCtaSchema = z.object({ label: z.string(), url: z.string() });
 
-export const featuredReleaseSchema = z.object({
-  pressingId: suiIdSchema,
-  releaseId: suiIdSchema,
-  title: z.string(),
-  artist: z.string(),
-  coverUrl: z.string().url().nullable(),
-});
-
 export const artistProfileSchema = z.object({
   id: suiIdSchema,
   kind: z.enum(["individual", "group"]),
@@ -268,8 +288,6 @@ export const artistProfileSchema = z.object({
   /** Present only when requested via `include` — the owner-editor fields. */
   roles: z.array(z.string()).optional(),
   tags: z.array(z.string()).optional(),
-  /** Present only when requested; null means the artist has no pinned release. */
-  featured: featuredReleaseSchema.nullable().optional(),
   avatarUrl: z.string().url(),
 });
 
@@ -352,13 +370,15 @@ export const ownershipSchema = z.object({
 // ── Receipts ─────────────────────────────────────────────────────────────────
 
 export const recordSaleSchema = z.object({
-  dropId: z.string(),
-  releaseId: z.string(),
-  edition: z.number().int().min(0),
+  listingId: suiIdSchema,
+  pressingId: suiIdSchema,
+  releaseId: suiIdSchema,
   recordId: suiIdSchema,
   number: u64Schema,
   paid: u64Schema,
-  buyer: z.string(),
+  price: priceSchema,
+  currencyType: z.string(),
+  buyer: suiIdSchema,
 });
 
 export const trackRoyaltySchema = z.object({
@@ -375,7 +395,7 @@ export const trackRoyaltySchema = z.object({
 export const purchaseReceiptSchema = z.object({
   sale: recordSaleSchema,
   detail: pressingDetailSchema,
-  /** The drop's list price — differs from `sale.paid` on a floor-price overpay. */
+  /** The Listing price — differs from `sale.paid` on a floor-price overpay. */
   price: u64Schema,
   tracks: z.array(trackRoyaltySchema),
 });

package/src/types.ts

@@ -17,19 +17,22 @@ export type ReleaseDetail = z.infer<typeof s.releaseDetailSchema>;
 export type TrackCredits = z.infer<typeof s.trackCreditsSchema>;
 export type Price = z.infer<typeof s.priceSchema>;
 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 DropPreview = z.infer<typeof s.dropPreviewSchema>;
+export type PressingPreview = z.infer<typeof s.pressingPreviewSchema>;
 
 export type PartyMember = z.infer<typeof s.partyMemberSchema>;
 export type PlatformKey = z.infer<typeof s.platformKeySchema>;
 export type PartyLink = z.infer<typeof s.partyLinkSchema>;
 export type PartyCta = z.infer<typeof s.partyCtaSchema>;
 export type ArtistProfile = z.infer<typeof s.artistProfileSchema>;
-export type FeaturedRelease = z.infer<typeof s.featuredReleaseSchema>;
 export type PartySummary = z.infer<typeof s.partySummarySchema>;
 
 export type OwnedRecord = z.infer<typeof s.ownedRecordSchema>;