@misofm/musicos 0.1.0

package/dist/queries.d.ts

@@ -0,0 +1,178 @@
+import type { ClientWithCoreApi } from "@mysten/sui/client";
+import type { SuiGraphQLClient } from "@mysten/sui/graphql";
+import type { Composition, CompositionAdminCap, Recording, RecordingAdminCap, Release, ReleaseAdminCap } from "./types.ts";
+/**
+ * Extracts the type parameter `T` from `package::module::Type<T>`. For multi-
+ * parameter types this returns everything between the outer angle brackets —
+ * use {@link extractTypeParams2} to split two top-level parameters.
+ */
+export declare function extractTypeParam(objectType: string): string;
+/** Splits the two top-level type parameters of `pkg::mod::Type<A, B>`. */
+export declare function extractTypeParams2(objectType: string): [string, string];
+/**
+ * True when `e` is a "this object does not exist" error from any of the Sui
+ * client transports, so null-returning readers can distinguish absence from
+ * transport failure. Matches, in order of preference:
+ *
+ *   1. Structured `ObjectError.code` values thrown by the JSON-RPC core client
+ *      (`notExists`, `deleted`, `dynamicFieldNotFound`) and the GraphQL core
+ *      client (`notFound`). The class itself is not exported by `@mysten/sui`,
+ *      so we duck-type on `code`.
+ *   2. The message shapes those clients (and the gRPC core client, which wraps
+ *      the server's per-object status message in a plain `Error`) produce:
+ *      "Object 0x… does not exist" / "Object 0x… not found" / "Object 0x… has
+ *      been deleted" / "Dynamic field not found for object 0x…" / "No object
+ *      found for id 0x…".
+ *
+ * Transport/protocol errors must NOT match: every message pattern requires
+ * object-ish context ("object" / "dynamic field"), so e.g. a JSON-RPC
+ * "Method not found" or a gRPC "peer not found" is never treated as a missing
+ * object and propagates to the caller.
+ */
+export declare function isNotFound(e: unknown): boolean;
+/** Any generated BCS codec with a `parse` method. */
+export interface BcsParser<T> {
+    parse(bytes: Uint8Array): T;
+}
+/**
+ * Fetch and parse an object through the transport-neutral Core API. Object
+ * content is BCS; never pass the full `objectBcs` envelope to a Move codec.
+ */
+export declare function getObjectByBcs<T>(client: ClientWithCoreApi, objectId: string, codec: BcsParser<T>): Promise<T>;
+export interface ExtensionFieldParams<T> {
+    /** Freshly published package address for the extension. */
+    packageId: string;
+    /** Move module declaring the fieldless `ExtensionKey`. */
+    module: string;
+    /** Generated codec for the dynamic-field value. */
+    codec: BcsParser<T>;
+}
+/**
+ * Read an optional first-party extension field from a core object's UID. Every
+ * current extension uses a fieldless `ExtensionKey`, whose BCS is one false
+ * boolean byte. Absence returns `null`; transport errors still propagate.
+ */
+export declare function getExtensionField<T>(client: ClientWithCoreApi, parentId: string, params: ExtensionFieldParams<T>): Promise<T | null>;
+export interface ReleaseDspFieldParams<T> {
+    /** Freshly published `release_dsp_link` package address. */
+    packageId: string;
+    /** Numeric DSP discriminator (`DspLinkData::platform()`). */
+    platform: number;
+    /** Generated codec for `DspLinkData` or `PerTrack<Option<DspLinkData>>`. */
+    codec: BcsParser<T>;
+}
+/** Read a release-level DSP link stored under `ReleaseLinkKey(platform)`. */
+export declare function getReleaseDspLink<T>(client: ClientWithCoreApi, releaseId: string, params: ReleaseDspFieldParams<T>): Promise<T | null>;
+/** Read the per-track DSP-link array stored under `TrackLinksKey(platform)`. */
+export declare function getTrackDspLinks<T>(client: ClientWithCoreApi, releaseId: string, params: ReleaseDspFieldParams<T>): Promise<T | null>;
+/** Parse the shared canonical core `miso::release::ReleaseRegistry` by ID. */
+export declare function getReleaseRegistryById(client: ClientWithCoreApi, registryId: string): Promise<{
+    id: string;
+}>;
+export interface WorkShareTypes {
+    compositions: readonly string[];
+    recordings: readonly string[];
+}
+export interface WorkAddressesByShareType {
+    compositions: Partial<Record<string, string>>;
+    recordings: Partial<Record<string, string>>;
+}
+/**
+ * Resolve many work share types in one GraphQL request.
+ *
+ * Compositions can be queried by their exact one-parameter type. Recordings
+ * carry both RecordingShare and CompositionShare, while an admin cap only
+ * exposes the first, so one bare Recording scan is shared by every requested
+ * recording type and filtered client-side.
+ */
+export declare function getWorkAddressesByShareTypes(client: SuiGraphQLClient, shareTypes: WorkShareTypes, misoPackageId: string): Promise<WorkAddressesByShareType>;
+export interface WorkIds {
+    compositions: readonly string[];
+    recordings: readonly string[];
+    releases: readonly string[];
+}
+export interface WorksById {
+    compositions: Partial<Record<string, Composition>>;
+    recordings: Partial<Record<string, Recording>>;
+    releases: Partial<Record<string, Release>>;
+}
+/** Fetch and parse heterogeneous work objects through one Core bulk request. */
+export declare function getWorksByIds(client: ClientWithCoreApi, ids: WorkIds): Promise<WorksById>;
+/** Fetches multiple compositions by ID in one Core request. */
+export declare function getCompositionsByIds(client: ClientWithCoreApi, compositionIds: string[]): Promise<Record<string, Composition>>;
+/** Fetches a composition by its object ID. */
+export declare function getCompositionById(client: ClientWithCoreApi, compositionId: string): Promise<Composition>;
+/** Extracts the share type `T` from a `Composition<T>` object. */
+export declare function getCompositionShareType(client: ClientWithCoreApi, compositionId: string): Promise<string>;
+/** Fetches a composition by its share type (GraphQL discovery + Core read). */
+export declare function getCompositionByShareType(client: ClientWithCoreApi, graphqlClient: SuiGraphQLClient, shareType: string, misoPackageId: string): Promise<Composition>;
+/**
+ * Resolves a composition share type to its object address.
+ *
+ * This is the lightweight discovery primitive for callers that need the
+ * composition's identity but will read extension fields rather than the core
+ * Composition contents.
+ */
+export declare function getCompositionAddressByShareType(graphqlClient: SuiGraphQLClient, shareType: string, misoPackageId: string): Promise<string | null>;
+export declare function getCompositionAdminCapById(client: ClientWithCoreApi, adminCapId: string): Promise<CompositionAdminCap>;
+/**
+ * Composition admin caps owned by `owner`.
+ *
+ * Core API (no GraphQL): `listOwnedObjects` takes a type filter and returns each
+ * object's instantiated `type`, so the share type is read straight off
+ * `CompositionAdminCap<CompositionShare>` with no second round-trip.
+ */
+export declare function getOwnedCompositionAdminCaps(client: ClientWithCoreApi, owner: string, misoPackageId: string): Promise<CompositionAdminCap[]>;
+export declare function deriveCompositionAdminCapId(compositionId: string, misoPackageId: string): string;
+export declare function getRecordingsByIds(client: ClientWithCoreApi, recordingIds: string[]): Promise<Record<string, Recording>>;
+export declare function getRecordingById(client: ClientWithCoreApi, recordingId: string): Promise<Recording>;
+/**
+ * The recording's OWN share type (`RecordingShare`). `Recording` is generic over
+ * two phantoms — `Recording<RecordingShare, CompositionShare>` — so this splits
+ * them and returns the first; use {@link getRecordingShareTypes} when the
+ * parent composition's share type is needed too.
+ */
+export declare function getRecordingShareType(client: ClientWithCoreApi, recordingId: string): Promise<string>;
+/**
+ * Both of a recording's share types, as `[RecordingShare, CompositionShare]`.
+ * Most builders need the pair — `track::new`, `recording::publish`
+ * and the recording credit/pool extensions are all generic over both, in this
+ * order.
+ */
+export declare function getRecordingShareTypes(client: ClientWithCoreApi, recordingId: string): Promise<[string, string]>;
+export declare function getRecordingByShareType(client: ClientWithCoreApi, graphqlClient: SuiGraphQLClient, shareType: string, misoPackageId: string): Promise<Recording>;
+export declare function getRecordingAdminCapById(client: ClientWithCoreApi, adminCapId: string): Promise<RecordingAdminCap>;
+/**
+ * Recording admin caps owned by `owner`.
+ *
+ * Core API (no GraphQL), same shape as {@link getOwnedCompositionAdminCaps}.
+ * Note `RecordingAdminCap<phantom RecordingShare>` is deliberately single-param,
+ * so this yields only the recording's own share type — its parent composition's
+ * share type is not recoverable from the cap alone.
+ */
+export declare function getOwnedRecordingAdminCaps(client: ClientWithCoreApi, owner: string, misoPackageId: string): Promise<RecordingAdminCap[]>;
+export declare function deriveRecordingAdminCapId(recordingId: string, misoPackageId: string): string;
+export declare function getReleasesByIds(client: ClientWithCoreApi, releaseIds: string[]): Promise<Record<string, Release>>;
+export declare function getReleaseById(client: ClientWithCoreApi, releaseId: string): Promise<Release>;
+export declare function getReleaseAdminCapById(client: ClientWithCoreApi, adminCapId: string): Promise<ReleaseAdminCap>;
+export declare function getOwnedReleaseAdminCaps(client: ClientWithCoreApi, owner: string, misoPackageId: string): Promise<ReleaseAdminCap[]>;
+export declare function deriveReleaseAdminCapId(releaseId: string, misoPackageId: string): string;
+/** Extracts the share type `T` from a `Currency<T>` object. */
+export declare function getShareCurrencyType(client: ClientWithCoreApi, shareCurrencyId: string): Promise<string>;
+/**
+ * Finds the `TreasuryCap<ShareType>` owned by `owner`. One Core API call.
+ *
+ * Takes the share TYPE, not the `Currency` object id, because callers almost
+ * always have it already — it is {@link ShareCurrencyBinding.shareType},
+ * threaded through every builder. Taking the object id instead would force a
+ * `getObject` purely to read the type parameter back off the tag, a round trip
+ * the caller already paid for. If you genuinely hold only the currency id,
+ * compose the two:
+ *
+ * ```ts
+ * const shareType = await getShareCurrencyType(client, shareCurrencyId);
+ * const capId = await getShareCurrencyTreasuryCap(client, shareType, owner);
+ * ```
+ */
+export declare function getShareCurrencyTreasuryCap(client: ClientWithCoreApi, shareType: string, owner: string): Promise<string>;
+//# sourceMappingURL=queries.d.ts.map

