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

package/dist/declarations/src/interfaces/resources/franchise.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Core data model for franchise.
+ *
+ * @public
+ */
+export interface Franchise {
+    franchiseId: string;
+    franchiseName: string;
+    ownerAddress: string;
+    tokenUri: string;
+}
+/**
+ * Request interface for franchise.get method.
+ *
+ * @public
+ */
+export interface GetFranchiseRequest {
+    franchiseId: string;
+}
+/**
+ * Response interface for franchise.get method.
+ *
+ * @public
+ */
+export interface GetFranchiseResponse {
+    data: Franchise;
+}
+/**
+ * Request interface for franchise.create method.
+ *
+ * @public
+ */
+export interface CreateFranchiseRequest {
+    franchiseName: string;
+    franchiseSymbol: string;
+    franchiseDescription: string;
+}
+/**
+ * Response interface for franchise.create method.
+ *
+ * @public
+ */
+export interface CreateFranchiseResponse {
+    txHash: string;
+}
+/**
+ * Response interface for franchise.list method.
+ *
+ * @public
+ */
+export interface ListFranchiseResponse {
+    data: Franchise[];
+}
+/**
+ * Request interface for franchise.configure method.
+ *
+ * @public
+ */
+export interface ConfigureFranchiseRequest {
+    franchiseId: string;
+}
+/**
+ * Response interface for franchise.configure method.
+ *
+ * @public
+ */
+export interface ConfigureFranchiseResponse {
+    txHash: string;
+}
+//# sourceMappingURL=franchise.d.ts.map

package/dist/declarations/src/interfaces/resources/franchise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"franchise.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["franchise.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AACD;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB"}

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

@@ -0,0 +1,70 @@
+import { ipAssetType } from "../../enums/ipAssetType.js";
+/**
+ * Core data model for IP Asset.
+ *
+ * @public
+ */
+export interface ipAsset {
+    ipAssetId: string;
+    franchiseId: string;
+    ipAssetName: string;
+    ipAssetType: ipAssetType;
+    ownerAddress: string;
+    tokenUri: string;
+}
+/**
+ * Request interface for ipAsset.get method.
+ *
+ * @public
+ */
+export interface GetIpAssetRequest {
+    ipAssetId: string;
+    franchiseId: string;
+}
+/**
+ * Response interface for ipAsset.get method.
+ *
+ * @public
+ */
+export interface GetIpAssetResponse {
+    data: ipAsset;
+}
+/**
+ * Request interface for ipAsset.create method.
+ *
+ * @public
+ */
+export interface CreateIpAssetRequest {
+    franchiseId: string;
+    ipAssetType: ipAssetType;
+    ipAssetName: string;
+    description: string;
+    mediaUrl: string;
+    to: string;
+    parentIpAssetId: string;
+}
+/**
+ * Response interface for ipAsset.create method.
+ *
+ * @public
+ */
+export interface CreateIpAssetResponse {
+    txHash: string;
+}
+/**
+ * Request interface for ipAsset.list method.
+ *
+ * @public
+ */
+export interface ListIpAssetRequest {
+    franchiseId: string;
+}
+/**
+ * Response interface for ipAsset.list method.
+ *
+ * @public
+ */
+export interface ListIpAssetResponse {
+    data: ipAsset[];
+}
+//# sourceMappingURL=ipAsset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mCAAgC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB"}

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

