@misofm/sdk 0.2.0 → 0.3.0

package/README.md

@@ -1,10 +1,9 @@
 # @misofm/sdk
 
-Typed reads and transaction builders for the **Miso platform layer** on Sui: the
-record production line and the sale of copies off it, the first-party protocol
-extensions (credits, cover art, royalty pools), and the opinionated publish flow
-(share economics, minato dispersal, whole-graph orchestration) built on top of
-`@misonetwork/sdk`'s bare protocol primitives.
+The complete client SDK for the **Miso platform layer** on Sui: composed catalog,
+artist, wallet, and receipt reads; the record production line and sale of copies;
+first-party protocol extensions (credits, cover art, royalty pools); and the
+opinionated publish flow built on `@misonetwork/sdk`'s bare protocol primitives.
 
 ## The split
 
@@ -94,6 +93,37 @@ Holding the ids yourself? Every builder and reader is exported bare, taking
 import { buyRecord, getSale } from "@misofm/sdk/pressing";
 ```
 
+### High-level platform reads
+
+`@misofm/sdk/read` turns protocol, pressing, PartyOS, credits, cover, and wallet
+objects into the JSON-safe views a client actually renders. It works in browsers,
+Workers, and servers. Miso's HTTP API is a thin validated and cached transport over
+this same surface, not a separate domain implementation.
+
+```ts
+import {
+  createMisoClient,
+  getDiscoverShelf,
+  getReleaseDetail,
+  getOwnedRecords,
+} from "@misofm/sdk/read";
+
+const miso = createMisoClient({ network: "testnet" });
+
+const discover = await getDiscoverShelf(miso);
+const release = await getReleaseDetail(miso, releaseId);
+const library = await getOwnedRecords(miso, walletAddress);
+```
+
+The package root also exposes the same functions under the `read` namespace:
+
+```ts
+import { read } from "@misofm/sdk";
+
+const miso = read.createMisoClient({ network: "testnet" });
+const artist = await read.getArtistProfile(miso, partyId);
+```
+
 ### Payment
 
 `listing::buy` takes a bare `Balance<Currency>`, and `buyRecord` sources it with
@@ -321,6 +351,8 @@ src/
   share-template.ts      embedded `share` package bytecode
   credits.ts             EXTENSION: contributor credits + the three role vocabularies
   cover.ts               EXTENSION: release cover art (Walrus blob via ori)
+  drop.ts                existing launch-drop compatibility surface
+  read/                  high-level catalog, artist, wallet, and receipt views
   extensions/
     royalty-pool.ts      EXTENSION: create + share a RoyaltyPool<Share, Currency>
   execute.ts              executeViaExecutor, layered on @misonetwork/sdk's buildTx/toExecResult

package/dist/catalog.d.ts

@@ -1,6 +1,36 @@
 import type { ClientWithCoreApi } from "@mysten/sui/client";
 import type { SuiGraphQLClient } from "@mysten/sui/graphql";
 import { type Recording } from "@misonetwork/sdk";
+import { type CreditView, type RecordingCreditsView } from "./credits.ts";
+export interface GetReleaseTrackCreditsOptions {
+    /** Core Miso package that defines Composition and Recording. */
+    misoPackageId: string;
+    /** Package that defines the composition_credits extension key. */
+    compositionCreditsPackageId: string;
+    /** Package that defines the recording_credits extension key. */
+    recordingCreditsPackageId: string;
+}
+export interface ReleaseTrackCredits {
+    compositionCredits: CreditView[];
+    recordingCredits: RecordingCreditsView;
+}
+/**
+ * Composition and recording credits for every track on a release, keyed by
+ * recording id.
+ *
+ * The read follows the chain's actual object graph instead of release credits:
+ * Release -> Recording -> Composition. Recording credit fields and recording
+ * type parameters are fetched together for every track. Composition addresses
+ * are then resolved concurrently, deduplicated, and all composition credit
+ * fields are fetched concurrently as well.
+ */
+export declare function getReleaseTrackCredits(client: ClientWithCoreApi, graphqlClient: SuiGraphQLClient, releaseId: string, options: GetReleaseTrackCreditsOptions): Promise<Record<string, ReleaseTrackCredits>>;
+/**
+ * Composition and recording credits for the supplied recordings, keyed by
+ * recording id. This form is intended for consumers that already loaded a
+ * release and do not need to fetch it again.
+ */
+export declare function getTrackCreditsByRecordingIds(client: ClientWithCoreApi, graphqlClient: SuiGraphQLClient, recordingIdsInput: readonly string[], options: GetReleaseTrackCreditsOptions): Promise<Record<string, ReleaseTrackCredits>>;
 export interface GetAdministeredRecordingsOptions {
     /**
      * Maximum lookups in flight at once. The traversal is one lookup per admin

package/dist/catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,kBAAkB,CAAC;AAE1B,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,SAAS,EAAE,CAAC,CAsBtB"}
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAML,KAAK,SAAS,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAGL,KAAK,UAAU,EACf,KAAK,oBAAoB,EAC1B,MAAM,cAAc,CAAC;AAEtB,MAAM,WAAW,6BAA6B;IAC5C,gEAAgE;IAChE,aAAa,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,2BAA2B,EAAE,MAAM,CAAC;IACpC,gEAAgE;IAChE,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,gBAAgB,EAAE,oBAAoB,CAAC;CACxC;AAQD;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAQ9C;AAED;;;;GAIG;AACH,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,iBAAiB,EAAE,SAAS,MAAM,EAAE,EACpC,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAoD9C;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,gCAAqC,GAC7C,OAAO,CAAC,SAAS,EAAE,CAAC,CAsBtB"}

package/dist/catalog.js

@@ -1,6 +1,65 @@
 // Copyright (c) Miso Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
-import { getOwnedRecordingAdminCaps, getRecordingByShareType, } from "@misonetwork/sdk";
+import { getCompositionAddressByShareType, getOwnedRecordingAdminCaps, getRecordingByShareType, getRecordingShareTypes, getReleaseById, } from "@misonetwork/sdk";
+import { getCompositionCredits, getRecordingCredits, } from "./credits.js";
+const EMPTY_RECORDING_CREDITS = {
+    credits: [],
+    primaryArtistIds: [],
+    featuredArtistIds: [],
+};
+/**
+ * Composition and recording credits for every track on a release, keyed by
+ * recording id.
+ *
+ * The read follows the chain's actual object graph instead of release credits:
+ * Release -> Recording -> Composition. Recording credit fields and recording
+ * type parameters are fetched together for every track. Composition addresses
+ * are then resolved concurrently, deduplicated, and all composition credit
+ * fields are fetched concurrently as well.
+ */
+export async function getReleaseTrackCredits(client, graphqlClient, releaseId, options) {
+    const release = await getReleaseById(client, releaseId);
+    return getTrackCreditsByRecordingIds(client, graphqlClient, release.tracks.map((track) => track.recordingId), options);
+}
+/**
+ * Composition and recording credits for the supplied recordings, keyed by
+ * recording id. This form is intended for consumers that already loaded a
+ * release and do not need to fetch it again.
+ */
+export async function getTrackCreditsByRecordingIds(client, graphqlClient, recordingIdsInput, options) {
+    const recordingIds = [...new Set(recordingIdsInput)];
+    const recordingReads = await Promise.all(recordingIds.map(async (recordingId) => {
+        const [recordingCredits, [, compositionShareType]] = await Promise.all([
+            getRecordingCredits(client, recordingId, options.recordingCreditsPackageId),
+            getRecordingShareTypes(client, recordingId),
+        ]);
+        return { recordingId, recordingCredits, compositionShareType };
+    }));
+    const compositionShareTypes = [...new Set(recordingReads.map((read) => read.compositionShareType))];
+    const compositionAddressEntries = await Promise.all(compositionShareTypes.map(async (shareType) => {
+        const compositionId = await getCompositionAddressByShareType(graphqlClient, shareType, options.misoPackageId);
+        if (!compositionId)
+            throw new Error(`Composition not found for share type: ${shareType}`);
+        return [shareType, compositionId];
+    }));
+    const compositionAddressByShareType = new Map(compositionAddressEntries);
+    const compositionIds = [...new Set(compositionAddressEntries.map(([, compositionId]) => compositionId))];
+    const compositionCreditEntries = await Promise.all(compositionIds.map(async (compositionId) => {
+        const credits = await getCompositionCredits(client, compositionId, options.compositionCreditsPackageId);
+        return [compositionId, credits ?? []];
+    }));
+    const compositionCreditsById = new Map(compositionCreditEntries);
+    return Object.fromEntries(recordingReads.map((read) => {
+        const compositionId = compositionAddressByShareType.get(read.compositionShareType);
+        return [
+            read.recordingId,
+            {
+                compositionCredits: compositionCreditsById.get(compositionId) ?? [],
+                recordingCredits: read.recordingCredits ?? EMPTY_RECORDING_CREDITS,
+            },
+        ];
+    }));
+}
 /**
  * Every `Recording` administered by `owner`.
  *

package/dist/catalog.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,sCAAsC;AActC,OAAO,EACL,0BAA0B,EAC1B,uBAAuB,GAExB,MAAM,kBAAkB,CAAC;AAW1B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,MAAyB,EACzB,aAA+B,EAC/B,KAAa,EACb,aAAqB,EACrB,UAA4C,EAAE;IAE9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAE5E,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACtB,IAAI,CAAC;gBACH,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAC5F,CAAC;YAAC,MAAM,CAAC;gBACP,kEAAkE;gBAClE,sEAAsE;gBACtE,4CAA4C;gBAC5C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,OAAO;YAAE,IAAI,GAAG;gBAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,sCAAsC;AActC,OAAO,EACL,gCAAgC,EAChC,0BAA0B,EAC1B,uBAAuB,EACvB,sBAAsB,EACtB,cAAc,GAEf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,qBAAqB,EACrB,mBAAmB,GAGpB,MAAM,cAAc,CAAC;AAgBtB,MAAM,uBAAuB,GAAyB;IACpD,OAAO,EAAE,EAAE;IACX,gBAAgB,EAAE,EAAE;IACpB,iBAAiB,EAAE,EAAE;CACtB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAAyB,EACzB,aAA+B,EAC/B,SAAiB,EACjB,OAAsC;IAEtC,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACxD,OAAO,6BAA6B,CAClC,MAAM,EACN,aAAa,EACb,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,EAChD,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,MAAyB,EACzB,aAA+B,EAC/B,iBAAoC,EACpC,OAAsC;IAEtC,MAAM,YAAY,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAErD,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CACtC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;QACrC,MAAM,CAAC,gBAAgB,EAAE,CAAC,EAAE,oBAAoB,CAAC,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACrE,mBAAmB,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,yBAAyB,CAAC;YAC3E,sBAAsB,CAAC,MAAM,EAAE,WAAW,CAAC;SAC5C,CAAC,CAAC;QACH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,CAAC;IACjE,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IACpG,MAAM,yBAAyB,GAAG,MAAM,OAAO,CAAC,GAAG,CACjD,qBAAqB,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QAC5C,MAAM,aAAa,GAAG,MAAM,gCAAgC,CAC1D,aAAa,EACb,SAAS,EACT,OAAO,CAAC,aAAa,CACtB,CAAC;QACF,IAAI,CAAC,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,yCAAyC,SAAS,EAAE,CAAC,CAAC;QAC1F,OAAO,CAAC,SAAS,EAAE,aAAa,CAAU,CAAC;IAC7C,CAAC,CAAC,CACH,CAAC;IACF,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAEzE,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IACzG,MAAM,wBAAwB,GAAG,MAAM,OAAO,CAAC,GAAG,CAChD,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QACzC,MAAM,OAAO,GAAG,MAAM,qBAAqB,CACzC,MAAM,EACN,aAAa,EACb,OAAO,CAAC,2BAA2B,CACpC,CAAC;QACF,OAAO,CAAC,aAAa,EAAE,OAAO,IAAI,EAAE,CAAU,CAAC;IACjD,CAAC,CAAC,CACH,CAAC;IACF,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC,wBAAwB,CAAC,CAAC;IAEjE,OAAO,MAAM,CAAC,WAAW,CACvB,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1B,MAAM,aAAa,GAAG,6BAA6B,CAAC,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAE,CAAC;QACpF,OAAO;YACL,IAAI,CAAC,WAAW;YAChB;gBACE,kBAAkB,EAAE,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE;gBACnE,gBAAgB,EAAE,IAAI,CAAC,gBAAgB,IAAI,uBAAuB;aACnE;SACF,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAWD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,MAAyB,EACzB,aAA+B,EAC/B,KAAa,EACb,aAAqB,EACrB,UAA4C,EAAE;IAE9C,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,MAAM,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAE5E,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACtB,IAAI,CAAC;gBACH,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAC5F,CAAC;YAAC,MAAM,CAAC;gBACP,kEAAkE;gBAClE,sEAAsE;gBACtE,4CAA4C;gBAC5C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,OAAO;YAAE,IAAI,GAAG;gBAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC"}