@starfish-codes/hellgate 3.3.0 → 3.5.0

package/README.md

@@ -7,6 +7,6 @@
 
 - **Hellgate:** https://hellgate.io/
 
-- **Developer Documentation:** https://developer.hellgate.io/sdks/web-sdk
+- **Developer Documentation:** https://developer.hellgate.io/resources/sdks/WebSDK/web-sdk
 
 - **API Reference:** https://api-reference.hellgate.io/

package/dist/card/card-handler.d.ts

@@ -1,20 +1,20 @@
 import { BasisTheory as IBasisTheory } from '@basis-theory/basis-theory-js/types/sdk';
 import { CompleteActionResult, HellgateSession } from '../session';
-import { CreateCardFieldsOptions, CreateCardFormOptions, PaymentAdditionalData, TokenizeCardConfig, TokenizedData } from './typings';
+import { CreateCardFieldsOptions, CreateCardFormOptions, PaymentAdditionalData, RefreshSecurityCodeSessionStateDTO, TokenizeCardSessionStateDTO, TokenizedData } from './typings';
 import { CardElement, CardExpirationDateElement, CardNumberElement, CardVerificationCodeElement, TextElement } from './ui/elements';
 import { ChangeEvent, ElementBaseOptions } from './ui/typings';
 export type FormFieldState = Omit<ChangeEvent<never>['data'], 'type'>;
