@unchainedshop/core-payment 2.14.2 → 3.0.0-alpha3

package/src/types.ts

@@ -0,0 +1,108 @@
+import { IBaseAdapter, IBaseDirector } from '@unchainedshop/utils';
+import type { TimestampFields } from '@unchainedshop/mongodb';
+import { Order } from '@unchainedshop/core-orders';
+import { OrderPayment } from '@unchainedshop/core-orders';
+import { UnchainedCore } from '@unchainedshop/core';
+
+export enum PaymentProviderType {
+  CARD = 'CARD',
+  INVOICE = 'INVOICE',
+  GENERIC = 'GENERIC',
+}
+
+export type PaymentConfiguration = Array<{
+  key: string;
+  value: string | null;
+}>;
+
+export type PaymentProvider = {
+  _id?: string;
+  type: PaymentProviderType;
+  adapterKey: string;
+  configuration: PaymentConfiguration;
+} & TimestampFields;
+
+export type PaymentCredentials = {
+  _id?: string;
+  paymentProviderId: string;
+  userId: string;
+  token?: string;
+  isPreferred?: boolean;
+  meta: any;
+} & TimestampFields;
+
+export enum PaymentError {
+  ADAPTER_NOT_FOUND = 'ADAPTER_NOT_FOUND',
+  NOT_IMPLEMENTED = 'NOT_IMPLEMENTED',
+  INCOMPLETE_CONFIGURATION = 'INCOMPLETE_CONFIGURATION',
+  WRONG_CREDENTIALS = 'WRONG_CREDENTIALS',
+}
+
+export interface PaymentContext {
+  userId?: string;
+  order?: Order;
+  orderPayment?: OrderPayment;
+  transactionContext?: any; // User for singing and charging a payment
+  token?: any; // Used for validation
+  meta?: any;
+}
+
+export type ChargeResult = {
+  transactionId?: string;
+  [key: string]: any;
+};
+
+export type PaymentChargeActionResult = ChargeResult & {
+  credentials?: {
+    token: string;
+    [key: string]: any;
+  };
+};
+export interface IPaymentActions {
+  charge: (transactionContext?: any) => Promise<PaymentChargeActionResult | false>;
+  configurationError: (transactionContext?: any) => PaymentError;
+  isActive: (transactionContext?: any) => boolean;
+  isPayLaterAllowed: (transactionContext?: any) => boolean;
+  register: (transactionContext?: any) => Promise<any>;
+  sign: (transactionContext?: any) => Promise<string>;
+  validate: (token?: any) => Promise<boolean>;
+  cancel: (transactionContext?: any) => Promise<boolean>;
+  confirm: (transactionContext?: any) => Promise<boolean>;
+}
+
+export type IPaymentAdapter = IBaseAdapter & {
+  initialConfiguration: PaymentConfiguration;
+
+  typeSupported: (type: PaymentProviderType) => boolean;
+
+  actions: (params: {
+    config: PaymentConfiguration;
+    paymentContext: PaymentContext & {
+      paymentProviderId: string;
+      paymentProvider: PaymentProvider;
+    };
+    context: UnchainedCore;
+  }) => IPaymentActions;
+};
+
+export type IPaymentDirector = IBaseDirector<IPaymentAdapter> & {
+  actions: (
+    paymentProvider: PaymentProvider,
+    paymentContext: PaymentContext,
+    unchainedAPI: UnchainedCore,
+  ) => Promise<IPaymentActions>;
+};
+
+/*
+ * Module
+ */
+
+export interface PaymentInterface {
+  _id: string;
+  label: string;
+  version: string;
+}
+
+/*
+ * Settings
+ */

package/lib/db/PaymentCredentialsSchema.d.ts

@@ -1,3 +0,0 @@
-import SimpleSchema from 'simpl-schema';
-export declare const PaymentCredentialsSchema: SimpleSchema;
-//# sourceMappingURL=PaymentCredentialsSchema.d.ts.map

