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

package/README.md

@@ -0,0 +1,85 @@
+core-sdk is the base level sdk to interact with story protocol. It provides functions to both read and write data to the protocol.
+
+## Installation
+
+Install the SDK and ethers.js
+
+npm
+
+```shell
+npm i @story-protocol/core-sdk ethers@^5.7.2
+```
+
+pnpm
+
+```shell
+pnpm i @story-protocol/core-sdk ethers@^5.7.2
+```
+
+yarn
+
+```shell
+yarn add @story-protocol/core-sdk ethers@^5.7.2
+```
+
+## Set up `.env` file
+
+(Ask the team to provide the values)
+
+```
+NEXT_PUBLIC_API_BASE_URL =
+NEXT_PUBLIC_FRANCHISE_REGISTRY_CONTRACT =
+NEXT_PUBLIC_RELATIONSHIP_MODULE_CONTRACT =
+NEXT_PUBLIC_COLLECT_MODULE_CONTRACT =
+NEXT_PUBLIC_LICENSING_MODULE_CONTRACT =
+```
+
+## Set up SDK client
+
+Using browser wallet
+
+```typescript
+import { StoryClient } from "@story-protocol/core-sdk";
+import ethers from "ethers";
+
+// Provider/Signer from browser wallet (i.e Metamask)
+const provider = new ethers.providers.Web3Provider(window.ethereum);
+await provider.send("eth_requestAccounts", []);
+const signer = await provider.getSigner();
+
+// Instantiate a read-only Story Client with an optional provider
+const client = StoryClient.newReadOnlyClient({ provider });
+
+// Instatiate a read/write Story Client with a signer
+const client = StoryClient.newClient({ signer });
+```
+
+Using private key
+
+```typescript
+import { StoryClient } from "@story-protocol/core-sdk"
+import ethers from "ethers"
+
+// Signer from private key
+const provider = new ethers.providers.JsonRpcProvider(<YOUR RPC URL>)
+const signer = new ethers.Wallet(<YOUR PRIVATE KEY>, provider)
+
+// Instantiate the Story Client
+const client = StoryClient.newClient({ signer })
+
+```
+
+## Use SDK client
+
+```typescript
+// Create a new franchise
+const response = await client.franchise.create({
+  franchiseName: "Alice in Wonderland",
+  franchiseSymbol: "Wonderland",
+  franchiseDescription:
+    "Fantastical journey, curious girl, whimsical characters, dreamlike adventures.",
+});
+
+// List franchises
+const { data: franchise } = await client.franchise.list();
+```

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

