@junobuild/functions 0.2.6 → 0.2.7

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 (2) hide show
  1. package/README.md +452 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -74,6 +74,10 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
74
74
  | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
75
75
  | `HookContextSchema` | `<T extends z.ZodTypeAny>(dataSchema: T) => ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: T; }, $strict>` |
76
76
 
77
+ References:
78
+
79
+ - HookContext
80
+
77
81
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/context.ts#L8)
78
82
 
79
83
  #### :gear: AssertFunctionSchema
@@ -82,6 +86,10 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
82
86
  | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
83
87
  | `AssertFunctionSchema` | `<T extends z.ZodTypeAny>(contextSchema: T) => ZodCustom<$InferInnerFunctionType<ZodTuple<[T], null>, ZodVoid>, $InferInnerFunctionType<ZodTuple<[T], null>, ZodVoid>>` |
84
88
 
89
+ References:
90
+
91
+ - AssertFunction
92
+
85
93
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/context.ts#L37)
86
94
 
87
95
  #### :gear: RunFunctionSchema
@@ -90,6 +98,10 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
90
98
  | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91
99
  | `RunFunctionSchema` | `<T extends z.ZodTypeAny>(contextSchema: T) => ZodCustom<$InferInnerFunctionType<ZodTuple<[T], null>, ZodUnion<[ZodPromise<ZodVoid>, ZodVoid]>>, $InferInnerFunctionType<...>>` |
92
100
 
101
+ References:
102
+
103
+ - RunFunction
104
+
93
105
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/context.ts#L52)
94
106
 
95
107
  #### :gear: DocContextSchema
@@ -98,6 +110,10 @@ JavaScript and TypeScript utilities for [Juno] Serverless Functions.
98
110
  | ------------------ | -------------------------------------------------------------------------------------------------------------------- |
99
111
  | `DocContextSchema` | `<T extends z.ZodTypeAny>(dataSchema: T) => ZodObject<{ collection: ZodString; key: ZodString; data: T; }, $strict>` |
100
112
 
113
+ References:
114
+
115
+ - DocContext
116
+
101
117
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L17)
102
118
 
103
119
  #### :gear: AssertFnSchema
@@ -204,6 +220,10 @@ Represents a list result.
204
220
  | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
205
221
  | `createListResultsSchema` | `<T extends z.ZodTypeAny>(itemData: T) => ZodObject<{ items: ZodArray<ZodTuple<[ZodString, T], null>>; items_length: ZodBigInt; items_page: ZodOptional<ZodBigInt>; matches_length: ZodBigInt; matches_pages: ZodOptional<...>; }, $strict>` |
206
222
 
223
+ References:
224
+
225
+ - JsListResults
226
+
207
227
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L128)
208
228
 
209
229
  #### :gear: normalizeCaller
@@ -802,6 +822,10 @@ A schema that validates a value is an Uint8Array.
802
822
  | -------------------- | --------------------------------------------------------------------- |
803
823
  | `RawPrincipalSchema` | `ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>` |
804
824
 
825
+ References:
826
+
827
+ - RawPrincipal
828
+
805
829
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L14)
806
830
 
807
831
  #### :gear: PrincipalSchema
@@ -810,6 +834,10 @@ A schema that validates a value is an Uint8Array.
810
834
  | ----------------- | --------------------------------- |
811
835
  | `PrincipalSchema` | `ZodCustom<Principal, Principal>` |
812
836
 
837
+ References:
838
+
839
+ - Principal
840
+
813
841
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/candid.ts#L24)
814
842
 
815
843
  #### :gear: TimestampSchema
@@ -818,6 +846,10 @@ A schema that validates a value is an Uint8Array.
818
846
  | ----------------- | ----------- |
819
847
  | `TimestampSchema` | `ZodBigInt` |
820
848
 
849
+ References:
850
+
851
+ - Timestamp
852
+
821
853
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L7)
822
854
 
823
855
  #### :gear: VersionSchema
@@ -826,6 +858,10 @@ A schema that validates a value is an Uint8Array.
826
858
  | --------------- | ----------- |
827
859
  | `VersionSchema` | `ZodBigInt` |
828
860
 
861
+ References:
862
+
863
+ - Version
864
+
829
865
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L19)
830
866
 
831
867
  #### :gear: RawUserIdSchema
@@ -834,6 +870,10 @@ A schema that validates a value is an Uint8Array.
834
870
  | ----------------- | --------------------------------------------------------------------- |
835
871
  | `RawUserIdSchema` | `ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>` |
836
872
 
873
+ References:
874
+
875
+ - RawUserId
876
+
837
877
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L31)
838
878
 
839
879
  #### :gear: UserIdSchema
@@ -842,6 +882,10 @@ A schema that validates a value is an Uint8Array.
842
882
  | -------------- | --------------------------------- |
843
883
  | `UserIdSchema` | `ZodCustom<Principal, Principal>` |
844
884
 
885
+ References:
886
+
887
+ - UserId
888
+
845
889
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L43)
846
890
 
847
891
  #### :gear: CollectionSchema
@@ -850,6 +894,10 @@ A schema that validates a value is an Uint8Array.
850
894
  | ------------------ | ----------- |
851
895
  | `CollectionSchema` | `ZodString` |
852
896
 
897
+ References:
898
+
899
+ - Collection
900
+
853
901
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L55)
854
902
 
855
903
  #### :gear: KeySchema
@@ -858,6 +906,10 @@ A schema that validates a value is an Uint8Array.
858
906
  | ----------- | ----------- |
859
907
  | `KeySchema` | `ZodString` |
860
908
 
909
+ References:
910
+
911
+ - Key
912
+
861
913
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L65)
862
914
 
863
915
  #### :gear: DescriptionSchema
@@ -866,6 +918,10 @@ A schema that validates a value is an Uint8Array.
866
918
  | ------------------- | ----------- |
867
919
  | `DescriptionSchema` | `ZodString` |
868
920
 
921
+ References:
922
+
923
+ - Description
924
+
869
925
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/satellite.ts#L75)
870
926
 
871
927
  #### :gear: CollectionsSchema
@@ -874,6 +930,10 @@ A schema that validates a value is an Uint8Array.
874
930
  | ------------------- | ------------------------------------------------------------------------ |
875
931
  | `CollectionsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; }, $strict>` |
876
932
 
933
+ References:
934
+
935
+ - Collections
936
+
877
937
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/collections.ts#L7)
878
938
 
879
939
  #### :gear: RawDataSchema
@@ -882,6 +942,10 @@ A schema that validates a value is an Uint8Array.
882
942
  | --------------- | --------------------------------------------------------------------- |
883
943
  | `RawDataSchema` | `ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>` |
884
944
 
945
+ References:
946
+
947
+ - RawData
948
+
885
949
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L17)
886
950
 
887
951
  #### :gear: DocSchema
@@ -890,6 +954,10 @@ A schema that validates a value is an Uint8Array.
890
954
  | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
891
955
  | `DocSchema` | `ZodObject<{ owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; created_at: ZodBigInt; updated_at: ZodBigInt; version: ZodOptional<...>; }, $strict>` |
892
956
 
957
+ References:
958
+
959
+ - Doc
960
+
893
961
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L29)
894
962
 
895
963
  #### :gear: OptionDocSchema
@@ -898,6 +966,10 @@ A schema that validates a value is an Uint8Array.
898
966
  | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
899
967
  | `OptionDocSchema` | `ZodOptional<ZodObject<{ owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; created_at: ZodBigInt; updated_at: ZodBigInt; version: ZodOptional<...>; }, $strict>>` |
900
968
 
969
+ References:
970
+
971
+ - OptionDoc
972
+
901
973
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L79)
902
974
 
