@mercurjs/core 2.3.9-canary.4 → 2.3.9-canary.5

package/.medusa/server/src/modules/payout/services/payout-module-service.d.ts

@@ -1,111 +1,105 @@
-import { CreatePayoutAccountDTO, CreatePayoutDTO, CreateOnboardingDTO, OnboardingDTO, PayoutAccountDTO, PayoutAccountStatus, PayoutDTO, PayoutWebhookActionInput, PayoutWebhookResult, PayoutModuleOptions, PayoutStatus } from "@mercurjs/types";
+import { AccountOutput, CreateAccountInput, CreatePayoutAccountDTO, CreateOnboardingDTO, IPayoutModuleService, OnboardingDTO, PayoutAccountDTO, PayoutAccountRequirements, PayoutAccountStatus, PayoutDTO, PayoutKycStatus, PayoutModuleOptions, PayoutOutput, PayoutProviderErrorCode, PayoutReversalDTO, PayoutStatus, PayoutWebhookActionInput, PayoutWebhookResult, ResolvedPayoutModuleOptions } from "@mercurjs/types";
 import PayoutProviderService from "./provider-service";
-import { Payout, PayoutAccount } from "../models";
-import { Context, DAL, InferEntityType } from "@medusajs/framework/types";
-import { EntityManager } from "@medusajs/framework/mikro-orm/knex";
+import { Context, DAL } from "@medusajs/framework/types";
+import { SqlEntityManager } from "@medusajs/framework/mikro-orm/postgresql";
 type InjectedDependencies = {
     payoutProviderService: PayoutProviderService;
     baseRepository: DAL.RepositoryService;
 };
