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

package/dist/index.d.ts

@@ -81,13 +81,20 @@ interface Section {
      */
     display_logic?: string;
     /**
-     * The questions in the section (all in one page)
+     * When set, the survey progress bar will not be shown during this section.
      */
-    questions?: Question[];
+    hide_progress_bar?: boolean;
     /**
      * The questions in the section, split into pages
      */
-    pages?: Page[];
+    pages: Page[];
+}
+/** @public */
+interface Page {
+    /**
+     * The questions on the page
+     */
+    questions: Question[];
 }
 /** @public */
 interface Question {
@@ -98,11 +105,7 @@ interface Question {
     /**
      * The question description, in markdown
      */
-    text?: string;
-    /**
-     * The question description, in HTML
-     */
-    text_html?: string;
+    text: string;
     /**
      * The type of question
      */
@@ -115,10 +118,6 @@ interface Question {
      * A boolean expression with logic if this question should be displayed or not
      */
     display_logic?: string;
-    /**
-     * Similar to display_logic, but enables the question to appear on the same page as the depending question
-     */
-    display_logic_in_page?: string;
     /**
      * If the question is required to answer; request means you will get a warning if you skip it but you can.
      */
@@ -146,7 +145,7 @@ interface Question {
         /**
          * The id of the group.
          */
-        id?: string;
+        id: string;
         /**
          * The display name of the group
          */
@@ -167,7 +166,7 @@ interface Question {
         /**
          * The id of the group.
          */
-        id?: string;
+        id: string;
         /**
          * The display name of the group
          */
@@ -179,6 +178,12 @@ interface Question {
         randomization?: Randomization;
     }[];
     randomization?: Randomization;
+    configuration?: {
+        /**
+         * Size of the column with the choice descriptions in a matrix question
+         */
+        choice_column_width_pixels?: number;
+    };
 }
 /** @public */
 interface Statement {
@@ -233,19 +238,12 @@ interface Choice {
     /**
      * If a textbox should appear next to the choice, and if it should be mandatory to fill it in if the choice is selected
      */
-    text?: 'no' | 'optional' | 'forced';
+    text_input?: 'no' | 'optional' | 'forced';
     /**
      * If true, this choice can't be combined with other choices in this question
      */
     exclusive_answer?: boolean;
 }
-/** @public */
-interface Page {
-    /**
-     * The questions on the page
-     */
-    questions: Question[];
-}
 
 /** @public */
 declare const validateTemplate: (template: SurveyTemplate) => void;
@@ -260,32 +258,26 @@ declare const validateTemplate: (template: SurveyTemplate) => void;
  * @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 = {
+/** @public */
+declare enum LOCATOR_EXPRESSION {
+    ALL = "all",
+    ALL_ENTERED_TEXT = "all_entered_text",
+    SELECTED = "selected",
+    SELECTED_ENTERED_TEXT = "selected_entered_text",
+    NOT_SELECTED = "not_selected",
+    FOR_MATRIX_CHOICE = "for_matrix_choice",
+    UNSELECTED_FOR_MATRIX_CHOICE = "unselected_for_matrix_choice"
+}
+/** @public */
+type Locator = {
     questionId: string;
-    statementId: string;
+    expression: LOCATOR_EXPRESSION;
+    identifier?: string | number;
 };
 /** @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;
-};
+declare const validateLocator: (locatorExpression: string) => boolean;
 /** @public */
-declare function evaluateExpression(expression: string, contextEvaluator: LogicContextEvaluator): any;
+declare const parseLocator: (locatorExpression: string) => Locator;
 
 /** @public */
 declare const templateSchema: {
@@ -297,7 +289,6 @@ declare const templateSchema: {
         template: {
             type: string;
             description: string;
-            /** @public */
             properties: {
                 id: {
                     type: string;
@@ -399,12 +390,9 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                questions: {
+                hide_progress_bar: {
                     type: string;
                     description: string;
-                    items: {
-                        $ref: string;
-                    };
                 };
                 pages: {
                     type: string;
@@ -416,9 +404,6 @@ declare const templateSchema: {
             };
             additionalProperties: boolean;
             required: string[];
-            oneOf: {
-                required: string[];
-            }[];
         };
         page: {
             type: string;
@@ -446,10 +431,6 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                text_html: {
-                    type: string;
-                    description: string;
-                };
                 type: {
                     type: string;
                     enum: string[];
@@ -464,10 +445,6 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                display_logic_in_page: {
-                    type: string;
-                    description: string;
-                };
                 required: {
                     type: string;
                     enum: string[];
@@ -575,17 +552,22 @@ declare const templateSchema: {
                 randomization: {
                     $ref: string;
                 };
+                configuration: {
+                    type: string;
+                    properties: {
+                        choice_column_width_pixels: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
             };
             additionalProperties: boolean;
-            allOf: ({
-                oneOf: {
-                    required: string[];
-                }[];
-            } | {
-                oneOf: {
-                    $ref: string;
-                }[];
-            })[];
+            required: string[];
+            oneOf: {
+                $ref: string;
+            }[];
         };
         "question-mc-horizontal": {
             type: string;
@@ -740,7 +722,7 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                text: {
+                text_input: {
                     type: string;
                     enum: string[];
                     description: string;
@@ -812,6 +794,28 @@ declare const templateSchema: {
 /** @public */
 declare const DEFAULT_TEMPLATE_ID = "pulse_default_alpha";
 
+/** @public */
+type Answer = {
+    choiceId?: string | null;
+    choiceValue?: number | null;
+    text?: string | null;
+};
+/** @public */
+type SurveyQuestionResponse = {
+    id: string;
+    surveyId: string;
+    questionId: string;
+    surveyResponseId: string;
+    /** The ID of the statement. Only set if question.type is MATRIX_SINGLE or MATRIX_MULTI. */
+    statementId?: string | null;
+    /** The selected choices for multiple answer questions (mc-multi, matrix-multi). */
+    multipleAnswers?: readonly Answer[] | null;
+    /** The selected choice for single answer questions (mc-single, matrix-single). */
+    singleAnswer?: Answer | null;
+    createdAt: Date;
+    updatedAt: Date;
+};
+
 /** @public */
 declare const permissions: {
     allPermissions: _backstage_plugin_permission_common.BasicPermission[];
@@ -819,4 +823,4 @@ declare const permissions: {
     surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { Choice, ChoiceRef, DEFAULT_TEMPLATE_ID, LogicContextEvaluator, MatrixStatementRef, Page, Question, Randomization, Section, Statement, SurveyTemplate, evaluateExpression, interpolateTemplate, permissions, templateSchema, validateTemplate };
+export { Answer, Choice, DEFAULT_TEMPLATE_ID, LOCATOR_EXPRESSION, Locator, Page, Question, Randomization, Section, Statement, SurveyQuestionResponse, SurveyTemplate, interpolateTemplate, parseLocator, permissions, templateSchema, validateLocator, validateTemplate };