fiberx-backend-toolkit 1.0.12 → 1.0.14

package/dist/types/fibase_registered_app_api_type.d.ts

@@ -0,0 +1,393 @@
+import type { FibaseHttpResponseInterface, FibaseRequestOptionsInterface } from "./fibase_type";
+/** ISO-8601 date/time string as serialized by the Fibase JSON API. */
+export type FibaseDateTimeString = string;
+export type FibaseIdentityType = "person" | "business" | "system";
+export type FibaseIdentityStatus = "active" | "suspended" | "closed" | "merged";
+export type FibaseIdentityAppAccountStatus = "active" | "inactive" | "banned" | "deleted" | "unknown";
+export interface FibaseApiSuccessEnvelopeInterface<TData, TMessage extends string = string> {
+    status: "success";
+    msg: TMessage;
+    data: TData;
+}
+export interface FibaseApiErrorEnvelopeInterface<TData = unknown> {
+    status: "error";
+    msg: string;
+    data?: TData;
+    code?: number;
+}
+export type FibaseApiHttpResponse<TData, TMessage extends string = string> = FibaseHttpResponseInterface<FibaseApiSuccessEnvelopeInterface<TData, TMessage>>;
+export interface FibaseAppIdentityProfileInputInterface {
+    first_name: string;
+    last_name: string;
+    middle_name?: string | null;
+    display_name?: string | null;
+    dob?: string | null;
+    gender?: string | null;
+    nationality?: string | null;
+    country_of_residence?: string | null;
+    profile_photo_link?: string | null;
+    primary_email?: string | null;
+    primary_phone?: string | null;
+    address?: Record<string, unknown> | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface FibaseResolveAppIdentityInputInterface {
+    member_public_id: string;
+    profile: FibaseAppIdentityProfileInputInterface;
+    identity_type?: FibaseIdentityType | null;
+    external_member_id?: string | null;
+    external_username?: string | null;
+    external_status?: FibaseIdentityAppAccountStatus | null;
+    registered_at?: string | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface FibaseIdentityProfileInterface {
+    public_id: string;
+    identity_public_id?: string | null;
+    first_name: string | null;
+    middle_name: string | null;
+    last_name: string | null;
+    display_name: string | null;
+    dob: string | null;
+    gender: string | null;
+    nationality: string | null;
+    country_of_residence: string | null;
+    profile_photo_link: string | null;
+    primary_email: string | null;
+    primary_phone: string | null;
+    address: Record<string, unknown> | null;
+    profile_completeness_score: number;
+    source_app_account_public_id?: string | null;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseIdentityContactInterface {
+    public_id: string;
+    identity_public_id?: string | null;
+    contact_type: string;
+    contact_value: string;
+    is_primary: boolean;
+    is_verified: boolean;
+    verified_at: FibaseDateTimeString | null;
+    source_app_account_public_id?: string | null;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseIdentityInterface {
+    public_id: string;
+    identity_type: FibaseIdentityType;
+    status: FibaseIdentityStatus;
+    is_verified: boolean;
+    is_deleted: boolean;
+    wallet_count?: number;
+    merged_into_identity_public_id?: string | null;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+    primary_profile?: FibaseIdentityProfileInterface | null;
+    profile?: FibaseIdentityProfileInterface | null;
+    contacts?: FibaseIdentityContactInterface[] | null;
+}
+export interface FibaseIdentityAppAccountInterface {
+    public_id: string;
+    identity_public_id?: string | null;
+    external_member_id: string;
+    external_public_id: string | null;
+    external_username: string | null;
+    external_status: FibaseIdentityAppAccountStatus;
+    registered_at: FibaseDateTimeString | null;
+    last_seen_at: FibaseDateTimeString | null;
+    last_synced_at: FibaseDateTimeString | null;
+    is_active: boolean;
+    is_deleted: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseAppIdentityRecordInterface {
+    identity: FibaseIdentityInterface;
+    app_account: FibaseIdentityAppAccountInterface;
+    created: boolean;
+}
+export type FibaseGetAppIdentityResponse = FibaseApiHttpResponse<FibaseAppIdentityRecordInterface, "fetched_app_identity_record_successfully">;
+export type FibaseResolveAppIdentityResponse = FibaseApiHttpResponse<FibaseAppIdentityRecordInterface, "created_app_identity_record_successfully" | "fetched_app_identity_record_successfully">;
+export interface FibaseCurrencyPreviewInterface {
+    code: string;
+    logo_url: string | null;
+    name: string;
+    symbol: string;
+    precision: number;
+    minor_unit: number | null;
+    format: string | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+}
+export interface FibaseCurrencyInterface extends FibaseCurrencyPreviewInterface {
+    id: number;
+    numeric_code: string | null;
+    country_code: string | null;
+    sort_order: number;
+    is_fiat: boolean;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseIdentityPreviewInterface {
+    public_id: string;
+    identity_type: FibaseIdentityType;
+    status: FibaseIdentityStatus;
+    is_verified: boolean;
+    is_deleted: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseIdentityWalletPreviewInterface {
+    public_id: string;
+    available_balance: number;
+    locked_balance: number;
+    status: string;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    identity?: FibaseIdentityPreviewInterface | null;
+    currency?: FibaseCurrencyPreviewInterface | null;
+}
+export interface FibaseIdentityWalletInterface extends FibaseIdentityWalletPreviewInterface {
+    refunded_balance: number;
+    pending_balance: number;
+    total_credit: number;
+    total_debit: number;
+    updated_at: FibaseDateTimeString | null;
+    currency?: FibaseCurrencyInterface | null;
+}
+export type FibaseIdentityWalletSortField = "public_id" | "identity_id" | "currency_id" | "available_balance" | "locked_balance" | "refunded_balance" | "pending_balance" | "status" | "is_active" | "is_deleted" | "created_at" | "updated_at";
+export interface FibaseDateRangeQueryInterface {
+    start_date: string;
+    end_date: string;
+}
+export interface FibaseAppIdentityWalletListQueryInterface {
+    page?: number;
+    limit?: number;
+    sort_by?: FibaseIdentityWalletSortField;
+    sort_direction?: "ASC" | "DESC" | "asc" | "desc";
+    search?: string | null;
+    preview_only?: boolean;
+    currency_id?: string | number | null;
+    status?: string | null;
+    is_active?: boolean | null;
+    date_range?: string | FibaseDateRangeQueryInterface | null;
+}
+export interface FibasePaginatedDataInterface<TRecord> {
+    total_items: number;
+    total_pages: number;
+    current_page: number;
+    records: TRecord[];
+}
+export interface FibaseGetAppIdentityWalletListInputInterface {
+    identity_public_id: string;
+    query?: FibaseAppIdentityWalletListQueryInterface;
+}
+export type FibaseGetAppIdentityWalletListResponse = FibaseApiHttpResponse<FibasePaginatedDataInterface<FibaseIdentityWalletInterface | FibaseIdentityWalletPreviewInterface>, "fetched_app_identity_wallet_list_successfully">;
+export interface FibaseGetAppIdentityCurrencyWalletInputInterface {
+    identity_public_id: string;
+    currency_id: string | number;
+}
+export type FibaseGetAppIdentityCurrencyWalletResponse = FibaseApiHttpResponse<FibaseIdentityWalletInterface, "fetched_app_identity_currency_wallet_successfully">;
+export interface FibaseResolveAppIdentityCurrencyWalletInputInterface extends FibaseGetAppIdentityCurrencyWalletInputInterface {
+}
+export type FibaseResolveAppIdentityCurrencyWalletResponse = FibaseApiHttpResponse<{
+    wallet: FibaseIdentityWalletInterface;
+    created: boolean;
+}, "created_app_identity_currency_wallet_successfully" | "fetched_app_identity_currency_wallet_successfully">;
+export type FibaseAppCurrencySortField = "is_default" | "created_at" | "updated_at";
+export interface FibaseAppCurrencyListQueryInterface {
+    page?: number;
+    limit?: number;
+    sort_by?: FibaseAppCurrencySortField;
+    sort_direction?: "ASC" | "DESC" | "asc" | "desc";
+    search?: string | null;
+    preview_only?: boolean;
+    currency_id?: string | number | null;
+    is_fiat?: boolean | null;
+    is_default?: boolean | null;
+    date_range?: string | FibaseDateRangeQueryInterface | null;
+}
+export interface FibaseGetAppCurrencyListInputInterface {
+    query?: FibaseAppCurrencyListQueryInterface;
+}
+export interface FibaseCurrencyListItemInterface extends FibaseCurrencyPreviewInterface {
+    numeric_code: string | null;
+    country_code: string | null;
+    sort_order: number;
+    is_fiat: boolean;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibaseAppCurrencyInterface {
+    is_default: boolean;
+    created_at: FibaseDateTimeString;
+    currency?: FibaseCurrencyListItemInterface | FibaseCurrencyPreviewInterface | null;
+}
+export type FibaseGetAppCurrencyListResponse = FibaseApiHttpResponse<FibasePaginatedDataInterface<FibaseAppCurrencyInterface>, "fetched_app_currency_list_successfully">;
+export type FibasePaymentProviderType = "payment_gateway" | "banking_partner" | "crypto_exchange" | "wallet_provider" | "other";
+export interface FibasePaymentProviderInterface {
+    id: number;
+    code: string;
+    name: string;
+    description: string | null;
+    provider_type: FibasePaymentProviderType;
+    logo_url: string | null;
+    website_url: string | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibasePaymentMethodMetadataInterface {
+    display_name?: string | null;
+    display_description?: string | null;
+    display_group?: string | null;
+    processing_time_text?: string | null;
+    fee_label?: string | null;
+    supported_country_codes?: string[];
+    supported_currency_codes?: string[];
+    requires_redirect?: boolean;
+    supports_deposit?: boolean;
+    supports_withdrawal?: boolean;
+    supports_refund?: boolean;
+    min_amount?: number | null;
+    max_amount?: number | null;
+    [key: string]: string | number | boolean | string[] | null | undefined;
+}
+export interface FibasePaymentMethodInterface {
+    id: number;
+    code: string;
+    name: string;
+    description: string | null;
+    icon_url: string | null;
+    sort_order: number;
+    metadata?: FibasePaymentMethodMetadataInterface | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibasePaymentProviderMethodInterface {
+    id: number;
+    direction: "deposit" | "withdrawal";
+    provider_method_code: string | null;
+    min_amount: number | null;
+    max_amount: number | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+    provider?: FibasePaymentProviderInterface | null;
+    payment_method?: FibasePaymentMethodInterface | null;
+}
+export interface FibaseCurrencyPaymentOptionInterface {
+    id: number;
+    min_amount: number | null;
+    max_amount: number | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+    provider_method?: FibasePaymentProviderMethodInterface | null;
+}
+export interface FibaseAppCurrencyPaymentOptionsInterface {
+    currency: FibaseCurrencyInterface;
+    options: FibaseCurrencyPaymentOptionInterface[];
+}
+export type FibaseGetAppCurrencyPaymentOptionsResponse = FibaseApiHttpResponse<FibaseAppCurrencyPaymentOptionsInterface, "fetched_app_currency_payment_options_successfully">;
+export interface FibaseInitiateAppDepositTransactionInputInterface {
+    identity_public_id: string;
+    currency_provider_method_id: string | number;
+    amount: string;
+    app_reference: string;
+    idempotency_key: string;
+    description?: string | null;
+    reason?: string | null;
+    redirect_url?: string | null;
+    metadata?: Record<string, unknown> | null;
+}
+export type FibasePaymentProviderInteractionStatus = "pending" | "processing" | "successful" | "failed" | "cancelled" | "expired" | "partially_paid" | "overpaid" | "requires_action" | "unknown";
+export interface FibasePaymentProviderAmountInterface {
+    amount: number;
+    currency_code: string;
+    minor_amount?: number | null;
+    precision?: number | null;
+}
+export interface FibasePaymentProviderInstructionInterface {
+    type: "redirect" | "bank_transfer" | "wallet_transfer" | "provider_action";
+    title?: string | null;
+    authorization_url?: string | null;
+    account_name?: string | null;
+    account_number?: string | null;
+    bank_name?: string | null;
+    bank_code?: string | null;
+    wallet_address?: string | null;
+    network?: string | null;
+    expires_at?: string | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface FibasePaymentProviderInteractionResultInterface {
+    status: FibasePaymentProviderInteractionStatus;
+    payment_reference?: string | null;
+    provider_reference?: string | null;
+    amount?: FibasePaymentProviderAmountInterface | null;
+    authorization_url?: string | null;
+    redirect_url?: string | null;
+    account?: Record<string, unknown> | null;
+    instructions?: FibasePaymentProviderInstructionInterface[] | null;
+    fees?: Array<{
+        amount: number;
+        currency_code: string;
+        label?: string | null;
+    }> | null;
+    metadata?: Record<string, unknown> | null;
+}
+export interface FibaseRegisteredAppSummaryInterface {
+    public_id: string;
+    prefix: string;
+    name: string;
+    description: string | null;
+    base_url: string | null;
+    logo_url: string | null;
+    is_active: boolean;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+}
+export interface FibasePaymentTransactionInterface {
+    public_id: string;
+    transaction_type: string;
+    direction: string;
+    status: string;
+    amount: number;
+    fee_amount: number;
+    net_amount: number;
+    app_reference: string | null;
+    provider_reference: string | null;
+    external_reference: string | null;
+    external_destination_type: string | null;
+    external_destination_snapshot: Record<string, unknown> | null;
+    provider_instruction_snapshot: Record<string, unknown> | null;
+    description: string | null;
+    reason: string | null;
+    initiated_at: FibaseDateTimeString | null;
+    authorized_at: FibaseDateTimeString | null;
+    settled_at: FibaseDateTimeString | null;
+    failed_at: FibaseDateTimeString | null;
+    cancelled_at: FibaseDateTimeString | null;
+    reversed_at: FibaseDateTimeString | null;
+    refunded_at: FibaseDateTimeString | null;
+    created_at: FibaseDateTimeString;
+    updated_at: FibaseDateTimeString | null;
+    parent_transaction_public_id?: string | null;
+    app?: FibaseRegisteredAppSummaryInterface | null;
+    currency?: FibaseCurrencyInterface | null;
+    initiated_by_identity?: FibaseIdentityInterface | null;
+    initiated_by_app?: FibaseRegisteredAppSummaryInterface | null;
+    destination_identity?: FibaseIdentityInterface | null;
+    destination_wallet?: FibaseIdentityWalletInterface | null;
+    provider?: FibasePaymentProviderInterface | null;
+    payment_method?: FibasePaymentMethodInterface | null;
+}
+export interface FibaseAppTransactionProviderActionInterface {
+    transaction: FibasePaymentTransactionInterface;
+    provider_result: FibasePaymentProviderInteractionResultInterface | null;
+}
+export type FibaseInitiateAppDepositTransactionResponse = FibaseApiHttpResponse<FibaseAppTransactionProviderActionInterface, "initiated_app_deposit_transaction_successfully" | "app_deposit_transaction_already_initialized">;
+export type FibaseGetAppTransactionResponse = FibaseApiHttpResponse<FibasePaymentTransactionInterface>;
+export type FibaseVerifyAppTransactionResponse = FibaseApiHttpResponse<FibaseAppTransactionProviderActionInterface>;
+export type FibaseRegisteredAppRequestOptionsInterface = Omit<FibaseRequestOptionsInterface, "params">;

package/dist/types/fibase_registered_app_api_type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/fibase_type.d.ts

@@ -46,6 +46,8 @@ export interface FibaseSignedRequestDataInterface<TBody = unknown> {
 export interface FibaseRequestOptionsInterface {
     request_id?: string;
     headers?: Record<string, string>;
+    /** Query parameters sent by Axios. Query values are not included in the Fibase signature body hash. */
+    params?: Record<string, unknown>;
 }
 export interface FibaseAppEventEnvelopeInterface<TPayload = unknown> {
     event_type: string;

package/dist/types/main.d.ts

@@ -11,3 +11,4 @@ export * from "./validator_type";
 export * from "./storage_type";
 export * from "./processor_type";
 export * from "./fibase_type";
+export * from "./fibase_registered_app_api_type";

package/dist/types/main.js

@@ -27,3 +27,4 @@ __exportStar(require("./validator_type"), exports);
 __exportStar(require("./storage_type"), exports);
 __exportStar(require("./processor_type"), exports);
 __exportStar(require("./fibase_type"), exports);
+__exportStar(require("./fibase_registered_app_api_type"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "1.0.12",
+    "version": "1.0.14",
     "description": "A TypeScript backend toolkit providing shared domain logic, infrastructure helpers, and utilities for FiberX server-side applications and services.",
     "type": "commonjs",
     "main": "./dist/index.js",
@@ -78,7 +78,8 @@
         "spell:check": "cspell .",
         "check": "npm run typecheck && npm run lint && npm run format:check && npm run spell:check && npm run build",
         "prepublishOnly": "npm run build",
-        "update-dependencies": "node scripts/update-dependencies.js"
+        "update-dependencies": "node scripts/update-dependencies.js",
+        "generate:fibase-api": "node scripts/generate-fibase-registered-app-routes.js"
     },
     "files": [
         "dist"
@@ -95,17 +96,17 @@
     "author": "David Matt-Ojo",
     "dependencies": {
         "@google-cloud/storage": "^7.21.0",
-        "@types/nodemailer": "^8.0.0",
-        "axios": "^1.17.0",
+        "@types/nodemailer": "^8.0.1",
+        "axios": "^1.18.1",
         "bcrypt": "^6.0.0",
         "dayjs": "^1.11.21",
         "ejs": "^6.0.1",
         "express": "^5.2.1",
-        "js-yaml": "^4.2.0",
+        "js-yaml": "^5.2.2",
         "jsonwebtoken": "^9.0.3",
-        "nodemailer": "^8.0.10",
+        "nodemailer": "^9.0.3",
         "sequelize": "^6.37.8",
-        "uuid": "^14.0.0"
+        "uuid": "^14.0.1"
     },
     "devDependencies": {
         "@eslint/js": "^10.0.1",
@@ -114,28 +115,29 @@
         "@types/express": "^5.0.6",
         "@types/js-yaml": "^4.0.9",
         "@types/jsonwebtoken": "^9.0.10",
-        "@types/node": "^25.9.2",
+        "@types/node": "^26.1.1",
         "cspell": "^10.0.1",
-        "eslint": "^10.4.1",
-        "globals": "^17.6.0",
-        "prettier": "^3.8.4",
+        "eslint": "^10.8.0",
+        "globals": "^17.7.0",
+        "prettier": "^3.9.6",
         "ts-node": "^10.9.2",
-        "tsc-alias": "^1.8.17",
+        "tsc-alias": "^1.9.1",
         "tsconfig-paths": "^4.2.0",
         "tsup": "^8.5.1",
         "typescript": "^6.0.3",
-        "typescript-eslint": "^8.61.0"
+        "typescript-eslint": "^8.65.0"
     },
     "overrides": {
-        "qs": "^6.15.2",
-        "uuid": "^14.0.0"
+        "qs": "^6.15.3",
+        "uuid": "^14.0.1",
+        "esbuild": "^0.28.1"
     },
     "engines": {
         "node": ">=24 <27"
     },
     "allowScripts": {
         "bcrypt@6.0.0": true,
-        "esbuild@0.27.7": true,
-        "fsevents@2.3.3": true
+        "fsevents@2.3.3": true,
+        "esbuild@0.28.1": true
     }
 }