@starfish-codes/hellgate 2.0.0-beta.4 → 2.0.0-beta.6

package/README.md

@@ -3,66 +3,12 @@
 [![CI](https://github.com/starfish-codes/hgate2-headless-web-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/starfish-codes/hgate2-headless-web-sdk/actions/workflows/ci.yml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/starfish-codes/hgate2-headless-web-sdk/graph/badge.svg?token=bw5V0iIWHe)](https://codecov.io/gh/starfish-codes/hgate2-headless-web-sdk)
 
-## Documentation
+## Communication Channels
 
-https://developer.hellgate.dev
+- **Hellgate:** https://hellgate.io/
 
-## Development
+- **Developer Documentation:** https://developer.hellgate.io/sdks/web-sdk
 
-### Install Dependencies
+- **API Reference:** https://api-reference.hellgate.io/
 
-```
-yarn
-```
-
-### Start Iframe App in dev mode
-
-```
-yarn iframe
-```
-
-Should be available on http://localhost:4044
-
-### Start Demo App in dev mode (Iframe app running is required)
-
-1. Create `demo/.env.dev` by copying `demo/.env.dev.example` (VITE_API_KEY is optional)
-
-```
-cp demo/.env.dev.example demo/.env.dev
-```
-
-2. Run demo app
-
-```
-yarn demo
-```
-
-Open http://localhost:4040
-
-### Run tests locally in dev mode (Iframe app running is required)
-
-1. Create `.env.test` by copying `.env.test.example`. (VITE_BT_API_KEY is required)
-
-```
-cp .env.test.example .env.test
-```
-
-2. Run tests
-
-```
-yarn test
-```
-
-### Run linter
-
-```
-yarn lint
-```
-
-## Production build
-
-```
-yarn build
-```
-
-Check `dist` folder
+- **Support contact:** hellgate.products@starfish.team.

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

@@ -1,9 +1,9 @@
 import { BasisTheory as IBasisTheory } from '@basis-theory/basis-theory-js/types/sdk';
 import { HellgateSession } from '../session';
 import { CreateCardFieldsOptions, CreateCardFormOptions, PaymentAdditionalData, TokenizedData } from './typings';
-import { CardElement, CardExpirationDateElement, CardNumberElement, CardVerificationCodeElement } from './ui/elements';
-import { CardValue, ChangeEvent, ElementBaseOptions } from './ui/typings';
-export type FormFieldState = Omit<ChangeEvent<CardValue>['data'], 'type'>;
+import { CardElement, CardExpirationDateElement, CardNumberElement, CardVerificationCodeElement, TextElement } from './ui/elements';
+import { ChangeEvent, ElementBaseOptions } from './ui/typings';
+export type FormFieldState = Omit<ChangeEvent<never>['data'], 'type'>;
 export declare class HellgateCardHandler {
     session: HellgateSession;
     private bt;
@@ -18,7 +18,7 @@ export declare class HellgateCardHandler {
         expiryDate: CardExpirationDateElement;
         securityCode: CardVerificationCodeElement;
     };
-    createTextField: (options?: ElementBaseOptions) => import("./ui/elements/text-element").TextElement;
+    createTextField: (options?: ElementBaseOptions) => TextElement;
     tokenize: () => Promise<TokenizedData>;
     onStateChange: (fn: (state: FormFieldState) => void) => void;
     clear: () => void;

package/dist/card/typings.d.ts

@@ -1,3 +1,4 @@
+import { TextElement } from './ui/';
 import { ElementBaseOptions } from './ui/typings';
 export type CreateCardFormOptions = Pick<ElementBaseOptions, 'style' | 'disabled' | 'autocomplete' | 'placeholder' | 'ariaLabel'> & {
     icon?: 'left' | 'right' | 'none';
@@ -7,16 +8,17 @@ export type CreateCardFieldsOptions = Pick<ElementBaseOptions, 'style' | 'disabl
     expiryDate?: ElementBaseOptions;
     securityCode?: ElementBaseOptions;
 };
-export type PaymentAdditionalData = {
-    cardholder_name?: string;
-    email?: string;
+export type AdditionalDataValue = string | TextElement;
+export type PaymentAdditionalData<FieldValue = AdditionalDataValue> = {
+    cardholder_name?: FieldValue;
+    email?: FieldValue;
     billing_address?: {
-        line1?: string;
-        line2?: string;
-        line3?: string;
-        postal_code?: string;
-        city?: string;
-        country?: string;
+        line1?: FieldValue;
+        line2?: FieldValue;
+        line3?: FieldValue;
+        postal_code?: FieldValue;
+        city?: FieldValue;
+        country?: FieldValue;
     };
 };
 export type TokenizeData = Record<string, unknown>;

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

@@ -4,18 +4,18 @@ export declare abstract class CardElementBase<Value, IframeValue = string> {
     readonly options: ElementBaseOptions<Value>;
     private iframe;
     private subscriptions;
-    value: Value | null;
     protected abstract type: ElementType;
     protected abstract extractValue: (rawValue: IframeValue | null) => Value | null;
     protected abstract putValue: (rawValue: Value | null) => IframeValue | null;
-    constructor(options: ElementBaseOptions<Value>);
+    constructor(options: ElementBaseOptions<Value>, key?: string);
     mount(selector: string | Element): Promise<void>;
     update: ({ ...data }: ElementBaseOptions<Value>) => Promise<void>;
     clear: () => void;
     focus: () => void;
     blur: () => void;
     unmount: () => void;
-    on<T extends EventType>(eventType: T, listener: (event: FindByType<Explicit<CardElementEvents<Value>>, T>['data']) => void): Subscription;
+    on<T extends EventType>(eventType: T, listener: (event: FindByType<Explicit<CardElementEvents<never>>, T>['data']) => void): Subscription;
+    secureValue(key: string): Value | null;
     private emitEvent;
     private iframePostMessage;
 }

package/dist/card/ui/elements/card-expiration-date.d.ts

@@ -9,6 +9,4 @@ export declare class CardExpirationDateElement extends CardElementBase<CardExpir
     protected type: ElementType;
     protected extractValue: typeof extractExpiryDateValue;
     protected putValue: typeof putExpiryDateValue;
-    month: () => number | null;
-    year: () => number | null;
 }

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

@@ -2,4 +2,5 @@ export * from './card';
 export * from './card-expiration-date';
 export * from './card-number';
 export * from './card-verification-code';
+export * from './text-element';
 export * from './utils';

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

@@ -11,5 +11,6 @@ type Elements = {
     cardVerificationCode: CardVerificationCodeElement;
     text: TextElement;
 };
-export declare function createElement<T extends keyof Elements>(type: T, options: ElementBaseOptions): Elements[T];
+export declare function createElement<T extends keyof Elements>(type: T, options: ElementBaseOptions, key?: string): Elements[T];
+export declare function uid(): string;
 export {};

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

@@ -16,7 +16,7 @@ type ChangeEvent<Value> = BaseEvent<'change', {
     complete: boolean;
     valid?: boolean;
     error?: string;
-    value: Value | null;
+    value: Value extends never ? never : Value | null;
 }>;
 type InputFocusEvent = BaseEvent<'focus'>;
 type InputBlurEvent = BaseEvent<'blur'>;