@aravinthan_p/appnest-app-sdk-utils 1.0.8 → 1.0.9

package/appnestFunctions/{appnestFunctions.MD → appnestBackendSdkFunctions.MD}

@@ -1,17 +1,17 @@
-# Appnest SDK Functions — Developer Reference
+# Appnest Backend SDK Functions — Developer Reference
 
 This document is the **single source of truth** for the Appnest custom SDK functions. Use it for **code generation**, auto-completion, and integration in your app.
 
-**For code generation:** This file is self-contained. All function signatures, parameters, types, and constraints are below; no other MD files are required to generate code that calls these SDK functions.
+**For AI code generation:** (1) This file is self-contained; all function signatures, parameters, return shapes, and constraints are below. (2) **Import pattern:** The package exports `AppnestFunctions` and `ResultData` only. Always use: `const { AppnestFunctions } = require('@aravinthan_p/appnest-app-sdk-utils'); const { $db, $http, $file, $next, $schedule, getTraceId } = AppnestFunctions;` (destructure only the modules you need). Do not use `const { $db } = require('@aravinthan_p/appnest-app-sdk-utils')` — that is incorrect.
 
-**Do not add `@aravinthan_p/appnest-app-sdk-utils` (or `appnest-app-sdk-utils`) to `app-backend/package.json`.** The SDK is provided by the AppNest platform at runtime. Your backend code should `require('@aravinthan_p/appnest-app-sdk-utils')` (or the package name configured by the platform) without listing it as a dependency.
+**Do not add `@aravinthan_p/appnest-app-sdk-utils` (or `@aravinthan_p/appnest-app-sdk-utils`) to `app-backend/package.json`.** The SDK is provided by the AppNest platform at runtime. Your backend code should `require('@aravinthan_p/appnest-app-sdk-utils')` (or the package name configured by the platform) without listing it as a dependency.
 
 ---
 
 ## Import
 
 ```javascript
-const { AppnestFunctions } = require('appnest-app-sdk-utils');
+const { AppnestFunctions } = require('@aravinthan_p/appnest-app-sdk-utils');
 // or from path:
 // const { AppnestFunctions } = require('<path-to-sdk>/appnestFunctions');
 
@@ -33,23 +33,28 @@ const { $db, $file, $http, $next, $schedule, getTraceId } = AppnestFunctions;
 
 ---
 
-## Module details (per-function docs)
+## Module summary
 
-Each module has a dedicated MD file with full signatures, parameters, and examples. Paths are relative to `appnestFunctions/`:
+Brief overview of each module.
 
-| Module    | Doc file              | Summary |
-|-----------|------------------------|--------|
-| **$db**   | [dbFunction/db.MD](dbFunction/db.MD) | Key/value by type: STRING, NUMBER, LIST, MAP, BOOLEAN. Common param: `key` (string). |
-| **$http** | [httpFunction/http.MD](httpFunction/http.MD) | `$http.request({ url, method, headers, body, query })`. Methods: GET, POST, PUT, DELETE, PATCH. Use `<%=iparams.<key>%>` for manifest params; use `<%=user_oauth.access_token%>` in headers for platform's access_token (e.g. OAuth or API auth); framework replaces at runtime. |
-| **$file** | [fileFunction/file.MD](fileFunction/file.MD) | `getUploadUrl`, `getDownloadUrl`, `delete`, `list`, `exists`. Params: `path`, `visibility` (optional). |
-| **$next** | [nextFunction/next.MD](nextFunction/next.MD) | `$next.run({ functionName, payload, delay })`. Delay in seconds. |
-| **$schedule** | [scheduleFunction/schedule.MD](scheduleFunction/schedule.MD) | Types: ONE_TIME, CRON, RECURRING. `name`, `type`, `data` required; type-specific: `runAt`, `cronExpression`, or `repeat`. |
+| Module      | Summary |
+|-------------|--------|
+| **$db**     | Key/value by type: STRING, NUMBER, LIST, MAP, BOOLEAN. Common param: `key` (string). |
+| **$http**   | `$http.request({ url, method, headers, body, query })`. Methods: GET, POST, PUT, DELETE, PATCH. Use `<%=iparams.<key>%>` for manifest params; use `<%=user_oauth.access_token%>` in headers for platform access_token; framework replaces at runtime. |
+| **$file**   | `getUploadUrl`, `getDownloadUrl`, `delete`, `list`, `exists`. Params: `path`, `visibility` (optional). |
+| **$next**   | `$next.run({ functionName, payload, delay })`. Delay in seconds. |
+| **$schedule** | Types: ONE_TIME, CRON, RECURRING. `name`, `type`, `data` required; type-specific: `runAt`, `cronExpression`, or `repeat`. |
 
 ---
 
 ## Code reference — function signatures & param details
 
-All functions return `Promise<{ data, status }>` unless noted.
+**Return shapes (summary):**  
+- **$db:** Get methods return the value directly (string, number, array, object, boolean). Create/update/delete return nothing (`Promise<void>`).  
+- **$http:** `request` returns `Promise<{ headers, body, status }>`.  
+- **$file:** All methods return the response object directly (e.g. `{ preSignedUrl }`, `{ deleted }`, `{ objects }`, `{ exists }`). No `{ data, status }` wrapper.  
+- **$next:** `run` returns the API response body directly (e.g. `Promise<{ success: boolean }>`).  
+- **$schedule:** All methods return nothing (`Promise<void>`).
 
 ---
 
@@ -60,7 +65,7 @@ All functions return `Promise<{ data, status }>` unless noted.
 | Function | Params | Types / constraints |
 |----------|--------|----------------------|
 | `$db.get({ key })` | key | string |
-| `$db.create({ key })` | key | string |
+| `$db.create({ key, value })` | key, value | key: string; value: string |
 | `$db.update({ key, value })` | key, value | key: string; value: string |
 | `$db.delete({ key })` | key | string |
 | `$db.string.get({ key })` | key | string |
@@ -71,8 +76,8 @@ All functions return `Promise<{ data, status }>` unless noted.
 | `$db.number.create({ key, value })` | key, value | key: string; value: number |
 | `$db.number.update({ key, value })` | key, value | string, number |
 | `$db.number.delete({ key })` | key | string |
-| `$db.number.increment({ key })` | key | string |
-| `$db.number.decrement({ key })` | key | string |
+| `$db.number.increment({ key, value })` | key, value | key: string; value: number (optional, for increment amount) |
+| `$db.number.decrement({ key, value })` | key, value | key: string; value: number (optional, for decrement amount) |
 | `$db.list.get({ key })` | key | string |
 | `$db.list.create({ key, value })` | key, value | key: string; value: array |
 | `$db.list.update({ key, value })` | key, value | string, array |
@@ -95,39 +100,39 @@ All functions return `Promise<{ data, status }>` unless noted.
 
 | Function | Params | Types / constraints |
 |----------|--------|----------------------|
-| `$http.request({ url, query, method, headers, body })` | url, query, method, headers, body | **url** (string, required): must start with `http://` or `https://`, max 2048 chars. **method** (string, required): `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH`. **headers** (object, required): string key/value, max 1000 keys, each value max 1000 chars. **body** (object, required): same. **query** (object, required): same. **Runtime replacement:** Use `<%=iparams.<key>%>` for manifest params; use `<%=user_oauth.access_token%>` in headers for platform's access_token (e.g. OAuth or API auth); AppNest framework replaces at runtime. See [http.MD](httpFunction/http.MD). |
+| `$http.request({ url, query, method, headers, body })` | url, query, method, headers, body | **url** (string, required). **method** (string, required): `GET` \| `POST` \| `PUT` \| `DELETE` \| `PATCH`. **headers** / **body** / **query** (object, optional, default `{}`). **Return:** `Promise<{ headers, body, status }>`. **Runtime replacement:** Use `<%=iparams.<key>%>` and `<%=user_oauth.access_token%>` in headers. See [http.MD](httpFunction/http.MD). |
 
 ---
 
 ### $file
 