@@ -0,0 +1,78 @@
+import { BytesLike } from "ethers";
+/**
+ * Represents the core data model for a License, containing essential information.
+ *
+ * @public
+ */
+export interface License {
+    licenseId: string;
+    ipAssetId: string;
+    franchiseId: string;
+    ownerAddress: string;
+    uri: string;
+    txHash: string;
+}
+/**
+ * Represents the request structure for retrieving license details using the `franchise.get` method.
+ *
+ * @public
+ */
+export interface GetLicenseRequest {
+    licenseId: string;
+}
+/**
+ * Represents the response structure for retrieving license details using the `license.get` method.
+ *
+ * @public
+ */
+export interface GetLicenseResponse {
+    data: License;
+}
+export interface ListLicenseRequest {
+    ipAssetId: string;
+    franchiseId: string;
+}
+/**
+ * Represents the request structure for listing multiple licenses using the `license.list` method.
+ *
+ * @public
+ */
+export interface ListLicenseResponse {
+    data: License[];
+}
+/**
+ * Represents the optional parameters for creating a new license using the `license.create` method.
+ *
+ * @public
+ */
+export interface CreateLicenseRequestOptions {
+    parentLicenseId?: string;
+    ownerAddress?: string;
+    revoker?: string;
+    isCommercial?: boolean;
+    isSublicensable?: boolean;
+    terms?: {
+        processor: string;
+        data: BytesLike | string;
+    };
+}
+/**
+ * Represents the request structure for creating a new license using the `license.create` method.
+ *
+ * @public
+ */
+export interface CreateLicenseRequest {
+    franchiseId: string;
+    ipAssetId: string;
+    licenseURI: string;
+    options?: CreateLicenseRequestOptions;
+}
+/**
+ * Represents the response structure for creating a new license using the `license.create` method.
+ *
+ * @public
+ */
+export interface CreateLicenseResponse {
+    txHash: string;
+}
+//# sourceMappingURL=license.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB"}

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

@@ -0,0 +1,83 @@
+import { BigNumberish } from "ethers";
+/**
+ * Core interface for relationship IPAsset.
+ *
+ * @public
+ */
+export interface IPAsset {
+    franchiseId: string;
+    ipAssetId: string;
+}
+/**
+ * Request interface for relationship.relate method.
+ *
+ * @public
+ */
+export interface RelationshipRelateRequest {
+    sourceIPAsset: IPAsset;
+    destIPAsset: IPAsset;
+    ttl?: BigNumberish;
+}
+/**
+ * Response interface for relationship.relate method.
+ *
+ * @public
+ */
+export interface RelationshipRelateResponse {
+    txHash: string;
+}
+/**
+ * Request interface for relationship.unrelate method.
+ *
+ * @public
+ */
+export interface RelationshipUnrelateRequest {
+    sourceIPAsset: IPAsset;
+    destIPAsset: IPAsset;
+    ttl?: BigNumberish;
+}
+/**
+ * Response interface for relationship.unrelate method.
+ *
+ * @public
+ */
+export interface RelationshipUnrelateResponse {
+    txHash: string;
+}
+/**
+ * Request interface for relationship.isRelationshipExpired method.
+ *
+ * @public
+ */
+export interface RelationshipIsRelationshipExpiredRequest {
+    sourceIPAsset: IPAsset;
+    destIPAsset: IPAsset;
+    ttl?: BigNumberish;
+}
+/**
+ * Response interface for relationship.isRelationshipExpired method.
+ *
+ * @public
+ */
+export interface RelationshipIsRelationshipExpiredResponse {
+    result: boolean;
+}
+/**
+ * Request interface for relationship.isRelated method.
+ *
+ * @public
+ */
+export interface RelationshipIsRelatedRequest {
+    sourceIPAsset: IPAsset;
+    destIPAsset: IPAsset;
+    ttl?: BigNumberish;
+}
+/**
+ * Response interface for relationship.isRelated method.
+ *
+ * @public
+ */
+export interface RelationshipIsRelatedResponse {
+    result: boolean;
+}
+//# sourceMappingURL=relationship.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["relationship.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AACD;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB;AACD;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,yCAAyC;IACxD,MAAM,EAAE,OAAO,CAAC;CACjB;AACD;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,CAAC,EAAE,YAAY,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,OAAO,CAAC;CACjB"}

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

