zova-module-a-pay 5.0.0

package/src/api/paymentSession.ts

@@ -0,0 +1,52 @@
+import type { IApiActionOptions } from 'zova-module-a-api';
+
+import { Api, BeanApiBase } from 'zova-module-a-api';
+
+import type { paths } from './openapi/index.js';
+
+import { OpenApiBaseURL } from './openapi/index.js';
+
+/** PaymentSession_start */
+export const ApiApiPaymentSessionstartPath = '/api/payment-session/{id}/start';
+export type ApiApiPaymentSessionstartPath = '/api/payment-session/{id}/start';
+export type ApiApiPaymentSessionstartMethod = 'post';
+export type ApiApiPaymentSessionstartRequestParams =
+  paths[ApiApiPaymentSessionstartPath][ApiApiPaymentSessionstartMethod]['parameters']['path'];
+export type ApiApiPaymentSessionstartResponseBody =
+  paths[ApiApiPaymentSessionstartPath][ApiApiPaymentSessionstartMethod]['responses']['200']['content']['application/json']['data'];
+
+/** PaymentSession_view */
+export const ApiApiPaymentSessionviewPath = '/api/payment-session/{id}';
+export type ApiApiPaymentSessionviewPath = '/api/payment-session/{id}';
+export type ApiApiPaymentSessionviewMethod = 'get';
+export type ApiApiPaymentSessionviewRequestParams =
+  paths[ApiApiPaymentSessionviewPath][ApiApiPaymentSessionviewMethod]['parameters']['path'];
+export type ApiApiPaymentSessionviewResponseBody =
+  paths[ApiApiPaymentSessionviewPath][ApiApiPaymentSessionviewMethod]['responses']['200']['content']['application/json']['data'];
+
+@Api()
+export class ApiPaymentSession extends BeanApiBase {
+  start(
+    body: undefined,
+    options: {
+      params: ApiApiPaymentSessionstartRequestParams;
+    } & IApiActionOptions,
+  ) {
+    return this.$fetch.post<any, ApiApiPaymentSessionstartResponseBody>(
+      this.$pathTranslate(ApiApiPaymentSessionstartPath, options.params),
+      body,
+      this.$configPrepare(OpenApiBaseURL(this.sys), options, true),
+    );
+  }
+
+  view(
+    options: {
+      params: ApiApiPaymentSessionviewRequestParams;
+    } & IApiActionOptions,
+  ) {
+    return this.$fetch.get<any, ApiApiPaymentSessionviewResponseBody>(
+      this.$pathTranslate(ApiApiPaymentSessionviewPath, options.params),
+      this.$configPrepare(OpenApiBaseURL(this.sys), options, true),
+    );
+  }
+}

package/src/apiSchema/paymentSession.ts

@@ -0,0 +1,20 @@
+import type { IApiSchemaOptions } from 'zova-module-a-api';
+
+import { BeanBase } from 'zova';
+import { ApiSchema } from 'zova-module-a-api';
+
+import {
+  ApiApiPaymentSessionstartPath,
+  ApiApiPaymentSessionviewPath,
+} from '../api/paymentSession.js';
+
+@ApiSchema()
+export class ApiSchemaPaymentSession extends BeanBase {
+  start(options?: IApiSchemaOptions) {
+    return this.$sdk.createApiSchemas(ApiApiPaymentSessionstartPath, 'post', options);
+  }
+
+  view(options?: IApiSchemaOptions) {
+    return this.$sdk.createApiSchemas(ApiApiPaymentSessionviewPath, 'get', options);
+  }
+}

package/src/component/paymentNextAction/controller.tsx