-**Common params:** `path` (string, required), `visibility` (string, optional, default `"PUBLIC"`: `"PUBLIC"` \| `"PRIVATE"`).
+**Common params:** `path` (string, required), `visibility` (string, optional, default `"PUBLIC"`: `"PUBLIC"` \| `"PRIVATE"`). All return the response object directly (no `{ data, status }` wrapper).
 
-| Function | Params | Notes |
+| Function | Params | Return |
 |----------|--------|--------|
-| `$file.getUploadUrl({ path, visibility })` | path, visibility | Signed URL for upload. |
-| `$file.getDownloadUrl({ path, visibility })` | path, visibility | Signed URL for download/read. |
-| `$file.delete({ path, visibility })` | path, visibility | Delete file at path. |
-| `$file.list({ path, visibility })` | path, visibility | List objects under path. |
-| `$file.exists({ path, visibility })` | path, visibility | Check if file exists. |
+| `$file.getUploadUrl({ path, visibility })` | path, visibility | `Promise<{ preSignedUrl: string }>` |
+| `$file.getDownloadUrl({ path, visibility })` | path, visibility | `Promise<{ preSignedUrl: string }>` |
+| `$file.delete({ path, visibility })` | path, visibility | `Promise<{ deleted: boolean }>` |
+| `$file.list({ path, visibility })` | path, visibility | `Promise<{ objects: Array<string> }>` |
+| `$file.exists({ path, visibility })` | path, visibility | `Promise<{ exists: boolean }>` |
 
 ---
 
 ### $next
 