903
975
  #### :gear: SetDocSchema
@@ -906,6 +978,10 @@ A schema that validates a value is an Uint8Array.
906
978
  | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
907
979
  | `SetDocSchema` | `ZodObject<{ data: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; description: ZodOptional<ZodString>; version: ZodOptional<...>; }, $strict>` |
908
980
 
981
+ References:
982
+
983
+ - SetDoc
984
+
909
985
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L89)
910
986
 
911
987
  #### :gear: DelDocSchema
@@ -914,6 +990,10 @@ A schema that validates a value is an Uint8Array.
914
990
  | -------------- | ---------------------------------------------------------- |
915
991
  | `DelDocSchema` | `ZodObject<{ version: ZodOptional<ZodBigInt>; }, $strict>` |
916
992
 
993
+ References:
994
+
995
+ - DelDoc
996
+
917
997
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L121)
918
998
 
919
999
  #### :gear: DocUpsertSchema
@@ -922,6 +1002,10 @@ A schema that validates a value is an Uint8Array.
922
1002
  | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
923
1003
  | `DocUpsertSchema` | `ZodObject<{ before: ZodOptional<ZodObject<{ owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodCustom<Uint8Array<...>, Uint8Array<...>>; description: ZodOptional<...>; created_at: ZodBigInt; updated_at: ZodBigInt; version: ZodOptional<...>; }, $strict>>; after: ZodObject<...>; }, $s...` |
924
1004
 
1005
+ References:
1006
+
1007
+ - DocUpsert
1008
+
925
1009
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L14)
926
1010
 
927
1011
  #### :gear: DocAssertSetSchema
@@ -930,6 +1014,10 @@ A schema that validates a value is an Uint8Array.
930
1014
  | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
931
1015
  | `DocAssertSetSchema` | `ZodObject<{ current: ZodOptional<ZodObject<{ owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodCustom<...>; description: ZodOptional<...>; created_at: ZodBigInt; updated_at: ZodBigInt; version: ZodOptional<...>; }, $strict>>; proposed: ZodObject<...>; }, $strict>` |
932
1016
 
1017
+ References:
1018
+
1019
+ - DocAssertSet
1020
+
933
1021
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L41)
934
1022
 
935
1023
  #### :gear: DocAssertDeleteSchema
@@ -938,6 +1026,10 @@ A schema that validates a value is an Uint8Array.
938
1026
  | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
939
1027
  | `DocAssertDeleteSchema` | `ZodObject<{ current: ZodOptional<ZodObject<{ owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodCustom<...>; description: ZodOptional<...>; created_at: ZodBigInt; updated_at: ZodBigInt; version: ZodOptional<...>; }, $strict>>; proposed: ZodObject<...>; }, $strict>` |
940
1028
 
1029
+ References:
1030
+
1031
+ - DocAssertDelete
1032
+
941
1033
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L71)
942
1034
 
943
1035
  #### :gear: OnSetDocContextSchema
@@ -946,6 +1038,10 @@ A schema that validates a value is an Uint8Array.
946
1038
  | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
947
1039
  | `OnSetDocContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ collection: ZodString; key: ZodString; data: ZodObject<...>; }, $strict>; }, $strict>` |
948
1040
 
1041
+ References:
1042
+
1043
+ - OnSetDocContext
1044
+
949
1045
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L52)
950
1046
 
951
1047
  #### :gear: OnSetManyDocsContextSchema
@@ -954,6 +1050,10 @@ A schema that validates a value is an Uint8Array.
954
1050
  | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
955
1051
  | `OnSetManyDocsContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodArray<ZodObject<{ collection: ZodString; key: ZodString; data: ZodObject<...>; }, $strict>>; }, $strict>` |
956
1052
 
1053
+ References:
1054
+
1055
+ - OnSetManyDocsContext
1056
+
957
1057
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L65)
958
1058
 
959
1059
  #### :gear: OnDeleteDocContextSchema
@@ -962,6 +1062,10 @@ A schema that validates a value is an Uint8Array.
962
1062
  | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
963
1063
  | `OnDeleteDocContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ collection: ZodString; key: ZodString; data: ZodOptional<...>; }, $strict>; }, $strict>` |
964
1064
 
1065
+ References:
1066
+
1067
+ - OnDeleteDocContext
1068
+
965
1069
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L80)
966
1070
 
967
1071
  #### :gear: OnDeleteManyDocsContextSchema
@@ -970,6 +1074,10 @@ A schema that validates a value is an Uint8Array.
970
1074
  | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
971
1075
  | `OnDeleteManyDocsContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodArray<ZodObject<{ collection: ZodString; key: ZodString; data: ZodOptional<...>; }, $strict>>; }, $strict>` |
972
1076
 
1077
+ References:
1078
+
1079
+ - OnDeleteManyDocsContext
1080
+
973
1081
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L93)
974
1082
 
975
1083
  #### :gear: OnDeleteFilteredDocsContextSchema
@@ -978,6 +1086,10 @@ A schema that validates a value is an Uint8Array.
978
1086
  | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
979
1087
  | `OnDeleteFilteredDocsContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodArray<ZodObject<{ collection: ZodString; key: ZodString; data: ZodOptional<...>; }, $strict>>; }, $strict>` |
980
1088
 
1089
+ References:
1090
+
1091
+ - OnDeleteFilteredDocsContext
1092
+
981
1093
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L108)
982
1094
 
983
1095
  #### :gear: AssertSetDocContextSchema
@@ -986,6 +1098,10 @@ A schema that validates a value is an Uint8Array.
986
1098
  | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
987
1099
  | `AssertSetDocContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ collection: ZodString; key: ZodString; data: ZodObject<...>; }, $strict>; }, $strict>` |
988
1100
 
1101
+ References:
1102
+
1103
+ - AssertSetDocContext
1104
+
989
1105
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L123)
990
1106
 
991
1107
  #### :gear: AssertDeleteDocContextSchema
@@ -994,6 +1110,10 @@ A schema that validates a value is an Uint8Array.
994
1110
  | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
995
1111
  | `AssertDeleteDocContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ collection: ZodString; key: ZodString; data: ZodObject<...>; }, $strict>; }, $strict>` |
996
1112
 
1113
+ References:
1114
+
1115
+ - AssertDeleteDocContext
1116
+
997
1117
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L136)
998
1118
 
999
1119
  #### :gear: SatelliteEnvSchema
@@ -1002,6 +1122,10 @@ A schema that validates a value is an Uint8Array.
1002
1122
  | -------------------- | --------------------------------- |
1003
1123
  | `SatelliteEnvSchema` | `ZodRecord<ZodString, ZodString>` |
1004
1124
 
1125
+ References:
1126
+
1127
+ - SatelliteEnv
1128
+
1005
1129
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/satellite.env.ts#L6)
1006
1130
 
1007
1131
  #### :gear: HeaderFieldsSchema
@@ -1010,6 +1134,10 @@ A schema that validates a value is an Uint8Array.
1010
1134
  | -------------------- | -------------------------------------------------- |
1011
1135
  | `HeaderFieldsSchema` | `ZodArray<ZodTuple<[ZodString, ZodString], null>>` |
1012
1136
 
1137
+ References:
1138
+
1139
+ - HeaderFields
1140
+
1013
1141
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L29)
1014
1142
 
1015
1143
  #### :gear: BlobSchema
@@ -1018,6 +1146,10 @@ A schema that validates a value is an Uint8Array.
1018
1146
  | ------------ | --------------------------------------------------------------------- |
1019
1147
  | `BlobSchema` | `ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>` |
1020
1148
 