@@ -0,0 +1,76 @@
+import { BeanControllerBase, Use } from 'zova';
+import { Controller } from 'zova-module-a-bean';
+
+import type { ServicePaymentCoordinator } from '../../service/paymentCoordinator.js';
+import type { TypePaymentNextAction } from '../../types/payment.js';
+
+export interface ControllerPaymentNextActionProps {
+  action?: TypePaymentNextAction;
+  disabled?: boolean;
+  onRefresh?: () => void | Promise<void>;
+}
+
+@Controller()
+export class ControllerPaymentNextAction extends BeanControllerBase {
+  static $propsDefault = {};
+
+  @Use()
+  $$paymentCoordinator: ServicePaymentCoordinator;
+
+  async continueRedirect() {
+    const action = this.$props.action;
+    if (action?.kind !== 'redirect' || this.$props.disabled) return;
+    await this.$$paymentCoordinator.execute(action);
+  }
+
+  protected render() {
+    const { action, disabled, onRefresh } = this.$props as ControllerPaymentNextActionProps;
+    if (!action) return null;
+    if (action.kind === 'redirect') {
+      return (
+        <div class="mt-6 space-y-3">
+          <p class="text-base-content/70">Continue to the payment provider to complete payment.</p>
+          <button
+            class="btn btn-primary"
+            disabled={disabled}
+            onClick={() => this.continueRedirect()}
+          >
+            Continue to payment
+          </button>
+        </div>
+      );
+    }
+    if (action.kind === 'pending') {
+      return (
+        <div class="mt-6 space-y-3" aria-live="polite">
+          <p class="text-base-content/70">
+            Payment is being prepared
+            {action.retryAfterSeconds
+              ? `; retrying in about ${action.retryAfterSeconds} seconds`
+              : ''}
+            .
+          </p>
+          {onRefresh && (
+            <button class="btn btn-outline" disabled={disabled} onClick={() => onRefresh()}>
+              Refresh payment status
+            </button>
+          )}
+        </div>
+      );
+    }
+    if (action.kind === 'completed') {
+      return (
+        <p class="mt-6 text-base-content/70" aria-live="polite">
+          Payment is complete. Confirming the order…
+        </p>
+      );
+    }
+    return (
+      <div class="mt-6" aria-live="polite">
+        <p class="text-base-content/70">
+          Embedded checkout will be available when this payment provider is configured.
+        </p>
+      </div>
+    );
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './lib/index.js';
+export * from './types/index.js';
+export * from './.metadata/index.js';

package/src/lib/index.ts

@@ -0,0 +1 @@
+export {};

package/src/model/paymentSession.ts

@@ -0,0 +1,32 @@
+import type { TableIdentity } from 'table-identity';
+import type { IDecoratorModelOptions } from 'zova-module-a-model';
+
+import { BeanModelBase, Model } from 'zova-module-a-model';
+
+export interface IModelOptionsPaymentSession extends IDecoratorModelOptions {}
+
+@Model<IModelOptionsPaymentSession>()
+export class ModelPaymentSession extends BeanModelBase {
+  view(id: TableIdentity) {
+    if (!process.env.CLIENT || !this.$passport.isAuthenticated) return;
+    return this.$useStateData({
+      queryKey: ['view', id],
+      queryFn: async () => {
+        return await this.scope.api.paymentSession.view({ params: { id } });
+      },
+      meta: { disableSuspenseOnInit: true },
+    });
+  }
+
+  start(id: TableIdentity) {
+    return this.$useMutationData({
+      mutationKey: ['start', id],
+      mutationFn: async () => {
+        return await this.scope.api.paymentSession.start(undefined, { params: { id } });
+      },
+      onSuccess: async () => {
+        await this.$invalidateQueries({ queryKey: ['view', id] });
+      },
+    });
+  }
+}

package/src/service/paymentCoordinator.ts

@@ -0,0 +1,13 @@
+import { BeanBase } from 'zova';
+import { Service } from 'zova-module-a-bean';
+
+import type { TypePaymentNextAction } from '../types/payment.js';
+
+@Service()
+export class ServicePaymentCoordinator extends BeanBase {
+  async execute(action: TypePaymentNextAction) {
+    if (action.kind !== 'redirect') return;
+    if (!process.env.CLIENT) return;
+    window.location.assign(action.url);
+  }
+}

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from './payment.js';

package/src/types/payment.ts

@@ -0,0 +1,25 @@
+export type TypePaymentNextAction =
+  | { kind: 'redirect'; url: string }
+  | { kind: 'embedded'; clientToken: string; publishableConfig?: Record<string, string> }
+  | { kind: 'pending'; retryAfterSeconds?: number }
+  | { kind: 'completed' };
+
+export interface IPaymentSessionView {
+  id: string | number;
+  state:
+    | 'created'
+    | 'starting'
+    | 'requires_action'
+    | 'processing'
+    | 'succeeded'
+    | 'failed'
+    | 'cancelled'
+    | 'expired';
+  providerName: string;
+  nextAction?: TypePaymentNextAction;
+}
+
+export interface IPayUiProvider {
+  supports(action: TypePaymentNextAction): boolean;
+  execute(action: TypePaymentNextAction): Promise<void>;
+}