@story-protocol/core-sdk 0.1.0-alpha-rc.1

package/dist/declarations/src/resources/transactionReadOnly.d.ts

@@ -0,0 +1,27 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetTransactionRequest, GetTransactionResponse, ListTransactionRequest, ListTransactionResponse } from "../types/resources/transaction.js";
+/**
+ * TransactionClient allows you to view and monitor transactions on
+ * Story Protocol.
+ */
+export declare class TransactionReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get transaction data based on the specified transaction id.
+     *
+     * @param request - the request object for getting the transaction
+     * @returns the response object that contains the fetched transaction object
+     */
+    get(request: GetTransactionRequest): Promise<GetTransactionResponse>;
+    /**
+     * Get transaction data based on the specified transaction id.
+     *
+     * @param request - the request object for getting the transactions
+     * @returns the response object that contains the fetched transaction object
+     */
+    list(request?: ListTransactionRequest): Promise<ListTransactionResponse>;
+}
+//# sourceMappingURL=transactionReadOnly.d.ts.map

package/dist/declarations/src/resources/transactionReadOnly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["transactionReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;gBAE/B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY;IAK9D;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAQtF"}

package/dist/declarations/src/types/client.d.ts

@@ -0,0 +1,35 @@
+import { LicenseReadOnlyClient } from "../resources/licenseReadOnly.js";
+import { TransactionClient } from "../resources/transaction.js";
+import { TransactionReadOnlyClient } from "../resources/transactionReadOnly.js";
+import { IPAssetClient } from "../resources/ipAsset.js";
+import { IPAssetReadOnlyClient } from "../resources/ipAssetReadOnly.js";
+import { RelationshipReadOnlyClient } from "../resources/relationshipReadOnly.js";
+import { IPOrgReadOnlyClient } from "../resources/ipOrgReadOnly.js";
+import { IPOrgClient } from "../resources/ipOrg.js";
+import { ModuleReadOnlyClient } from "../resources/moduleReadOnly.js";
+import { ModuleClient } from "../resources/module.js";
+import { HookReadOnlyClient } from "../resources/hookReadOnly.js";
+import { HookClient } from "../resources/hook.js";
+import { PlatformClient } from "../utils/platform.js";
+import { LicenseClient } from "../resources/license.js";
+import { RelationshipClient } from "../resources/relationship.js";
+export interface ReadOnlyClient {
+    hook: HookReadOnlyClient;
+    module: ModuleReadOnlyClient;
+    ipOrg: IPOrgReadOnlyClient;
+    license: LicenseReadOnlyClient;
+    transaction: TransactionReadOnlyClient;
+    ipAsset: IPAssetReadOnlyClient;
+    relationship: RelationshipReadOnlyClient;
+}
+export interface Client {
+    hook: HookClient;
+    module: ModuleClient;
+    ipOrg: IPOrgClient;
+    license: LicenseClient;
+    transaction: TransactionClient;
+    ipAsset: IPAssetClient;
+    relationship: RelationshipClient;
+    platform: PlatformClient;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/declarations/src/types/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../../src/types","sources":["client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,iBAAiB,EAAE,oCAAiC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,4CAAyC;AAC7E,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,0BAA0B,EAAE,6CAA0C;AAC/E,OAAO,EAAE,mBAAmB,EAAE,sCAAmC;AACjE,OAAO,EAAE,WAAW,EAAE,8BAA2B;AACjD,OAAO,EAAE,oBAAoB,EAAE,uCAAoC;AACnE,OAAO,EAAE,YAAY,EAAE,+BAA4B;AACnD,OAAO,EAAE,kBAAkB,EAAE,qCAAkC;AAC/D,OAAO,EAAE,UAAU,EAAE,6BAA0B;AAC/C,OAAO,EAAE,cAAc,EAAE,6BAA0B;AACnD,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,kBAAkB,EAAE,qCAAkC;AAE/D,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,KAAK,EAAE,mBAAmB,CAAC;IAC3B,OAAO,EAAE,qBAAqB,CAAC;IAC/B,WAAW,EAAE,yBAAyB,CAAC;IACvC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,YAAY,EAAE,0BAA0B,CAAC;CAC1C;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,KAAK,EAAE,WAAW,CAAC;IACnB,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,YAAY,EAAE,kBAAkB,CAAC;IACjC,QAAQ,EAAE,cAAc,CAAC;CAC1B"}

package/dist/declarations/src/types/config.d.ts

@@ -0,0 +1,18 @@
+import { Account, Chain, Transport } from "viem";
+import { Environment } from "../enums/Environment.js";
+/**
+ * Configuration for the SDK Client.
+ *
+ * @public
+ */
+export interface StoryCommonConfig {
+    readonly environment: Environment;
+}
+export interface StoryConfig extends StoryReadOnlyConfig {
+    readonly account: Account;
+}
+export interface StoryReadOnlyConfig extends StoryCommonConfig {
+    readonly chain?: Chain;
+    readonly transport?: Transport;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/declarations/src/types/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjD,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;CAChC"}

package/dist/declarations/src/types/options.d.ts

@@ -0,0 +1,10 @@
+export type TxOptions = {
+    waitForTransaction?: boolean;
+};
+export type QueryOptions = {
+    pagination?: {
+        offset?: number;
+        limit?: number;
+    };
+};
+//# sourceMappingURL=options.d.ts.map

package/dist/declarations/src/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"../../../../src/types","sources":["options.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG;IACtB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC"}

package/dist/declarations/src/types/resources/IPOrg.d.ts

@@ -0,0 +1,71 @@
+import { QueryOptions, TxOptions } from "../options.js";
+/**
+ * Core data model for franchise.
+ *
+ * @public
+ */
+export type IPOrg = {
+    id: string;
+    name: string;
+    symbol: string;
+    owner: string;
+    baseUri?: string;
+    contractUri?: string;
+    ipAssetTypes: string[];
+    createdAt: string;
+    txHash: string;
+};
+/**
+ * Request type for franchise.get method.
+ *
+ * @public
+ */
+export type GetIPOrgRequest = {
+    ipOrgId: string;
+};
+/**
+ * Response type for franchise.get method.
+ *
+ * @public
+ */
+export type GetIPOrgResponse = {
+    ipOrg: IPOrg;
+};
+/**
+ * Request type for franchise.create method.
+ *
+ * @public
+ */
+export type CreateIPOrgRequest = {
+    name: string;
+    symbol: string;
+    owner?: string;
+    ipAssetTypes: Array<string>;
+    txOptions?: TxOptions;
+};
+/**
+ * Response type for franchise.create method.
+ *
+ * @public
+ */
+export type CreateIPOrgResponse = {
+    txHash: string;
+    ipOrgId?: string;
+};
+/**
+ * Request type for franchise.list method.
+ *
+ * @public
+ */
+export type ListIPOrgRequest = {
+    options?: QueryOptions;
+};
+/**
+ * Response type for franchise.list method.
+ *
+ * @public
+ */
+export type ListIPOrgResponse = {
+    ipOrgs: IPOrg[];
+};
+//# sourceMappingURL=IPOrg.d.ts.map

package/dist/declarations/src/types/resources/IPOrg.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPOrg.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["IPOrg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD;;;;GAIG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC"}

package/dist/declarations/src/types/resources/hook.d.ts

@@ -0,0 +1,49 @@
+import { QueryOptions } from "../options.js";
+/**
+ * Core data model for Hook.
+ *
+ * @public
+ */
+export type Hook = {
+    id: string;
+    moduleId: string;
+    interface?: string;
+    hookType: number;
+    registryKey: string;
+    registeredAt: string;
+    txHash: string;
+};
+/**
+ * Request type for hook.get method.
+ *
+ * @public
+ */
+export type GetHookRequest = {
+    hookId: string;
+};
+/**
+ * Response type for hook.get method.
+ *
+ * @public
+ */
+export type GetHookResponse = {
+    hook: Hook;
+};
+/**
+ * Request type for hook.list method.
+ *
+ * @public
+ */
+export type ListHookRequest = {
+    moduleId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Response type for hook.list method.
+ *
+ * @public
+ */
+export type ListHookResponse = {
+    hooks: Hook[];
+};
+//# sourceMappingURL=hook.d.ts.map

package/dist/declarations/src/types/resources/hook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hook.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,sBAAmB;AAE1C;;;;GAIG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC"}

package/dist/declarations/src/types/resources/ipAsset.d.ts

@@ -0,0 +1,76 @@
+import { QueryOptions, TxOptions } from "../options.js";
+/**
+ * Core data model for IP Asset.
+ *
+ * @public
+ */
+export type IPAsset = {
+    id: string;
+    name: string;
+    type: number;
+    ipOrgId: string;
+    owner: string;
+    mediaUrl: string;
+    contentHash?: string;
+    createdAt: string;
+    txHash: string;
+};
+/**
+ * Request type for ipAsset.get method.
+ *
+ * @public
+ */
+export type GetIpAssetRequest = {
+    ipAssetId: string;
+};
+/**
+ * Response type for ipAsset.get method.
+ *
+ * @public
+ */
+export type GetIpAssetResponse = {
+    ipAsset: IPAsset;
+};
+/**
+ * Request type for ipAsset.create method.
+ *
+ * @public
+ */
+export type CreateIpAssetRequest = {
+    name: string;
+    type: number;
+    ipOrgId: string;
+    owner: string;
+    mediaUrl?: string;
+    contentHash?: string;
+    preHookData?: Array<Record<string, unknown>>;
+    postHookData?: Array<Record<string, unknown>>;
+    txOptions?: TxOptions;
+};
+/**
+ * Response type for ipAsset.create method.
+ *
+ * @public
+ */
+export type CreateIpAssetResponse = {
+    txHash: string;
+    ipAssetId?: string;
+};
+/**
+ * Request type for ipAsset.list method.
+ *
+ * @public
+ */
+export type ListIpAssetRequest = {
+    ipOrgId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Response type for ipAsset.list method.
+ *
+ * @public
+ */
+export type ListIpAssetResponse = {
+    ipAssets: IPAsset[];
+};
+//# sourceMappingURL=ipAsset.d.ts.map

package/dist/declarations/src/types/resources/ipAsset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7C,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC"}

package/dist/declarations/src/types/resources/license.d.ts

@@ -0,0 +1,85 @@
+import { QueryOptions, TxOptions } from "../options.js";
+/**
+ * Represents the core data model for a License, containing essential information.
+ *
+ * @public
+ */
+export type License = {
+    id: number;
+    isCommercial: boolean;
+    status: number;
+    licensor: string;
+    revoker: string;
+    ipOrgId: string;
+    licenseeType: number;
+    ipAssetId: string;
+    parentLicenseId: string;
+    termIds: string[];
+    termsData: string[];
+    createdAt: string;
+    txHash: string;
+};
+interface CreateLicenseRequest {
+    ipOrgId: string;
+    parentLicenseId?: string;
+    isCommercial: boolean;
+    preHooksCalldata?: Record<string, undefined>[];
+    postHooksCalldata?: Record<string, undefined>[];
+    txOptions?: TxOptions;
+}
+/**
+ * Represents the request structure for creating a new license NFT (createLicenseNft on StoryProtocol.sol)
+ *
+ * @public
+ */
+export interface CreateLicenseNftRequest extends CreateLicenseRequest {
+    licensee: string;
+}
+/**
+ * Represents the request structure for creating a new IPA-bound license (createIpaBoundLicense on StoryProtocol.sol)
+ *
+ * @public
+ */
+export interface CreateIpaBoundLicenseRequest extends CreateLicenseRequest {
+    ipaId: number;
+}
+/**
+ * Represents the request structure for retrieving license details using the `franchise.get` method.
+ *
+ * @public
+ */
+export type GetLicenseRequest = {
+    licenseId: string;
+};
+/**
+ * Represents the response structure for retrieving license details using the `license.get` method.
+ *
+ * @public
+ */
+export type GetLicenseResponse = {
+    license: License;
+};
+export type ListLicenseRequest = {
+    ipOrgId?: string;
+    ipAssetId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Represents the request structure for listing multiple licenses using the `license.list` method.
+ *
+ * @public
+ */
+export type ListLicenseResponse = {
+    licenses: License[];
+};
+/**
+ * Represents the response structure for creating a new license using the `license.create` method.
+ *
+ * @public
+ */
+export type CreateLicenseResponse = {
+    txHash: string;
+    licenseId?: string;
+};
+export {};
+//# sourceMappingURL=license.d.ts.map

package/dist/declarations/src/types/resources/license.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,UAAU,oBAAoB;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;IAC/C,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;IAChD,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,oBAAoB;IACnE,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,oBAAoB;IACxE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/declarations/src/types/resources/module.d.ts

@@ -0,0 +1,49 @@
+import { Hook } from "./hook.js";
+import { QueryOptions } from "../options.js";
+/**
+ * Core data model for Module.
+ *
+ * @public
+ */
+export type Module = {
+    id: string;
+    ipOrgId: string;
+    moduleKey: string;
+    interface?: string;
+    preHooks?: Hook[];
+    postHooks?: Hook[];
+};
+/**
+ * Request type for module.get method.
+ *
+ * @public
+ */
+export type GetModuleRequest = {
+    moduleId: string;
+};
+/**
+ * Response type for module.get method.
+ *
+ * @public
+ */
+export type GetModuleResponse = {
+    module: Module;
+};
+/**
+ * Request type for module.list method.
+ *
+ * @public
+ */
+export type ListModuleRequest = {
+    ipOrgId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Response type for module.list method.
+ *
+ * @public
+ */
+export type ListModuleResponse = {
+    modules: Module[];
+};
+//# sourceMappingURL=module.d.ts.map

package/dist/declarations/src/types/resources/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,kBAAe;AAC9B,OAAO,EAAE,YAAY,EAAE,sBAAmB;AAE1C;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC"}

package/dist/declarations/src/types/resources/relationship.d.ts

@@ -0,0 +1,158 @@
+import { QueryOptions, TxOptions } from "../options.js";
+/**
+ * Core type for relationship IPAsset.
+ *
+ * @public
+ */
+export type IPAssetId = {
+    franchiseId: string;
+    ipAssetId: string;
+};
+/**
+ * Request type for relationship.relate method.
+ *
+ * @public
+ */
+export type RelationshipRelateRequest = {
+    sourceIPAsset: IPAssetId;
+    destIPAsset: IPAssetId;
+    ttl?: string;
+};
+/**
+ * Response type for relationship.relate method.
+ *
+ * @public
+ */
+export type RelationshipRelateResponse = {
+    txHash: string;
+};
+/**
+ * Request type for relationship.unrelate method.
+ *
+ * @public
+ */
+export type RelationshipUnrelateRequest = {
+    sourceIPAsset: IPAssetId;
+    destIPAsset: IPAssetId;
+    ttl?: string;
+};
+/**
+ * Response type for relationship.unrelate method.
+ *
+ * @public
+ */
+export type RelationshipUnrelateResponse = {
+    txHash: string;
+};
+/**
+ * Request type for relationship.isRelationshipExpired method.
+ *
+ * @public
+ */
+export type RelationshipIsRelationshipExpiredRequest = {
+    sourceIPAsset: IPAssetId;
+    destIPAsset: IPAssetId;
+    ttl?: string;
+};
+/**
+ * Response type for relationship.isRelationshipExpired method.
+ *
+ * @public
+ */
+export type RelationshipIsRelationshipExpiredResponse = {
+    result: boolean;
+};
+/**
+ * Request type for relationship.isRelated method.
+ *
+ * @public
+ */
+export type RelationshipIsRelatedRequest = {
+    sourceIPAsset: IPAssetId;
+    destIPAsset: IPAssetId;
+    ttl?: string;
+};
+/**
+ * Response type for relationship.isRelated method.
+ *
+ * @public
+ */
+export type RelationshipIsRelatedResponse = {
+    result: boolean;
+};
+declare enum Relatables {
+    UNDEFINED = 0,
+    IPA = 1,
+    IPORG_ENTRY = 2,
+    LICENSE = 3,
+    ADDRESS = 4,
+    EXTERNAL_NFT = 5
+}
+export interface RelatedElements {
+    src: Relatables;
+    dst: Relatables;
+}
+export type Relationship = {
+    id: string;
+    type: string;
+    typeId: string;
+    srcContract: string;
+    srcTokenId: string;
+    srcName?: string;
+    dstContract: string;
+    dstTokenId: string;
+    dstName?: string;
+    ttl?: number;
+    registeredAt: string;
+    txHash: string;
+};
+export type RegisterRelationshipRequest = {
+    ipOrgId: string;
+    relType: string;
+    srcContract: string;
+    srcTokenId: string;
+    srcType?: string;
+    dstContract: string;
+    dstTokenId: string;
+    dstType?: string;
+    preHookData: Record<string, unknown>[];
+    postHookData: Record<string, unknown>[];
+    txOptions?: TxOptions;
+};
+export type RegisterRelationshipResponse = {
+    txHash: string;
+    relationshipId?: string;
+    success?: boolean;
+};
+export type GetRelationshipRequest = {
+    relationshipId: string;
+    options?: QueryOptions;
+};
+export type GetRelationshipResponse = {
+    relationship: Relationship;
+};
+export type ListRelationshipRequest = {
+    tokenId: string;
+    contract?: string;
+    options?: QueryOptions;
+};
+export type ListRelationshipResponse = {
+    relationships: Relationship[];
+};
+export type RegisterRelationshipTypeRequest = {
+    ipOrgId: string;
+    relType: string;
+    relatedElements: RelatedElements;
+    allowedSrcs: string[];
+    allowedDsts: string[];
+    preHooksConfig: Record<string, unknown>[];
+    postHooksConfig: Record<string, unknown>[];
+    txOptions?: TxOptions;
+};
+export type RegisterRelationshipTypeResponse = {
+    txHash: string;
+    success?: boolean;
+    relationshipId?: string;
+};
+export {};
+//# sourceMappingURL=relationship.d.ts.map

package/dist/declarations/src/types/resources/relationship.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/types/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAmB;AAErD;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,aAAa,EAAE,SAAS,CAAC;IACzB,WAAW,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,aAAK,UAAU;IACb,SAAS,IAAA;IACT,GAAG,IAAA;IACH,WAAW,IAAA;IACX,OAAO,IAAA;IACP,OAAO,IAAA;IACP,YAAY,IAAA;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,UAAU,CAAC;IAChB,GAAG,EAAE,UAAU,CAAC;CACjB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACxC,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB,CAAC;AACF,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAC3C,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/declarations/src/types/resources/transaction.d.ts

@@ -0,0 +1,52 @@
+import { ResourceType } from "../../enums/ResourceType.js";
+import { ActionType } from "../../enums/ActionType.js";
+import { QueryOptions } from "../options.js";
+/**
+ * Core data model for transactions.
+ *
+ * @public
+ */
+export type Transaction = {
+    id: string;
+    txHash: string;
+    ipOrgId: string;
+    initiator: string;
+    resourceId: string;
+    resourceType: ResourceType;
+    actionType: ActionType;
+    createdAt: string;
+};
+/**
+ * Request type for transaction.get method.
+ *
+ * @public
+ */
+export type GetTransactionRequest = {
+    transactionId: string;
+};
+/**
+ * Response type for transaction.get method.
+ *
+ * @public
+ */
+export type GetTransactionResponse = {
+    transaction: Transaction;
+};
+/**
+ * Response type for transaction.list method.
+ *
+ * @public
+ */
+export type ListTransactionRequest = {
+    ipOrgId?: string;
+    options?: QueryOptions;
+};
+/**
+ * Response type for transaction.list method.
+ *
+ * @public
+ */
+export type ListTransactionResponse = {
+    transactions: Transaction[];
+};
+//# sourceMappingURL=transaction.d.ts.map