-| Function | Params | Types / constraints |
-|----------|--------|----------------------|
-| `$next.run({ functionName, payload, delay })` | functionName, payload, delay | **functionName** (string, required). **payload** (object, required). **delay** (number, optional, default 0): seconds before execution, >= 0. |
+| Function | Params | Types / constraints | Return |
+|----------|--------|----------------------|--------|
+| `$next.run({ functionName, payload, delay })` | functionName, payload, delay | **functionName** (string, required). **payload** (object, required). **delay** (number, optional, default 0): seconds, >= 0. | `Promise<object>` (API response body, e.g. `{ success: boolean }`) |
 
 ---
 
 ### $schedule
 
-**Common for create/update:** `name` (string, required, max 30), `type` (string, required: `ONE_TIME` \| `CRON` \| `RECURRING`), `data` (object, required, at least one key).
+**Common for create/update:** `name` (string, required, max 30), `type` (string, required: `ONE_TIME` \| `CRON` \| `RECURRING`), `data` (object, required, at least one key). All schedule methods return `Promise<void>`.
 
 | Function | Params | Types / constraints |
 |----------|--------|----------------------|
-| `$schedule.create({ name, type, data, runAt? \| cronExpression? \| repeat? })` | name, type, data + type-specific | **ONE_TIME:** `runAt` (string, required, valid date e.g. ISO 8601). **CRON:** `cronExpression` (string, required). **RECURRING:** `repeat: { frequency, timeUnit }` — frequency (integer >= 1; >= 10 if timeUnit is MINUTES), timeUnit: `MINUTES` \| `HOURS` \| `DAYS` \| `WEEKS` \| `MONTHS` \| `YEARS`. |
+| `$schedule.create({ name, type, data, runAt? \| cronExpression? \| repeat? })` | name, type, data + type-specific | **ONE_TIME:** `runAt` (string, required). **CRON:** `cronExpression` (string, required). **RECURRING:** `repeat: { frequency, timeUnit }` — frequency (integer >= 1; >= 10 if timeUnit is MINUTES), timeUnit: `MINUTES` \| `HOURS` \| `DAYS` \| `WEEKS` \| `MONTHS` \| `YEARS`. |
 | `$schedule.get({ name, type })` | name, type | name: string; type: ONE_TIME \| CRON \| RECURRING |
 | `$schedule.update({ name, type, data, runAt? \| cronExpression? \| repeat? })` | same as create | Same type-specific rules as create. |
 | `$schedule.pause({ name, type })` | name, type | string, string |
@@ -149,15 +154,15 @@ All functions return `Promise<{ data, status }>` unless noted.
 Typical pattern inside a Lambda or handler:
 
 ```javascript
-const { AppnestFunctions } = require('appnest-app-sdk-utils');
+const { AppnestFunctions } = require('@aravinthan_p/appnest-app-sdk-utils');
 const { $db, $http, $file, $next, $schedule, getTraceId } = AppnestFunctions;
 
 exports.myHandler = async (event, context) => {
   const traceId = getTraceId();
   // Use $db, $http, $file, $next, $schedule as needed
-  const row = await $db.string.get({ key: 'config' });
-  await $http.request({ url: 'https://api.example.com', method: 'GET', headers: {}, body: {}, query: {} });
-  await $next.run({ functionName: 'otherFn', payload: { id: 1 }, delay: 0 });
+  const row = await $db.string.get({ key: 'config' }); // row is the string value
+  const res = await $http.request({ url: 'https://api.example.com', method: 'GET', headers: {}, body: {}, query: {} }); // res === { headers, body, status }
+  const nextResult = await $next.run({ functionName: 'otherFn', payload: { id: 1 }, delay: 0 }); // nextResult is the API response body
 };
 ```
 

