@spotify/backstage-plugin-pulse-common 0.6.3 → 0.8.0

package/dist/index.d.ts

@@ -54,7 +54,7 @@ interface SurveyTemplate {
         default?: string | number | boolean;
     }[];
     /**
-     * Expression shortcuts. Macros are referred to elsewhere in the survey using the $\{p:<name>\} construct (same as parameters) and will get lazily in-place replaced. Macros can be recursive and contain references to parameters or answers in the survey.
+     * Expression shortcuts. Macros are referred to elsewhere in the survey using the $\{m:<name>\} construct (similar to parameters) and will get lazily in-place replaced. Macros can be recursive and contain references to parameters or answers in the survey.
      */
     macros?: {
         [k: string]: string;
@@ -62,33 +62,32 @@ interface SurveyTemplate {
     /**
      * The survey sections, in the order they will appear in the survey
      */
-    sections: {
-        /**
-         * The id of this section
-         */
-        id: string;
-        /**
-         * The name of this section
-         */
-        name: string;
-        /**
-         * An optional boolean expression that decides if the surveyee should see the questions in this section.
-         */
-        display_logic?: string;
-        /**
-         * The questions in the section (all in one page)
-         */
-        questions?: Question[];
-        /**
-         * The questions in the section, split into pages
-         */
-        pages?: {
-            /**
-             * The questions on the page
-             */
-            questions: Question[];
-        }[];
-    }[];
+    sections: Section[];
+}
+/**
+ * A survey section.
+ * @public */
+interface Section {
+    /**
+     * The id of this section
+     */
+    id: string;
+    /**
+     * The name of this section
+     */
+    name: string;
+    /**
+     * An optional boolean expression that decides if the surveyee should see the questions in this section.
+     */
+    display_logic?: string;
+    /**
+     * The questions in the section (all in one page)
+     */
+    questions?: Question[];
+    /**
+     * The questions in the section, split into pages
+     */
+    pages?: Page[];
 }
 /** @public */
 interface Question {
@@ -145,7 +144,7 @@ interface Question {
     statement_groups?: {
         statements: Statement[];
         /**
-         * The id of the group. Need only be set if referenced to in constrained randomization.
+         * The id of the group.
          */
         id?: string;
         /**
@@ -166,7 +165,7 @@ interface Question {
     choice_groups?: {
         choices: Choice[];
         /**
-         * The id of the group. Need only be set if referenced to in constrained randomization.
+         * The id of the group.
          */
         id?: string;
         /**
@@ -198,8 +197,7 @@ interface Statement {
 }
 /**
  * Configuration of the display order randomization of choices, statements or groups.
- */
-/** @public */
+ * @public */
 interface Randomization {
     /**
      * The type of randomization: randomize all items, a subset of them, or using constrained randomization
@@ -241,10 +239,54 @@ interface Choice {
      */
     exclusive_answer?: boolean;
 }
+/** @public */
+interface Page {
+    /**
+     * The questions on the page
+     */
+    questions: Question[];
+}
 
 /** @public */
 declare const validateTemplate: (template: SurveyTemplate) => void;
 
+/**
+ * Mutates the template by replacing all references to $\{m:<macro>\} with
+ * the evaluation of the macro. This can and must be done once after
+ * loading the template and before evaluating any expression etc.
+ *
+ * The interpolation is idempotent.
+ *
+ * @public */
+declare const interpolateTemplate: (template: SurveyTemplate) => SurveyTemplate;
+
+/** Refers to a specific choice in a specific question/statement
+ * If statementId is defined, questionId.statementId is the full path
+ * to this choice
+ * @public */
+type ChoiceRef = {
+    questionId: string;
+    statementId?: string;
+    choice: string | number;
+};
+/** Refers to a specific statement in a matrix
+ * @public */
+type MatrixStatementRef = {
+    questionId: string;
+    statementId: string;
+};
+/** @public */
+type LogicContextEvaluator = {
+    surveyResponseId?: string;
+    isSelected: (choice: ChoiceRef) => boolean;
+    isDisplayed: (choice: ChoiceRef) => boolean;
+    countSelected: (questionId: string) => number;
+    countChoiceSelections: (questionId: string, choice: number | string) => number;
+    textEntry: (choiceRef: ChoiceRef) => string;
+};
+/** @public */
+declare function evaluateExpression(expression: string, contextEvaluator: LogicContextEvaluator): any;
+
 /** @public */
 declare const templateSchema: {
     $id: string;
@@ -255,6 +297,7 @@ declare const templateSchema: {
         template: {
             type: string;
             description: string;
+            /** @public */
             properties: {
                 id: {
                     type: string;
@@ -331,60 +374,66 @@ declare const templateSchema: {
             type: string;
             description: string;
             items: {
-                type: string;
-                description: string;
-                properties: {
-                    id: {
-                        type: string;
-                        description: string;
-                        format: string;
-                        pattern: string;
-                    };
-                    name: {
-                        type: string;
-                        description: string;
-                    };
-                    display_logic: {
-                        type: string;
-                        description: string;
-                    };
-                    questions: {
-                        type: string;
-                        description: string;
-                        items: {
-                            $ref: string;
-                        };
-                    };
-                    pages: {
-                        type: string;
-                        description: string;
-                        items: {
-                            type: string;
-                            properties: {
-                                questions: {
-                                    type: string;
-                                    description: string;
-                                    items: {
-                                        $ref: string;
-                                    };
-                                };
-                            };
-                            required: string[];
-                            additionalProperties: boolean;
-                        };
-                    };
-                };
-                additionalProperties: boolean;
-                required: string[];
-                oneOf: {
-                    required: string[];
-                }[];
+                $ref: string;
             };
         };
     };
     additionalProperties: boolean;
     required: string[];
     $defs: {
+        section: {
+            type: string;
+            description: string;
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                    format: string;
+                    pattern: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                };
+                display_logic: {
+                    type: string;
+                    description: string;
+                };
+                questions: {
+                    type: string;
+                    description: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                pages: {
+                    type: string;
+                    description: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+            };
+            additionalProperties: boolean;
+            required: string[];
+            oneOf: {
+                required: string[];
+            }[];
+        };
+        page: {
+            type: string;
+            properties: {
+                questions: {
+                    type: string;
+                    description: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
         question: {
             type: string;
             properties: {
@@ -770,4 +819,4 @@ declare const permissions: {
     surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { Choice, DEFAULT_TEMPLATE_ID, Question, Randomization, Statement, SurveyTemplate, permissions, templateSchema, validateTemplate };
+export { Choice, ChoiceRef, DEFAULT_TEMPLATE_ID, LogicContextEvaluator, MatrixStatementRef, Page, Question, Randomization, Section, Statement, SurveyTemplate, evaluateExpression, interpolateTemplate, permissions, templateSchema, validateTemplate };