@@ -0,0 +1,111 @@
+import { StoryConfig, StoryReadOnlyConfig } from "./types/config.js";
+import { IPOrgClient } from "./resources/ipOrg.js";
+import { IPOrgReadOnlyClient } from "./resources/ipOrgReadOnly.js";
+import { RelationshipReadOnlyClient } from "./resources/relationshipReadOnly.js";
+import { IPAssetClient } from "./resources/ipAsset.js";
+import { IPAssetReadOnlyClient } from "./resources/ipAssetReadOnly.js";
+import { LicenseReadOnlyClient } from "./resources/licenseReadOnly.js";
+import { TransactionClient } from "./resources/transaction.js";
+import { TransactionReadOnlyClient } from "./resources/transactionReadOnly.js";
+import { Client, ReadOnlyClient } from "./types/client.js";
+import { ModuleClient } from "./resources/module.js";
+import { ModuleReadOnlyClient } from "./resources/moduleReadOnly.js";
+import { HookClient } from "./resources/hook.js";
+import { HookReadOnlyClient } from "./resources/hookReadOnly.js";
+import { PlatformClient } from "./utils/platform.js";
+import { LicenseClient } from "./resources/license.js";
+import { RelationshipClient } from "./resources/relationship.js";
+/**
+ * The StoryClient is the main entry point for the SDK.
+ */
+export declare class StoryClient {
+    private readonly config;
+    private readonly httpClient;
+    private readonly isReadOnly;
+    private readonly rpcClient;
+    private readonly wallet?;
+    private _ipOrg;
+    private _license;
+    private _transaction;
+    private _ipAsset;
+    private _relationship;
+    private _module;
+    private _hook;
+    private _platform;
+    /**
+     * @param config - the configuration for the SDK client
+     * @param isReadOnly
+     */
+    private constructor();
+    /**
+     * Factory method for creating a read only SDK client.
+     *
+     * @param config - the configuration for a read only SDK client
+     */
+    static newReadOnlyClient(config: StoryReadOnlyConfig): ReadOnlyClient;
+    /**
+     * Factory method for creating a SDK client with a signer.
+     *
+     * @param config - the configuration for a new read/write SDK client
+     */
+    static newClient(config: StoryConfig): Client;
+    private initIPOrg;
+    private initRelationship;
+    private initIpAsset;
+    private initLicense;
+    private initTransaction;
+    private initModule;
+    private initHook;
+    private initPlatform;
+    /**
+     * Getter for the ipOrg client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the IPOrgClient or IPOrgReadOnlyClient instance
+     */
+    get ipOrg(): IPOrgClient | IPOrgReadOnlyClient;
+    /**
+     * Getter for the relationship client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the RelationshipClient instance
+     */
+    get relationship(): RelationshipClient | RelationshipReadOnlyClient;
+    /**
+     * Getter for the IP Asset client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the IpAssetClient instance
+     */
+    get ipAsset(): IPAssetClient | IPAssetReadOnlyClient;
+    /**
+     * Getter for the license client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the License instance
+     */
+    get license(): LicenseClient | LicenseReadOnlyClient;
+    /**
+     * Getter for the transaction client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the TransactionClient instance
+     */
+    get transaction(): TransactionClient | TransactionReadOnlyClient;
+    /**
+     * Getter for the module client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the ModuleClient instance
+     */
+    get module(): ModuleClient | ModuleReadOnlyClient;
+    /**
+     * Getter for the hook client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the HookClient instance
+     */
+    get hook(): HookClient | HookReadOnlyClient;
+    get platform(): PlatformClient;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"../../../src","sources":["client.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AAElE,OAAO,EAAE,WAAW,EAAE,6BAA0B;AAChD,OAAO,EAAE,mBAAmB,EAAE,qCAAkC;AAChE,OAAO,EAAE,0BAA0B,EAAE,4CAAyC;AAC9E,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,qBAAqB,EAAE,uCAAoC;AACpE,OAAO,EAAE,iBAAiB,EAAE,mCAAgC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,2CAAwC;AAE5E,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,0BAAuB;AACxD,OAAO,EAAE,YAAY,EAAE,8BAA2B;AAClD,OAAO,EAAE,oBAAoB,EAAE,sCAAmC;AAClE,OAAO,EAAE,UAAU,EAAE,4BAAyB;AAC9C,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAC9D,OAAO,EAAE,cAAc,EAAE,4BAAyB;AAClD,OAAO,EAAE,aAAa,EAAE,+BAA4B;AACpD,OAAO,EAAE,kBAAkB,EAAE,oCAAiC;AAK9D;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoC;IAC3D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAe;IAEvC,OAAO,CAAC,MAAM,CAAkD;IAChE,OAAO,CAAC,QAAQ,CAAsC;IACtD,OAAO,CAAC,YAAY,CAA8D;IAClF,OAAO,CAAC,QAAQ,CAAsD;IACtE,OAAO,CAAC,aAAa,CAA2C;IAChE,OAAO,CAAC,OAAO,CAAoD;IACnE,OAAO,CAAC,KAAK,CAAgD;IAC7D,OAAO,CAAC,SAAS,CAA+B;IAEhD;;;OAGG;IACH,OAAO;IAoCP;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,cAAc;IAIrE;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM;IAI7C,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,YAAY;IAIpB;;;;;OAKG;IACH,IAAW,KAAK,IAAI,WAAW,GAAG,mBAAmB,CAMpD;IAED;;;;;OAKG;IACH,IAAW,YAAY,IAAI,kBAAkB,GAAG,0BAA0B,CAMzE;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,GAAG,qBAAqB,CAK1D;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,aAAa,GAAG,qBAAqB,CAM1D;IAED;;;;;OAKG;IACH,IAAW,WAAW,IAAI,iBAAiB,GAAG,yBAAyB,CAMtE;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,YAAY,GAAG,oBAAoB,CAMvD;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,UAAU,GAAG,kBAAkB,CAMjD;IAED,IAAW,QAAQ,IAAI,cAAc,CAMpC;CACF"}

package/dist/declarations/src/enums/ActionType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ */
+export declare enum ActionType {
+    UNSPECIFIED = 0,
+    REGISTER = 1,
+    UNREGISTER = 2,
+    CONFIGURE = 3,
+    CREATE = 4
+}
+//# sourceMappingURL=ActionType.d.ts.map

package/dist/declarations/src/enums/ActionType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionType.d.ts","sourceRoot":"../../../../src/enums","sources":["ActionType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,UAAU;IACpB,WAAW,IAAA;IACX,QAAQ,IAAA;IACR,UAAU,IAAA;IACV,SAAS,IAAA;IACT,MAAM,IAAA;CACP"}

package/dist/declarations/src/enums/Environment.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @public
+ */
+export declare enum Environment {
+    TEST = "TEST",
+    PROD = "PROD"
+}
+//# sourceMappingURL=Environment.d.ts.map

package/dist/declarations/src/enums/Environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Environment.d.ts","sourceRoot":"../../../../src/enums","sources":["Environment.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;CACd"}

package/dist/declarations/src/enums/IPAssetType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ */
+export declare enum IPAssetType {
+    STORY = 1,
+    CHARACTER = 2,
+    ART = 3,
+    LOCATION = 5,
+    ITEM = 6
+}
+//# sourceMappingURL=IPAssetType.d.ts.map

package/dist/declarations/src/enums/IPAssetType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPAssetType.d.ts","sourceRoot":"../../../../src/enums","sources":["IPAssetType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB,KAAK,IAAI;IACT,SAAS,IAAI;IACb,GAAG,IAAI;IACP,QAAQ,IAAI;IACZ,IAAI,IAAI;CACT"}

package/dist/declarations/src/enums/ResourceType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @public
+ */
+export declare enum ResourceType {
+    UNSPECIFIED = 0,
+    IP_ORG = 1,
+    IP_ASSET = 2,
+    LICENSE = 3,
+    RELATIONSHIP = 4,
+    RELATIONSHIPTYPE = 5,
+    MODULE = 6,
+    HOOK = 7,
+    DISPUTE = 8
+}
+//# sourceMappingURL=ResourceType.d.ts.map

package/dist/declarations/src/enums/ResourceType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResourceType.d.ts","sourceRoot":"../../../../src/enums","sources":["ResourceType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,YAAY;IACtB,WAAW,IAAA;IACX,MAAM,IAAA;IACN,QAAQ,IAAA;IACR,OAAO,IAAA;IACP,YAAY,IAAA;IACZ,gBAAgB,IAAA;IAChB,MAAM,IAAA;IACN,IAAI,IAAA;IACJ,OAAO,IAAA;CACR"}

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,13 @@
+export { StoryClient } from "./client.js";
+export { Environment } from "./enums/Environment.js";
+export { IPAssetType } from "./enums/IPAssetType.js";
+export { ResourceType } from "./enums/ResourceType.js";
+export type { StoryConfig, StoryReadOnlyConfig } from "./types/config.js";
+export type { IPOrg, GetIPOrgRequest, GetIPOrgResponse, CreateIPOrgRequest, CreateIPOrgResponse, ListIPOrgResponse, } from "./types/resources/IPOrg.js";
+export type { IPAsset, GetIpAssetRequest, GetIpAssetResponse, CreateIpAssetRequest, CreateIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse, } from "./types/resources/ipAsset.js";
+export type { License, GetLicenseRequest, GetLicenseResponse, CreateLicenseNftRequest, CreateIpaBoundLicenseRequest, CreateLicenseResponse, ListLicenseRequest, ListLicenseResponse, } from "./types/resources/license.js";
+export type { Relationship, RegisterRelationshipRequest, RegisterRelationshipResponse, ListRelationshipRequest, ListRelationshipResponse, GetRelationshipRequest, GetRelationshipResponse, RegisterRelationshipTypeRequest, RegisterRelationshipTypeResponse, } from "./types/resources/relationship.js";
+export type { Transaction, GetTransactionRequest, GetTransactionResponse, ListTransactionResponse, } from "./types/resources/transaction.js";
+export type { Module, GetModuleRequest, GetModuleResponse, ListModuleRequest, ListModuleResponse, } from "./types/resources/module.js";
+export type { Hook, GetHookRequest, GetHookResponse, ListHookRequest, ListHookResponse, } from "./types/resources/hook.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,oBAAiB;AACvC,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,YAAY,EAAE,gCAA6B;AAEpD,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,0BAAuB;AAEvE,YAAY,EACV,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,mCAAgC;AAEjC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,OAAO,EACP,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,qBAAqB,EACrB,kBAAkB,EAClB,mBAAmB,GACpB,qCAAkC;AAEnC,YAAY,EACV,YAAY,EACZ,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,+BAA+B,EAC/B,gCAAgC,GACjC,0CAAuC;AAExC,YAAY,EACV,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,GACxB,yCAAsC;AAEvC,YAAY,EACV,MAAM,EACN,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,GACnB,oCAAiC;AAElC,YAAY,EACV,IAAI,EACJ,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,GACjB,kCAA+B"}

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