+export type CardHandlerSessionInitState = TokenizeCardSessionStateDTO | RefreshSecurityCodeSessionStateDTO;
 export declare class HellgateCardHandler {
-    session: HellgateSession;
-    private tokenizeConfig;
+    session: HellgateSession<CardHandlerSessionInitState>;
     private bt?;
-    private cardAdditionalData?;
     state: FormFieldState;
     private cardElements;
     private textElements;
     private stateChangeHandlers;
-    static init(session: HellgateSession, tokenizeConfig: TokenizeCardConfig): Promise<HellgateCardHandler>;
-    constructor(session: HellgateSession, tokenizeConfig: TokenizeCardConfig, bt?: IBasisTheory | undefined, cardAdditionalData?: PaymentAdditionalData<string> | undefined);
+    readonly cvcOnlyEnabled: boolean;
+    static init(session: HellgateSession<CardHandlerSessionInitState>): Promise<HellgateCardHandler>;
+    constructor(session: HellgateSession<CardHandlerSessionInitState>, bt?: IBasisTheory | undefined);
     createForm: (options?: CreateCardFormOptions) => CardElement;
     createFormFields: (options?: CreateCardFieldsOptions) => {
         cardNumber: CardNumberElement;
@@ -22,14 +22,14 @@ export declare class HellgateCardHandler {
         securityCode: CardVerificationCodeElement;
     };
     createTextField: (options?: ElementBaseOptions) => TextElement;
-    tokenize: () => Promise<TokenizedData | {
-        token_id: string;
-    } | null>;
+    tokenize: (additionalData: PaymentAdditionalData) => Promise<TokenizedData | null>;
     onStateChange: (fn: (state: FormFieldState) => void) => void;
     clear: () => void;
     reset: () => void;
     dispose: () => void;
     process: (additionalData?: PaymentAdditionalData) => Promise<CompleteActionResult>;
+    private refreshSecurityCode;
+    private getFormValue;
     private hasFormElements;
     private disableFormElements;
     private extractAdditionalData;

package/dist/card/typings.d.ts

@@ -1,13 +1,16 @@
 import { JWK } from 'jose';
 import { TextElement } from './ui/';
-import { ElementBaseOptions } from './ui/typings';
+import { IconPosition } from './ui/iframe/elements/card-number';
+import { CardSchema, ElementBaseOptions } from './ui/typings';
 export type CreateCardFormOptions = Pick<ElementBaseOptions, 'style' | 'disabled' | 'autocomplete' | 'placeholder' | 'ariaLabel'> & {
-    icon?: 'left' | 'right' | 'none';
+    icon?: IconPosition;
+    schemes?: CardSchema[];
 };
 export type CreateCardFieldsOptions = Pick<ElementBaseOptions, 'style' | 'disabled' | 'autocomplete'> & {
     cardNumber?: ElementBaseOptions;
     expiryDate?: ElementBaseOptions;
     securityCode?: ElementBaseOptions;
+    schemes?: CardSchema[];
 };
 export type AdditionalDataValue = string | TextElement;
 export type PaymentAdditionalData<FieldValue = AdditionalDataValue> = {
@@ -32,12 +35,11 @@ export type TokenizedData = {
     enc_payload: string;
 } | {
     token_id: string;
+    additional_data?: PaymentAdditionalData;
 };
 export type TokenizeCardActionDTO = {
     action: 'tokenize_card';
-    result: TokenizedData & {
-        additional_data?: PaymentAdditionalData;
-    };
+    result: TokenizedData;
 };
 export type TokenizeCardConfig = {
     provider: 'guardian';
@@ -58,4 +60,24 @@ export type CardTokenizeData = {
     expiry_year: number;
     security_code: string;
     cardholder_name?: string;
+    additional_data: PaymentAdditionalData<string>;
+};
+export type TokenizedCardMaskedData = {
+    account_number_last_four: string;
+    account_number_length: number;
+    issuer_identification_number: string;
+    expiry_month: number;
+    expiry_year: number;
+    scheme: CardSchema;
+    jwk: JWK;
+};
+export type RefreshSecurityCodeSessionStateDTO = {
+    next_action: 'refresh_security_code';
+    data: TokenizedCardMaskedData;
+};
+export type RefreshSecurityCodeActionDTO = {
+    action: 'refresh_security_code';
+    result: {
+        enc_payload: string;
+    };
 };

package/dist/card/ui/constants.d.ts

@@ -3,6 +3,6 @@ export declare const ELEMENTS_INIT_ERROR_MESSAGE = "WebSDK Elements was not prop
 export declare const ELEMENTS_NON_DOM_ERROR_MESSAGE = "Tried to load WebSDKElements in a non-DOM environment.";
 export declare const ELEMENTS_SCRIPT_LOAD_ERROR_MESSAGE = "WebSDK Elements did not load properly.";
 export declare const ELEMENTS_SCRIPT_UNKNOWN_ERROR_MESSAGE = "There was an unknown error when loading WebSDK Elements. Check the console for details.";
-export declare const CARD_BRANDS: readonly ["visa", "mastercard", "american-express", "discover", "diners-club", "jcb", "unionpay", "maestro", "elo", "hiper", "hipercard", "mir", "unknown"];
+export declare const CARD_SCHEMAS: readonly ["visa", "mastercard", "american-express", "discover", "diners-club", "jcb", "unionpay"];
 export declare const CARD_ICON_POSITIONS: readonly ["left", "right", "none"];
 export declare const AUTOCOMPLETE_VALUES: readonly ["off", "on"];

package/dist/card/ui/iframe/elements/base-element.d.ts

@@ -26,6 +26,7 @@ export declare abstract class IframeCardElementBase implements BaseElement<Eleme
     blur(): void;
     clear(): void;
     updateCardType(cardTypeName: string | undefined): void;
+    updateState(): void;
     update(options: ElementBaseOptions): Promise<void>;
     on<T extends EventType>(eventType: T, listener: ElementEventListener<CardElementEvents<string>, T>): Subscription;
     private emitEvent;

package/dist/card/ui/iframe/elements/card-number.d.ts

@@ -9,4 +9,5 @@ export declare class IframeCardNumber extends IframeCardElementBase implements I
     update(options: ElementBaseOptions): Promise<void>;
     protected validate(masked: Masked): ElementMetadata & CardNumberAdditionalData;
     protected renderHTML(): string;
+    private getCardType;
 }

package/dist/card/ui/index.d.ts

@@ -1 +1,3 @@
+export { CARD_SCHEMAS } from './constants';
 export * from './elements';
+export { type CardSchema } from './typings';

package/dist/card/ui/typings.d.ts

@@ -1,3 +1,4 @@
+import { CARD_SCHEMAS } from './constants';
 import { IconPosition } from './iframe/elements/card-number';
 import { ElementStyle } from './styles';
 export type ListenableKey = 'Escape' | 'Enter';
@@ -59,10 +60,12 @@ export type ElementBaseOptions<Value = unknown> = {
     style?: ElementStyle;
     height?: string;
     disabled?: boolean;
+    cvcOnly?: boolean;
     autocomplete?: 'on' | 'off';
     placeholder?: string;
     ariaLabel?: string;
     icon?: IconPosition;
+    schemes?: CardSchema[];
     value?: Value;
 };
 /**
@@ -85,3 +88,4 @@ export type CardValue = {
     cvc: string | null;
 };
 export type ICardElement<Value = CardValue> = BaseElement<ElementBaseOptions, CardElementEvents<Value>, Value>;
+export type CardSchema = (typeof CARD_SCHEMAS)[number];

package/dist/card/ui/utils.d.ts

@@ -0,0 +1,2 @@
+import { TokenizedCardMaskedData } from '../typings';
+export declare function getMaskedCardNumber(data: TokenizedCardMaskedData): string;