@legalplace/prerenderx 3.8.24-staging.0 → 3.9.0

package/.yalc/@legalplace/models-v3-types/index.ts

@@ -1,915 +0,0 @@
-// Type definitions for model v3
-// TypeScript Version: 2.1
-import type { ROLE } from "@legalplace/typeorm-constants";
-
-type CONDITION_TYPE =
-  | "selected"
-  | "not-selected"
-  | "not-selected-ip"
-  | "has-one"
-  | "at-least-one"
-  | "has-many"
-  | "contains"
-  | "does-not-contain"
-  | "="
-  | ">"
-  | "<"
-  | "!="
-  | ">="
-  | "<="
-  | "<>"
-  | "=="
-  | "empty"
-  | "not-empty"
-  | "is"
-  | "not"
-  | "like"
-  | "not-like"
-  | "regex-match"
-  | "conditions-met"
-  | "conditions-not-met";
-type DATA_MAP = {
-  var: string;
-};
-type CONDITION = {
-  [key in CONDITION_TYPE]?: [
-    DATA_MAP,
-    (string | number | boolean)?,
-    DATA_MAP[]?
-  ];
-};
-type CONDITION_SCOPE = "first" | "all" | "any" | "related";
-type GROUP_META = { label?: string; collapsed?: boolean };
-type CONDITION_NODE = CONDITION & {
-  scope?: CONDITION_SCOPE;
-  groupMeta?: GROUP_META;
-};
-type CONDITION_OPERATOR = {
-  [key in "and" | "or"]?: (CONDITION_OPERATOR & CONDITION_NODE)[];
-};
-export type ConditionV3 = CONDITION_OPERATOR & CONDITION_NODE;
-
-/**
- * Document section role for output regions (body is the default when absent).
- */
-export type SectionRoleV3 =
-  | "body"
-  | "header"
-  | "footer"
-  | "firstPageHeader"
-  | "firstPageFooter";
-
-/**
- * Word page layout settings (distances in centimeters).
- */
-export interface DocumentLayoutV3 {
-  margins?: {
-    top?: number;
-    right?: number;
-    bottom?: number;
-    left?: number;
-  };
-  headerDistance?: number;
-  footerDistance?: number;
-  differentFirstPage?: boolean;
-}
-
-/**
- * Model
- */
-export interface ModelV3<ConstumizationMeta = CustomizationMetaDefault> {
-  documents: {
-    /**
-     * This interface was referenced by `undefined`'s JSON-Schema definition
-     * via the `patternProperty` ".*".
-     */
-    [k: string]: {
-      /**
-       * Document's name
-       */
-      name: string;
-      /**
-       * Document's fallback name
-       */
-      fallbackName?: string;
-      /**
-       * Document's slug name
-       */
-      documentSlug?: string;
-      /**
-       * Document's sections list
-       */
-      sections: SectionV3[];
-      /**
-       * Document's PDF link
-       */
-      pdf?: {
-        id: string;
-        filename: string;
-        form: FDFFormV3;
-        thumbnails: string[];
-      };
-      /**
-       * Document's params
-       */
-      params?: {
-        formats?: {
-          pdf?: boolean;
-          docx?: boolean;
-        };
-        visibility?: {
-          [key: string]: boolean | undefined;
-          private?: boolean;
-        };
-        documentStyle?: {
-          styles?: {
-            Normal?: {
-              color?: string;
-              indent?: number;
-              /** Font size in pt (lpdocast default: 10). Unset uses built-in default. */
-              fontSize?: string;
-            };
-            headingOne?: {
-              color?: string;
-              indent?: number;
-              /** Font size in pt (lpdocast default: 14). Unset uses built-in default. */
-              fontSize?: string;
-            };
-            headingTwo?: {
-              color?: string;
-              indent?: number;
-              /** Font size in pt (lpdocast default: 12). Unset uses built-in default. */
-              fontSize?: string;
-            };
-            headingThree?: {
-              color?: string;
-              indent?: number;
-              /** Font size in pt (lpdocast default: 10). Unset uses built-in default. */
-              fontSize?: string;
-            };
-            headingFour?: {
-              color?: string;
-              indent?: number;
-              /** Font size in pt (lpdocast default: 10). Unset uses built-in default. */
-              fontSize?: string;
-            };
-          };
-          titlesNumbering?: {
-            enabled: boolean;
-            type: "ARTICLE-FIRST" | "SIMPLE";
-          };
-        };
-        conditions?: ConditionV3;
-        grantLevel?: ROLE;
-        /**
-         * Document multiple settings: when enabled, the document is rendered
-         * once per occurrence of the linked multiple option, producing N separate
-         * PDF/DOCX files instead of a single file.
-         */
-        multiple?: {
-          /**
-           * Enable/disable the document-level multiple
-           */
-          enabled: boolean;
-          /**
-           * ID of the option that drives the repetition. Must point to an
-           * `OptionV3` whose `meta.multiple.enabled === true`.
-           */
-          repeatOption: number;
-          /**
-           * Optional filename template, e.g. `"Contrat - [var:47]"`.
-           * `[var:X]` placeholders are resolved per occurrence at render time.
-           * When absent or empty, prerenderx falls back to
-           * `"<documentName> N°<index + incrementationStart>"`.
-           */
-          filenameTemplate?: string;
-        };
-        /**
-         * Word page layout: margins, header/footer distance, first-page header/footer.
-         */
-        layout?: DocumentLayoutV3;
-      };
-    };
-  };
-  options: {
-    [k: string]: OptionV3;
-  };
-  variables: {
-    [k: string]: VariableV3;
-  };
-  customization: {
-    disableAutoDefault?: boolean;
-    meta?: ConstumizationMeta;
-    dataStorage?: {
-      extendedDuration?: boolean;
-    };
-  };
-}
-
-/**
- * Default meta customization
- */
-export interface CustomizationMetaDefault {
-  [key: string]: any;
-  extracts?: ExtractV3[];
-  clientType?: {
-    type: "ind" | "pro" | "conditionnal";
-    conditions?: ConditionV3;
-  };
-  isTwoSteps?: boolean;
-  isFullWidth?: boolean;
-  previewTitle?: string;
-  contractType?: {
-    socialType?: "individual" | "collective";
-    privacy?: "public" | "private";
-  };
-  emailSection?: {
-    sectionTitle?: string;
-    inputLabel?: string;
-    warningBlock?: string;
-    ctaLabel?: string;
-    ctaIcon?: string;
-  };
-  disableDownloads?: boolean;
-}
-
-/**
- * Extract V3
- */
-export interface ExtractV3 {
-  type: "option" | "variable";
-  id: number;
-  destination: {
-    sendinblue?: {
-      name: string;
-    };
-    mixpanel?: {
-      name: string;
-    };
-    slack?: {
-      name: string;
-      channel: string;
-    };
-  };
-}
-
-/**
- * Email Customization
- */
-export interface EmailStep {
-  sectionTitle?: string;
-  icon?: "download" | "continue";
-  ctaLabel?: string;
-  label?: string;
-}
-
-/**
- * Section V3
- */
-export interface SectionV3 {
-  /**
-   * Section's id
-   */
-  id: number;
-  /**
-   * Section's grant type
-   */
-  grantLevel?: ROLE;
-  /**
-   * Section's title
-   */
-  label: string;
-  /**
-   * Section's options
-   */
-  options: number[];
-  /**
-   * Section's conditions
-   */
-  conditions?: ConditionV3;
-  /**
-   * Step two only
-   */
-  step?: "*" | number[];
-  /**
-   * Tags
-   */
-  tags?: string[];
-  /**
-   * Slug
-   */
-  slug?: string;
-  /**
-   * Output region role. When absent, the section is treated as body content.
-   */
-  role?: SectionRoleV3;
-}
-
-export interface OptionV3 {
-  meta: {
-    /**
-     * Option's id
-     */
-    id: number;
-    /**
-     * Option's type
-     *  - `static`: A static question
-     *  - `radio`: A radio input
-     *  - `checkbox`: A checkbox input
-     *  - `hidden`: An option that only displays an output
-     *  - `brut-text`: An option without output that displays HTML in the wizard
-     *  - `repeated`: A loop linked to a multiple (can only have `hidden` options as children)
-     */
-    type:
-      | "static"
-      | "radio"
-      | "checkbox"
-      | "hidden"
-      | "repeated"
-      | "box"
-      | "separator";
-
-    /**
-     * Option's label
-     */
-    label: string;
-    /**
-     * Option steps
-     */
-    step: "*" | number[];
-    /**
-     * Fallback Label
-     */
-    fallbackLabel?: string;
-    /**
-     * Set to true to make the option mandatory
-     */
-    mandatory?: boolean;
-    /**
-     * Tags
-     */
-    tags?: string[];
-    /**
-     * The raw option's output
-     */
-    output?: string;
-    /**
-     * The html content of the warning block
-     */
-    warning?: string;
-    /**
-     * The html content of the helper block
-     */
-    helper?: string;
-    /**
-     * Raw conditions array
-     */
-    conditions?: ConditionV3;
-    /**
-     * Option's grantLevel
-     */
-    grantLevel?: ROLE;
-    /**
-     * Option's randomize order of children
-     */
-    randomizeChildren?: boolean;
-    /**
-     * Option's fixed last order of children
-     */
-    fixedChildrenLastOrder?: string;
-    /**
-     * Option style
-     */
-    style?: "" | "half" | "full";
-    /**
-     * In case of a radio/checkbox/static options, this holds the default child id that should be selected in case the user advances to the next section without selecting any of the child
-     */
-    defaultRadio?: number;
-    /**
-     * In case of a `repeated` option, this defines the multiple's id that the loop should be linked to
-     */
-    repeatOption?: number;
-    /**
-     * Hidden option
-     */
-    hidden?: boolean;
-    /**
-     * Disabled option
-     */
-    disabled?: boolean;
-    /**
-     * Prechecked option
-     * If true, the option will be prechecked on initialization
-     */
-    prechecked?: boolean;
-    /**
-     * Validator PARAMS
-     */
-    validator?: {
-      /**
-       * Validator condition
-       */
-      conditions?: ConditionV3;
-      /**
-       * Unvalid message
-       */
-      message?: string;
-    };
-
-    /**
-     * MULTIPLE PARAMS
-     */
-    multiple?: {
-      /**
-       * Enabled/Disable Multiple (on root options only)
-       */
-      enabled: boolean;
-      /**
-       * The label of the multiple's incrementing cta
-       */
-      cta?: string;
-      /**
-       * The text that preceeds the reccurency number of the multiple
-       */
-      label?: string;
-      /**
-       * The start of the multiples incrementation counter
-       */
-      incrementationStart?: number;
-    };
-
-    /**
-     * TERMSHEET PARAMS
-     */
-    termsheet?: {
-      /**
-       * Option's termsheetLabel
-       */
-      label?: string;
-      /**
-       * Hide option from termsheet
-       */
-      hide?: boolean;
-    };
-
-    /**
-     * Table hierarchy role for hidden output options.
-     * When set, the option participates in an output table tree instead of storing inline HTML.
-     */
-    tableRole?: "table" | "row" | "cell";
-
-    /**
-     * Table styling metadata (only on tableRole = 'table' options).
-     */
-    tableStyle?: {
-      columnWidths?: number[];
-      width?: number;
-      borderStyle?: string;
-      borderColor?: string;
-      borderWidth?: number;
-    };
-
-    /**
-     * Cell styling metadata (only on tableRole = 'cell' options).
-     */
-    cellStyle?: Record<string, string>;
-
-    /**
-     * BOX PARAMS
-     */
-    box?: {
-      /**
-       * Box type
-       */
-      type?: "warning" | "error" | "info" | "light";
-      /**
-       * Box title
-       */
-      title?: string;
-      /**
-       * Box collapsable
-       */
-      collapsable?: boolean;
-      /**
-       * Box aggregatable
-       */
-      aggregatable?: boolean;
-      /**
-       * The html content of the brut-text option
-       */
-      content?: string;
-    };
-  };
-  /**
-   * Child options
-   */
-  options: number[];
-  /**
-   * Child variables
-   */
-  variables: number[];
-}
-/**
- * Variable definition object
- *
- * This interface was referenced by `undefined`'s JSON-Schema definition
- * via the `patternProperty` ".*".
- */
-export interface VariableV3 {
-  /**
-   * Variable's id (must be unique)
-   */
-  id: number;
-  /**
-   * Variable's label
-   */
-  label: string;
-  /**
-   * Variable's Fallback Label
-   */
-  fallbackLabel?: string;
-  /**
-   * Variable's type
-   */
-  type:
-    | "text"
-    | "date"
-    | "list"
-    | "textarea"
-    | "number"
-    | "eval"
-    | "hour"
-    | "email"
-    | "user_email"
-    | "phone_number"
-    | "iframe"
-    | "mask"
-    | "autocomplete"
-    | "upload";
-  /**
-   * Variable's grantLevel
-   */
-  grantLevel?: ROLE;
-  /**
-   * Variable's suffix
-   */
-  suffix?: string;
-  /**
-   * Variable's place holder length
-   */
-  placeholderLength?: number;
-  /**
-   * The html content of the warning block
-   */
-  warning?: string;
-  /**
-   * The html content of the helper block
-   */
-  helper?: string;
-  /**
-   * The list of options for the select (list type) variable
-   */
-  selectValues?: string[];
-  /**
-   * The input's autocomplete attribute
-   */
-  autocomplete?: string;
-  /**
-   * Preffiling's object
-   */
-  prefillings?: PrefillingV3[];
-  /**
-   * Determines whether prefillers take priority over user input.
-   */
-  prioritizePrefillings?: boolean;
-  /**
-   * Input's placeholder
-   */
-  placeholder?: string;
-  /**
-   * Set to true if the variable should be displayed in the second step only
-   */
-  step: "*" | number[];
-  /**
-   * Variable conditions
-   */
-  conditions?: ConditionV3;
-  /**
-   * Defines input size
-   */
-  style?: "half" | "full";
-  /**
-   * Hidden variable
-   */
-  hidden?: boolean;
-  /**
-   * Tags
-   */
-  tags?: string[];
-  /**
-   * True if the variable is mandatory
-   */
-  mandatory?: boolean;
-
-  /**
-   * When true, the date should not be in the past (for date type only)
-   */
-  dateNotInPast?: boolean;
-
-  /**
-   * When true, the date should not be in the future (for date type only)
-   */
-  dateNotInFuture?: boolean;
-
-  /**
-   * Evaluation params
-   */
-  eval?: {
-    /**
-     * The evaluation formula (eval type), Example:
-     *  ```
-     * [var:1]*[var:2]/[var:3]```
-     */
-    formula?: string;
-    /**
-     * The number of decimals for the result of an evaluation (eval type)
-     */
-    decimals?: number;
-    /**
-     * Round evalulation result (eval type).
-     */
-    round?: "ceil" | "floor" | "round";
-  };
-
-  /**
-   * Number input
-   */
-  number?: {
-    intOnly?: boolean;
-  };
-
-  /**
-   * Textarea styling
-   */
-  textarea?: {
-    /**
-     * Textarea's size (textarea type)
-     *  - l: Large (240px)
-     *  - m: Medium (120px)
-     *  - s: Small (60px)
-     *  - p: Custom size in number of lines
-     */
-    size?: "l" | "m" | "p" | "s";
-    /**
-     * The textarea's high (lines number) (Only if textarea_size is set to `p`)
-     */
-    lineNumbers?: number;
-  };
-
-  /**
-   * Mask
-   */
-  mask?: {
-    /**
-     * The advanced mask's formula (ex: 20 ???-???-???) (?: Char & Number, !: Number Only, @: Char Only)
-     */
-    formula?: string;
-    /**
-     * Mask's placeholder
-     */
-    placeholder?: string;
-  };
-
-  /**
-   * Validator
-   */
-  validator?: {
-    /**
-     * Validator condition
-     */
-    conditions?: ConditionV3;
-    /**
-     * Unvalid error message
-     */
-    message?: string;
-  };
-
-  /**
-   * Autocomplete input type
-   */
-  autocompleteInputType?: "text" | "select";
-
-  /**
-   * Autocomplete dataset
-   */
-  autocompleteDataset?: AutocompleteDatasetType;
-
-  /**
-   * Linked variables (used in autocomplete)
-   */
-  linkedVariables?: Record<string, number>;
-
-  /**
-   * User side variable disabled condition
-   */
-  disabled?: boolean;
-
-  /**
-   * User side variable disabled tooltip
-   */
-  disabledTooltip?: string;
-
-  /**
-   * Termsheet
-   */
-  termsheet?: {
-    /**
-     * Variable's termsheet label
-     */
-    label?: string;
-    /**
-     * Hide variable from termsheet
-     */
-    hide?: boolean;
-  };
-
-  /**
-   * ExtraInformations (for managing multiple datas associated with a single variable)
-   */
-  extraInformations?: ExtraInformations;
-}
-/**
- * ExtraInformations (for managing multiple datas associated with a single variable)
- */
-interface ExtraInformations {
-  /**
-   * List of the inputs to check if it's disabled or not
-   */
-  disabledIndexes: boolean[];
-  /**
-   * List of defined options for each dropdown menu associated with a specific variable
-   */
-  selectedValuesIndexes?: string[][];
-}
-/**
- * A Prefilling, is a conditionned text placeholder/example used to fill a textarea according to different conditions
- */
-export interface PrefillingV3 {
-  /**
-   * Text used to fill the textarea if the condition is realized
-   */
-  value: string;
-  /**
-   * Compiled conditions object
-   */
-  conditions?: ConditionV3;
-}
-
-/**
- * FDF
- */
-export interface FDFFormV3 {
-  inputs: FDFInputsV3[];
-  boxes: FDFBoxesV3[];
-}
-
-/**
- * FDF Inputs
- */
-export interface FDFInputsV3 {
-  name: string;
-  page: number;
-  rect: {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-  };
-  variables: {
-    id: number;
-    date?: "DD" | "MM" | "YYYY";
-    hour?: "HH" | "MM";
-    email?: "ADDRESS" | "PROVIDER";
-    fragment?: {
-      from?: number;
-      to?: number;
-    };
-  }[];
-}
-
-/**
- * FDF Boxes
- */
-export interface FDFBoxesV3 {
-  name: string;
-  page: number;
-  value: string;
-  rect: {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-  };
-  options: {
-    id: number;
-  }[];
-}
-
-/**
- * Autocomplete datasets
- */
-export type AutocompleteDatasetType =
-  | "datagouv_addresses"
-  | "datagouv_cities"
-  | "pappers"
-  | "activities"
-  | "kanoon_collective_agreements"
-  | "datagouv_addresses_v2"
-  | "datagouv_cities_with_inpi"
-  | "rbe";
-
-/**
- * RBE linkedvariables
- */
-export type RbeLinkedVariableType =
-  // First variation with _1
-  | "civilite_1"
-  | "prenoms_1"
-  | "nom_1"
-  | "nationalite_1"
-  | "dateDeNaissance_1"
-  | "paysDeNaissance_1"
-  | "villeDeNaissance_1"
-  | "codePostalDeLaVilleDeNaissance_1"
-  | "paysDuDomicile_1"
-  | "numeroEtVoieDuDomicile_1"
-  | "codePostalDuDomicile_1"
-  | "villeDuDomicile_1"
-  | "partsDirectesPleinePropriete_1"
-  | "partsIndirectesIndivisionPleinePropriete_1"
-  // Second variation with _2
-  | "civilite_2"
-  | "prenoms_2"
-  | "nom_2"
-  | "nationalite_2"
-  | "dateDeNaissance_2"
-  | "paysDeNaissance_2"
-  | "villeDeNaissance_2"
-  | "codePostalDeLaVilleDeNaissance_2"
-  | "paysDuDomicile_2"
-  | "numeroEtVoieDuDomicile_2"
-  | "codePostalDuDomicile_2"
-  | "villeDuDomicile_2"
-  | "partsDirectesPleinePropriete_2"
-  | "partsIndirectesIndivisionPleinePropriete_2"
-  // Third variation with _3
-  | "civilite_3"
-  | "prenoms_3"
-  | "nom_3"
-  | "nationalite_3"
-  | "dateDeNaissance_3"
-  | "paysDeNaissance_3"
-  | "villeDeNaissance_3"
-  | "codePostalDeLaVilleDeNaissance_3"
-  | "paysDuDomicile_3"
-  | "numeroEtVoieDuDomicile_3"
-  | "codePostalDuDomicile_3"
-  | "villeDuDomicile_3"
-  | "partsDirectesPleinePropriete_3"
-  | "partsIndirectesIndivisionPleinePropriete_3";
-
-/**
- * Autocomplete linkedvariables
- */
-export type AutocompleteLinkedVariableType =
-  | "city"
-  | "communal_code"
-  | "postcode"
-  | "company_activity"
-  | "company_capital"
-  | "company_ceased_business"
-  | "company_creation_date"
-  | "company_denomination"
-  | "company_hq_address"
-  | "company_hq_city"
-  | "company_hq_country"
-  | "company_hq_postcode"
-  | "company_legal_status"
-  | "company_naf_code"
-  | "company_siren"
-  | "category"
-  | "nafCode"
-  | "type"
-  | "level1Id"
-  | "level2Id"
-  | "level3Id"
-  | "level4Id"
-  | "shouldAskIfAlcohol"
-  | "shouldAskIfCommercialPremises"
-  | "comptaplaceEligibility"
-  | "comptaplaceCategory"
-  | "regulatedActivityProofNeeded"
-  | "description"
-  | "descriptionIfSellsAlcohol"
-  | "warningText"
-  | RbeLinkedVariableType;