@@ -0,0 +1,12 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { HookReadOnlyClient } from "./hookReadOnly.js";
+/**
+ * HookClient allows you to view and monitor hooks on
+ * Story Protocol.
+ */
+export declare class HookClient extends HookReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+}
+//# sourceMappingURL=hook.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hook.d.ts","sourceRoot":"../../../../src/resources","sources":["hook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,kBAAkB,EAAE,0BAAuB;AAEpD;;;GAGG;AACH,qBAAa,UAAW,SAAQ,kBAAkB;IAChD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}

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

@@ -0,0 +1,27 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetHookRequest, GetHookResponse, ListHookRequest, ListHookResponse } from "../types/resources/hook.js";
+/**
+ * HookClient allows you to view and monitor hooks on
+ * Story Protocol.
+ */
+export declare class HookReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get hook data based on the specified hook id.
+     *
+     * @param request - the request object for getting the hook
+     * @returns the response object that contains the fetched hook object
+     */
+    get(request: GetHookRequest): Promise<GetHookResponse>;
+    /**
+     * Get hook data based on the specified hook id.
+     *
+     * @param request - the request object for getting the hooks
+     * @returns the response object that contains the fetched hook object
+     */
+    list(request?: ListHookRequest): Promise<ListHookResponse>;
+}
+//# sourceMappingURL=hookReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hookReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["hookReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,gBAAgB,EACjB,mCAAgC;AAEjC;;;GAGG;AACH,qBAAa,kBAAkB;IAC7B,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,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASnE;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAYxE"}

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

