@junobuild/functions 0.7.2 → 0.8.0

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 (120) hide show
  1. package/README.md +399 -223
  2. package/canisters/ckbtc/index.js +1 -1
  3. package/canisters/cketh/index.js +1 -1
  4. package/canisters/cmc/index.js +1 -1
  5. package/canisters/declarations/ckbtc/bitcoin.did.d.ts +1 -1
  6. package/canisters/declarations/ckbtc/minter.did.d.ts +1 -1
  7. package/canisters/declarations/cketh/minter.did.d.ts +1 -1
  8. package/canisters/declarations/cketh/orchestrator.did.d.ts +1 -1
  9. package/canisters/declarations/cmc/cmc.did.d.ts +1 -1
  10. package/canisters/declarations/ic-management/ic-management.did.d.ts +1 -1
  11. package/canisters/declarations/ledger-icp/index.did.d.ts +1 -1
  12. package/canisters/declarations/ledger-icp/ledger.did.d.ts +1 -1
  13. package/canisters/declarations/ledger-icrc/icrc_icrc-1.did.d.ts +1 -1
  14. package/canisters/declarations/ledger-icrc/icrc_icrc-10.did.d.ts +1 -1
  15. package/canisters/declarations/ledger-icrc/icrc_index.did.d.ts +1 -1
  16. package/canisters/declarations/ledger-icrc/icrc_ledger.did.d.ts +1 -1
  17. package/canisters/declarations/ledger-icrc/icrc_nft-ledger.did.d.ts +1 -1
  18. package/canisters/declarations/nns/genesis_token.did.d.ts +1 -1
  19. package/canisters/declarations/nns/governance.did.d.ts +1 -1
  20. package/canisters/declarations/nns/governance_test.did.d.ts +1 -1
  21. package/canisters/declarations/nns/sns_wasm.did.d.ts +1 -1
  22. package/canisters/declarations/sns/governance.did.d.ts +1 -1
  23. package/canisters/declarations/sns/governance_test.did.d.ts +1 -1
  24. package/canisters/declarations/sns/root.did.d.ts +1 -1
  25. package/canisters/declarations/sns/swap.did.d.ts +1 -1
  26. package/canisters/ic-management/index.js +1 -1
  27. package/canisters/index.js +1 -1
  28. package/canisters/ledger/icp/index.js +1 -1
  29. package/canisters/ledger/icrc/index.js +1 -1
  30. package/canisters/nns/index.js +1 -1
  31. package/canisters/sns/index.js +1 -1
  32. package/{chunk-CAQXR2VB.js → chunk-I4MVAQHI.js} +1 -1
  33. package/{chunk-CAQXR2VB.js.map → chunk-I4MVAQHI.js.map} +1 -1
  34. package/chunk-JU5CZHLY.js +2 -0
  35. package/chunk-JU5CZHLY.js.map +7 -0
  36. package/chunk-VIFVPVUD.js +2 -0
  37. package/chunk-VIFVPVUD.js.map +7 -0
  38. package/chunk-X3EF7OU6.js +2 -0
  39. package/chunk-X3EF7OU6.js.map +7 -0
  40. package/chunk-YHNBR22R.js +2 -0
  41. package/chunk-YHNBR22R.js.map +7 -0
  42. package/chunk-ZBCLFWQJ.js +2 -0
  43. package/chunk-ZBCLFWQJ.js.map +7 -0
  44. package/functions/query.d.ts +8 -0
  45. package/functions/schemas/function.d.ts +27 -0
  46. package/functions/update.d.ts +8 -0
  47. package/global.d.ts +15 -6
  48. package/ic-cdk/http-request.ic-cdk.d.ts +10 -0
  49. package/ic-cdk/schemas/call.d.ts +1 -1
  50. package/ic-cdk/schemas/http-request.d.ts +142 -0
  51. package/ic-cdk.d.ts +2 -0
  52. package/ic-cdk.js +1 -1
  53. package/ic-cdk.js.map +4 -4
  54. package/index.d.ts +1 -1
  55. package/index.js +1 -1
  56. package/index.js.map +3 -3
  57. package/package.json +3 -3
  58. package/schemas/principal.d.ts +8 -0
  59. package/schemas/satellite.d.ts +1 -1
  60. package/sdk/access-keys.sdk.d.ts +50 -0
  61. package/sdk/guards.sdk.d.ts +25 -0
  62. package/sdk/schemas/{controllers.d.ts → access-keys.d.ts} +39 -38
  63. package/sdk.d.ts +3 -2
  64. package/sdk.js +1 -1
  65. package/sdk.js.map +4 -4
  66. package/src/canisters/declarations/ckbtc/bitcoin.did.d.ts +1 -1
  67. package/src/canisters/declarations/ckbtc/bitcoin.did.idl.js +1 -1
  68. package/src/canisters/declarations/ckbtc/minter.did.d.ts +1 -1
  69. package/src/canisters/declarations/ckbtc/minter.did.idl.js +1 -1
  70. package/src/canisters/declarations/cketh/minter.did.d.ts +1 -1
  71. package/src/canisters/declarations/cketh/minter.did.idl.js +1 -1
  72. package/src/canisters/declarations/cketh/orchestrator.did.d.ts +1 -1
  73. package/src/canisters/declarations/cketh/orchestrator.did.idl.js +1 -1
  74. package/src/canisters/declarations/cmc/cmc.did.d.ts +1 -1
  75. package/src/canisters/declarations/cmc/cmc.did.idl.js +1 -1
  76. package/src/canisters/declarations/ic-management/ic-management.did.d.ts +1 -1
  77. package/src/canisters/declarations/ic-management/ic-management.did.idl.js +1 -1
  78. package/src/canisters/declarations/ledger-icp/index.did.d.ts +1 -1
  79. package/src/canisters/declarations/ledger-icp/index.did.idl.js +1 -1
  80. package/src/canisters/declarations/ledger-icp/ledger.did.d.ts +1 -1
  81. package/src/canisters/declarations/ledger-icp/ledger.did.idl.js +1 -1
  82. package/src/canisters/declarations/ledger-icrc/icrc_icrc-1.did.d.ts +1 -1
  83. package/src/canisters/declarations/ledger-icrc/icrc_icrc-1.did.idl.js +1 -1
  84. package/src/canisters/declarations/ledger-icrc/icrc_icrc-10.did.d.ts +1 -1
  85. package/src/canisters/declarations/ledger-icrc/icrc_icrc-10.did.idl.js +1 -1
  86. package/src/canisters/declarations/ledger-icrc/icrc_index.did.d.ts +1 -1
  87. package/src/canisters/declarations/ledger-icrc/icrc_index.did.idl.js +1 -1
  88. package/src/canisters/declarations/ledger-icrc/icrc_ledger.did.d.ts +1 -1
  89. package/src/canisters/declarations/ledger-icrc/icrc_ledger.did.idl.js +1 -1
  90. package/src/canisters/declarations/ledger-icrc/icrc_nft-ledger.did.d.ts +1 -1
  91. package/src/canisters/declarations/ledger-icrc/icrc_nft-ledger.did.idl.js +1 -1
  92. package/src/canisters/declarations/nns/genesis_token.did.d.ts +1 -1
  93. package/src/canisters/declarations/nns/genesis_token.did.idl.js +1 -1
  94. package/src/canisters/declarations/nns/governance.did.d.ts +1 -1
  95. package/src/canisters/declarations/nns/governance.did.idl.js +1 -1
  96. package/src/canisters/declarations/nns/governance_test.did.d.ts +1 -1
  97. package/src/canisters/declarations/nns/governance_test.did.idl.js +1 -1
  98. package/src/canisters/declarations/nns/sns_wasm.did.d.ts +1 -1
  99. package/src/canisters/declarations/nns/sns_wasm.did.idl.js +1 -1
  100. package/src/canisters/declarations/sns/governance.did.d.ts +1 -1
  101. package/src/canisters/declarations/sns/governance.did.idl.js +1 -1
  102. package/src/canisters/declarations/sns/governance_test.did.d.ts +1 -1
  103. package/src/canisters/declarations/sns/governance_test.did.idl.js +1 -1
  104. package/src/canisters/declarations/sns/root.did.d.ts +1 -1
  105. package/src/canisters/declarations/sns/root.did.idl.js +1 -1
  106. package/src/canisters/declarations/sns/swap.did.d.ts +1 -1
  107. package/src/canisters/declarations/sns/swap.did.idl.js +1 -1
  108. package/src/global.d.ts +15 -6
  109. package/chunk-3CCXJJ4Y.js +0 -2
  110. package/chunk-3CCXJJ4Y.js.map +0 -7
  111. package/chunk-5IWIJYKG.js +0 -2
  112. package/chunk-5IWIJYKG.js.map +0 -7
  113. package/chunk-6QTAU2M5.js +0 -2
  114. package/chunk-6QTAU2M5.js.map +0 -7
  115. package/chunk-BAYP4XBH.js +0 -2
  116. package/chunk-BAYP4XBH.js.map +0 -7
  117. package/chunk-EHQF2DOU.js +0 -2
  118. package/chunk-EHQF2DOU.js.map +0 -7
  119. package/schemas/candid.d.ts +0 -21
  120. package/sdk/controllers.sdk.d.ts +0 -39