1149
+ References:
1150
+
1151
+ - Blob
1152
+
1021
1153
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L39)
1022
1154
 
1023
1155
  #### :gear: AssetKeySchema
@@ -1026,6 +1158,10 @@ A schema that validates a value is an Uint8Array.
1026
1158
  | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1027
1159
  | `AssetKeySchema` | `ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; }, $strict>` |
1028
1160
 
1161
+ References:
1162
+
1163
+ - AssetKey
1164
+
1029
1165
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L71)
1030
1166
 
1031
1167
  #### :gear: AssetEncodingSchema
@@ -1034,6 +1170,10 @@ A schema that validates a value is an Uint8Array.
1034
1170
  | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1035
1171
  | `AssetEncodingSchema` | `ZodObject<{ modified: ZodBigInt; content_chunks: ZodArray<ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>>; total_length: ZodBigInt; sha256: ZodCustom<...>; }, $strip>` |
1036
1172
 
1173
+ References:
1174
+
1175
+ - AssetEncoding
1176
+
1037
1177
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L121)
1038
1178
 
1039
1179
  #### :gear: AssetSchema
@@ -1042,6 +1182,10 @@ A schema that validates a value is an Uint8Array.
1042
1182
  | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1043
1183
  | `AssetSchema` | `ZodObject<{ key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>` |
1044
1184
 
1185
+ References:
1186
+
1187
+ - Asset
1188
+
1045
1189
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L176)
1046
1190
 
1047
1191
  #### :gear: AssetNoContentSchema
@@ -1050,6 +1194,10 @@ A schema that validates a value is an Uint8Array.
1050
1194
  | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1051
1195
  | `AssetNoContentSchema` | `ZodObject<{ version: ZodOptional<ZodBigInt>; created_at: ZodBigInt; updated_at: ZodBigInt; key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<...>; collection: ZodString; owner: ZodCustom<...>; description: ZodOptional<...>; }, $strict>; headers: ZodArray<...>; encodings: ZodArray<...>; }, $s...` |
1052
1196
 
1197
+ References:
1198
+
1199
+ - AssetNoContent
1200
+
1053
1201
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L225)
1054
1202
 
1055
1203
  #### :gear: BatchSchema
@@ -1058,6 +1206,10 @@ A schema that validates a value is an Uint8Array.
1058
1206
  | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1059
1207
  | `BatchSchema` | `ZodObject<{ key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; }, $strict>; reference_id: ZodOptional<...>; expires_at: ZodBigInt; encoding_type: ZodOptional<...>;...` |
1060
1208
 
1209
+ References:
1210
+
1211
+ - Batch
1212
+
1061
1213
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L251)
1062
1214
 
1063
1215
  #### :gear: CommitBatchSchema
@@ -1066,6 +1218,10 @@ A schema that validates a value is an Uint8Array.
1066
1218
  | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
1067
1219
  | `CommitBatchSchema` | `ZodObject<{ batch_id: ZodBigInt; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; chunk_ids: ZodArray<ZodBigInt>; }, $strict>` |
1068
1220
 
1221
+ References:
1222
+
1223
+ - CommitBatch
1224
+
1069
1225
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L308)
1070
1226
 
1071
1227
  #### :gear: FullPathSchema
@@ -1074,6 +1230,10 @@ A schema that validates a value is an Uint8Array.
1074
1230
  | ---------------- | ----------- |
1075
1231
  | `FullPathSchema` | `ZodString` |
1076
1232
 
1233
+ References:
1234
+
1235
+ - FullPath
1236
+
1077
1237
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L339)
1078
1238
 
1079
1239
  #### :gear: OptionAssetSchema
@@ -1082,6 +1242,10 @@ A schema that validates a value is an Uint8Array.
1082
1242
  | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1083
1243
  | `OptionAssetSchema` | `ZodOptional<ZodObject<{ key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>>` |
1084
1244
 
1245
+ References:
1246
+
1247
+ - OptionAsset
1248
+
1085
1249
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L352)
1086
1250
 
1087
1251
  #### :gear: AssetAssertUploadSchema
@@ -1090,6 +1254,10 @@ A schema that validates a value is an Uint8Array.
1090
1254
  | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1091
1255
  | `AssetAssertUploadSchema` | `ZodObject<{ current: ZodOptional<ZodObject<{ key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<...>; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>>; batch: ZodObject<...>; commit_batch: Z...` |
1092
1256
 
1257
+ References:
1258
+
1259
+ - AssetAssertUpload
1260
+
1093
1261
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/payload.ts#L14)
1094
1262
 
1095
1263
  #### :gear: OnUploadAssetContextSchema
@@ -1098,6 +1266,10 @@ A schema that validates a value is an Uint8Array.
1098
1266
  | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1099
1267
  | `OnUploadAssetContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ key: ZodObject<{ name: ZodString; ... 4 more ...; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>; }, $strict>` |
1100
1268
 
1269
+ References:
1270
+
1271
+ - OnUploadAssetContext
1272
+
1101
1273
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L9)
1102
1274
 
1103
1275
  #### :gear: OnDeleteAssetContextSchema
@@ -1106,6 +1278,10 @@ A schema that validates a value is an Uint8Array.
1106
1278
  | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1107
1279
  | `OnDeleteAssetContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodOptional<ZodObject<{ key: ZodObject<{ name: ZodString; ... 4 more ...; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>>; }, $strict>` |
1108
1280
 
1281
+ References:
1282
+
1283
+ - OnDeleteAssetContext
1284
+
1109
1285
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L21)
1110
1286
 
1111
1287
  #### :gear: OnDeleteManyAssetsContextSchema
@@ -1114,6 +1290,10 @@ A schema that validates a value is an Uint8Array.
1114
1290
  | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1115
1291
  | `OnDeleteManyAssetsContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodArray<ZodOptional<ZodObject<{ key: ZodObject<{ ...; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>>>; }, $strict>` |
1116
1292
 
1293
+ References:
1294
+
1295
+ - OnDeleteManyAssetsContext
1296
+
1117
1297
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L35)
1118
1298
 
1119
1299
  #### :gear: OnDeleteFilteredAssetsContextSchema
@@ -1122,6 +1302,10 @@ A schema that validates a value is an Uint8Array.
1122
1302
  | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1123
1303
  | `OnDeleteFilteredAssetsContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodArray<ZodOptional<ZodObject<{ key: ZodObject<{ ...; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>>>; }, $strict>` |
1124
1304
 
1305
+ References:
1306
+
1307
+ - OnDeleteFilteredAssetsContext
1308
+
1125
1309
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L47)
1126
1310
 
1127
1311
  #### :gear: AssertUploadAssetContextSchema
@@ -1130,6 +1314,10 @@ A schema that validates a value is an Uint8Array.
1130
1314
  | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1131
1315
  | `AssertUploadAssetContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ current: ZodOptional<ZodObject<...>>; batch: ZodObject<...>; commit_batch: ZodObject<...>; }, $strict>; }, $strict>` |
1132
1316
 
1317
+ References:
1318
+
1319
+ - AssertUploadAssetContext
1320
+
1133
1321
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L61)
1134
1322
 
1135
1323
  #### :gear: AssertDeleteAssetContextSchema
@@ -1138,6 +1326,10 @@ A schema that validates a value is an Uint8Array.
1138
1326
  | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1139
1327
  | `AssertDeleteAssetContextSchema` | `ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>; data: ZodObject<{ key: ZodObject<{ name: ZodString; ... 4 more ...; description: ZodOptional<...>; }, $strict>; ... 4 more ...; version: ZodOptional<...>; }, $strict>; }, $strict>` |
1140
1328
 
