https://github.com/baqend/js-sdk
Baqend JavaScript SDK and CLI for High-Performance Websites
https://github.com/baqend/js-sdk
baas backend-as-a-service baqend javascript sdk serverless
Last synced: 5 months ago
JSON representation
Baqend JavaScript SDK and CLI for High-Performance Websites
- Host: GitHub
- URL: https://github.com/baqend/js-sdk
- Owner: Baqend
- License: mit
- Created: 2015-02-12T10:38:13.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T13:45:22.000Z (about 1 year ago)
- Last Synced: 2025-05-09T16:02:27.011Z (5 months ago)
- Topics: baas, backend-as-a-service, baqend, javascript, sdk, serverless
- Language: TypeScript
- Homepage: https://www.baqend.com
- Size: 24.4 MB
- Stars: 26
- Watchers: 12
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README-ACTIAN.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Actian BaaS JavaScript SDK
=====================
Actian BaaS JavaScript SDK and CLI for High-Performance Websites
* [Docs](https://www.baqend.com/guide/)
* [CLI help](https://www.baqend.com/guide/topics/cli/)
* [Dashboard](https://dashboard.baqend.com/register/)
CLI
-----
Actian BaaS provides a CLI to easily manage your app. Install it by typing `npm install -g baqend`.
Afterwards you can use the `baqend` command in your terminal.
Setup
-----
To use the Actian BaaS SDK, just include the [baqend.js](//www.baqend.com/js-sdk/latest/baqend.es5.js) or
[baqend.min.js](//www.baqend.com/js-sdk/latest/baqend.es5.js) from the dist folder
at the bottom of your body.
Alternatively you can install the Actian BaaS SDK with npm. Just type `npm install baqend`
Or [download the latest release](https://github.com/Baqend/js-sdk/releases/latest) directly from GitHub.
```html
```
You can use [unpkg.com](https://unpkg.com/) to directly load the dependency into your browser
```html
```
The Actian BaaS SDK provides a global `Baqend` variable by default.
Initialize
----------
Before you can actually use the Actian BaaS SDK, you must link the Actian BaaS SDK to your Baqend Account.
Just call `Baqend.db.connect()` after including the Actian BaaS SDK.
The Actian BaaS SDK connects to your Actian BaaS and initialize the SDK. If the connection was successfully established
the ready callback will be called, and the `db` can be used to load, query and save objects.
```html
import { db } from 'https://unpkg.com/baqend@3/dist/baqend.es2015.min.js';
// connects to your Baqend Accounts example app
db.connect('example');
// Or pass false as a second parameter for an unencrypted connection (not recommended)
db.connect('example', false);
// For custom deployments i.e. the community edition use:
db.connect('https://baqend.example.com/v1');
// waits while the SDK connects to your Baqend
await db.ready();
// work with your Baqend instance
db.User.find()
```
Upgrading from 2.x
-----
There are some steps required to upgrade to the v3 version if you have previously used our v2 release.
We recommend changing your current imports to use the new
[ES2015 module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) structure
of the SDK.
Therefore, you should migrate your code to use the new ES2015 module imports:
```html
import { db, util } from 'https://unpkg.com/baqend@3/dist/baqend.es2015.min.js';
await db.connect('<your-app>');
const result = await db.MyClass.find().resultList();
result.forEach(object => {
...
})
```
You may change some import path. With node 14+ you can't require any specific subpath directly anymore.
Accessing subpackages of the SDK can now be made by importing the submodule and use the modules from it:
```js
import { util, metamodel } from 'baqend';
// generates a random uuid
util.uuid()
```
To enable better tree shaking support we have moved some classes from the util submodule to the new intersection
submodule. The classes can still be accessed through the util module, but a deprecation warning will be logged.
You should change the imports from util to intersection to fix the warning.
```js
import { util, intersection } from 'baqend';
util.Permission() // access via util is deprecated
intersection.Permission() // change it by improting from the new submodule
```
If you have previously relied on the global DB variable, you must expose the global DB variable manually now.
This will provide you with all the exports which were available in the 2.x release of the SDK:
```js
window.DB = Baqend.db;
await DB.connect('<your-app>');
const result = await DB.MyClass.find().resultList();
...
```
We have dropped the cryptojs dependency and have replaced it with a native implementation of node.js / browser APIs.
As a direct result, we have to change the signature of `file.url -> string` to an asynchronous version of it by providing
`file.createURL() -> Promise<string>` as a new method. Accessing the old property `file.url` will throw an exception.
All previously shipped shims are removed from our bundles to make the overall library size smaller.
If you still need to support old Browsers e.g. IE, ensure that you will bundle a `Promise` shim to let the SDK work
properly.
We have improved the typescript support by providing better typings. You may experience some new typescript
errors since the typings are more precise in many cases.
Actian BaaS Real-Time SDK
--------------------
If you want to use real-time queries, you must include [Rx.js](https://github.com/ReactiveX/rxjs) in your project
as well. The realtime components are now core part of v3 release of the SDK and no alternative module must be
used.
The Rx.js module will be loaded as an optional peer dependency from the global Rx variable
or will be required via. `require('rxjs')` call.
If rxjs can't be loaded the realtime components of the SDK will throw an exception.
You can use the unpkg CDN to get all dependencies:
```html
<script type="text/javascript" src="https://unpkg.com/rxjs/bundles/rxjs.umd.min.js">
import { db } from 'https://unpkg.com/baqend@3/dist/baqend.es2015.js';
await db.connect('<your-app>');
const observable = db.MyClass.find().resultStream();
observable.subscribe((result) => {
result.forEach(object => {
...
})
})
```
Usage in Node.js
----------------
The Actian BaaS SDK can also be used in Node.js. Just do an `npm install baqend` and use
`require('baqend')` for old node environments or `import { db } from 'baqend'` in your code.
Up to Node.js v12
```javascript
const { db } = require('baqend');
// connects to your Baqend Accounts example app
db.connect('example');
// waits while the SDK connects to your Baqend
db.ready(function() {
// work with your Baqend
db.User.find()
...
});
```
Node.js v13+
```javascript
import { db } from 'baqend';
// connects to your Baqend Accounts example app
// and waits while the SDK connects to your Baqend
await db.connect('example');
// work with your Baqend
await db.User.find()
...
```
Note: The Actian BaaS Real-Time SDK can be used by just installing Rx.js as well `npm install rxjs`
License
-------
This Actian BaaS SDK is published under the very permissive [MIT license](LICENSE.md)