package/README.md CHANGED
@@ -47,10 +47,11 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
47
47
  - [decodeDocData](#gear-decodedocdata)
48
48
  - [encodeDocData](#gear-encodedocdata)
49
49
  - [normalizeCaller](#gear-normalizecaller)
50
- - [getAdminControllers](#gear-getadmincontrollers)
51
- - [getControllers](#gear-getcontrollers)
50
+ - [getAdminAccessKeys](#gear-getadminaccesskeys)
51
+ - [getAccessKeys](#gear-getaccesskeys)
52
+ - [isWriteAccessKey](#gear-iswriteaccesskey)
53
+ - [isValidAccessKey](#gear-isvalidaccesskey)
52
54
  - [isAdminController](#gear-isadmincontroller)
53
- - [isController](#gear-iscontroller)
54
55
  - [setDocStore](#gear-setdocstore)
55
56
  - [deleteDocStore](#gear-deletedocstore)
56
57
  - [getDocStore](#gear-getdocstore)
@@ -59,6 +60,9 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
59
60
  - [countDocsStore](#gear-countdocsstore)
60
61
  - [deleteDocsStore](#gear-deletedocsstore)
61
62
  - [deleteFilteredDocsStore](#gear-deletefiltereddocsstore)
63
+ - [callerIsAdmin](#gear-callerisadmin)
64
+ - [callerHasWritePermission](#gear-callerhaswritepermission)
65
+ - [callerIsAccessKey](#gear-callerisaccesskey)
62
66
  - [countCollectionAssetsStore](#gear-countcollectionassetsstore)
63
67
  - [countAssetsStore](#gear-countassetsstore)
64
68
  - [setAssetHandler](#gear-setassethandler)
@@ -72,6 +76,7 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
72
76
  - [call](#gear-call)
73
77
  - [msgCaller](#gear-msgcaller)
74
78
  - [caller](#gear-caller)
79
+ - [httpRequest](#gear-httprequest)
75
80
  - [canisterSelf](#gear-canisterself)
76
81
  - [id](#gear-id)
77
82
  - [satelliteSelf](#gear-satelliteself)
@@ -417,71 +422,90 @@ The raw user ID as a `Uint8Array`.
417
422
 
418
423
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/utils/caller.utils.ts#L12)
419
424
 
420
- #### :gear: getAdminControllers
425
+ #### :gear: getAdminAccessKeys
421
426
 
422
- Gets the list of admin controllers from the Satellite.
427
+ Gets the list of admin access keys from the Satellite.
423
428
 
424
- | Function | Type |
425
- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
426
- | `getAdminControllers` | `() => [Uint8Array<ArrayBuffer>, { metadata: [string, string][]; created_at: bigint; updated_at: bigint; scope: "write" or "admin" or "submit"; expires_at?: bigint or undefined; kind?: "automation" or ... 1 more ... or undefined; }][]` |
429
+ | Function | Type |
430
+ | -------------------- | ------------------ |
431
+ | `getAdminAccessKeys` | `() => AccessKeys` |
427
432
 
428
433
  Returns:
429
434
 
430
- The list of admin controllers.
435
+ The list of admin acces keys.
431
436
 
432
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L15)
437
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/access-keys.sdk.ts#L15)
433
438
 
434
- #### :gear: getControllers
439
+ #### :gear: getAccessKeys
435
440
 
436
- Gets the list of controllers from the Satellite.
441
+ Gets the list of access keys from the Satellite.
437
442
 
438
- | Function | Type |
439
- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
440
- | `getControllers` | `() => [Uint8Array<ArrayBuffer>, { metadata: [string, string][]; created_at: bigint; updated_at: bigint; scope: "write" or "admin" or "submit"; expires_at?: bigint or undefined; kind?: "automation" or ... 1 more ... or undefined; }][]` |
443
+ | Function | Type |
444
+ | --------------- | ------------------ |
445
+ | `getAccessKeys` | `() => AccessKeys` |
441
446
 
442
447
  Returns:
443
448
 
444
- The list of all controllers.
449
+ The list of all access keys.
445
450
 
446
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L24)
451
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/access-keys.sdk.ts#L24)
447
452
 
448
- #### :gear: isAdminController
453
+ #### :gear: isWriteAccessKey
454
+
455
+ Checks if the given id exists among the provided access keys.
456
+
457
+ | Function | Type |
458
+ | ------------------ | ------------------------------------------- |
459
+ | `isWriteAccessKey` | `(params: AccessKeyCheckParams) => boolean` |
460
+
461
+ Parameters:
462
+
463
+ - `params`: - The parameters including the id
464
+ and the list of access keys to verify against.
465
+
466
+ Returns:
449
467
 
450
- Checks if the given caller is an admin among the provided controllers.
468
+ Whether the id is an access key with write permission.
451
469
 
452
- | Function | Type |
453
- | ------------------- | -------------------------------------------- |
454
- | `isAdminController` | `(params: ControllerCheckParams) => boolean` |
470
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/access-keys.sdk.ts#L36)
471
+
472
+ #### :gear: isValidAccessKey
473
+
474
+ Checks if the given id exists among the provided access keys.
475
+
476
+ | Function | Type |
477
+ | ------------------ | ------------------------------------------- |
478
+ | `isValidAccessKey` | `(params: AccessKeyCheckParams) => boolean` |
455
479
 
456
480
  Parameters:
457
481
 
458
- - `params`: - The parameters including the caller identity
459
- and the list of controllers to verify against.
482
+ - `params`: - The parameters including the id
483
+ and the list of access keys to verify against.
460
484
 
461
485
  Returns:
462
486
 
463
- Whether the caller is an admin.
487
+ Whether the id is an access key.
464
488
 
465
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L36)
489
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/access-keys.sdk.ts#L56)
466
490
 
467
- #### :gear: isController
491
+ #### :gear: isAdminController
468
492
 
469
- Checks if the given caller exists among the provided controllers.
493
+ Checks if the given id is an admin among the provided access keys and a controller as known on the Internet Computer.
470
494
 
471
- | Function | Type |
472
- | -------------- | -------------------------------------------- |
473
- | `isController` | `(params: ControllerCheckParams) => boolean` |
495
+ | Function | Type |
496
+ | ------------------- | ------------------------------------------- |
497
+ | `isAdminController` | `(params: AccessKeyCheckParams) => boolean` |
474
498
 
475
499
  Parameters:
476
500
 
477
- - `params`: - The parameters including the caller identity
478
- and the list of controllers to verify against.
501
+ - `params`: - The parameters including the id
502
+ and the list of access keys to verify against.
479
503
 
480
504
  Returns:
481
505
 
482
- Whether the caller is a controller.
506
+ Whether the id is an admin and a controller of the Satellite on the Internet Computer.
483
507
 
484
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/controllers.sdk.ts#L56)
508
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/access-keys.sdk.ts#L76)
485
509
 
486
510
  #### :gear: setDocStore
487
511
 
@@ -629,6 +653,36 @@ The context resulting of the deletion of documents that match the provided filte
629
653
 
630
654
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/db.sdk.ts#L175)
631
655
 
656
+ #### :gear: callerIsAdmin
657
+
658
+ Guard that succeeds if the caller is an admin access key of this satellite.
659
+
660
+ | Function | Type |
661
+ | --------------- | ------------ |
662
+ | `callerIsAdmin` | `() => void` |
663
+
664
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/guards.sdk.ts#L10)
665
+
666
+ #### :gear: callerHasWritePermission
667
+
668
+ Guard that succeeds if the caller is an access key with write permission.
669
+
670
+ | Function | Type |
671
+ | -------------------------- | ------------------ |
672
+ | `callerHasWritePermission` | `() => AccessKeys` |
673
+
674
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/guards.sdk.ts#L21)
675
+
676
+ #### :gear: callerIsAccessKey
677
+
678
+ Guard that succeeds if the caller is any recognized access key of this satellite.
679
+
680
+ | Function | Type |
681
+ | ------------------- | ------------------ |
682
+ | `callerIsAccessKey` | `() => AccessKeys` |
683
+
684
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/guards.sdk.ts#L31)
685
+
632
686
  #### :gear: countCollectionAssetsStore
633
687
 
634
688
  Counts the number of assets in a specific collection.
@@ -847,6 +901,24 @@ The Principal ID of the caller.
847
901
 
848
902
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/caller.ic-cdk.ts#L21)
849
903
 
904
+ #### :gear: httpRequest
905
+
906
+ Performs an HTTP request from a Juno serverless function.
907
+
908
+ | Function | Type |
909
+ | ------------- | ------------------------------------------------------- |
910
+ | `httpRequest` | `(args: HttpRequestArgs) => Promise<HttpRequestResult>` |
911
+
912
+ Parameters:
913
+
914
+ - `args`: - The HTTP request parameters
915
+
916
+ Returns:
917
+
918
+ A promise resolving to the HTTP response.
919
+
920
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/http-request.ic-cdk.ts#L17)
921
+
850
922
  #### :gear: canisterSelf
851
923
 
852
924
  Retrieves the Satellite's Principal ID.
@@ -909,6 +981,7 @@ The current timestamp.
909
981
 
910
982
  - [SatelliteEnvSchema](#gear-satelliteenvschema)
911
983
  - [JUNO_FUNCTION_TYPE](#gear-juno_function_type)
984
+ - [CustomFunctionGuardSchema](#gear-customfunctionguardschema)
912
985
  - [CustomFunctionWithArgsAndResultSchema](#gear-customfunctionwithargsandresultschema)
913
986
  - [CustomFunctionWithArgsSchema](#gear-customfunctionwithargsschema)
914
987
  - [CustomFunctionWithResultSchema](#gear-customfunctionwithresultschema)
@@ -916,9 +989,7 @@ The current timestamp.
916
989
  - [CustomFunctionSchema](#gear-customfunctionschema)
917
990
  - [QuerySchema](#gear-queryschema)
918
991
  - [UpdateSchema](#gear-updateschema)
919
- - [Uint8ArraySchema](#gear-uint8arrayschema)
920
992
  - [RawPrincipalSchema](#gear-rawprincipalschema)
921
- - [PrincipalSchema](#gear-principalschema)
922
993
  - [TimestampSchema](#gear-timestampschema)
923
994
  - [VersionSchema](#gear-versionschema)
924
995
  - [RawUserIdSchema](#gear-rawuseridschema)
@@ -981,13 +1052,13 @@ The current timestamp.
981
1052
  - [ListOrderFieldSchema](#gear-listorderfieldschema)
982
1053
  - [ListOrderSchema](#gear-listorderschema)
983
1054
  - [ListParamsSchema](#gear-listparamsschema)
984
- - [ControllerScopeSchema](#gear-controllerscopeschema)
985
- - [ControllerKindSchema](#gear-controllerkindschema)
1055
+ - [AccessKeyScopeSchema](#gear-accesskeyscopeschema)
1056
+ - [AccessKeyKindSchema](#gear-accesskeykindschema)
986
1057
  - [MetadataSchema](#gear-metadataschema)
987
- - [ControllerSchema](#gear-controllerschema)
988
- - [ControllerRecordSchema](#gear-controllerrecordschema)
989
- - [ControllersSchema](#gear-controllersschema)
990
- - [ControllerCheckParamsSchema](#gear-controllercheckparamsschema)
1058
+ - [AccessKeySchema](#gear-accesskeyschema)
1059
+ - [AccessKeyRecordSchema](#gear-accesskeyrecordschema)
1060
+ - [AccessKeysSchema](#gear-accesskeysschema)
1061
+ - [AccessKeyCheckParamsSchema](#gear-accesskeycheckparamsschema)
991
1062
  - [CollectionParamsSchema](#gear-collectionparamsschema)
992
1063
  - [ListStoreParamsSchema](#gear-liststoreparamsschema)
993
1064
  - [GetDocStoreParamsSchema](#gear-getdocstoreparamsschema)
@@ -1014,6 +1085,11 @@ The current timestamp.
1014
1085
  - [CallArgsSchema](#gear-callargsschema)
1015
1086
  - [CallResultSchema](#gear-callresultschema)
1016
1087
  - [CallParamsSchema](#gear-callparamsschema)
1088
+ - [HttpHeaderSchema](#gear-httpheaderschema)
1089
+ - [HttpMethodSchema](#gear-httpmethodschema)
1090
+ - [HttpRequestArgsSchema](#gear-httprequestargsschema)
1091
+ - [HttpRequestResultSchema](#gear-httprequestresultschema)
1092
+ - [TransformArgsSchema](#gear-transformargsschema)
1017
1093
 
1018
1094
  #### :gear: SatelliteEnvSchema
1019
1095
 
@@ -1038,71 +1114,79 @@ Not intended for direct use by developers.
1038
1114
 
1039
1115
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/constants.ts#L5)
1040
1116
 
1117
+ #### :gear: CustomFunctionGuardSchema
1118
+
1119
+ | Constant | Type |
1120
+ | --------------------------- | ------------------------------------------------------------------------------------------------------------------- |
1121
+ | `CustomFunctionGuardSchema` | `ZodCustom<$InferInnerFunctionType<$ZodFunctionArgs, ZodVoid>, $InferInnerFunctionType<$ZodFunctionArgs, ZodVoid>>` |
1122
+
1123
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L15)
1124
+
1041
1125
  #### :gear: CustomFunctionWithArgsAndResultSchema
1042
1126
 
1043
- | Constant | Type |
1044
- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1045
- | `CustomFunctionWithArgsAndResultSchema` | `ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; type: ZodEnum<...>; }, $strict>` |
1127
+ | Constant | Type |
1128
+ | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
1129
+ | `CustomFunctionWithArgsAndResultSchema` | `ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; ... 4 more ...; type: ZodEnum<...>; }, $strict>` |
1046
1130
 
1047
1131
  References:
1048
1132
 
1049
1133
  - CustomFunctionWithArgsAndResult
1050
1134
 
1051
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L18)
1135
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L32)
1052
1136
 
1053
1137
  #### :gear: CustomFunctionWithArgsSchema
1054
1138
 
1055
- | Constant | Type |
1056
- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1057
- | `CustomFunctionWithArgsSchema` | `ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; handler: ZodCustom<...>; type: ZodEnum<...>; }, $strict>` |
1139
+ | Constant | Type |
1140
+ | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1141
+ | `CustomFunctionWithArgsSchema` | `ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; handler: ZodCustom<...>; guard: ZodOptional<...>; hidden: ZodOptional<...>; type: ZodEnum<...>; }, $strict>` |
1058
1142
 
1059
1143
  References:
1060
1144
 
1061
1145
  - CustomFunctionWithArgs
1062
1146
 
1063
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L33)
1147
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L48)
1064
1148
 
1065
1149
  #### :gear: CustomFunctionWithResultSchema
1066
1150
 
1067
- | Constant | Type |
1068
- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1069
- | `CustomFunctionWithResultSchema` | `ZodObject<{ result: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; handler: ZodCustom<...>; type: ZodEnum<...>; }, $strict>` |
1151
+ | Constant | Type |
1152
+ | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1153
+ | `CustomFunctionWithResultSchema` | `ZodObject<{ result: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; handler: ZodCustom<...>; guard: ZodOptional<...>; hidden: ZodOptional<...>; type: ZodEnum<...>; }, $strict>` |
1070
1154
 
1071
1155
  References:
1072
1156
 
1073
1157
  - CustomFunctionWithResult
1074
1158
 
1075
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L47)
1159
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L63)
1076
1160
 
1077
1161
  #### :gear: CustomFunctionWithoutArgsAndResultSchema
1078
1162
 
1079
- | Constant | Type |
1080
- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1081
- | `CustomFunctionWithoutArgsAndResultSchema` | `ZodObject<{ handler: ZodCustom<$InferInnerFunctionType<ZodTuple<[], null>, ZodUnion<readonly [ZodVoid, ZodPromise<ZodVoid>]>>, $InferInnerFunctionType<...>>; type: ZodEnum<...>; }, $strict>` |
1163
+ | Constant | Type |
1164
+ | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1165
+ | `CustomFunctionWithoutArgsAndResultSchema` | `ZodObject<{ handler: ZodCustom<$InferInnerFunctionType<ZodTuple<[], null>, ZodUnion<readonly [ZodVoid, ZodPromise<ZodVoid>]>>, $InferInnerFunctionType<...>>; guard: ZodOptional<...>; hidden: ZodOptional<...>; type: ZodEnum<...>; }, $strict>` |
1082
1166
 
1083
1167
  References:
1084
1168
 
1085
1169
  - CustomFunctionWithoutArgsAndResult
1086
1170
 
1087
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L61)
1171
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L78)
1088
1172
 
1089
1173
  #### :gear: CustomFunctionSchema
1090
1174
 
1091
- | Constant | Type |
1092
- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1093
- | `CustomFunctionSchema` | `ZodUnion<readonly [ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; type: ZodEnum<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>` |
1175
+ | Constant | Type |
1176
+ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1177
+ | `CustomFunctionSchema` | `ZodUnion<readonly [ZodObject<{ args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; ... 4 more ...; type: ZodEnum<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>` |
1094
1178
 
1095
1179
  References:
1096
1180
 
1097
1181
  - CustomFunction
1098
1182
 
1099
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L74)
1183
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L92)
1100
1184
 
1101
1185
  #### :gear: QuerySchema
1102
1186
 
1103
- | Constant | Type |
1104
- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1105
- | `QuerySchema` | `ZodUnion<readonly [ZodObject<{ type: ZodLiteral<"__juno_function_query">; args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>` |
1187
+ | Constant | Type |
1188
+ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1189
+ | `QuerySchema` | `ZodUnion<readonly [ZodObject<{ type: ZodLiteral<"__juno_function_query">; args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; guard: ZodOptional<...>; hidden: ZodOptional<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<....` |
1106
1190
 
1107
1191
  References:
1108
1192
 
@@ -1112,9 +1196,9 @@ References:
1112
1196
 
1113
1197
  #### :gear: UpdateSchema
1114
1198
 
1115
- | Constant | Type |
1116
- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1117
- | `UpdateSchema` | `ZodUnion<readonly [ZodObject<{ type: ZodLiteral<"__juno_function_update">; args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>` |
1199
+ | Constant | Type |
1200
+ | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1201
+ | `UpdateSchema` | `ZodUnion<readonly [ZodObject<{ type: ZodLiteral<"__juno_function_update">; args: ZodCustom<ZodObject<$ZodLooseShape, $strip>, ZodObject<$ZodLooseShape, $strip>>; result: ZodCustom<...>; handler: ZodCustom<...>; guard: ZodOptional<...>; hidden: ZodOptional<...>; }, $strict>, ZodObject<...>, ZodObject<...>, ZodObject<...` |
1118
1202
 
1119
1203
  References:
1120
1204
 
@@ -1122,16 +1206,6 @@ References:
1122
1206
 
1123
1207
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/update.ts#L23)
1124
1208
 
1125
- #### :gear: Uint8ArraySchema
1126
-
1127
- A schema that validates a value is an Uint8Array.
1128
-
1129
- | Constant | Type |
1130
- | ------------------ | ------------------------------------------------------------- |
1131
- | `Uint8ArraySchema` | `ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>` |
1132
-
1133
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L10)
1134
-
1135
1209
  #### :gear: RawPrincipalSchema
1136
1210
 
1137
1211
  | Constant | Type |
@@ -1142,19 +1216,7 @@ References:
1142
1216
 
1143
1217
  - RawPrincipal
1144
1218
 
1145
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L15)
1146
-
1147
- #### :gear: PrincipalSchema
1148
-
1149
- | Constant | Type |
1150
- | ----------------- | ------------------------------------------------------------------------------ |
1151
- | `PrincipalSchema` | `ZodPipe<ZodCustom<Principal, Principal>, ZodTransform<Principal, Principal>>` |
1152
-
1153
- References:
1154
-
1155
- - Principal
1156
-
1157
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L25)
1219
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/principal.ts#L6)
1158
1220
 
1159
1221
  #### :gear: TimestampSchema
1160
1222
 
@@ -1166,7 +1228,7 @@ References:
1166
1228
 
1167
1229
  - Timestamp
1168
1230
 
1169
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L7)
1231
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L8)
1170
1232
 
1171
1233
  #### :gear: VersionSchema
1172
1234
 
@@ -1178,7 +1240,7 @@ References:
1178
1240
 
1179
1241
  - Version
1180
1242
 
1181
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L19)
1243
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L20)
1182
1244
 
1183
1245
  #### :gear: RawUserIdSchema
1184
1246
 
@@ -1190,19 +1252,19 @@ References:
1190
1252
 
1191
1253
  - RawUserId
1192
1254
 
1193
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L31)
1255
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L32)
1194
1256
 
1195
1257
  #### :gear: UserIdSchema
1196
1258
 
1197
- | Constant | Type |
1198
- | -------------- | ------------------------------------------------------------------------------ |
1199
- | `UserIdSchema` | `ZodPipe<ZodCustom<Principal, Principal>, ZodTransform<Principal, Principal>>` |
1259
+ | Constant | Type |
1260
+ | -------------- | ------------------------------------------------------ |
1261
+ | `UserIdSchema` | `ZodPipe<ZodCustom<any, any>, ZodTransform<any, any>>` |
1200
1262
 
1201
1263
  References:
1202
1264
 
1203
1265
  - UserId
1204
1266
 
1205
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L43)
1267
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L44)
1206
1268
 
1207
1269
  #### :gear: CollectionSchema
1208
1270
 
@@ -1214,7 +1276,7 @@ References:
1214
1276
 
1215
1277
  - Collection
1216
1278
 
1217
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L55)
1279
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L56)
1218
1280
 
1219
1281
  #### :gear: KeySchema
1220
1282
 
@@ -1226,7 +1288,7 @@ References:
1226
1288
 
1227
1289
  - Key
1228
1290
 
1229
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L65)
1291
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L66)
1230
1292
 
1231
1293
  #### :gear: DescriptionSchema
1232
1294
 
@@ -1238,7 +1300,7 @@ References:
1238
1300
 
1239
1301
  - Description
1240
1302
 
1241
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L75)
1303
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L76)
1242
1304
 
1243
1305
  #### :gear: CollectionsSchema
1244
1306
 
@@ -1900,29 +1962,29 @@ References:
1900
1962
 
1901
1963
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L103)
1902
1964
 
1903
- #### :gear: ControllerScopeSchema
1965
+ #### :gear: AccessKeyScopeSchema
1904
1966
 
1905
- | Constant | Type |
1906
- | ----------------------- | ---------------------------------------------------------------- |
1907
- | `ControllerScopeSchema` | `ZodEnum<{ write: "write"; admin: "admin"; submit: "submit"; }>` |
1967
+ | Constant | Type |
1968
+ | ---------------------- | ---------------------------------------------------------------- |
1969
+ | `AccessKeyScopeSchema` | `ZodEnum<{ write: "write"; admin: "admin"; submit: "submit"; }>` |
1908
1970
 
1909
1971
  References:
1910
1972
 
1911
- - ControllerScope
1973
+ - AccessKeyScope
1912
1974
 
1913
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L15)
1975
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L15)
1914
1976
 
1915
- #### :gear: ControllerKindSchema
1977
+ #### :gear: AccessKeyKindSchema
1916
1978
 
1917
- | Constant | Type |
1918
- | ---------------------- | -------------------------------------------------------------- |
1919
- | `ControllerKindSchema` | `ZodEnum<{ automation: "automation"; emulator: "emulator"; }>` |
1979
+ | Constant | Type |
1980
+ | --------------------- | -------------------------------------------------------------- |
1981
+ | `AccessKeyKindSchema` | `ZodEnum<{ automation: "automation"; emulator: "emulator"; }>` |
1920
1982
 
1921
1983
  References:
1922
1984
 
1923
- - ControllerKind
1985
+ - AccessKeyKind
1924
1986
 
1925
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L25)
1987
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L25)
1926
1988
 
1927
1989
  #### :gear: MetadataSchema
1928
1990
 
@@ -1934,55 +1996,55 @@ References:
1934
1996
 
1935
1997
  - MetadataSchema
1936
1998
 
1937
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L35)
1999
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L35)
1938
2000
 
1939
- #### :gear: ControllerSchema
2001
+ #### :gear: AccessKeySchema
1940
2002
 
1941
- | Constant | Type |
1942
- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1943
- | `ControllerSchema` | `ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; kind: ZodOptional<...>; }, $strict>` |
2003
+ | Constant | Type |
2004
+ | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2005
+ | `AccessKeySchema` | `ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; kind: ZodOptional<...>; }, $strict>` |
1944
2006
 
1945
2007
  References:
1946
2008
 
1947
- - ControllerSchema
2009
+ - AccessKeySchema
1948
2010
 
1949
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L45)
2011
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L45)
1950
2012
 
1951
- #### :gear: ControllerRecordSchema
2013
+ #### :gear: AccessKeyRecordSchema
1952
2014
 
1953
- | Constant | Type |
1954
- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1955
- | `ControllerRecordSchema` | `ZodTuple<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; ... 4 more ...; kind: ZodOptional<...>; }, $strict>], null>` |
2015
+ | Constant | Type |
2016
+ | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2017
+ | `AccessKeyRecordSchema` | `ZodTuple<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; ... 4 more ...; kind: ZodOptional<...>; }, $strict>], null>` |
1956
2018
 
1957
2019
  References:
1958
2020
 
1959
- - ControllerRecordSchema
2021
+ - AccessKeyRecordSchema
1960
2022
 
1961
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L94)
2023
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L94)
1962
2024
 
1963
- #### :gear: ControllersSchema
2025
+ #### :gear: AccessKeysSchema
1964
2026
 
1965
- | Constant | Type |
1966
- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1967
- | `ControllersSchema` | `ZodArray<ZodTuple<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; ... 4 more ...; kind: ZodOptional<...>; }, $strict>], null>>` |
2027
+ | Constant | Type |
2028
+ | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2029
+ | `AccessKeysSchema` | `ZodArray<ZodTuple<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; ... 4 more ...; kind: ZodOptional<...>; }, $strict>], null>>` |
1968
2030
 
1969
2031
  References:
1970
2032
 
1971
- - ControllersSchema
2033
+ - AccessKeysSchema
1972
2034
 
1973
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L104)
2035
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L104)
1974
2036
 
1975
- #### :gear: ControllerCheckParamsSchema
2037
+ #### :gear: AccessKeyCheckParamsSchema
1976
2038
 
1977
- | Constant | Type |
1978
- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1979
- | `ControllerCheckParamsSchema` | `ZodObject<{ caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodPipe<ZodCustom<Principal, Principal>, ZodTransform<...>>]>; controllers: ZodArray<...>; }, $strip>` |
2039
+ | Constant | Type |
2040
+ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2041
+ | `AccessKeyCheckParamsSchema` | `ZodObject<{ id: ZodUnion<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodPipe<ZodCustom<any, any>, ZodTransform<...>>]>; accessKeys: ZodArray<...>; }, $strip>` |
1980
2042
 
1981
2043
  References:
1982
2044
 
1983
- - ControllerCheckParamsSchema
2045
+ - AccessKeyCheckParamsSchema
1984
2046
 
1985
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L114)
2047
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L114)
1986
2048
 
1987
2049
  #### :gear: CollectionParamsSchema
1988
2050
 
@@ -2246,7 +2308,7 @@ References:
2246
2308
 
2247
2309
  - IDLType
2248
2310
 
2249
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L9)
2311
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L10)
2250
2312
 
2251
2313
  #### :gear: CallArgSchema
2252
2314
 
@@ -2258,7 +2320,7 @@ References:
2258
2320
 
2259
2321
  - CallArg
2260
2322
 
2261
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L21)
2323
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L22)
2262
2324
 
2263
2325
  #### :gear: CallArgsSchema
2264
2326
 
@@ -2272,7 +2334,7 @@ References:
2272
2334
 
2273
2335
  - CallArgs
2274
2336
 
2275
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L33)
2337
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L34)
2276
2338
 
2277
2339
  #### :gear: CallResultSchema
2278
2340
 
@@ -2284,19 +2346,79 @@ References:
2284
2346
 
2285
2347
  - CallResult
2286
2348
 
2287
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L49)
2349
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L50)
2288
2350
 
2289
2351
  #### :gear: CallParamsSchema
2290
2352
 
2291
- | Constant | Type |
2292
- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2293
- | `CallParamsSchema` | `ZodObject<{ canisterId: ZodUnion<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodPipe<ZodCustom<Principal, Principal>, ZodTransform<...>>]>; method: ZodString; args: ZodOptional<...>; result: ZodOptional<...>; }, $strip>` |
2353
+ | Constant | Type |
2354
+ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2355
+ | `CallParamsSchema` | `ZodObject<{ canisterId: ZodUnion<[ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>, ZodPipe<ZodCustom<any, any>, ZodTransform<...>>]>; method: ZodString; args: ZodOptional<...>; result: ZodOptional<...>; }, $strip>` |
2294
2356
 
2295
2357
  References:
2296
2358
 
2297
2359
  - CallParams
2298
2360
 
2299
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L59)
2361
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L60)
2362
+
2363
+ #### :gear: HttpHeaderSchema
2364
+
2365
+ | Constant | Type |
2366
+ | ------------------ | ----------------------------------------------------------- |
2367
+ | `HttpHeaderSchema` | `ZodObject<{ name: ZodString; value: ZodString; }, $strip>` |
2368
+
2369
+ References:
2370
+
2371
+ - HttpHeader
2372
+
2373
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L6)
2374
+
2375
+ #### :gear: HttpMethodSchema
2376
+
2377
+ | Constant | Type |
2378
+ | ------------------ | ------------------------------------------------------ |
2379
+ | `HttpMethodSchema` | `ZodEnum<{ GET: "GET"; POST: "POST"; HEAD: "HEAD"; }>` |
2380
+
2381
+ References:
2382
+
2383
+ - HttpMethod
2384
+
2385
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L14)
2386
+
2387
+ #### :gear: HttpRequestArgsSchema
2388
+
2389
+ | Constant | Type |
2390
+ | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2391
+ | `HttpRequestArgsSchema` | `ZodObject<{ url: ZodURL; method: ZodEnum<{ GET: "GET"; POST: "POST"; HEAD: "HEAD"; }>; headers: ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, $strip>>; body: ZodOptional<...>; maxResponseBytes: ZodOptional<...>; transform: ZodOptional<...>; isReplicated: ZodOptional<...>; }, $strip>` |
2392
+
2393
+ References:
2394
+
2395
+ - HttpRequestArgs
2396
+
2397
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L19)
2398
+
2399
+ #### :gear: HttpRequestResultSchema
2400
+
2401
+ | Constant | Type |
2402
+ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2403
+ | `HttpRequestResultSchema` | `ZodObject<{ status: ZodBigInt; headers: ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, $strip>>; body: ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<...>>; }, $strip>` |
2404
+
2405
+ References:
2406
+
2407
+ - HttpRequestResult
2408
+
2409
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L32)
2410
+
2411
+ #### :gear: TransformArgsSchema
2412
+
2413
+ | Constant | Type |
2414
+ | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2415
+ | `TransformArgsSchema` | `ZodObject<{ response: ZodObject<{ status: ZodBigInt; headers: ZodArray<ZodObject<{ name: ZodString; value: ZodString; }, $strip>>; body: ZodCustom<...>; }, $strip>; context: ZodCustom<...>; }, $strip>` |
2416
+
2417
+ References:
2418
+
2419
+ - TransformArgs
2420
+
2421
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L41)
2300
2422
 
2301
2423
  ### :factory: CallResponseLengthError
2302
2424
 
@@ -2328,12 +2450,16 @@ References:
2328
2450
  - [ListOrder](#gear-listorder)
2329
2451
  - [ListParams](#gear-listparams)
2330
2452
  - [ListResults](#gear-listresults)
2331
- - [Controller](#gear-controller)
2332
- - [ControllerCheckParams](#gear-controllercheckparams)
2453
+ - [AccessKey](#gear-accesskey)
2454
+ - [AccessKeyCheckParams](#gear-accesskeycheckparams)
2333
2455
  - [CollectionParams](#gear-collectionparams)
2334
2456
  - [SetAssetHandlerParams](#gear-setassethandlerparams)
2335
2457
  - [GetContentChunksStoreParams](#gear-getcontentchunksstoreparams)
2336
2458
  - [CallParams](#gear-callparams)
2459
+ - [HttpHeader](#gear-httpheader)
2460
+ - [HttpRequestArgs](#gear-httprequestargs)
2461
+ - [HttpRequestResult](#gear-httprequestresult)
2462
+ - [TransformArgs](#gear-transformargs)
2337
2463
 
2338
2464
  #### :gear: CustomFunctionWithArgsAndResult
2339
2465
 
@@ -2345,7 +2471,7 @@ A serverless function with both input arguments and an output result.
2345
2471
  | `result` | `ZodObject<TResult, $strip>` | A Zod schema describing the output result. |
2346
2472
  | `handler` | `(args: $InferObjectOutput<TArgs, {}>) => $InferObjectOutput<TResult, {}> or Promise<$InferObjectOutput<TResult, {}>>` | The function handler. Can be synchronous or asynchronous. param: args - The input arguments.returns |
2347
2473
 
2348
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L97)
2474
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L127)
2349
2475
 
2350
2476
  #### :gear: CustomFunctionWithArgs
2351
2477
 
@@ -2356,7 +2482,7 @@ A serverless function with input arguments but no output result.
2356
2482
  | `args` | `ZodObject<TArgs, $strip>` | A Zod schema describing the input arguments. |
2357
2483
  | `handler` | `(args: $InferObjectOutput<TArgs, {}>) => void or Promise<void>` | The function handler. Can be synchronous or asynchronous. param: args - The input arguments.returns |
2358
2484
 
2359
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L127)
2485
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L157)
2360
2486
 
2361
2487
  #### :gear: CustomFunctionWithResult
2362
2488
 
@@ -2367,7 +2493,7 @@ A serverless function with an output result but no input arguments.
2367
2493
  | `result` | `ZodObject<TResult, $strip>` | A Zod schema describing the output result. |
2368
2494
  | `handler` | `() => $InferObjectOutput<TResult, {}> or Promise<$InferObjectOutput<TResult, {}>>` | The function handler. Can be synchronous or asynchronous. returns |
2369
2495
 
2370
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L147)
2496
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L177)
2371
2497
 
2372
2498
  #### :gear: CustomFunctionWithoutArgsAndResult
2373
2499
 
@@ -2377,7 +2503,7 @@ A serverless function with no input arguments and no output result.
2377
2503
  | --------- | ----------------------------- | ----------------------------------------------------------------- |
2378
2504
  | `handler` | `() => void or Promise<void>` | The function handler. Can be synchronous or asynchronous. returns |
2379
2505
 
2380
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L166)
2506
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L196)
2381
2507
 
2382
2508
  #### :gear: Collections
2383
2509
 
@@ -2634,31 +2760,31 @@ List results, parameterized by type of returned item.
2634
2760
 
2635
2761
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L142)
2636
2762
 
2637
- #### :gear: Controller
2763
+ #### :gear: AccessKey
2638
2764
 
2639
- Represents a controller with access scope and associated metadata.
2765
+ Represents an access key with access scope and associated metadata.
2640
2766
 
2641
2767
  | Property | Type | Description |
2642
2768
  | ------------ | ----------------------------------------- | ------------------------------------------------------------------ |
2643
- | `metadata` | `[string, string][]` | A list of key-value metadata pairs associated with the controller. |
2644
- | `created_at` | `bigint` | The timestamp when the controller was created. |
2645
- | `updated_at` | `bigint` | The timestamp when the controller was last updated. |
2646
- | `expires_at` | `bigint or undefined` | Optional expiration timestamp for the controller. |
2647
- | `scope` | `"write" or "admin" or "submit"` | The scope assigned to the controller. |
2648
- | `kind` | `"automation" or "emulator" or undefined` | An optional kind identifier of the controller. |
2769
+ | `metadata` | `[string, string][]` | A list of key-value metadata pairs associated with the access key. |
2770
+ | `created_at` | `bigint` | The timestamp when the access key was created. |
2771
+ | `updated_at` | `bigint` | The timestamp when the access key was last updated. |
2772
+ | `expires_at` | `bigint or undefined` | Optional expiration timestamp for the access key. |
2773
+ | `scope` | `"write" or "admin" or "submit"` | The scope assigned to the access key. |
2774
+ | `kind` | `"automation" or "emulator" or undefined` | An optional kind identifier of the access key. |
2649
2775
 
2650
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L59)
2776
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L59)
2651
2777
 
2652
- #### :gear: ControllerCheckParams
2778
+ #### :gear: AccessKeyCheckParams
2653
2779
 
2654
- Represents the parameters required to perform controller checks.
2780
+ Represents the parameters required to perform an access key checks.
2655
2781
 
2656
- | Property | Type | Description |
2657
- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
2658
- | `caller` | `any` | The identity of the caller to verify against the controller list. |
2659
- | `controllers` | `[Uint8Array<ArrayBuffer>, { metadata: [string, string][]; created_at: bigint; updated_at: bigint; scope: "write" or "admin" or "submit"; expires_at?: bigint or undefined; kind?: "automation" or ... 1 more ... or undefined; }][]` | The list of controllers to check against. |
2782
+ | Property | Type | Description |
2783
+ | ------------ | ------------ | ----------------------------------------------- |
2784
+ | `id` | `any` | The identity to verify against the access keys. |
2785
+ | `accessKeys` | `AccessKeys` | The list of access keys to check against. |
2660
2786
 
2661
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L122)
2787
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L122)
2662
2788
 
2663
2789
  #### :gear: CollectionParams
2664
2790
 
@@ -2705,7 +2831,57 @@ Type representing the parameters required to make a canister call.
2705
2831
  | `args` | `[IDL.Type<unknown>, unknown][] or undefined` | The arguments, including types and values, for the canister call. |
2706
2832
  | `result` | `any` | The expected result type used for decoding the response. |
2707
2833
 
2708
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L69)
2834
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L70)
2835
+
2836
+ #### :gear: HttpHeader
2837
+
2838
+ An HTTP header consisting of a name and value.
2839
+
2840
+ | Property | Type | Description |
2841
+ | -------- | -------- | ----------------- |
2842
+ | `name` | `string` | The header name. |
2843
+ | `value` | `string` | The header value. |
2844
+
2845
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L49)
2846
+
2847
+ #### :gear: HttpRequestArgs
2848
+
2849
+ The arguments for an HTTP request.
2850
+
2851
+ | Property | Type | Description |
2852
+ | ------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2853
+ | `url` | `string` | The requested URL. |
2854
+ | `method` | `HttpMethod` | The HTTP method. |
2855
+ | `headers` | `HttpHeader[]` | List of HTTP request headers and their corresponding values. |
2856
+ | `body` | `Uint8Array<ArrayBuffer> or undefined` | Optionally provide request body. |
2857
+ | `maxResponseBytes` | `bigint or undefined` | The maximal size of the response in bytes. |
2858
+ | `transform` | `string or undefined` | The name of a query function used to transform the response before consensus - for example, to trim headers. If provided, a corresponding query must be declared using {@link defineQuery }. |
2859
+ | `isReplicated` | `boolean or undefined` | Whether all nodes should perform the request and agree on the response, or just one node. Using a single node is cheaper but the response is not verified by others - suitable when you trust the data source or consistency is not critical. Defaults to all nodes if not specified. |
2860
+
2861
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L69)
2862
+
2863
+ #### :gear: HttpRequestResult
2864
+
2865
+ The result of an HTTP request.
2866
+
2867
+ | Property | Type | Description |
2868
+ | --------- | ------------------------- | ------------------------------------------------------------- |
2869
+ | `status` | `bigint` | The response status (e.g. 200, 404). |
2870
+ | `headers` | `HttpHeader[]` | List of HTTP response headers and their corresponding values. |
2871
+ | `body` | `Uint8Array<ArrayBuffer>` | The response's body. |
2872
+
2873
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L112)
2874
+
2875
+ #### :gear: TransformArgs
2876
+
2877
+ The arguments passed to an HTTP response transform function.
2878
+
2879
+ | Property | Type | Description |
2880
+ | ---------- | ------------------------- | ---------------------------------------- |
2881
+ | `response` | `HttpRequestResult` | The raw HTTP response to be transformed. |
2882
+ | `context` | `Uint8Array<ArrayBuffer>` | Context for response transformation |
2883
+
2884
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L132)
2709
2885
 
2710
2886
  ### :cocktail: Types
2711
2887
 
@@ -2721,7 +2897,6 @@ Type representing the parameters required to make a canister call.
2721
2897
  - [UpdateFn](#gear-updatefn)
2722
2898
  - [UpdateFnOrObject](#gear-updatefnorobject)
2723
2899
  - [RawPrincipal](#gear-rawprincipal)
2724
- - [Principal](#gear-principal)
2725
2900
  - [Timestamp](#gear-timestamp)
2726
2901
  - [Version](#gear-version)
2727
2902
  - [RawUserId](#gear-rawuserid)
@@ -2783,11 +2958,11 @@ Type representing the parameters required to make a canister call.
2783
2958
  - [HookFnOrObject](#gear-hookfnorobject)
2784
2959
  - [TimestampMatcher](#gear-timestampmatcher)
2785
2960
  - [ListOrderField](#gear-listorderfield)
2786
- - [ControllerScope](#gear-controllerscope)
2787
- - [ControllerKind](#gear-controllerkind)
2961
+ - [AccessKeyScope](#gear-accesskeyscope)
2962
+ - [AccessKeyKind](#gear-accesskeykind)
2788
2963
  - [Metadata](#gear-metadata)
2789
- - [ControllerRecord](#gear-controllerrecord)
2790
- - [Controllers](#gear-controllers)
2964
+ - [AccessKeyRecord](#gear-accesskeyrecord)
2965
+ - [AccessKeys](#gear-accesskeys)
2791
2966
  - [ListStoreParams](#gear-liststoreparams)
2792
2967
  - [GetDocStoreParams](#gear-getdocstoreparams)
2793
2968
  - [SetDocStoreParams](#gear-setdocstoreparams)
@@ -2810,6 +2985,7 @@ Type representing the parameters required to make a canister call.
2810
2985
  - [CallArg](#gear-callarg)
2811
2986
  - [CallArgs](#gear-callargs)
2812
2987
  - [CallResult](#gear-callresult)
2988
+ - [HttpMethod](#gear-httpmethod)
2813
2989
 
2814
2990
  #### :gear: SatelliteEnv
2815
2991
 
@@ -2846,7 +3022,7 @@ of optional input arguments and output result.
2846
3022
  | ---------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2847
3023
  | `CustomFunction` | ` | CustomFunctionWithArgsAndResult<TArgs, TResult> or CustomFunctionWithArgs<TArgs> or CustomFunctionWithResult<TResult> or CustomFunctionWithoutArgsAndResult` |
2848
3024
 
2849
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L182)
3025
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/functions/schemas/function.ts#L212)
2850
3026
 
2851
3027
  #### :gear: Query
2852
3028
 
@@ -2940,17 +3116,7 @@ Represents a raw principal - a Uint8Array representation of a Principal.
2940
3116
  | -------------- | ------------ |
2941
3117
  | `RawPrincipal` | `Uint8Array` |
2942
3118
 
2943
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L20)
2944
-
2945
- #### :gear: Principal
2946
-
2947
- Represents a principal - i.e. an object instantiated with the class Principal.
2948
-
2949
- | Type | Type |
2950
- | ----------- | --------------------------------- |
2951
- | `Principal` | `z.infer<typeof PrincipalSchema>` |
2952
-
2953
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L30)
3119
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/principal.ts#L11)
2954
3120
 
2955
3121
  #### :gear: Timestamp
2956
3122
 
@@ -2962,7 +3128,7 @@ Used for tracking when events occur, such as document creation and updates.
2962
3128
  | ----------- | --------------------------------- |
2963
3129
  | `Timestamp` | `z.infer<typeof TimestampSchema>` |
2964
3130
 
2965
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L14)
3131
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L15)
2966
3132
 
2967
3133
  #### :gear: Version
2968
3134
 
@@ -2974,7 +3140,7 @@ This is typically incremented with each update to ensure consistency.
2974
3140
  | --------- | ------------------------------- |
2975
3141
  | `Version` | `z.infer<typeof VersionSchema>` |
2976
3142
 
2977
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L26)
3143
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L27)
2978
3144
 
2979
3145
  #### :gear: RawUserId
2980
3146
 
@@ -2986,7 +3152,7 @@ This is a principal associated with a user.
2986
3152
  | ----------- | -------------- |
2987
3153
  | `RawUserId` | `RawPrincipal` |
2988
3154
 
2989
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L38)
3155
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L39)
2990
3156
 
2991
3157
  #### :gear: UserId
2992
3158
 
@@ -2998,7 +3164,7 @@ This is a principal associated with a user.
2998
3164
  | -------- | ------------------------------ |
2999
3165
  | `UserId` | `z.infer<typeof UserIdSchema>` |
3000
3166
 
3001
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L50)
3167
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L51)
3002
3168
 
3003
3169
  #### :gear: Collection
3004
3170
 
@@ -3008,7 +3174,7 @@ A collection name where data are stored.
3008
3174
  | ------------ | ---------------------------------- |
3009
3175
  | `Collection` | `z.infer<typeof CollectionSchema>` |
3010
3176
 
3011
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L60)
3177
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L61)
3012
3178
 
3013
3179
  #### :gear: Key
3014
3180
 
@@ -3018,7 +3184,7 @@ A key identifier within a collection.
3018
3184
  | ----- | --------------------------- |
3019
3185
  | `Key` | `z.infer<typeof KeySchema>` |
3020
3186
 
3021
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L70)
3187
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L71)
3022
3188
 
3023
3189
  #### :gear: Description
3024
3190
 
@@ -3029,7 +3195,7 @@ Used for document and asset fields which can be useful for search purpose.
3029
3195
  | ------------- | ----------------------------------- |
3030
3196
  | `Description` | `z.infer<typeof DescriptionSchema>` |
3031
3197
 
3032
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L81)
3198
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L82)
3033
3199
 
3034
3200
  #### :gear: AssertFunction
3035
3201
 
@@ -3610,25 +3776,25 @@ Enum representing possible fields to order by.
3610
3776
 
3611
3777
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L80)
3612
3778
 
3613
- #### :gear: ControllerScope
3779
+ #### :gear: AccessKeyScope
3614
3780
 
3615
- Represents the permission scope of a controller.
3781
+ Represents the permission scope of an access key.
3616
3782
 
3617
- | Type | Type |
3618
- | ----------------- | --------------------------------------- |
3619
- | `ControllerScope` | `z.infer<typeof ControllerScopeSchema>` |
3783
+ | Type | Type |
3784
+ | ---------------- | -------------------------------------- |
3785
+ | `AccessKeyScope` | `z.infer<typeof AccessKeyScopeSchema>` |
3620
3786
 
3621
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L20)
3787
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L20)
3622
3788
 
3623
- #### :gear: ControllerKind
3789
+ #### :gear: AccessKeyKind
3624
3790
 
3625
- Represents a specific kind of controller. Meant for informational purposes.
3791
+ Represents a specific kind of access key. Meant for informational purposes.
3626
3792
 
3627
- | Type | Type |
3628
- | ---------------- | -------------------------------------- |
3629
- | `ControllerKind` | `z.infer<typeof ControllerKindSchema>` |
3793
+ | Type | Type |
3794
+ | --------------- | ------------------------------------- |
3795
+ | `AccessKeyKind` | `z.infer<typeof AccessKeyKindSchema>` |
3630
3796
 
3631
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L30)
3797
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L30)
3632
3798
 
3633
3799
  #### :gear: Metadata
3634
3800
 
@@ -3638,27 +3804,27 @@ Represents a single metadata entry as a key-value tuple.
3638
3804
  | ---------- | -------------------------------- |
3639
3805
  | `Metadata` | `z.infer<typeof MetadataSchema>` |
3640
3806
 
3641
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L40)
3807
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L40)
3642
3808
 
3643
- #### :gear: ControllerRecord
3809
+ #### :gear: AccessKeyRecord
3644
3810
 
3645
- Represents a tuple containing the principal ID and associated controller data.
3811
+ Represents a tuple containing the principal ID and associated access key data.
3646
3812
 
3647
- | Type | Type |
3648
- | ------------------ | ---------------------------------------- |
3649
- | `ControllerRecord` | `z.infer<typeof ControllerRecordSchema>` |
3813
+ | Type | Type |
3814
+ | ----------------- | --------------------------------------- |
3815
+ | `AccessKeyRecord` | `z.infer<typeof AccessKeyRecordSchema>` |
3650
3816
 
3651
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L99)
3817
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L99)
3652
3818
 
3653
- #### :gear: Controllers
3819
+ #### :gear: AccessKeys
3654
3820
 
3655
- Represents a list of controllers.
3821
+ Represents a list of access keys.
3656
3822
 
3657
- | Type | Type |
3658
- | ------------- | ----------------------------------- |
3659
- | `Controllers` | `z.infer<typeof ControllersSchema>` |
3823
+ | Type | Type |
3824
+ | ------------ | ----------------------------- |
3825
+ | `AccessKeys` | `[RawPrincipal, AccessKey][]` |
3660
3826
 
3661
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L109)
3827
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/access-keys.ts#L109)
3662
3828
 
3663
3829
  #### :gear: ListStoreParams
3664
3830
 
@@ -3854,7 +4020,7 @@ Custom validation function to verify if a value is an instance of `IDL.Type` fro
3854
4020
  | --------- | ------------------------------- |
3855
4021
  | `IDLType` | `z.infer<typeof IDLTypeSchema>` |
3856
4022
 
3857
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L16)
4023
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L17)
3858
4024
 
3859
4025
  #### :gear: CallArg
3860
4026
 
@@ -3864,7 +4030,7 @@ A call argument consisting of its IDL type and corresponding value.
3864
4030
  | --------- | ------------------------------- |
3865
4031
  | `CallArg` | `z.infer<typeof CallArgSchema>` |
3866
4032
 
3867
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L26)
4033
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L27)
3868
4034
 
3869
4035
  #### :gear: CallArgs
3870
4036
 
@@ -3880,7 +4046,7 @@ The order of arguments is preserved for the function call.
3880
4046
  | ---------- | -------------------------------- |
3881
4047
  | `CallArgs` | `z.infer<typeof CallArgsSchema>` |
3882
4048
 
3883
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L44)
4049
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L45)
3884
4050
 
3885
4051
  #### :gear: CallResult
3886
4052
 
@@ -3890,7 +4056,17 @@ Defines the type used to decode the result of a canister call.
3890
4056
  | ------------ | ---------------------------------- |
3891
4057
  | `CallResult` | `z.infer<typeof CallResultSchema>` |
3892
4058
 
3893
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L54)
4059
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L55)
4060
+
4061
+ #### :gear: HttpMethod
4062
+
4063
+ The HTTP method for the request.
4064
+
4065
+ | Type | Type |
4066
+ | ------------ | --------------------------- |
4067
+ | `HttpMethod` | `'GET' or 'POST' or 'HEAD'` |
4068
+
4069
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/http-request.ts#L64)
3894
4070
 
3895
4071
  <!-- TSDOC_END -->
3896
4072