@chargehive/types 2.0.0

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 | null;
+  companyName: string | null;
+  address1: string;
+  address2: string | null;
+  address3: string | null;
+  city: string;
+  county: string;
+  country: string;
+  postal: string;
+}

package/chargehive.d.ts

@@ -0,0 +1,263 @@
+import {FieldName as PCIBFieldName, PCIBridgeTokenizeResponse} from '@pci-bridge/types/pcibridge';
+import {FieldValidation} from '@pci-bridge/types/validation';
+import {Address, Person} from './address';
+
+declare global
+{
+  /* eslint-disable no-var */
+  // noinspection ES6ConvertVarToLetConst
+  var ChargeHive: ChargeHiveType;
+  /* eslint-enable 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
+{
+  /**
+   * PCIBridge Major Version
+   */
+  get version(): string;
+
+  initialize(placementToken: string, projectId: string, options: ChargeHiveInitOptions);
+
+  validate(field?: FieldName, timeout?: number): Promise<Map<FieldName, FieldValidation>>;
+
+  tokenize(): Promise<TokenizeResponse>;
+
+  authorize(): Promise<AuthorizeResponse>;
+
+  clear(field: FieldName);
+
+  setNameOnCard(value: string);
+
+  setCardExpiry(month: number, year: number);
+
+  setPaymentMethod<T extends PaymentMethodType>(type: T, data: PaymentMethodDataTypes[T]): void;
+}
+
+export interface ChargeHiveInitOptions
+{
+  billingProfileID: string;
+  country: string;
+  currency: string;
+  environment?: ChargeEnvironment;
+}
+
+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: {}
+  PLACEMENT_CAPABILITY_APPLE_PAY: {
+    initiativeContext: string;
+    sessionUrl: string;
+    session: string;
+    token: string;
+  }
+  PLACEMENT_CAPABILITY_GOOGLE_PAY: {
+    description: string;
+    cardDetails: string;
+    cardNetwork: string;
+    token: string;
+  }
+  PLACEMENT_CAPABILITY_DIRECTDEBIT_FORM: {
+    accountName: string;
+    accountNum: string;
+    sortCode: string;
+    payerReference: string;
+  }
+};
+
+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
+{
+  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 =
+  | 'init'
+  | 'token'
+  | 'success'
+  | 'declined'
+  | 'error'
+  | 'cancel'
+  | 'authentication'
+  | 'ready'
+  | 'paste'
+  | 'all-valid'
+  | 'submit'
+  | 'method-type-changed'
+  | 'charge-created'
+  | 'charge-id';
+
+export type ChargeHiveEventType = Extract<EventName, 'token' | 'success' | 'declined' | 'authentication'>
+
+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;
+  }
+}
+
+export type Dictionary = { [key: PropertyKey]: string };
+
+export interface AuthorizeResponse
+{
+  result: string;
+  message: string;
+  continuationId: string;
+  chargeId: string;
+  events: ChargeHiveEvent[];
+}
+
+export interface ChargeHiveEvent<T extends ChargeHiveEventType = any>
+{
+  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,12 @@
+{
+  "name": "@chargehive/types",
+  "types": "chargehive.d.ts",
+  "private": false,
+  "files": [
+    "*.d.ts"
+  ],
+  "dependencies": {
+    "@pci-bridge/types": "^1.1.0"
+  },
+  "version": "2.0.0"
+}

package/validation.d.ts

@@ -0,0 +1,3 @@
+import {FieldValidation as PCIBFieldValidation} from '@pci-bridge/types/validation';
+
+export type FieldValidation = PCIBFieldValidation