Skip to content

CCM-15038: Add accessible formats to template & routing config schemas #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ClareJonesBJSS merged 10 commits into from
Apr 8, 2026
Merged

CCM-15038: Add accessible formats to template & routing config schemas #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
836e707
Add BSL to routing config schema
ClareJonesBJSS Mar 26, 2026
e34cc93
Add all accessible formats
ClareJonesBJSS Apr 1, 2026
fc36da2
Merge commit '94dc6db617e8f12b2416ca8be0818e713133a171' into feature/…
ClareJonesBJSS Apr 1, 2026
2692d71
package lock
ClareJonesBJSS Apr 1, 2026
55065df
Merge commit 'f665e061adb64de8a6af813a598a333df0e7c95d' into feature/…
ClareJonesBJSS Apr 2, 2026
5309bd7
Version increment
ClareJonesBJSS Apr 2, 2026
c4cba31
Merge commit 'b510f398cd1f10d284ed4a2328179937afb9e885' into feature/…
ClareJonesBJSS Apr 7, 2026
482e2af
Version increment
ClareJonesBJSS Apr 7, 2026
3ff85d8
Merge branch 'main' into feature/CCM-15038_add-bsl
ClareJonesBJSS Apr 8, 2026
b6a408a
Package lock
ClareJonesBJSS Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
577 changes: 289 additions & 288 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/event-schemas/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@
},
"type": "commonjs",
"types": "./dist/index.d.ts",
"version": "1.4.6"
"version": "1.4.7"
}
9 changes: 6 additions & 3 deletions packages/event-schemas/schemas/RoutingConfigCompleted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"items": {
"$ref": "#/$defs/CascadeGroupOverride"
},
"description": "Config defining non-default cascade groups and the conditons under which they will be used"
"description": "Config defining non-default cascade groups and the conditions under which they will be used"
}
},
"required": [
Expand Down Expand Up @@ -213,10 +213,13 @@
]
},
"accessibleFormat": {
"description": "Communication preference override for the template",
"description": "Communication preference override for the template - q1:Braille, q4:British Sign Language, x1:Large Print, x3:Audio",
"type": "string",
"enum": [
"x1"
"q1",
"q4",
"x1",
"x3"
]
},
"supplierReferences": {
Expand Down
9 changes: 6 additions & 3 deletions packages/event-schemas/schemas/RoutingConfigDeleted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"items": {
"$ref": "#/$defs/CascadeGroupOverride"
},
"description": "Config defining non-default cascade groups and the conditons under which they will be used"
"description": "Config defining non-default cascade groups and the conditions under which they will be used"
}
},
"required": [
Expand Down Expand Up @@ -220,10 +220,13 @@
]
},
"accessibleFormat": {
"description": "Communication preference override for the template",
"description": "Communication preference override for the template - q1:Braille, q4:British Sign Language, x1:Large Print, x3:Audio",
"type": "string",
"enum": [
"x1"
"q1",
"q4",
"x1",
"x3"
]
},
"supplierReferences": {
Expand Down
9 changes: 6 additions & 3 deletions packages/event-schemas/schemas/RoutingConfigDrafted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
"items": {
"$ref": "#/$defs/CascadeGroupOverride"
},
"description": "Config defining non-default cascade groups and the conditons under which they will be used"
"description": "Config defining non-default cascade groups and the conditions under which they will be used"
}
},
"required": [
Expand Down Expand Up @@ -220,10 +220,13 @@
]
},
"accessibleFormat": {
"description": "Communication preference override for the template",
"description": "Communication preference override for the template - q1:Braille, q4:British Sign Language, x1:Large Print, x3:Audio",
"type": "string",
"enum": [
"x1"
"q1",
"q4",
"x1",
"x3"
]
},
"supplierReferences": {
Expand Down
6 changes: 4 additions & 2 deletions packages/event-schemas/schemas/TemplateCompleted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,13 @@
"letterType": {
"type": "string",
"enum": [
"q1",
"q4",
"x0",
"x1"
"x1",
"x3"
],
"description": "Letter type - q4:British Sign Language, x1:Large Print, x0:Standard"
"description": "Letter type - q1:Braille, q4:British Sign Language, x0:Standard, x1:Large Print, x3:Audio"
},
"personalisationParameters": {
"type": "array",
Expand Down
6 changes: 4 additions & 2 deletions packages/event-schemas/schemas/TemplateDeleted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,13 @@
"letterType": {
"type": "string",
"enum": [
"q1",
"q4",
"x0",
"x1"
"x1",
"x3"
],
"description": "Letter type - q4:British Sign Language, x1:Large Print, x0:Standard"
"description": "Letter type - q1:Braille, q4:British Sign Language, x0:Standard, x1:Large Print, x3:Audio"
},
"personalisationParameters": {
"type": "array",
Expand Down
6 changes: 4 additions & 2 deletions packages/event-schemas/schemas/TemplateDrafted/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,13 @@
"letterType": {
"type": "string",
"enum": [
"q1",
"q4",
"x0",
"x1"
"x1",
"x3"
],
"description": "Letter type - q4:British Sign Language, x1:Large Print, x0:Standard"
"description": "Letter type - q1:Braille, q4:British Sign Language, x0:Standard, x1:Large Print, x3:Audio"
},
"personalisationParameters": {
"type": "array",
Expand Down
7 changes: 4 additions & 3 deletions packages/event-schemas/src/routing-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const $RoutingConfigEventChannel = z.enum([
'LETTER',
]);

const accessibleFormats = ['x1'];
const accessibleFormats = ['q1', 'q4', 'x1', 'x3'];

export type RoutingConfigEventChannel = z.infer<
typeof $RoutingConfigEventChannel
Expand All @@ -25,7 +25,8 @@ const $RoutingConfigEventConditionalTemplate = z
description: 'Language override for the template',
}),
accessibleFormat: z.enum(accessibleFormats).optional().meta({
description: 'Communication preference override for the template',
description:
'Communication preference override for the template - q1:Braille, q4:British Sign Language, x1:Large Print, x3:Audio',
}),
supplierReferences: z.record(z.string(), z.string()).optional().meta({
description: 'Supplier references that identify the template',
Expand Down Expand Up @@ -141,7 +142,7 @@ export const $BaseRoutingConfigEventData = z.object({
}),
cascadeGroupOverrides: z.array($CascadeGroupOverride).meta({
description:
'Config defining non-default cascade groups and the conditons under which they will be used',
'Config defining non-default cascade groups and the conditions under which they will be used',
}),
});

Expand Down
4 changes: 2 additions & 2 deletions packages/event-schemas/src/template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { z } from 'zod';
import { languages } from './common';

const letterTypes = ['q4', 'x0', 'x1'];
const letterTypes = ['q1', 'q4', 'x0', 'x1', 'x3'];

const $TemplateEventV1BaseData = z.object({
owner: z.string().meta({
Expand Down Expand Up @@ -100,7 +100,7 @@ const $LetterTemplateEventV1Data = $TemplateEventV1BaseData
}),
letterType: z.enum(letterTypes).meta({
description:
'Letter type - q4:British Sign Language, x1:Large Print, x0:Standard',
'Letter type - q1:Braille, q4:British Sign Language, x0:Standard, x1:Large Print, x3:Audio',
}),
personalisationParameters: z.array(z.string().max(1000)).meta({
description: 'List of personalisation parameters used in the template',
Expand Down
Loading