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

package/dist/story-protocol-core-sdk.esm.js

@@ -497,8 +497,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) {
@@ -549,7 +548,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IPOrgs.
+     * List IPOrgs.
      *
      * @returns the response object that contains a list of IPOrgs
      */
@@ -2702,8 +2701,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);
@@ -2785,7 +2783,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) {
@@ -2797,8 +2795,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",
@@ -2836,9 +2834,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",
@@ -2879,7 +2877,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) {
@@ -2930,7 +2928,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
       return get;
     }()
     /**
-     * List all IP assets.
+     * List IP assets.
      *
      * @returns the response object that contains results from listing query.
      */
@@ -3968,7 +3966,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);
@@ -4158,8 +4156,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) {
@@ -4204,10 +4201,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",
@@ -4229,7 +4225,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();
@@ -4246,8 +4242,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);
@@ -4268,8 +4263,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) {
@@ -4314,10 +4308,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",
@@ -4343,7 +4336,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();
@@ -4360,8 +4353,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);
@@ -4377,8 +4369,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) {
@@ -4469,8 +4460,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);
@@ -6509,7 +6499,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);
@@ -6597,7 +6587,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) {
@@ -6609,9 +6599,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",
@@ -6631,7 +6620,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();
@@ -6644,9 +6633,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",
@@ -6670,7 +6659,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();
@@ -6687,7 +6676,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);
@@ -6759,7 +6748,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();
@@ -7091,6 +7080,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@story-protocol/core-sdk",
-  "version": "0.1.0-alpha-rc.4",
+  "version": "0.1.0-alpha-rc.5",
   "description": "Story Protocol Core SDK",
   "main": "dist/story-protocol-core-sdk.cjs.js",
   "module": "dist/story-protocol-core-sdk.esm.js",