@story-protocol/core-sdk 0.1.0-rc.5 → 0.1.0-rc.7

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

@@ -1,30 +1,16 @@
 import { AxiosInstance } from "axios";
 import { Signer } from "ethers";
-import { GetLicenseRequest, GetLicenseResponse, ListLicenseResponse, CreateLicenseRequest, CreateLicenseResponse, ListLicenseRequest } from "../types/resources/license.js";
+import { CreateLicenseRequest, CreateLicenseResponse } from "../types/resources/license.js";
 import { FranchiseRegistry } from "../abi/generated/index.js";
+import { LicenseReadOnlyClient } from "./licenseReadOnly.js";
 /**
  * A class representing License operations.
  *
  * @public
  */
-export declare class LicenseClient {
-    private readonly httpClient;
+export declare class LicenseClient extends LicenseReadOnlyClient {
     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.
      *

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

@@ -1 +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,sCAAmC;AACpC,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"}
+{"version":3,"file":"license.d.ts","sourceRoot":"../../../../src/resources","sources":["license.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,MAAM,EAAkC,MAAM,QAAQ,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,sCAAmC;AACzF,OAAO,EAAE,iBAAiB,EAA4B,kCAAyB;AAE/E,OAAO,EAAE,qBAAqB,EAAE,6BAA0B;AAE1D;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,iBAAiB;IAK3F;;;;;OAKG;IACU,MAAM,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAyDnF"}

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

@@ -0,0 +1,27 @@
+import { AxiosInstance } from "axios";
+import { GetLicenseRequest, GetLicenseResponse, ListLicenseResponse, ListLicenseRequest } from "../types/resources/license.js";
+import { FranchiseRegistry } from "../abi/generated/index.js";
+/**
+ * A class representing License operations.
+ *
+ * @public
+ */
+export declare class LicenseReadOnlyClient {
+    protected readonly httpClient: AxiosInstance;
+    protected readonly franchiseRegistry: FranchiseRegistry;
+    constructor(httpClient: AxiosInstance, 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>;
+}
+//# 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;AAErD,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,sCAAmC;AACpC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAIrD;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;gBAE5C,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,iBAAiB;IAK3E;;;;;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;CAW7E"}

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

@@ -1,12 +1,11 @@
 import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
 import { RelationshipIsRelatedRequest, RelationshipIsRelatedResponse, RelationshipIsRelationshipExpiredRequest, RelationshipIsRelationshipExpiredResponse, RelationshipRelateRequest, RelationshipRelateResponse, RelationshipUnrelateRequest, RelationshipUnrelateResponse } from "../types/resources/relationship.js";
 import { FranchiseRegistry } from "../abi/generated/index.js";
+import { RelationshipReadOnlyClient } from "./relationshipReadOnly.js";
 /**
  * Client for managing relationships.
  */
-export declare class RelationshipClient {
-    private readonly relationshipModule;
-    private readonly franchiseRegistry;
+export declare class RelationshipClient extends RelationshipReadOnlyClient {
     /**
      * Creates a new RelationshipClient instance.
      * @param relationshipModule - The relationship module to interact with.

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

@@ -1 +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,2CAAwC;AAEzC,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"}
+{"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,2CAAwC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AACrD,OAAO,EAAE,0BAA0B,EAAE,kCAA+B;AAEpE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,0BAA0B;IAChE;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;IAIxF;;;;;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/relationshipReadOnly.d.ts

@@ -0,0 +1,16 @@
+import { RelationshipModule } from "../abi/generated/RelationshipModule.js";
+import { FranchiseRegistry } from "../abi/generated/index.js";
+/**
+ * Client for managing relationships.
+ */
+export declare class RelationshipReadOnlyClient {
+    protected readonly relationshipModule: RelationshipModule;
+    protected readonly franchiseRegistry: 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);
+}
+//# 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,kBAAkB,EAAE,+CAA4C;AACzE,OAAO,EAAE,iBAAiB,EAAE,kCAAyB;AAErD;;GAEG;AACH,qBAAa,0BAA0B;IACrC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAC1D,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAExD;;;;OAIG;gBACS,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,iBAAiB;CAIzF"}

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

@@ -1,25 +1,10 @@
 import { AxiosInstance } from "axios";
-import { GetTransactionRequest, GetTransactionResponse, ListTransactionResponse } from "../types/resources/transaction.js";
+import { TransactionReadOnlyClient } from "./transactionReadOnly.js";
 /**
  * TransactionClient allows you to view and monitor transactions on
  * Story Protocol.
  */
-export declare class TransactionClient {
-    private readonly httpClient;
+export declare class TransactionClient extends TransactionReadOnlyClient {
     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

@@ -1 +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,0CAAuC;AAExC;;;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"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"../../../../src/resources","sources":["transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAEtC,OAAO,EAAE,yBAAyB,EAAE,iCAA8B;AAElE;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,yBAAyB;gBAClD,UAAU,EAAE,aAAa;CAGtC"}

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

@@ -0,0 +1,25 @@
+import { AxiosInstance } from "axios";
+import { GetTransactionRequest, GetTransactionResponse, 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;
+    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=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;AAGrD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACxB,0CAAuC;AAExC;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC;gBAEjC,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/declarations/src/types/client.d.ts

@@ -0,0 +1,29 @@
+import { CollectClient } from "../resources/collect.js";
+import { CollectReadOnlyClient } from "../resources/collectReadOnly.js";
+import { FranchiseClient } from "../resources/franchise.js";
+import { FranchiseReadOnlyClient } from "../resources/franchiseReadOnly.js";
+import { LicenseClient } from "../resources/license.js";
+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 { RelationshipClient } from "../resources/relationship.js";
+import { RelationshipReadOnlyClient } from "../resources/relationshipReadOnly.js";
+export interface ReadOnlyClient {
+    franchise: FranchiseReadOnlyClient;
+    license: LicenseReadOnlyClient;
+    collect: CollectReadOnlyClient;
+    transaction: TransactionReadOnlyClient;
+    ipAsset: IPAssetReadOnlyClient;
+    relationship: RelationshipReadOnlyClient;
+}
+export interface Client {
+    franchise: FranchiseClient;
+    license: LicenseClient;
+    collect: CollectClient;
+    transaction: TransactionClient;
+    ipAsset: IPAssetClient;
+    relationship: RelationshipClient;
+}
+//# 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,aAAa,EAAE,gCAA6B;AACrD,OAAO,EAAE,qBAAqB,EAAE,wCAAqC;AACrE,OAAO,EAAE,eAAe,EAAE,kCAA+B;AACzD,OAAO,EAAE,uBAAuB,EAAE,0CAAuC;AACzE,OAAO,EAAE,aAAa,EAAE,gCAA6B;AACrD,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,kBAAkB,EAAE,qCAAkC;AAC/D,OAAO,EAAE,0BAA0B,EAAE,6CAA0C;AAE/E,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,uBAAuB,CAAC;IACnC,OAAO,EAAE,qBAAqB,CAAC;IAC/B,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,SAAS,EAAE,eAAe,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,YAAY,EAAE,kBAAkB,CAAC;CAClC"}

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

@@ -1,3 +1,4 @@
+import { Provider } from "@ethersproject/providers";
 import { Signer } from "ethers";
 import { Environment } from "../enums/Environment.js";
 /**
@@ -5,8 +6,13 @@ import { Environment } from "../enums/Environment.js";
  *
  * @public
  */
-export type StoryConfig = {
+export interface StoryCommonConfig {
     readonly environment: Environment;
+}
+export interface StoryConfig extends StoryCommonConfig {
     readonly signer: Signer;
-};
+}
+export interface StoryReadOnlyConfig extends StoryCommonConfig {
+    readonly provider?: Provider;
+}
 //# sourceMappingURL=config.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"../../../../src/types","sources":["config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,WAAW,EAAE,gCAA6B;AAEnD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAoB,SAAQ,iBAAiB;IAC5D,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAC9B"}