feat: add setValue method to elements, other qol improvements (#248)

Basis-Theory · Nov 16, 2022 · cac105a · cac105a
1 parent 999d5a0
commit cac105a
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 15 deletions.
diff --git a/src/BasisTheory.ts b/src/BasisTheory.ts
@@ -85,12 +85,12 @@ export class BasisTheory
   private _proxies?: Proxies;
 
   public init(
-    apiKey: string,
+    apiKey: string | undefined,
     options?: BasisTheoryInitOptionsWithoutElements
   ): Promise<IBasisTheory>;
 
   public init(
-    apiKey: string,
+    apiKey: string | undefined,
     options: BasisTheoryInitOptionsWithElements
   ): Promise<IBasisTheory & BasisTheoryElements>;
 

diff --git a/src/elements/services/tokens.ts b/src/elements/services/tokens.ts
@@ -49,7 +49,9 @@ const delegateTokens = (
     public retrieve(
       id: string,
       requestOptions?: RequestOptions
-    ): Promise<Token> {
+      // avoid casting when accessing token data props
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ): Promise<Token<any>> {
       if (elements !== undefined) {
         return elements.tokens.retrieve(id, requestOptions);
       }

diff --git a/src/tokens/BasisTheoryTokens.ts b/src/tokens/BasisTheoryTokens.ts
@@ -39,7 +39,12 @@ export const BasisTheoryTokens = new CrudBuilder(
       super(_options);
     }
 
-    public retrieve(id: string, options: RequestOptions = {}): Promise<Token> {
+    public retrieve(
+      id: string,
+      options: RequestOptions = {}
+      // avoid casting when accessing token data props
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ): Promise<Token<any>> {
       const url = `/${id}`;
 
       return this.client

diff --git a/src/types/elements/elements.ts b/src/types/elements/elements.ts
@@ -19,8 +19,11 @@ import type {
   UpdateCardExpirationDateElementOptions,
   UpdateCardVerificationCodeElementOptions,
   UpdateTextElementOptions,
+  CardElementValue,
+  CardExpirationDateValue,
 } from './options';
 import type { Tokenize, Tokens } from './services';
+import { DataElementReference } from './shared';
 
 interface BaseElement<UpdateOptions, ElementEvents> {
   readonly mounted: boolean;
@@ -36,27 +39,36 @@ interface BaseElement<UpdateOptions, ElementEvents> {
   ): Subscription;
 }
 
-type CardElement = BaseElement<UpdateCardElementOptions, CardElementEvents>;
+type CardElement = BaseElement<UpdateCardElementOptions, CardElementEvents> & {
+  setValue(value: CardElementValue<'reference'>): void;
+};
 
-type TextElement = BaseElement<UpdateTextElementOptions, TextElementEvents>;
+type TextElement = BaseElement<UpdateTextElementOptions, TextElementEvents> & {
+  setValue(value: DataElementReference): void;
+};
 
 type CardNumberElement = BaseElement<
   UpdateCardNumberElementOptions,
   CardNumberElementEvents
->;
+> & {
+  setValue(value: DataElementReference): void;
+};
 
 type CardExpirationDateElement = BaseElement<
   UpdateCardExpirationDateElementOptions,
   CardExpirationDateElementEvents
 > & {
   month(): ElementWrapper<CardExpirationDateElement>;
   year(): ElementWrapper<CardExpirationDateElement>;
+  setValue(value: CardExpirationDateValue<'reference'>): void;
 };
 
 type CardVerificationCodeElement = BaseElement<
   UpdateCardVerificationCodeElementOptions,
   CardVerificationCodeElementEvents
->;
+> & {
+  setValue(value: DataElementReference): void;
+};
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type ElementWrapper<T extends BaseElement<any, any> = BaseElement<any, any>> = {

diff --git a/src/types/elements/options.ts b/src/types/elements/options.ts
@@ -58,15 +58,15 @@ interface CardElementValue<T extends ElementValueType> {
   number?: T extends 'reference' ? DataElementReference : string;
   // disabling camecalse so that the element value matches the API data
   /* eslint-disable camelcase */
-  expiration_month?: T extends 'reference' ? DataElementReference : string;
-  expiration_year?: T extends 'reference' ? DataElementReference : string;
+  expiration_month?: T extends 'reference' ? DataElementReference : number;
+  expiration_year?: T extends 'reference' ? DataElementReference : number;
   /* eslint-enable camelcase */
   cvc?: T extends 'reference' ? DataElementReference : string;
 }
 
 interface CardExpirationDateValue<T extends ElementValueType> {
-  month: T extends 'reference' ? DataElementReference : string;
-  year: T extends 'reference' ? DataElementReference : string;
+  month: T extends 'reference' ? DataElementReference : number;
+  year: T extends 'reference' ? DataElementReference : number;
 }
 
 type CreateCardElementOptions = CustomizableElementOptions & {
@@ -104,7 +104,7 @@ type CreateCardExpirationDateElementOptions = CustomizableElementOptions &
   Pick<ElementOptions, 'placeholder'> &
   Required<Pick<ElementOptions, 'targetId'>> & {
     'aria-label'?: string;
-    value?: CardExpirationDateValue<'static'>;
+    value?: CardExpirationDateValue<'static'> | string;
   };
 
 type UpdateCardExpirationDateElementOptions = Omit<

diff --git a/src/types/elements/services/tokens.ts b/src/types/elements/services/tokens.ts
@@ -10,7 +10,9 @@ type CreateToken = CreateTokenModel<ElementValue>;
 type UpdateToken = UpdateTokenModel<ElementValue>;
 
 type Tokens = Create<Token, CreateToken> &
-  Retrieve<Token> &
+  // avoid casting when accessing token data props
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Retrieve<Token<any>> &
   Update<Token, UpdateToken>;
 
 export type { Tokens, CreateToken, UpdateToken };
diff --git a/src/types/sdk/services/tokens.ts b/src/types/sdk/services/tokens.ts
@@ -30,7 +30,9 @@ interface SearchTokensRequest {
 interface Tokens
   extends Create<Token, CreateToken>,
     Update<Token, UpdateToken>,
-    Retrieve<Token>,
+    // avoid casting when accessing token data props
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    Retrieve<Token<any>>,
     Delete,
     List<Token, ListTokensQuery> {
   createAssociation(