@spotify/backstage-plugin-pulse-common 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @spotify/backstage-plugin-pulse-common
 
+## 0.6.0
+
+### Minor Changes
+
+- Changed how survey questions are loaded to allow customization in the future.
+
+### Patch Changes
+
+- Upgraded Backstage to `v1.13.0`.
+- Added utilities for handling survey templates.
+
 ## 0.5.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var s=require("@backstage/plugin-permission-common");const i="survey-instance",e=s.createPermission({name:"survey.instance.administer",attributes:{action:"create"}}),r=[e],n={allPermissions:r,SURVEY_RESOURCE_TYPE:i,surveyAdministerPermission:e};exports.permissions=n;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var o=require("@backstage/plugin-permission-common"),n=require("ajv"),a=require("ajv-formats");function t(e){return e&&typeof e=="object"&&"default"in e?e:{default:e}}var d=t(n),p=t(a);const c="survey-instance",i=o.createPermission({name:"survey.instance.administer",attributes:{action:"create"}}),u=[i];var l="http://json-schema.org/draft-07/schema",m="Survey Template",y="object",h={template:{type:"object",description:"Meta data about the survey template",properties:{id:{type:"string",description:"An id of the survey template. If there are multiple templates with the same id, they must have different versions.",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$",minLength:1},version:{type:"string",format:"regex",pattern:"^[0-9]+(\\.[0-9]+)?$",description:"A version of template"},name:{type:"string",description:"The display name of the survey template",minLength:1},description:{type:"string",description:"A longer description of the survey template"},owner:{type:"string",description:"The owner of the survey template",minLength:1}},required:["id","version","name","owner"],additionalProperties:!1},parameters:{type:"array",description:"Template parameters that can or must be set when creating a survey from this template. Parameters are referred to elsewhere in the survey using the ${p:<id>} construct and will get lazily in-place replaced.",items:{type:"object",properties:{id:{type:"string",description:"The id of the parameter",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$"},description:{type:"string",description:"The description of the parameter"},format:{type:"string",enum:["string","number","boolean"],description:"The format of the parameter. Should only be set if a default value is not provided."},default:{type:["string","number","boolean"],description:"An optional default value of this parameter. If this is omitted, the parameter must be provided when creating a survey from the template."}},required:["id","description"],oneOf:[{required:["format"]},{required:["default"]}],additionalProperties:!1}},macros:{type:"object",description:"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.",additionalProperties:{type:"string"}},sections:{type:"array",description:"The survey sections, in the order they will appear in the survey",items:{type:"object",description:"A survey section.",properties:{id:{type:"string",description:"The id of this section",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$"},name:{type:"string",description:"The name of this section"},display_logic:{type:"string",description:"An optional boolean expression that decides if the surveyee should see the questions in this section."},questions:{type:"array",description:"The questions in the section (all in one page)",items:{$ref:"#/$defs/question"}},pages:{type:"array",description:"The questions in the section, split into pages",items:{type:"object",properties:{questions:{type:"array",description:"The questions on the page",items:{$ref:"#/$defs/question"}}},required:["questions"],additionalProperties:!1}}},additionalProperties:!1,required:["id","name"],oneOf:[{required:["questions"]},{required:["pages"]}]}}},f=!1,g=["template","parameters","sections"],q={question:{type:"object",properties:{id:{type:"string",description:"The unique ID of the question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$"},text:{type:"string",description:"The question description, in markdown"},text_html:{type:"string",description:"The question description, in HTML"},type:{type:"string",enum:["mc-single","mc-multi","matrix-single","matrix-multi","text-single","text-multi","description"],description:"The type of question"},layout:{type:"string",enum:["vertical","horizontal"],description:"Determines the visual layout of the options in multiple choice questions"},display_logic:{type:"string",description:"A boolean expression with logic if this question should be displayed or not"},display_logic_in_page:{type:"string",description:"Similar to display_logic, but enables the question to appear on the same page as the depending question"},required:{type:"string",enum:["required","optional","request"],description:"If the question is required to answer; request means you will get a warning if you skip it but you can."},validation:{type:"object",description:"Validation constraints on the question. Only applied if the user has answered the question, so typically used in combination with required",properties:{min_choices:{type:"integer",description:"The minimum number of choices to user can pick (multiple choice questions only)"},max_choices:{type:"integer",description:"The maximum number of choices to user can pick (multiple choice questions only)"}},additionalProperties:!1},statements:{type:"array",items:{$ref:"#/$defs/statement"}},dynamic_statements:{type:"string",description:"Carry forward statements from a previous question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*/(all|selected|all_entered_text|selected_entered_text|not_selected|displayed|not_displayed|for_matrix_choice\\([\\-a-zA-Z0-9_]+\\)|unselected_for_matrix_choice\\([\\-a-zA-Z0-9_]+\\))$"},statement_groups:{type:"array",items:{type:"object",properties:{statements:{type:"array",items:{$ref:"#/$defs/statement"}},id:{type:"string",description:"The id of the group. Need only be set if referenced to in constrained randomization."},display:{type:"string",description:"The display name of the group"},display_logic:{type:"string",description:"A boolean expression determining if the group should be displayed"},randomization:{$ref:"#/$defs/randomization"}},required:["statements","display"],additionalProperties:!1}},choices:{type:"array",items:{$ref:"#/$defs/choice"}},dynamic_choices:{type:"string",description:"Carry forward choices from a previous question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*/(all|selected|all_entered_text|selected_entered_text|not_selected|displayed|not_displayed|for_matrix_choice\\([\\-a-zA-Z0-9_]+\\)|unselected_for_matrix_choice\\([\\-a-zA-Z0-9_]+\\))$"},choice_groups:{type:"array",items:{type:"object",properties:{choices:{type:"array",items:{$ref:"#/$defs/choice"}},id:{type:"string",description:"The id of the group. Need only be set if referenced to in constrained randomization."},display:{type:"string",description:"The display name of the group"},display_logic:{type:"string",description:"A boolean expression determining if the group should be displayed"},randomization:{$ref:"#/$defs/randomization"}},required:["choices","display"],additionalProperties:!1}},randomization:{$ref:"#/$defs/randomization"}},additionalProperties:!1,allOf:[{oneOf:[{required:["text"]},{required:["text_html"]}]},{oneOf:[{$ref:"#/$defs/question-mc-horizontal"},{$ref:"#/$defs/question-mc-vertical"},{$ref:"#/$defs/question-matrix"},{$ref:"#/$defs/question-text"},{$ref:"#/$defs/question-description"}]}]},"question-mc-horizontal":{type:"object",properties:{type:{enum:["mc-single","mc-multi"]},position:{const:"horizontal"}},required:["id","type","position","choices"],not:{anyOf:[{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["dynamic_statements"]},{required:["statement_groups"]}]}},"question-mc-vertical":{type:"object",properties:{type:{enum:["mc-single","mc-multi"]},position:{const:"vertical"}},required:["id","type"],not:{anyOf:[{required:["statements"]},{required:["dynamic_statements"]},{required:["statement_groups"]}]},oneOf:[{anyOf:[{required:["choices"]},{required:["dynamic_choices"]}],not:{required:["choice_groups"]}},{required:["choice_groups"],not:{anyOf:[{required:["choices"]},{required:["dynamic_choices"]}]}}]},"question-matrix":{type:"object",properties:{type:{enum:["matrix-single","matrix-multi"]}},required:["id","type","choices"],not:{anyOf:[{required:["dynamic_choices"]},{required:["choice_groups"]}]},oneOf:[{anyOf:[{required:["statements"]},{required:["dynamic_statements"]}],not:{required:["statement_groups"]}},{required:["statement_groups"],not:{anyOf:[{required:["statements"]},{required:["dynamic_statements"]}]}}]},"question-text":{type:"object",properties:{type:{enum:["text-single","text-multi"]}},required:["id","type"],not:{anyOf:[{required:["choices"]},{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["statement_groups"]},{required:["dynamic_statements"]},{required:["randomization"]}]}},"question-description":{type:"object",properties:{type:{const:"description"}},not:{anyOf:[{required:["choices"]},{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["statement_groups"]},{required:["dynamic_statements"]},{required:["randomization"]}]}},statement:{type:"object",properties:{id:{type:"string",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$",description:"The id of the statement"},display:{type:"string",description:"The statement name, as shown to the surveyee"},display_logic:{type:"string",description:"A boolean expression determining if the statement should be displayed"}},required:["id","display"],additionalProperties:!1},choice:{type:"object",properties:{display:{type:"string",description:"The choice name, as shown to the surveyee"},id:{type:"string",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$",description:"The id of the choice"},value:{type:"integer",description:"The value the choice"},display_logic:{type:"string",description:"A boolean expression determining if the choice should be displayed"},text:{type:"string",enum:["no","optional","forced"],description:"If a textbox should appear next to the choice, and if it should be mandatory to fill it in if the choice is selected"},exclusive_answer:{type:"boolean",description:"If true, this choice can't be combined with other choices in this question"}},required:["display"],anyOf:[{required:["value"]},{required:["id"]}],additionalProperties:!1},randomization:{type:"object",description:"Configuration of the display order randomization of choices, statements or groups.",properties:{type:{type:"string",description:"The type of randomization: randomize all items, a subset of them, or using constrained randomization",enum:["all","subset","constrained"]},total:{type:"integer",description:"Maximum number of items to show"},order:{type:"string",description:"A space separated string containing the order of the items; each 'word' is either an id of some item or the wildcard $ representing the remaining items"}},required:["type"],oneOf:[{properties:{type:{const:"all"}},not:{required:["total","order"]}},{properties:{type:{const:"subset"}},required:["total"],not:{required:["order"]}},{properties:{type:{const:"constrained"}},required:["order"]}],additionalProperties:!1}},_={$schema:l,title:m,type:y,properties:h,additionalProperties:f,required:g,$defs:q};const r=new d.default({allowUnionTypes:!0});p.default(r);const s=r.compile(_),v=e=>{if(!s(e))throw new Error(`Invalid template: ${e.template.id}. Reason: ${s.errors}`)},b="pulse_default_alpha",$={allPermissions:u,SURVEY_RESOURCE_TYPE:c,surveyAdministerPermission:i};exports.DEFAULT_TEMPLATE_ID=b,exports.permissions=$,exports.validateTemplate=v;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.d.ts

