@legalplace/models-v3-types 3.0.0

package/README

@@ -0,0 +1,6 @@
+# Model Typing - V3 Model
+
+## Install - V 3.0.0
+```
+yarn add https://git.legalplace.eu/legalplace/model-v3-types.git#3.0.0
+```

package/index.ts

@@ -0,0 +1,458 @@
+// Type definitions for model v3
+// TypeScript Version: 2.1
+
+type CONDITION_TYPE = 'selected' | 'not-selected' | 'has-one' | 'at-least-one' | 'has-many' | 'contains' | 'does-not-contain' | '=' | '>' | '<' | '!=' | '>=' | '<=' | '<>' | '==';
+type DATA_MAP = {
+  var: string
+};
+type CONDITION = {
+  [key in CONDITION_TYPE]?: [DATA_MAP, (string | number | boolean)?]
+}
+type CONDITION_OPERATOR = { [key in 'and' | 'or']?: (CONDITION_OPERATOR & CONDITION)[] };
+export type ConditionV3 = CONDITION_OPERATOR & CONDITION;
+
+/**
+ * Model
+ */
+export interface ModelV3 {
+  documents: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` ".*".
+     */
+    [k: string]: {
+      /**
+       * Document's name
+       */
+      name: string;
+      /**
+       * Document's sections list
+       */
+      sections: SectionV3[];
+      /**
+       * Document's params
+       */
+      params?: {
+        formats?: {
+          pdf?: boolean;
+          docx?: boolean;
+        };
+        private?: boolean;
+        conditions?: ConditionV3;
+        grantLevel?: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST';
+      };
+    };
+  };
+  options: {
+    [k: string]: OptionV3;
+  };
+  variables: {
+    [k: string]: VariableV3;
+  };
+  customization: {
+    disableAutoDefaut?: boolean;
+    extracts?: ExtractV3[];
+    clientType?: {
+      type: "ind" | "pro" | "conditionnal";
+      conditions?: ConditionV3;
+    }
+  };
+}
+
+/**
+ * Extract V3
+ */
+export interface ExtractV3 {
+  type: 'option' | 'variable';
+  id: number;
+  destination: {
+    sendinblue?: {
+      name: string;
+    };
+    mixpanel?: {
+      name: string;
+    };
+    slack?: {
+      name: string;
+      channel: string;
+    };
+  }
+}
+
+/**
+ * Section V3
+ */
+export interface SectionV3 {
+  /**
+   * Section's id
+   */
+  id: number;
+  /**
+   * Section's grant type
+   */
+  grantLevel?: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST';
+  /**
+   * Section's title
+   */
+  label: string;
+  /**
+   * Section's options
+   */
+  options: number[];
+  /**
+   * Section's conditions
+   */
+  conditions?: ConditionV3;
+  /**
+   * Step two only
+   */
+  step?: '*' | number[];
+  /**
+   * Tags
+   */
+  tags?: string[];
+}
+
+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?: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST';
+    /**
+     * 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;
+    /**
+     * 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;
+    };
+  
+    /**
+     * 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 type
+   */
+  type:
+    | 'text'
+    | 'date'
+    | 'list'
+    | 'textarea'
+    | 'number'
+    | 'eval'
+    | 'hour'
+    | 'email'
+    | 'mask';
+  /**
+   * Variable's grantLevel
+   */
+  grantLevel?: 'ADMIN' | 'MANAGER' | 'USER' | 'GUEST';
+  /**
+   * 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[];
+  /**
+   * 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;
+
+  /**
+   * 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';
+  };
+
+  /**
+   * 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;
+  };
+
+  /**
+   * Termsheet
+   */
+  termsheet?: {
+    /**
+     * Variable's termsheet label
+     */
+    label?: string;
+    /**
+     * Hide variable from termsheet
+     */
+    hide?: boolean;
+  };
+}
+/**
+ * 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;
+}

package/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@legalplace/models-v3-types",
+  "version": "3.0.0",
+  "main": "",
+  "types": "index",
+  "author": "Moncef Hammou <moncef@legalplace.fr>",
+  "license": "MIT"
+}