feat: add retrieve method, data reference types for reveal elements (#…

…239)

src/elements/services/tokens.ts

@@ -45,6 +45,17 @@ const delegateTokens = (
 
       return super.update(id, payload as UpdateToken, requestOptions);
     }
+
+    public retrieve(
+      id: string,
+      requestOptions?: RequestOptions
+    ): Promise<Token> {
+      if (elements !== undefined) {
+        return elements.tokens.retrieve(id, requestOptions);
+      }
+
+      return super.retrieve(id, requestOptions);
+    }
   };
 
 export { delegateTokens };

src/types/elements/options.ts

@@ -1,4 +1,4 @@
-import { AutoCompleteValue } from './shared';
+import { AutoCompleteValue, DataElementReference } from './shared';
 import type { ElementStyle } from './styles';
 
 const ELEMENTS_TYPES = [
@@ -7,6 +7,7 @@ const ELEMENTS_TYPES = [
   'cardNumber',
   'cardExpirationDate',
   'cardVerificationCode',
+  'data',
 ] as const;
 
 type ElementType = typeof ELEMENTS_TYPES[number];
@@ -49,18 +50,18 @@ type CustomizableElementOptions = Pick<ElementOptions, 'style' | 'disabled'> &
   AutoCompleteOption;
 
 interface CardElementValue {
-  number?: string;
+  number?: DataElementReference;
   // disabling camecalse so that the element value matches the API data
   /* eslint-disable camelcase */
-  expiration_month?: number;
-  expiration_year?: number;
+  expiration_month?: DataElementReference;
+  expiration_year?: DataElementReference;
   /* eslint-enable camelcase */
-  cvc?: string;
+  cvc?: DataElementReference;
 }
 
 interface CardExpirationDateValue {
-  month: number;
-  year: number;
+  month: DataElementReference;
+  year: DataElementReference;
 }
 
 type CreateCardElementOptions = CustomizableElementOptions & {

src/types/elements/services/tokens.ts

@@ -4,11 +4,13 @@ import type {
   UpdateToken as UpdateTokenModel,
   Token,
 } from '@/types/models';
-import type { Create, Update } from '@/types/sdk';
+import type { Create, Retrieve, Update } from '@/types/sdk';
 
 type CreateToken = CreateTokenModel<ElementValue>;
 type UpdateToken = UpdateTokenModel<ElementValue>;
 
-type Tokens = Create<Token, CreateToken> & Update<Token, UpdateToken>;
+type Tokens = Create<Token, CreateToken> &
+  Retrieve<Token> &
+  Update<Token, UpdateToken>;
 
 export type { Tokens, CreateToken, UpdateToken };

src/types/elements/shared.ts

@@ -46,6 +46,15 @@ type CardIconPosition = typeof CARD_ICON_POSITIONS[number];
  */
 type AutoCompleteValue = typeof AUTOCOMPLETE_VALUES[number];
 
+/**
+ * Type used for detokenization responses stored on Data Elements
+ */
+type DataElementReference = {
+  correlationId: string;
+  elementId: string;
+  path: string;
+};
+
 export type {
   FieldErrorType,
   ConfigErrorType,
@@ -57,4 +66,5 @@ export type {
   Brand,
   CardIconPosition,
   AutoCompleteValue,
+  DataElementReference,
 };