@@ -0,0 +1,19 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { CreateIpAssetRequest, CreateIpAssetResponse } from "../types/resources/ipAsset.js";
+import { IPAssetReadOnlyClient } from "./ipAssetReadOnly.js";
+/**
+ * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ */
+export declare class IPAssetClient extends IPAssetReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    /**
+     * 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>;
+}
+//# 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,EAAc,YAAY,EAAS,YAAY,EAAE,MAAM,MAAM,CAAC;AAErE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,sCAAmC;AAEzF,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAK1D;;GAEG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAkCnF"}

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

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetIpAssetRequest, GetIpAssetResponse, ListIpAssetRequest, ListIpAssetResponse } from "../types/resources/ipAsset.js";
+/**
+ * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ */
+export declare class IPAssetReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * 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>;
+    /**
+     * List all IP assets.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+    list(request: ListIpAssetRequest): Promise<ListIpAssetResponse>;
+}
+//# sourceMappingURL=ipAssetReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipAssetReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["ipAssetReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAIpC;;GAEG;AACH,qBAAa,qBAAqB;IAChC,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,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAazE;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAQ7E"}

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

@@ -0,0 +1,20 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { CreateIPOrgRequest, CreateIPOrgResponse } from "../types/resources/IPOrg.js";
+import { IPOrgReadOnlyClient } from "./ipOrgReadOnly.js";
+/**
+ * IPOrgClient allows you to create, update, view, search IPOrgs on
+ * Story Protocol.
+ */
+export declare class IPOrgClient extends IPOrgReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    /**
+     * Create a IPOrg on Story Protocol based on the specified input IPOrg data.
+     *
+     * @param request - the request object that contains all data needed to create a IPOrg
+     * @returns the response object that contains results from the create IPOrg action
+     */
+    create(request: CreateIPOrgRequest): Promise<CreateIPOrgResponse>;
+}
+//# sourceMappingURL=ipOrg.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipOrg.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrg.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAc,YAAY,EAAE,YAAY,EAAe,MAAM,MAAM,CAAC;AAE3E,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,oCAAiC;AAEnF,OAAO,EAAE,mBAAmB,EAAE,2BAAwB;AAKtD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,mBAAmB;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA4B/E"}

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

