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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist/declarations/src/enums/Relatables.d.ts +3 -0
  2. package/dist/declarations/src/enums/Relatables.d.ts.map +1 -1
  3. package/dist/declarations/src/index.d.ts +1 -1
  4. package/dist/declarations/src/index.d.ts.map +1 -1
  5. package/dist/declarations/src/resources/hook.d.ts +1 -2
  6. package/dist/declarations/src/resources/hook.d.ts.map +1 -1
  7. package/dist/declarations/src/resources/hookReadOnly.d.ts +1 -2
  8. package/dist/declarations/src/resources/hookReadOnly.d.ts.map +1 -1
  9. package/dist/declarations/src/resources/ipAsset.d.ts +1 -1
  10. package/dist/declarations/src/resources/ipAssetReadOnly.d.ts +2 -2
  11. package/dist/declarations/src/resources/ipOrg.d.ts +1 -2
  12. package/dist/declarations/src/resources/ipOrg.d.ts.map +1 -1
  13. package/dist/declarations/src/resources/ipOrgReadOnly.d.ts +2 -3
  14. package/dist/declarations/src/resources/ipOrgReadOnly.d.ts.map +1 -1
  15. package/dist/declarations/src/resources/module.d.ts +1 -2
  16. package/dist/declarations/src/resources/module.d.ts.map +1 -1
  17. package/dist/declarations/src/resources/moduleReadOnly.d.ts +3 -5
  18. package/dist/declarations/src/resources/moduleReadOnly.d.ts.map +1 -1
  19. package/dist/declarations/src/resources/relationship.d.ts +1 -1
  20. package/dist/declarations/src/resources/relationshipReadOnly.d.ts +5 -5
  21. package/dist/declarations/src/resources/relationshipType.d.ts +1 -1
  22. package/dist/declarations/src/resources/relationshipTypeReadOnly.d.ts +5 -6
  23. package/dist/declarations/src/resources/relationshipTypeReadOnly.d.ts.map +1 -1
  24. package/dist/declarations/src/resources/transaction.d.ts +1 -2
  25. package/dist/declarations/src/resources/transaction.d.ts.map +1 -1
  26. package/dist/declarations/src/resources/transactionReadOnly.d.ts +3 -5
  27. package/dist/declarations/src/resources/transactionReadOnly.d.ts.map +1 -1
  28. package/dist/declarations/src/types/config.d.ts +5 -0
  29. package/dist/declarations/src/types/config.d.ts.map +1 -1
  30. package/dist/declarations/src/types/resources/IPOrg.d.ts +7 -7
  31. package/dist/declarations/src/types/resources/relationship.d.ts +30 -0
  32. package/dist/declarations/src/types/resources/relationship.d.ts.map +1 -1
  33. package/dist/declarations/src/types/resources/relationshipType.d.ts +40 -0
  34. package/dist/declarations/src/types/resources/relationshipType.d.ts.map +1 -1
  35. package/dist/story-protocol-core-sdk.cjs.dev.js +36 -44
  36. package/dist/story-protocol-core-sdk.cjs.prod.js +36 -44
  37. package/dist/story-protocol-core-sdk.esm.js +36 -44
  38. package/package.json +1 -1
@@ -497,8 +497,7 @@ function handleError(error, msg) {
497
497
  }
498
498
 
499
499
  /**
500
- * IPOrgReadOnlyClient allows you to view, search IPOrgs on
501
- * Story Protocol.
500
+ * IPOrgReadOnlyClient allows you to view and search IPOrgs on Story Protocol.
502
501
  */