package/appnestFunctions/appnestClientFunctions.MD

@@ -0,0 +1,98 @@
+# Appnest Client SDK — Invoke Backend Function
+
+This document describes the **client-side** function used to invoke a backend (server) function by name. Use it for **code generation**, auto-completion, and integration in your app’s frontend or client code.
+
+**For AI code generation:** This is the **client** API. Use `appBackendInvoke` when the client (e.g. browser, mobile app) needs to call a named backend function. For **backend** SDK functions (`$db`, `$http`, `$file`, `$next`, `$schedule`), see [appnestBackendSdkFunctions.MD](appnestBackendSdkFunctions.MD).
+
+---
+
+## Import / usage
+
+`appBackendInvoke` is provided by the Appnest client SDK. The exact import path depends on your project (e.g. from the platform’s client bundle or a local wrapper). Ensure `makeSparrowAppsApiRequest`, `createUUID`, `appId`, and `appVersionId` are available in scope (typically injected by the platform or your client setup).
+
+```javascript
+// Example: after client SDK is loaded
+const result = await appBackendInvoke({
+  apiFunctionName: 'myBackendHandler',
+  payload: { userId: 123, action: 'sync' }
+});
+```
+
+---
+
+## API
+
+### appBackendInvoke
+
+Invokes a backend function by name. Sends a POST request to the platform’s backend-invoke endpoint with the given function name and payload. The client context (`appId`, `appVersionId`, `traceId`) is added automatically.
+
+| Item | Description |
+|------|--------------|
+| **Signature** | `appBackendInvoke({ apiFunctionName, payload, options })` |
+| **Return** | `Promise<any>` — the **parsed JSON body** of the backend response. Not `{ data, status }`; the response body is parsed and returned directly. |
+| **Throws** | Rethrows if the request fails or response is not valid JSON. |
+
+---
+
+## Parameters
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `apiFunctionName` | string | yes | — | Name of the backend function to invoke (e.g. the server method/handler name). |
+| `payload` | object | yes | — | Data to send to the backend function. Must be serializable (e.g. plain object, array). |
+| `options` | object | no | `{}` | Optional extra options (reserved for future use). |
+
+**Request:** The function sends a POST to `/v2/api/sparrow-apps/backend-invoke` with a body that includes `serverMethod` (same as `apiFunctionName`), `payload`, `appVersionId`, `appId`, and `traceId` (from `createUUID()`). The actual HTTP call is made via `makeSparrowAppsApiRequest`.
+
+---
+
+## Return value
+
+- **Success:** The **parsed JSON** of `response.body` is returned. Type is `any` (object, array, or primitive depending on what the backend returns).
+- **Failure:** The promise rejects; errors are rethrown (e.g. network error, non-JSON response).
+
+**Do not** assume a wrapper shape like `{ data, status }`. Use the returned value directly as the backend response body.
+
+---
+
+## Examples
+
+**Invoke a backend function with a payload:**
+
+```javascript
+const data = await appBackendInvoke({
+  apiFunctionName: 'getUserSettings',
+  payload: { userId: 'user_123' }
+});
+// data is the parsed response body (e.g. { theme: 'dark', notifications: true })
+```
+
+**Invoke with empty payload:**
+
+```javascript
+const result = await appBackendInvoke({
+  apiFunctionName: 'refreshCache',
+  payload: {}
+});
+```
+
+**With options (for future use):**
+
+```javascript
+const result = await appBackendInvoke({
+  apiFunctionName: 'exportData',
+  payload: { format: 'csv' },
+  options: {}
+});
+```
+
+---
+
+## Summary for code generation
+
+| Function | Params | Return |
+|----------|--------|--------|
+| `appBackendInvoke({ apiFunctionName, payload, options })` | `apiFunctionName` (string, required), `payload` (object, required), `options` (object, optional, default `{}`) | `Promise<any>` — parsed JSON body of the backend response |
+
+- **Client-only:** Use from frontend/client code to call backend functions by name.
+- **Backend functions** (e.g. `getUserSettings`, `refreshCache`) are implemented on the server and documented in the backend SDK reference.

package/appnestFunctions/dbFunction/db.MD