package/lib/db/PaymentCredentialsSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PaymentCredentialsSchema.d.ts","sourceRoot":"","sources":["../../src/db/PaymentCredentialsSchema.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,eAAO,MAAM,wBAAwB,cAUpC,CAAC"}

package/lib/db/PaymentCredentialsSchema.js

@@ -1,11 +0,0 @@
-import { Schemas } from '@unchainedshop/utils';
-import SimpleSchema from 'simpl-schema';
-export const PaymentCredentialsSchema = new SimpleSchema({
-    paymentProviderId: { type: String, required: true },
-    userId: { type: String, required: true },
-    token: String,
-    isPreferred: Boolean,
-    meta: { type: Object, blackbox: true },
-    ...Schemas.timestampFields,
-}, { requiredByDefault: false });
-//# sourceMappingURL=PaymentCredentialsSchema.js.map

package/lib/db/PaymentCredentialsSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PaymentCredentialsSchema.js","sourceRoot":"","sources":["../../src/db/PaymentCredentialsSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,YAAY,CACtD;IACE,iBAAiB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACnD,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACxC,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,OAAO;IACpB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACtC,GAAG,OAAO,CAAC,eAAe;CAC3B,EACD,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAC"}

package/lib/db/PaymentProvidersSchema.d.ts

@@ -1,3 +0,0 @@
-import SimpleSchema from 'simpl-schema';
-export declare const PaymentProvidersSchema: SimpleSchema;
-//# sourceMappingURL=PaymentProvidersSchema.d.ts.map

package/lib/db/PaymentProvidersSchema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PaymentProvidersSchema.d.ts","sourceRoot":"","sources":["../../src/db/PaymentProvidersSchema.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,eAAO,MAAM,sBAAsB,cAWlC,CAAC"}

package/lib/db/PaymentProvidersSchema.js

@@ -1,12 +0,0 @@
-import { Schemas } from '@unchainedshop/utils';
-import SimpleSchema from 'simpl-schema';
-export const PaymentProvidersSchema = new SimpleSchema({
-    type: { type: String, required: true },
-    adapterKey: { type: String, required: true },
-    configuration: { type: Array },
-    'configuration.$': { type: Object },
-    'configuration.$.key': { type: String },
-    'configuration.$.value': { type: String },
-    ...Schemas.timestampFields,
-}, { requiredByDefault: false });
-//# sourceMappingURL=PaymentProvidersSchema.js.map

package/lib/db/PaymentProvidersSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PaymentProvidersSchema.js","sourceRoot":"","sources":["../../src/db/PaymentProvidersSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,YAAY,CACpD;IACE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IACtC,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC5C,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;IAC9B,iBAAiB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;IACnC,qBAAqB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;IACvC,uBAAuB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;IACzC,GAAG,OAAO,CAAC,eAAe;CAC3B,EACD,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAC7B,CAAC"}

package/src/db/PaymentCredentialsSchema.ts

@@ -1,14 +0,0 @@
-import { Schemas } from '@unchainedshop/utils';
-import SimpleSchema from 'simpl-schema';
-
-export const PaymentCredentialsSchema = new SimpleSchema(
-  {
-    paymentProviderId: { type: String, required: true },
-    userId: { type: String, required: true },
-    token: String,
-    isPreferred: Boolean,
-    meta: { type: Object, blackbox: true },
-    ...Schemas.timestampFields,
-  },
-  { requiredByDefault: false },
-);

package/src/db/PaymentProvidersSchema.ts

@@ -1,15 +0,0 @@
-import { Schemas } from '@unchainedshop/utils';
-import SimpleSchema from 'simpl-schema';
-
-export const PaymentProvidersSchema = new SimpleSchema(
-  {
-    type: { type: String, required: true },
-    adapterKey: { type: String, required: true },
-    configuration: { type: Array },
-    'configuration.$': { type: Object },
-    'configuration.$.key': { type: String },
-    'configuration.$.value': { type: String },
-    ...Schemas.timestampFields,
-  },
-  { requiredByDefault: false },
-);