# enigmabase > EnigmaBase JavaScript SDK Latest version **1.0.1** (published 2022-07-12) · MIT license · 0 weekly downloads ## Install ```sh npm install enigmabase pnpm add enigmabase yarn add enigmabase bun add enigmabase ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2022-07-12 | | First published | 2022-07-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 2 | | Unpacked size | 560.4 KB | | Known vulnerabilities | 0 (+23 in 1 direct dependencies) | | Install scripts | no | | Author | Devs | | Maintainers | devbaze | | Keywords | enigmabase, enigmabase-js, js-sdk, javascript-sdk, enigmabase-sdk | ## Links - npm: https://www.npmjs.com/package/enigmabase - Repository: https://github.com/enigmabase/js-sdk - Homepage: https://github.com/enigmabase/js-sdk#readme - Issues: https://github.com/enigmabase/js-sdk/issues - npm.io page: https://npm.io/package/enigmabase ## Dependencies (2) - [qs](https://npm.io/package/qs.md) ^6.10.1 - [axios](https://npm.io/package/axios.md) ^0.21.1 ## Recent versions - 1.0.1 (latest) — 2022-07-12 - 1.0.0 — 2022-07-12 ## README EnigmaBase JavaScript SDK ====================================================================== Official JavaScript SDK (browser and node) for interacting with the [EnigmaBase API](https://enigmabase.io/docs). - [Installation](#installation) - [Examples](#examples) - [Definitions](#definitions) - [Caveats](#caveats) - [Development](#development) ## Installation #### Node.js (via npm) ```sh npm install enigmabase --save ``` ```js const EnigmaBase = require("enigmabase"); ... ``` _OR if you are using es6 style imports (suitable also for bundlers like rollup and webpack):_ ```js import EnigmaBase from "enigmabase"; ... ``` #### Browser (manually via script tag) ```html ``` _OR if you are using JavaScript modules:_ ```html ``` ## Examples ```js const client = new EnigmaBase('http://localhost:8090'); ... // list and filter "demo" collection records const result = await client.Records.getList("demo", 1, 20, { filter: "status = true && totalComments > 0" }); // authenticate as regular user const userData = await client.Users.authViaEmail("test@example.com", "123456"); // or as admin const adminData = await client.Admins.authViaEmail("test@example.com", "123456"); // and much more... ``` > More detailed API docs and copy-paste examples could be found in the [API documentation for each service](https://enigmabase.io/docs/api-authentication). ## Definitions #### Creating new client instance ```js const client = new EnigmaBase( baseUrl = '/', lang = 'en-US', authStore = LocalAuthStore, httpConfig = {}, ); ``` #### Instance methods > Each instance method returns the `EnigmaBase` instance allowing chaining. | Method | Description | |:----------------------------------|:------------------------------------------------------| | `client.cancelRequest(cancelKey)` | Cancels single request by its cancellation token key. | | `client.cancelAllRequests()` | Cancels all pending requests. | | `client.send(reqConfig = {})` | Sends an api http request. | #### API services > Each service call returns a `Promise` object with the API response. | Resource | Description | |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------| | **[Admins](https://enigmabase.io/docs/api-admins)** | | | 🔓`client.Admins.authViaEmail(email, password, bodyParams = {}, queryParams = {})` | Authenticate an admin account by its email and password and returns a new admin token and admin data. | | 🔐`client.Admins.refresh(bodyParams = {}, queryParams = {})` | Refreshes the current admin authenticated instance and returns a new admin token and admin data. | | 🔓`client.Admins.requestPasswordReset(email, bodyParams = {}, queryParams = {})` | Sends admin password reset request. | | 🔓`client.Admins.confirmPasswordReset(passwordResetToken, password, passwordConfirm, bodyParams = {}, queryParams = {})` | Confirms admin password reset request. | | 🔐`client.Admins.getList(page = 1, perPage = 30, queryParams = {})` | Returns paginated admins list. | | 🔐`client.Admins.getFullList(batchSize = 100, queryParams = {})` | Returns a list with all admins batch fetched at once. | | 🔐`client.Admins.getOne(id, queryParams = {})` | Returns single admin by its id. | | 🔐`client.Admins.create(bodyParams = {}, queryParams = {})` | Creates a new admin. | | 🔐`client.Admins.update(id, bodyParams = {}, queryParams = {})` | Updates an existing admin by its id. | | 🔐`client.Admins.delete(id, bodyParams = {}, queryParams = {})` | Deletes an existing admin by its id. | | **[Users](https://enigmabase.io/docs/api-users)** | | | 🔓`client.Users.listAuthMethods(queryParams = {})` | Returns all available application auth methods. | | 🔓`client.Users.authViaEmail(email, password, bodyParams = {}, queryParams = {})` | Authenticate a user account by its email and password and returns a new user token and user data. | | 🔓`client.Users.authViaOAuth2(clientName, code, codeVerifier, redirectUrl, bodyParams = {}, queryParams = {})` | Authenticate a user via OAuth2 client provider. | | 🔐`client.Users.refresh(bodyParams = {}, queryParams = {})` | Refreshes the current user authenticated instance and returns a new user token and user data. | | 🔓`client.Users.requestPasswordReset(email, bodyParams = {}, queryParams = {})` | Sends user password reset request. | | 🔓`client.Users.confirmPasswordReset(passwordResetToken, password, passwordConfirm, bodyParams = {}, queryParams = {})` | Confirms user password reset request. | | 🔓`client.Users.requestVerification(email, bodyParams = {}, queryParams = {})` | Sends user verification email request. | | 🔓`client.Users.confirmVerification(verificationToken, bodyParams = {}, queryParams = {})` | Confirms user email verification request. | | 🔐`client.Users.requestEmailChange(newEmail, bodyParams = {}, queryParams = {})` | Sends an email change request to the authenticated user. | | 🔓`client.Users.confirmEmailChange(emailChangeToken, password, bodyParams = {}, queryParams = {})` | Confirms user new email address. | | 🔐`client.Users.getList(page = 1, perPage = 30, queryParams = {})` | Returns paginated users list. | | 🔐`client.Users.getFullList(batchSize = 100, queryParams = {})` | Returns a list with all users batch fetched at once. | | 🔐`client.Users.getOne(id, queryParams = {})` | Returns single user by its id. | | 🔐`client.Users.create(bodyParams = {}, queryParams = {})` | Creates a new user. | | 🔐`client.Users.update(id, bodyParams = {}, queryParams = {})` | Updates an existing user by its id. | | 🔐`client.Users.delete(id, bodyParams = {}, queryParams = {})` | Deletes an existing user by its id. | | **[Realtime](https://enigmabase.io/docs/api-realtime)**
_(for node environments you'll have to install an EventSource polyfill beforehand, eg. https://github.com/EventSource/eventsource)_ | | | 🔓`client.Realtime.subscribe(subscription, callback)` | Inits the sse connection (if not already) and register the subscription. | | 🔓`client.Realtime.unsubscribe(subscription = "")` | Unsubscribe from a subscription (if empty - unsubscibe from all registered subscriptions). | | **[Collections](https://enigmabase.io/docs/api-collections)** | | | 🔐`client.Collections.getList(page = 1, perPage = 30, queryParams = {})` | Returns paginated collections list. | | 🔐`client.Collections.getFullList(batchSize = 100, queryParams = {})` | Returns a list with all collections batch fetched at once. | | 🔐`client.Collections.getOne(id, queryParams = {})` | Returns single collection by its id. | | 🔐`client.Collections.create(bodyParams = {}, queryParams = {})` | Creates a new collection. | | 🔐`client.Collections.update(id, bodyParams = {}, queryParams = {})` | Updates an existing collection by its id. | | 🔐`client.Collections.delete(id, bodyParams = {}, queryParams = {})` | Deletes an existing collection by its id. | | **[Records](https://enigmabase.io/docs/api-records)** | | | 🔓`client.Records.getList(collectionIdOrName, page = 1, perPage = 30, queryParams = {})` | Returns paginated records list. | | 🔓`client.Records.getFullList(collectionIdOrName, batchSize = 100, queryParams = {})` | Returns a list with all records batch fetched at once. | | 🔓`client.Records.getOne(collectionIdOrName, id, queryParams = {})` | Returns single record by its id. | | 🔓`client.Records.create(collectionIdOrName, bodyParams = {}, queryParams = {})` | Creates a new record. | | 🔓`client.Records.update(collectionIdOrName, id, bodyParams = {}, queryParams = {})` | Updates an existing record by its id. | | 🔓`client.Records.delete(collectionIdOrName, id, bodyParams = {}, queryParams = {})` | Deletes an existing record by its id. | | **[Logs](https://enigmabase.io/docs/api-logs)** | | | 🔐`client.Logs.getRequestsList(page = 1, perPage = 30, queryParams = {})` | Returns paginated request logs list. | | 🔐`client.Logs.getRequest(id, queryParams = {})` | Returns a single request log by its id. | | 🔐`client.Logs.getRequestsStats(queryParams = {})` | Returns request logs statistics. | | **[Settings](https://enigmabase.io/docs/api-records)** | | | 🔐`client.Settings.getAll(queryParams = {})` | Fetch all available app settings. | | 🔐`client.Settings.update(bodyParams = {}, queryParams = {})` | Bulk updates app settings. | ## Caveats The SDK client auto cancel duplicated pending requests. For example, if you have the following 3 duplicated calls, only the last one will be executed, while the first 2 will be cancelled with error `null`: ```js client.Records.getList("demo", 1, 20) // cancelled client.Records.getList("demo", 1, 20) // cancelled client.Records.getList("demo", 1, 20) // executed ``` To change this behavior, you could make use of 2 special query parameters: - `$autoCancel ` - set it to `false` to disable auto cancellation for this request - `$cancelKey` - set it to a string that will be used as request identifier and based on which pending duplicated requests will be matched (default to `HTTP_METHOD + url`, eg. "get /api/users?page=1") Example: ```js client.Records.getList("demo", 1, 20); // cancelled client.Records.getList("demo", 1, 20); // executed client.Records.getList("demo", 1, 20, { "$autoCancel": false }); // executed client.Records.getList("demo", 1, 20, { "$autoCancel": false }) // executed client.Records.getList("demo", 1, 20, { "$cancelKey": "test" }) // cancelled client.Records.getList("demo", 1, 20, { "$cancelKey": "test" }) // executed ``` To manually cancel pending requests, you could use `client.cancelAllRequests()` or `client.cancelRequest(cancelKey)`. ## Development ```sh # run unit tests npm test # build and minify for production npm run build ``` --- _Source: https://npm.io/package/enigmabase · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._