@oneuptime/common 14.0.13 → 14.0.14

package/UI/Components/Forms/Utils/FinishFromAnyStep.ts

@@ -1,284 +0,0 @@
-import Field from "../Types/Field";
-import FormFieldSchemaType from "../Types/FormFieldSchemaType";
-import { FormStep } from "../Types/FormStep";
-import FormValues from "../Types/FormValues";
-import Validation from "../Validation";
-import Dictionary from "../../../../Types/Dictionary";
-import GenericObject from "../../../../Types/GenericObject";
-import { JSONObject } from "../../../../Types/JSON";
-
-/*
- * A stepped form can be finished as soon as every step left is optional.
- *
- * "Reduce decision / choice paralysis as much as possible: show people as
- * few options as possible ... and have sane defaults." - the maintainer,
- * closing the feedback document. Long forms walk steps (PR #4192), and a
- * create wizard used to make every one of them a click: Declare Incident
- * walked Resources Affected, Incident Roles, On-Call and More even when the
- * title and the severity were all the incident needed, and a status page
- * visitor clicked Next to a Preferences step whose answers ("all resources",
- * "every kind of event") were already ticked.
- *
- * So while every step after the one on screen already holds valid answers,
- * the form's main button is its action ("Declare Incident", "Subscribe"),
- * and a plain Next beside it walks on for anyone who wants the rest. The
- * action submits through BasicForm.submitAllSteps, which checks every step
- * and opens the first one with a problem. Steps not reached yet stay closed
- * in the step list, and there is still no Back button (b61a6b656d).
- *
- * A step holding a custom element counts as unfinished until it has been
- * shown, unless its field says customElementCanBeSkipped. A custom element
- * can write a value of its own when it first shows - the default criteria of
- * a monitor's type, a rule's conditions, a discovery scan's SNMP settings -
- * or be something to read before saving (the Free plan's pay-as-you-go
- * notice), and the form cannot tell which until it draws it. Skipping one of
- * those would save the record without that value, so the form walks to it.
- */
-
-export type CanFinishFormFromStepFunction = <T extends GenericObject>(data: {
-  // The steps the user walks, in order: the ones their showIf leaves out are not here.
-  steps: ReadonlyArray<FormStep<T>>;
-  currentStepId: string | null;
-  // The form's fields, each with its name.
-  fields: ReadonlyArray<Field<T>>;
-  values: FormValues<T>;
-  // The steps the form has shown so far.
-  shownStepIds: ReadonlyArray<string>;
-  onValidate?: ((values: FormValues<T>) => JSONObject) | undefined;
-}) => boolean;
-
-type IsFieldShownFunction = <T extends GenericObject>(
-  field: Field<T>,
-  values: FormValues<T>,
-) => boolean;
-
-const isFieldShown: IsFieldShownFunction = <T extends GenericObject>(
-  field: Field<T>,
-  values: FormValues<T>,
-): boolean => {
-  return !field.showIf || field.showIf(values);
-};
-
-type GetFieldNameFunction = <T extends GenericObject>(
-  field: Field<T>,
-) => string;
-
-const getFieldName: GetFieldNameFunction = <T extends GenericObject>(
-  field: Field<T>,
-): string => {
-  return (
-    field.name ||
-    field.overrideFieldKey ||
-    (Object.keys(field.field || {})[0] as string) ||
-    ""
-  );
-};
-
-/*
- * A custom element the form has not drawn yet, that the form cannot finish
- * without drawing - see the note at the top.
- */
-export const isCustomElementToShowBeforeFinishing: IsFieldShownFunction = <
-  T extends GenericObject,
->(
-  field: Field<T>,
-  values: FormValues<T>,
-): boolean => {
-  return (
-    field.fieldType === FormFieldSchemaType.CustomComponent &&
-    !field.customElementCanBeSkipped &&
-    isFieldShown(field, values)
-  );
-};
-
-/*
- * Whether every step other than the one on screen is finished: each of its
- * fields that shows passes validation, and a step not shown yet holds no
- * custom element the form has to draw first. The step on screen is not
- * judged - its fields are in front of the user, and the action checks them
- * the moment it is pressed. Nothing is marked touched and no error is shown:
- * this only decides what the form's buttons say.
- */
-export const canFinishFormFromStep: CanFinishFormFromStepFunction = <
-  T extends GenericObject,
->(data: {
-  steps: ReadonlyArray<FormStep<T>>;
-  currentStepId: string | null;
-  fields: ReadonlyArray<Field<T>>;
-  values: FormValues<T>;
-  shownStepIds: ReadonlyArray<string>;
-  onValidate?: ((values: FormValues<T>) => JSONObject) | undefined;
-}): boolean => {
-  if (data.steps.length === 0 || !data.currentStepId) {
-    return false;
-  }
-
-  const currentStepId: string = data.currentStepId;
-
-  const isCurrentStepWalked: boolean = data.steps.some(
-    (step: FormStep<T>): boolean => {
-      return step.id === currentStepId;
-    },
-  );
-
-  if (!isCurrentStepWalked) {
-    return false;
-  }
-
-  const otherSteps: Array<FormStep<T>> = data.steps.filter(
-    (step: FormStep<T>): boolean => {
-      return step.id !== currentStepId;
-    },
-  );
-
-  const otherStepIds: Set<string> = new Set<string>(
-    otherSteps.map((step: FormStep<T>): string => {
-      return step.id;
-    }),
-  );
-
-  const fieldsOnOtherSteps: Array<Field<T>> = data.fields
-    .filter((field: Field<T>): boolean => {
-      return Boolean(field.stepId) && otherStepIds.has(field.stepId as string);
-    })
-    .map((field: Field<T>): Field<T> => {
-      // Validation names each error after its field.
-      return field.name ? field : { ...field, name: getFieldName(field) };
-    });
-
-  // A step not shown yet, holding an element that has to be drawn first.
-  for (const step of otherSteps) {
-    if (data.shownStepIds.includes(step.id)) {
-      continue;
-    }
-
-    const holdsElementToShow: boolean = fieldsOnOtherSteps.some(
-      (field: Field<T>): boolean => {
-        return (
-          field.stepId === step.id &&
-          isCustomElementToShowBeforeFinishing(field, data.values)
-        );
-      },
-    );
-
-    if (holdsElementToShow) {
-      return false;
-    }
-  }
-
-  const fieldErrors: Dictionary<string> = Validation.validate<T>({
-    values: data.values,
-    formFields: fieldsOnOtherSteps,
-    currentFormStepId: null,
-    onValidate: undefined,
-  });
-
-  if (Object.keys(fieldErrors).length > 0) {
-    return false;
-  }
-
-  if (!data.onValidate) {
-    return true;
-  }
-
-  /*
-   * The form's own check answers for the whole form. An error it pins on a
-   * field of the step on screen is the user's to fix there; any other - on
-   * another step, or on no field at all - is one the action would stop at.
-   */
-  const fieldNamesOnCurrentStep: Set<string> = new Set<string>(
-    data.fields
-      .filter((field: Field<T>): boolean => {
-        return field.stepId === currentStepId;
-      })
-      .map((field: Field<T>): string => {
-        return getFieldName(field);
-      }),
-  );
-
-  const formErrors: JSONObject = data.onValidate(data.values) || {};
-
-  return Object.keys(formErrors).every((key: string): boolean => {
-    return fieldNamesOnCurrentStep.has(key);
-  });
-};
-
-/*
- * What a stepped form's footer offers on the step on screen.
- */
-export interface SteppedFormFooter {
-  // What the main button says: the form's action, or "Next".
-  primaryButtonText: string;
-  /*
-   * The main button finishes the form from here: BasicForm.submitAllSteps,
-   * which checks every step and opens the first one with a problem. Otherwise
-   * it is BasicForm.submitForm - check this step, then walk on, or submit on
-   * the last step.
-   */
-  primaryButtonSubmitsAllSteps: boolean;
-  // A plain Next beside the main button (BasicForm.submitForm).
-  showNextButton: boolean;
-}
-
-export const NEXT_BUTTON_TEXT: string = "Next";
-
-export type GetSteppedFormFooterFunction = (data: {
-  hasSteps: boolean;
-  isOnLastStep: boolean;
-  // canFinishFormFromStep, for the step on screen.
-  canFinishFromCurrentStep: boolean;
-  /*
-   * An edit form: every step is filled in already, so it saves from any
-   * step whatever the steps hold (ModelFormModal's Update forms,
-   * BasicFormModal's saveFromAnyStep).
-   */
-  savesFromAnyStep?: boolean | undefined;
-  // The form's action: "Declare Incident", "Save Changes".
-  actionText: string;
-}) => SteppedFormFooter;
-
-export const getSteppedFormFooter: GetSteppedFormFooterFunction = (data: {
-  hasSteps: boolean;
-  isOnLastStep: boolean;
-  canFinishFromCurrentStep: boolean;
-  savesFromAnyStep?: boolean | undefined;
-  actionText: string;
-}): SteppedFormFooter => {
-  if (!data.hasSteps) {
-    return {
-      primaryButtonText: data.actionText,
-      primaryButtonSubmitsAllSteps: false,
-      showNextButton: false,
-    };
-  }
-
-  if (data.savesFromAnyStep) {
-    return {
-      primaryButtonText: data.actionText,
-      primaryButtonSubmitsAllSteps: true,
-      showNextButton: !data.isOnLastStep,
-    };
-  }
-
-  if (data.isOnLastStep) {
-    return {
-      primaryButtonText: data.actionText,
-      primaryButtonSubmitsAllSteps: false,
-      showNextButton: false,
-    };
-  }
-
-  if (data.canFinishFromCurrentStep) {
-    return {
-      primaryButtonText: data.actionText,
-      primaryButtonSubmitsAllSteps: true,
-      showNextButton: true,
-    };
-  }
-
-  return {
-    primaryButtonText: NEXT_BUTTON_TEXT,
-    primaryButtonSubmitsAllSteps: false,
-    showNextButton: false,
-  };
-};