@@ -0,0 +1,26 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetIPOrgRequest, GetIPOrgResponse, ListIPOrgRequest, ListIPOrgResponse } from "../types/resources/IPOrg.js";
+/**
+ * IPOrgReadOnlyClient allows you to view, search IPOrgs on
+ * Story Protocol.
+ */
+export declare class IPOrgReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get a IPOrg data based on the specified IPOrg id.
+     *
+     * @param request - the request object for getting the IPOrg
+     * @returns the response object that contains the fetched IPOrg object
+     */
+    get(request: GetIPOrgRequest): Promise<GetIPOrgResponse>;
+    /**
+     * List all IPOrgs.
+     *
+     * @returns the response object that contains a list of IPOrgs
+     */
+    list(request?: ListIPOrgRequest): Promise<ListIPOrgResponse>;
+}
+//# sourceMappingURL=ipOrgReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ipOrgReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["ipOrgReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAa,YAAY,EAAE,MAAM,MAAM,CAAC;AAE/C,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EAClB,oCAAiC;AAGlC;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,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,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYrE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAQ1E"}

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

@@ -0,0 +1,15 @@
+import { PublicClient, WalletClient } from "viem";
+import { AxiosInstance } from "axios";
+import { LicenseReadOnlyClient } from "./licenseReadOnly.js";
+import { CreateIpaBoundLicenseRequest, CreateLicenseNftRequest, CreateLicenseResponse } from "../types/resources/license.js";
+/**
+ * Client for managing relationships.
+ */
+export declare class LicenseClient extends LicenseReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    create(request: CreateLicenseNftRequest | CreateIpaBoundLicenseRequest): Promise<CreateLicenseResponse>;
+    private isCreateLicenseNftRequest;
+    private isCreateIpaBoundLicenseRequest;
+}
+//# 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,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAMtC,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAC1D,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,EACvB,qBAAqB,EACtB,sCAAmC;AAEpC;;GAEG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKvE,MAAM,CACjB,OAAO,EAAE,uBAAuB,GAAG,4BAA4B,GAC9D,OAAO,CAAC,qBAAqB,CAAC;IAiDjC,OAAO,CAAC,yBAAyB;IAMjC,OAAO,CAAC,8BAA8B;CAKvC"}

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

@@ -0,0 +1,27 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetLicenseRequest, GetLicenseResponse, ListLicenseRequest, ListLicenseResponse } from "../types/resources/license.js";
+/**
+ * A class representing License operations.
+ *
+ * @public
+ */
+export declare class LicenseReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * 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>;
+}
+//# sourceMappingURL=licenseReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"licenseReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["licenseReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACpB,sCAAmC;AAIpC;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,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,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAgBzE;;;;OAIG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAc9E"}

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

@@ -0,0 +1,12 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { ModuleReadOnlyClient } from "./moduleReadOnly.js";
+/**
+ * ModuleClient allows you to view and monitor modules on
+ * Story Protocol.
+ */
+export declare class ModuleClient extends ModuleReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+}
+//# sourceMappingURL=module.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"../../../../src/resources","sources":["module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,oBAAoB,EAAE,4BAAyB;AAExD;;;GAGG;AACH,qBAAa,YAAa,SAAQ,oBAAoB;IACpD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}

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

