@okta/okta-signin-widget/src/v3/types/stepTransformer.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 { IdxMessage, IdxTransaction } from '@okta/okta-auth-js';
import { StateUpdater } from 'preact/hooks';

import { FormBag } from './schema';
import { WidgetProps } from './widget';

type IdxStepTransformerOptions = {
  transaction: IdxTransaction;
  prevTransaction?: IdxTransaction;
  formBag: FormBag;
  widgetProps: WidgetProps;
};

// TODO: remove
export type IdxStepTransformer = (options: IdxStepTransformerOptions) => FormBag;

export type TransformationOptions = {
  widgetProps: WidgetProps;
  transaction: IdxTransaction;
  prevTransaction?: IdxTransaction;
  step: string;
  setMessage: StateUpdater<IdxMessage | undefined>;
  isClientTransaction: boolean;
};

export type TransformStepFn = (formbag: FormBag) => FormBag;
export type TransformStepFnWithOptions = (options: TransformationOptions) => TransformStepFn;