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

package/dist/story-protocol-core-sdk.cjs.dev.js

@@ -524,8 +524,7 @@ function handleError(error, msg) {
 }
 
 /**
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
- * Story Protocol.
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
  */
 var IPOrgReadOnlyClient = /*#__PURE__*/function () {
   function IPOrgReadOnlyClient(httpClient, rpcClient) {
@@ -576,7 +575,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IPOrgs.
+     * List IPOrgs.
      *
      * @returns the response object that contains a list of IPOrgs
      */
@@ -2729,8 +2728,7 @@ function typedDataToBytes(typedData) {
 }
 
 /**
- * IPOrgClient allows you to create, update, view, search IPOrgs on
- * Story Protocol.
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
  */
 var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
   _inherits(IPOrgClient, _IPOrgReadOnlyClient);
@@ -2812,7 +2810,7 @@ var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
 }(IPOrgReadOnlyClient);
 
 /**
- * Client for managing relationships.
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
  */
 var RelationshipReadOnlyClient = /*#__PURE__*/function () {
   function RelationshipReadOnlyClient(httpClient, rpcClient) {
@@ -2824,8 +2822,8 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
   /**
    * Get a relationship by its ID.
    *
-   * @param relationshipId - The ID of the relationship to retrieve.
-   * @returns A Promise that resolves to the RelationshipGetResponse.
+   * @param request - the request object for getting the relationship
+   * @returns the response object that contains the fetched relationship object
    */
   _createClass(RelationshipReadOnlyClient, [{
     key: "get",
@@ -2863,9 +2861,9 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all relationships.
+     * List relationships.
      *
-     * @returns A Promise that resolves to the RelationshipListResponse.
+     * @returns the response object that contains a list of relationships.
      */
   }, {
     key: "list",
@@ -2906,7 +2904,7 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
  */
 var IPAssetReadOnlyClient = /*#__PURE__*/function () {
   function IPAssetReadOnlyClient(httpClient, rpcClient) {
@@ -2957,7 +2955,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IP assets.
+     * List IP assets.
      *
      * @returns the response object that contains results from listing query.
      */
@@ -3995,7 +3993,7 @@ var registrationModuleConfig = {
 };
 
 /**
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
  */
 var IPAssetClient = /*#__PURE__*/function (_IPAssetReadOnlyClien) {
   _inherits(IPAssetClient, _IPAssetReadOnlyClien);
@@ -4185,8 +4183,7 @@ var LicenseReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * TransactionClient allows you to view and monitor transactions on
- * Story Protocol.
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
  */
 var TransactionReadOnlyClient = /*#__PURE__*/function () {
   function TransactionReadOnlyClient(httpClient, rpcClient) {
@@ -4231,10 +4228,9 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * Get transaction data based on the specified transaction id.
+     * List Transactions.
      *
-     * @param request - the request object for getting the transactions
-     * @returns the response object that contains the fetched transaction object
+     * @returns the response object that contains a list of transactions
      */
   }, {
     key: "list",
@@ -4256,7 +4252,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context2.prev = 8;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to get transactions");
+              handleError(_context2.t0, "Failed to list transactions");
             case 11:
             case "end":
               return _context2.stop();
@@ -4273,8 +4269,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * TransactionClient allows you to view and monitor transactions on
- * Story Protocol.
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
  */
 var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
   _inherits(TransactionClient, _TransactionReadOnlyC);
@@ -4295,8 +4290,7 @@ var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
 var HTTP_TIMEOUT = 5000;
 
 /**
- * ModuleClient allows you to view and monitor modules on
- * Story Protocol.
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
  */
 var ModuleReadOnlyClient = /*#__PURE__*/function () {
   function ModuleReadOnlyClient(httpClient, rpcClient) {
@@ -4341,10 +4335,9 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * Get module data based on the specified module id.
+     * List Modules.
      *
-     * @param request - the request object for getting the modules
-     * @returns the response object that contains the fetched module object
+     * @returns the response object that contains a list of modules
      */
   }, {
     key: "list",
@@ -4370,7 +4363,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context2.prev = 8;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to get modules");
+              handleError(_context2.t0, "Failed to list modules");
             case 11:
             case "end":
               return _context2.stop();
@@ -4387,8 +4380,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * ModuleClient allows you to view and monitor modules on
- * Story Protocol.
+ * ModuleClient allows you to view and search modules on Story Protocol.
  */
 var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
   _inherits(ModuleClient, _ModuleReadOnlyClient);
@@ -4404,8 +4396,7 @@ var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
 }(ModuleReadOnlyClient);
 
 /**
- * HookClient allows you to view and monitor hooks on
- * Story Protocol.
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
  */
 var HookReadOnlyClient = /*#__PURE__*/function () {
   function HookReadOnlyClient(httpClient, rpcClient) {
@@ -4496,8 +4487,7 @@ var HookReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * HookClient allows you to view and monitor hooks on
- * Story Protocol.
+ * HookClient allows you to view and search hooks on Story Protocol.
  */
 var HookClient = /*#__PURE__*/function (_HookReadOnlyClient) {
   _inherits(HookClient, _HookReadOnlyClient);
@@ -6536,7 +6526,7 @@ var relationshipModuleConfig = {
 };
 
 /**
- * Client for managing relationships.
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
  */
 var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
   _inherits(RelationshipClient, _RelationshipReadOnly);
@@ -6624,7 +6614,7 @@ var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
 }(RelationshipReadOnlyClient);
 
 /**
- * Client for managing RelationshipTypes.
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
  */
 var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
   function RelationshipTypeReadOnlyClient(httpClient, rpcClient) {
@@ -6636,9 +6626,8 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
   /**
    * Get a RelationshipType by ipOrgId or relType.
    *
-   * @param ipOrgId - The ID of the IP Org.
-   * @param relType - Relationship Type.
-   * @returns A Promise that resolves to the GetRelationshipTypeResponse.
+   * @param request - the request object for getting the relationship type
+   * @returns the response object that contains the fetched relationship type object
    */
   _createClass(RelationshipTypeReadOnlyClient, [{
     key: "get",
@@ -6658,7 +6647,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context.prev = 8;
               _context.t0 = _context["catch"](0);
-              handleError(_context.t0, "Failed to get RelationshipType");
+              handleError(_context.t0, "Failed to get relationship type");
             case 11:
             case "end":
               return _context.stop();
@@ -6671,9 +6660,9 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all RelationshipTypes.
+     * List RelationshipTypes.
      *
-     * @returns A Promise that resolves to the ListRelationshipTypesResponse.
+     * @returns the response object that contains a list of relationship types
      */
   }, {
     key: "list",
@@ -6697,7 +6686,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
             case 7:
               _context2.prev = 7;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to list RelationshipTypes");
+              handleError(_context2.t0, "Failed to list relationship types");
             case 10:
             case "end":
               return _context2.stop();
@@ -6714,7 +6703,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * Client for managing relationships.
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
  */
 var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
   _inherits(RelationshipTypeClient, _RelationshipTypeRead);
@@ -6786,7 +6775,7 @@ var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
             case 17:
               _context.prev = 17;
               _context.t0 = _context["catch"](0);
-              handleError(_context.t0, "Failed to register relationship");
+              handleError(_context.t0, "Failed to register relationship type");
             case 20:
             case "end":
               return _context.stop();
@@ -7118,6 +7107,9 @@ var ActionType = /*#__PURE__*/function (ActionType) {
   return ActionType;
 }({});
 
+/**
+ * @public
+ */
 var Relatables = /*#__PURE__*/function (Relatables) {
   Relatables[Relatables["Undefined"] = 0] = "Undefined";
   Relatables[Relatables["IPA"] = 1] = "IPA";

package/dist/story-protocol-core-sdk.cjs.prod.js

@@ -524,8 +524,7 @@ function handleError(error, msg) {
 }
 
 /**
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
- * Story Protocol.
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
  */
 var IPOrgReadOnlyClient = /*#__PURE__*/function () {
   function IPOrgReadOnlyClient(httpClient, rpcClient) {
@@ -576,7 +575,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IPOrgs.
+     * List IPOrgs.
      *
      * @returns the response object that contains a list of IPOrgs
      */
@@ -2729,8 +2728,7 @@ function typedDataToBytes(typedData) {
 }
 
 /**
- * IPOrgClient allows you to create, update, view, search IPOrgs on
- * Story Protocol.
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
  */
 var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
   _inherits(IPOrgClient, _IPOrgReadOnlyClient);
@@ -2812,7 +2810,7 @@ var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
 }(IPOrgReadOnlyClient);
 
 /**
- * Client for managing relationships.
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
  */
 var RelationshipReadOnlyClient = /*#__PURE__*/function () {
   function RelationshipReadOnlyClient(httpClient, rpcClient) {
@@ -2824,8 +2822,8 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
   /**
    * Get a relationship by its ID.
    *
-   * @param relationshipId - The ID of the relationship to retrieve.
-   * @returns A Promise that resolves to the RelationshipGetResponse.
+   * @param request - the request object for getting the relationship
+   * @returns the response object that contains the fetched relationship object
    */
   _createClass(RelationshipReadOnlyClient, [{
     key: "get",
@@ -2863,9 +2861,9 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all relationships.
+     * List relationships.
      *
-     * @returns A Promise that resolves to the RelationshipListResponse.
+     * @returns the response object that contains a list of relationships.
      */
   }, {
     key: "list",
@@ -2906,7 +2904,7 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
  */
 var IPAssetReadOnlyClient = /*#__PURE__*/function () {
   function IPAssetReadOnlyClient(httpClient, rpcClient) {
@@ -2957,7 +2955,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IP assets.
+     * List IP assets.
      *
      * @returns the response object that contains results from listing query.
      */
@@ -3995,7 +3993,7 @@ var registrationModuleConfig = {
 };
 
 /**
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
  */
 var IPAssetClient = /*#__PURE__*/function (_IPAssetReadOnlyClien) {
   _inherits(IPAssetClient, _IPAssetReadOnlyClien);
@@ -4185,8 +4183,7 @@ var LicenseReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * TransactionClient allows you to view and monitor transactions on
- * Story Protocol.
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
  */
 var TransactionReadOnlyClient = /*#__PURE__*/function () {
   function TransactionReadOnlyClient(httpClient, rpcClient) {
@@ -4231,10 +4228,9 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * Get transaction data based on the specified transaction id.
+     * List Transactions.
      *
-     * @param request - the request object for getting the transactions
-     * @returns the response object that contains the fetched transaction object
+     * @returns the response object that contains a list of transactions
      */
   }, {
     key: "list",
@@ -4256,7 +4252,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context2.prev = 8;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to get transactions");
+              handleError(_context2.t0, "Failed to list transactions");
             case 11:
             case "end":
               return _context2.stop();
@@ -4273,8 +4269,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * TransactionClient allows you to view and monitor transactions on
- * Story Protocol.
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
  */
 var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
   _inherits(TransactionClient, _TransactionReadOnlyC);
@@ -4295,8 +4290,7 @@ var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
 var HTTP_TIMEOUT = 5000;
 
 /**
- * ModuleClient allows you to view and monitor modules on
- * Story Protocol.
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
  */
 var ModuleReadOnlyClient = /*#__PURE__*/function () {
   function ModuleReadOnlyClient(httpClient, rpcClient) {
@@ -4341,10 +4335,9 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * Get module data based on the specified module id.
+     * List Modules.
      *
-     * @param request - the request object for getting the modules
-     * @returns the response object that contains the fetched module object
+     * @returns the response object that contains a list of modules
      */
   }, {
     key: "list",
@@ -4370,7 +4363,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context2.prev = 8;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to get modules");
+              handleError(_context2.t0, "Failed to list modules");
             case 11:
             case "end":
               return _context2.stop();
@@ -4387,8 +4380,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * ModuleClient allows you to view and monitor modules on
- * Story Protocol.
+ * ModuleClient allows you to view and search modules on Story Protocol.
  */
 var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
   _inherits(ModuleClient, _ModuleReadOnlyClient);
@@ -4404,8 +4396,7 @@ var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
 }(ModuleReadOnlyClient);
 
 /**
- * HookClient allows you to view and monitor hooks on
- * Story Protocol.
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
  */
 var HookReadOnlyClient = /*#__PURE__*/function () {
   function HookReadOnlyClient(httpClient, rpcClient) {
@@ -4496,8 +4487,7 @@ var HookReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * HookClient allows you to view and monitor hooks on
- * Story Protocol.
+ * HookClient allows you to view and search hooks on Story Protocol.
  */
 var HookClient = /*#__PURE__*/function (_HookReadOnlyClient) {
   _inherits(HookClient, _HookReadOnlyClient);
@@ -6536,7 +6526,7 @@ var relationshipModuleConfig = {
 };
 
 /**
- * Client for managing relationships.
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
  */
 var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
   _inherits(RelationshipClient, _RelationshipReadOnly);
@@ -6624,7 +6614,7 @@ var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
 }(RelationshipReadOnlyClient);
 
 /**
- * Client for managing RelationshipTypes.
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
  */
 var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
   function RelationshipTypeReadOnlyClient(httpClient, rpcClient) {
@@ -6636,9 +6626,8 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
   /**
    * Get a RelationshipType by ipOrgId or relType.
    *
-   * @param ipOrgId - The ID of the IP Org.
-   * @param relType - Relationship Type.
-   * @returns A Promise that resolves to the GetRelationshipTypeResponse.
+   * @param request - the request object for getting the relationship type
+   * @returns the response object that contains the fetched relationship type object
    */
   _createClass(RelationshipTypeReadOnlyClient, [{
     key: "get",
@@ -6658,7 +6647,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
             case 8:
               _context.prev = 8;
               _context.t0 = _context["catch"](0);
-              handleError(_context.t0, "Failed to get RelationshipType");
+              handleError(_context.t0, "Failed to get relationship type");
             case 11:
             case "end":
               return _context.stop();
@@ -6671,9 +6660,9 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all RelationshipTypes.
+     * List RelationshipTypes.
      *
-     * @returns A Promise that resolves to the ListRelationshipTypesResponse.
+     * @returns the response object that contains a list of relationship types
      */
   }, {
     key: "list",
@@ -6697,7 +6686,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
             case 7:
               _context2.prev = 7;
               _context2.t0 = _context2["catch"](0);
-              handleError(_context2.t0, "Failed to list RelationshipTypes");
+              handleError(_context2.t0, "Failed to list relationship types");
             case 10:
             case "end":
               return _context2.stop();
@@ -6714,7 +6703,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
 }();
 
 /**
- * Client for managing relationships.
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
  */
 var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
   _inherits(RelationshipTypeClient, _RelationshipTypeRead);
@@ -6786,7 +6775,7 @@ var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
             case 17:
               _context.prev = 17;
               _context.t0 = _context["catch"](0);
-              handleError(_context.t0, "Failed to register relationship");
+              handleError(_context.t0, "Failed to register relationship type");
             case 20:
             case "end":
               return _context.stop();
@@ -7118,6 +7107,9 @@ var ActionType = /*#__PURE__*/function (ActionType) {
   return ActionType;
 }({});
 
+/**
+ * @public
+ */
 var Relatables = /*#__PURE__*/function (Relatables) {
   Relatables[Relatables["Undefined"] = 0] = "Undefined";
   Relatables[Relatables["IPA"] = 1] = "IPA";