1329
+ References:
1330
+
1331
+ - AssertDeleteAssetContext
1332
+
1141
1333
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/context.ts#L73)
1142
1334
 
1143
1335
  #### :gear: AssertSetDocSchema
@@ -1146,6 +1338,10 @@ A schema that validates a value is an Uint8Array.
1146
1338
  | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1147
1339
  | `AssertSetDocSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; assert: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodVoid>, $InferInnerFunctionType<...>>; }, $strict>` |
1148
1340
 
1341
+ References:
1342
+
1343
+ - AssertSetDoc
1344
+
1149
1345
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L45)
1150
1346
 
1151
1347
  #### :gear: AssertDeleteDocSchema
@@ -1154,6 +1350,10 @@ A schema that validates a value is an Uint8Array.
1154
1350
  | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1155
1351
  | `AssertDeleteDocSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; assert: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodVoid>, $InferInnerFunctionType<...>>; }, $strict>` |
1156
1352
 
1353
+ References:
1354
+
1355
+ - AssertDeleteDoc
1356
+
1157
1357
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L55)
1158
1358
 
1159
1359
  #### :gear: AssertUploadAssetSchema
@@ -1162,6 +1362,10 @@ A schema that validates a value is an Uint8Array.
1162
1362
  | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1163
1363
  | `AssertUploadAssetSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; assert: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodVoid>, $InferInnerFunctionType<...>>; }, $strict>` |
1164
1364
 
1365
+ References:
1366
+
1367
+ - AssertUploadAsset
1368
+
1165
1369
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L65)
1166
1370
 
1167
1371
  #### :gear: AssertDeleteAssetSchema
@@ -1170,6 +1374,10 @@ A schema that validates a value is an Uint8Array.
1170
1374
  | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1171
1375
  | `AssertDeleteAssetSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; assert: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodVoid>, $InferInnerFunctionType<...>>; }, $strict>` |
1172
1376
 
1377
+ References:
1378
+
1379
+ - AssertDeleteAsset
1380
+
1173
1381
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L75)
1174
1382
 
1175
1383
  #### :gear: AssertSchema
@@ -1178,6 +1386,10 @@ A schema that validates a value is an Uint8Array.
1178
1386
  | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1179
1387
  | `AssertSchema` | `ZodUnion<readonly [ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; assert: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodVoid>, $InferInnerFunctionType<...>>; }, $strict>, ZodObject<......` |
1180
1388
 
1389
+ References:
1390
+
1391
+ - Assert
1392
+
1181
1393
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/assertions.ts#L85)
1182
1394
 
1183
1395
  #### :gear: OnSetDocSchema
@@ -1186,6 +1398,10 @@ A schema that validates a value is an Uint8Array.
1186
1398
  | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1187
1399
  | `OnSetDocSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1188
1400
 
1401
+ References:
1402
+
1403
+ - OnSetDoc
1404
+
1189
1405
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L55)
1190
1406
 
1191
1407
  #### :gear: OnSetManyDocsSchema
@@ -1194,6 +1410,10 @@ A schema that validates a value is an Uint8Array.
1194
1410
  | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1195
1411
  | `OnSetManyDocsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodArray<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1196
1412
 
1413
+ References:
1414
+
1415
+ - OnSetManyDocs
1416
+
1197
1417
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L65)
1198
1418
 
1199
1419
  #### :gear: OnDeleteDocSchema
@@ -1202,6 +1422,10 @@ A schema that validates a value is an Uint8Array.
1202
1422
  | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1203
1423
  | `OnDeleteDocSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1204
1424
 
1425
+ References:
1426
+
1427
+ - OnDeleteDoc
1428
+
1205
1429
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L75)
1206
1430
 
1207
1431
  #### :gear: OnDeleteManyDocsSchema
@@ -1210,6 +1434,10 @@ A schema that validates a value is an Uint8Array.
1210
1434
  | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1211
1435
  | `OnDeleteManyDocsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodArray<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1212
1436
 
1437
+ References:
1438
+
1439
+ - OnDeleteManyDocs
1440
+
1213
1441
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L85)
1214
1442
 
1215
1443
  #### :gear: OnDeleteFilteredDocsSchema
@@ -1218,6 +1446,10 @@ A schema that validates a value is an Uint8Array.
1218
1446
  | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1219
1447
  | `OnDeleteFilteredDocsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodArray<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1220
1448
 
1449
+ References:
1450
+
1451
+ - OnDeleteFilteredDocs
1452
+
1221
1453
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L95)
1222
1454
 
1223
1455
  #### :gear: OnUploadAssetSchema
@@ -1226,6 +1458,10 @@ A schema that validates a value is an Uint8Array.
1226
1458
  | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1227
1459
  | `OnUploadAssetSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1228
1460
 
1461
+ References:
1462
+
1463
+ - OnUploadAsset
1464
+
1229
1465
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L105)
1230
1466
 
1231
1467
  #### :gear: OnDeleteAssetSchema
@@ -1234,6 +1470,10 @@ A schema that validates a value is an Uint8Array.
1234
1470
  | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1235
1471
  | `OnDeleteAssetSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodOptional<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1236
1472
 
1473
+ References:
1474
+
1475
+ - OnDeleteAsset
1476
+
1237
1477
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L115)
1238
1478
 
1239
1479
  #### :gear: OnDeleteManyAssetsSchema
@@ -1242,6 +1482,10 @@ A schema that validates a value is an Uint8Array.
1242
1482
  | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1243
1483
  | `OnDeleteManyAssetsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodArray<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1244
1484
 
1485
+ References:
1486
+
1487
+ - OnDeleteManyAssets
1488
+
1245
1489
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L125)
1246
1490
 
1247
1491
  #### :gear: OnDeleteFilteredAssetsSchema
@@ -1250,6 +1494,10 @@ A schema that validates a value is an Uint8Array.
1250
1494
  | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1251
1495
  | `OnDeleteFilteredAssetsSchema` | `ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodArray<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>` |
1252
1496
 
1497
+ References:
1498
+
1499
+ - OnDeleteFilteredAssets
1500
+
1253
1501
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L135)
1254
1502
 
1255
1503
  #### :gear: HookSchema
@@ -1258,6 +1506,10 @@ A schema that validates a value is an Uint8Array.
1258
1506
  | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1259
1507
  | `HookSchema` | `ZodUnion<readonly [ZodObject<{ collections: ZodReadonly<ZodArray<ZodString>>; run: ZodCustom<$InferInnerFunctionType<ZodTuple<[ZodObject<{ caller: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; data: ZodObject<...>; }, $strict>], null>, ZodUnion<...>>, $InferInnerFunctionType<...>>; }, $strict>, ... 7 more...` |
1260
1508
 
1509
+ References:
1510
+
1511
+ - Hook
1512
+
1261
1513
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/hooks.ts#L145)
1262
1514
 
1263
1515
  #### :gear: TimestampMatcherSchema
@@ -1266,6 +1518,10 @@ A schema that validates a value is an Uint8Array.
1266
1518
  | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1267
1519
  | `TimestampMatcherSchema` | `ZodUnion<readonly [ZodObject<{ equal: ZodBigInt; }, $strip>, ZodObject<{ greater_than: ZodBigInt; }, $strip>, ZodObject<{ less_than: ZodBigInt; }, $strip>, ZodObject<...>]>` |
1268
1520
 
1521
+ References:
1522
+
1523
+ - TimestampMatcher
1524
+
1269
1525
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L16)
1270
1526
 
1271
1527
  #### :gear: ListMatcherSchema
@@ -1274,6 +1530,10 @@ A schema that validates a value is an Uint8Array.
1274
1530
  | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1275
