@functional-systems/lambdadb 0.1.4 → 0.2.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 (484) hide show
  1. package/README.md +10 -11
  2. package/RUNTIMES.md +6 -6
  3. package/_speakeasy/.github/action-inputs-config.json +53 -0
  4. package/_speakeasy/.github/action-security-config.json +88 -0
  5. package/dist/commonjs/funcs/collectionsCreate.js +1 -1
  6. package/dist/commonjs/funcs/collectionsCreate.js.map +1 -1
  7. package/dist/commonjs/funcs/collectionsDelete.js +1 -1
  8. package/dist/commonjs/funcs/collectionsDelete.js.map +1 -1
  9. package/dist/commonjs/funcs/collectionsDocsBulkUpsert.js +1 -1
  10. package/dist/commonjs/funcs/collectionsDocsBulkUpsert.js.map +1 -1
  11. package/dist/commonjs/funcs/collectionsDocsDelete.js +1 -1
  12. package/dist/commonjs/funcs/collectionsDocsDelete.js.map +1 -1
  13. package/dist/commonjs/funcs/collectionsDocsFetch.js +1 -1
  14. package/dist/commonjs/funcs/collectionsDocsFetch.js.map +1 -1
  15. package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.js +1 -1
  16. package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.js.map +1 -1
  17. package/dist/commonjs/funcs/collectionsDocsListDocs.d.ts +15 -0
  18. package/dist/commonjs/funcs/collectionsDocsListDocs.d.ts.map +1 -0
  19. package/dist/commonjs/funcs/collectionsDocsListDocs.js +135 -0
  20. package/dist/commonjs/funcs/collectionsDocsListDocs.js.map +1 -0
  21. package/dist/commonjs/funcs/collectionsDocsUpdate.js +1 -1
  22. package/dist/commonjs/funcs/collectionsDocsUpdate.js.map +1 -1
  23. package/dist/commonjs/funcs/collectionsDocsUpsert.js +1 -1
  24. package/dist/commonjs/funcs/collectionsDocsUpsert.js.map +1 -1
  25. package/dist/commonjs/funcs/collectionsGet.js +1 -1
  26. package/dist/commonjs/funcs/collectionsGet.js.map +1 -1
  27. package/dist/commonjs/funcs/collectionsList.js +1 -1
  28. package/dist/commonjs/funcs/collectionsList.js.map +1 -1
  29. package/dist/commonjs/funcs/collectionsQuery.js +1 -1
  30. package/dist/commonjs/funcs/collectionsQuery.js.map +1 -1
  31. package/dist/commonjs/funcs/collectionsUpdate.js +1 -1
  32. package/dist/commonjs/funcs/collectionsUpdate.js.map +1 -1
  33. package/dist/commonjs/hooks/hooks.d.ts.map +1 -1
  34. package/dist/commonjs/hooks/hooks.js +0 -2
  35. package/dist/commonjs/hooks/hooks.js.map +1 -1
  36. package/dist/commonjs/lib/base64.d.ts +1 -1
  37. package/dist/commonjs/lib/base64.d.ts.map +1 -1
  38. package/dist/commonjs/lib/base64.js +1 -1
  39. package/dist/commonjs/lib/base64.js.map +1 -1
  40. package/dist/commonjs/lib/config.d.ts +3 -3
  41. package/dist/commonjs/lib/config.js +3 -3
  42. package/dist/commonjs/lib/encodings.d.ts +1 -0
  43. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  44. package/dist/commonjs/lib/encodings.js +12 -1
  45. package/dist/commonjs/lib/encodings.js.map +1 -1
  46. package/dist/commonjs/lib/env.d.ts +1 -1
  47. package/dist/commonjs/lib/env.d.ts.map +1 -1
  48. package/dist/commonjs/lib/env.js +19 -2
  49. package/dist/commonjs/lib/env.js.map +1 -1
  50. package/dist/commonjs/lib/schemas.d.ts +1 -1
  51. package/dist/commonjs/lib/schemas.d.ts.map +1 -1
  52. package/dist/commonjs/lib/schemas.js +2 -2
  53. package/dist/commonjs/lib/schemas.js.map +1 -1
  54. package/dist/commonjs/lib/sdks.js +2 -2
  55. package/dist/commonjs/lib/sdks.js.map +1 -1
  56. package/dist/commonjs/lib/security.d.ts.map +1 -1
  57. package/dist/commonjs/lib/security.js.map +1 -1
  58. package/dist/commonjs/lib/url.js +1 -1
  59. package/dist/commonjs/lib/url.js.map +1 -1
  60. package/dist/commonjs/models/collectionresponse.d.ts +8 -30
  61. package/dist/commonjs/models/collectionresponse.d.ts.map +1 -1
  62. package/dist/commonjs/models/collectionresponse.js +5 -28
  63. package/dist/commonjs/models/collectionresponse.js.map +1 -1
  64. package/dist/commonjs/models/errors/badrequesterror.d.ts +1 -19
  65. package/dist/commonjs/models/errors/badrequesterror.d.ts.map +1 -1
  66. package/dist/commonjs/models/errors/badrequesterror.js +2 -19
  67. package/dist/commonjs/models/errors/badrequesterror.js.map +1 -1
  68. package/dist/commonjs/models/errors/index.d.ts +1 -0
  69. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  70. package/dist/commonjs/models/errors/index.js +1 -0
  71. package/dist/commonjs/models/errors/index.js.map +1 -1
  72. package/dist/commonjs/models/errors/internalservererror.d.ts +1 -19
  73. package/dist/commonjs/models/errors/internalservererror.d.ts.map +1 -1
  74. package/dist/commonjs/models/errors/internalservererror.js +2 -19
  75. package/dist/commonjs/models/errors/internalservererror.js.map +1 -1
  76. package/dist/commonjs/models/errors/resourcealreadyexistserror.d.ts +1 -19
  77. package/dist/commonjs/models/errors/resourcealreadyexistserror.d.ts.map +1 -1
  78. package/dist/commonjs/models/errors/resourcealreadyexistserror.js +2 -19
  79. package/dist/commonjs/models/errors/resourcealreadyexistserror.js.map +1 -1
  80. package/dist/commonjs/models/errors/resourcenotfounderror.d.ts +1 -19
  81. package/dist/commonjs/models/errors/resourcenotfounderror.d.ts.map +1 -1
  82. package/dist/commonjs/models/errors/resourcenotfounderror.js +2 -19
  83. package/dist/commonjs/models/errors/resourcenotfounderror.js.map +1 -1
  84. package/dist/commonjs/models/errors/responsevalidationerror.js +1 -1
  85. package/dist/commonjs/models/errors/responsevalidationerror.js.map +1 -1
  86. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +1 -1
  87. package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -1
  88. package/dist/commonjs/models/errors/sdkvalidationerror.js +1 -1
  89. package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -1
  90. package/dist/commonjs/models/errors/toomanyrequestserror.d.ts +1 -19
  91. package/dist/commonjs/models/errors/toomanyrequestserror.d.ts.map +1 -1
  92. package/dist/commonjs/models/errors/toomanyrequestserror.js +2 -19
  93. package/dist/commonjs/models/errors/toomanyrequestserror.js.map +1 -1
  94. package/dist/commonjs/models/errors/unauthenticatederror.d.ts +1 -19
  95. package/dist/commonjs/models/errors/unauthenticatederror.d.ts.map +1 -1
  96. package/dist/commonjs/models/errors/unauthenticatederror.js +2 -19
  97. package/dist/commonjs/models/errors/unauthenticatederror.js.map +1 -1
  98. package/dist/commonjs/models/fieldsselectorunion.d.ts +47 -0
  99. package/dist/commonjs/models/fieldsselectorunion.d.ts.map +1 -0
  100. package/dist/commonjs/models/fieldsselectorunion.js +68 -0
  101. package/dist/commonjs/models/fieldsselectorunion.js.map +1 -0
  102. package/dist/commonjs/models/index.d.ts +3 -0
  103. package/dist/commonjs/models/index.d.ts.map +1 -1
  104. package/dist/commonjs/models/index.js +3 -0
  105. package/dist/commonjs/models/index.js.map +1 -1
  106. package/dist/commonjs/models/indexconfigsunion.d.ts +38 -204
  107. package/dist/commonjs/models/indexconfigsunion.d.ts.map +1 -1
  108. package/dist/commonjs/models/indexconfigsunion.js +28 -162
  109. package/dist/commonjs/models/indexconfigsunion.js.map +1 -1
  110. package/dist/commonjs/models/messageresponse.d.ts +1 -20
  111. package/dist/commonjs/models/messageresponse.d.ts.map +1 -1
  112. package/dist/commonjs/models/messageresponse.js +2 -21
  113. package/dist/commonjs/models/messageresponse.js.map +1 -1
  114. package/dist/commonjs/models/operations/bulkupsertdocs.d.ts +1 -33
  115. package/dist/commonjs/models/operations/bulkupsertdocs.d.ts.map +1 -1
  116. package/dist/commonjs/models/operations/bulkupsertdocs.js +2 -46
  117. package/dist/commonjs/models/operations/bulkupsertdocs.js.map +1 -1
  118. package/dist/commonjs/models/operations/createcollection.d.ts +3 -35
  119. package/dist/commonjs/models/operations/createcollection.d.ts.map +1 -1
  120. package/dist/commonjs/models/operations/createcollection.js +3 -45
  121. package/dist/commonjs/models/operations/createcollection.js.map +1 -1
  122. package/dist/commonjs/models/operations/deletecollection.d.ts +1 -18
  123. package/dist/commonjs/models/operations/deletecollection.d.ts.map +1 -1
  124. package/dist/commonjs/models/operations/deletecollection.js +2 -22
  125. package/dist/commonjs/models/operations/deletecollection.js.map +1 -1
  126. package/dist/commonjs/models/operations/deletedocs.d.ts +4 -33
  127. package/dist/commonjs/models/operations/deletedocs.d.ts.map +1 -1
  128. package/dist/commonjs/models/operations/deletedocs.js +4 -47
  129. package/dist/commonjs/models/operations/deletedocs.js.map +1 -1
  130. package/dist/commonjs/models/operations/fetchdocs.d.ts +9 -74
  131. package/dist/commonjs/models/operations/fetchdocs.d.ts.map +1 -1
  132. package/dist/commonjs/models/operations/fetchdocs.js +5 -88
  133. package/dist/commonjs/models/operations/fetchdocs.js.map +1 -1
  134. package/dist/commonjs/models/operations/getbulkupsertdocs.d.ts +4 -74
  135. package/dist/commonjs/models/operations/getbulkupsertdocs.d.ts.map +1 -1
  136. package/dist/commonjs/models/operations/getbulkupsertdocs.js +2 -70
  137. package/dist/commonjs/models/operations/getbulkupsertdocs.js.map +1 -1
  138. package/dist/commonjs/models/operations/getcollection.d.ts +1 -35
  139. package/dist/commonjs/models/operations/getcollection.d.ts.map +1 -1
  140. package/dist/commonjs/models/operations/getcollection.js +2 -40
  141. package/dist/commonjs/models/operations/getcollection.js.map +1 -1
  142. package/dist/commonjs/models/operations/index.d.ts +1 -0
  143. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  144. package/dist/commonjs/models/operations/index.js +1 -0
  145. package/dist/commonjs/models/operations/index.js.map +1 -1
  146. package/dist/commonjs/models/operations/listcollections.d.ts +1 -20
  147. package/dist/commonjs/models/operations/listcollections.d.ts.map +1 -1
  148. package/dist/commonjs/models/operations/listcollections.js +2 -21
  149. package/dist/commonjs/models/operations/listcollections.js.map +1 -1
  150. package/dist/commonjs/models/operations/listdocs.d.ts +43 -0
  151. package/dist/commonjs/models/operations/listdocs.d.ts.map +1 -0
  152. package/dist/commonjs/models/operations/listdocs.js +62 -0
  153. package/dist/commonjs/models/operations/listdocs.js.map +1 -0
  154. package/dist/commonjs/models/operations/querycollection.d.ts +7 -79
  155. package/dist/commonjs/models/operations/querycollection.d.ts.map +1 -1
  156. package/dist/commonjs/models/operations/querycollection.js +5 -94
  157. package/dist/commonjs/models/operations/querycollection.js.map +1 -1
  158. package/dist/commonjs/models/operations/updatecollection.d.ts +1 -50
  159. package/dist/commonjs/models/operations/updatecollection.d.ts.map +1 -1
  160. package/dist/commonjs/models/operations/updatecollection.js +2 -64
  161. package/dist/commonjs/models/operations/updatecollection.js.map +1 -1
  162. package/dist/commonjs/models/operations/updatedocs.d.ts +1 -33
  163. package/dist/commonjs/models/operations/updatedocs.d.ts.map +1 -1
  164. package/dist/commonjs/models/operations/updatedocs.js +2 -46
  165. package/dist/commonjs/models/operations/updatedocs.js.map +1 -1
  166. package/dist/commonjs/models/operations/upsertdocs.d.ts +1 -33
  167. package/dist/commonjs/models/operations/upsertdocs.d.ts.map +1 -1
  168. package/dist/commonjs/models/operations/upsertdocs.js +2 -46
  169. package/dist/commonjs/models/operations/upsertdocs.js.map +1 -1
  170. package/dist/commonjs/models/partitionconfig.d.ts +45 -0
  171. package/dist/commonjs/models/partitionconfig.d.ts.map +1 -0
  172. package/dist/commonjs/models/partitionconfig.js +73 -0
  173. package/dist/commonjs/models/partitionconfig.js.map +1 -0
  174. package/dist/commonjs/models/partitionfilter.d.ts +20 -0
  175. package/dist/commonjs/models/partitionfilter.d.ts.map +1 -0
  176. package/dist/commonjs/models/partitionfilter.js +50 -0
  177. package/dist/commonjs/models/partitionfilter.js.map +1 -0
  178. package/dist/commonjs/models/security.d.ts +1 -18
  179. package/dist/commonjs/models/security.d.ts.map +1 -1
  180. package/dist/commonjs/models/security.js +2 -26
  181. package/dist/commonjs/models/security.js.map +1 -1
  182. package/dist/commonjs/models/status.d.ts +1 -21
  183. package/dist/commonjs/models/status.d.ts.map +1 -1
  184. package/dist/commonjs/models/status.js +2 -15
  185. package/dist/commonjs/models/status.js.map +1 -1
  186. package/dist/commonjs/sdk/docs.d.ts +4 -0
  187. package/dist/commonjs/sdk/docs.d.ts.map +1 -1
  188. package/dist/commonjs/sdk/docs.js +7 -0
  189. package/dist/commonjs/sdk/docs.js.map +1 -1
  190. package/dist/commonjs/types/blobs.d.ts +1 -1
  191. package/dist/commonjs/types/blobs.d.ts.map +1 -1
  192. package/dist/commonjs/types/blobs.js +1 -1
  193. package/dist/commonjs/types/blobs.js.map +1 -1
  194. package/dist/commonjs/types/constdatetime.d.ts +1 -1
  195. package/dist/commonjs/types/constdatetime.d.ts.map +1 -1
  196. package/dist/commonjs/types/constdatetime.js +1 -1
  197. package/dist/commonjs/types/constdatetime.js.map +1 -1
  198. package/dist/commonjs/types/enums.d.ts +8 -11
  199. package/dist/commonjs/types/enums.d.ts.map +1 -1
  200. package/dist/commonjs/types/enums.js +59 -3
  201. package/dist/commonjs/types/enums.js.map +1 -1
  202. package/dist/commonjs/types/index.d.ts +2 -2
  203. package/dist/commonjs/types/index.d.ts.map +1 -1
  204. package/dist/commonjs/types/index.js +16 -3
  205. package/dist/commonjs/types/index.js.map +1 -1
  206. package/dist/commonjs/types/unrecognized.d.ts +16 -0
  207. package/dist/commonjs/types/unrecognized.d.ts.map +1 -0
  208. package/dist/commonjs/types/unrecognized.js +34 -0
  209. package/dist/commonjs/types/unrecognized.js.map +1 -0
  210. package/dist/esm/funcs/collectionsCreate.js +1 -1
  211. package/dist/esm/funcs/collectionsCreate.js.map +1 -1
  212. package/dist/esm/funcs/collectionsDelete.js +1 -1
  213. package/dist/esm/funcs/collectionsDelete.js.map +1 -1
  214. package/dist/esm/funcs/collectionsDocsBulkUpsert.js +1 -1
  215. package/dist/esm/funcs/collectionsDocsBulkUpsert.js.map +1 -1
  216. package/dist/esm/funcs/collectionsDocsDelete.js +1 -1
  217. package/dist/esm/funcs/collectionsDocsDelete.js.map +1 -1
  218. package/dist/esm/funcs/collectionsDocsFetch.js +1 -1
  219. package/dist/esm/funcs/collectionsDocsFetch.js.map +1 -1
  220. package/dist/esm/funcs/collectionsDocsGetBulkUpsert.js +1 -1
  221. package/dist/esm/funcs/collectionsDocsGetBulkUpsert.js.map +1 -1
  222. package/dist/esm/funcs/collectionsDocsListDocs.d.ts +15 -0
  223. package/dist/esm/funcs/collectionsDocsListDocs.d.ts.map +1 -0
  224. package/dist/esm/funcs/collectionsDocsListDocs.js +99 -0
  225. package/dist/esm/funcs/collectionsDocsListDocs.js.map +1 -0
  226. package/dist/esm/funcs/collectionsDocsUpdate.js +1 -1
  227. package/dist/esm/funcs/collectionsDocsUpdate.js.map +1 -1
  228. package/dist/esm/funcs/collectionsDocsUpsert.js +1 -1
  229. package/dist/esm/funcs/collectionsDocsUpsert.js.map +1 -1
  230. package/dist/esm/funcs/collectionsGet.js +1 -1
  231. package/dist/esm/funcs/collectionsGet.js.map +1 -1
  232. package/dist/esm/funcs/collectionsList.js +1 -1
  233. package/dist/esm/funcs/collectionsList.js.map +1 -1
  234. package/dist/esm/funcs/collectionsQuery.js +1 -1
  235. package/dist/esm/funcs/collectionsQuery.js.map +1 -1
  236. package/dist/esm/funcs/collectionsUpdate.js +1 -1
  237. package/dist/esm/funcs/collectionsUpdate.js.map +1 -1
  238. package/dist/esm/hooks/hooks.d.ts.map +1 -1
  239. package/dist/esm/hooks/hooks.js +0 -2
  240. package/dist/esm/hooks/hooks.js.map +1 -1
  241. package/dist/esm/lib/base64.d.ts +1 -1
  242. package/dist/esm/lib/base64.d.ts.map +1 -1
  243. package/dist/esm/lib/base64.js +1 -1
  244. package/dist/esm/lib/base64.js.map +1 -1
  245. package/dist/esm/lib/config.d.ts +3 -3
  246. package/dist/esm/lib/config.js +3 -3
  247. package/dist/esm/lib/encodings.d.ts +1 -0
  248. package/dist/esm/lib/encodings.d.ts.map +1 -1
  249. package/dist/esm/lib/encodings.js +12 -1
  250. package/dist/esm/lib/encodings.js.map +1 -1
  251. package/dist/esm/lib/env.d.ts +1 -1
  252. package/dist/esm/lib/env.d.ts.map +1 -1
  253. package/dist/esm/lib/env.js +19 -2
  254. package/dist/esm/lib/env.js.map +1 -1
  255. package/dist/esm/lib/schemas.d.ts +1 -1
  256. package/dist/esm/lib/schemas.d.ts.map +1 -1
  257. package/dist/esm/lib/schemas.js +1 -1
  258. package/dist/esm/lib/schemas.js.map +1 -1
  259. package/dist/esm/lib/sdks.js +2 -2
  260. package/dist/esm/lib/sdks.js.map +1 -1
  261. package/dist/esm/lib/security.d.ts.map +1 -1
  262. package/dist/esm/lib/security.js.map +1 -1
  263. package/dist/esm/lib/url.js +1 -1
  264. package/dist/esm/lib/url.js.map +1 -1
  265. package/dist/esm/models/collectionresponse.d.ts +8 -30
  266. package/dist/esm/models/collectionresponse.d.ts.map +1 -1
  267. package/dist/esm/models/collectionresponse.js +6 -28
  268. package/dist/esm/models/collectionresponse.js.map +1 -1
  269. package/dist/esm/models/errors/badrequesterror.d.ts +1 -19
  270. package/dist/esm/models/errors/badrequesterror.d.ts.map +1 -1
  271. package/dist/esm/models/errors/badrequesterror.js +1 -18
  272. package/dist/esm/models/errors/badrequesterror.js.map +1 -1
  273. package/dist/esm/models/errors/index.d.ts +1 -0
  274. package/dist/esm/models/errors/index.d.ts.map +1 -1
  275. package/dist/esm/models/errors/index.js +1 -0
  276. package/dist/esm/models/errors/index.js.map +1 -1
  277. package/dist/esm/models/errors/internalservererror.d.ts +1 -19
  278. package/dist/esm/models/errors/internalservererror.d.ts.map +1 -1
  279. package/dist/esm/models/errors/internalservererror.js +1 -18
  280. package/dist/esm/models/errors/internalservererror.js.map +1 -1
  281. package/dist/esm/models/errors/resourcealreadyexistserror.d.ts +1 -19
  282. package/dist/esm/models/errors/resourcealreadyexistserror.d.ts.map +1 -1
  283. package/dist/esm/models/errors/resourcealreadyexistserror.js +1 -18
  284. package/dist/esm/models/errors/resourcealreadyexistserror.js.map +1 -1
  285. package/dist/esm/models/errors/resourcenotfounderror.d.ts +1 -19
  286. package/dist/esm/models/errors/resourcenotfounderror.d.ts.map +1 -1
  287. package/dist/esm/models/errors/resourcenotfounderror.js +1 -18
  288. package/dist/esm/models/errors/resourcenotfounderror.js.map +1 -1
  289. package/dist/esm/models/errors/responsevalidationerror.js +1 -1
  290. package/dist/esm/models/errors/responsevalidationerror.js.map +1 -1
  291. package/dist/esm/models/errors/sdkvalidationerror.d.ts +1 -1
  292. package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -1
  293. package/dist/esm/models/errors/sdkvalidationerror.js +1 -1
  294. package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -1
  295. package/dist/esm/models/errors/toomanyrequestserror.d.ts +1 -19
  296. package/dist/esm/models/errors/toomanyrequestserror.d.ts.map +1 -1
  297. package/dist/esm/models/errors/toomanyrequestserror.js +1 -18
  298. package/dist/esm/models/errors/toomanyrequestserror.js.map +1 -1
  299. package/dist/esm/models/errors/unauthenticatederror.d.ts +1 -19
  300. package/dist/esm/models/errors/unauthenticatederror.d.ts.map +1 -1
  301. package/dist/esm/models/errors/unauthenticatederror.js +1 -18
  302. package/dist/esm/models/errors/unauthenticatederror.js.map +1 -1
  303. package/dist/esm/models/fieldsselectorunion.d.ts +47 -0
  304. package/dist/esm/models/fieldsselectorunion.d.ts.map +1 -0
  305. package/dist/esm/models/fieldsselectorunion.js +29 -0
  306. package/dist/esm/models/fieldsselectorunion.js.map +1 -0
  307. package/dist/esm/models/index.d.ts +3 -0
  308. package/dist/esm/models/index.d.ts.map +1 -1
  309. package/dist/esm/models/index.js +3 -0
  310. package/dist/esm/models/index.js.map +1 -1
  311. package/dist/esm/models/indexconfigsunion.d.ts +38 -204
  312. package/dist/esm/models/indexconfigsunion.d.ts.map +1 -1
  313. package/dist/esm/models/indexconfigsunion.js +27 -161
  314. package/dist/esm/models/indexconfigsunion.js.map +1 -1
  315. package/dist/esm/models/messageresponse.d.ts +1 -20
  316. package/dist/esm/models/messageresponse.d.ts.map +1 -1
  317. package/dist/esm/models/messageresponse.js +1 -19
  318. package/dist/esm/models/messageresponse.js.map +1 -1
  319. package/dist/esm/models/operations/bulkupsertdocs.d.ts +1 -33
  320. package/dist/esm/models/operations/bulkupsertdocs.d.ts.map +1 -1
  321. package/dist/esm/models/operations/bulkupsertdocs.js +1 -43
  322. package/dist/esm/models/operations/bulkupsertdocs.js.map +1 -1
  323. package/dist/esm/models/operations/createcollection.d.ts +3 -35
  324. package/dist/esm/models/operations/createcollection.d.ts.map +1 -1
  325. package/dist/esm/models/operations/createcollection.js +2 -42
  326. package/dist/esm/models/operations/createcollection.js.map +1 -1
  327. package/dist/esm/models/operations/deletecollection.d.ts +1 -18
  328. package/dist/esm/models/operations/deletecollection.d.ts.map +1 -1
  329. package/dist/esm/models/operations/deletecollection.js +1 -20
  330. package/dist/esm/models/operations/deletecollection.js.map +1 -1
  331. package/dist/esm/models/operations/deletedocs.d.ts +4 -33
  332. package/dist/esm/models/operations/deletedocs.d.ts.map +1 -1
  333. package/dist/esm/models/operations/deletedocs.js +3 -44
  334. package/dist/esm/models/operations/deletedocs.js.map +1 -1
  335. package/dist/esm/models/operations/fetchdocs.d.ts +9 -74
  336. package/dist/esm/models/operations/fetchdocs.d.ts.map +1 -1
  337. package/dist/esm/models/operations/fetchdocs.js +4 -83
  338. package/dist/esm/models/operations/fetchdocs.js.map +1 -1
  339. package/dist/esm/models/operations/getbulkupsertdocs.d.ts +4 -74
  340. package/dist/esm/models/operations/getbulkupsertdocs.d.ts.map +1 -1
  341. package/dist/esm/models/operations/getbulkupsertdocs.js +1 -67
  342. package/dist/esm/models/operations/getbulkupsertdocs.js.map +1 -1
  343. package/dist/esm/models/operations/getcollection.d.ts +1 -35
  344. package/dist/esm/models/operations/getcollection.d.ts.map +1 -1
  345. package/dist/esm/models/operations/getcollection.js +1 -37
  346. package/dist/esm/models/operations/getcollection.js.map +1 -1
  347. package/dist/esm/models/operations/index.d.ts +1 -0
  348. package/dist/esm/models/operations/index.d.ts.map +1 -1
  349. package/dist/esm/models/operations/index.js +1 -0
  350. package/dist/esm/models/operations/index.js.map +1 -1
  351. package/dist/esm/models/operations/listcollections.d.ts +1 -20
  352. package/dist/esm/models/operations/listcollections.d.ts.map +1 -1
  353. package/dist/esm/models/operations/listcollections.js +1 -19
  354. package/dist/esm/models/operations/listcollections.js.map +1 -1
  355. package/dist/esm/models/operations/listdocs.d.ts +43 -0
  356. package/dist/esm/models/operations/listdocs.d.ts.map +1 -0
  357. package/dist/esm/models/operations/listdocs.js +24 -0
  358. package/dist/esm/models/operations/listdocs.js.map +1 -0
  359. package/dist/esm/models/operations/querycollection.d.ts +7 -79
  360. package/dist/esm/models/operations/querycollection.d.ts.map +1 -1
  361. package/dist/esm/models/operations/querycollection.js +4 -89
  362. package/dist/esm/models/operations/querycollection.js.map +1 -1
  363. package/dist/esm/models/operations/updatecollection.d.ts +1 -50
  364. package/dist/esm/models/operations/updatecollection.d.ts.map +1 -1
  365. package/dist/esm/models/operations/updatecollection.js +1 -60
  366. package/dist/esm/models/operations/updatecollection.js.map +1 -1
  367. package/dist/esm/models/operations/updatedocs.d.ts +1 -33
  368. package/dist/esm/models/operations/updatedocs.d.ts.map +1 -1
  369. package/dist/esm/models/operations/updatedocs.js +1 -43
  370. package/dist/esm/models/operations/updatedocs.js.map +1 -1
  371. package/dist/esm/models/operations/upsertdocs.d.ts +1 -33
  372. package/dist/esm/models/operations/upsertdocs.d.ts.map +1 -1
  373. package/dist/esm/models/operations/upsertdocs.js +1 -43
  374. package/dist/esm/models/operations/upsertdocs.js.map +1 -1
  375. package/dist/esm/models/partitionconfig.d.ts +45 -0
  376. package/dist/esm/models/partitionconfig.d.ts.map +1 -0
  377. package/dist/esm/models/partitionconfig.js +35 -0
  378. package/dist/esm/models/partitionconfig.js.map +1 -0
  379. package/dist/esm/models/partitionfilter.d.ts +20 -0
  380. package/dist/esm/models/partitionfilter.d.ts.map +1 -0
  381. package/dist/esm/models/partitionfilter.js +13 -0
  382. package/dist/esm/models/partitionfilter.js.map +1 -0
  383. package/dist/esm/models/security.d.ts +1 -18
  384. package/dist/esm/models/security.d.ts.map +1 -1
  385. package/dist/esm/models/security.js +1 -24
  386. package/dist/esm/models/security.js.map +1 -1
  387. package/dist/esm/models/status.d.ts +1 -21
  388. package/dist/esm/models/status.d.ts.map +1 -1
  389. package/dist/esm/models/status.js +1 -14
  390. package/dist/esm/models/status.js.map +1 -1
  391. package/dist/esm/sdk/docs.d.ts +4 -0
  392. package/dist/esm/sdk/docs.d.ts.map +1 -1
  393. package/dist/esm/sdk/docs.js +7 -0
  394. package/dist/esm/sdk/docs.js.map +1 -1
  395. package/dist/esm/types/blobs.d.ts +1 -1
  396. package/dist/esm/types/blobs.d.ts.map +1 -1
  397. package/dist/esm/types/blobs.js +1 -1
  398. package/dist/esm/types/blobs.js.map +1 -1
  399. package/dist/esm/types/constdatetime.d.ts +1 -1
  400. package/dist/esm/types/constdatetime.d.ts.map +1 -1
  401. package/dist/esm/types/constdatetime.js +1 -1
  402. package/dist/esm/types/constdatetime.js.map +1 -1
  403. package/dist/esm/types/enums.d.ts +8 -11
  404. package/dist/esm/types/enums.d.ts.map +1 -1
  405. package/dist/esm/types/enums.js +22 -2
  406. package/dist/esm/types/enums.js.map +1 -1
  407. package/dist/esm/types/index.d.ts +2 -2
  408. package/dist/esm/types/index.d.ts.map +1 -1
  409. package/dist/esm/types/index.js +1 -1
  410. package/dist/esm/types/index.js.map +1 -1
  411. package/dist/esm/types/unrecognized.d.ts +16 -0
  412. package/dist/esm/types/unrecognized.d.ts.map +1 -0
  413. package/dist/esm/types/unrecognized.js +31 -0
  414. package/dist/esm/types/unrecognized.js.map +1 -0
  415. package/examples/collectionsList.example.ts +2 -2
  416. package/examples/package-lock.json +3 -3
  417. package/jsr.json +1 -1
  418. package/package.json +3 -3
  419. package/src/funcs/collectionsCreate.ts +1 -1
  420. package/src/funcs/collectionsDelete.ts +1 -1
  421. package/src/funcs/collectionsDocsBulkUpsert.ts +1 -1
  422. package/src/funcs/collectionsDocsDelete.ts +1 -1
  423. package/src/funcs/collectionsDocsFetch.ts +1 -1
  424. package/src/funcs/collectionsDocsGetBulkUpsert.ts +1 -1
  425. package/src/funcs/collectionsDocsListDocs.ts +204 -0
  426. package/src/funcs/collectionsDocsUpdate.ts +1 -1
  427. package/src/funcs/collectionsDocsUpsert.ts +1 -1
  428. package/src/funcs/collectionsGet.ts +1 -1
  429. package/src/funcs/collectionsList.ts +1 -1
  430. package/src/funcs/collectionsQuery.ts +1 -1
  431. package/src/funcs/collectionsUpdate.ts +1 -1
  432. package/src/hooks/hooks.ts +0 -3
  433. package/src/lib/base64.ts +1 -1
  434. package/src/lib/config.ts +3 -3
  435. package/src/lib/encodings.ts +17 -3
  436. package/src/lib/env.ts +21 -5
  437. package/src/lib/schemas.ts +1 -1
  438. package/src/lib/sdks.ts +2 -2
  439. package/src/lib/security.ts +4 -1
  440. package/src/lib/url.ts +1 -1
  441. package/src/models/collectionresponse.ts +12 -56
  442. package/src/models/errors/badrequesterror.ts +1 -30
  443. package/src/models/errors/index.ts +1 -0
  444. package/src/models/errors/internalservererror.ts +1 -30
  445. package/src/models/errors/resourcealreadyexistserror.ts +1 -30
  446. package/src/models/errors/resourcenotfounderror.ts +1 -30
  447. package/src/models/errors/responsevalidationerror.ts +1 -1
  448. package/src/models/errors/sdkvalidationerror.ts +1 -1
  449. package/src/models/errors/toomanyrequestserror.ts +1 -30
  450. package/src/models/errors/unauthenticatederror.ts +1 -30
  451. package/src/models/fieldsselectorunion.ts +99 -0
  452. package/src/models/index.ts +3 -0
  453. package/src/models/indexconfigsunion.ts +76 -216
  454. package/src/models/messageresponse.ts +1 -34
  455. package/src/models/operations/bulkupsertdocs.ts +1 -73
  456. package/src/models/operations/createcollection.ts +4 -73
  457. package/src/models/operations/deletecollection.ts +1 -36
  458. package/src/models/operations/deletedocs.ts +5 -74
  459. package/src/models/operations/fetchdocs.ts +11 -144
  460. package/src/models/operations/getbulkupsertdocs.ts +4 -109
  461. package/src/models/operations/getcollection.ts +1 -68
  462. package/src/models/operations/index.ts +1 -0
  463. package/src/models/operations/listcollections.ts +1 -36
  464. package/src/models/operations/listdocs.ts +80 -0
  465. package/src/models/operations/querycollection.ts +9 -159
  466. package/src/models/operations/updatecollection.ts +1 -105
  467. package/src/models/operations/updatedocs.ts +1 -73
  468. package/src/models/operations/upsertdocs.ts +1 -73
  469. package/src/models/partitionconfig.ts +85 -0
  470. package/src/models/partitionfilter.ts +38 -0
  471. package/src/models/security.ts +1 -40
  472. package/src/models/status.ts +1 -16
  473. package/src/sdk/docs.ts +15 -0
  474. package/src/types/blobs.ts +7 -6
  475. package/src/types/constdatetime.ts +1 -1
  476. package/src/types/enums.ts +38 -9
  477. package/src/types/index.ts +2 -2
  478. package/src/types/unrecognized.ts +35 -0
  479. package/tsconfig.json +1 -2
  480. package/.devcontainer/README.md +0 -30
  481. package/docs/sdks/collections/README.md +0 -551
  482. package/docs/sdks/docs/README.md +0 -594
  483. package/docs/sdks/lambdadb/README.md +0 -7
  484. package/examples/README.md +0 -31
