@functional-systems/lambdadb 0.1.3
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.
- package/.devcontainer/README.md +30 -0
- package/.devcontainer/devcontainer.json +45 -0
- package/FUNCTIONS.md +87 -0
- package/LICENSE +201 -0
- package/README.md +470 -0
- package/RUNTIMES.md +48 -0
- package/dist/commonjs/core.d.ts +10 -0
- package/dist/commonjs/core.d.ts.map +1 -0
- package/dist/commonjs/core.js +17 -0
- package/dist/commonjs/core.js.map +1 -0
- package/dist/commonjs/funcs/collectionsCreate.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsCreate.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsCreate.js +125 -0
- package/dist/commonjs/funcs/collectionsCreate.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDelete.d.ts +16 -0
- package/dist/commonjs/funcs/collectionsDelete.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDelete.js +131 -0
- package/dist/commonjs/funcs/collectionsDelete.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsBulkUpsert.d.ts +16 -0
- package/dist/commonjs/funcs/collectionsDocsBulkUpsert.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsBulkUpsert.js +132 -0
- package/dist/commonjs/funcs/collectionsDocsBulkUpsert.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsDelete.d.ts +16 -0
- package/dist/commonjs/funcs/collectionsDocsDelete.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsDelete.js +132 -0
- package/dist/commonjs/funcs/collectionsDocsDelete.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsFetch.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsDocsFetch.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsFetch.js +131 -0
- package/dist/commonjs/funcs/collectionsDocsFetch.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.js +130 -0
- package/dist/commonjs/funcs/collectionsDocsGetBulkUpsert.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsUpdate.d.ts +16 -0
- package/dist/commonjs/funcs/collectionsDocsUpdate.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsUpdate.js +132 -0
- package/dist/commonjs/funcs/collectionsDocsUpdate.js.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsUpsert.d.ts +16 -0
- package/dist/commonjs/funcs/collectionsDocsUpsert.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsDocsUpsert.js +132 -0
- package/dist/commonjs/funcs/collectionsDocsUpsert.js.map +1 -0
- package/dist/commonjs/funcs/collectionsGet.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsGet.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsGet.js +130 -0
- package/dist/commonjs/funcs/collectionsGet.js.map +1 -0
- package/dist/commonjs/funcs/collectionsList.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsList.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsList.js +115 -0
- package/dist/commonjs/funcs/collectionsList.js.map +1 -0
- package/dist/commonjs/funcs/collectionsQuery.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsQuery.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsQuery.js +131 -0
- package/dist/commonjs/funcs/collectionsQuery.js.map +1 -0
- package/dist/commonjs/funcs/collectionsUpdate.d.ts +15 -0
- package/dist/commonjs/funcs/collectionsUpdate.d.ts.map +1 -0
- package/dist/commonjs/funcs/collectionsUpdate.js +131 -0
- package/dist/commonjs/funcs/collectionsUpdate.js.map +1 -0
- package/dist/commonjs/hooks/hooks.d.ts +25 -0
- package/dist/commonjs/hooks/hooks.d.ts.map +1 -0
- package/dist/commonjs/hooks/hooks.js +86 -0
- package/dist/commonjs/hooks/hooks.js.map +1 -0
- package/dist/commonjs/hooks/index.d.ts +3 -0
- package/dist/commonjs/hooks/index.d.ts.map +1 -0
- package/dist/commonjs/hooks/index.js +22 -0
- package/dist/commonjs/hooks/index.js.map +1 -0
- package/dist/commonjs/hooks/registration.d.ts +3 -0
- package/dist/commonjs/hooks/registration.d.ts.map +1 -0
- package/dist/commonjs/hooks/registration.js +15 -0
- package/dist/commonjs/hooks/registration.js.map +1 -0
- package/dist/commonjs/hooks/types.d.ts +76 -0
- package/dist/commonjs/hooks/types.d.ts.map +1 -0
- package/dist/commonjs/hooks/types.js +6 -0
- package/dist/commonjs/hooks/types.js.map +1 -0
- package/dist/commonjs/index.d.ts +6 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +48 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/lib/base64.d.ts +10 -0
- package/dist/commonjs/lib/base64.d.ts.map +1 -0
- package/dist/commonjs/lib/base64.js +71 -0
- package/dist/commonjs/lib/base64.js.map +1 -0
- package/dist/commonjs/lib/config.d.ts +42 -0
- package/dist/commonjs/lib/config.d.ts.map +1 -0
- package/dist/commonjs/lib/config.js +44 -0
- package/dist/commonjs/lib/config.js.map +1 -0
- package/dist/commonjs/lib/dlv.d.ts +14 -0
- package/dist/commonjs/lib/dlv.d.ts.map +1 -0
- package/dist/commonjs/lib/dlv.js +49 -0
- package/dist/commonjs/lib/dlv.js.map +1 -0
- package/dist/commonjs/lib/encodings.d.ts +52 -0
- package/dist/commonjs/lib/encodings.d.ts.map +1 -0
- package/dist/commonjs/lib/encodings.js +368 -0
- package/dist/commonjs/lib/encodings.js.map +1 -0
- package/dist/commonjs/lib/env.d.ts +15 -0
- package/dist/commonjs/lib/env.d.ts.map +1 -0
- package/dist/commonjs/lib/env.js +65 -0
- package/dist/commonjs/lib/env.js.map +1 -0
- package/dist/commonjs/lib/files.d.ts +13 -0
- package/dist/commonjs/lib/files.d.ts.map +1 -0
- package/dist/commonjs/lib/files.js +77 -0
- package/dist/commonjs/lib/files.js.map +1 -0
- package/dist/commonjs/lib/http.d.ts +67 -0
- package/dist/commonjs/lib/http.d.ts.map +1 -0
- package/dist/commonjs/lib/http.js +217 -0
- package/dist/commonjs/lib/http.js.map +1 -0
- package/dist/commonjs/lib/is-plain-object.d.ts +2 -0
- package/dist/commonjs/lib/is-plain-object.d.ts.map +1 -0
- package/dist/commonjs/lib/is-plain-object.js +41 -0
- package/dist/commonjs/lib/is-plain-object.js.map +1 -0
- package/dist/commonjs/lib/logger.d.ts +6 -0
- package/dist/commonjs/lib/logger.d.ts.map +1 -0
- package/dist/commonjs/lib/logger.js +6 -0
- package/dist/commonjs/lib/logger.js.map +1 -0
- package/dist/commonjs/lib/matchers.d.ts +59 -0
- package/dist/commonjs/lib/matchers.d.ts.map +1 -0
- package/dist/commonjs/lib/matchers.js +222 -0
- package/dist/commonjs/lib/matchers.js.map +1 -0
- package/dist/commonjs/lib/primitives.d.ts +26 -0
- package/dist/commonjs/lib/primitives.d.ts.map +1 -0
- package/dist/commonjs/lib/primitives.js +111 -0
- package/dist/commonjs/lib/primitives.js.map +1 -0
- package/dist/commonjs/lib/retries.d.ts +38 -0
- package/dist/commonjs/lib/retries.d.ts.map +1 -0
- package/dist/commonjs/lib/retries.js +153 -0
- package/dist/commonjs/lib/retries.js.map +1 -0
- package/dist/commonjs/lib/schemas.d.ts +19 -0
- package/dist/commonjs/lib/schemas.d.ts.map +1 -0
- package/dist/commonjs/lib/schemas.js +62 -0
- package/dist/commonjs/lib/schemas.js.map +1 -0
- package/dist/commonjs/lib/sdks.d.ts +63 -0
- package/dist/commonjs/lib/sdks.d.ts.map +1 -0
- package/dist/commonjs/lib/sdks.js +273 -0
- package/dist/commonjs/lib/sdks.js.map +1 -0
- package/dist/commonjs/lib/security.d.ts +83 -0
- package/dist/commonjs/lib/security.d.ts.map +1 -0
- package/dist/commonjs/lib/security.js +144 -0
- package/dist/commonjs/lib/security.js.map +1 -0
- package/dist/commonjs/lib/url.d.ts +5 -0
- package/dist/commonjs/lib/url.d.ts.map +1 -0
- package/dist/commonjs/lib/url.js +25 -0
- package/dist/commonjs/lib/url.js.map +1 -0
- package/dist/commonjs/models/collectionresponse.d.ts +70 -0
- package/dist/commonjs/models/collectionresponse.d.ts.map +1 -0
- package/dist/commonjs/models/collectionresponse.js +85 -0
- package/dist/commonjs/models/collectionresponse.js.map +1 -0
- package/dist/commonjs/models/errors/badrequesterror.d.ts +35 -0
- package/dist/commonjs/models/errors/badrequesterror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/badrequesterror.js +82 -0
- package/dist/commonjs/models/errors/badrequesterror.js.map +1 -0
- package/dist/commonjs/models/errors/httpclienterrors.d.ts +44 -0
- package/dist/commonjs/models/errors/httpclienterrors.d.ts.map +1 -0
- package/dist/commonjs/models/errors/httpclienterrors.js +78 -0
- package/dist/commonjs/models/errors/httpclienterrors.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +11 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -0
- package/dist/commonjs/models/errors/index.js +30 -0
- package/dist/commonjs/models/errors/index.js.map +1 -0
- package/dist/commonjs/models/errors/internalservererror.d.ts +35 -0
- package/dist/commonjs/models/errors/internalservererror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/internalservererror.js +82 -0
- package/dist/commonjs/models/errors/internalservererror.js.map +1 -0
- package/dist/commonjs/models/errors/lambdadbdefaulterror.d.ts +10 -0
- package/dist/commonjs/models/errors/lambdadbdefaulterror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/lambdadbdefaulterror.js +34 -0
- package/dist/commonjs/models/errors/lambdadbdefaulterror.js.map +1 -0
- package/dist/commonjs/models/errors/lambdadberror.d.ts +19 -0
- package/dist/commonjs/models/errors/lambdadberror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/lambdadberror.js +20 -0
- package/dist/commonjs/models/errors/lambdadberror.js.map +1 -0
- package/dist/commonjs/models/errors/resourcealreadyexistserror.d.ts +35 -0
- package/dist/commonjs/models/errors/resourcealreadyexistserror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/resourcealreadyexistserror.js +82 -0
- package/dist/commonjs/models/errors/resourcealreadyexistserror.js.map +1 -0
- package/dist/commonjs/models/errors/resourcenotfounderror.d.ts +35 -0
- package/dist/commonjs/models/errors/resourcenotfounderror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/resourcenotfounderror.js +82 -0
- package/dist/commonjs/models/errors/resourcenotfounderror.js.map +1 -0
- package/dist/commonjs/models/errors/responsevalidationerror.d.ts +26 -0
- package/dist/commonjs/models/errors/responsevalidationerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/responsevalidationerror.js +66 -0
- package/dist/commonjs/models/errors/responsevalidationerror.js.map +1 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts +21 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.js +129 -0
- package/dist/commonjs/models/errors/sdkvalidationerror.js.map +1 -0
- package/dist/commonjs/models/errors/toomanyrequestserror.d.ts +35 -0
- package/dist/commonjs/models/errors/toomanyrequestserror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/toomanyrequestserror.js +82 -0
- package/dist/commonjs/models/errors/toomanyrequestserror.js.map +1 -0
- package/dist/commonjs/models/errors/unauthenticatederror.d.ts +35 -0
- package/dist/commonjs/models/errors/unauthenticatederror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/unauthenticatederror.js +82 -0
- package/dist/commonjs/models/errors/unauthenticatederror.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +6 -0
- package/dist/commonjs/models/index.d.ts.map +1 -0
- package/dist/commonjs/models/index.js +25 -0
- package/dist/commonjs/models/index.js.map +1 -0
- package/dist/commonjs/models/indexconfigsunion.d.ts +321 -0
- package/dist/commonjs/models/indexconfigsunion.d.ts.map +1 -0
- package/dist/commonjs/models/indexconfigsunion.js +318 -0
- package/dist/commonjs/models/indexconfigsunion.js.map +1 -0
- package/dist/commonjs/models/messageresponse.d.ts +29 -0
- package/dist/commonjs/models/messageresponse.d.ts.map +1 -0
- package/dist/commonjs/models/messageresponse.js +69 -0
- package/dist/commonjs/models/messageresponse.js.map +1 -0
- package/dist/commonjs/models/operations/bulkupsertdocs.d.ts +62 -0
- package/dist/commonjs/models/operations/bulkupsertdocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/bulkupsertdocs.js +107 -0
- package/dist/commonjs/models/operations/bulkupsertdocs.js.map +1 -0
- package/dist/commonjs/models/operations/createcollection.d.ts +75 -0
- package/dist/commonjs/models/operations/createcollection.d.ts.map +1 -0
- package/dist/commonjs/models/operations/createcollection.js +107 -0
- package/dist/commonjs/models/operations/createcollection.js.map +1 -0
- package/dist/commonjs/models/operations/deletecollection.d.ts +32 -0
- package/dist/commonjs/models/operations/deletecollection.d.ts.map +1 -0
- package/dist/commonjs/models/operations/deletecollection.js +69 -0
- package/dist/commonjs/models/operations/deletecollection.js.map +1 -0
- package/dist/commonjs/models/operations/deletedocs.d.ts +71 -0
- package/dist/commonjs/models/operations/deletedocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/deletedocs.js +109 -0
- package/dist/commonjs/models/operations/deletedocs.js.map +1 -0
- package/dist/commonjs/models/operations/fetchdocs.d.ts +141 -0
- package/dist/commonjs/models/operations/fetchdocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/fetchdocs.js +171 -0
- package/dist/commonjs/models/operations/fetchdocs.js.map +1 -0
- package/dist/commonjs/models/operations/getbulkupsertdocs.d.ts +140 -0
- package/dist/commonjs/models/operations/getbulkupsertdocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getbulkupsertdocs.js +147 -0
- package/dist/commonjs/models/operations/getbulkupsertdocs.js.map +1 -0
- package/dist/commonjs/models/operations/getcollection.d.ts +61 -0
- package/dist/commonjs/models/operations/getcollection.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getcollection.js +97 -0
- package/dist/commonjs/models/operations/getcollection.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +13 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -0
- package/dist/commonjs/models/operations/index.js +32 -0
- package/dist/commonjs/models/operations/index.js.map +1 -0
- package/dist/commonjs/models/operations/listcollections.d.ts +33 -0
- package/dist/commonjs/models/operations/listcollections.d.ts.map +1 -0
- package/dist/commonjs/models/operations/listcollections.js +70 -0
- package/dist/commonjs/models/operations/listcollections.js.map +1 -0
- package/dist/commonjs/models/operations/querycollection.d.ts +180 -0
- package/dist/commonjs/models/operations/querycollection.d.ts.map +1 -0
- package/dist/commonjs/models/operations/querycollection.js +181 -0
- package/dist/commonjs/models/operations/querycollection.js.map +1 -0
- package/dist/commonjs/models/operations/updatecollection.d.ts +92 -0
- package/dist/commonjs/models/operations/updatecollection.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updatecollection.js +135 -0
- package/dist/commonjs/models/operations/updatecollection.js.map +1 -0
- package/dist/commonjs/models/operations/updatedocs.d.ts +66 -0
- package/dist/commonjs/models/operations/updatedocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/updatedocs.js +107 -0
- package/dist/commonjs/models/operations/updatedocs.js.map +1 -0
- package/dist/commonjs/models/operations/upsertdocs.d.ts +66 -0
- package/dist/commonjs/models/operations/upsertdocs.d.ts.map +1 -0
- package/dist/commonjs/models/operations/upsertdocs.js +107 -0
- package/dist/commonjs/models/operations/upsertdocs.js.map +1 -0
- package/dist/commonjs/models/security.d.ts +29 -0
- package/dist/commonjs/models/security.d.ts.map +1 -0
- package/dist/commonjs/models/security.js +78 -0
- package/dist/commonjs/models/security.js.map +1 -0
- package/dist/commonjs/models/status.d.ts +37 -0
- package/dist/commonjs/models/status.d.ts.map +1 -0
- package/dist/commonjs/models/status.js +65 -0
- package/dist/commonjs/models/status.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/sdk/collections.d.ts +33 -0
- package/dist/commonjs/sdk/collections.d.ts.map +1 -0
- package/dist/commonjs/sdk/collections.js +58 -0
- package/dist/commonjs/sdk/collections.js.map +1 -0
- package/dist/commonjs/sdk/docs.d.ts +30 -0
- package/dist/commonjs/sdk/docs.d.ts.map +1 -0
- package/dist/commonjs/sdk/docs.js +54 -0
- package/dist/commonjs/sdk/docs.js.map +1 -0
- package/dist/commonjs/sdk/index.d.ts +2 -0
- package/dist/commonjs/sdk/index.d.ts.map +1 -0
- package/dist/commonjs/sdk/index.js +21 -0
- package/dist/commonjs/sdk/index.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +7 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -0
- package/dist/commonjs/sdk/sdk.js +15 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -0
- package/dist/commonjs/types/async.d.ts +23 -0
- package/dist/commonjs/types/async.d.ts.map +1 -0
- package/dist/commonjs/types/async.js +44 -0
- package/dist/commonjs/types/async.js.map +1 -0
- package/dist/commonjs/types/blobs.d.ts +4 -0
- package/dist/commonjs/types/blobs.d.ts.map +1 -0
- package/dist/commonjs/types/blobs.js +62 -0
- package/dist/commonjs/types/blobs.js.map +1 -0
- package/dist/commonjs/types/constdatetime.d.ts +3 -0
- package/dist/commonjs/types/constdatetime.d.ts.map +1 -0
- package/dist/commonjs/types/constdatetime.js +46 -0
- package/dist/commonjs/types/constdatetime.js.map +1 -0
- package/dist/commonjs/types/enums.d.ts +12 -0
- package/dist/commonjs/types/enums.d.ts.map +1 -0
- package/dist/commonjs/types/enums.js +10 -0
- package/dist/commonjs/types/enums.js.map +1 -0
- package/dist/commonjs/types/fp.d.ts +31 -0
- package/dist/commonjs/types/fp.d.ts.map +1 -0
- package/dist/commonjs/types/fp.js +37 -0
- package/dist/commonjs/types/fp.js.map +1 -0
- package/dist/commonjs/types/index.d.ts +8 -0
- package/dist/commonjs/types/index.d.ts.map +1 -0
- package/dist/commonjs/types/index.js +16 -0
- package/dist/commonjs/types/index.js.map +1 -0
- package/dist/commonjs/types/operations.d.ts +27 -0
- package/dist/commonjs/types/operations.d.ts.map +1 -0
- package/dist/commonjs/types/operations.js +83 -0
- package/dist/commonjs/types/operations.js.map +1 -0
- package/dist/commonjs/types/rfcdate.d.ts +21 -0
- package/dist/commonjs/types/rfcdate.d.ts.map +1 -0
- package/dist/commonjs/types/rfcdate.js +46 -0
- package/dist/commonjs/types/rfcdate.js.map +1 -0
- package/dist/commonjs/types/streams.d.ts +2 -0
- package/dist/commonjs/types/streams.d.ts.map +1 -0
- package/dist/commonjs/types/streams.js +18 -0
- package/dist/commonjs/types/streams.js.map +1 -0
- package/dist/esm/core.d.ts +10 -0
- package/dist/esm/core.d.ts.map +1 -0
- package/dist/esm/core.js +13 -0
- package/dist/esm/core.js.map +1 -0
- package/dist/esm/funcs/collectionsCreate.d.ts +15 -0
- package/dist/esm/funcs/collectionsCreate.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsCreate.js +89 -0
- package/dist/esm/funcs/collectionsCreate.js.map +1 -0
- package/dist/esm/funcs/collectionsDelete.d.ts +16 -0
- package/dist/esm/funcs/collectionsDelete.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDelete.js +95 -0
- package/dist/esm/funcs/collectionsDelete.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsBulkUpsert.d.ts +16 -0
- package/dist/esm/funcs/collectionsDocsBulkUpsert.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsBulkUpsert.js +96 -0
- package/dist/esm/funcs/collectionsDocsBulkUpsert.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsDelete.d.ts +16 -0
- package/dist/esm/funcs/collectionsDocsDelete.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsDelete.js +96 -0
- package/dist/esm/funcs/collectionsDocsDelete.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsFetch.d.ts +15 -0
- package/dist/esm/funcs/collectionsDocsFetch.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsFetch.js +95 -0
- package/dist/esm/funcs/collectionsDocsFetch.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsGetBulkUpsert.d.ts +15 -0
- package/dist/esm/funcs/collectionsDocsGetBulkUpsert.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsGetBulkUpsert.js +94 -0
- package/dist/esm/funcs/collectionsDocsGetBulkUpsert.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsUpdate.d.ts +16 -0
- package/dist/esm/funcs/collectionsDocsUpdate.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsUpdate.js +96 -0
- package/dist/esm/funcs/collectionsDocsUpdate.js.map +1 -0
- package/dist/esm/funcs/collectionsDocsUpsert.d.ts +16 -0
- package/dist/esm/funcs/collectionsDocsUpsert.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsDocsUpsert.js +96 -0
- package/dist/esm/funcs/collectionsDocsUpsert.js.map +1 -0
- package/dist/esm/funcs/collectionsGet.d.ts +15 -0
- package/dist/esm/funcs/collectionsGet.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsGet.js +94 -0
- package/dist/esm/funcs/collectionsGet.js.map +1 -0
- package/dist/esm/funcs/collectionsList.d.ts +15 -0
- package/dist/esm/funcs/collectionsList.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsList.js +79 -0
- package/dist/esm/funcs/collectionsList.js.map +1 -0
- package/dist/esm/funcs/collectionsQuery.d.ts +15 -0
- package/dist/esm/funcs/collectionsQuery.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsQuery.js +95 -0
- package/dist/esm/funcs/collectionsQuery.js.map +1 -0
- package/dist/esm/funcs/collectionsUpdate.d.ts +15 -0
- package/dist/esm/funcs/collectionsUpdate.d.ts.map +1 -0
- package/dist/esm/funcs/collectionsUpdate.js +95 -0
- package/dist/esm/funcs/collectionsUpdate.js.map +1 -0
- package/dist/esm/hooks/hooks.d.ts +25 -0
- package/dist/esm/hooks/hooks.d.ts.map +1 -0
- package/dist/esm/hooks/hooks.js +82 -0
- package/dist/esm/hooks/hooks.js.map +1 -0
- package/dist/esm/hooks/index.d.ts +3 -0
- package/dist/esm/hooks/index.d.ts.map +1 -0
- package/dist/esm/hooks/index.js +6 -0
- package/dist/esm/hooks/index.js.map +1 -0
- package/dist/esm/hooks/registration.d.ts +3 -0
- package/dist/esm/hooks/registration.d.ts.map +1 -0
- package/dist/esm/hooks/registration.js +12 -0
- package/dist/esm/hooks/registration.js.map +1 -0
- package/dist/esm/hooks/types.d.ts +76 -0
- package/dist/esm/hooks/types.d.ts.map +1 -0
- package/dist/esm/hooks/types.js +5 -0
- package/dist/esm/hooks/types.js.map +1 -0
- package/dist/esm/index.d.ts +6 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +8 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/lib/base64.d.ts +10 -0
- package/dist/esm/lib/base64.d.ts.map +1 -0
- package/dist/esm/lib/base64.js +29 -0
- package/dist/esm/lib/base64.js.map +1 -0
- package/dist/esm/lib/config.d.ts +42 -0
- package/dist/esm/lib/config.d.ts.map +1 -0
- package/dist/esm/lib/config.js +40 -0
- package/dist/esm/lib/config.js.map +1 -0
- package/dist/esm/lib/dlv.d.ts +14 -0
- package/dist/esm/lib/dlv.d.ts.map +1 -0
- package/dist/esm/lib/dlv.js +46 -0
- package/dist/esm/lib/dlv.js.map +1 -0
- package/dist/esm/lib/encodings.d.ts +52 -0
- package/dist/esm/lib/encodings.d.ts.map +1 -0
- package/dist/esm/lib/encodings.js +354 -0
- package/dist/esm/lib/encodings.js.map +1 -0
- package/dist/esm/lib/env.d.ts +15 -0
- package/dist/esm/lib/env.d.ts.map +1 -0
- package/dist/esm/lib/env.js +27 -0
- package/dist/esm/lib/env.js.map +1 -0
- package/dist/esm/lib/files.d.ts +13 -0
- package/dist/esm/lib/files.d.ts.map +1 -0
- package/dist/esm/lib/files.js +73 -0
- package/dist/esm/lib/files.js.map +1 -0
- package/dist/esm/lib/http.d.ts +67 -0
- package/dist/esm/lib/http.d.ts.map +1 -0
- package/dist/esm/lib/http.js +207 -0
- package/dist/esm/lib/http.js.map +1 -0
- package/dist/esm/lib/is-plain-object.d.ts +2 -0
- package/dist/esm/lib/is-plain-object.d.ts.map +1 -0
- package/dist/esm/lib/is-plain-object.js +38 -0
- package/dist/esm/lib/is-plain-object.js.map +1 -0
- package/dist/esm/lib/logger.d.ts +6 -0
- package/dist/esm/lib/logger.d.ts.map +1 -0
- package/dist/esm/lib/logger.js +5 -0
- package/dist/esm/lib/logger.js.map +1 -0
- package/dist/esm/lib/matchers.d.ts +59 -0
- package/dist/esm/lib/matchers.d.ts.map +1 -0
- package/dist/esm/lib/matchers.js +203 -0
- package/dist/esm/lib/matchers.js.map +1 -0
- package/dist/esm/lib/primitives.d.ts +26 -0
- package/dist/esm/lib/primitives.d.ts.map +1 -0
- package/dist/esm/lib/primitives.js +103 -0
- package/dist/esm/lib/primitives.js.map +1 -0
- package/dist/esm/lib/retries.d.ts +38 -0
- package/dist/esm/lib/retries.d.ts.map +1 -0
- package/dist/esm/lib/retries.js +147 -0
- package/dist/esm/lib/retries.js.map +1 -0
- package/dist/esm/lib/schemas.d.ts +19 -0
- package/dist/esm/lib/schemas.d.ts.map +1 -0
- package/dist/esm/lib/schemas.js +57 -0
- package/dist/esm/lib/schemas.js.map +1 -0
- package/dist/esm/lib/sdks.d.ts +63 -0
- package/dist/esm/lib/sdks.d.ts.map +1 -0
- package/dist/esm/lib/sdks.js +269 -0
- package/dist/esm/lib/sdks.js.map +1 -0
- package/dist/esm/lib/security.d.ts +83 -0
- package/dist/esm/lib/security.d.ts.map +1 -0
- package/dist/esm/lib/security.js +137 -0
- package/dist/esm/lib/security.js.map +1 -0
- package/dist/esm/lib/url.d.ts +5 -0
- package/dist/esm/lib/url.d.ts.map +1 -0
- package/dist/esm/lib/url.js +22 -0
- package/dist/esm/lib/url.js.map +1 -0
- package/dist/esm/models/collectionresponse.d.ts +70 -0
- package/dist/esm/models/collectionresponse.d.ts.map +1 -0
- package/dist/esm/models/collectionresponse.js +47 -0
- package/dist/esm/models/collectionresponse.js.map +1 -0
- package/dist/esm/models/errors/badrequesterror.d.ts +35 -0
- package/dist/esm/models/errors/badrequesterror.d.ts.map +1 -0
- package/dist/esm/models/errors/badrequesterror.js +45 -0
- package/dist/esm/models/errors/badrequesterror.js.map +1 -0
- package/dist/esm/models/errors/httpclienterrors.d.ts +44 -0
- package/dist/esm/models/errors/httpclienterrors.d.ts.map +1 -0
- package/dist/esm/models/errors/httpclienterrors.js +69 -0
- package/dist/esm/models/errors/httpclienterrors.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +11 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -0
- package/dist/esm/models/errors/index.js +14 -0
- package/dist/esm/models/errors/index.js.map +1 -0
- package/dist/esm/models/errors/internalservererror.d.ts +35 -0
- package/dist/esm/models/errors/internalservererror.d.ts.map +1 -0
- package/dist/esm/models/errors/internalservererror.js +45 -0
- package/dist/esm/models/errors/internalservererror.js.map +1 -0
- package/dist/esm/models/errors/lambdadbdefaulterror.d.ts +10 -0
- package/dist/esm/models/errors/lambdadbdefaulterror.d.ts.map +1 -0
- package/dist/esm/models/errors/lambdadbdefaulterror.js +30 -0
- package/dist/esm/models/errors/lambdadbdefaulterror.js.map +1 -0
- package/dist/esm/models/errors/lambdadberror.d.ts +19 -0
- package/dist/esm/models/errors/lambdadberror.d.ts.map +1 -0
- package/dist/esm/models/errors/lambdadberror.js +16 -0
- package/dist/esm/models/errors/lambdadberror.js.map +1 -0
- package/dist/esm/models/errors/resourcealreadyexistserror.d.ts +35 -0
- package/dist/esm/models/errors/resourcealreadyexistserror.d.ts.map +1 -0
- package/dist/esm/models/errors/resourcealreadyexistserror.js +45 -0
- package/dist/esm/models/errors/resourcealreadyexistserror.js.map +1 -0
- package/dist/esm/models/errors/resourcenotfounderror.d.ts +35 -0
- package/dist/esm/models/errors/resourcenotfounderror.d.ts.map +1 -0
- package/dist/esm/models/errors/resourcenotfounderror.js +45 -0
- package/dist/esm/models/errors/resourcenotfounderror.js.map +1 -0
- package/dist/esm/models/errors/responsevalidationerror.d.ts +26 -0
- package/dist/esm/models/errors/responsevalidationerror.d.ts.map +1 -0
- package/dist/esm/models/errors/responsevalidationerror.js +29 -0
- package/dist/esm/models/errors/responsevalidationerror.js.map +1 -0
- package/dist/esm/models/errors/sdkvalidationerror.d.ts +21 -0
- package/dist/esm/models/errors/sdkvalidationerror.d.ts.map +1 -0
- package/dist/esm/models/errors/sdkvalidationerror.js +91 -0
- package/dist/esm/models/errors/sdkvalidationerror.js.map +1 -0
- package/dist/esm/models/errors/toomanyrequestserror.d.ts +35 -0
- package/dist/esm/models/errors/toomanyrequestserror.d.ts.map +1 -0
- package/dist/esm/models/errors/toomanyrequestserror.js +45 -0
- package/dist/esm/models/errors/toomanyrequestserror.js.map +1 -0
- package/dist/esm/models/errors/unauthenticatederror.d.ts +35 -0
- package/dist/esm/models/errors/unauthenticatederror.d.ts.map +1 -0
- package/dist/esm/models/errors/unauthenticatederror.js +45 -0
- package/dist/esm/models/errors/unauthenticatederror.js.map +1 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.d.ts.map +1 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/esm/models/index.js.map +1 -0
- package/dist/esm/models/indexconfigsunion.d.ts +321 -0
- package/dist/esm/models/indexconfigsunion.d.ts.map +1 -0
- package/dist/esm/models/indexconfigsunion.js +272 -0
- package/dist/esm/models/indexconfigsunion.js.map +1 -0
- package/dist/esm/models/messageresponse.d.ts +29 -0
- package/dist/esm/models/messageresponse.d.ts.map +1 -0
- package/dist/esm/models/messageresponse.js +31 -0
- package/dist/esm/models/messageresponse.js.map +1 -0
- package/dist/esm/models/operations/bulkupsertdocs.d.ts +62 -0
- package/dist/esm/models/operations/bulkupsertdocs.d.ts.map +1 -0
- package/dist/esm/models/operations/bulkupsertdocs.js +67 -0
- package/dist/esm/models/operations/bulkupsertdocs.js.map +1 -0
- package/dist/esm/models/operations/createcollection.d.ts +75 -0
- package/dist/esm/models/operations/createcollection.d.ts.map +1 -0
- package/dist/esm/models/operations/createcollection.js +67 -0
- package/dist/esm/models/operations/createcollection.js.map +1 -0
- package/dist/esm/models/operations/deletecollection.d.ts +32 -0
- package/dist/esm/models/operations/deletecollection.d.ts.map +1 -0
- package/dist/esm/models/operations/deletecollection.js +31 -0
- package/dist/esm/models/operations/deletecollection.js.map +1 -0
- package/dist/esm/models/operations/deletedocs.d.ts +71 -0
- package/dist/esm/models/operations/deletedocs.d.ts.map +1 -0
- package/dist/esm/models/operations/deletedocs.js +69 -0
- package/dist/esm/models/operations/deletedocs.js.map +1 -0
- package/dist/esm/models/operations/fetchdocs.d.ts +141 -0
- package/dist/esm/models/operations/fetchdocs.d.ts.map +1 -0
- package/dist/esm/models/operations/fetchdocs.js +127 -0
- package/dist/esm/models/operations/fetchdocs.js.map +1 -0
- package/dist/esm/models/operations/getbulkupsertdocs.d.ts +140 -0
- package/dist/esm/models/operations/getbulkupsertdocs.d.ts.map +1 -0
- package/dist/esm/models/operations/getbulkupsertdocs.js +107 -0
- package/dist/esm/models/operations/getbulkupsertdocs.js.map +1 -0
- package/dist/esm/models/operations/getcollection.d.ts +61 -0
- package/dist/esm/models/operations/getcollection.d.ts.map +1 -0
- package/dist/esm/models/operations/getcollection.js +57 -0
- package/dist/esm/models/operations/getcollection.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +13 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -0
- package/dist/esm/models/operations/index.js +16 -0
- package/dist/esm/models/operations/index.js.map +1 -0
- package/dist/esm/models/operations/listcollections.d.ts +33 -0
- package/dist/esm/models/operations/listcollections.d.ts.map +1 -0
- package/dist/esm/models/operations/listcollections.js +32 -0
- package/dist/esm/models/operations/listcollections.js.map +1 -0
- package/dist/esm/models/operations/querycollection.d.ts +180 -0
- package/dist/esm/models/operations/querycollection.d.ts.map +1 -0
- package/dist/esm/models/operations/querycollection.js +137 -0
- package/dist/esm/models/operations/querycollection.js.map +1 -0
- package/dist/esm/models/operations/updatecollection.d.ts +92 -0
- package/dist/esm/models/operations/updatecollection.d.ts.map +1 -0
- package/dist/esm/models/operations/updatecollection.js +93 -0
- package/dist/esm/models/operations/updatecollection.js.map +1 -0
- package/dist/esm/models/operations/updatedocs.d.ts +66 -0
- package/dist/esm/models/operations/updatedocs.d.ts.map +1 -0
- package/dist/esm/models/operations/updatedocs.js +67 -0
- package/dist/esm/models/operations/updatedocs.js.map +1 -0
- package/dist/esm/models/operations/upsertdocs.d.ts +66 -0
- package/dist/esm/models/operations/upsertdocs.d.ts.map +1 -0
- package/dist/esm/models/operations/upsertdocs.js +67 -0
- package/dist/esm/models/operations/upsertdocs.js.map +1 -0
- package/dist/esm/models/security.d.ts +29 -0
- package/dist/esm/models/security.d.ts.map +1 -0
- package/dist/esm/models/security.js +40 -0
- package/dist/esm/models/security.js.map +1 -0
- package/dist/esm/models/status.d.ts +37 -0
- package/dist/esm/models/status.d.ts.map +1 -0
- package/dist/esm/models/status.js +29 -0
- package/dist/esm/models/status.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk/collections.d.ts +33 -0
- package/dist/esm/sdk/collections.d.ts.map +1 -0
- package/dist/esm/sdk/collections.js +54 -0
- package/dist/esm/sdk/collections.js.map +1 -0
- package/dist/esm/sdk/docs.d.ts +30 -0
- package/dist/esm/sdk/docs.d.ts.map +1 -0
- package/dist/esm/sdk/docs.js +50 -0
- package/dist/esm/sdk/docs.js.map +1 -0
- package/dist/esm/sdk/index.d.ts +2 -0
- package/dist/esm/sdk/index.d.ts.map +1 -0
- package/dist/esm/sdk/index.js +5 -0
- package/dist/esm/sdk/index.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +7 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -0
- package/dist/esm/sdk/sdk.js +11 -0
- package/dist/esm/sdk/sdk.js.map +1 -0
- package/dist/esm/types/async.d.ts +23 -0
- package/dist/esm/types/async.d.ts.map +1 -0
- package/dist/esm/types/async.js +40 -0
- package/dist/esm/types/async.js.map +1 -0
- package/dist/esm/types/blobs.d.ts +4 -0
- package/dist/esm/types/blobs.d.ts.map +1 -0
- package/dist/esm/types/blobs.js +25 -0
- package/dist/esm/types/blobs.js.map +1 -0
- package/dist/esm/types/constdatetime.d.ts +3 -0
- package/dist/esm/types/constdatetime.d.ts.map +1 -0
- package/dist/esm/types/constdatetime.js +10 -0
- package/dist/esm/types/constdatetime.js.map +1 -0
- package/dist/esm/types/enums.d.ts +12 -0
- package/dist/esm/types/enums.d.ts.map +1 -0
- package/dist/esm/types/enums.js +7 -0
- package/dist/esm/types/enums.js.map +1 -0
- package/dist/esm/types/fp.d.ts +31 -0
- package/dist/esm/types/fp.d.ts.map +1 -0
- package/dist/esm/types/fp.js +31 -0
- package/dist/esm/types/fp.js.map +1 -0
- package/dist/esm/types/index.d.ts +8 -0
- package/dist/esm/types/index.d.ts.map +1 -0
- package/dist/esm/types/index.js +8 -0
- package/dist/esm/types/index.js.map +1 -0
- package/dist/esm/types/operations.d.ts +27 -0
- package/dist/esm/types/operations.d.ts.map +1 -0
- package/dist/esm/types/operations.js +77 -0
- package/dist/esm/types/operations.js.map +1 -0
- package/dist/esm/types/rfcdate.d.ts +21 -0
- package/dist/esm/types/rfcdate.d.ts.map +1 -0
- package/dist/esm/types/rfcdate.js +42 -0
- package/dist/esm/types/rfcdate.js.map +1 -0
- package/dist/esm/types/streams.d.ts +2 -0
- package/dist/esm/types/streams.d.ts.map +1 -0
- package/dist/esm/types/streams.js +15 -0
- package/dist/esm/types/streams.js.map +1 -0
- package/docs/sdks/collections/README.md +551 -0
- package/docs/sdks/docs/README.md +594 -0
- package/docs/sdks/lambdadb/README.md +7 -0
- package/examples/README.md +31 -0
- package/examples/collectionsList.example.ts +26 -0
- package/examples/package-lock.json +611 -0
- package/examples/package.json +18 -0
- package/jsr.json +27 -0
- package/package.json +122 -0
- package/src/core.ts +13 -0
- package/src/funcs/collectionsCreate.ts +192 -0
- package/src/funcs/collectionsDelete.ts +195 -0
- package/src/funcs/collectionsDocsBulkUpsert.ts +202 -0
- package/src/funcs/collectionsDocsDelete.ts +202 -0
- package/src/funcs/collectionsDocsFetch.ts +201 -0
- package/src/funcs/collectionsDocsGetBulkUpsert.ts +196 -0
- package/src/funcs/collectionsDocsUpdate.ts +202 -0
- package/src/funcs/collectionsDocsUpsert.ts +202 -0
- package/src/funcs/collectionsGet.ts +194 -0
- package/src/funcs/collectionsList.ts +170 -0
- package/src/funcs/collectionsQuery.ts +199 -0
- package/src/funcs/collectionsUpdate.ts +199 -0
- package/src/hooks/hooks.ts +132 -0
- package/src/hooks/index.ts +6 -0
- package/src/hooks/registration.ts +14 -0
- package/src/hooks/types.ts +107 -0
- package/src/index.ts +9 -0
- package/src/lib/base64.ts +37 -0
- package/src/lib/config.ts +78 -0
- package/src/lib/dlv.ts +53 -0
- package/src/lib/encodings.ts +483 -0
- package/src/lib/env.ts +41 -0
- package/src/lib/files.ts +82 -0
- package/src/lib/http.ts +323 -0
- package/src/lib/is-plain-object.ts +43 -0
- package/src/lib/logger.ts +9 -0
- package/src/lib/matchers.ts +352 -0
- package/src/lib/primitives.ts +150 -0
- package/src/lib/retries.ts +218 -0
- package/src/lib/schemas.ts +91 -0
- package/src/lib/sdks.ts +406 -0
- package/src/lib/security.ts +261 -0
- package/src/lib/url.ts +33 -0
- package/src/models/collectionresponse.ts +126 -0
- package/src/models/errors/badrequesterror.ts +74 -0
- package/src/models/errors/httpclienterrors.ts +62 -0
- package/src/models/errors/index.ts +14 -0
- package/src/models/errors/internalservererror.ts +74 -0
- package/src/models/errors/lambdadbdefaulterror.ts +40 -0
- package/src/models/errors/lambdadberror.ts +35 -0
- package/src/models/errors/resourcealreadyexistserror.ts +74 -0
- package/src/models/errors/resourcenotfounderror.ts +74 -0
- package/src/models/errors/responsevalidationerror.ts +50 -0
- package/src/models/errors/sdkvalidationerror.ts +109 -0
- package/src/models/errors/toomanyrequestserror.ts +74 -0
- package/src/models/errors/unauthenticatederror.ts +74 -0
- package/src/models/index.ts +9 -0
- package/src/models/indexconfigsunion.ts +495 -0
- package/src/models/messageresponse.ts +64 -0
- package/src/models/operations/bulkupsertdocs.ts +143 -0
- package/src/models/operations/createcollection.ts +151 -0
- package/src/models/operations/deletecollection.ts +69 -0
- package/src/models/operations/deletedocs.ts +150 -0
- package/src/models/operations/fetchdocs.ts +290 -0
- package/src/models/operations/getbulkupsertdocs.ts +223 -0
- package/src/models/operations/getcollection.ts +131 -0
- package/src/models/operations/index.ts +16 -0
- package/src/models/operations/listcollections.ts +70 -0
- package/src/models/operations/querycollection.ts +335 -0
- package/src/models/operations/updatecollection.ts +204 -0
- package/src/models/operations/updatedocs.ts +143 -0
- package/src/models/operations/upsertdocs.ts +143 -0
- package/src/models/security.ts +71 -0
- package/src/models/status.ts +38 -0
- package/src/sdk/collections.ts +104 -0
- package/src/sdk/docs.ts +100 -0
- package/src/sdk/index.ts +5 -0
- package/src/sdk/sdk.ts +13 -0
- package/src/types/async.ts +68 -0
- package/src/types/blobs.ts +31 -0
- package/src/types/constdatetime.ts +15 -0
- package/src/types/enums.ts +16 -0
- package/src/types/fp.ts +50 -0
- package/src/types/index.ts +11 -0
- package/src/types/operations.ts +105 -0
- package/src/types/rfcdate.ts +54 -0
- package/src/types/streams.ts +21 -0
- package/tsconfig.json +41 -0
package/README.md
ADDED
|
@@ -0,0 +1,470 @@
|
|
|
1
|
+
# lambdadb
|
|
2
|
+
|
|
3
|
+
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *LambdaDB* API.
|
|
4
|
+
|
|
5
|
+
<div align="left">
|
|
6
|
+
<a href="https://www.speakeasy.com/?utm_source=lambdadb&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
|
|
7
|
+
<a href="https://opensource.org/licenses/MIT">
|
|
8
|
+
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
|
|
9
|
+
</a>
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<!-- Start Summary [summary] -->
|
|
15
|
+
## Summary
|
|
16
|
+
|
|
17
|
+
LambdaDB API: LambdaDB Open API Spec
|
|
18
|
+
<!-- End Summary [summary] -->
|
|
19
|
+
|
|
20
|
+
<!-- Start Table of Contents [toc] -->
|
|
21
|
+
## Table of Contents
|
|
22
|
+
<!-- $toc-max-depth=2 -->
|
|
23
|
+
* [lambdadb](#lambdadb)
|
|
24
|
+
* [SDK Installation](#sdk-installation)
|
|
25
|
+
* [Requirements](#requirements)
|
|
26
|
+
* [SDK Example Usage](#sdk-example-usage)
|
|
27
|
+
* [Authentication](#authentication)
|
|
28
|
+
* [Available Resources and Operations](#available-resources-and-operations)
|
|
29
|
+
* [Standalone functions](#standalone-functions)
|
|
30
|
+
* [Retries](#retries)
|
|
31
|
+
* [Error Handling](#error-handling)
|
|
32
|
+
* [Server Selection](#server-selection)
|
|
33
|
+
* [Custom HTTP Client](#custom-http-client)
|
|
34
|
+
* [Debugging](#debugging)
|
|
35
|
+
* [Development](#development)
|
|
36
|
+
* [Maturity](#maturity)
|
|
37
|
+
* [Contributions](#contributions)
|
|
38
|
+
|
|
39
|
+
<!-- End Table of Contents [toc] -->
|
|
40
|
+
|
|
41
|
+
<!-- Start SDK Installation [installation] -->
|
|
42
|
+
## SDK Installation
|
|
43
|
+
|
|
44
|
+
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
|
45
|
+
|
|
46
|
+
### NPM
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npm add @functional-systems/lambdadb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### PNPM
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pnpm add @functional-systems/lambdadb
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Bun
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
bun add @functional-systems/lambdadb
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Yarn
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
yarn add @functional-systems/lambdadb zod
|
|
68
|
+
|
|
69
|
+
# Note that Yarn does not install peer dependencies automatically. You will need
|
|
70
|
+
# to install zod as shown above.
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
> [!NOTE]
|
|
74
|
+
> This package is published with CommonJS and ES Modules (ESM) support.
|
|
75
|
+
<!-- End SDK Installation [installation] -->
|
|
76
|
+
|
|
77
|
+
<!-- Start Requirements [requirements] -->
|
|
78
|
+
## Requirements
|
|
79
|
+
|
|
80
|
+
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
|
81
|
+
<!-- End Requirements [requirements] -->
|
|
82
|
+
|
|
83
|
+
<!-- Start SDK Example Usage [usage] -->
|
|
84
|
+
## SDK Example Usage
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
90
|
+
|
|
91
|
+
const lambdaDB = new LambdaDB({
|
|
92
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await lambdaDB.collections.list();
|
|
97
|
+
|
|
98
|
+
console.log(result);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
run();
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
<!-- End SDK Example Usage [usage] -->
|
|
105
|
+
|
|
106
|
+
<!-- Start Authentication [security] -->
|
|
107
|
+
## Authentication
|
|
108
|
+
|
|
109
|
+
### Per-Client Security Schemes
|
|
110
|
+
|
|
111
|
+
This SDK supports the following security scheme globally:
|
|
112
|
+
|
|
113
|
+
| Name | Type | Scheme | Environment Variable |
|
|
114
|
+
| --------------- | ------ | ------- | -------------------------- |
|
|
115
|
+
| `projectApiKey` | apiKey | API key | `LAMBDADB_PROJECT_API_KEY` |
|
|
116
|
+
|
|
117
|
+
To authenticate with the API the `projectApiKey` parameter must be set when initializing the SDK client instance. For example:
|
|
118
|
+
```typescript
|
|
119
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
120
|
+
|
|
121
|
+
const lambdaDB = new LambdaDB({
|
|
122
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
async function run() {
|
|
126
|
+
const result = await lambdaDB.collections.list();
|
|
127
|
+
|
|
128
|
+
console.log(result);
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
run();
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
<!-- End Authentication [security] -->
|
|
135
|
+
|
|
136
|
+
<!-- Start Available Resources and Operations [operations] -->
|
|
137
|
+
## Available Resources and Operations
|
|
138
|
+
|
|
139
|
+
<details open>
|
|
140
|
+
<summary>Available methods</summary>
|
|
141
|
+
|
|
142
|
+
### [collections](docs/sdks/collections/README.md)
|
|
143
|
+
|
|
144
|
+
* [list](docs/sdks/collections/README.md#list) - List all collections in an existing project.
|
|
145
|
+
* [create](docs/sdks/collections/README.md#create) - Create a collection.
|
|
146
|
+
* [delete](docs/sdks/collections/README.md#delete) - Delete an existing collection.
|
|
147
|
+
* [get](docs/sdks/collections/README.md#get) - Get metadata of an existing collection.
|
|
148
|
+
* [update](docs/sdks/collections/README.md#update) - Configure a collection.
|
|
149
|
+
* [query](docs/sdks/collections/README.md#query) - Search a collection with a query and return the most similar documents.
|
|
150
|
+
|
|
151
|
+
#### [collections.docs](docs/sdks/docs/README.md)
|
|
152
|
+
|
|
153
|
+
* [upsert](docs/sdks/docs/README.md#upsert) - Upsert documents into a collection. Note that the maximum supported payload size is 6MB.
|
|
154
|
+
* [getBulkUpsert](docs/sdks/docs/README.md#getbulkupsert) - Request required info to upload documents.
|
|
155
|
+
* [bulkUpsert](docs/sdks/docs/README.md#bulkupsert) - Bulk upsert documents into a collection. Note that the maximum supported object size is 200MB.
|
|
156
|
+
* [update](docs/sdks/docs/README.md#update) - Update documents in a collection. Note that the maximum supported payload size is 6MB.
|
|
157
|
+
* [delete](docs/sdks/docs/README.md#delete) - Delete documents by document IDs or query filter from a collection.
|
|
158
|
+
* [fetch](docs/sdks/docs/README.md#fetch) - Lookup and return documents by document IDs from a collection.
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</details>
|
|
162
|
+
<!-- End Available Resources and Operations [operations] -->
|
|
163
|
+
|
|
164
|
+
<!-- Start Standalone functions [standalone-funcs] -->
|
|
165
|
+
## Standalone functions
|
|
166
|
+
|
|
167
|
+
All the methods listed above are available as standalone functions. These
|
|
168
|
+
functions are ideal for use in applications running in the browser, serverless
|
|
169
|
+
runtimes or other environments where application bundle size is a primary
|
|
170
|
+
concern. When using a bundler to build your application, all unused
|
|
171
|
+
functionality will be either excluded from the final bundle or tree-shaken away.
|
|
172
|
+
|
|
173
|
+
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
174
|
+
|
|
175
|
+
<details>
|
|
176
|
+
|
|
177
|
+
<summary>Available standalone functions</summary>
|
|
178
|
+
|
|
179
|
+
- [`collectionsCreate`](docs/sdks/collections/README.md#create) - Create a collection.
|
|
180
|
+
- [`collectionsDelete`](docs/sdks/collections/README.md#delete) - Delete an existing collection.
|
|
181
|
+
- [`collectionsDocsBulkUpsert`](docs/sdks/docs/README.md#bulkupsert) - Bulk upsert documents into a collection. Note that the maximum supported object size is 200MB.
|
|
182
|
+
- [`collectionsDocsDelete`](docs/sdks/docs/README.md#delete) - Delete documents by document IDs or query filter from a collection.
|
|
183
|
+
- [`collectionsDocsFetch`](docs/sdks/docs/README.md#fetch) - Lookup and return documents by document IDs from a collection.
|
|
184
|
+
- [`collectionsDocsGetBulkUpsert`](docs/sdks/docs/README.md#getbulkupsert) - Request required info to upload documents.
|
|
185
|
+
- [`collectionsDocsUpdate`](docs/sdks/docs/README.md#update) - Update documents in a collection. Note that the maximum supported payload size is 6MB.
|
|
186
|
+
- [`collectionsDocsUpsert`](docs/sdks/docs/README.md#upsert) - Upsert documents into a collection. Note that the maximum supported payload size is 6MB.
|
|
187
|
+
- [`collectionsGet`](docs/sdks/collections/README.md#get) - Get metadata of an existing collection.
|
|
188
|
+
- [`collectionsList`](docs/sdks/collections/README.md#list) - List all collections in an existing project.
|
|
189
|
+
- [`collectionsQuery`](docs/sdks/collections/README.md#query) - Search a collection with a query and return the most similar documents.
|
|
190
|
+
- [`collectionsUpdate`](docs/sdks/collections/README.md#update) - Configure a collection.
|
|
191
|
+
|
|
192
|
+
</details>
|
|
193
|
+
<!-- End Standalone functions [standalone-funcs] -->
|
|
194
|
+
|
|
195
|
+
<!-- Start Retries [retries] -->
|
|
196
|
+
## Retries
|
|
197
|
+
|
|
198
|
+
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
|
199
|
+
|
|
200
|
+
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
|
201
|
+
```typescript
|
|
202
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
203
|
+
|
|
204
|
+
const lambdaDB = new LambdaDB({
|
|
205
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
async function run() {
|
|
209
|
+
const result = await lambdaDB.collections.list({
|
|
210
|
+
retries: {
|
|
211
|
+
strategy: "backoff",
|
|
212
|
+
backoff: {
|
|
213
|
+
initialInterval: 1,
|
|
214
|
+
maxInterval: 50,
|
|
215
|
+
exponent: 1.1,
|
|
216
|
+
maxElapsedTime: 100,
|
|
217
|
+
},
|
|
218
|
+
retryConnectionErrors: false,
|
|
219
|
+
},
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
console.log(result);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
run();
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
|
230
|
+
```typescript
|
|
231
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
232
|
+
|
|
233
|
+
const lambdaDB = new LambdaDB({
|
|
234
|
+
retryConfig: {
|
|
235
|
+
strategy: "backoff",
|
|
236
|
+
backoff: {
|
|
237
|
+
initialInterval: 1,
|
|
238
|
+
maxInterval: 50,
|
|
239
|
+
exponent: 1.1,
|
|
240
|
+
maxElapsedTime: 100,
|
|
241
|
+
},
|
|
242
|
+
retryConnectionErrors: false,
|
|
243
|
+
},
|
|
244
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
async function run() {
|
|
248
|
+
const result = await lambdaDB.collections.list();
|
|
249
|
+
|
|
250
|
+
console.log(result);
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
run();
|
|
254
|
+
|
|
255
|
+
```
|
|
256
|
+
<!-- End Retries [retries] -->
|
|
257
|
+
|
|
258
|
+
<!-- Start Error Handling [errors] -->
|
|
259
|
+
## Error Handling
|
|
260
|
+
|
|
261
|
+
[`LambdaDBError`](./src/models/errors/lambdadberror.ts) is the base class for all HTTP error responses. It has the following properties:
|
|
262
|
+
|
|
263
|
+
| Property | Type | Description |
|
|
264
|
+
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
|
265
|
+
| `error.message` | `string` | Error message |
|
|
266
|
+
| `error.statusCode` | `number` | HTTP response status code eg `404` |
|
|
267
|
+
| `error.headers` | `Headers` | HTTP response headers |
|
|
268
|
+
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
|
269
|
+
| `error.rawResponse` | `Response` | Raw HTTP response |
|
|
270
|
+
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
|
271
|
+
|
|
272
|
+
### Example
|
|
273
|
+
```typescript
|
|
274
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
275
|
+
import * as errors from "@functional-systems/lambdadb/models/errors";
|
|
276
|
+
|
|
277
|
+
const lambdaDB = new LambdaDB({
|
|
278
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
async function run() {
|
|
282
|
+
try {
|
|
283
|
+
const result = await lambdaDB.collections.list();
|
|
284
|
+
|
|
285
|
+
console.log(result);
|
|
286
|
+
} catch (error) {
|
|
287
|
+
// The base class for HTTP error responses
|
|
288
|
+
if (error instanceof errors.LambdaDBError) {
|
|
289
|
+
console.log(error.message);
|
|
290
|
+
console.log(error.statusCode);
|
|
291
|
+
console.log(error.body);
|
|
292
|
+
console.log(error.headers);
|
|
293
|
+
|
|
294
|
+
// Depending on the method different errors may be thrown
|
|
295
|
+
if (error instanceof errors.UnauthenticatedError) {
|
|
296
|
+
console.log(error.data$.message); // string
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
run();
|
|
303
|
+
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Error Classes
|
|
307
|
+
**Primary errors:**
|
|
308
|
+
* [`LambdaDBError`](./src/models/errors/lambdadberror.ts): The base class for HTTP error responses.
|
|
309
|
+
* [`UnauthenticatedError`](./src/models/errors/unauthenticatederror.ts): Unauthenticated. Status code `401`.
|
|
310
|
+
* [`TooManyRequestsError`](./src/models/errors/toomanyrequestserror.ts): Too many requests. Status code `429`.
|
|
311
|
+
* [`InternalServerError`](./src/models/errors/internalservererror.ts): Internal server error. Status code `500`.
|
|
312
|
+
* [`ResourceNotFoundError`](./src/models/errors/resourcenotfounderror.ts): Resource not found. Status code `404`. *
|
|
313
|
+
|
|
314
|
+
<details><summary>Less common errors (8)</summary>
|
|
315
|
+
|
|
316
|
+
<br />
|
|
317
|
+
|
|
318
|
+
**Network errors:**
|
|
319
|
+
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
|
|
320
|
+
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
|
|
321
|
+
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
|
|
322
|
+
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
|
323
|
+
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
**Inherit from [`LambdaDBError`](./src/models/errors/lambdadberror.ts)**:
|
|
327
|
+
* [`BadRequestError`](./src/models/errors/badrequesterror.ts): Bad request. Status code `400`. Applicable to 8 of 12 methods.*
|
|
328
|
+
* [`ResourceAlreadyExistsError`](./src/models/errors/resourcealreadyexistserror.ts): Resource already exists. Status code `409`. Applicable to 1 of 12 methods.*
|
|
329
|
+
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
330
|
+
|
|
331
|
+
</details>
|
|
332
|
+
|
|
333
|
+
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
|
334
|
+
<!-- End Error Handling [errors] -->
|
|
335
|
+
|
|
336
|
+
<!-- Start Server Selection [server] -->
|
|
337
|
+
## Server Selection
|
|
338
|
+
|
|
339
|
+
### Server Variables
|
|
340
|
+
|
|
341
|
+
The default server `https://{projectHost}` contains variables and is set to `https://api.lambdadb.com/projects/default` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
|
342
|
+
|
|
343
|
+
| Variable | Parameter | Default | Description |
|
|
344
|
+
| ------------- | --------------------- | ------------------------------------- | -------------------------- |
|
|
345
|
+
| `projectHost` | `projectHost: string` | `"api.lambdadb.com/projects/default"` | The project URL of the API |
|
|
346
|
+
|
|
347
|
+
#### Example
|
|
348
|
+
|
|
349
|
+
```typescript
|
|
350
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
351
|
+
|
|
352
|
+
const lambdaDB = new LambdaDB({
|
|
353
|
+
projectHost: "<value>",
|
|
354
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
355
|
+
});
|
|
356
|
+
|
|
357
|
+
async function run() {
|
|
358
|
+
const result = await lambdaDB.collections.list();
|
|
359
|
+
|
|
360
|
+
console.log(result);
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
run();
|
|
364
|
+
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Override Server URL Per-Client
|
|
368
|
+
|
|
369
|
+
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
|
370
|
+
```typescript
|
|
371
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
372
|
+
|
|
373
|
+
const lambdaDB = new LambdaDB({
|
|
374
|
+
serverURL: "https://api.lambdadb.com/projects/default",
|
|
375
|
+
projectApiKey: "<YOUR_PROJECT_API_KEY>",
|
|
376
|
+
});
|
|
377
|
+
|
|
378
|
+
async function run() {
|
|
379
|
+
const result = await lambdaDB.collections.list();
|
|
380
|
+
|
|
381
|
+
console.log(result);
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
run();
|
|
385
|
+
|
|
386
|
+
```
|
|
387
|
+
<!-- End Server Selection [server] -->
|
|
388
|
+
|
|
389
|
+
<!-- Start Custom HTTP Client [http-client] -->
|
|
390
|
+
## Custom HTTP Client
|
|
391
|
+
|
|
392
|
+
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
|
393
|
+
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
|
394
|
+
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
|
395
|
+
around the request lifecycle that can be used to modify the request or handle
|
|
396
|
+
errors and response.
|
|
397
|
+
|
|
398
|
+
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
|
399
|
+
used to integrate a third-party HTTP client or when writing tests to mock out
|
|
400
|
+
the HTTP client and feed in fixtures.
|
|
401
|
+
|
|
402
|
+
The following example shows how to use the `"beforeRequest"` hook to to add a
|
|
403
|
+
custom header and a timeout to requests and how to use the `"requestError"` hook
|
|
404
|
+
to log errors:
|
|
405
|
+
|
|
406
|
+
```typescript
|
|
407
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
408
|
+
import { HTTPClient } from "@functional-systems/lambdadb/lib/http";
|
|
409
|
+
|
|
410
|
+
const httpClient = new HTTPClient({
|
|
411
|
+
// fetcher takes a function that has the same signature as native `fetch`.
|
|
412
|
+
fetcher: (request) => {
|
|
413
|
+
return fetch(request);
|
|
414
|
+
}
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
httpClient.addHook("beforeRequest", (request) => {
|
|
418
|
+
const nextRequest = new Request(request, {
|
|
419
|
+
signal: request.signal || AbortSignal.timeout(5000)
|
|
420
|
+
});
|
|
421
|
+
|
|
422
|
+
nextRequest.headers.set("x-custom-header", "custom value");
|
|
423
|
+
|
|
424
|
+
return nextRequest;
|
|
425
|
+
});
|
|
426
|
+
|
|
427
|
+
httpClient.addHook("requestError", (error, request) => {
|
|
428
|
+
console.group("Request Error");
|
|
429
|
+
console.log("Reason:", `${error}`);
|
|
430
|
+
console.log("Endpoint:", `${request.method} ${request.url}`);
|
|
431
|
+
console.groupEnd();
|
|
432
|
+
});
|
|
433
|
+
|
|
434
|
+
const sdk = new LambdaDB({ httpClient });
|
|
435
|
+
```
|
|
436
|
+
<!-- End Custom HTTP Client [http-client] -->
|
|
437
|
+
|
|
438
|
+
<!-- Start Debugging [debug] -->
|
|
439
|
+
## Debugging
|
|
440
|
+
|
|
441
|
+
You can setup your SDK to emit debug logs for SDK requests and responses.
|
|
442
|
+
|
|
443
|
+
You can pass a logger that matches `console`'s interface as an SDK option.
|
|
444
|
+
|
|
445
|
+
> [!WARNING]
|
|
446
|
+
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
|
447
|
+
|
|
448
|
+
```typescript
|
|
449
|
+
import { LambdaDB } from "@functional-systems/lambdadb";
|
|
450
|
+
|
|
451
|
+
const sdk = new LambdaDB({ debugLogger: console });
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
You can also enable a default debug logger by setting an environment variable `LAMBDADB_DEBUG` to true.
|
|
455
|
+
<!-- End Debugging [debug] -->
|
|
456
|
+
|
|
457
|
+
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
458
|
+
|
|
459
|
+
# Development
|
|
460
|
+
|
|
461
|
+
## Maturity
|
|
462
|
+
|
|
463
|
+
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
|
464
|
+
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
|
465
|
+
looking for the latest version.
|
|
466
|
+
|
|
467
|
+
## Contributions
|
|
468
|
+
|
|
469
|
+
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
|
|
470
|
+
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
package/RUNTIMES.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Supported JavaScript runtimes
|
|
2
|
+
|
|
3
|
+
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
|
4
|
+
|
|
5
|
+
* [Web Fetch API][web-fetch]
|
|
6
|
+
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
|
7
|
+
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
|
8
|
+
|
|
9
|
+
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
|
10
|
+
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
|
11
|
+
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
|
12
|
+
|
|
13
|
+
Runtime environments that are explicitly supported are:
|
|
14
|
+
|
|
15
|
+
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
|
16
|
+
- Node.js active and maintenance LTS releases
|
|
17
|
+
- Currently, this is v18 and v20
|
|
18
|
+
- Bun v1 and above
|
|
19
|
+
- Deno v1.39
|
|
20
|
+
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
|
21
|
+
|
|
22
|
+
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
|
23
|
+
|
|
24
|
+
## Recommended TypeScript compiler options
|
|
25
|
+
|
|
26
|
+
The following `tsconfig.json` options are recommended for projects using this
|
|
27
|
+
SDK in order to get static type support for features like async iterables,
|
|
28
|
+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
|
29
|
+
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
|
30
|
+
so on):
|
|
31
|
+
|
|
32
|
+
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
|
33
|
+
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
|
34
|
+
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
|
35
|
+
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
|
36
|
+
|
|
37
|
+
```jsonc
|
|
38
|
+
{
|
|
39
|
+
"compilerOptions": {
|
|
40
|
+
"target": "es2020", // or higher
|
|
41
|
+
"lib": ["es2020", "dom", "dom.iterable"],
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
While `target` can be set to older ECMAScript versions, it may result in extra,
|
|
47
|
+
unnecessary compatibility code being generated if you are not targeting old
|
|
48
|
+
runtimes.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ClientSDK } from "./lib/sdks.js";
|
|
2
|
+
/**
|
|
3
|
+
* A minimal client to use when calling standalone SDK functions. Typically, an
|
|
4
|
+
* instance of this class would be instantiated once at the start of an
|
|
5
|
+
* application and passed around through some dependency injection mechanism to
|
|
6
|
+
* parts of an application that need to make SDK calls.
|
|
7
|
+
*/
|
|
8
|
+
export declare class LambdaDBCore extends ClientSDK {
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=core.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,SAAS;CAAG"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.LambdaDBCore = void 0;
|
|
7
|
+
const sdks_js_1 = require("./lib/sdks.js");
|
|
8
|
+
/**
|
|
9
|
+
* A minimal client to use when calling standalone SDK functions. Typically, an
|
|
10
|
+
* instance of this class would be instantiated once at the start of an
|
|
11
|
+
* application and passed around through some dependency injection mechanism to
|
|
12
|
+
* parts of an application that need to make SDK calls.
|
|
13
|
+
*/
|
|
14
|
+
class LambdaDBCore extends sdks_js_1.ClientSDK {
|
|
15
|
+
}
|
|
16
|
+
exports.LambdaDBCore = LambdaDBCore;
|
|
17
|
+
//# sourceMappingURL=core.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,mBAAS;CAAG;AAA9C,oCAA8C"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { LambdaDBCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
4
|
+
import * as errors from "../models/errors/index.js";
|
|
5
|
+
import { LambdaDBError } from "../models/errors/lambdadberror.js";
|
|
6
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
7
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { APIPromise } from "../types/async.js";
|
|
10
|
+
import { Result } from "../types/fp.js";
|
|
11
|
+
/**
|
|
12
|
+
* Create a collection.
|
|
13
|
+
*/
|
|
14
|
+
export declare function collectionsCreate(client: LambdaDBCore, request: operations.CreateCollectionRequest, options?: RequestOptions): APIPromise<Result<operations.CreateCollectionResponse, errors.BadRequestError | errors.UnauthenticatedError | errors.ResourceAlreadyExistsError | errors.TooManyRequestsError | errors.InternalServerError | LambdaDBError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
|
+
//# sourceMappingURL=collectionsCreate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"collectionsCreate.d.ts","sourceRoot":"","sources":["../../../src/funcs/collectionsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,wBAAwB,EACjC,MAAM,CAAC,eAAe,GACtB,MAAM,CAAC,oBAAoB,GAC3B,MAAM,CAAC,0BAA0B,GACjC,MAAM,CAAC,oBAAoB,GAC3B,MAAM,CAAC,mBAAmB,GAC1B,aAAa,GACb,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|