sahab-utils 1.3.0 → 1.4.0

package/dist/constants/types.d.ts

@@ -444,13 +444,101 @@ export type Provider = {
     integrations?: {
         email?: string;
         isActive?: boolean;
+        /** Canonical values from `INTEGRATION_KEYS`, e.g. `'TAP_PAYMENTS'`. */
         key: string;
         /** Tap (and other gateways): server-side API secret */
         secretKey?: string;
-        /** Tap Connect marketplace payout destination id (sub-merchant) */
+        /** Tap Connect marketplace payout destination id (sub-merchant). Set when the related `TapApplication` reaches `payout_enabled`. */
         tapDestinationId?: string;
     }[];
 };
+export declare const INTEGRATION_KEYS: {
+    readonly TAP_PAYMENTS: "TAP_PAYMENTS";
+};
+export type IntegrationKey = (typeof INTEGRATION_KEYS)[keyof typeof INTEGRATION_KEYS];
+export type TapKycStatus = 'draft' | 'documents_uploaded' | 'lead_created' | 'account_created' | 'payout_enabled' | 'rejected';
+export type TapDocumentPurpose = 'commercial_registration' | 'national_id' | 'bank_statement' | 'iban_certificate';
+export type TapLicenseType = 'LLC' | 'SOLE_PROPRIETORSHIP' | 'JOINT_STOCK' | 'PARTNERSHIP' | 'OTHER';
+export type TapApplicationFile = {
+    purpose: TapDocumentPurpose;
+    fileId: string;
+    title?: string;
+    /** epoch seconds */
+    uploadedAt: number;
+    /** epoch seconds, mirrors Tap's expires_at */
+    expiresAt?: number;
+};
+export type TapApplicationFormData = {
+    country: 'SA';
+    brand: {
+        websiteUrl: string;
+        nameEn: string;
+        nameAr: string;
+    };
+    entity: {
+        licenseNumber: string;
+        unifiedNumber: string;
+        licenseType: TapLicenseType;
+        legalNameEn: string;
+    };
+    bank: {
+        beneficiaryName: string;
+        iban: string;
+    };
+    walletName: string;
+    owner: {
+        firstName: string;
+        middleName?: string;
+        lastName: string;
+        email: string;
+        phoneCountryCode: string;
+        phoneNumber: string;
+        nationalId: string;
+        nationality: string;
+        idType: 'national_id' | 'passport';
+    };
+};
+export type TapApplicationError = {
+    code?: string;
+    message: string;
+    /** epoch seconds */
+    at: number;
+    endpoint: 'files' | 'lead' | 'account' | 'update_lead';
+};
+/**
+ * Stored at: `service_providers/{providerId}/tapApplications/{applicationId}`.
+ *
+ * One document per onboarding attempt. On rejection a new application may be created;
+ * history is preserved. Invariant: at most one non-terminal application per provider.
+ * Terminal states: `payout_enabled`, `rejected`.
+ */
+export type TapApplication = {
+    id: string;
+    providerId: string;
+    /** epoch seconds */
+    createdAt: number;
+    /** epoch seconds */
+    updatedAt: number;
+    /** admin uid that initiated the application */
+    createdBy: string;
+    kycStatus: TapKycStatus;
+    payoutEnabled: boolean;
+    formData?: TapApplicationFormData;
+    files?: TapApplicationFile[];
+    tapLeadId?: string;
+    /** retailer.id from Tap; mirrored up to provider.integrations[TAP_PAYMENTS].tapDestinationId on payout_enabled */
+    tapDestinationId?: string;
+    /** epoch seconds — lead → account transition */
+    submittedAt?: number;
+    /** epoch seconds — set by webhook on payout_enabled */
+    approvedAt?: number;
+    /** epoch seconds */
+    rejectedAt?: number;
+    rejectionReason?: string;
+    lastError?: TapApplicationError;
+    /** echo of post.url sent on lead creation */
+    webhookUrl?: string;
+};
 export type Card = {
     id?: string;
     issuer?: string;

package/dist/constants/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistrationSection = exports.ReviewStatus = exports.ComplaintStatus = exports.ComplaintType = exports.MovementType = exports.OrderPaymentType = exports.OrderStatus = exports.CarSize = void 0;
+exports.INTEGRATION_KEYS = exports.RegistrationSection = exports.ReviewStatus = exports.ComplaintStatus = exports.ComplaintType = exports.MovementType = exports.OrderPaymentType = exports.OrderStatus = exports.CarSize = void 0;
 var CarSize;
 (function (CarSize) {
     CarSize[CarSize["X_SMALL"] = 0] = "X_SMALL";
@@ -77,3 +77,6 @@ var RegistrationSection;
     RegistrationSection[RegistrationSection["STATUS"] = 11] = "STATUS";
     RegistrationSection[RegistrationSection["DONE"] = 12] = "DONE";
 })(RegistrationSection || (exports.RegistrationSection = RegistrationSection = {}));
+exports.INTEGRATION_KEYS = {
+    TAP_PAYMENTS: 'TAP_PAYMENTS',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sahab-utils",
-	"version": "1.3.0",
+	"version": "1.4.0",
 	"description": "This package contains types and utils functions",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",