idmission-web-sdk 2.6.3-changeset-release-develop-8a04e04 → 2.6.3-changeset-release-develop-c1e1b02

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1178,6 +1178,57 @@ type DocumentCaptureInput = {
1178
1178
  content?: Blob;
1179
1179
  };
1180
1180
 
1181
+ type DocumentCaptureGuideOverlayClassNames = {
1182
+ container?: string;
1183
+ };
1184
+
1185
+ type DocumentCaptureViewClassNames = {
1186
+ cameraFeedWrapper?: string;
1187
+ cameraFeed?: string;
1188
+ previewImage?: string;
1189
+ captureContainer?: string;
1190
+ headingRow?: string;
1191
+ heading?: string;
1192
+ guideOverlay?: DocumentCaptureGuideOverlayClassNames;
1193
+ footerRow?: string;
1194
+ instructions?: string;
1195
+ tamperMessage?: string;
1196
+ buttonsRow?: string;
1197
+ retryCameraAccessBtn?: string;
1198
+ retryCaptureBtn?: string;
1199
+ uploadBtn?: string;
1200
+ uploadProgressBtn?: string;
1201
+ captureBtn?: string;
1202
+ autoCaptureGuidance?: string;
1203
+ manualCaptureHint?: string;
1204
+ reviewContainer?: string;
1205
+ reviewCard?: string;
1206
+ reviewHeading?: string;
1207
+ };
1208
+ type DocumentCaptureViewVerbiage = {
1209
+ headingText?: CustomerSuppliedVerbiage;
1210
+ loadingBtnText?: CustomerSuppliedVerbiage;
1211
+ retryCameraAccessBtnText?: CustomerSuppliedVerbiage;
1212
+ exitBtnText?: CustomerSuppliedVerbiage;
1213
+ tamperingText?: CustomerSuppliedVerbiage;
1214
+ captureBtnText?: CustomerSuppliedVerbiage;
1215
+ capturingBtnText?: CustomerSuppliedVerbiage;
1216
+ retryCaptureBtnText?: CustomerSuppliedVerbiage;
1217
+ uploadBtnText?: CustomerSuppliedVerbiage;
1218
+ uploadingBtnText?: CustomerSuppliedVerbiage;
1219
+ retryUploadBtnText?: CustomerSuppliedVerbiage;
1220
+ successBtnText?: CustomerSuppliedVerbiage;
1221
+ autoCaptureNoDocumentText?: CustomerSuppliedVerbiage;
1222
+ autoCaptureTooCloseText?: CustomerSuppliedVerbiage;
1223
+ autoCaptureTooFarText?: CustomerSuppliedVerbiage;
1224
+ autoCaptureNotStableText?: CustomerSuppliedVerbiage;
1225
+ autoCaptureOutOfFocusText?: CustomerSuppliedVerbiage;
1226
+ autoCaptureHoldStillText?: CustomerSuppliedVerbiage;
1227
+ manualCaptureHintText?: CustomerSuppliedVerbiage;
1228
+ reviewHeadingText?: CustomerSuppliedVerbiage;
1229
+ reviewImageAltText?: CustomerSuppliedVerbiage;
1230
+ };
1231
+
1181
1232
  type Color = {
1182
1233
  '50': string;
1183
1234
  '100': string;
@@ -9925,11 +9976,21 @@ type DocumentCaptureProps = CompatSessionProps & CompatSubmissionIdProps & Compa
9925
9976
  cameraFeedMode?: CameraFeedMode;
9926
9977
  instructions?: ReactNode;
9927
9978
  /** Class names for the component's inner elements, keyed as in 2.x
9928
- * (`DocumentCaptureClassNames`). Keys marked deprecated have no effect in 3.0. */
9929
- classNames?: DocumentCaptureClassNames;
9930
- /** Object containing any verbiage overrides. */
9931
- verbiage?: DocumentCaptureVerbiage;
9979
+ * (`DocumentCaptureClassNames`), plus the 3.0 view's own keys. Keys marked
9980
+ * deprecated have no effect in 3.0. */
9981
+ classNames?: DocumentCaptureClassNames & ForwardedDocumentViewClassNames;
9982
+ /** Verbiage overrides: the 2.x keys plus the 3.0 view's own keys. */
9983
+ verbiage?: DocumentCaptureVerbiage & ForwardedDocumentViewVerbiage;
9932
9984
  };
9985
+ /**
9986
+ * The `DocumentCaptureView` keys `DocumentCapture` forwards untouched: its
9987
+ * mapper spreads the whole `classNames` and `verbiage` bags into the view, so
9988
+ * the view's own keys (the auto-capture guidance copy, for one) work here too.
9989
+ * The tamper-message keys are left out because the mapper always sets them
9990
+ * from the 2.x tamper seal.
9991
+ */
9992
+ type ForwardedDocumentViewClassNames = Omit<DocumentCaptureViewClassNames, 'tamperMessage'>;
9993
+ type ForwardedDocumentViewVerbiage = Omit<DocumentCaptureViewVerbiage, 'tamperingText'>;
9933
9994
  /** The prop surface both customer-match flows share. */