@@ -0,0 +1,27 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetModuleRequest, GetModuleResponse, ListModuleRequest, ListModuleResponse } from "../types/resources/module.js";
+/**
+ * ModuleClient allows you to view and monitor modules on
+ * Story Protocol.
+ */
+export declare class ModuleReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get module data based on the specified module id.
+     *
+     * @param request - the request object for getting the module
+     * @returns the response object that contains the fetched module object
+     */
+    get(request: GetModuleRequest): Promise<GetModuleResponse>;
+    /**
+     * Get module data based on the specified module id.
+     *
+     * @param request - the request object for getting the modules
+     * @returns the response object that contains the fetched module object
+     */
+    list(request?: ListModuleRequest): Promise<ListModuleResponse>;
+}
+//# sourceMappingURL=moduleReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"moduleReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["moduleReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGpC,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,qCAAkC;AAEnC;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,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,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASvE;;;;;OAKG;IACU,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAY5E"}

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

@@ -0,0 +1,26 @@
+import { PublicClient, WalletClient } from "viem";
+import { AxiosInstance } from "axios";
+import { RegisterRelationshipTypeRequest, RegisterRelationshipTypeResponse, RegisterRelationshipRequest, RegisterRelationshipResponse } from "../types/resources/relationship.js";
+import { RelationshipReadOnlyClient } from "./relationshipReadOnly.js";
+/**
+ * Client for managing relationships.
+ */
+export declare class RelationshipClient extends RelationshipReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+    /**
+     * Register a relationship on Story Protocol based on the specified input relationship data.
+     *
+     * @param request - the request object that contains all data needed to register a relationship
+     * @returns the response object that contains results from the register relationship action
+     */
+    register(request: RegisterRelationshipRequest): Promise<RegisterRelationshipResponse>;
+    /**
+     * Register a relationship type on Story Protocol based on the specified input data.
+     *
+     * @param request - the request object that contains all data needed to register a relationship type
+     * @returns the response object that contains results from the register relationship type action
+     */
+    registerRelationshipType(request: RegisterRelationshipTypeRequest): Promise<RegisterRelationshipTypeResponse>;
+}
+//# 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":"AAAA,OAAO,EAAc,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EACL,+BAA+B,EAC/B,gCAAgC,EAChC,2BAA2B,EAC3B,4BAA4B,EAC7B,2CAAwC;AAEzC,OAAO,EAAE,0BAA0B,EAAE,kCAA+B;AAKpE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,0BAA0B;IAChE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;IAKpF;;;;;OAKG;IACU,QAAQ,CACnB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,4BAA4B,CAAC;IAsCxC;;;;;OAKG;IACU,wBAAwB,CACnC,OAAO,EAAE,+BAA+B,GACvC,OAAO,CAAC,gCAAgC,CAAC;CAmC7C"}

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

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { PublicClient } from "viem";
+import { GetRelationshipRequest, GetRelationshipResponse, ListRelationshipRequest, ListRelationshipResponse } from "../types/resources/relationship.js";
+/**
+ * Client for managing relationships.
+ */
+export declare class RelationshipReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly rpcClient: PublicClient;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient);
+    /**
+     * Get a relationship by its ID.
+     *
+     * @param relationshipId - The ID of the relationship to retrieve.
+     * @returns A Promise that resolves to the RelationshipGetResponse.
+     */
+    get(request: GetRelationshipRequest): Promise<GetRelationshipResponse>;
+    /**
+     * List all relationships.
+     *
+     * @returns A Promise that resolves to the RelationshipListResponse.
+     */
+    list(request: ListRelationshipRequest): Promise<ListRelationshipResponse>;
+}
+//# sourceMappingURL=relationshipReadOnly.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"relationshipReadOnly.d.ts","sourceRoot":"../../../../src/resources","sources":["relationshipReadOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACzB,2CAAwC;AAIzC;;GAEG;AACH,qBAAa,0BAA0B;IACrC,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,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAkBnF;;;;OAIG;IACU,IAAI,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAqBvF"}

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

@@ -0,0 +1,12 @@
+import { AxiosInstance } from "axios";
+import { PublicClient, WalletClient } from "viem";
+import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
+/**
+ * TransactionClient allows you to view and monitor transactions on
+ * Story Protocol.
+ */
+export declare class TransactionClient extends TransactionReadOnlyClient {
+    private readonly wallet;
+    constructor(httpClient: AxiosInstance, rpcClient: PublicClient, wallet: WalletClient);
+}
+//# 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,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;gBAE1B,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY;CAIrF"}