503
502
  var IPOrgReadOnlyClient = /*#__PURE__*/function () {
504
503
  function IPOrgReadOnlyClient(httpClient, rpcClient) {
@@ -549,7 +548,7 @@ var IPOrgReadOnlyClient = /*#__PURE__*/function () {
549
548
  return get;
550
549
  }()
551
550
  /**
552
- * List all IPOrgs.
551
+ * List IPOrgs.
553
552
  *
554
553
  * @returns the response object that contains a list of IPOrgs
555
554
  */
@@ -2702,8 +2701,7 @@ function typedDataToBytes(typedData) {
2702
2701
  }
2703
2702
 
2704
2703
  /**
2705
- * IPOrgClient allows you to create, update, view, search IPOrgs on
2706
- * Story Protocol.
2704
+ * IPOrgClient allows you to create, view, search IPOrgs on Story Protocol.
2707
2705
  */
2708
2706
  var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2709
2707
  _inherits(IPOrgClient, _IPOrgReadOnlyClient);
@@ -2785,7 +2783,7 @@ var IPOrgClient = /*#__PURE__*/function (_IPOrgReadOnlyClient) {
2785
2783
  }(IPOrgReadOnlyClient);
2786
2784
 
2787
2785
  /**
2788
- * Client for managing relationships.
2786
+ * RelationshipReadOnlyClient allows you to view and search relationships on Story Protocol.
2789
2787
  */
2790
2788
  var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2791
2789
  function RelationshipReadOnlyClient(httpClient, rpcClient) {
@@ -2797,8 +2795,8 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2797
2795
  /**
2798
2796
  * Get a relationship by its ID.
2799
2797
  *
2800
- * @param relationshipId - The ID of the relationship to retrieve.
2801
- * @returns A Promise that resolves to the RelationshipGetResponse.
2798
+ * @param request - the request object for getting the relationship
2799
+ * @returns the response object that contains the fetched relationship object
2802
2800
  */
2803
2801
  _createClass(RelationshipReadOnlyClient, [{
2804
2802
  key: "get",
@@ -2836,9 +2834,9 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2836
2834
  return get;
2837
2835
  }()
2838
2836
  /**
2839
- * List all relationships.
2837
+ * List relationships.
2840
2838
  *
2841
- * @returns A Promise that resolves to the RelationshipListResponse.
2839
+ * @returns the response object that contains a list of relationships.
2842
2840
  */
2843
2841
  }, {
2844
2842
  key: "list",
@@ -2879,7 +2877,7 @@ var RelationshipReadOnlyClient = /*#__PURE__*/function () {
2879
2877
  }();
2880
2878
 
2881
2879
  /**
2882
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
2880
+ * IPAssetReadOnlyClient allows you to view and search IP Assets on Story Protocol.
2883
2881
  */
2884
2882
  var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2885
2883
  function IPAssetReadOnlyClient(httpClient, rpcClient) {
@@ -2930,7 +2928,7 @@ var IPAssetReadOnlyClient = /*#__PURE__*/function () {
2930
2928
  return get;
2931
2929
  }()
2932
2930
  /**
2933
- * List all IP assets.
2931
+ * List IP assets.
2934
2932
  *
2935
2933
  * @returns the response object that contains results from listing query.
2936
2934
  */
@@ -3968,7 +3966,7 @@ var registrationModuleConfig = {
3968
3966
  };
3969
3967
 
3970
3968
  /**
3971
- * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
3969
+ * IpAssetClient allows you to create, view, and search IP Assets on Story Protocol.
3972
3970
  */
3973
3971
  var IPAssetClient = /*#__PURE__*/function (_IPAssetReadOnlyClien) {
3974
3972
  _inherits(IPAssetClient, _IPAssetReadOnlyClien);
@@ -4158,8 +4156,7 @@ var LicenseReadOnlyClient = /*#__PURE__*/function () {
4158
4156
  }();
4159
4157
 
4160
4158
  /**
4161
- * TransactionClient allows you to view and monitor transactions on
4162
- * Story Protocol.
4159
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4163
4160
  */
4164
4161
  var TransactionReadOnlyClient = /*#__PURE__*/function () {
4165
4162
  function TransactionReadOnlyClient(httpClient, rpcClient) {
@@ -4204,10 +4201,9 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4204
4201
  return get;
4205
4202
  }()
4206
4203
  /**
4207
- * Get transaction data based on the specified transaction id.
4204
+ * List Transactions.
4208
4205
  *
4209
- * @param request - the request object for getting the transactions
4210
- * @returns the response object that contains the fetched transaction object
4206
+ * @returns the response object that contains a list of transactions
4211
4207
  */
4212
4208
  }, {
4213
4209
  key: "list",
@@ -4229,7 +4225,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4229
4225
  case 8:
4230
4226
  _context2.prev = 8;
4231
4227
  _context2.t0 = _context2["catch"](0);
4232
- handleError(_context2.t0, "Failed to get transactions");
4228
+ handleError(_context2.t0, "Failed to list transactions");
4233
4229
  case 11:
4234
4230
  case "end":
4235
4231
  return _context2.stop();
@@ -4246,8 +4242,7 @@ var TransactionReadOnlyClient = /*#__PURE__*/function () {
4246
4242
  }();
4247
4243
 
4248
4244
  /**
4249
- * TransactionClient allows you to view and monitor transactions on
4250
- * Story Protocol.
4245
+ * TransactionClient allows you to view and monitor transactions on Story Protocol.
4251
4246
  */
4252
4247
  var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4253
4248
  _inherits(TransactionClient, _TransactionReadOnlyC);
@@ -4268,8 +4263,7 @@ var TransactionClient = /*#__PURE__*/function (_TransactionReadOnlyC) {
4268
4263
  var HTTP_TIMEOUT = 5000;
4269
4264
 
4270
4265
  /**
4271
- * ModuleClient allows you to view and monitor modules on
4272
- * Story Protocol.
4266
+ * ModuleReadOnlyClient allows you to view and search modules on Story Protocol.
4273
4267
  */
4274
4268
  var ModuleReadOnlyClient = /*#__PURE__*/function () {
4275
4269
  function ModuleReadOnlyClient(httpClient, rpcClient) {
@@ -4314,10 +4308,9 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4314
4308
  return get;
4315
4309
  }()
4316
4310
  /**
4317
- * Get module data based on the specified module id.
4311
+ * List Modules.
4318
4312
  *
4319
- * @param request - the request object for getting the modules
4320
- * @returns the response object that contains the fetched module object
4313
+ * @returns the response object that contains a list of modules
4321
4314
  */
4322
4315
  }, {
4323
4316
  key: "list",
@@ -4343,7 +4336,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4343
4336
  case 8:
4344
4337
  _context2.prev = 8;
4345
4338
  _context2.t0 = _context2["catch"](0);
4346
- handleError(_context2.t0, "Failed to get modules");
4339
+ handleError(_context2.t0, "Failed to list modules");
4347
4340
  case 11:
4348
4341
  case "end":
4349
4342
  return _context2.stop();
@@ -4360,8 +4353,7 @@ var ModuleReadOnlyClient = /*#__PURE__*/function () {
4360
4353
  }();
4361
4354
 
4362
4355
  /**
4363
- * ModuleClient allows you to view and monitor modules on
4364
- * Story Protocol.
4356
+ * ModuleClient allows you to view and search modules on Story Protocol.
4365
4357
  */
4366
4358
  var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4367
4359
  _inherits(ModuleClient, _ModuleReadOnlyClient);
@@ -4377,8 +4369,7 @@ var ModuleClient = /*#__PURE__*/function (_ModuleReadOnlyClient) {
4377
4369
  }(ModuleReadOnlyClient);
4378
4370
 
4379
4371
  /**
4380
- * HookClient allows you to view and monitor hooks on
4381
- * Story Protocol.
4372
+ * HookReadOnlyClient allows you to get and search hooks on Story Protocol.
4382
4373
  */
4383
4374
  var HookReadOnlyClient = /*#__PURE__*/function () {
4384
4375
  function HookReadOnlyClient(httpClient, rpcClient) {
@@ -4469,8 +4460,7 @@ var HookReadOnlyClient = /*#__PURE__*/function () {
4469
4460
  }();
4470
4461
 
4471
4462
  /**
4472
- * HookClient allows you to view and monitor hooks on
4473
- * Story Protocol.
4463
+ * HookClient allows you to view and search hooks on Story Protocol.
4474
4464
  */
4475
4465
  var HookClient = /*#__PURE__*/function (_HookReadOnlyClient) {
4476
4466
  _inherits(HookClient, _HookReadOnlyClient);
@@ -6509,7 +6499,7 @@ var relationshipModuleConfig = {
6509
6499
  };
6510
6500
 
6511
6501
  /**
6512
- * Client for managing relationships.
6502
+ * RelationshipClient allows you to create, view and search relationships on Story Protocol.
6513
6503
  */
6514
6504
  var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6515
6505
  _inherits(RelationshipClient, _RelationshipReadOnly);
@@ -6597,7 +6587,7 @@ var RelationshipClient = /*#__PURE__*/function (_RelationshipReadOnly) {
6597
6587
  }(RelationshipReadOnlyClient);
6598
6588
 
6599
6589
  /**
6600
- * Client for managing RelationshipTypes.
6590
+ * RelationshipTypeReadOnlyClient allows you to view and search relationship types on Story Protocol.
6601
6591
  */
6602
6592
  var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6603
6593
  function RelationshipTypeReadOnlyClient(httpClient, rpcClient) {
@@ -6609,9 +6599,8 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6609
6599
  /**
6610
6600
  * Get a RelationshipType by ipOrgId or relType.
6611
6601
  *
6612
- * @param ipOrgId - The ID of the IP Org.
6613
- * @param relType - Relationship Type.
6614
- * @returns A Promise that resolves to the GetRelationshipTypeResponse.
6602
+ * @param request - the request object for getting the relationship type
6603
+ * @returns the response object that contains the fetched relationship type object
6615
6604
  */
6616
6605
  _createClass(RelationshipTypeReadOnlyClient, [{
6617
6606
  key: "get",
@@ -6631,7 +6620,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6631
6620
  case 8:
6632
6621
  _context.prev = 8;
6633
6622
  _context.t0 = _context["catch"](0);
6634
- handleError(_context.t0, "Failed to get RelationshipType");
6623
+ handleError(_context.t0, "Failed to get relationship type");
6635
6624
  case 11:
6636
6625
  case "end":
6637
6626
  return _context.stop();
@@ -6644,9 +6633,9 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6644
6633
  return get;
6645
6634
  }()
6646
6635
  /**
6647
- * List all RelationshipTypes.
6636
+ * List RelationshipTypes.
6648
6637
  *
6649
- * @returns A Promise that resolves to the ListRelationshipTypesResponse.
6638
+ * @returns the response object that contains a list of relationship types
6650
6639
  */
6651
6640
  }, {
6652
6641
  key: "list",
@@ -6670,7 +6659,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6670
6659
  case 7:
6671
6660
  _context2.prev = 7;
6672
6661
  _context2.t0 = _context2["catch"](0);
6673
- handleError(_context2.t0, "Failed to list RelationshipTypes");
6662
+ handleError(_context2.t0, "Failed to list relationship types");
6674
6663
  case 10:
6675
6664
  case "end":
6676
6665
  return _context2.stop();
@@ -6687,7 +6676,7 @@ var RelationshipTypeReadOnlyClient = /*#__PURE__*/function () {
6687
6676
  }();
6688
6677
 
6689
6678
  /**
6690
- * Client for managing relationships.
6679
+ * RelationshipTypeClient allows you to create, view and search relationship types on Story Protocol.
6691
6680
  */
6692
6681
  var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6693
6682
  _inherits(RelationshipTypeClient, _RelationshipTypeRead);
@@ -6759,7 +6748,7 @@ var RelationshipTypeClient = /*#__PURE__*/function (_RelationshipTypeRead) {
6759
6748
  case 17:
6760
6749
  _context.prev = 17;
6761
6750
  _context.t0 = _context["catch"](0);
6762
- handleError(_context.t0, "Failed to register relationship");
6751
+ handleError(_context.t0, "Failed to register relationship type");
6763
6752
  case 20:
6764
6753
  case "end":
6765
6754
  return _context.stop();
@@ -7091,6 +7080,9 @@ var ActionType = /*#__PURE__*/function (ActionType) {
7091
7080
  return ActionType;
7092
7081
  }({});
7093
7082
 
7083
+ /**
7084
+ * @public
7085
+ */
7094
7086
  var Relatables = /*#__PURE__*/function (Relatables) {
7095
7087
  Relatables[Relatables["Undefined"] = 0] = "Undefined";
7096
7088
  Relatables[Relatables["IPA"] = 1] = "IPA";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@story-protocol/core-sdk",
3
- "version": "0.1.0-alpha-rc.4",
3
+ "version": "0.1.0-alpha-rc.5",
4
4
  "description": "Story Protocol Core SDK",
5
5
  "main": "dist/story-protocol-core-sdk.cjs.js",
6
6
  "module": "dist/story-protocol-core-sdk.esm.js",