@okta/okta-signin-widget/src/v3/transformer/i18n/transformIdentifierHint.ts

The Okta Sign-In Widget

/*
 * Copyright (c) 2022-present, Okta, Inc. and/or its affiliates. All rights reserved.
 * The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
 *
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and limitations under the License.
 */

import { IDX_STEP } from '../../constants';
import {
  FieldElement,
  TransformStepFnWithOptions,
} from '../../types';
import { traverseLayout } from '../util';
import { isCustomizedI18nKey } from './isCustomizedI18nKey';
import { addTranslation } from './util';

export const transformIdentifierHint: TransformStepFnWithOptions = ({
  transaction,
  widgetProps,
}) => (
  formbag,
) => {
  const { uischema } = formbag;

  traverseLayout({
    layout: uischema,
    predicate: (element) => (element as FieldElement).options?.inputMeta?.name === 'identifier',
    callback: (element) => {
      const { nextStep: { name } = {} } = transaction;
      if (name !== IDX_STEP.IDENTIFY) {
        return;
      }
      const key = 'primaryauth.username.tooltip';
      if (!isCustomizedI18nKey(key, widgetProps)) {
        return;
      }
      addTranslation({
        element,
        name: 'hint',
        i18nKey: key,
      });
    },
  });

  return formbag;
};