@spotify/backstage-plugin-pulse-common 0.9.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 {
@@ -111,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.
      */
@@ -175,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 {
@@ -235,13 +244,6 @@ interface Choice {
      */
     exclusive_answer?: boolean;
 }
-/** @public */
-interface Page {
-    /**
-     * The questions on the page
-     */
-    questions: Question[];
-}
 
 /** @public */
 declare const validateTemplate: (template: SurveyTemplate) => void;
@@ -264,9 +266,7 @@ declare enum LOCATOR_EXPRESSION {
     SELECTED_ENTERED_TEXT = "selected_entered_text",
     NOT_SELECTED = "not_selected",
     FOR_MATRIX_CHOICE = "for_matrix_choice",
-    UNSELECTED_FOR_MATRIX_CHOICE = "unselected_for_matrix_choice",
-    DISPLAYED = "displayed",
-    NOT_DISPLAYED = "not_displayed"
+    UNSELECTED_FOR_MATRIX_CHOICE = "unselected_for_matrix_choice"
 }
 /** @public */
 type Locator = {
@@ -279,120 +279,6 @@ declare const validateLocator: (locatorExpression: string) => boolean;
 /** @public */
 declare const parseLocator: (locatorExpression: string) => Locator;
 
-/** @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 */
-type StatementWithGroupInfo = Statement & {
-    groupId?: string;
-    groupDisplay?: string;
-};
-/** @public */
-type ChoiceWithGroupInfo = Choice & {
-    groupId?: string;
-    groupDisplay?: string;
-};
-
-/** 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 */
-declare const getAnswerValue: (answer: Answer) => string | number;
-/** @public */
-type TemplateContextEvaluatorOptions = {
-    surveyId?: string;
-    templateId?: string;
-    surveyResponseId?: string;
-    questions: Question[];
-    questionResponses: SurveyQuestionResponse[];
-};
-/**
- * Provides useful methods for making template schema evaluations given a particular response context
- * @public */
-declare class TemplateContextEvaluator {
-    #private;
-    surveyId?: string;
-    templateId?: string;
-    surveyResponseId?: string;
-    questions: Question[];
-    questionResponses: SurveyQuestionResponse[];
-    constructor(options: TemplateContextEvaluatorOptions);
-    /**
-     * Returns the relevant answers for a particular question. If a statement ID or choice
-     * identifier is provided, answers will be filtered to those matching the specified
-     * inputs.
-     */
-    getQuestionAnswers(questionId: string, statementId?: string | null, choiceIdOrValue?: string | number | null): Answer[];
-    /**
-     * Returns the list of choices or statements referenced by a locator taking into
-     * account the current response context.
-     */
-    evaluateDynamicExpression<T extends Choice | Statement>(locator: Locator, target: 'choices' | 'statements'): T[];
-    isStatementSelected(statement: MatrixStatementRef): boolean;
-    isSelected(choice: ChoiceRef): boolean;
-    isDisplayed(_: ChoiceRef): boolean;
-    countSelected(questionId: string): number;
-    countChoiceSelections(questionId: string, choice: number | string): number;
-    textEntry(choice: ChoiceRef): string;
-}
-/**
- * Returns a context evaluator with no responses which effectively means most
- * display logic expressions would evaluate to false. This evaluator is useful when
- * there is no existing surver response such as when a user first begins taking a survey.
- * @public */
-declare const getBaseContextEvaluator: (questions?: Question[]) => TemplateContextEvaluator;
-/**
- * Evaluates a display logic expression using the given response context
- * @public */
-declare const evaluateDisplayLogic: (evaluator: TemplateContextEvaluator, expression?: string) => boolean;
-/**
- * Returns the question text with any dynamic expressions interpolated.
- * @public
- */
-declare const getQuestionText: (question: Question, evaluator?: TemplateContextEvaluator | null) => string;
-/**
- * Returns all choices that are valid for a particular question given a specific
- * response context. This takes into account choices that are in groups and
- * dynamic choices that may come from other questions.
- *  @public */
-declare const getQuestionChoices: (question: Question, evaluator?: TemplateContextEvaluator | null) => ChoiceWithGroupInfo[];
-/**
- * Returns all statements that are valid for a particular question given a specific
- * response context. This takes into account statements that are in groups and
- * dynamic statements that may come from other questions.
- * @public */
-declare const getQuestionStatements: (question: Question, evaluator?: TemplateContextEvaluator | null) => StatementWithGroupInfo[];
-
 /** @public */
 declare const templateSchema: {
     $id: string;
@@ -504,12 +390,9 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                questions: {
+                hide_progress_bar: {
                     type: string;
                     description: string;
-                    items: {
-                        $ref: string;
-                    };
                 };
                 pages: {
                     type: string;
@@ -521,9 +404,6 @@ declare const templateSchema: {
             };
             additionalProperties: boolean;
             required: string[];
-            oneOf: {
-                required: string[];
-            }[];
         };
         page: {
             type: string;
@@ -565,10 +445,6 @@ declare const templateSchema: {
                     type: string;
                     description: string;
                 };
-                display_logic_in_page: {
-                    type: string;
-                    description: string;
-                };
                 required: {
                     type: string;
                     enum: string[];
@@ -676,6 +552,16 @@ declare const templateSchema: {
                 randomization: {
                     $ref: string;
                 };
+                configuration: {
+                    type: string;
+                    properties: {
+                        choice_column_width_pixels: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
             };
             additionalProperties: boolean;
             required: string[];
@@ -908,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[];
@@ -915,4 +823,4 @@ declare const permissions: {
     surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { Answer, Choice, ChoiceRef, ChoiceWithGroupInfo, DEFAULT_TEMPLATE_ID, LOCATOR_EXPRESSION, Locator, MatrixStatementRef, Page, Question, Randomization, Section, Statement, StatementWithGroupInfo, SurveyQuestionResponse, SurveyTemplate, TemplateContextEvaluator, TemplateContextEvaluatorOptions, evaluateDisplayLogic, getAnswerValue, getBaseContextEvaluator, getQuestionChoices, getQuestionStatements, getQuestionText, interpolateTemplate, parseLocator, permissions, templateSchema, validateLocator, validateTemplate };
+export { Answer, Choice, DEFAULT_TEMPLATE_ID, LOCATOR_EXPRESSION, Locator, Page, Question, Randomization, Section, Statement, SurveyQuestionResponse, SurveyTemplate, interpolateTemplate, parseLocator, permissions, templateSchema, validateLocator, validateTemplate };