@@ -1,5 +1,253 @@
 import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
 
+/**
+ * Types automatically generated by `yarn json2ts`.
+ * To resolve api-report warnings you will need to manually add @public tags
+ * and escape chars for macro braces ("${p:<id>}").
+ */
+/** @public */
+interface SurveyTemplate {
+    /**
+     * Meta data about the survey template
+     */
+    template: {
+        /**
+         * An id of the survey template. If there are multiple templates with the same id, they must have different versions.
+         */
+        id: string;
+        /**
+         * A version of template
+         */
+        version: string;
+        /**
+         * The display name of the survey template
+         */
+        name: string;
+        /**
+         * A longer description of the survey template
+         */
+        description?: string;
+        /**
+         * The owner of the survey template
+         */
+        owner: string;
+    };
+    /**
+     * Template parameters that can or must be set when creating a survey from this template. Parameters are referred to elsewhere in the survey using the $\{p:<id>\} construct and will get lazily in-place replaced.
+     */
+    parameters: {
+        /**
+         * The id of the parameter
+         */
+        id: string;
+        /**
+         * The description of the parameter
+         */
+        description: string;
+        /**
+         * The format of the parameter. Should only be set if a default value is not provided.
+         */
+        format?: 'string' | 'number' | 'boolean';
+        /**
+         * An optional default value of this parameter. If this is omitted, the parameter must be provided when creating a survey from the template.
+         */
+        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.
+     */
+    macros?: {
+        [k: string]: string;
+    };
+    /**
+     * 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[];
+        }[];
+    }[];
+}
+/** @public */
+interface Question {
+    /**
+     * The unique ID of the question
+     */
+    id?: string;
+    /**
+     * The question description, in markdown
+     */
+    text?: string;
+    /**
+     * The question description, in HTML
+     */
+    text_html?: string;
+    /**
+     * The type of question
+     */
+    type?: 'mc-single' | 'mc-multi' | 'matrix-single' | 'matrix-multi' | 'text-single' | 'text-multi' | 'description';
+    /**
+     * Determines the visual layout of the options in multiple choice questions
+     */
+    layout?: 'vertical' | 'horizontal';
+    /**
+     * 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.
+     */
+    required?: 'required' | 'optional' | 'request';
+    /**
+     * Validation constraints on the question. Only applied if the user has answered the question, so typically used in combination with required
+     */
+    validation?: {
+        /**
+         * The minimum number of choices to user can pick (multiple choice questions only)
+         */
+        min_choices?: number;
+        /**
+         * The maximum number of choices to user can pick (multiple choice questions only)
+         */
+        max_choices?: number;
+    };
+    statements?: Statement[];
+    /**
+     * Carry forward statements from a previous question
+     */
+    dynamic_statements?: string;
+    statement_groups?: {
+        statements: Statement[];
+        /**
+         * The id of the group. Need only be set if referenced to in constrained randomization.
+         */
+        id?: string;
+        /**
+         * The display name of the group
+         */
+        display: string;
+        /**
+         * A boolean expression determining if the group should be displayed
+         */
+        display_logic?: string;
+        randomization?: Randomization;
+    }[];
+    choices?: Choice[];
+    /**
+     * Carry forward choices from a previous question
+     */
+    dynamic_choices?: string;
+    choice_groups?: {
+        choices: Choice[];
+        /**
+         * The id of the group. Need only be set if referenced to in constrained randomization.
+         */
+        id?: string;
+        /**
+         * The display name of the group
+         */
+        display: string;
+        /**
+         * A boolean expression determining if the group should be displayed
+         */
+        display_logic?: string;
+        randomization?: Randomization;
+    }[];
+    randomization?: Randomization;
+}
+/** @public */
+interface Statement {
+    /**
+     * The id of the statement
+     */
+    id: string;
+    /**
+     * The statement name, as shown to the surveyee
+     */
+    display: string;
+    /**
+     * A boolean expression determining if the statement should be displayed
+     */
+    display_logic?: string;
+}
+/**
+ * Configuration of the display order randomization of choices, statements or groups.
+ */
+/** @public */
+interface Randomization {
+    /**
+     * The type of randomization: randomize all items, a subset of them, or using constrained randomization
+     */
+    type: 'all' | 'subset' | 'constrained';
+    /**
+     * Maximum number of items to show
+     */
+    total?: number;
+    /**
+     * A space separated string containing the order of the items; each 'word' is either an id of some item or the wildcard $ representing the remaining items
+     */
+    order?: string;
+}
+/** @public */
+interface Choice {
+    /**
+     * The choice name, as shown to the surveyee
+     */
+    display: string;
+    /**
+     * The id of the choice
+     */
+    id?: string;
+    /**
+     * The value the choice
+     */
+    value?: number;
+    /**
+     * A boolean expression determining if the choice should be displayed
+     */
+    display_logic?: string;
+    /**
+     * 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';
+    /**
+     * If true, this choice can't be combined with other choices in this question
+     */
+    exclusive_answer?: boolean;
+}
+
+/** @public */
+declare const validateTemplate: (template: SurveyTemplate) => void;
+
+/** @public */
+declare const DEFAULT_TEMPLATE_ID = "pulse_default_alpha";
+
 /** @public */
 declare const permissions: {
     allPermissions: _backstage_plugin_permission_common.BasicPermission[];
@@ -7,4 +255,4 @@ declare const permissions: {
     surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { permissions };
+export { Choice, DEFAULT_TEMPLATE_ID, Question, Randomization, Statement, SurveyTemplate, permissions, validateTemplate };

package/dist/index.esm.js

@@ -1,2 +1,2 @@
-import{createPermission as i}from"@backstage/plugin-permission-common";const e="survey-instance",s=i({name:"survey.instance.administer",attributes:{action:"create"}}),r=[s],n={allPermissions:r,SURVEY_RESOURCE_TYPE:e,surveyAdministerPermission:s};export{n as permissions};
+import{createPermission as s}from"@backstage/plugin-permission-common";import o from"ajv";import n from"ajv-formats";const a="survey-instance",t=s({name:"survey.instance.administer",attributes:{action:"create"}}),p=[t];var d="http://json-schema.org/draft-07/schema",c="Survey Template",u="object",m={template:{type:"object",description:"Meta data about the survey template",properties:{id:{type:"string",description:"An id of the survey template. If there are multiple templates with the same id, they must have different versions.",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$",minLength:1},version:{type:"string",format:"regex",pattern:"^[0-9]+(\\.[0-9]+)?$",description:"A version of template"},name:{type:"string",description:"The display name of the survey template",minLength:1},description:{type:"string",description:"A longer description of the survey template"},owner:{type:"string",description:"The owner of the survey template",minLength:1}},required:["id","version","name","owner"],additionalProperties:!1},parameters:{type:"array",description:"Template parameters that can or must be set when creating a survey from this template. Parameters are referred to elsewhere in the survey using the ${p:<id>} construct and will get lazily in-place replaced.",items:{type:"object",properties:{id:{type:"string",description:"The id of the parameter",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$"},description:{type:"string",description:"The description of the parameter"},format:{type:"string",enum:["string","number","boolean"],description:"The format of the parameter. Should only be set if a default value is not provided."},default:{type:["string","number","boolean"],description:"An optional default value of this parameter. If this is omitted, the parameter must be provided when creating a survey from the template."}},required:["id","description"],oneOf:[{required:["format"]},{required:["default"]}],additionalProperties:!1}},macros:{type:"object",description:"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.",additionalProperties:{type:"string"}},sections:{type:"array",description:"The survey sections, in the order they will appear in the survey",items:{type:"object",description:"A survey section.",properties:{id:{type:"string",description:"The id of this section",format:"regex",pattern:"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$"},name:{type:"string",description:"The name of this section"},display_logic:{type:"string",description:"An optional boolean expression that decides if the surveyee should see the questions in this section."},questions:{type:"array",description:"The questions in the section (all in one page)",items:{$ref:"#/$defs/question"}},pages:{type:"array",description:"The questions in the section, split into pages",items:{type:"object",properties:{questions:{type:"array",description:"The questions on the page",items:{$ref:"#/$defs/question"}}},required:["questions"],additionalProperties:!1}}},additionalProperties:!1,required:["id","name"],oneOf:[{required:["questions"]},{required:["pages"]}]}}},l=!1,y=["template","parameters","sections"],h={question:{type:"object",properties:{id:{type:"string",description:"The unique ID of the question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$"},text:{type:"string",description:"The question description, in markdown"},text_html:{type:"string",description:"The question description, in HTML"},type:{type:"string",enum:["mc-single","mc-multi","matrix-single","matrix-multi","text-single","text-multi","description"],description:"The type of question"},layout:{type:"string",enum:["vertical","horizontal"],description:"Determines the visual layout of the options in multiple choice questions"},display_logic:{type:"string",description:"A boolean expression with logic if this question should be displayed or not"},display_logic_in_page:{type:"string",description:"Similar to display_logic, but enables the question to appear on the same page as the depending question"},required:{type:"string",enum:["required","optional","request"],description:"If the question is required to answer; request means you will get a warning if you skip it but you can."},validation:{type:"object",description:"Validation constraints on the question. Only applied if the user has answered the question, so typically used in combination with required",properties:{min_choices:{type:"integer",description:"The minimum number of choices to user can pick (multiple choice questions only)"},max_choices:{type:"integer",description:"The maximum number of choices to user can pick (multiple choice questions only)"}},additionalProperties:!1},statements:{type:"array",items:{$ref:"#/$defs/statement"}},dynamic_statements:{type:"string",description:"Carry forward statements from a previous question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*/(all|selected|all_entered_text|selected_entered_text|not_selected|displayed|not_displayed|for_matrix_choice\\([\\-a-zA-Z0-9_]+\\)|unselected_for_matrix_choice\\([\\-a-zA-Z0-9_]+\\))$"},statement_groups:{type:"array",items:{type:"object",properties:{statements:{type:"array",items:{$ref:"#/$defs/statement"}},id:{type:"string",description:"The id of the group. Need only be set if referenced to in constrained randomization."},display:{type:"string",description:"The display name of the group"},display_logic:{type:"string",description:"A boolean expression determining if the group should be displayed"},randomization:{$ref:"#/$defs/randomization"}},required:["statements","display"],additionalProperties:!1}},choices:{type:"array",items:{$ref:"#/$defs/choice"}},dynamic_choices:{type:"string",description:"Carry forward choices from a previous question",pattern:"^[a-zA-Z][a-zA-Z0-9_]*/(all|selected|all_entered_text|selected_entered_text|not_selected|displayed|not_displayed|for_matrix_choice\\([\\-a-zA-Z0-9_]+\\)|unselected_for_matrix_choice\\([\\-a-zA-Z0-9_]+\\))$"},choice_groups:{type:"array",items:{type:"object",properties:{choices:{type:"array",items:{$ref:"#/$defs/choice"}},id:{type:"string",description:"The id of the group. Need only be set if referenced to in constrained randomization."},display:{type:"string",description:"The display name of the group"},display_logic:{type:"string",description:"A boolean expression determining if the group should be displayed"},randomization:{$ref:"#/$defs/randomization"}},required:["choices","display"],additionalProperties:!1}},randomization:{$ref:"#/$defs/randomization"}},additionalProperties:!1,allOf:[{oneOf:[{required:["text"]},{required:["text_html"]}]},{oneOf:[{$ref:"#/$defs/question-mc-horizontal"},{$ref:"#/$defs/question-mc-vertical"},{$ref:"#/$defs/question-matrix"},{$ref:"#/$defs/question-text"},{$ref:"#/$defs/question-description"}]}]},"question-mc-horizontal":{type:"object",properties:{type:{enum:["mc-single","mc-multi"]},position:{const:"horizontal"}},required:["id","type","position","choices"],not:{anyOf:[{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["dynamic_statements"]},{required:["statement_groups"]}]}},"question-mc-vertical":{type:"object",properties:{type:{enum:["mc-single","mc-multi"]},position:{const:"vertical"}},required:["id","type"],not:{anyOf:[{required:["statements"]},{required:["dynamic_statements"]},{required:["statement_groups"]}]},oneOf:[{anyOf:[{required:["choices"]},{required:["dynamic_choices"]}],not:{required:["choice_groups"]}},{required:["choice_groups"],not:{anyOf:[{required:["choices"]},{required:["dynamic_choices"]}]}}]},"question-matrix":{type:"object",properties:{type:{enum:["matrix-single","matrix-multi"]}},required:["id","type","choices"],not:{anyOf:[{required:["dynamic_choices"]},{required:["choice_groups"]}]},oneOf:[{anyOf:[{required:["statements"]},{required:["dynamic_statements"]}],not:{required:["statement_groups"]}},{required:["statement_groups"],not:{anyOf:[{required:["statements"]},{required:["dynamic_statements"]}]}}]},"question-text":{type:"object",properties:{type:{enum:["text-single","text-multi"]}},required:["id","type"],not:{anyOf:[{required:["choices"]},{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["statement_groups"]},{required:["dynamic_statements"]},{required:["randomization"]}]}},"question-description":{type:"object",properties:{type:{const:"description"}},not:{anyOf:[{required:["choices"]},{required:["choice_groups"]},{required:["dynamic_choices"]},{required:["statements"]},{required:["statement_groups"]},{required:["dynamic_statements"]},{required:["randomization"]}]}},statement:{type:"object",properties:{id:{type:"string",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$",description:"The id of the statement"},display:{type:"string",description:"The statement name, as shown to the surveyee"},display_logic:{type:"string",description:"A boolean expression determining if the statement should be displayed"}},required:["id","display"],additionalProperties:!1},choice:{type:"object",properties:{display:{type:"string",description:"The choice name, as shown to the surveyee"},id:{type:"string",pattern:"^[a-zA-Z][a-zA-Z0-9_]*$",description:"The id of the choice"},value:{type:"integer",description:"The value the choice"},display_logic:{type:"string",description:"A boolean expression determining if the choice should be displayed"},text:{type:"string",enum:["no","optional","forced"],description:"If a textbox should appear next to the choice, and if it should be mandatory to fill it in if the choice is selected"},exclusive_answer:{type:"boolean",description:"If true, this choice can't be combined with other choices in this question"}},required:["display"],anyOf:[{required:["value"]},{required:["id"]}],additionalProperties:!1},randomization:{type:"object",description:"Configuration of the display order randomization of choices, statements or groups.",properties:{type:{type:"string",description:"The type of randomization: randomize all items, a subset of them, or using constrained randomization",enum:["all","subset","constrained"]},total:{type:"integer",description:"Maximum number of items to show"},order:{type:"string",description:"A space separated string containing the order of the items; each 'word' is either an id of some item or the wildcard $ representing the remaining items"}},required:["type"],oneOf:[{properties:{type:{const:"all"}},not:{required:["total","order"]}},{properties:{type:{const:"subset"}},required:["total"],not:{required:["order"]}},{properties:{type:{const:"constrained"}},required:["order"]}],additionalProperties:!1}},f={$schema:d,title:c,type:u,properties:m,additionalProperties:l,required:y,$defs:h};const i=new o({allowUnionTypes:!0});n(i);const r=i.compile(f),g=e=>{if(!r(e))throw new Error(`Invalid template: ${e.template.id}. Reason: ${r.errors}`)},q="pulse_default_alpha",_={allPermissions:p,SURVEY_RESOURCE_TYPE:a,surveyAdministerPermission:t};export{q as DEFAULT_TEMPLATE_ID,_ as permissions,g as validateTemplate};
 //# sourceMappingURL=index.esm.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spotify/backstage-plugin-pulse-common",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://backstage.spotify.com/",
   "main": "dist/index.cjs.js",
@@ -19,20 +19,25 @@
     "test": "backstage-cli package test",
     "clean": "backstage-cli package clean",
     "prepack": "backstage-cli package prepack",
-    "postpack": "backstage-cli package postpack"
+    "postpack": "backstage-cli package postpack",
+    "json2ts": "./src/templates/schema/generateSchemaTypes.sh"
   },
   "dependencies": {
-    "@backstage/plugin-permission-common": "^0.7.4",
-    "js-yaml": "^4.1.0"
+    "@backstage/plugin-permission-common": "^0.7.5",
+    "ajv": "^8.11.2",
+    "ajv-formats": "^2.1.1",
+    "graphql": "^16.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.4",
-    "ajv": "^8.11.2",
-    "ajv-formats": "^2.1.1"
+    "@backstage/cli": "^0.22.6",
+    "js-yaml": "^4.1.0",
+    "json-schema-to-typescript": "12.0.0",
+    "process": "^0.11.10"
   },
   "files": [
     "dist",
-    "!dist/**/*.map"
+    "!dist/**/*.map",
+    "src/templates/surveys"
   ],
   "module": "dist/index.esm.js"
 }