@adobe-commerce/aio-toolkit 1.1.1 → 1.2.1

package/CHANGELOG.md

@@ -5,6 +5,100 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.1] - 2026-03-31
+
+### ✨ Features
+
+- **feat(abdb): Add `AbdbRepository` — generic CRUD repository for `AbdbCollection`**
+
+  A typed, token-aware repository layer that wraps any `AbdbCollection` and exposes a clean CRUD surface without requiring callers to manage tokens, regions, or raw DB connections per call.
+
+#### `AbdbRepository`
+
+Generic repository class that holds the IMS token and region for its lifetime, auto-stamps `_created_at` / `_updated_at`, and validates every payload against the collection schema before touching the database.
+
+**Single-document operations:**
+
+- `save(payload)` — insert with full schema validation; stamps `_created_at` and `_updated_at`; returns new `_id`
+- `save(payload, id)` — partial update by `_id`; stamps `_updated_at`; only validates fields present in the payload (absent required fields are not re-enforced); returns the same `id`
+- `findOne(filter)` — returns the first document matching an arbitrary filter (e.g. `{ _id: 'x' }` or `{ email: 'a@b.com' }`), or `null`
+- `find(filter?)` — returns all documents matching an optional filter; defaults to all documents
+- `exists(id)` — lightweight existence check via `countDocuments`; returns `boolean`
+- `delete(id)` — deletes by `_id`; no-ops silently for empty id
+- `count(filter?)` — counts matching documents; defaults to all documents
+
+**Bulk operations (single DB round-trip each):**
+
+- `insertAll(payloads[])` — bulk insert via `insertMany`; each payload is stamped and fully validated before the DB call; returns array of inserted ids
+- `updateAll(payload, filter?)` — bulk partial update via `updateMany`; stamps `_updated_at`; partial validation on present fields only
+- `deleteAll(filter?)` — bulk delete via `deleteMany`; defaults to all documents
+
+**Accessors:**
+
+- `getName()` — returns the underlying collection name
+- `getCollection()` — returns the underlying `AbdbCollection` instance
+
+#### Automatic timestamp management
+
+The constructor registers `_created_at` and `_updated_at` columns on the collection exactly once — re-using the same collection across multiple repository instances (e.g. different tokens or regions) is safe.
+
+#### Partial update validation
+
+The update path (`save(payload, id)` and `updateAll`) uses `_validatePartial`, which checks only the columns present in the payload. Required columns that are absent are not re-enforced because they already exist in the stored document. This prevents spurious validation failures when doing field-level patches.
+
+### 📖 Documentation
+
+- **`@adobe/aio-lib-db` declared as required peer dependency** — added to the top-level installation command, peer dependencies table, individual install steps, App Builder `npm list` check command, and ERESOLVE upgrade guide in the README
+- **Database provisioning guide added** — declarative `app.config.yaml` provisioning and `aio app db provision` CLI command documented as step 1 of the `AbdbCollection` usage guide
+- **Authentication guide added** — `generateAccessToken` pattern with `include-ims-credentials` annotation documented as step 2; runtime action example updated to use real token generation instead of a placeholder comment
+- **`AbdbRepository` section added to README** — covers basic usage, automatic timestamps, full API reference tables (single-document and bulk operations), custom region, and bulk operation examples
+- **Fixed `RuntimeApiGatewayService` constructor call** in `test/framework/index.test.ts` — was passing 7 arguments copied from `ImsToken`; corrected to the actual 3-argument signature `(namespace, imsOrgId, imsToken)`
+
+## [1.2.0] - 2026-03-30
+
+### ✨ Features
+
+- **feat(abdb): Add `AbdbColumn` and `AbdbCollection` framework components**
+
+  Two new framework components that provide a typed schema definition layer and managed database connectivity via `@adobe/aio-lib-db`.
+
+#### `AbdbColumn`
+
+Immutable field definition class for describing a single column in an ABDB document schema.
+
+- Supports four value types: `STRING`, `NUMBER`, `BOOLEAN`, `DATETIME`
+- Comprehensive type coercion rules — accepts numeric strings, `"true"/"false"` strings, ISO 8601 date strings, finite numeric timestamps, and `Date` objects
+- Required field enforcement via `isRequired` flag
+- `validate(value)` — throws on the first type or requiredness violation
+- `clone(overrides?)` — derives a new immutable instance with overridden fields
+- `toJSON()` — serializes to a plain `AbdbColumnJson` object
+- Fully immutable after construction (`Object.freeze`)
+- Exhaustive `switch` guard via TypeScript `never` — compile-time safety if a new type is added without updating the validator
+
+#### `AbdbCollection`
+
+Named schema container with fluent column registration, validation, and a managed Adobe I/O DB lifecycle.
+
+- `addColumn(name, type, description?, isRequired?)` — **positional form** (backward-compatible short syntax)
+- `addColumn(name, type, options?)` — **options-object form** — no `undefined` placeholder needed to set only `isRequired`
+- `getColumn(name)` — O(1) single-column lookup; returns `undefined` if not found
+- `hasColumn(name)` — O(1) existence check
+- `getColumns()` — defensive copy in insertion order
+- `validate(record)` — fail-fast; throws on the **first** failing column
+- `validateAll(record)` — collects **all** column errors; returns `string[]` — ideal for API error responses
+- `run<T>(callback, token, region?)` — opens `@adobe/aio-lib-db` connection, invokes callback with `(collection, client)`, closes in `finally`
+
+#### Types exported
+
+| Type | Description |
+|---|---|
+| `AbdbColumnType` | String enum: `STRING \| NUMBER \| BOOLEAN \| DATETIME` |
+| `AbdbColumnOptions` | Constructor input shape for `AbdbColumn` |
+| `AbdbColumnJson` | `toJSON()` output shape |
+| `AddColumnOptions` | `Omit<AbdbColumnOptions, 'name' \| 'type'>` — options-object form for `addColumn` |
+| `AbdbCollectionCallback` | Constructor setup callback `(collection: AbdbCollection) => void` |
+| `AbdbRunCallback<T>` | Async work callback for `run()` |
+
 ## [1.1.1] - 2026-03-28
 
 ### 🐛 Bug Fixes

