@misofm/api-client 0.5.1 → 0.5.3

package/src/schemas.ts

@@ -1,384 +0,0 @@
-// Copyright (c) Miso Labs, Inc.
-// SPDX-License-Identifier: Apache-2.0
-//
-// The response contract for every Miso read. This file is the SOURCE OF TRUTH:
-//
-//   · @misofm/api-client infers its types from it
-//   · miso-read-service generates its OpenAPI document from it
-//   · a contract test in that service parses every handler's real output through
-//     it, so a change in @misofm/sdk/read that these schemas don't describe fails CI
-//     rather than reaching a client
-//
-// Schemas, not hand-written interfaces, precisely so that third clause is
-// possible. The CLI and any future client read the same OpenAPI.
-//
-// SCALARS: every u64/u128 is a DECIMAL STRING (`u64Schema`), never a number.
-// Prices, supply counts, and balances routinely exceed 2^53, and JSON has no
-// integer type that holds them. Millisecond timestamps stay numbers — they are
-// inside Number.MAX_SAFE_INTEGER and callers want to pass them to `new Date()`.
-
-import { z } from "zod";
-
-/** A u64/u128 in base units, as a decimal string. See the file header. */
-export const u64Schema = z
-  .string()
-  .regex(/^\d+$/, "expected a decimal integer string");
-
-/** A 0x-prefixed 32-byte Sui object id or address, in canonical form. */
-export const suiIdSchema = z
-  .string()
-  .regex(/^0x[0-9a-fA-F]{1,64}$/, "expected a Sui object id");
-
-// ── Shared ───────────────────────────────────────────────────────────────────
-
-export const workStateSchema = z.union([
-  z.object({ type: z.literal("Initialized") }),
-  z.object({ type: z.literal("Published"), timestampMs: z.number().int() }),
-]);
-
-export const coverImageSchema = z.object({
-  kind: z.enum(["blob", "quiltPatch"]),
-  /** Aggregator URL — the only field a renderer needs. */
-  url: z.string().url(),
-});
-
-export const coverSchema = z.object({
-  still: coverImageSchema,
-  animated: coverImageSchema.nullable(),
-});
-
-export const creditSchema = z.object({
-  partyId: suiIdSchema,
-  displayName: z.string(),
-  roles: z.array(z.string()),
-});
-
-export const trackViewSchema = z.object({
-  /** Display number — "1", or "1.2" (disc.track) on a multi-disc set. */
-  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),
-});
-
-/** A recording's work-role credits and recording billing positions. */
-export const recordingCreditsSchema = z.object({
-  credits: z.array(creditSchema),
-  primaryArtistIds: z.array(suiIdSchema),
-  featuredArtistIds: z.array(suiIdSchema),
-});
-
-/** Per-track credits for a release. Composition writing and recording
- * performance/production credits remain separate. */
-const completeTrackCreditsSchema = z.object({
-  compositionCredits: z.array(creditSchema),
-  recordingCredits: recordingCreditsSchema,
-});
-
-/** The HTTP wire accepts the complete shape and the deployed recording-only shape. */
-export const trackCreditsWireSchema = z.union([
-  completeTrackCreditsSchema,
-  recordingCreditsSchema,
-]);
-
-/** Clients always receive the complete shape, including during the rollout. */
-export const trackCreditsSchema = trackCreditsWireSchema.transform((credits) =>
-  "recordingCredits" in credits
-    ? credits
-    : { compositionCredits: [], recordingCredits: credits },
-);
-
-// ── Catalog ──────────────────────────────────────────────────────────────────
-
-const releaseDetailBaseSchema = z.object({
-  id: suiIdSchema,
-  title: z.string(),
-  subtitle: z.string().nullable(),
-  /** Self-declared `release_kind`, or null when the extension is absent. */
-  kind: z.string().nullable(),
-  state: workStateSchema,
-  publishedAtMs: z.number().int().nullable(),
-  cover: coverSchema.nullable(),
-  credits: z.array(creditSchema),
-  /** The release's primary artists in chain order — its artist line. */
-  primaryArtists: z.array(z.string()),
-  discCount: z.number().int().min(0),
-  tracks: z.array(trackViewSchema),
-});
-
-/** Transform-free wire form used by OpenAPI generation. */
-export const releaseDetailWireSchema = releaseDetailBaseSchema.extend({
-  trackCredits: z.record(suiIdSchema, trackCreditsWireSchema).optional(),
-});
-
-export const releaseDetailSchema = releaseDetailBaseSchema.extend({
-  /** Present only when requested via `include`. */
-  trackCredits: z.record(suiIdSchema, trackCreditsSchema).optional(),
-});
-
-export const priceSchema = z.object({
-  /** `fixed` — pay exactly this. `floor` — pay at least this. */
-  kind: z.enum(["fixed", "floor"]),
-  amount: u64Schema,
-});
-
-export const currencySchema = z.object({
-  type: z.string().nullable(),
-  symbol: z.string(),
-  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,
-  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,
-  state: z.enum(["enabled", "disabled"]),
-});
-
-export const pressingDetailSchema = z.object({
-  pressing: pressingViewSchema,
-  release: releaseDetailSchema,
-});
-
-export const pressingDetailWireSchema = z.object({
-  pressing: pressingViewSchema,
-  release: releaseDetailWireSchema,
-});
-
-export const recordAlbumSchema = z.object({
-  recordId: suiIdSchema,
-  releaseId: suiIdSchema.nullable(),
-  /** Present only when requested via `include`. */
-  release: releaseDetailSchema.nullable().optional(),
-});
-
-export const recordAlbumWireSchema = z.object({
-  recordId: suiIdSchema,
-  releaseId: suiIdSchema.nullable(),
-  release: releaseDetailWireSchema.nullable().optional(),
-});
-
-// ── Artist ───────────────────────────────────────────────────────────────────
-
-export const partyMemberSchema = z.object({
-  id: suiIdSchema,
-  name: z.string(),
-});
-
-/**
- * Every external platform the party link extensions know how to build a URL for,
- * spanning social, music, and professional payloads. Enumerated rather than left
- * as `string` so a renderer's icon/label switch is exhaustive at compile time —
- * adding a platform on-chain should break the UI that has no icon for it.
- */
-export const platformKeySchema = z.enum([
-  // Social (party_social)
-  "x",
-  "instagram",
-  "threads",
-  "tiktok",
-  "youtube",
-  "discord",
-  "telegram",
-  "reddit",
-  "twitch",
-  "facebook",
-  // Music (party_music)
-  "spotify",
-  "bandcamp",
-  "soundcloud",
-  "appleMusic",
-  "deezer",
-  "tidal",
-  "amazonMusic",
-  "audiomack",
-  // Professional / industry (party_pro_link)
-  "website",
-  "bookingPage",
-  "managementPage",
-  "publisherPage",
-  "labelPage",
-  "epk",
-  "patreon",
-  "substack",
-  "kofi",
-]);
-
-export const partyLinkSchema = z.object({
-  platform: platformKeySchema,
-  /** The platform-native identifier stored on-chain (handle / id / subdomain / URL). */
-  value: z.string(),
-  /** The public profile URL, rebuilt client-side from `value`. */
-  url: z.string(),
-});
-
-export const partyCtaSchema = z.object({ label: z.string(), url: z.string() });
-
-export const artistProfileSchema = z.object({
-  id: suiIdSchema,
-  kind: z.enum(["individual", "group"]),
-  name: z.string(),
-  createdAtMs: z.number().int(),
-  bioShort: z.string().nullable(),
-  bioLong: z.string().nullable(),
-  country: z.string().nullable(),
-  languages: z.array(z.string()),
-  /** Display names, already humanized from the on-chain HIP_HOP form. */
-  genres: z.array(z.string()),
-  links: z.array(partyLinkSchema),
-  ctas: z.array(partyCtaSchema),
-  members: z.array(partyMemberSchema),
-  /** Present only when requested via `include` — the owner-editor fields. */
-  roles: z.array(z.string()).optional(),
-  tags: z.array(z.string()).optional(),
-  avatarUrl: z.string().url(),
-});
-
-export const partySummarySchema = z.object({
-  id: suiIdSchema,
-  name: z.string(),
-  kind: z.enum(["individual", "group"]),
-});
-
-export const partySummariesSchema = z.array(partySummarySchema);
-
-// ── Wallet-scoped ────────────────────────────────────────────────────────────
-
-export const ownedRecordSchema = z.object({
-  id: suiIdSchema,
-  type: z.string(),
-  releaseId: suiIdSchema.nullable(),
-  /** This copy's number in its run. */
-  number: z.number().int().nullable(),
-});
-
-export const ownedRecordsSchema = z.array(ownedRecordSchema);
-
-export const ownedPartySchema = z.object({
-  partyId: suiIdSchema,
-  capId: suiIdSchema,
-  name: z.string(),
-  kind: z.enum(["individual", "group"]),
-});
-
-export const ownedPartiesSchema = z.array(ownedPartySchema);
-
-/** A group invitation awaiting action by a party the wallet administers. */
-export const pendingMembershipSchema = z.object({
-  memberPartyId: suiIdSchema,
-  memberCapId: suiIdSchema,
-  groupId: suiIdSchema,
-  groupName: z.string(),
-});
-
-export const pendingMembershipsSchema = z.array(pendingMembershipSchema);
-
-export const workKindSchema = z.enum(["composition", "recording", "release"]);
-
-export const ownedWorkSchema = z.object({
-  /** The ADMIN CAP object id — the catalog's routing key. */
-  capId: suiIdSchema,
-  kind: workKindSchema,
-  workId: suiIdSchema,
-  title: z.string(),
-  state: z.string(),
-});
-
-export const ownedWorksSchema = z.array(ownedWorkSchema);
-
-export const workDetailSchema = ownedWorkSchema.extend({
-  subtitle: z.string().optional(),
-  royaltyRateBps: z.number().int().min(0).max(10_000).optional(),
-  shareType: z.string().optional(),
-  discCount: z.number().int().min(0).optional(),
-  trackCount: z.number().int().min(0).optional(),
-});
-
-export const balanceSchema = z.object({
-  address: suiIdSchema,
-  coinType: z.string(),
-  /** Base units. Totals coin objects AND the address balance. */
-  balance: u64Schema,
-  decimals: z.number().int().min(0).max(18),
-});
-
-export const ownershipSchema = z.object({
-  address: suiIdSchema,
-  objectId: suiIdSchema,
-  isOwner: z.boolean(),
-  /** Party checks only — the derived PartyAdminCap id owner-gated writes need. */
-  capId: suiIdSchema.optional(),
-});
-
-// ── Receipts ─────────────────────────────────────────────────────────────────
-
-export const recordSaleSchema = z.object({
-  listingId: suiIdSchema,
-  pressingId: suiIdSchema,
-  releaseId: suiIdSchema,
-  recordId: suiIdSchema,
-  number: u64Schema,
-  paid: u64Schema,
-  price: priceSchema,
-  currencyType: z.string(),
-  buyer: suiIdSchema,
-});
-
-export const trackRoyaltySchema = z.object({
-  no: z.string(),
-  title: z.string(),
-  recordingId: suiIdSchema,
-  splitBps: z.number().int().min(0).max(10_000),
-  amount: u64Schema,
-  /** Both null when the composition's royalty rate could not be resolved. */
-  composition: u64Schema.nullable(),
-  recording: u64Schema.nullable(),
-});
-
-export const purchaseReceiptSchema = z.object({
-  sale: recordSaleSchema,
-  detail: pressingDetailSchema,
-  /** The Listing price — differs from `sale.paid` on a floor-price overpay. */
-  price: u64Schema,
-  tracks: z.array(trackRoyaltySchema),
-});
-
-export const purchaseReceiptWireSchema = z.object({
-  sale: recordSaleSchema,
-  detail: pressingDetailWireSchema,
-  price: u64Schema,
-  tracks: z.array(trackRoyaltySchema),
-});
-
-// ── Errors ───────────────────────────────────────────────────────────────────
-
-/** The envelope every non-2xx carries, matching miso-api's `apiError`. */
-export const apiErrorSchema = z.object({
-  error: z.object({
-    code: z.string(),
-    message: z.string(),
-  }),
-});