@spotify/backstage-plugin-pulse-common 0.6.2 → 0.7.0

package/dist/index.d.ts

@@ -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 {
@@ -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,538 @@ interface Choice {
      */
     exclusive_answer?: boolean;
 }
+/** @public */
+interface Page {
+    /**
+     * The questions on the page
+     */
+    questions: Question[];
+}
 
 /** @public */
 declare const validateTemplate: (template: SurveyTemplate) => void;
 
+/** @public */
+declare const templateSchema: {
+    $id: string;
+    $schema: string;
+    title: string;
+    type: string;
+    properties: {
+        template: {
+            type: string;
+            description: string;
+            properties: {
+                id: {
+                    type: string;
+                    description: string;
+                    format: string;
+                    pattern: string;
+                    minLength: number;
+                };
+                version: {
+                    type: string;
+                    format: string;
+                    pattern: string;
+                    description: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                    minLength: number;
+                };
+                description: {
+                    type: string;
+                    description: string;
+                };
+                owner: {
+                    type: string;
+                    description: string;
+                    minLength: number;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+        parameters: {
+            type: string;
+            description: string;
+            items: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                        description: string;
+                        format: string;
+                        pattern: string;
+                    };
+                    description: {
+                        type: string;
+                        description: string;
+                    };
+                    format: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    default: {
+                        type: string[];
+                        description: string;
+                    };
+                };
+                required: string[];
+                oneOf: {
+                    required: string[];
+                }[];
+                additionalProperties: boolean;
+            };
+        };
+        macros: {
+            type: string;
+            description: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        sections: {
+            type: string;
+            description: string;
+            items: {
+                $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: {
+                id: {
+                    type: string;
+                    description: string;
+                    pattern: string;
+                };
+                text: {
+                    type: string;
+                    description: string;
+                };
+                text_html: {
+                    type: string;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                layout: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                display_logic: {
+                    type: string;
+                    description: string;
+                };
+                display_logic_in_page: {
+                    type: string;
+                    description: string;
+                };
+                required: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                validation: {
+                    type: string;
+                    description: string;
+                    properties: {
+                        min_choices: {
+                            type: string;
+                            description: string;
+                        };
+                        max_choices: {
+                            type: string;
+                            description: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+                statements: {
+                    type: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                dynamic_statements: {
+                    type: string;
+                    description: string;
+                    pattern: string;
+                };
+                statement_groups: {
+                    type: string;
+                    items: {
+                        type: string;
+                        properties: {
+                            statements: {
+                                type: string;
+                                items: {
+                                    $ref: string;
+                                };
+                            };
+                            id: {
+                                type: string;
+                                description: string;
+                            };
+                            display: {
+                                type: string;
+                                description: string;
+                            };
+                            display_logic: {
+                                type: string;
+                                description: string;
+                            };
+                            randomization: {
+                                $ref: string;
+                            };
+                        };
+                        required: string[];
+                        additionalProperties: boolean;
+                    };
+                };
+                choices: {
+                    type: string;
+                    items: {
+                        $ref: string;
+                    };
+                };
+                dynamic_choices: {
+                    type: string;
+                    description: string;
+                    pattern: string;
+                };
+                choice_groups: {
+                    type: string;
+                    items: {
+                        type: string;
+                        properties: {
+                            choices: {
+                                type: string;
+                                items: {
+                                    $ref: string;
+                                };
+                            };
+                            id: {
+                                type: string;
+                                description: string;
+                            };
+                            display: {
+                                type: string;
+                                description: string;
+                            };
+                            display_logic: {
+                                type: string;
+                                description: string;
+                            };
+                            randomization: {
+                                $ref: string;
+                            };
+                        };
+                        required: string[];
+                        additionalProperties: boolean;
+                    };
+                };
+                randomization: {
+                    $ref: string;
+                };
+            };
+            additionalProperties: boolean;
+            allOf: ({
+                oneOf: {
+                    required: string[];
+                }[];
+            } | {
+                oneOf: {
+                    $ref: string;
+                }[];
+            })[];
+        };
+        "question-mc-horizontal": {
+            type: string;
+            properties: {
+                type: {
+                    enum: string[];
+                };
+                position: {
+                    const: string;
+                };
+            };
+            required: string[];
+            not: {
+                anyOf: {
+                    required: string[];
+                }[];
+            };
+        };
+        "question-mc-vertical": {
+            type: string;
+            properties: {
+                type: {
+                    enum: string[];
+                };
+                position: {
+                    const: string;
+                };
+            };
+            required: string[];
+            not: {
+                anyOf: {
+                    required: string[];
+                }[];
+            };
+            oneOf: ({
+                anyOf: {
+                    required: string[];
+                }[];
+                not: {
+                    required: string[];
+                    anyOf?: undefined;
+                };
+                required?: undefined;
+            } | {
+                required: string[];
+                not: {
+                    anyOf: {
+                        required: string[];
+                    }[];
+                    required?: undefined;
+                };
+                anyOf?: undefined;
+            })[];
+        };
+        "question-matrix": {
+            type: string;
+            properties: {
+                type: {
+                    enum: string[];
+                };
+            };
+            required: string[];
+            not: {
+                anyOf: {
+                    required: string[];
+                }[];
+            };
+            oneOf: ({
+                anyOf: {
+                    required: string[];
+                }[];
+                not: {
+                    required: string[];
+                    anyOf?: undefined;
+                };
+                required?: undefined;
+            } | {
+                required: string[];
+                not: {
+                    anyOf: {
+                        required: string[];
+                    }[];
+                    required?: undefined;
+                };
+                anyOf?: undefined;
+            })[];
+        };
+        "question-text": {
+            type: string;
+            properties: {
+                type: {
+                    enum: string[];
+                };
+            };
+            required: string[];
+            not: {
+                anyOf: {
+                    required: string[];
+                }[];
+            };
+        };
+        "question-description": {
+            type: string;
+            properties: {
+                type: {
+                    const: string;
+                };
+            };
+            not: {
+                anyOf: {
+                    required: string[];
+                }[];
+            };
+        };
+        statement: {
+            type: string;
+            properties: {
+                id: {
+                    type: string;
+                    pattern: string;
+                    description: string;
+                };
+                display: {
+                    type: string;
+                    description: string;
+                };
+                display_logic: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
+        choice: {
+            type: string;
+            properties: {
+                display: {
+                    type: string;
+                    description: string;
+                };
+                id: {
+                    type: string;
+                    pattern: string;
+                    description: string;
+                };
+                value: {
+                    type: string;
+                    description: string;
+                };
+                display_logic: {
+                    type: string;
+                    description: string;
+                };
+                text: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                exclusive_answer: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            oneOf: {
+                required: string[];
+            }[];
+            additionalProperties: boolean;
+        };
+        randomization: {
+            type: string;
+            description: string;
+            properties: {
+                type: {
+                    type: string;
+                    description: string;
+                    enum: string[];
+                };
+                total: {
+                    type: string;
+                    description: string;
+                };
+                order: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            oneOf: ({
+                properties: {
+                    type: {
+                        const: string;
+                    };
+                };
+                not: {
+                    required: string[];
+                };
+                required?: undefined;
+            } | {
+                properties: {
+                    type: {
+                        const: string;
+                    };
+                };
+                required: string[];
+                not: {
+                    required: string[];
+                };
+            } | {
+                properties: {
+                    type: {
+                        const: string;
+                    };
+                };
+                required: string[];
+                not?: undefined;
+            })[];
+            additionalProperties: boolean;
+        };
+    };
+};
+
 /** @public */
 declare const DEFAULT_TEMPLATE_ID = "pulse_default_alpha";
 
@@ -255,4 +781,4 @@ declare const permissions: {
     surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { Choice, DEFAULT_TEMPLATE_ID, Question, Randomization, Statement, SurveyTemplate, permissions, validateTemplate };
+export { Choice, DEFAULT_TEMPLATE_ID, Page, Question, Randomization, Section, Statement, SurveyTemplate, permissions, templateSchema, validateTemplate };