@planning-inspectorate/data-model 1.16.1 → 1.18.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 (26) hide show
  1. package/docs/README.md +2 -2
  2. package/docs/appeal-has.md +764 -86
  3. package/docs/appeal-s78.md +55 -133
  4. package/package.json +1 -1
  5. package/pins_data_model/models/model_appeal_has.py +647 -8
  6. package/pins_data_model/models/model_appeal_s78.py +604 -10
  7. package/schemas/appeal-has.schema.json +161 -9
  8. package/schemas/appeal-s78.schema.json +81 -125
  9. package/schemas/commands/appeal-advert.submission.schema.json +23 -0
  10. package/schemas/commands/appeal-common-submission.schema.json +30 -8
  11. package/schemas/commands/appeal-has-submission.schema.json +0 -1
  12. package/schemas/commands/appeal-s78-submission.schema.json +0 -1
  13. package/schemas/commands/appellant-submission.schema.json +17 -6
  14. package/schemas/commands/lpa-questionnaire-has.schema.json +0 -1
  15. package/schemas/commands/lpa-questionnaire-s78.schema.json +0 -1
  16. package/schemas/commands/lpa-questionnaire.schema.json +14 -12
  17. package/src/lib/gen-docs.js +4 -2
  18. package/src/schemas.d.ts +284 -533
  19. package/tests/appeals/appeal-has.test.js +243 -0
  20. package/tests/appeals/appeal-s78.test.js +227 -0
  21. package/tests/appeals/commands/adverts-questionnaire.test.js +92 -0
  22. package/tests/appeals/commands/adverts-submission.test.js +188 -0
  23. package/tests/appeals/commands/has-questionnaire.test.js +3 -3
  24. package/tests/appeals/commands/has-submission.test.js +62 -1
  25. package/tests/appeals/commands/s78-questionnaire.test.js +8 -1
  26. package/tests/appeals/commands/s78-submission.test.js +60 -1
package/schemas/commands/lpa-questionnaire.schema.json CHANGED
@@ -11,27 +11,29 @@
11
11
  "casedata": {
12
12
  "type": "object",
13
13
  "additionalProperties": true,
14
- "anyOf": [
14
+ "oneOf": [
15
15
  {
16
+ "$comment": "Householder + CAS Planning",
16
17
  "allOf": [
17
- { "$comment": "backwards compatibility for no case type, when removed can update allOf to oneOf" },
18
- { "not": { "required": ["caseType"] } },
18
+ { "properties": { "caseType": { "enum": ["D", "ZP"] } } },
19
+ { "$ref": "lpa-questionnaire-common.schema.json" },
19
20
  { "$ref": "lpa-questionnaire-has.schema.json" }
20
21
  ]
21
22
  },
22
23
  {
23
- "allOf": [{ "properties": { "caseType": { "const": "W" } } }, { "$ref": "lpa-questionnaire-s78.schema.json" }]
24
- },
25
- {
26
- "allOf": [{ "properties": { "caseType": { "const": "Y" } } }, { "$ref": "lpa-questionnaire-s78.schema.json" }]
27
- },
28
- {
29
- "allOf": [{ "properties": { "caseType": { "const": "D" } } }, { "$ref": "lpa-questionnaire-has.schema.json" }]
24
+ "$comment": "S78 + S20",
25
+ "allOf": [
26
+ { "properties": { "caseType": { "enum": ["W", "Y"] } } },
27
+ { "$ref": "lpa-questionnaire-common.schema.json" },
28
+ { "$ref": "lpa-questionnaire-has.schema.json" },
29
+ { "$ref": "lpa-questionnaire-s78.schema.json" }
30
+ ]
30
31
  },
31
32
  {
33
+ "$comment": "Adverts + CAS Adverts - TBD - may need separate schemas",
32
34
  "allOf": [
33
- { "properties": { "caseType": { "const": "ZP" } } },
34
- { "$ref": "lpa-questionnaire-has.schema.json" }
35
+ { "properties": { "caseType": { "enum": ["H", "ZA"] } } },
36
+ { "$ref": "lpa-questionnaire-common.schema.json" }
35
37
  ]
36
38
  }
37
39
  ]
package/src/lib/gen-docs.js CHANGED
@@ -22,9 +22,11 @@ async function genDocs() {
22
22
  outDir: 'docs',
23
23
  includeReadme: true
24
24
  });
25
- // remove all the "-properties-" files that aren't needed
25
+ // remove all irrelevant docs
26
+ const removePatterns = ['-properties-', '-properties.', '-anyof-'];
26
27
  for (const md of out.markdown) {
27
- if (md.fileName.includes('-properties-')) {
28
+ const shouldRemove = removePatterns.some((pattern) => md.fileName.includes(pattern));
29
+ if (shouldRemove) {
28
30
  await fs.rm(md.fullPath);
29
31
  }
30
32
  }