1531
  | `ListMatcherSchema` | `ZodObject<{ key: ZodOptional<ZodString>; description: ZodOptional<ZodString>; created_at: ZodOptional<ZodUnion<readonly [ZodObject<{ equal: ZodBigInt; }, $strip>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>>; updated_at: ZodOptional<...>; }, $strict>` |
1276
1532
 
1533
+ References:
1534
+
1535
+ - ListMatcher
1536
+
1277
1537
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L35)
1278
1538
 
1279
1539
  #### :gear: ListPaginateSchema
@@ -1282,6 +1542,10 @@ A schema that validates a value is an Uint8Array.
1282
1542
  | -------------------- | --------------------------------------------------------------------------------------------- |
1283
1543
  | `ListPaginateSchema` | `ZodObject<{ start_after: ZodOptional<ZodString>; limit: ZodOptional<ZodBigInt>; }, $strict>` |
1284
1544
 
1545
+ References:
1546
+
1547
+ - ListPaginate
1548
+
1285
1549
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L57)
1286
1550
 
1287
1551
  #### :gear: ListOrderFieldSchema
@@ -1290,6 +1554,10 @@ A schema that validates a value is an Uint8Array.
1290
1554
  | ---------------------- | -------------------------------------------------------------------------------- |
1291
1555
  | `ListOrderFieldSchema` | `ZodEnum<{ keys: "keys"; created_at: "created_at"; updated_at: "updated_at"; }>` |
1292
1556
 
1557
+ References:
1558
+
1559
+ - ListOrderField
1560
+
1293
1561
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L75)
1294
1562
 
1295
1563
  #### :gear: ListOrderSchema
@@ -1298,6 +1566,10 @@ A schema that validates a value is an Uint8Array.
1298
1566
  | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
1299
1567
  | `ListOrderSchema` | `ZodObject<{ desc: ZodBoolean; field: ZodEnum<{ keys: "keys"; created_at: "created_at"; updated_at: "updated_at"; }>; }, $strict>` |
1300
1568
 
1569
+ References:
1570
+
1571
+ - ListOrder
1572
+
1301
1573
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L85)
1302
1574
 
1303
1575
  #### :gear: ListParamsSchema
@@ -1306,6 +1578,10 @@ A schema that validates a value is an Uint8Array.
1306
1578
  | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1307
1579
  | `ListParamsSchema` | `ZodObject<{ matcher: ZodOptional<ZodObject<{ key: ZodOptional<ZodString>; description: ZodOptional<ZodString>; created_at: ZodOptional<ZodUnion<readonly [ZodObject<{ equal: ZodBigInt; }, $strip>, ZodObject<...>, ZodObject<...>, ZodObject<...>]>>; updated_at: ZodOptional<...>; }, $strict>>; paginate: ZodOptional<...>...` |
1308
1580
 
1581
+ References:
1582
+
1583
+ - ListParams
1584
+
1309
1585
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L103)
1310
1586
 
1311
1587
  #### :gear: ControllerScopeSchema
@@ -1314,6 +1590,10 @@ A schema that validates a value is an Uint8Array.
1314
1590
  | ----------------------- | ---------------------------------------------------------------- |
1315
1591
  | `ControllerScopeSchema` | `ZodEnum<{ write: "write"; admin: "admin"; submit: "submit"; }>` |
1316
1592
 
1593
+ References:
1594
+
1595
+ - ControllerScopeSchema
1596
+
1317
1597
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L15)
1318
1598
 
1319
1599
  #### :gear: MetadataSchema
@@ -1322,6 +1602,10 @@ A schema that validates a value is an Uint8Array.
1322
1602
  | ---------------- | ---------------------------------------- |
1323
1603
  | `MetadataSchema` | `ZodTuple<[ZodString, ZodString], null>` |
1324
1604
 
1605
+ References:
1606
+
1607
+ - MetadataSchema
1608
+
1325
1609
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L25)
1326
1610
 
1327
1611
  #### :gear: ControllerSchema
@@ -1330,6 +1614,10 @@ A schema that validates a value is an Uint8Array.
1330
1614
  | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1331
1615
  | `ControllerSchema` | `ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; }, $strict>` |
1332
1616
 
1617
+ References:
1618
+
1619
+ - ControllerSchema
1620
+
1333
1621
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L35)
1334
1622
 
1335
1623
  #### :gear: ControllerRecordSchema
@@ -1338,6 +1626,10 @@ A schema that validates a value is an Uint8Array.
1338
1626
  | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1339
1627
  | `ControllerRecordSchema` | `ZodTuple<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; }, $strict>], null>` |
1340
1628
 
1629
+ References:
1630
+
1631
+ - ControllerRecordSchema
1632
+
1341
1633
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L79)
1342
1634
 
1343
1635
  #### :gear: ControllersSchema
@@ -1346,6 +1638,10 @@ A schema that validates a value is an Uint8Array.
1346
1638
  | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1347
1639
  | `ControllersSchema` | `ZodArray<ZodTuple<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodObject<{ metadata: ZodArray<ZodTuple<[ZodString, ZodString], null>>; created_at: ZodBigInt; updated_at: ZodBigInt; expires_at: ZodOptional<...>; scope: ZodEnum<...>; }, $strict>], null>>` |
1348
1640
 
1641
+ References:
1642
+
1643
+ - ControllersSchema
1644
+
1349
1645
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L89)
1350
1646
 
1351
1647
  #### :gear: ControllerCheckParamsSchema
@@ -1354,6 +1650,10 @@ A schema that validates a value is an Uint8Array.
1354
1650
  | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1355
1651
  | `ControllerCheckParamsSchema` | `ZodObject<{ caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<Principal, Principal>]>; controllers: ZodArray<...>; }, $strip>` |
1356
1652
 
1653
+ References:
1654
+
1655
+ - ControllerCheckParamsSchema
1656
+
1357
1657
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L99)
1358
1658
 
1359
1659
  #### :gear: CollectionParamsSchema
@@ -1362,6 +1662,10 @@ A schema that validates a value is an Uint8Array.
1362
1662
  | ------------------------ | ------------------------------------------------ |
1363
1663
  | `CollectionParamsSchema` | `ZodObject<{ collection: ZodString; }, $strict>` |
1364
1664
 
1665
+ References:
1666
+
1667
+ - CollectionParams
1668
+
1365
1669
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/params.ts#L15)
1366
1670
 
1367
1671
  #### :gear: ListStoreParamsSchema
@@ -1370,6 +1674,10 @@ A schema that validates a value is an Uint8Array.
1370
1674
  | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1371