9934
9995
  type CompatCustomerMatchProps = CompatSessionProps & CompatSubmissionIdProps & CompatSubmissionFlagProps & CompatWebhookProps & CompatUploadCallbackProps & CompatLoadingCallbackProps & CompatCameraProps & CompatCaptureExitProps & CompatChromeProps & CompatFaceCaptureProps & CompatEyesOpenProps & {
9935
9996
  children?: ReactNode;
@@ -11162,8 +11223,8 @@ declare const renderDocumentCapture: (optionsOrTargetElement: TargetElement | (C
11162
11223
  aspectRatio?: number;
11163
11224
  cameraFeedMode?: CameraFeedMode;
11164
11225
  instructions?: ReactNode;
11165
- classNames?: DocumentCaptureClassNames;
11166
- verbiage?: DocumentCaptureVerbiage;
11226
+ classNames?: DocumentCaptureClassNames & ForwardedDocumentViewClassNames;
11227
+ verbiage?: DocumentCaptureVerbiage & ForwardedDocumentViewVerbiage;
11167
11228
  }), options?: (CompatSessionProps & CompatSubmissionIdProps & CompatUploadCallbackProps & CompatCameraProps & CompatCaptureExitProps & CompatChromeProps & {
11168
11229
  children?: ReactNode;
11169
11230
  useDocumentServiceForLivenessChecks?: boolean;
@@ -11174,8 +11235,8 @@ declare const renderDocumentCapture: (optionsOrTargetElement: TargetElement | (C
11174
11235
  aspectRatio?: number;
11175
11236
  cameraFeedMode?: CameraFeedMode;
11176
11237
  instructions?: ReactNode;
11177
- classNames?: DocumentCaptureClassNames;
11178
- verbiage?: DocumentCaptureVerbiage;
11238
+ classNames?: DocumentCaptureClassNames & ForwardedDocumentViewClassNames;
11239
+ verbiage?: DocumentCaptureVerbiage & ForwardedDocumentViewVerbiage;
11179
11240
  }) | undefined) => Element | DocumentFragment;
11180
11241
 
11181
11242
  type IDmissionSDK = {
@@ -11213,7 +11274,7 @@ declare global {
11213
11274
  var IDmissionSDK: IDmissionSDK;
11214
11275
  }
11215
11276
 
11216
- declare const webSdkVersion = "2.6.3-changeset-release-develop-8a04e04";
11277
+ declare const webSdkVersion = "2.6.3-changeset-release-develop-c1e1b02";
11217
11278
 
11218
11279
  /**
11219
11280
  * sdk2's imperative handle on the video-signature capture screen
package/dist/props.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$comment": "GENERATED by scripts/propsManifest.mjs at build time. Each customer flow's props, read off dist/index.d.ts.",
3
3
  "schemaVersion": 1,
4
- "version": "2.6.3-changeset-release-develop-8a04e04",
4
+ "version": "2.6.3-changeset-release-develop-c1e1b02",
5
5
  "components": {
6
6
  "IdValidation": {
7
7
  "description": "Render a fullscreen ID capture component that instructs the user to\nphotograph both sides of their ID card, or the full page of their passport.",
@@ -3375,15 +3375,15 @@
3375
3375
  },
3376
3376
  {
3377
3377
  "name": "classNames",
3378
- "type": "DocumentCaptureClassNames",
3378
+ "type": "DocumentCaptureClassNames & ForwardedDocumentViewClassNames",
3379
3379
  "required": false,
3380
- "description": "Class names for the component's inner elements, keyed as in 2.x\n(`DocumentCaptureClassNames`). Keys marked deprecated have no effect in 3.0."
3380
+ "description": "Class names for the component's inner elements, keyed as in 2.x\n(`DocumentCaptureClassNames`), plus the 3.0 view's own keys. Keys marked\ndeprecated have no effect in 3.0."
3381
3381
  },
3382
3382
  {
3383
3383
  "name": "verbiage",
3384
- "type": "DocumentCaptureVerbiage",
3384
+ "type": "DocumentCaptureVerbiage & ForwardedDocumentViewVerbiage",
3385
3385
  "required": false,
3386
- "description": "Object containing any verbiage overrides."
3386
+ "description": "Verbiage overrides: the 2.x keys plus the 3.0 view's own keys."
3387
3387
  }
3388
3388
  ]
3389
3389
  },
@@ -48584,7 +48584,7 @@ function mapCustomerIdAndBiometricsEnrollmentProps(props, ctx) {
48584
48584
  });
48585
48585
  }
48586
48586
 
48587
- var webSdkVersion = '2.6.3-changeset-release-develop-8a04e04';
48587
+ var webSdkVersion = '2.6.3-changeset-release-develop-c1e1b02';
48588
48588
 
48589
48589
  // GENERATED by scripts/styleBagTypes.mjs from
48590
48590
  // src/__fixtures__/sdk2StyleBags.json and the mapper sweep — do not
@@ -51097,6 +51097,59 @@ function isBag(value) {
51097
51097
  var proto = Object.getPrototypeOf(value);
51098
51098
  return proto === null || Object.getPrototypeOf(proto) === null;
51099
51099
  }
51100
+ /**
51101
+ * Top-level style keys a flow forwards to its 3.0 view beyond the 2.x paths,
51102
+ * so the 2.x check below must not call them typos. `satisfies` keeps each list
51103
+ * in step with the type it mirrors.
51104
+ */
51105
+ var FORWARDED_STYLE_KEYS = {
51106
+ DocumentCapture: {
51107
+ classNames: {
51108
+ cameraFeedWrapper: true,
51109
+ cameraFeed: true,
51110
+ previewImage: true,
51111
+ captureContainer: true,
51112
+ headingRow: true,
51113
+ heading: true,
51114
+ guideOverlay: true,
51115
+ footerRow: true,
51116
+ instructions: true,
51117
+ buttonsRow: true,
51118
+ retryCameraAccessBtn: true,
51119
+ retryCaptureBtn: true,
51120
+ uploadBtn: true,
51121
+ uploadProgressBtn: true,
51122
+ captureBtn: true,
51123
+ autoCaptureGuidance: true,
51124
+ manualCaptureHint: true,
51125
+ reviewContainer: true,
51126
+ reviewCard: true,
51127
+ reviewHeading: true
51128
+ },
51129
+ verbiage: {
51130
+ headingText: true,
51131
+ loadingBtnText: true,
51132
+ retryCameraAccessBtnText: true,
51133
+ exitBtnText: true,
51134
+ captureBtnText: true,
51135
+ capturingBtnText: true,
51136
+ retryCaptureBtnText: true,
51137
+ uploadBtnText: true,
51138
+ uploadingBtnText: true,
51139
+ retryUploadBtnText: true,
51140
+ successBtnText: true,
51141
+ autoCaptureNoDocumentText: true,
51142
+ autoCaptureTooCloseText: true,
51143
+ autoCaptureTooFarText: true,
51144
+ autoCaptureNotStableText: true,
51145
+ autoCaptureOutOfFocusText: true,
51146
+ autoCaptureHoldStillText: true,
51147
+ manualCaptureHintText: true,
51148
+ reviewHeadingText: true,
51149
+ reviewImageAltText: true
51150
+ }
51151
+ }
51152
+ };
51100
51153
  /**
51101
51154
  * Warns once per page load for each style-bag key the caller set that 2.x
51102
51155
  * never had — a typo a type checker would have caught, which plain-JS
@@ -51106,22 +51159,25 @@ function isBag(value) {
51106
51159
  * is reported too, since nothing reads it.
51107
51160
  */
51108
51161
  function reportStyleKeys(flow, props) {
51162
+ var _a;
51109
51163
  if (getLogLevel() < LogLevel.Warn) return;
51110
51164
  var drops = STYLE_BAG_DROPS[flow] || {};
51111
51165
  var _loop_1 = function _loop_1(bag) {
51112
51166
  if (!hasOwn.call(STYLE_BAG_KEYS, bag)) return "continue";
51113
- var _a = STYLE_BAG_KEYS[bag],
51114
- flows = _a.flows,
51115
- aliases = _a.aliases;
51167
+ var _b = STYLE_BAG_KEYS[bag],
51168
+ flows = _b.flows,
51169
+ aliases = _b.aliases;
51116
51170
  var bagValue = props[bag];
51117
51171
  if (!hasOwn.call(flows, flow) || !isBag(bagValue)) return "continue";
51118
51172
  var bagDrops = drops[bag] || {};
51173
+ var forwarded = ((_a = FORWARDED_STYLE_KEYS[flow]) === null || _a === void 0 ? void 0 : _a[bag]) || {};
51119
51174
  var _walk = function walk(value, alias, prefix) {
51120
51175
  var keys = aliases[alias];
51121
51176
  for (var key in value) {
51122
51177
  if (!hasOwn.call(value, key) || value[key] === undefined) continue;
51123
51178
  var path = prefix + key;
51124
51179
  if (!hasOwn.call(keys, key)) {
51180
+ if (prefix === '' && hasOwn.call(forwarded, key)) continue;
51125
51181
  report(flow, bag + '.' + path, 'is not a 2.x `' + bag + '` key, so it has no effect.');
51126
51182
  } else if (hasOwn.call(bagDrops, path)) {
51127
51183
  report(flow, bag + '.' + path, 'has no effect in 3.0: ' + NO_EFFECT[bagDrops[path]]);