package/build/dist/UI/Components/Forms/Utils/FinishFromAnyStep.js

@@ -1,132 +0,0 @@
-import FormFieldSchemaType from "../Types/FormFieldSchemaType";
-import Validation from "../Validation";
-const isFieldShown = (field, values) => {
-    return !field.showIf || field.showIf(values);
-};
-const getFieldName = (field) => {
-    return (field.name ||
-        field.overrideFieldKey ||
-        Object.keys(field.field || {})[0] ||
-        "");
-};
-/*
- * A custom element the form has not drawn yet, that the form cannot finish
- * without drawing - see the note at the top.
- */
-export const isCustomElementToShowBeforeFinishing = (field, values) => {
-    return (field.fieldType === FormFieldSchemaType.CustomComponent &&
-        !field.customElementCanBeSkipped &&
-        isFieldShown(field, values));
-};
-/*
- * Whether every step other than the one on screen is finished: each of its
- * fields that shows passes validation, and a step not shown yet holds no
- * custom element the form has to draw first. The step on screen is not
- * judged - its fields are in front of the user, and the action checks them
- * the moment it is pressed. Nothing is marked touched and no error is shown:
- * this only decides what the form's buttons say.
- */
-export const canFinishFormFromStep = (data) => {
-    if (data.steps.length === 0 || !data.currentStepId) {
-        return false;
-    }
-    const currentStepId = data.currentStepId;
-    const isCurrentStepWalked = data.steps.some((step) => {
-        return step.id === currentStepId;
-    });
-    if (!isCurrentStepWalked) {
-        return false;
-    }
-    const otherSteps = data.steps.filter((step) => {
-        return step.id !== currentStepId;
-    });
-    const otherStepIds = new Set(otherSteps.map((step) => {
-        return step.id;
-    }));
-    const fieldsOnOtherSteps = data.fields
-        .filter((field) => {
-        return Boolean(field.stepId) && otherStepIds.has(field.stepId);
-    })
-        .map((field) => {
-        // Validation names each error after its field.
-        return field.name ? field : Object.assign(Object.assign({}, field), { name: getFieldName(field) });
-    });
-    // A step not shown yet, holding an element that has to be drawn first.
-    for (const step of otherSteps) {
-        if (data.shownStepIds.includes(step.id)) {
-            continue;
-        }
-        const holdsElementToShow = fieldsOnOtherSteps.some((field) => {
-            return (field.stepId === step.id &&
-                isCustomElementToShowBeforeFinishing(field, data.values));
-        });
-        if (holdsElementToShow) {
-            return false;
-        }
-    }
-    const fieldErrors = Validation.validate({
-        values: data.values,
-        formFields: fieldsOnOtherSteps,
-        currentFormStepId: null,
-        onValidate: undefined,
-    });
-    if (Object.keys(fieldErrors).length > 0) {
-        return false;
-    }
-    if (!data.onValidate) {
-        return true;
-    }
-    /*
-     * The form's own check answers for the whole form. An error it pins on a
-     * field of the step on screen is the user's to fix there; any other - on
-     * another step, or on no field at all - is one the action would stop at.
-     */
-    const fieldNamesOnCurrentStep = new Set(data.fields
-        .filter((field) => {
-        return field.stepId === currentStepId;
-    })
-        .map((field) => {
-        return getFieldName(field);
-    }));
-    const formErrors = data.onValidate(data.values) || {};
-    return Object.keys(formErrors).every((key) => {
-        return fieldNamesOnCurrentStep.has(key);
-    });
-};
-export const NEXT_BUTTON_TEXT = "Next";
-export const getSteppedFormFooter = (data) => {
-    if (!data.hasSteps) {
-        return {
-            primaryButtonText: data.actionText,
-            primaryButtonSubmitsAllSteps: false,
-            showNextButton: false,
-        };
-    }
-    if (data.savesFromAnyStep) {
-        return {
-            primaryButtonText: data.actionText,
-            primaryButtonSubmitsAllSteps: true,
-            showNextButton: !data.isOnLastStep,
-        };
-    }
-    if (data.isOnLastStep) {
-        return {
-            primaryButtonText: data.actionText,
-            primaryButtonSubmitsAllSteps: false,
-            showNextButton: false,
-        };
-    }
-    if (data.canFinishFromCurrentStep) {
-        return {
-            primaryButtonText: data.actionText,
-            primaryButtonSubmitsAllSteps: true,
-            showNextButton: true,
-        };
-    }
-    return {
-        primaryButtonText: NEXT_BUTTON_TEXT,
-        primaryButtonSubmitsAllSteps: false,
-        showNextButton: false,
-    };
-};
-//# sourceMappingURL=FinishFromAnyStep.js.map