1675
  | `ListStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1372
1676
 
1677
+ References:
1678
+
1679
+ - ListStoreParams
1680
+
1373
1681
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/params.ts#L34)
1374
1682
 
1375
1683
  #### :gear: GetDocStoreParamsSchema
@@ -1378,6 +1686,10 @@ A schema that validates a value is an Uint8Array.
1378
1686
  | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1379
1687
  | `GetDocStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; key: ZodString; }, $strict>` |
1380
1688
 
1689
+ References:
1690
+
1691
+ - GetDocStoreParams
1692
+
1381
1693
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L20)
1382
1694
 
1383
1695
  #### :gear: SetDocStoreParamsSchema
@@ -1386,6 +1698,10 @@ A schema that validates a value is an Uint8Array.
1386
1698
  | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1387
1699
  | `SetDocStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; key: ZodString; doc: ZodObject<...>; }, $strict>` |
1388
1700
 
1701
+ References:
1702
+
1703
+ - SetDocStoreParams
1704
+
1389
1705
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L43)
1390
1706
 
1391
1707
  #### :gear: DeleteDocStoreParamsSchema
@@ -1394,6 +1710,10 @@ A schema that validates a value is an Uint8Array.
1394
1710
  | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1395
1711
  | `DeleteDocStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; key: ZodString; doc: ZodObject<...>; }, $strict>` |
1396
1712
 
1713
+ References:
1714
+
1715
+ - DeleteDocStoreParams
1716
+
1397
1717
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L63)
1398
1718
 
1399
1719
  #### :gear: CountCollectionDocsStoreParamsSchema
@@ -1402,6 +1722,10 @@ A schema that validates a value is an Uint8Array.
1402
1722
  | -------------------------------------- | ------------------------------------------------ |
1403
1723
  | `CountCollectionDocsStoreParamsSchema` | `ZodObject<{ collection: ZodString; }, $strict>` |
1404
1724
 
1725
+ References:
1726
+
1727
+ - CountCollectionDocsStoreParams
1728
+
1405
1729
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L83)
1406
1730
 
1407
1731
  #### :gear: CountDocsStoreParamsSchema
@@ -1410,6 +1734,10 @@ A schema that validates a value is an Uint8Array.
1410
1734
  | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1411
1735
  | `CountDocsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1412
1736
 
1737
+ References:
1738
+
1739
+ - CountDocsStoreParams
1740
+
1413
1741
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L93)
1414
1742
 
1415
1743
  #### :gear: ListDocsStoreParamsSchema
@@ -1418,6 +1746,10 @@ A schema that validates a value is an Uint8Array.
1418
1746
  | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1419
1747
  | `ListDocsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1420
1748
 
1749
+ References:
1750
+
1751
+ - ListDocsStoreParams
1752
+
1421
1753
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L103)
1422
1754
 
1423
1755
  #### :gear: DeleteDocsStoreParamsSchema
@@ -1426,6 +1758,10 @@ A schema that validates a value is an Uint8Array.
1426
1758
  | ----------------------------- | ------------------------------------------------ |
1427
1759
  | `DeleteDocsStoreParamsSchema` | `ZodObject<{ collection: ZodString; }, $strict>` |
1428
1760
 
1761
+ References:
1762
+
1763
+ - DeleteDocsStoreParams
1764
+
1429
1765
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L113)
1430
1766
 
1431
1767
  #### :gear: DeleteFilteredDocsStoreParamsSchema
@@ -1434,6 +1770,10 @@ A schema that validates a value is an Uint8Array.
1434
1770
  | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1435
1771
  | `DeleteFilteredDocsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1436
1772
 
1773
+ References:
1774
+
1775
+ - DeleteFilteredDocsParams
1776
+
1437
1777
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/db.ts#L123)
1438
1778
 
1439
1779
  #### :gear: MemorySchema
@@ -1442,6 +1782,10 @@ A schema that validates a value is an Uint8Array.
1442
1782
  | -------------- | ---------------------------------------------- |
1443
1783
  | `MemorySchema` | `ZodEnum<{ heap: "heap"; stable: "stable"; }>` |
1444
1784
 
1785
+ References:
1786
+
1787
+ - Memory
1788
+
1445
1789
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/collections.ts#L6)
1446
1790
 
1447
1791
  #### :gear: GetAssetStoreParamsSchema
@@ -1450,6 +1794,10 @@ A schema that validates a value is an Uint8Array.
1450
1794
  | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1451
1795
  | `GetAssetStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; full_path: ZodString; }, $strict>` |
1452
1796
 
1797
+ References:
1798
+
1799
+ - GetAssetStoreParams
1800
+
1453
1801
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L26)
1454
1802
 
1455
1803
  #### :gear: CountCollectionAssetsStoreParamsSchema
@@ -1458,6 +1806,10 @@ A schema that validates a value is an Uint8Array.
1458
1806
  | ---------------------------------------- | ------------------------------------------------ |
1459
1807
  | `CountCollectionAssetsStoreParamsSchema` | `ZodObject<{ collection: ZodString; }, $strict>` |
1460
1808
 
1809
+ References:
1810
+
1811
+ - CountCollectionAssetsStoreParams
1812
+
1461
1813
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L49)
1462
1814
 
1463
1815
  #### :gear: CountAssetsStoreParamsSchema
@@ -1466,6 +1818,10 @@ A schema that validates a value is an Uint8Array.
1466
1818
  | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1467
1819
  | `CountAssetsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1468
1820
 
1821
+ References:
1822
+
1823
+ - CountAssetsStoreParams
1824
+
1469
1825
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L59)
1470
1826
 
1471
1827
  #### :gear: SetAssetHandlerParamsSchema
@@ -1474,6 +1830,10 @@ A schema that validates a value is an Uint8Array.
1474
1830
  | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1475
1831
  | `SetAssetHandlerParamsSchema` | `ZodObject<{ key: ZodObject<{ name: ZodString; full_path: ZodString; token: ZodOptional<ZodString>; collection: ZodString; owner: ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<...>>; description: ZodOptional<...>; }, $strict>; content: ZodCustom<...>; headers: ZodArray<...>; }, $strict>` |
1476
1832
 
1833
+ References:
1834
+
1835
+ - SetAssetHandlerParams
1836
+
1477
1837
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L69)
1478
1838
 
1479
1839
  #### :gear: DeleteAssetsStoreParamsSchema
@@ -1482,6 +1842,10 @@ A schema that validates a value is an Uint8Array.
1482
1842
  | ------------------------------- | ------------------------------------------------ |
1483
1843
  | `DeleteAssetsStoreParamsSchema` | `ZodObject<{ collection: ZodString; }, $strict>` |
1484
1844
 
1845
+ References:
1846
+
1847
+ - DeleteAssetsStoreParams
1848
+
1485
1849
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L100)
1486
1850
 
1487
1851
  #### :gear: DeleteFilteredAssetsStoreParamsSchema
@@ -1490,6 +1854,10 @@ A schema that validates a value is an Uint8Array.
1490
1854
  | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1491
1855
  | `DeleteFilteredAssetsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1492
1856
 
1857
+ References:
1858
+
1859
+ - DeleteFilteredAssetsParams
1860
+
1493
1861
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L110)
1494
1862
 
1495
1863
  #### :gear: DeleteAssetStoreParamsSchema
@@ -1498,6 +1866,10 @@ A schema that validates a value is an Uint8Array.
1498
1866
  | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1499
1867
  | `DeleteAssetStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; full_path: ZodString; }, $strict>` |
1500
1868
 
1869
+ References:
1870
+
1871
+ - DeleteAssetStoreParams
1872
+
1501
1873
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L120)
1502
1874
 
1503
1875
  #### :gear: ListAssetsStoreParamsSchema
@@ -1506,6 +1878,10 @@ A schema that validates a value is an Uint8Array.
1506
1878
  | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1507
1879
  | `ListAssetsStoreParamsSchema` | `ZodObject<{ collection: ZodString; caller: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<...>]>; params: ZodObject<...>; }, $strict>` |
1508
1880
 
1881
+ References:
1882
+
1883
+ - ListAssetsStoreParams
1884
+
1509
1885
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L130)
1510
1886
 
1511
1887
  #### :gear: GetContentChunksStoreParamsSchema
@@ -1514,6 +1890,10 @@ A schema that validates a value is an Uint8Array.
1514
1890
  | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1515
1891
  | `GetContentChunksStoreParamsSchema` | `ZodObject<{ encoding: ZodObject<{ modified: ZodBigInt; content_chunks: ZodArray<ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>>; total_length: ZodBigInt; sha256: ZodCustom<...>; }, $strip>; chunk_index: ZodBigInt; memory: ZodEnum<...>; }, $strict>` |
1516
1892
 
