feat: add refundReasons spec

examples/refundReasons.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=../schema-definitions/refundReasons.json
+refundReasons:
+  - id: WRONG_TICKET_TYPE
+    name:
+      - lang: nob
+        value: Feil billettype
+      - lang: nno
+        value: Feil billettype
+      - lang: eng
+        value: Wrong ticket type
+  - id: OTHER
+    name:
+      - lang: nob
+        value: Annet
+      - lang: nno
+        value: Anna
+      - lang: eng
+        value: Other

schema-definitions/refundReasons.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "RefundReasons",
+  "type": "object",
+  "properties": {
+    "refundReasons": {
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "array",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "properties": {
+                    "lang": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["lang", "value"]
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "language": {
+                      "type": "string"
+                    },
+                    "value": {
+                      "type": "string"
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        },
+        "required": ["id", "name"]
+      }
+    }
+  }
+}

src/index.ts

@@ -9,3 +9,4 @@ export * from './other';
 export * from './reference-data';
 export * from './stop-signal-button-config';
 export * from './known-qr-code-urls';
+export * from './refund-reasons';

src/refund-reasons.ts

@@ -0,0 +1,14 @@
+import {z} from 'zod';
+import {LanguageAndTextTypeArray} from './common';
+
+export const RefundReason = z.object({
+  id: z.string(),
+  name: LanguageAndTextTypeArray,
+});
+
+export const RefundReasons = z.object({
+  refundReasons: z.array(RefundReason).default([]),
+});
+
+export type RefundReasonType = z.infer<typeof RefundReason>;
+export type RefundReasonsType = z.infer<typeof RefundReasons>;

src/tools/specifications-types.ts

@@ -21,6 +21,7 @@ import {Other} from '../other';
 import {ReferenceData} from '../reference-data';
 import {StopSignalButtonConfig} from '../stop-signal-button-config';
 import {KnownQrCodeUrls} from '../known-qr-code-urls';
+import {RefundReasons} from '../refund-reasons';
 import {AppVersionedItem, AppVersionedItemSchema} from '../common';
 
 // All supported specifications
@@ -36,6 +37,7 @@ export const specifications = [
   'referenceData',
   'stopSignalButtonConfig',
   'knownQrCodeUrls',
+  'refundReasons',
 ] as const;
 
 export type SchemaNames = (typeof specifications)[number];
@@ -76,6 +78,7 @@ export const schemaTypes = {
   referenceData: ReferenceData,
   stopSignalButtonConfig: StopSignalButtonConfig,
   knownQrCodeUrls: KnownQrCodeUrls.meta({title: 'KnownQrCodeUrls'}),
+  refundReasons: RefundReasons.meta({title: 'RefundReasons'}),
 } satisfies Record<SchemaNames, unknown>;
 
 // All correctly supported schema types as JSON Schema data structures