@@ -7,9 +7,11 @@ The `$db` module provides typed key/value storage operations. Use the namespaced
 ## Import / Usage
 
 ```javascript
-const { $db } = require('<path-to-sdk>/appnestFunctions');
-// or from appnest-app-sdk-utils
-const { $db } = require('appnest-app-sdk-utils');
+const { AppnestFunctions } = require('appnest-app-sdk-utils');
+const { $db } = AppnestFunctions;
+// or from path:
+// const AppnestFunctions = require('<path-to-sdk>/appnestFunctions');
+// const { $db } = AppnestFunctions;
 ```
 
 ---
@@ -20,7 +22,7 @@ const { $db } = require('appnest-app-sdk-utils');
 |----------|--------|----------|--------------------------------------|
 | `key`    | string | yes      | Non-empty, max 1000 characters       |
 
-**Return shape:** `Promise<{ data, status }>`
+**Return shape:** Get methods return the value directly (string, number, array, object, or boolean). Create, update, and delete methods return nothing (`Promise<void>`).
 
 ---
 
@@ -38,17 +40,18 @@ const { $db } = require('appnest-app-sdk-utils');
 
 ## Top-level (string-oriented)
 
-| Method | Signature | Description |
-|--------|-----------|-------------|
-| get    | `$db.get({ key })` | Get value by key (string) |
-| create | `$db.create({ key })` | Create key (string; for full control use `$db.string.create`) |
-| update | `$db.update({ key, value })` | Update string value |
-| delete | `$db.delete({ key })` | Delete by key |
+| Method | Signature | Description | Return |
+|--------|-----------|-------------|--------|
+| get    | `$db.get({ key })` | Get value by key (string) | `Promise<string>` |
+| create | `$db.create({ key, value })` | Create key with string value; for full control use `$db.string.create` | `Promise<void>` |
+| update | `$db.update({ key, value })` | Update string value | `Promise<void>` |
+| delete | `$db.delete({ key })` | Delete by key | `Promise<void>` |
 
 **Example:**
 
 ```javascript
-const result = await $db.get({ key: 'welcome' });
+await $db.create({ key: 'welcome', value: 'hello' });
+const result = await $db.get({ key: 'welcome' }); // result is the string value
 await $db.update({ key: 'welcome', value: 'hello' });
 await $db.delete({ key: 'welcome' });
 ```
@@ -57,12 +60,12 @@ await $db.delete({ key: 'welcome' });
 
 ## $db.string
 
-| Method | Signature | Parameters |
-|--------|-----------|------------|
-| get    | `$db.string.get({ key })` | `key` (string, required) |
-| create | `$db.string.create({ key, value })` | `key`, `value` (string, required) |
-| update | `$db.string.update({ key, value })` | `key`, `value` (string, required) |
-| delete | `$db.string.delete({ key })` | `key` (string, required) |
+| Method | Signature | Parameters | Return |
+|--------|-----------|------------|--------|
+| get    | `$db.string.get({ key })` | `key` (string, required) | `Promise<string>` |
+| create | `$db.string.create({ key, value })` | `key`, `value` (string, required) | `Promise<void>` |
+| update | `$db.string.update({ key, value })` | `key`, `value` (string, required) | `Promise<void>` |
+| delete | `$db.string.delete({ key })` | `key` (string, required) | `Promise<void>` |
 
 **Example:**
 
@@ -77,14 +80,14 @@ await $db.string.delete({ key: 'welcome' });
 
 ## $db.number
 
-| Method    | Signature | Parameters |
-|-----------|-----------|------------|
-| get       | `$db.number.get({ key })` | `key` (string, required) |
-| create    | `$db.number.create({ key, value })` | `key`, `value` (number, required) |
-| update    | `$db.number.update({ key, value })` | `key`, `value` (number, required) |
-| delete    | `$db.number.delete({ key })` | `key` (string, required) |
-| increment | `$db.number.increment({ key })` | `key` (string, required) |
-| decrement | `$db.number.decrement({ key })` | `key` (string, required) |
+| Method    | Signature | Parameters | Return |
+|-----------|-----------|------------|--------|
+| get       | `$db.number.get({ key })` | `key` (string, required) | `Promise<number>` |
+| create    | `$db.number.create({ key, value })` | `key`, `value` (number, required) | `Promise<void>` |
+| update    | `$db.number.update({ key, value })` | `key`, `value` (number, required) | `Promise<void>` |
+| delete    | `$db.number.delete({ key })` | `key` (string, required) | `Promise<void>` |
+| increment | `$db.number.increment({ key, value })` | `key` (string, required), `value` (number, optional) | `Promise<void>` |
+| decrement | `$db.number.decrement({ key, value })` | `key` (string, required), `value` (number, optional) | `Promise<void>` |
 
 **Example:**
 