package/build/dist/UI/Components/Forms/Utils/FinishFromAnyStep.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FinishFromAnyStep.js","sourceRoot":"","sources":["../../../../../../UI/Components/Forms/Utils/FinishFromAnyStep.ts"],"names":[],"mappings":"AACA,OAAO,mBAAmB,MAAM,8BAA8B,CAAC;AAG/D,OAAO,UAAU,MAAM,eAAe,CAAC;AAkDvC,MAAM,YAAY,GAAyB,CACzC,KAAe,EACf,MAAqB,EACZ,EAAE;IACX,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC,CAAC;AAMF,MAAM,YAAY,GAAyB,CACzC,KAAe,EACP,EAAE;IACV,OAAO,CACL,KAAK,CAAC,IAAI;QACV,KAAK,CAAC,gBAAgB;QACrB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAY;QAC7C,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAyB,CAGxE,KAAe,EACf,MAAqB,EACZ,EAAE;IACX,OAAO,CACL,KAAK,CAAC,SAAS,KAAK,mBAAmB,CAAC,eAAe;QACvD,CAAC,KAAK,CAAC,yBAAyB;QAChC,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAC5B,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAkC,CAElE,IAOD,EAAW,EAAE;IACZ,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,aAAa,GAAW,IAAI,CAAC,aAAa,CAAC;IAEjD,MAAM,mBAAmB,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAClD,CAAC,IAAiB,EAAW,EAAE;QAC7B,OAAO,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC;IACnC,CAAC,CACF,CAAC;IAEF,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,UAAU,GAAuB,IAAI,CAAC,KAAK,CAAC,MAAM,CACtD,CAAC,IAAiB,EAAW,EAAE;QAC7B,OAAO,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC;IACnC,CAAC,CACF,CAAC;IAEF,MAAM,YAAY,GAAgB,IAAI,GAAG,CACvC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAiB,EAAU,EAAE;QAC3C,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,kBAAkB,GAAoB,IAAI,CAAC,MAAM;SACpD,MAAM,CAAC,CAAC,KAAe,EAAW,EAAE;QACnC,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,MAAgB,CAAC,CAAC;IAC3E,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,KAAe,EAAY,EAAE;QACjC,+CAA+C;QAC/C,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,iCAAM,KAAK,KAAE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,GAAE,CAAC;IACtE,CAAC,CAAC,CAAC;IAEL,uEAAuE;IACvE,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACxC,SAAS;QACX,CAAC;QAED,MAAM,kBAAkB,GAAY,kBAAkB,CAAC,IAAI,CACzD,CAAC,KAAe,EAAW,EAAE;YAC3B,OAAO,CACL,KAAK,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE;gBACxB,oCAAoC,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CACzD,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,IAAI,kBAAkB,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAuB,UAAU,CAAC,QAAQ,CAAI;QAC7D,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,UAAU,EAAE,kBAAkB;QAC9B,iBAAiB,EAAE,IAAI;QACvB,UAAU,EAAE,SAAS;KACtB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,uBAAuB,GAAgB,IAAI,GAAG,CAClD,IAAI,CAAC,MAAM;SACR,MAAM,CAAC,CAAC,KAAe,EAAW,EAAE;QACnC,OAAO,KAAK,CAAC,MAAM,KAAK,aAAa,CAAC;IACxC,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,KAAe,EAAU,EAAE;QAC/B,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC,CACL,CAAC;IAEF,MAAM,UAAU,GAAe,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAElE,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,GAAW,EAAW,EAAE;QAC5D,OAAO,uBAAuB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAmBF,MAAM,CAAC,MAAM,gBAAgB,GAAW,MAAM,CAAC;AAiB/C,MAAM,CAAC,MAAM,oBAAoB,GAAiC,CAAC,IAMlE,EAAqB,EAAE;IACtB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnB,OAAO;YACL,iBAAiB,EAAE,IAAI,CAAC,UAAU;YAClC,4BAA4B,EAAE,KAAK;YACnC,cAAc,EAAE,KAAK;SACtB,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,OAAO;YACL,iBAAiB,EAAE,IAAI,CAAC,UAAU;YAClC,4BAA4B,EAAE,IAAI;YAClC,cAAc,EAAE,CAAC,IAAI,CAAC,YAAY;SACnC,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,OAAO;YACL,iBAAiB,EAAE,IAAI,CAAC,UAAU;YAClC,4BAA4B,EAAE,KAAK;YACnC,cAAc,EAAE,KAAK;SACtB,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAClC,OAAO;YACL,iBAAiB,EAAE,IAAI,CAAC,UAAU;YAClC,4BAA4B,EAAE,IAAI;YAClC,cAAc,EAAE,IAAI;SACrB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,iBAAiB,EAAE,gBAAgB;QACnC,4BAA4B,EAAE,KAAK;QACnC,cAAc,EAAE,KAAK;KACtB,CAAC;AACJ,CAAC,CAAC"}