1893
+ References:
1894
+
1895
+ - GetContentChunksStoreParams
1896
+
1517
1897
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L140)
1518
1898
 
1519
1899
  #### :gear: IDLTypeSchema
@@ -1522,6 +1902,10 @@ A schema that validates a value is an Uint8Array.
1522
1902
  | --------------- | ----------------------------------------- |
1523
1903
  | `IDLTypeSchema` | `ZodCustom<Type<unknown>, Type<unknown>>` |
1524
1904
 
1905
+ References:
1906
+
1907
+ - IDLType
1908
+
1525
1909
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L9)
1526
1910
 
1527
1911
  #### :gear: CallArgSchema
@@ -1530,6 +1914,10 @@ A schema that validates a value is an Uint8Array.
1530
1914
  | --------------- | ----------------------------------------------------------------------- |
1531
1915
  | `CallArgSchema` | `ZodTuple<[ZodCustom<Type<unknown>, Type<unknown>>, ZodUnknown], null>` |
1532
1916
 
1917
+ References:
1918
+
1919
+ - CallArg
1920
+
1533
1921
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L21)
1534
1922
 
1535
1923
  #### :gear: CallArgsSchema
@@ -1540,6 +1928,10 @@ Schema for encoding the call arguments.
1540
1928
  | ---------------- | --------------------------------------------------------------------------------- |
1541
1929
  | `CallArgsSchema` | `ZodArray<ZodTuple<[ZodCustom<Type<unknown>, Type<unknown>>, ZodUnknown], null>>` |
1542
1930
 
1931
+ References:
1932
+
1933
+ - CallArgs
1934
+
1543
1935
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L33)
1544
1936
 
1545
1937
  #### :gear: CallResultSchema
@@ -1548,6 +1940,10 @@ Schema for encoding the call arguments.
1548
1940
  | ------------------ | ----------------------------------------- |
1549
1941
  | `CallResultSchema` | `ZodCustom<Type<unknown>, Type<unknown>>` |
1550
1942
 
1943
+ References:
1944
+
1945
+ - CallResult
1946
+
1551
1947
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L49)
1552
1948
 
1553
1949
  #### :gear: CallParamsSchema
@@ -1556,6 +1952,10 @@ Schema for encoding the call arguments.
1556
1952
  | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1557
1953
  | `CallParamsSchema` | `ZodObject<{ canisterId: ZodUnion<[ZodCustom<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>, ZodCustom<Principal, Principal>]>; method: ZodString; args: ZodOptional<...>; result: ZodOptional<...>; }, $strip>` |
1558
1954
 
1955
+ References:
1956
+
1957
+ - CallParams
1958
+
1559
1959
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L59)
1560
1960
 
1561
1961
  ### :factory: CallResponseLengthError
@@ -1599,6 +1999,8 @@ Defines the collections where a hook or assertion should run.
1599
1999
  | ------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------ |
1600
2000
  | `collections` | `readonly string[]` | An array of collection names where the hook or assertion will run. If empty, no hooks or assertions are triggered. |
1601
2001
 
2002
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/collections.ts#L16)
2003
+
1602
2004
  #### :gear: HookContext
1603
2005
 
1604
2006
  Represents the context provided to hooks, containing information about the caller and related data.
@@ -1608,6 +2010,8 @@ Represents the context provided to hooks, containing information about the calle
1608
2010
  | `caller` | `Uint8Array<ArrayBufferLike>` | The user who originally triggered the function that in turn triggered the hook. |
1609
2011
  | `data` | `T` | The data associated with the hook execution. |
1610
2012
 
2013
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/context.ts#L22)
2014
+
1611
2015
  #### :gear: Doc
1612
2016
 
1613
2017
  Represents a document stored in a collection.
@@ -1621,6 +2025,8 @@ Represents a document stored in a collection.
1621
2025
  | `updated_at` | `bigint` | The timestamp when the document was last updated. |
1622
2026
  | `version` | `bigint or undefined` | The version number of the document, used for consistency checks. If not provided, it's assumed to be the first version. |
1623
2027
 
2028
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L43)
2029
+
1624
2030
  #### :gear: SetDoc
1625
2031
 
1626
2032
  Represents the proposed version of a document to be created or updated.
@@ -1632,6 +2038,8 @@ This can be validated before allowing the operation.
1632
2038
  | `description` | `string or undefined` | An optional description of the document. |
1633
2039
  | `version` | `bigint or undefined` | The expected version number to ensure consistency. |
1634
2040
 
2041
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L101)
2042
+
1635
2043
  #### :gear: DelDoc
1636
2044
 
1637
2045
  Represents the proposed version of a document to be deleted.
@@ -1641,6 +2049,8 @@ This can be validated before allowing the operation.
1641
2049
  | --------- | --------------------- | -------------------------------------------------- |
1642
2050
  | `version` | `bigint or undefined` | The expected version number to ensure consistency. |
1643
2051
 
2052
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/db.ts#L131)
2053
+
1644
2054
  #### :gear: DocUpsert
1645
2055
 
1646
2056
  Represents a document update operation.
@@ -1652,6 +2062,8 @@ This is used in hooks where a document is either being created or updated.
1652
2062
  | `before` | `Doc or undefined` | The previous version of the document before the update. Undefined if this is a new document. |
1653
2063
  | `after` | `Doc` | The new version of the document after the update. |
1654
2064
 
2065
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L26)
2066
+
1655
2067
  #### :gear: DocAssertSet
1656
2068
 
1657
2069
  Represents a validation check before setting a document.
@@ -1664,6 +2076,8 @@ throw an error if their validation fails.
1664
2076
  | `current` | `Doc or undefined` | The current version of the document before the operation. Undefined if this is a new document. |
1665
2077
  | `proposed` | `SetDoc` | The proposed version of the document. This can be validated before allowing the operation. |
1666
2078
 
2079
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L54)
2080
+
1667
2081
  #### :gear: DocAssertDelete
1668
2082
 
1669
2083
  Represents a validation check before deleting a document.
@@ -1676,6 +2090,8 @@ throw an error if their validation fails.
1676
2090
  | `current` | `Doc or undefined` | The current version of the document before the operation. Undefined if the document does not exist. |
1677
2091
  | `proposed` | `DelDoc` | The proposed version of the document. This can be validated before allowing the operation. |
1678
2092
 
2093
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/payload.ts#L84)
2094
+
1679
2095
  #### :gear: DocContext
1680
2096
 
1681
2097
  Represents the context of a document operation within a collection.
@@ -1686,6 +2102,8 @@ Represents the context of a document operation within a collection.
1686
2102
  | `key` | `string` | The key identifying the document within the collection. |
1687
2103
  | `data` | `T` | The data associated with the document operation. |
1688
2104
 
2105
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/db/context.ts#L32)
2106
+
1689
2107
  #### :gear: AssetKey
1690
2108
 
1691
2109
  Metadata identifying an asset within a collection and the storage system.
@@ -1699,6 +2117,8 @@ Metadata identifying an asset within a collection and the storage system.
1699
2117
  | `owner` | `Uint8Array<ArrayBufferLike>` | The owner of the asset. |
1700
2118
  | `description` | `string or undefined` | Optional description of the asset for indexing/search. |
1701
2119
 
2120
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L85)
2121
+
1702
2122
  #### :gear: AssetEncoding
1703
2123
 
1704
2124
  Represents a specific encoding of an asset, such as "gzip" or "identity" (no compression).
@@ -1710,6 +2130,8 @@ Represents a specific encoding of an asset, such as "gzip" or "identity" (no com
1710
2130
  | `total_length` | `bigint` | Total byte size of the encoded content. |
1711
2131
  | `sha256` | `Hash` | SHA-256 hash of the encoded content. |
1712
2132
 
2133
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L131)
2134
+
1713
2135
  #### :gear: Asset
