# sealjs

**Repository Path**: fjymj/sealjs

## Basic Information

- **Project Name**: sealjs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-17
- **Last Updated**: 2025-06-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sealjs

JavaScript library for the [Sealax](https://github.com/sealas/sealax) backend.

## User Client

```js
import { userClient } from 'sealjs'

// Request validation token via email
const resp = await userClient.createUserToken(email)

// Create user with email, password and emailed validation token
const user = await userClient.createUser(resp.token, email, pw)

// Request auth token for API requests
let authResp
try {
  authResp = await userClient.authenticate(email, pw)

  if (authResp.tfa) {
    authResp = await userClient.authenticateWithTFA(authResp, 'YUBIKEY_CODE_HERE')
  }
} catch (e) {
  // Handle error
}
```

## Item Channel

```js
import { ItemChannel } from 'sealjs'

const channel = new ItemChannel()

channel.on('all_items', (items) => {
  // Handling all items here!
})

channel.on('add_item', (item) => {
  // Handling single new item
})

channel.on('update_item', (item) => {
  // Handling single updated item
})

channel.on('add_item', (id) => {
  // Handling single deleted item
})

// Connect to backend with authResp from userClient.authenticate
await channel.connect(authResp)

try {
  const result = await channel.create({
    new: 'item'
  })

  // handle new item with id: result.id
} catch (e) {
  console.error('Oh no!', e)
}

try {
  const result = await channel.update(ItemID, {
    updated: 'item'
  })

  // handle updated item
} catch (e) {
  console.error('Oh no!', e)
}

try {
  const result = await channel.delete(ItemID)

  // handle deleted item
} catch (e) {
  console.error('Oh no!', e)
}
```