package/dist/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAgB5D,OAAO,KAAK,EACV,WAAW,EACX,mBAAmB,EACnB,SAAS,EACT,iBAAiB,EACjB,OAAO,EACP,eAAe,EAChB,MAAM,YAAY,CAAC;AAMpB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAK3D;AAED,0EAA0E;AAC1E,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAWvE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAoB9C;AAKD,qDAAqD;AACrD,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC;CAC7B;AAsCD;;;GAGG;AACH,wBAAsB,cAAc,CAAC,CAAC,EACpC,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,CAIZ;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC;IACrC,2DAA2D;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,mDAAmD;IACnD,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAC9B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAcnB;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;CACrB;AA0BD,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAEnB;AAED,gFAAgF;AAChF,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC/B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAEnB;AAMD,8EAA8E;AAC9E,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,MAAM;;GAGnB;AA2CD,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,wBAAwB;IACvC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAC7C;AAYD;;;;;;;GAOG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,cAAc,EAC1B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,wBAAwB,CAAC,CAoGnC;AAED,MAAM,WAAW,OAAO;IACtB,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACnD,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAC/C,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC5C;AAED,gFAAgF;AAChF,wBAAsB,aAAa,CACjC,MAAM,EAAE,iBAAiB,EACzB,GAAG,EAAE,OAAO,GACX,OAAO,CAAC,SAAS,CAAC,CA6CpB;AAMD,+DAA+D;AAC/D,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,iBAAiB,EACzB,cAAc,EAAE,MAAM,EAAE,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAetC;AAED,8CAA8C;AAC9C,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,WAAW,CAAC,CAItB;AAED,kEAAkE;AAClE,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,CAAC,CAGjB;AAED,+EAA+E;AAC/E,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,WAAW,CAAC,CAStB;AAED;;;;;;GAMG;AACH,wBAAsB,gCAAgC,CACpD,aAAa,EAAE,gBAAgB,EAC/B,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAGxB;AAED,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,mBAAmB,CAAC,CAG9B;AAED;;;;;;GAMG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAShC;AAED,wBAAgB,2BAA2B,CACzC,aAAa,EAAE,MAAM,EACrB,aAAa,EAAE,MAAM,GACpB,MAAM,CAMR;AAMD,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,iBAAiB,EACzB,YAAY,EAAE,MAAM,EAAE,GACrB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAepC;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,SAAS,CAAC,CAIpB;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,CAMjB;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAG3B;AAED,wBAAsB,uBAAuB,CAC3C,MAAM,EAAE,iBAAiB,EACzB,aAAa,EAAE,gBAAgB,EAC/B,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,SAAS,CAAC,CASpB;AAED,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC,CAG5B;AAED;;;;;;;GAOG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAS9B;AAED,wBAAgB,yBAAyB,CACvC,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,GACpB,MAAM,CAMR;AAMD,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAYlC;AAED,wBAAsB,cAAc,CAClC,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC,CAOlB;AAED,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,iBAAiB,EACzB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,eAAe,CAAC,CAS1B;AAED,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,eAAe,EAAE,CAAC,CAc5B;AAED,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,GACpB,MAAM,CAMR;AAMD,+DAA+D;AAC/D,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,iBAAiB,EACzB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,MAAM,CAAC,CAGjB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC,CASjB"}