@@ -1,594 +0,0 @@
1
- # Docs
2
- (*collections.docs*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [upsert](#upsert) - Upsert documents into a collection. Note that the maximum supported payload size is 6MB.
9
- * [getBulkUpsert](#getbulkupsert) - Request required info to upload documents.
10
- * [bulkUpsert](#bulkupsert) - Bulk upsert documents into a collection. Note that the maximum supported object size is 200MB.
11
- * [update](#update) - Update documents in a collection. Note that the maximum supported payload size is 6MB.
12
- * [delete](#delete) - Delete documents by document IDs or query filter from a collection.
13
- * [fetch](#fetch) - Lookup and return documents by document IDs from a collection.
14
-
15
- ## upsert
16
-
17
- Upsert documents into a collection. Note that the maximum supported payload size is 6MB.
18
-
19
- ### Example Usage
20
-
21
- <!-- UsageSnippet language="typescript" operationID="upsertDocs" method="post" path="/collections/{collectionName}/docs/upsert" -->
22
- ```typescript
23
- import { LambdaDB } from "@functional-systems/lambdadb";
24
-
25
- const lambdaDB = new LambdaDB({
26
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
27
- });
28
-
29
- async function run() {
30
- const result = await lambdaDB.collections.docs.upsert({
31
- collectionName: "<value>",
32
- requestBody: {
33
- docs: [
34
- {
35
- "example-field1": "example-value1",
36
- "example-field2": [
37
- 0.1,
38
- 0.2,
39
- 0.3,
40
- ],
41
- },
42
- {
43
- "example-field1": "example-value2",
44
- "example-field2": [
45
- 0.4,
46
- 0.5,
47
- 0.6,
48
- ],
49
- },
50
- ],
51
- },
52
- });
53
-
54
- console.log(result);
55
- }
56
-
57
- run();
58
- ```
59
-
60
- ### Standalone function
61
-
62
- The standalone function version of this method:
63
-
64
- ```typescript
65
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
66
- import { collectionsDocsUpsert } from "@functional-systems/lambdadb/funcs/collectionsDocsUpsert.js";
67
-
68
- // Use `LambdaDBCore` for best tree-shaking performance.
69
- // You can create one instance of it to use across an application.
70
- const lambdaDB = new LambdaDBCore({
71
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
72
- });
73
-
74
- async function run() {
75
- const res = await collectionsDocsUpsert(lambdaDB, {
76
- collectionName: "<value>",
77
- requestBody: {
78
- docs: [
79
- {
80
- "example-field1": "example-value1",
81
- "example-field2": [
82
- 0.1,
83
- 0.2,
84
- 0.3,
85
- ],
86
- },
87
- {
88
- "example-field1": "example-value2",
89
- "example-field2": [
90
- 0.4,
91
- 0.5,
92
- 0.6,
93
- ],
94
- },
95
- ],
96
- },
97
- });
98
- if (res.ok) {
99
- const { value: result } = res;
100
- console.log(result);
101
- } else {
102
- console.log("collectionsDocsUpsert failed:", res.error);
103
- }
104
- }
105
-
106
- run();
107
- ```
108
-
109
- ### Parameters
110
-
111
- | Parameter | Type | Required | Description |
112
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
113
- | `request` | [operations.UpsertDocsRequest](../../models/operations/upsertdocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
114
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
115
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
116
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
117
-
118
- ### Response
119
-
120
- **Promise\<[models.MessageResponse](../../models/messageresponse.md)\>**
121
-
122
- ### Errors
123
-
124
- | Error Type | Status Code | Content Type |
125
- | ---------------------------- | ---------------------------- | ---------------------------- |
126
- | errors.BadRequestError | 400 | application/json |
127
- | errors.UnauthenticatedError | 401 | application/json |
128
- | errors.ResourceNotFoundError | 404 | application/json |
129
- | errors.TooManyRequestsError | 429 | application/json |
130
- | errors.InternalServerError | 500 | application/json |
131
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
132
-
133
- ## getBulkUpsert
134
-
135
- Request required info to upload documents.
136
-
137
- ### Example Usage
138
-
139
- <!-- UsageSnippet language="typescript" operationID="getBulkUpsertDocs" method="get" path="/collections/{collectionName}/docs/bulk-upsert" -->
140
- ```typescript
141
- import { LambdaDB } from "@functional-systems/lambdadb";
142
-
143
- const lambdaDB = new LambdaDB({
144
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
145
- });
146
-
147
- async function run() {
148
- const result = await lambdaDB.collections.docs.getBulkUpsert({
149
- collectionName: "<value>",
150
- });
151
-
152
- console.log(result);
153
- }
154
-
155
- run();
156
- ```
157
-
158
- ### Standalone function
159
-
160
- The standalone function version of this method:
161
-
162
- ```typescript
163
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
164
- import { collectionsDocsGetBulkUpsert } from "@functional-systems/lambdadb/funcs/collectionsDocsGetBulkUpsert.js";
165
-
166
- // Use `LambdaDBCore` for best tree-shaking performance.
167
- // You can create one instance of it to use across an application.
168
- const lambdaDB = new LambdaDBCore({
169
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
170
- });
171
-
172
- async function run() {
173
- const res = await collectionsDocsGetBulkUpsert(lambdaDB, {
174
- collectionName: "<value>",
175
- });
176
- if (res.ok) {
177
- const { value: result } = res;
178
- console.log(result);
179
- } else {
180
- console.log("collectionsDocsGetBulkUpsert failed:", res.error);
181
- }
182
- }
183
-
184
- run();
185
- ```
186
-
187
- ### Parameters
188
-
189
- | Parameter | Type | Required | Description |
190
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
191
- | `request` | [operations.GetBulkUpsertDocsRequest](../../models/operations/getbulkupsertdocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
192
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
193
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
194
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
195
-
196
- ### Response
197
-
198
- **Promise\<[operations.GetBulkUpsertDocsResponse](../../models/operations/getbulkupsertdocsresponse.md)\>**
199
-
200
- ### Errors
201
-
202
- | Error Type | Status Code | Content Type |
203
- | ---------------------------- | ---------------------------- | ---------------------------- |
204
- | errors.UnauthenticatedError | 401 | application/json |
205
- | errors.ResourceNotFoundError | 404 | application/json |
206
- | errors.TooManyRequestsError | 429 | application/json |
207
- | errors.InternalServerError | 500 | application/json |
208
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
209
-
210
- ## bulkUpsert
211
-
212
- Bulk upsert documents into a collection. Note that the maximum supported object size is 200MB.
213
-
214
- ### Example Usage
215
-
216
- <!-- UsageSnippet language="typescript" operationID="bulkUpsertDocs" method="post" path="/collections/{collectionName}/docs/bulk-upsert" -->
217
- ```typescript
218
- import { LambdaDB } from "@functional-systems/lambdadb";
219
-
220
- const lambdaDB = new LambdaDB({
221
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
222
- });
223
-
224
- async function run() {
225
- const result = await lambdaDB.collections.docs.bulkUpsert({
226
- collectionName: "<value>",
227
- requestBody: {
228
- objectKey: "example-object-key",
229
- },
230
- });
231
-
232
- console.log(result);
233
- }
234
-
235
- run();
236
- ```
237
-
238
- ### Standalone function
239
-
240
- The standalone function version of this method:
241
-
242
- ```typescript
243
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
244
- import { collectionsDocsBulkUpsert } from "@functional-systems/lambdadb/funcs/collectionsDocsBulkUpsert.js";
245
-
246
- // Use `LambdaDBCore` for best tree-shaking performance.
247
- // You can create one instance of it to use across an application.
248
- const lambdaDB = new LambdaDBCore({
249
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
250
- });
251
-
252
- async function run() {
253
- const res = await collectionsDocsBulkUpsert(lambdaDB, {
254
- collectionName: "<value>",
255
- requestBody: {
256
- objectKey: "example-object-key",
257
- },
258
- });
259
- if (res.ok) {
260
- const { value: result } = res;
261
- console.log(result);
262
- } else {
263
- console.log("collectionsDocsBulkUpsert failed:", res.error);
264
- }
265
- }
266
-
267
- run();
268
- ```
269
-
270
- ### Parameters
271
-
272
- | Parameter | Type | Required | Description |
273
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
274
- | `request` | [operations.BulkUpsertDocsRequest](../../models/operations/bulkupsertdocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
275
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
276
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
277
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
278
-
279
- ### Response
280
-
281
- **Promise\<[models.MessageResponse](../../models/messageresponse.md)\>**
282
-
283
- ### Errors
284
-
285
- | Error Type | Status Code | Content Type |
286
- | ---------------------------- | ---------------------------- | ---------------------------- |
287
- | errors.BadRequestError | 400 | application/json |
288
- | errors.UnauthenticatedError | 401 | application/json |
289
- | errors.ResourceNotFoundError | 404 | application/json |
290
- | errors.TooManyRequestsError | 429 | application/json |
291
- | errors.InternalServerError | 500 | application/json |
292
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
293
-
294
- ## update
295
-
296
- Update documents in a collection. Note that the maximum supported payload size is 6MB.
297
-
298
- ### Example Usage
299
-
300
- <!-- UsageSnippet language="typescript" operationID="updateDocs" method="post" path="/collections/{collectionName}/docs/update" -->
301
- ```typescript
302
- import { LambdaDB } from "@functional-systems/lambdadb";
303
-
304
- const lambdaDB = new LambdaDB({
305
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
306
- });
307
-
308
- async function run() {
309
- const result = await lambdaDB.collections.docs.update({
310
- collectionName: "<value>",
311
- requestBody: {
312
- docs: [
313
- {
314
- "id": "example-id1",
315
- "example-field1": "example-value1",
316
- "example-field2": [
317
- 0.1,
318
- 0.2,
319
- 0.3,
320
- ],
321
- },
322
- {
323
- "id": "example-id2",
324
- "example-field1": "example-value2",
325
- "example-field2": [
326
- 0.4,
327
- 0.5,
328
- 0.6,
329
- ],
330
- },
331
- ],
332
- },
333
- });
334
-
335
- console.log(result);
336
- }
337
-
338
- run();
339
- ```
340
-
341
- ### Standalone function
342
-
343
- The standalone function version of this method:
344
-
345
- ```typescript
346
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
347
- import { collectionsDocsUpdate } from "@functional-systems/lambdadb/funcs/collectionsDocsUpdate.js";
348
-
349
- // Use `LambdaDBCore` for best tree-shaking performance.
350
- // You can create one instance of it to use across an application.
351
- const lambdaDB = new LambdaDBCore({
352
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
353
- });
354
-
355
- async function run() {
356
- const res = await collectionsDocsUpdate(lambdaDB, {
357
- collectionName: "<value>",
358
- requestBody: {
359
- docs: [
360
- {
361
- "id": "example-id1",
362
- "example-field1": "example-value1",
363
- "example-field2": [
364
- 0.1,
365
- 0.2,
366
- 0.3,
367
- ],
368
- },
369
- {
370
- "id": "example-id2",
371
- "example-field1": "example-value2",
372
- "example-field2": [
373
- 0.4,
374
- 0.5,
375
- 0.6,
376
- ],
377
- },
378
- ],
379
- },
380
- });
381
- if (res.ok) {
382
- const { value: result } = res;
383
- console.log(result);
384
- } else {
385
- console.log("collectionsDocsUpdate failed:", res.error);
386
- }
387
- }
388
-
389
- run();
390
- ```
391
-
392
- ### Parameters
393
-
394
- | Parameter | Type | Required | Description |
395
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
396
- | `request` | [operations.UpdateDocsRequest](../../models/operations/updatedocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
397
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
398
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
399
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
400
-
401
- ### Response
402
-
403
- **Promise\<[models.MessageResponse](../../models/messageresponse.md)\>**
404
-
405
- ### Errors
406
-
407
- | Error Type | Status Code | Content Type |
408
- | ---------------------------- | ---------------------------- | ---------------------------- |
409
- | errors.BadRequestError | 400 | application/json |
410
- | errors.UnauthenticatedError | 401 | application/json |
411
- | errors.ResourceNotFoundError | 404 | application/json |
412
- | errors.TooManyRequestsError | 429 | application/json |
413
- | errors.InternalServerError | 500 | application/json |
414
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
415
-
416
- ## delete
417
-
418
- Delete documents by document IDs or query filter from a collection.
419
-
420
- ### Example Usage
421
-
422
- <!-- UsageSnippet language="typescript" operationID="deleteDocs" method="post" path="/collections/{collectionName}/docs/delete" -->
423
- ```typescript
424
- import { LambdaDB } from "@functional-systems/lambdadb";
425
-
426
- const lambdaDB = new LambdaDB({
427
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
428
- });
429
-
430
- async function run() {
431
- const result = await lambdaDB.collections.docs.delete({
432
- collectionName: "<value>",
433
- requestBody: {
434
- ids: [
435
- "example-doc-id-1",
436
- "example-doc-id-2",
437
- ],
438
- },
439
- });
440
-
441
- console.log(result);
442
- }
443
-
444
- run();
445
- ```
446
-
447
- ### Standalone function
448
-
449
- The standalone function version of this method:
450
-
451
- ```typescript
452
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
453
- import { collectionsDocsDelete } from "@functional-systems/lambdadb/funcs/collectionsDocsDelete.js";
454
-
455
- // Use `LambdaDBCore` for best tree-shaking performance.
456
- // You can create one instance of it to use across an application.
457
- const lambdaDB = new LambdaDBCore({
458
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
459
- });
460
-
461
- async function run() {
462
- const res = await collectionsDocsDelete(lambdaDB, {
463
- collectionName: "<value>",
464
- requestBody: {
465
- ids: [
466
- "example-doc-id-1",
467
- "example-doc-id-2",
468
- ],
469
- },
470
- });
471
- if (res.ok) {
472
- const { value: result } = res;
473
- console.log(result);
474
- } else {
475
- console.log("collectionsDocsDelete failed:", res.error);
476
- }
477
- }
478
-
479
- run();
480
- ```
481
-
482
- ### Parameters
483
-
484
- | Parameter | Type | Required | Description |
485
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
486
- | `request` | [operations.DeleteDocsRequest](../../models/operations/deletedocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
487
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
488
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
489
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
490
-
491
- ### Response
492
-
493
- **Promise\<[models.MessageResponse](../../models/messageresponse.md)\>**
494
-
495
- ### Errors
496
-
497
- | Error Type | Status Code | Content Type |
498
- | ---------------------------- | ---------------------------- | ---------------------------- |
499
- | errors.BadRequestError | 400 | application/json |
500
- | errors.UnauthenticatedError | 401 | application/json |
501
- | errors.ResourceNotFoundError | 404 | application/json |
502
- | errors.TooManyRequestsError | 429 | application/json |
503
- | errors.InternalServerError | 500 | application/json |
504
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
505
-
506
- ## fetch
507
-
508
- Lookup and return documents by document IDs from a collection.
509
-
510
- ### Example Usage
511
-
512
- <!-- UsageSnippet language="typescript" operationID="fetchDocs" method="post" path="/collections/{collectionName}/docs/fetch" -->
513
- ```typescript
514
- import { LambdaDB } from "@functional-systems/lambdadb";
515
-
516
- const lambdaDB = new LambdaDB({
517
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
518
- });
519
-
520
- async function run() {
521
- const result = await lambdaDB.collections.docs.fetch({
522
- collectionName: "<value>",
523
- requestBody: {
524
- ids: [
525
- "example-doc-id-1",
526
- "example-doc-id-2",
527
- ],
528
- },
529
- });
530
-
531
- console.log(result);
532
- }
533
-
534
- run();
535
- ```
536
-
537
- ### Standalone function
538
-
539
- The standalone function version of this method:
540
-
541
- ```typescript
542
- import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
543
- import { collectionsDocsFetch } from "@functional-systems/lambdadb/funcs/collectionsDocsFetch.js";
544
-
545
- // Use `LambdaDBCore` for best tree-shaking performance.
546
- // You can create one instance of it to use across an application.
547
- const lambdaDB = new LambdaDBCore({
548
- projectApiKey: "<YOUR_PROJECT_API_KEY>",
549
- });
550
-
551
- async function run() {
552
- const res = await collectionsDocsFetch(lambdaDB, {
553
- collectionName: "<value>",
554
- requestBody: {
555
- ids: [
556
- "example-doc-id-1",
557
- "example-doc-id-2",
558
- ],
559
- },
560
- });
561
- if (res.ok) {
562
- const { value: result } = res;
563
- console.log(result);
564
- } else {
565
- console.log("collectionsDocsFetch failed:", res.error);
566
- }
567
- }
568
-
569
- run();
570
- ```
571
-
572
- ### Parameters
573
-
574
- | Parameter | Type | Required | Description |
575
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
576
- | `request` | [operations.FetchDocsRequest](../../models/operations/fetchdocsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
577
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
578
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
579
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
580
-
581
- ### Response
582
-
583
- **Promise\<[operations.FetchDocsResponse](../../models/operations/fetchdocsresponse.md)\>**
584
-
585
- ### Errors
586
-
587
- | Error Type | Status Code | Content Type |
588
- | ---------------------------- | ---------------------------- | ---------------------------- |
589
- | errors.BadRequestError | 400 | application/json |
590
- | errors.UnauthenticatedError | 401 | application/json |
591
- | errors.ResourceNotFoundError | 404 | application/json |
592
- | errors.TooManyRequestsError | 429 | application/json |
593
- | errors.InternalServerError | 500 | application/json |
594
- | errors.LambdaDBDefaultError | 4XX, 5XX | \*/\* |
@@ -1,7 +0,0 @@
1
- # LambdaDB SDK
2
-
3
- ## Overview
4
-
5
- LambdaDB API: LambdaDB Open API Spec
6
-
7
- ### Available Operations
@@ -1,31 +0,0 @@
1
- # @functional-systems/lambdadb Examples
2
-
3
- This directory contains example scripts demonstrating how to use the @functional-systems/lambdadb SDK.
4
-
5
- ## Prerequisites
6
-
7
- - Node.js (v18 or higher)
8
- - npm
9
-
10
- ## Setup
11
-
12
- 1. Copy `.env.template` to `.env`:
13
- ```bash
14
- cp .env.template .env
15
- ```
16
-
17
- 2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
18
-
19
- ## Running the Examples
20
-
21
- To run an example file from the examples directory:
22
-
23
- ```bash
24
- npm run build && npx tsx example.ts
25
- ```
26
-
27
- ## Creating new examples
28
-
29
- Duplicate an existing example file, they won't be overwritten by the generation process.
30
-
31
-