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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.cjs.js +13 -13
  3. package/dist/index.d.ts +89 -78
  4. package/dist/index.esm.js +13 -13
  5. package/package.json +4 -4
  6. package/src/templates/schema/survey-template-schema.json +59 -53
package/dist/index.d.ts CHANGED
@@ -62,33 +62,32 @@ interface SurveyTemplate {
62
62
  /**
63
63
  * The survey sections, in the order they will appear in the survey
64
64
  */
65
- sections: {
66
- /**
67
- * The id of this section
68
- */
69
- id: string;
70
- /**
71
- * The name of this section
72
- */
73
- name: string;
74
- /**
75
- * An optional boolean expression that decides if the surveyee should see the questions in this section.
76
- */
77
- display_logic?: string;
78
- /**
79
- * The questions in the section (all in one page)
80
- */
81
- questions?: Question[];
82
- /**
83
- * The questions in the section, split into pages
84
- */
85
- pages?: {
86
- /**
87
- * The questions on the page
88
- */
89
- questions: Question[];
90
- }[];
91
- }[];
65
+ sections: Section[];
66
+ }
67
+ /**
68
+ * A survey section.
69
+ * @public */
70
+ interface Section {
71
+ /**
72
+ * The id of this section
73
+ */
74
+ id: string;
75
+ /**
76
+ * The name of this section
77
+ */
78
+ name: string;
79
+ /**
80
+ * An optional boolean expression that decides if the surveyee should see the questions in this section.
81
+ */
82
+ display_logic?: string;
83
+ /**
84
+ * The questions in the section (all in one page)
85
+ */
86
+ questions?: Question[];
87
+ /**
88
+ * The questions in the section, split into pages
89
+ */
90
+ pages?: Page[];
92
91
  }
93
92
  /** @public */
94
93
  interface Question {
@@ -198,8 +197,7 @@ interface Statement {
198
197
  }
199
198
  /**
200
199
  * Configuration of the display order randomization of choices, statements or groups.
201
- */
202
- /** @public */
200
+ * @public */
203
201
  interface Randomization {
204
202
  /**
205
203
  * The type of randomization: randomize all items, a subset of them, or using constrained randomization
@@ -241,6 +239,13 @@ interface Choice {
241
239
  */
242
240
  exclusive_answer?: boolean;
243
241
  }
242
+ /** @public */
243
+ interface Page {
244
+ /**
245
+ * The questions on the page
246
+ */
247
+ questions: Question[];
248
+ }
244
249
 
245
250
  /** @public */
246
251
  declare const validateTemplate: (template: SurveyTemplate) => void;
@@ -331,60 +336,66 @@ declare const templateSchema: {
331
336
  type: string;
332
337
  description: string;
333
338
  items: {
334
- type: string;
335
- description: string;
336
- properties: {
337
- id: {
338
- type: string;
339
- description: string;
340
- format: string;
341
- pattern: string;
342
- };
343
- name: {
344
- type: string;
345
- description: string;
346
- };
347
- display_logic: {
348
- type: string;
349
- description: string;
350
- };
351
- questions: {
352
- type: string;
353
- description: string;
354
- items: {
355
- $ref: string;
356
- };
357
- };
358
- pages: {
359
- type: string;
360
- description: string;
361
- items: {
362
- type: string;
363
- properties: {
364
- questions: {
365
- type: string;
366
- description: string;
367
- items: {
368
- $ref: string;
369
- };
370
- };
371
- };
372
- required: string[];
373
- additionalProperties: boolean;
374
- };
375
- };
376
- };
377
- additionalProperties: boolean;
378
- required: string[];
379
- oneOf: {
380
- required: string[];
381
- }[];
339
+ $ref: string;
382
340
  };
383
341
  };
384
342
  };
385
343
  additionalProperties: boolean;
386
344
  required: string[];
387
345
  $defs: {
346
+ section: {
347
+ type: string;
348
+ description: string;
349
+ properties: {
350
+ id: {
351
+ type: string;
352
+ description: string;
353
+ format: string;
354
+ pattern: string;
355
+ };
356
+ name: {
357
+ type: string;
358
+ description: string;
359
+ };
360
+ display_logic: {
361
+ type: string;
362
+ description: string;
363
+ };
364
+ questions: {
365
+ type: string;
366
+ description: string;
367
+ items: {
368
+ $ref: string;
369
+ };
370
+ };
371
+ pages: {
372
+ type: string;
373
+ description: string;
374
+ items: {
375
+ $ref: string;
376
+ };
377
+ };
378
+ };
379
+ additionalProperties: boolean;
380
+ required: string[];
381
+ oneOf: {
382
+ required: string[];
383
+ }[];
384
+ };
385
+ page: {
386
+ type: string;
387
+ properties: {
388
+ questions: {
389
+ type: string;
390
+ description: string;
391
+ items: {
392
+ $ref: string;
393
+ };
394
+ };
395
+ };
396
+ required: string[];
397
+ additionalProperties: boolean;
398
+ };
388
399
  question: {
389
400
  type: string;
390
401
  properties: {
@@ -770,4 +781,4 @@ declare const permissions: {
770
781
  surveyAdministerPermission: _backstage_plugin_permission_common.BasicPermission;
771
782
  };
772
783
 
773
- export { Choice, DEFAULT_TEMPLATE_ID, Question, Randomization, Statement, SurveyTemplate, permissions, templateSchema, validateTemplate };
784
+ export { Choice, DEFAULT_TEMPLATE_ID, Page, Question, Randomization, Section, Statement, SurveyTemplate, permissions, templateSchema, validateTemplate };