1714
2136
 
1715
2137
  A stored asset including its metadata, encodings, and timestamps.
@@ -1723,6 +2145,8 @@ A stored asset including its metadata, encodings, and timestamps.
1723
2145
  | `updated_at` | `bigint` | Timestamp when the asset was last updated. |
1724
2146
  | `version` | `bigint or undefined` | Optional version number of the asset. |
1725
2147
 
2148
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L190)
2149
+
1726
2150
  #### :gear: Batch
1727
2151
 
1728
2152
  Represents a batch of chunks to be uploaded and committed to an asset.
@@ -1734,6 +2158,8 @@ Represents a batch of chunks to be uploaded and committed to an asset.
1734
2158
  | `expires_at` | `bigint` | Timestamp when this batch expires. |
1735
2159
  | `encoding_type` | `EncodingType or undefined` | Optional encoding format (e.g., "gzip"). |
1736
2160
 
2161
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L263)
2162
+
1737
2163
  #### :gear: CommitBatch
1738
2164
 
1739
2165
  Represents the final step in uploading an asset, committing the batch to storage.
@@ -1744,6 +2170,8 @@ Represents the final step in uploading an asset, committing the batch to storage
1744
2170
  | `headers` | `HeaderField[]` | HTTP headers associated with this asset. |
1745
2171
  | `chunk_ids` | `bigint[]` | List of chunk IDs that make up the asset content. |
1746
2172
 
2173
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/storage.ts#L319)
2174
+
1747
2175
  #### :gear: AssetAssertUpload
1748
2176
 
1749
2177
  Represents a validation context before uploading an asset.
@@ -1754,6 +2182,8 @@ Represents a validation context before uploading an asset.
1754
2182
  | `batch` | `Batch` | The batch metadata being uploaded. |
1755
2183
  | `commit_batch` | `CommitBatch` | The commit data describing headers and chunk ids. |
1756
2184
 
2185
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/hooks/schemas/storage/payload.ts#L25)
2186
+
1757
2187
  #### :gear: ListMatcher
1758
2188
 
1759
2189
  Matcher used to filter list results.
@@ -1765,6 +2195,8 @@ Matcher used to filter list results.
1765
2195
  | `created_at` | `TimestampMatcher or undefined` | |
1766
2196
  | `updated_at` | `TimestampMatcher or undefined` | |
1767
2197
 
2198
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L47)
2199
+
1768
2200
  #### :gear: ListPaginate
1769
2201
 
1770
2202
  Optional pagination controls for listing.
@@ -1774,6 +2206,8 @@ Optional pagination controls for listing.
1774
2206
  | `start_after` | `string or undefined` | |
1775
2207
  | `limit` | `bigint or undefined` | |
1776
2208
 
2209
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L67)
2210
+
1777
2211
  #### :gear: ListOrder
1778
2212
 
1779
2213
  Ordering strategy for listing documents.
@@ -1783,6 +2217,8 @@ Ordering strategy for listing documents.
1783
2217
  | `desc` | `boolean` | |
1784
2218
  | `field` | `ListOrderField` | |
1785
2219
 
2220
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L95)
2221
+
1786
2222
  #### :gear: ListParams
1787
2223
 
1788
2224
  Full set of listing parameters.
@@ -1794,6 +2230,8 @@ Full set of listing parameters.
1794
2230
  | `order` | `ListOrder or undefined` | |
1795
2231
  | `owner` | `Uint8Array<ArrayBufferLike> or undefined` | |
1796
2232
 
2233
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L115)
2234
+
1797
2235
  #### :gear: ListResults
1798
2236
 
1799
2237
  List results, parameterized by type of returned item.
@@ -1806,6 +2244,8 @@ List results, parameterized by type of returned item.
1806
2244
  | `matches_length` | `bigint` | |
1807
2245
  | `matches_pages` | `bigint or undefined` | |
1808
2246
 
2247
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/schemas/list.ts#L142)
2248
+
1809
2249
  #### :gear: Controller
1810
2250
 
1811
2251
  Represents a controller with access scope and associated metadata.
@@ -1818,6 +2258,8 @@ Represents a controller with access scope and associated metadata.
1818
2258
  | `expires_at` | `bigint or undefined` | Optional expiration timestamp for the controller. 👉 It's a placeholder for future implementation. |
1819
2259
  | `scope` | `"write" or "admin" or "submit"` | The scope assigned to the controller. |
1820
2260
 
2261
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L48)
2262
+
1821
2263
  #### :gear: ControllerCheckParams
1822
2264
 
1823
2265
  Represents the parameters required to perform controller checks.
@@ -1827,6 +2269,8 @@ Represents the parameters required to perform controller checks.
1827
2269
  | `caller` | `Uint8Array<ArrayBufferLike> or Principal` | The identity of the caller to verify against the controller list. |
1828
2270
  | `controllers` | `[Uint8Array<ArrayBufferLike>, { metadata: [string, string][]; created_at: bigint; updated_at: bigint; scope: "write" or "admin" or "submit"; expires_at?: bigint or undefined; }][]` | The list of controllers to check against. |
1829
2271
 
2272
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/controllers.ts#L107)
2273
+
1830
2274
  #### :gear: CollectionParams
1831
2275
 
1832
2276
  The parameters required to scope an operation to a collection.
@@ -1835,6 +2279,8 @@ The parameters required to scope an operation to a collection.
1835
2279
  | ------------ | -------- | ------------------------------------- |
1836
2280
  | `collection` | `string` | The name of the collection to target. |
1837
2281
 
2282
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/params.ts#L24)
2283
+
1838
2284
  #### :gear: SetAssetHandlerParams
1839
2285
 
1840
2286
  The parameters required to set (or update) an asset.
@@ -1845,6 +2291,8 @@ The parameters required to set (or update) an asset.
1845
2291
  | `content` | `Blob` | The binary content of the asset. |
1846
2292
  | `headers` | `HeaderFields` | Associated HTTP headers. |
1847
2293
 
2294
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L80)
2295
+
1848
2296
  #### :gear: GetContentChunksStoreParams
1849
2297
 
1850
2298
  The parameters required to retrieve a specific chunk from an asset.
@@ -1855,6 +2303,8 @@ The parameters required to retrieve a specific chunk from an asset.
1855
2303
  | `chunk_index` | `bigint` | The index of the chunk to retrieve. |
1856
2304
  | `memory` | `"heap" or "stable"` | The memory type to retrieve the chunk from. |
1857
2305
 
2306
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/sdk/schemas/storage.ts#L151)
2307
+
1858
2308
  #### :gear: CallParams
1859
2309
 
1860
2310
  Type representing the parameters required to make a canister call.
@@ -1866,6 +2316,8 @@ Type representing the parameters required to make a canister call.
1866
2316
  | `args` | `[Type<unknown>, unknown][] or undefined` | The arguments, including types and values, for the canister call. |
1867
2317
  | `result` | `Type<unknown> or undefined` | The expected result type used for decoding the response. |
1868
2318
 
2319
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/functions/src/ic-cdk/schemas/call.ts#L69)
2320
+
1869
2321
  ### :cocktail: Types
1870
2322
 
1871
2323
  - [RawPrincipal](#gear-rawprincipal)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@junobuild/functions",
3
- "version": "0.2.6",
3
+ "version": "0.2.7",
4
4
  "description": "JavaScript and TypeScript utilities for Juno Serverless Functions",
5
5
  "author": "David Dal Busco (https://daviddalbusco.com)",
6
6
  "license": "MIT",