@@ -0,0 +1,46 @@
+/**
+ * Core data model for transactions.
+ *
+ * @public
+ */
+export interface Transaction {
+    txId: string;
+    txHash: string;
+    createdAt: string;
+    creatorAddress: string;
+    type: ResourceType;
+    resourceId: string;
+    franchiseId: string;
+}
+export declare enum ResourceType {
+    FRANCHISE = 0,
+    IP_ASSET = 1,
+    LICENSE = 2,
+    RELATIONSHIP = 3,
+    COLLECT = 4
+}
+/**
+ * Request interface for transaction.get method.
+ *
+ * @public
+ */
+export interface GetTransactionRequest {
+    txId: string;
+}
+/**
+ * Response interface for transaction.get method.
+ *
+ * @public
+ */
+export interface GetTransactionResponse {
+    data: Transaction;
+}
+/**
+ * Response interface for transaction.list method.
+ *
+ * @public
+ */
+export interface ListTransactionResponse {
+    data: Transaction[];
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/declarations/src/interfaces/resources/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../../src/interfaces/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,oBAAY,YAAY;IACtB,SAAS,IAAA;IACT,QAAQ,IAAA;IACR,OAAO,IAAA;IACP,YAAY,IAAA;IACZ,OAAO,IAAA;CACR;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,WAAW,EAAE,CAAC;CACrB"}

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

@@ -0,0 +1,24 @@
+import { AxiosInstance } from "axios";
+import { Signer } from "ethers";
+import { CollectIPAssetRequest, CollectIPAssetResponse, ListCollectionsRequest, ListCollectionsResponse } from "../interfaces/resources/collect.js";
+import { CollectModule } from "../abi/generated/index.js";
+export declare class CollectClient {
+    private readonly httpClient;
+    private readonly signer;
+    private readonly collectModuleContract;
+    constructor(httpClient: AxiosInstance, signer: Signer, collectModule: CollectModule);
+    /**
+     * List all collected IP Assets.
+     *
+     * @returns A Promise that resolves to the ListLicenseResponse.
+     */
+    list(request: ListCollectionsRequest): Promise<ListCollectionsResponse>;
+    /**
+     * Collect an IP Asset on Story Protocol based on the specified input collect data.
+     *
+     * @param request - the request object that contains all data needed to collect an IP Asset
+     * @returns the response object that contains results from the create franchise action
+     */
+    collect(request: CollectIPAssetRequest): Promise<CollectIPAssetResponse>;
+}
+//# sourceMappingURL=collect.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"collect.d.ts","sourceRoot":"../../../../src/resources","sources":["collect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAuB,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACxB,2CAAwC;AACzC,OAAO,EAAE,aAAa,EAAE,kCAAyB;AAGjD,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAgB;gBAE1C,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa;IAMnF;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAWpF;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAkBtF"}

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

@@ -0,0 +1,41 @@
+import { AxiosInstance } from "axios";
+import { GetFranchiseRequest, GetFranchiseResponse, CreateFranchiseRequest, CreateFranchiseResponse, ListFranchiseResponse, ConfigureFranchiseRequest, ConfigureFranchiseResponse } from "../interfaces/resources/franchise.js";
+import { FranchiseRegistry, LicensingModule } from "../abi/generated/index.js";
+/**
+ * FranchiseClient allows you to create, update, view, search franchises on
+ * Story Protocol.
+ */
+export declare class FranchiseClient {
+    private readonly httpClient;
+    private readonly franchiseRegistry;
+    private readonly licenseModule;
+    constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry, licenseModule: LicensingModule);
+    /**
+     * Get a franchise data based on the specified franchise id.
+     *
+     * @param request - the request object for getting the franchise
+     * @returns the response object that contains the fetched franchise object
+     */
+    get(request: GetFranchiseRequest): Promise<GetFranchiseResponse>;
+    /**
+     * List all franchises.
+     *
+     * @returns the response object that contains a list of franchises
+     */
+    list(): Promise<ListFranchiseResponse>;
+    /**
+     * Create a franchise on Story Protocol based on the specified input franchise data.
+     *
+     * @param request - the request object that contains all data needed to create a franchise
+     * @returns the response object that contains results from the create franchise action
+     */
+    create(request: CreateFranchiseRequest): Promise<CreateFranchiseResponse>;
+    /**
+     * Configure a franchise on Story Protocol.
+     *
+     * @param request - the request object that contains all data needed to configure a franchise
+     * @returns the response object that contains results from the configure franchise action
+     */
+    configure(request: ConfigureFranchiseRequest): Promise<ConfigureFranchiseResponse>;
+}
+//# sourceMappingURL=franchise.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"franchise.d.ts","sourceRoot":"../../../../src/resources","sources":["franchise.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAGtC,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,0BAA0B,EAC3B,6CAA0C;AAG3C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,kCAAyB;AAEtE;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAkB;gBAG9C,UAAU,EAAE,aAAa,EACzB,iBAAiB,EAAE,iBAAiB,EACpC,aAAa,EAAE,eAAe;IAOhC;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAc7E;;;;OAIG;IACU,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC;IASnD;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAoBtF;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CA+BhG"}

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

