@adiba-banking-cloud/backoffice-console-appshell-api-sdk

Shared Appshell API SDK for ADIBA backoffice console applications.

This package is intended for Appshell and shared platform concerns that are consumed across multiple modules such as Retail Engine, Open Banking, and Process Engine.

Collections

The SDK currently includes typed support for:

• Applications
• Connections
• Documents
• Members
• Preferences
• Subscriptions
• Messages

Installation

npm install @adiba-banking-cloud/backoffice-console-appshell-api-sdk

Configuration

Configure the SDK once at app startup:

import { configureBackofficeAppshellSdk } from "@adiba-banking-cloud/backoffice-console-appshell-api-sdk";

configureBackofficeAppshellSdk({
  baseURL: "https://api.s2.adiba.app/_base/backoffice/0.0.1",
  requireAuth: true,
  getAccessToken: async () => {
    return localStorage.getItem("access_token") ?? undefined;
  },
  onUnauthorized: async () => {
    // handle token expiry / redirect to login
  },
});

Usage

Applications

import { ApplicationsApi } from "@adiba-banking-cloud/backoffice-console-appshell-api-sdk";

const response = await ApplicationsApi.getMyApplications({
  limit: 4,
  offset: 0,
});

console.log(response.data.applications);

Documents

import { DocumentsApi } from "@adiba-banking-cloud/backoffice-console-appshell-api-sdk";

const documents = await DocumentsApi.getDocuments({
  limit: 20,
  offset: 0,
});

const preview = await DocumentsApi.getDocumentPreviewById("doc-001");

Messages

import { MessagesApi } from "@adiba-banking-cloud/backoffice-console-appshell-api-sdk";

await MessagesApi.composeConversation({
  participantIds: ["user-001", "user-002"],
  subject: "Hello",
});

Public API

Runtime exports

• configureBackofficeAppshellSdk
• setApiBaseUrl
• setAccessTokenProvider
• apiClient
• API_ENDPOINTS

Feature exports

• ApplicationsApi
• ConnectionsApi
• DocumentsApi
• MembersApi
• PreferencesApi
• SubscriptionsApi
• MessagesApi

Type exports

The package re-exports feature types from each collection barrel, for example:

• application list and detail types
• connection payload and response types
• document upload/list/preview types
• member management payload types
• preference update payload types
• subscription plan and payment payload types
• message and conversation payload types

Notes on typing

This SDK follows the local HTML API documentation as the source of truth.

Where the docs provide concrete request or response structures, those are typed directly. Where the docs currently return generic {} payloads, the SDK keeps those responses conservative using shared empty or opaque response types rather than inventing fields that are not documented yet.

Development

Build the package:

npm run build

Type-check the package:

npx tsc --noEmit