-declare const PayoutModuleService_base: import("@medusajs/framework/utils").MedusaServiceReturnType<import("@medusajs/framework/utils").ModelConfigurationsToConfigTemplate<{
-    readonly Onboarding: import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-        id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-        data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-        context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-        account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-            status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutAccountStatus>;
-            data: import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>;
-            context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            onboarding: import("@medusajs/framework/utils").RelationNullableModifier<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "onboarding">, import("@medusajs/framework/utils").HasOne<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "onboarding">>, false>;
-            payouts: import("@medusajs/framework/utils").HasMany<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-                id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-                display_id: import("@medusajs/framework/utils").AutoIncrementProperty;
-                currency_code: import("@medusajs/framework/utils").TextProperty;
-                amount: import("@medusajs/framework/utils").BigNumberProperty;
-                data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-                account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-                status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutStatus>;
-            }>, "payout">>;
-        }>, "payout_account">, undefined>;
-    }>, "onboarding">;
-    readonly Payout: import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-        id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-        display_id: import("@medusajs/framework/utils").AutoIncrementProperty;
-        currency_code: import("@medusajs/framework/utils").TextProperty;
-        amount: import("@medusajs/framework/utils").BigNumberProperty;
-        data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-        account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-            status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutAccountStatus>;
-            data: import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>;
-            context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            onboarding: import("@medusajs/framework/utils").RelationNullableModifier<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-                id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-                data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-                context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-                account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-            }>, "onboarding">, import("@medusajs/framework/utils").HasOne<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-                id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-                data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-                context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-                account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-            }>, "onboarding">>, false>;
-            payouts: import("@medusajs/framework/utils").HasMany<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout">>;
-        }>, "payout_account">, undefined>;
-        status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutStatus>;
-    }>, "payout">;
-    readonly PayoutAccount: import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-        id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-        status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutAccountStatus>;
-        data: import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>;
-        context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-        onboarding: import("@medusajs/framework/utils").RelationNullableModifier<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-            data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-        }>, "onboarding">, import("@medusajs/framework/utils").HasOne<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-            data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            context: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-        }>, "onboarding">>, false>;
-        payouts: import("@medusajs/framework/utils").HasMany<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder<{
-            id: import("@medusajs/framework/utils").PrimaryKeyModifier<string, import("@medusajs/framework/utils").IdProperty>;
-            display_id: import("@medusajs/framework/utils").AutoIncrementProperty;
-            currency_code: import("@medusajs/framework/utils").TextProperty;
-            amount: import("@medusajs/framework/utils").BigNumberProperty;
-            data: import("@medusajs/framework/utils").NullableModifier<NoInfer<Record<string, unknown>>, import("@medusajs/framework/utils").JSONProperty<NoInfer<Record<string, unknown>>>>;
-            account: import("@medusajs/framework/utils").BelongsTo<() => import("@medusajs/framework/utils").DmlEntity<import("@medusajs/framework/utils").DMLEntitySchemaBuilder</*elided*/ any>, "payout_account">, undefined>;
-            status: import("@medusajs/framework/utils").EnumProperty<typeof PayoutStatus>;
-        }>, "payout">>;
-    }>, "payout_account">;
-}>>;
-export default class PayoutModuleService extends PayoutModuleService_base {
+type ProviderAccount = {
+    external_id?: string | null;
+    data?: Record<string, unknown> | null;
+};
+type ProviderResult = {
+    status: PayoutStatus;
+    status_reason: string | null;
+    data: Record<string, unknown>;
+};
+declare const PayoutModuleService_base: import("@medusajs/framework/utils").MedusaServiceReturnType<{
+    Onboarding: {
+        dto: OnboardingDTO;
+    };
+    Payout: {
+        dto: PayoutDTO;
+    };
+    PayoutAccount: {
+        dto: PayoutAccountDTO;
+    };
+    PayoutReversal: {
+        dto: PayoutReversalDTO;
+    };
+}>;
+export default class PayoutModuleService extends PayoutModuleService_base implements IPayoutModuleService {
+    protected static readonly PROCESSABLE_STATUSES: PayoutStatus[];
+    protected static readonly STATUS_DETAIL_MAX_LENGTH = 1024;
     protected readonly payoutProviderService_: PayoutProviderService;
     protected readonly baseRepository_: DAL.RepositoryService;
-    protected readonly options_: PayoutModuleOptions;
+    protected readonly options_: ResolvedPayoutModuleOptions;
     constructor({ payoutProviderService, baseRepository }: InjectedDependencies, options: PayoutModuleOptions);
-    getOptions(): {
-        providers?: {
-            resolve: string | import("@mercurjs/types").ModuleProviderExports;
-            id: string;
-            options?: Record<string, unknown>;
-        }[];
-        disabled: boolean;
-        authorizationWindowMs: number;
-        sellerActionWindowMs: number;
-        captureSafetyBufferMs: number;
-        requiredFulfillmentStatus: import("@mercurjs/types").FulfillmentStatus;
-    };
-    createPayoutAccount(input: CreatePayoutAccountDTO, sharedContext?: Context<EntityManager>): Promise<PayoutAccountDTO>;
-    createOnboarding(input: CreateOnboardingDTO, sharedContext?: Context<EntityManager>): Promise<OnboardingDTO>;
-    createPayouts(input: CreatePayoutDTO, sharedContext?: Context<EntityManager>): Promise<PayoutDTO>;
-    protected createPayouts_(input: CreatePayoutDTO, sharedContext?: Context<EntityManager>): Promise<{
-        payout: InferEntityType<typeof Payout>;
-        payoutAccount: InferEntityType<typeof PayoutAccount>;
-    }>;
+    getOptions(): ResolvedPayoutModuleOptions;
+    createPayoutAccount(input: CreatePayoutAccountDTO, sharedContext?: Context<SqlEntityManager>): Promise<PayoutAccountDTO>;
+    syncPayoutAccount(accountId: string, sharedContext?: Context<SqlEntityManager>): Promise<PayoutAccountDTO>;
+    deletePayoutAccount(accountId: string, sharedContext?: Context<SqlEntityManager>): Promise<void>;
+    createOnboarding(input: CreateOnboardingDTO, sharedContext?: Context<SqlEntityManager>): Promise<OnboardingDTO>;
+    processPayout(payoutId: string, sharedContext?: Context<SqlEntityManager>): Promise<PayoutDTO>;
+    processPayoutReversal(reversalId: string, sharedContext?: Context<SqlEntityManager>): Promise<PayoutReversalDTO>;
     getWebhookActionAndData(input: PayoutWebhookActionInput): Promise<PayoutWebhookResult>;
+    protected processPayout_(payoutId: string, sharedContext?: Context<SqlEntityManager>): Promise<{
+        payout: PayoutDTO;
+        attempt: {
+            attempts: number;
+            idempotency_key: string;
+        } | null;
+    }>;
+    protected processPayoutReversal_(reversalId: string, sharedContext?: Context<SqlEntityManager>): Promise<{
+        reversal: PayoutReversalDTO;
+        attempt: {
+            attempts: number;
+            idempotency_key: string;
+        } | null;
+    }>;
+    protected processPayoutFromProvider_(payout: PayoutDTO, attempt: {
+        idempotency_key: string;
+    }): Promise<ProviderResult>;
+    protected processPayoutReversalFromProvider_(reversal: PayoutReversalDTO, attempt: {
+        idempotency_key: string;
+    }): Promise<ProviderResult>;
+    protected lockRow_(table: string, id: string, sharedContext: Context<SqlEntityManager>): Promise<void>;
+    /**
+     * The key of a request whose outcome is unknown is kept, so a retry after a
+     * timeout returns the payout the provider may already have made. Only a
+     * provider refusal clears it, and the next attempt gets a fresh key.
+     */
+    protected nextAttempt_(id: string, data: Record<string, unknown> | null): {
+        attempts: number;
+        idempotency_key: string;
+    };
+    protected statusFromProvider_(response: PayoutOutput): ProviderResult;
+    protected statusFromError_(error: unknown): ProviderResult;
+    protected providerErrorCode_(error: unknown): PayoutProviderErrorCode;
+    protected isOnboardingTokenValid_(account: PayoutAccountDTO): boolean;
+    protected generateOnboardingToken_(): string;
+    protected providerAccountRef_(account: ProviderAccount): {
+        id: string;
+        data: Record<string, unknown>;
+    };
+    protected providerAccountInput_(accountId: string, input: CreatePayoutAccountDTO): CreateAccountInput;
+    protected accountFieldsFromProvider_(account: AccountOutput): {
+        external_id: string;
+        status: PayoutAccountStatus;
+        kyc_status: PayoutKycStatus;
+        payouts_enabled: boolean;
+        charges_enabled: boolean;
+        details_submitted: boolean;
+        disabled_reason: string | null;
+        data: Record<string, unknown>;
+        last_synced_at: Date;
+    };
+    /**
+     * Outstanding requirements beat pending verification, a `rejected.*`
+     * disabled reason is final, any other disabled reason is still under review.
+     */
+    protected deriveKycStatus_(requirements: PayoutAccountRequirements | null | undefined, disabledReason: string | null | undefined): PayoutKycStatus;
+    protected deriveAccountStatus_(account: AccountOutput): PayoutAccountStatus;
 }
 export {};