@@ -0,0 +1,40 @@
+import { AxiosInstance } from "axios";
+import { Signer } from "ethers";
+import { GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../interfaces/resources/ipAsset.js";
+import { FranchiseRegistry } from "../abi/generated/index.js";
+/**
+ * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ */
+export declare class IpAssetClient {
+    private readonly httpClient;
+    private readonly franchiseRegistry;
+    private readonly signer;
+    constructor(httpClient: AxiosInstance, franchiseRegistry: FranchiseRegistry, signer: Signer);
+    /**
+     * Get the ipAssetRegistry associated with a franchiseId.
+     *
+     * @returns the response object that contains the requested ipAssetRegistry.
+     */
+    private getRegistry;
+    /**
+     * Get an IP Asset based on the specified IP asset ID.
+     *
+     * @param request - the request object for getting an IP Asset.
+     * @returns the response object the contains the fetched IP Asset.
+     */
+    get(request: GetIpAssetRequest): Promise<GetIpAssetResponse>;
+    /**
+     * Create an IP Asset on Story Protocol based on the specified input asset data.
+     *
+     * @param request - the request object that contains all data needed to create an IP Asset.
+     * @returns the response object that contains results from the asset creation.
+     */
+    create(request: CreateIpAssetRequest): Promise<CreateIpAssetResponse>;
+    /**
+     * List all IP assets.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+    list(request: ListIpAssetRequest): Promise<ListIpAssetResponse>;
+}
+//# sourceMappingURL=ipAsset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipAsset.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAsset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,EACpB,2CAAwC;AAGzC,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAG/E;;GAEG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM;IAM3F;;;;OAIG;YACW,WAAW;IAUzB;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAezE;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA0BlF;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAQ7E"}

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

@@ -0,0 +1,36 @@
+import { AxiosInstance } from "axios";
+import { Signer } from "ethers";
+import { GetLicenseRequest, GetLicenseResponse, ListLicenseResponse, CreateLicenseRequest, CreateLicenseResponse, ListLicenseRequest } from "../interfaces/resources/license.js";
+import { FranchiseRegistry } from "../abi/generated/index.js";
+/**
+ * A class representing License operations.
+ *
+ * @public
+ */
+export declare class LicenseClient {
+    private readonly httpClient;
+    private readonly signer;
+    private readonly franchiseRegistry;
+    constructor(httpClient: AxiosInstance, signer: Signer, franchiseRegistry: FranchiseRegistry);
+    /**
+     * Get a license by its ID.
+     *
+     * @param licenseId - The ID of the license to retrieve.
+     * @returns A Promise that resolves to the GetLicenseResponse.
+     */
+    get(request: GetLicenseRequest): Promise<GetLicenseResponse>;
+    /**
+     * List all licenses.
+     *
+     * @returns A Promise that resolves to the ListLicenseResponse.
+     */
+    list(request: ListLicenseRequest): Promise<ListLicenseResponse>;
+    /**
+     * Create a license within the Story Protocol based on the specified input data.
+     *
+     * @param request - An object containing the necessary data to create a license.
+     * @returns A response object containing the result of the create license action, including the transaction hash.
+     */
+    create(request: CreateLicenseRequest): Promise<CreateLicenseResponse>;
+}
+//# sourceMappingURL=license.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,MAAM,EAAkC,MAAM,QAAQ,CAAC;AAEhE,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EACnB,2CAAwC;AACzC,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAI/E;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;gBAE1C,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;IAM3F;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAczE;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY5E;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAyDnF"}

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

@@ -0,0 +1,48 @@
+import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
+import { RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse } from "../interfaces/resources/relationship.js";
+import { FranchiseRegistry } from "../abi/generated/index.js";
+/**
+ * Client for managing relationships.
+ */
+export declare class RelationshipClient {
+    private readonly relationshipModule;
+    private readonly franchiseRegistry;
+    /**
+     * Creates a new RelationshipClient instance.
+     * @param relationshipModule - The relationship module to interact with.
+     * @param franchiseRegistry - The franchise registry to interact with.
+     */
+    constructor(relationshipModule: RelationshipModule, franchiseRegistry: FranchiseRegistry);
+    /**
+     * Retrieves the registry addresses for source and destination franchises.
+     * @param sourceFranchiseId - The ID of the source franchise.
+     * @param destFranchiseId - The ID of the destination franchise.
+     * @returns An object containing the source and destination IP registry addresses.
+     */
+    private getRegistryAddresses;
+    /**
+     * Establishes a relationship between two IP assets.
+     * @param request - The request for establishing the relationship.
+     * @returns A promise that resolves to the response with the transaction hash.
+     */
+    relate(request: RelationshipRelateRequest): Promise<RelationshipRelateResponse>;
+    /**
+     * Removes a relationship between two IP assets.
+     * @param request - The request for removing the relationship.
+     * @returns A promise that resolves to the response with the transaction hash.
+     */
+    unrelate(request: RelationshipUnrelateRequest): Promise<RelationshipUnrelateResponse>;
+    /**
+     * Checks if a relationship has expired.
+     * @param request - The request for checking the relationship's expiration status.
+     * @returns A promise that resolves to the response indicating whether the relationship has expired.
+     */
+    isRelationshipExpired(request: RelationshipIsRelationshipExpiredRequest): Promise<RelationshipIsRelationshipExpiredResponse>;
+    /**
+     * Checks if two IP assets are related.
+     * @param request - The request for checking the relationship between two IP assets.
+     * @returns A promise that resolves to the response indicating whether the IP assets are related.
+     */
+    isRelated(request: RelationshipIsRelatedRequest): Promise<RelationshipIsRelatedResponse>;
+}
+//# sourceMappingURL=relationship.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relationship.d.ts","sourceRoot":"../../../../src/resources","sources":["relationship.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,+CAA4C;AACzE,OAAO,EACL,4BAA4B,EAC5B,6BAA6B,EAC7B,wCAAwC,EACxC,yCAAyC,EACzC,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC7B,gDAA6C;AAE9C,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAErD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAqB;IACxD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IAEtD;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;IAKxF;;;;;OAKG;YACW,oBAAoB;IAwBlC;;;;OAIG;IACU,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAiC5F;;;;OAIG;IACU,QAAQ,CACnB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IA+BxC;;;;OAIG;IACU,qBAAqB,CAChC,OAAO,EAAE,wCAAwC,GAChD,OAAO,CAAC,yCAAyC,CAAC;IA+BrD;;;;OAIG;IACU,SAAS,CACpB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,6BAA6B,CAAC;CA8B1C"}

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

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { GetTransactionRequest, GetTransactionResponse, ListTransactionResponse } from "../interfaces/resources/transaction.js";
+/**
+ * TransactionClient allows you to view and monitor transactions on
+ * Story Protocol.
+ */
+export declare class TransactionClient {
+    private readonly httpClient;
+    constructor(httpClient: AxiosInstance);
+    /**
+     * 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(): Promise<ListTransactionResponse>;
+}
+//# sourceMappingURL=transaction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAGrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACxB,+CAA4C;AAE7C;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;gBAE/B,UAAU,EAAE,aAAa;IAIrC;;;;;OAKG;IACU,GAAG,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASjF;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,uBAAuB,CAAC;CAQtD"}

package/dist/story-protocol-core-sdk.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index";
+//# sourceMappingURL=story-protocol-core-sdk.cjs.d.ts.map

package/dist/story-protocol-core-sdk.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"story-protocol-core-sdk.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}