@chargehive/types 1.0.18

package/address.d.ts

@@ -0,0 +1,23 @@
+export interface Person
+{
+  title?: string;
+  firstName: string;
+  lastName: string;
+  fullName: string;
+  email: string;
+  phone?: string;
+  language?: string;
+}
+
+export interface Address
+{
+  fao?: string;
+  companyName?: string;
+  address1: string;
+  address2?: string;
+  address3?: string;
+  city: string;
+  county: string;
+  country: string;
+  postal: string;
+}

package/chargehive.d.ts

@@ -0,0 +1,355 @@
+import {
+  FieldName as PCIBFieldName,
+  EventName as PCIBEventName,
+  PCIBridgeTokenizeResponse,
+  PCIBridgeTokenizeEphemeralResponse,
+} from '@pci-bridge/types/pcibridge';
+import {FieldValidation} from '@pci-bridge/types/validation';
+import {Address, Person} from './address';
+import ApplePayPaymentToken = ApplePayJS.ApplePayPaymentToken;
+
+type EmptyObject = Record<string, never>;
+
+declare global
+{
+  // noinspection ES6ConvertVarToLetConst
+  var ChargeHive: ChargeHiveType; // eslint-disable-line no-var
+}
+
+declare type FieldName = PCIBFieldName;
+
+export interface ChargeHiveEventTarget extends Omit<EventTarget, 'dispatchEvent'>
+{
+  addEventListener(
+    type: EventName, callback: EventListenerOrEventListenerObject | null,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+
+  removeEventListener(
+    type: EventName, callback: EventListenerOrEventListenerObject | null,
+    options?: EventListenerOptions | boolean,
+  ): void;
+
+  triggerEvent(type: EventName, data?: object);
+}
+
+export interface ChargeHiveType extends ChargeType, ChargeHiveEventTarget
+{
+  /**
+   * Chargehive Major Version
+   */
+  readonly version: string;
+
+  initialize(options: ChargeHiveInitOptions);
+
+  isInitialized(): boolean;
+
+  readonly getInitOptions: ChargeHiveInitOptions | undefined;
+
+  getInitResponse(): InitResponse | undefined;
+
+  validate(field?: FieldName, timeout?: number): Promise<Map<FieldName, FieldValidation>>;
+
+  tokenize(): Promise<TokenizeResponse>;
+
+  tokenizeEphemeral<T extends PaymentMethodType>(): Promise<PaymentMethodEphemeralDataTypes[T]>;
+
+  authorize(): Promise<AuthorizeResponse>;
+
+  clear(field: FieldName);
+
+  setNameOnCard(value: string);
+
+  setCardExpiry(month: number, year: number);
+
+  setPaymentMethod<T extends PaymentMethodType>(type: T, data?: object | PaymentMethodDataTypes[T]): void;
+}
+
+export interface WalletOptions
+{
+  /**
+   * @default true
+   */
+  requireEmail?: boolean;
+  /**
+   * @default true
+   */
+  requireBillingAddress?: boolean;
+  /**
+   * @default false
+   */
+  requireBillingPhone?: boolean;
+  /**
+   * @default false
+   */
+  requireShippingAddress?: boolean;
+  /**
+   * @default false
+   */
+  requireShippingPhone?: boolean;
+}
+
+export interface ChargeHiveInitOptions
+{
+  projectId: string;
+  projectPlacement: string;
+  merchantHash: string;
+  merchantPlacement: string;
+  country: string;
+  currency: string;
+  environment?: ChargeEnvironment;
+  walletOptions?: WalletOptions;
+}
+
+export interface InitResponse
+{
+  riskCheckers: { [key: string]: RiskChecker };
+  capabilities: PaymentMethodType[];
+  serverTime: number;
+  sandboxMode: boolean;
+  defaultPaymentType: PaymentMethodType;
+  projectName: string;
+}
+
+export type RiskChecker = {
+  [key: string]: string;
+}
+
+export type PaymentMethodType =
+  | 'PLACEMENT_CAPABILITY_TOKEN'
+  | 'PLACEMENT_CAPABILITY_CARD_FORM'
+  | 'PLACEMENT_CAPABILITY_PAYPAL'
+  | 'PLACEMENT_CAPABILITY_APPLE_PAY'
+  | 'PLACEMENT_CAPABILITY_GOOGLE_PAY'
+  | 'PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM'
+
+export type PaymentMethodDataTypes = {
+  PLACEMENT_CAPABILITY_TOKEN: {
+    token: string;
+  }
+  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeResponse
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  PLACEMENT_CAPABILITY_APPLE_PAY: {
+    initiativeContext?: string;
+    sessionUrl?: string;
+    session?: string;
+    token?: ApplePayPaymentToken;
+  }
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: {
+    description: string | undefined;
+    cardDetails: string | undefined;
+    cardNetwork: google.payments.api.CardNetwork | undefined;
+    token: string;
+  }
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {
+    accountName: string;
+    accountNum: string;
+    sortCode: string;
+    payerReference: string;
+  }
+};
+
+export type PaymentMethodEphemeralDataTypes = {
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
+  PLACEMENT_CAPABILITY_CARD_FORM: PCIBridgeTokenizeEphemeralResponse
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+};
+
+export type PaymentMethodEphemeralTokenizationConfig = {
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
+  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  PLACEMENT_CAPABILITY_APPLE_PAY: EmptyObject
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: EmptyObject
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+};
+
+export type PaymentMethodTokenizationConfig = {
+  PLACEMENT_CAPABILITY_TOKEN: EmptyObject
+  PLACEMENT_CAPABILITY_PAYPAL: EmptyObject
+  PLACEMENT_CAPABILITY_CARD_FORM: EmptyObject
+  PLACEMENT_CAPABILITY_APPLE_PAY: {
+    Session?: string;
+    InitiativeContext?: string;
+    SessionUrl?: string;
+  }
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: {
+    environment?: string;
+    googlePayConfig?: google.payments.api.PaymentDataRequest | string;
+    token?: string;
+  }
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: EmptyObject
+}
+
+export type PaymentMethodAuthenticationTypes = {
+  cvv: string;
+}
+
+export type ChargeEnvironment =
+  | 'CHARGE_ENVIRONMENT_RETAIL'
+  | 'CHARGE_ENVIRONMENT_ECOMMERCE'
+  | 'CHARGE_ENVIRONMENT_MOTO'
+  | 'CHARGE_ENVIRONMENT_RENEWAL';
+
+export interface ChargeMeta
+{
+  customerInfo?: Person;
+  billingAddress?: Address;
+  shippingAddress?: Address;
+  orderItems?: OrderItem[];
+}
+
+export interface ChargeData
+{
+  billingProfileId: string;
+  amount: number;
+  currency: string;
+  references?: Dictionary;
+  labels?: Dictionary;
+  language?: string;
+  meta?: ChargeMeta;
+  connectorId?: string;
+}
+
+export interface ChargeType
+{
+  readonly charge: ChargeData;
+
+  prepareChargeWithId(chargeId: string, cfg: ChargeData): void;
+
+  prepareCharge(merchantReference: string, cfg: ChargeData): void;
+
+  updateCharge(data: ChargeData): void;
+
+  setBillingAddress(address: Address): void;
+
+  setShippingAddress(address: Address): void;
+
+  setCustomerInfo(customer: Person): void;
+
+  setOrderItems(items: OrderItem[]): void;
+
+  addOrderItem(item: OrderItem): void;
+
+  clearOrderItems(): void;
+}
+
+export interface OrderItem
+{
+  subscriptionId: string;
+  renewalNumber: number;
+  duration: number;
+  startDate: number;
+  endDate: number;
+  productType: number;
+  skuType: number;
+  deliveryType: number;
+  quantity?: number;
+  unitPrice: number;
+  taxAmount?: number;
+  discountAmount?: number;
+  name: string;
+  description: string;
+  productCode: string;
+  skuCode: string;
+  termType: number;
+  termUnits: number;
+}
+
+export type EventName = PCIBEventName
+  | 'init'
+  | 'token'
+  | 'token-config'
+  | 'success'
+  | 'declined'
+  | 'error'
+  | 'cancel'
+  | 'authentication'
+  | 'ready'
+  | 'paste'
+  | 'method-type-changed'
+  | 'charge-id';
+
+export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication' | 'error' | 'token-config'>
+
+export type TransactionResponse = {
+  responseCode: string;
+  responseMessage: string;
+  merchantMessage: string;
+  failureType: string;
+  category: string;
+  errorType: string;
+  errorProperties: Dictionary;
+  originatingCode: string;
+  specificErrors: TransactionResponse[];
+}
+
+export type ChargeHiveEventData = {
+  token: {
+    name: string;
+    scheme: string;
+    expiry: string;
+    token: string;
+    additionalData: Dictionary;
+    connectorId: string;
+    customerError: string;
+    merchantError: string;
+  }
+  success: {
+    chargeId: string;
+    transactionId: string;
+    transactedAmount: {
+      currency: string;
+      units: number;
+    };
+    responseBreakdown: TransactionResponse;
+  }
+  declined: {
+    chargeId: string;
+    message: string;
+    responseCode: string;
+    paymentScheme: string;
+    responseBreakdown: TransactionResponse;
+  }
+  authentication: {
+    environment: string;
+    type: string;
+    connector: string;
+    connectorData: Dictionary;
+    paymentType: string;
+  }
+  error: object;
+  'token-config': PaymentMethodTokenizationConfig[PaymentMethodType];
+}
+
+export type Dictionary = { [key: string]: string };
+
+export interface AuthorizeResponse
+{
+  result: string;
+  message: string;
+  continuationId: string;
+  chargeId: string;
+  events: ChargeHiveEvent<ChargeHiveEventType>[];
+}
+
+export interface ChargeHiveEvent<T extends ChargeHiveEventType>
+{
+  type: T;
+  data: ChargeHiveEventData[T];
+}
+
+export interface TokenizeResponse
+{
+  name: string;
+  scheme: string;
+  expiry: string;
+  token: string;
+  additionalData: Dictionary;
+  connectorID: string;
+  customerError: string;
+  merchantError: string;
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@chargehive/types",
+  "types": "chargehive.d.ts",
+  "private": false,
+  "files": [
+    "*.d.ts"
+  ],
+  "dependencies": {
+    "typescript": "^3 || ^4",
+    "@pci-bridge/types": "*"
+  },
+  "version": "1.0.18"
+}

package/validation.d.ts

@@ -0,0 +1,10 @@
+import {
+  FieldValidation as PCIBFieldValidation,
+  CardFieldValidation as PCIBCardFieldValidation,
+} from '@pci-bridge/types/validation';
+
+export type FieldValidation = PCIBFieldValidation
+
+export type CardFieldValidation = PCIBCardFieldValidation
+
+export type ValidationEvent = CustomEvent<FieldValidation | CardFieldValidation>;