package/README.md

@@ -9,6 +9,7 @@ A comprehensive TypeScript toolkit for Adobe App Builder applications providing
 ```bash
 npm install @adobe-commerce/aio-toolkit \
   @adobe/aio-sdk \
+  @adobe/aio-lib-db \
   @adobe/aio-lib-ims \
   @adobe/aio-lib-telemetry \
   @opentelemetry/resources \
@@ -675,6 +676,275 @@ This approach provides:
 - **Flexible ID management**: Support for explicit IDs, payload IDs, and auto-generation
 - **Automatic sanitization**: IDs are cleaned to ensure file system compatibility
 
+#### `AbdbColumn` & `AbdbCollection`
+
+Typed schema definition and managed database connectivity via `@adobe/aio-lib-db`.
+
+The recommended pattern is to create a dedicated collection class per entity by extending `AbdbCollection`, then use it directly inside runtime actions.
+
+##### 1. Provision a database
+
+A database must be provisioned before any collection can connect. There are two ways to do this:
+
+**Declarative provisioning via `app.config.yaml`** (runs on `aio app deploy`):
+
+```yaml
+application:
+  runtimeManifest:
+    database:
+      auto-provision: true
+      region: emea
+```
+
+When the application is deployed with `aio app deploy`, a database is provisioned in the specified region unless one is already present. Declarative provisioning does **not** run during `aio app run` or `aio app dev`, so the database must be provisioned manually for local development (see below).
+
+**Manual provisioning via the AIO CLI:**
+
+```bash
+aio app db provision [--region <area>]
+```
+
+##### 2. Configure authentication
+
+Every `@adobe/aio-lib-db` call requires an IMS access token. The recommended approach is to use `@adobe/aio-sdk`, which handles token caching and refresh automatically:
+
+```javascript
+const { generateAccessToken } = require('@adobe/aio-sdk').Core.AuthClient;
+const libDb = require('@adobe/aio-lib-db');
+
+async function main(params) {
+  const token = await generateAccessToken(params);
+  const db = await libDb.init({ token: token.access_token });
+}
+```
+
+**Requirements:**
+
+- The AIO project workspace must include the **App Builder Data Services API**.
+- The runtime action must have the `include-ims-credentials` annotation set to `true` in `app.config.yaml`:
+
+```yaml
+actions:
+  action:
+    function: actions/generic/action.js
+    annotations:
+      include-ims-credentials: true
+```
+
+> `@adobe/aio-sdk` transparently manages token caching and refresh — you do not need to implement this yourself.
+
+##### 3. Define a custom collection
+
+Create a reusable collection class that declares the schema once:
+
+```javascript
+// src/collections/UserCollection.js
+'use strict';
+
+const { AbdbCollection, AbdbColumnType } = require('@adobe-commerce/aio-toolkit');
+
+/**
+ * ABDB collection for the `users` table.
+ *
+ * Columns:
+ * - `first_name` (STRING, required)
+ * - `last_name`  (STRING, required)
+ * - `email`      (STRING, required)
+ */
+class UserCollection extends AbdbCollection {
+  constructor() {
+    super('users', (c) => {
+      c.addColumn('first_name', AbdbColumnType.STRING, 'First name', true)
+       .addColumn('last_name',  AbdbColumnType.STRING, 'Last name',  true)
+       .addColumn('email',      AbdbColumnType.STRING, 'Email address', true);
+    });
+  }
+}
+
+module.exports = UserCollection;
+```
+
+##### 4. Use it in a runtime action
+
+```javascript
+const { HttpMethod, RuntimeAction, RuntimeActionResponse } = require('@adobe-commerce/aio-toolkit');
+const { generateAccessToken } = require('@adobe/aio-sdk').Core.AuthClient;
+const UserCollection = require('@lib/UserCollection');
+
+exports.main = RuntimeAction.execute(
+  'users-create',
+  [HttpMethod.POST],
+  ['first_name', 'last_name', 'email'],
+  ['Authorization'],
+  async (params, ctx) => {
+    const { first_name, last_name, email } = params;
+    const { logger } = ctx;
+
+    const token = await generateAccessToken(params);
+    const accessToken = token.access_token;
+
+    const users = new UserCollection();
+
+    // Fail-fast validation — throws before touching the DB
+    users.validate({ first_name, last_name, email });
+
+    // Open DB connection, run the operation, close in finally
+    const result = await users.run(async (collection) => {
+      return await collection.insertOne({ first_name, last_name, email });
+    }, accessToken);
+
+    logger.info(`User inserted: ${result.insertedId}`);
+
+    return RuntimeActionResponse.success(result);
+  }
+);
+```
+
+##### 5. API surface reference
+
+**`addColumn` call forms:**
+
+```javascript
+// Positional (short form) — description and isRequired are optional positional args
+c.addColumn('email', AbdbColumnType.STRING, 'Email address', true);
+
+// Options-object form — no undefined placeholder needed when setting only one option
+c.addColumn('email', AbdbColumnType.STRING, { isRequired: true });
+c.addColumn('note',  AbdbColumnType.STRING, { description: 'An optional note' });
+```
+
+**Supported types (`AbdbColumnType`):**
+
+| Value | Accepts |
+|---|---|
+| `STRING` | Primitive string |
+| `NUMBER` | Finite number, or numeric string (e.g. `"3.14"`) |
+| `BOOLEAN` | `true`/`false`, or `"true"`/`"false"` (case-insensitive) |
+| `DATETIME` | `Date`, finite timestamp (ms), or ISO 8601 string |
+
+**Validation strategies:**
+
+```javascript
+// Fail-fast — throws on the first error (use before DB writes)
+users.validate({ first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com' });
+
+// Collect all errors — ideal for API validation responses
+const errors = users.validateAll({ first_name: '', email: 'not-an-email' });
+// errors → ['"first_name" expects a string', '"last_name" is required']
+```
+
+**Column introspection:**
+
+```javascript
+users.hasColumn('email');          // true
+users.getColumn('email');          // AbdbColumn instance (or undefined)
+users.getColumns();                // Map<string, AbdbColumn> in insertion order
+```
+
+#### `AbdbRepository`
+
+A generic CRUD repository that wraps an `AbdbCollection` and holds the IMS token and region for the lifetime of the instance. All write methods validate payloads against the collection schema before touching the database, and `_created_at` / `_updated_at` timestamps are stamped automatically.
+
+##### Basic usage
+
+```javascript
+const { AbdbRepository, AbdbColumnType } = require('@adobe-commerce/aio-toolkit');
+const { generateAccessToken } = require('@adobe/aio-sdk').Core.AuthClient;
+const UserCollection = require('@lib/UserCollection');
+
+exports.main = async (params) => {
+  const token = await generateAccessToken(params);
+  const accessToken = token.access_token;
+
+  const repo = new AbdbRepository(new UserCollection(), accessToken);
+
+  // Insert — returns the new document _id
+  const id = await repo.save({ first_name: 'Jane', last_name: 'Doe', email: 'jane@example.com' });
+
+  // Read one by _id
+  const doc = await repo.findOne({ _id: id });
+
+  // Read one by any field
+  const byEmail = await repo.findOne({ email: 'jane@example.com' });
+
+  // Read all (optional filter)
+  const all    = await repo.find();
+  const active = await repo.find({ active: true });
+
+  // Partial update — only provided fields are validated; required fields already in the DB are not re-checked
+  await repo.save({ first_name: 'Janet' }, id);
+
+  // Delete
+  await repo.delete(id);
+};
+```
+
+##### Automatic timestamps
+
+The repository automatically registers two extra columns on the collection:
+
+| Column | Set on | Value |
+|---|---|---|
+| `_created_at` | First insert only | ISO 8601 UTC string |
+| `_updated_at` | Every insert and update | ISO 8601 UTC string |
+
+These are added once per collection instance, so re-using the same collection across multiple repository instances is safe.
+
+##### API reference
+
+**Single-document operations:**
+
+| Method | Description | Returns |
+|---|---|---|
+| `save(payload)` | Insert a new document (full validation) | `Promise<string>` — new `_id` |
+| `save(payload, id)` | Partial update by `_id` (only present fields validated) | `Promise<string>` — same `id` |
+| `findOne(filter)` | First document matching filter, e.g. `{ _id: 'x' }` | `Promise<T \| null>` |
+| `find(filter?)` | All documents matching filter (default: all) | `Promise<T[]>` |
+| `exists(id)` | Lightweight existence check via `countDocuments` | `Promise<boolean>` |
+| `delete(id)` | Delete document by `_id`; no-ops for empty id | `Promise<void>` |
+| `count(filter?)` | Count matching documents (default: all) | `Promise<number>` |
+
+**Bulk operations (single DB round-trip each):**
+
+| Method | Description | Returns |
+|---|---|---|
+| `insertAll(payloads[])` | Bulk insert via `insertMany` — each payload stamped and validated | `Promise<string[]>` — inserted ids |
+| `updateAll(payload, filter?)` | Bulk partial update via `updateMany` — stamps `_updated_at` | `Promise<void>` |
+| `deleteAll(filter?)` | Bulk delete via `deleteMany` (default: all documents) | `Promise<void>` |
+
+**Accessors:**
+
+| Method | Description |
+|---|---|
+| `getName()` | Returns the underlying collection name |
+| `getCollection()` | Returns the underlying `AbdbCollection` instance |
+
+##### Custom region
+
+```javascript
+// Default region is 'amer'. Pass a third argument to override:
+const repo = new AbdbRepository(new UserCollection(), accessToken, 'emea');
+```
+
+##### Bulk operations
+
+```javascript
+// Insert multiple documents in one DB call
+const ids = await repo.insertAll([
+  { first_name: 'Alice', last_name: 'Smith', email: 'alice@example.com' },
+  { first_name: 'Bob',   last_name: 'Jones', email: 'bob@example.com'   },
+]);
+
+// Update all matching documents in one DB call
+await repo.updateAll({ active: false }, { email: 'bob@example.com' });
+
+// Delete all matching documents in one DB call
+await repo.deleteAll({ active: false });
+
+// Delete everything in the collection
+await repo.deleteAll();
+```
+
 ### 🏪 Commerce Components  
 
 **Adobe Commerce API integration and authentication**
@@ -1780,12 +2050,13 @@ Packages that maintain **singleton state or shared registries** — if two copie
 | Package | Why it must be shared |
 |---|---|
 | `@adobe/aio-sdk` | Singleton services — logger, config, state are shared across the app |
+| `@adobe/aio-lib-db` | Database client singleton — connection state and collection registry must be shared |
 | `graphql` | Schema registry is a singleton — `instanceof GraphQLSchema` and type checks fail with two copies |
 | `@adobe/aio-lib-ims` | Token cache and auth context must be the same shared instance |
 | `@adobe/aio-lib-telemetry` | Single telemetry pipeline — two copies split traces and logs |
 | `@opentelemetry/resources` | Resource object tied to the telemetry pipeline instance |
 
-All five are **required** — they are unconditionally imported when the package loads (`export * from './framework'` and `export * from './commerce'` in the root `index.ts`). If any is missing, the entire package will fail to load with a `Cannot find module` error.
+All six are **required** — they are unconditionally imported when the package loads (`export * from './framework'` and `export * from './commerce'` in the root `index.ts`). If any is missing, the entire package will fail to load with a `Cannot find module` error.
 
 ### Installing peer dependencies
 
@@ -1794,6 +2065,7 @@ Install the toolkit and all required peer dependencies in one command:
 ```bash
 npm install @adobe-commerce/aio-toolkit \
   @adobe/aio-sdk \
+  @adobe/aio-lib-db \
   @adobe/aio-lib-ims \
   @adobe/aio-lib-telemetry \
   @opentelemetry/resources \
@@ -1806,14 +2078,15 @@ Or individually if you prefer to control versions:
 npm install @adobe-commerce/aio-toolkit
 
 # Required peer dependencies
-npm install @adobe/aio-sdk@^5.0.0
+npm install @adobe/aio-sdk@^6.0.0
+npm install @adobe/aio-lib-db@^1.0.0
 npm install @adobe/aio-lib-ims@^7.0.0
 npm install @adobe/aio-lib-telemetry@^1.0.0
 npm install @opentelemetry/resources@^2.0.0
 npm install graphql@^16.0.0
 ```
 
-> **Note for App Builder projects:** `@adobe/aio-sdk`, `graphql`, and `@adobe/aio-lib-ims` are almost always already present in a standard App Builder project. Run `npm list @adobe/aio-sdk graphql @adobe/aio-lib-ims` to check before installing.
+> **Note for App Builder projects:** `@adobe/aio-sdk`, `graphql`, and `@adobe/aio-lib-ims` are almost always already present in a standard App Builder project. Run `npm list @adobe/aio-sdk @adobe/aio-lib-db graphql @adobe/aio-lib-ims` to check before installing.
 
 ### Resolving `ERESOLVE` errors
 
@@ -1828,9 +2101,12 @@ npm install @adobe-commerce/aio-toolkit 2>&1 | grep "Found:"
 **Upgrade the conflicting package to a compatible version:**
 
 ```bash
-# @adobe/aio-sdk must be >=5.0.0
+# @adobe/aio-sdk must be >=6.0.0
 npm install @adobe/aio-sdk@latest
 
+# @adobe/aio-lib-db must be >=1.0.0
+npm install @adobe/aio-lib-db@latest
+
 # graphql must be >=14.0.0
 npm install graphql@latest
 

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import openwhisk, { Dict, Activation } from 'openwhisk';
+import { DbCollection, DbClient } from '@adobe/aio-lib-db';
 import { EntrypointInstrumentationConfig } from '@adobe/aio-lib-telemetry';
 import { LogRecordProcessor } from '@opentelemetry/sdk-logs';
 import { SdkLogRecord } from '@adobe/aio-lib-telemetry/otel';
@@ -202,6 +203,94 @@ declare class FileRepository {
     private getFiles;
 }
 
+declare enum AbdbColumnType {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    BOOLEAN = "BOOLEAN",
+    DATETIME = "DATETIME"
+}
+interface AbdbColumnOptions {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: boolean;
+}
+interface AbdbColumnJson {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: true;
+}
+
+declare class AbdbColumn {
+    private readonly _name;
+    private readonly _type;
+    private readonly _description;
+    private readonly _isRequired;
+    constructor(options: AbdbColumnOptions);
+    getName(): string;
+    getType(): AbdbColumnType;
+    getDescription(): string | undefined;
+    getIsRequired(): boolean;
+    toJSON(): AbdbColumnJson;
+    clone(overrides?: Partial<AbdbColumnOptions>): AbdbColumn;
+    validate(value: unknown): void;
+    private _isMissingValue;
+    private _validateStringValue;
+    private _validateNumberValue;
+    private _validateBooleanValue;
+    private _validateDateTimeValue;
+}
+
+type AddColumnOptions = Omit<AbdbColumnOptions, 'name' | 'type'>;
+type AbdbRunCallback<T = unknown> = (collection: DbCollection, client: DbClient) => Promise<T>;
+
+type AbdbCollectionCallback = (collection: AbdbCollection) => void;
+declare class AbdbCollection {
+    private readonly _name;
+    private readonly _columns;
+    constructor(name: string, callback?: AbdbCollectionCallback);
+    getName(): string;
+    addColumn(name: string, type: AbdbColumnType, options?: AddColumnOptions): this;
+    addColumn(name: string, type: AbdbColumnType, description?: string, isRequired?: boolean): this;
+    getColumns(): AbdbColumn[];
+    getColumn(name: string): AbdbColumn | undefined;
+    hasColumn(name: string): boolean;
+    validate(record: Record<string, unknown>): void;
+    validateAll(record: Record<string, unknown>): string[];
+    run<T>(callback: AbdbRunCallback<T>, token: string, region?: string): Promise<T>;
+    private _validateCollectionName;
+    private _validateColumnName;
+    private _validateIdentifier;
+}
+
+interface AbdbRecord {
+    _id?: string;
+    _created_at?: string;
+    _updated_at?: string;
+    [key: string]: unknown;
+}
+type AbdbRepositoryFilter = Record<string, unknown>;
+
+declare class AbdbRepository<T extends AbdbRecord = AbdbRecord> {
+    private readonly _collection;
+    private readonly _token;
+    private readonly _region;
+    constructor(collection: AbdbCollection, token: string, region?: string);
+    getName(): string;
+    getCollection(): AbdbCollection;
+    find(filter?: AbdbRepositoryFilter): Promise<T[]>;
+    findOne(filter: AbdbRepositoryFilter): Promise<T | null>;
+    exists(id: string): Promise<boolean>;
+    count(filter?: AbdbRepositoryFilter): Promise<number>;
+    save(payload?: Partial<T>, id?: string): Promise<string>;
+    delete(id?: string): Promise<void>;
+    insertAll(payloads: Array<Partial<T>>): Promise<string[]>;
+    updateAll(payload: Partial<T>, filter?: AbdbRepositoryFilter): Promise<void>;
+    deleteAll(filter?: AbdbRepositoryFilter): Promise<void>;
+    private _validatePartial;
+}
+
 interface EventData {
     type: string;
     data: any;
@@ -989,4 +1078,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };
+export { AbdbCollection, type AbdbCollectionCallback, AbdbColumn, type AbdbColumnJson, type AbdbColumnOptions, AbdbColumnType, type AbdbRecord, AbdbRepository, type AbdbRepositoryFilter, type AbdbRunCallback, type AddColumnOptions, AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import openwhisk, { Dict, Activation } from 'openwhisk';
+import { DbCollection, DbClient } from '@adobe/aio-lib-db';
 import { EntrypointInstrumentationConfig } from '@adobe/aio-lib-telemetry';
 import { LogRecordProcessor } from '@opentelemetry/sdk-logs';
 import { SdkLogRecord } from '@adobe/aio-lib-telemetry/otel';
@@ -202,6 +203,94 @@ declare class FileRepository {
     private getFiles;
 }
 
+declare enum AbdbColumnType {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    BOOLEAN = "BOOLEAN",
+    DATETIME = "DATETIME"
+}
+interface AbdbColumnOptions {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: boolean;
+}
+interface AbdbColumnJson {
+    name: string;
+    type: AbdbColumnType;
+    description?: string;
+    isRequired?: true;
+}
+
+declare class AbdbColumn {
+    private readonly _name;
+    private readonly _type;
+    private readonly _description;
+    private readonly _isRequired;
+    constructor(options: AbdbColumnOptions);
+    getName(): string;
+    getType(): AbdbColumnType;
+    getDescription(): string | undefined;
+    getIsRequired(): boolean;
+    toJSON(): AbdbColumnJson;
+    clone(overrides?: Partial<AbdbColumnOptions>): AbdbColumn;
+    validate(value: unknown): void;
+    private _isMissingValue;
+    private _validateStringValue;
+    private _validateNumberValue;
+    private _validateBooleanValue;
+    private _validateDateTimeValue;
+}
+
+type AddColumnOptions = Omit<AbdbColumnOptions, 'name' | 'type'>;
+type AbdbRunCallback<T = unknown> = (collection: DbCollection, client: DbClient) => Promise<T>;
+
+type AbdbCollectionCallback = (collection: AbdbCollection) => void;
+declare class AbdbCollection {
+    private readonly _name;
+    private readonly _columns;
+    constructor(name: string, callback?: AbdbCollectionCallback);
+    getName(): string;
+    addColumn(name: string, type: AbdbColumnType, options?: AddColumnOptions): this;
+    addColumn(name: string, type: AbdbColumnType, description?: string, isRequired?: boolean): this;
+    getColumns(): AbdbColumn[];
+    getColumn(name: string): AbdbColumn | undefined;
+    hasColumn(name: string): boolean;
+    validate(record: Record<string, unknown>): void;
+    validateAll(record: Record<string, unknown>): string[];
+    run<T>(callback: AbdbRunCallback<T>, token: string, region?: string): Promise<T>;
+    private _validateCollectionName;
+    private _validateColumnName;
+    private _validateIdentifier;
+}
+
+interface AbdbRecord {
+    _id?: string;
+    _created_at?: string;
+    _updated_at?: string;
+    [key: string]: unknown;
+}
+type AbdbRepositoryFilter = Record<string, unknown>;
+
+declare class AbdbRepository<T extends AbdbRecord = AbdbRecord> {
+    private readonly _collection;
+    private readonly _token;
+    private readonly _region;
+    constructor(collection: AbdbCollection, token: string, region?: string);
+    getName(): string;
+    getCollection(): AbdbCollection;
+    find(filter?: AbdbRepositoryFilter): Promise<T[]>;
+    findOne(filter: AbdbRepositoryFilter): Promise<T | null>;
+    exists(id: string): Promise<boolean>;
+    count(filter?: AbdbRepositoryFilter): Promise<number>;
+    save(payload?: Partial<T>, id?: string): Promise<string>;
+    delete(id?: string): Promise<void>;
+    insertAll(payloads: Array<Partial<T>>): Promise<string[]>;
+    updateAll(payload: Partial<T>, filter?: AbdbRepositoryFilter): Promise<void>;
+    deleteAll(filter?: AbdbRepositoryFilter): Promise<void>;
+    private _validatePartial;
+}
+
 interface EventData {
     type: string;
     data: any;
@@ -989,4 +1078,4 @@ declare class AdminUiSdk {
     getRegistration(): AdminUiSdkRegistration;
 }
 
-export { AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };
+export { AbdbCollection, type AbdbCollectionCallback, AbdbColumn, type AbdbColumnJson, type AbdbColumnOptions, AbdbColumnType, type AbdbRecord, AbdbRepository, type AbdbRepositoryFilter, type AbdbRunCallback, type AddColumnOptions, AdminUiSdk, type AdminUiSdkRegistration, AdobeAuth, AdobeCommerceClient, type AdobeIMSConfig, type BaseTelemetry, type BaseTelemetryValidator, BasicAuthConnection, BearerToken, type BearerTokenInfo, type CommerceEvent, type CommerceEventConfig, type CommerceEventField, type Connection, type CreateEventResult, CreateEvents, type CreateProviderParams, type CreateProviderResult, type CreateRegistrationResult, CreateRegistrations, type ErrorResponse, EventConsumerAction, type EventData, type EventMetadata, type EventMetadataInputModel, type EventMetadataListResponse, EventMetadataManager, type ExtendedRequestError, type FileMetadata, type FileRecord, FileRepository, GenerateBasicAuthToken, type GetProviderQueryParams, type GetRegistrationQueryParams, GraphQlAction, type HALLink, type Headers, HttpMethod, HttpStatus, IOEventsApiError, type IOEventsError, ImsConnection, ImsToken, type ImsTokenResult, InfiniteLoopBreaker, type InfiniteLoopData, IoEventsGlobals, JsonMessageProcessor, type ListProvidersQueryParams, type ListRegistrationQueryParams, type MenuItem, Oauth1aConnection, OnboardCommerce, type OnboardCommerceConfig, type OnboardCommerceResult, OnboardEvents, type OnboardEventsInput, type OnboardEventsResponse, OnboardEvents as OnboardIOEvents, Openwhisk, OpenwhiskAction, type OpenwhiskConfig, type Page, Parameters, type Provider, type ProviderInputModel, ProviderManager, PublishEvent, type PublishEventResult, type Registration, type RegistrationCreateModel, type RegistrationListResponse, RegistrationManager, RestClient, RuntimeAction, RuntimeActionResponse, type RuntimeActionResponseType, RuntimeApiGatewayService, ShippingCarrier, type ShippingCarrierData, ShippingCarrierMethod, type ShippingCarrierMethodAdditionalData, type ShippingCarrierMethodData, ShippingCarrierResponse, SignatureVerification, SuccessChecker, type SuccessResponse, Telemetry, TelemetryInputError, type TokenResult, Validator, WebhookAction, type WebhookActionAddResponse, type WebhookActionExceptionResponse, WebhookActionOperation, type WebhookActionRemoveResponse, type WebhookActionReplaceResponse, WebhookActionResponse, type WebhookActionResponseType, type WebhookActionSuccessResponse, type WorkspaceConfig };