@@ -100,15 +103,15 @@ await $db.number.delete({ key: 'counter' });
 
 ## $db.list
 
-| Method            | Signature | Parameters |
-|-------------------|-----------|------------|
-| get               | `$db.list.get({ key })` | `key` (string, required) |
-| create            | `$db.list.create({ key, value })` | `key`, `value` (array, required) |
-| update            | `$db.list.update({ key, value })` | `key`, `value` (array, required) |
-| append            | `$db.list.append({ key, value })` | `key`, `value` (array, required) |
-| prepend           | `$db.list.prepend({ key, value })` | `key`, `value` (array, required) |
-| updateItemAtIndex | `$db.list.updateItemAtIndex({ key, value, index })` | `key`, `value` (array), `index` (number, required) |
-| removeItemAtIndex | `$db.list.removeItemAtIndex({ key, index })` | `key`, `index` (number, required) |
+| Method            | Signature | Parameters | Return |
+|-------------------|-----------|------------|--------|
+| get               | `$db.list.get({ key })` | `key` (string, required) | `Promise<array>` |
+| create            | `$db.list.create({ key, value })` | `key`, `value` (array, required) | `Promise<void>` |
+| update            | `$db.list.update({ key, value })` | `key`, `value` (array, required) | `Promise<void>` |
+| append            | `$db.list.append({ key, value })` | `key`, `value` (array, required) | `Promise<void>` |
+| prepend           | `$db.list.prepend({ key, value })` | `key`, `value` (array, required) | `Promise<void>` |
+| updateItemAtIndex | `$db.list.updateItemAtIndex({ key, value, index })` | `key`, `value` (array), `index` (number, required) | `Promise<void>` |
+| removeItemAtIndex | `$db.list.removeItemAtIndex({ key, index })` | `key`, `index` (number, required) | `Promise<void>` |
 
 **Example:**
 
@@ -124,12 +127,12 @@ await $db.delete({ key: 'logs' });
 
 ## $db.map
 
-| Method | Signature | Parameters |
-|--------|-----------|------------|
-| get    | `$db.map.get({ key })` | `key` (string, required) |
-| create | `$db.map.create({ key, value })` | `key`, `value` (object, required, JSON-serializable) |
-| update | `$db.map.update({ key, value })` | `key`, `value` (object, required) |
-| delete | `$db.map.delete({ key })` | `key` (string, required) |
+| Method | Signature | Parameters | Return |
+|--------|-----------|------------|--------|
+| get    | `$db.map.get({ key })` | `key` (string, required) | `Promise<object>` |
+| create | `$db.map.create({ key, value })` | `key`, `value` (object, required, JSON-serializable) | `Promise<void>` |
+| update | `$db.map.update({ key, value })` | `key`, `value` (object, required) | `Promise<void>` |
+| delete | `$db.map.delete({ key })` | `key` (string, required) | `Promise<void>` |
 
 **Example:**
 
@@ -144,12 +147,12 @@ await $db.map.delete({ key: 'profile' });
 
 ## $db.boolean
 
-| Method | Signature | Parameters |
-|--------|-----------|------------|
-| get    | `$db.boolean.get({ key })` | `key` (string, required) |
-| create | `$db.boolean.create({ key, value })` | `key`, `value` (boolean, required) |
-| update | `$db.boolean.update({ key, value })` | `key`, `value` (boolean, required) |
-| delete | `$db.boolean.delete({ key })` | `key` (string, required) |
+| Method | Signature | Parameters | Return |
+|--------|-----------|------------|--------|
+| get    | `$db.boolean.get({ key })` | `key` (string, required) | `Promise<boolean>` |
+| create | `$db.boolean.create({ key, value })` | `key`, `value` (boolean, required) | `Promise<void>` |
+| update | `$db.boolean.update({ key, value })` | `key`, `value` (boolean, required) | `Promise<void>` |
+| delete | `$db.boolean.delete({ key })` | `key` (string, required) | `Promise<void>` |
 
 **Example:**