@openframe-org/criteria-set-protocol 2.0.0 → 2.0.2

package/README.md

@@ -3,60 +3,67 @@
 # Criteria Set Protocol
 
 ## TypeScript library
+
 This is a TypeScript library with types and implementations of the Criteria Set Protocol. It is published
 publicly on [npmjs](https://www.npmjs.com/package/@openframe-org/criteria-set-protocol) as `@openframe-org/criteria-set-protocol`.
 
 ### Installation
+
 ```bash
 npm install --save @openframe-org/criteria-set-protocol
 ```
 
 ### Contents
+
 The library contains a service to work with protocol versions, and an interface to interact with this service.
 
 #### Protocol v1
+
 The library contains the types defined in the protocol v1 specification, and a service that implements this specification.
 
 ##### Types
-| Type                          | Remarks                                             |
-|-------------------------------|-----------------------------------------------------|
-| **Metadata types**            |                                                     |
-| `Metadata`                    |                                                     |
-| `Theme`                     |                                                     |
-| `ThemeStyle`                |                                                     |
-| `Color`                       |                                                     |
-| **Task tree types**           |                                                     |
-| `CriteriaTree`                |                                                     |
-| `Theme`                           |                                                     |
-| `Criterion`                   |                                                     |
-| `TaskGroup`                   |                                                     |
-| `Task`                        |                                                     |
-| `TaskItem`                    |                                                     |
-| **TaskItem value types**      |                                                     |
-| `SelectSingleType`            |                                                     |
-| `SelectMultipleType`          |                                                     |
-| `NumberType`                  |                                                     |
-| `BooleanType`                 |                                                     |
-| `PointOption`                 | Used by `SelectSingleType` and `SelectMultipleType` |
-| `TaskItemValue`               | The raw value of a TaskItem, which can be an array  |
-| `TaskItemScalarValue`         | The raw value of a TaskItem                         |
-| **Express types**             |                                                     |
-| `MetadataResponse`            | Metadata endpoint response body                     |
+
+| Type                       | Remarks                                             |
+| -------------------------- | --------------------------------------------------- |
+| **Metadata types**         |                                                     |
+| `Metadata`                 |                                                     |
+| `Theme`                    |                                                     |
+| `ThemeStyle`               |                                                     |
+| `Color`                    |                                                     |
+| **Task tree types**        |                                                     |
+| `CriteriaTree`             |                                                     |
+| `Theme`                    |                                                     |
+| `Criterion`                |                                                     |
+| `TaskGroup`                |                                                     |
+| `Task`                     |                                                     |
+| `TaskItem`                 |                                                     |
+| **TaskItem value types**   |                                                     |
+| `SelectSingleType`         |                                                     |
+| `SelectMultipleType`       |                                                     |
+| `NumberType`               |                                                     |
+| `BooleanType`              |                                                     |
+| `PointOption`              | Used by `SelectSingleType` and `SelectMultipleType` |
+| `TaskItemValue`            | The raw value of a TaskItem, which can be an array  |
+| `TaskItemScalarValue`      | The raw value of a TaskItem                         |
+| **Express types**          |                                                     |
+| `MetadataResponse`         | Metadata endpoint response body                     |
 | `TreeAndMatrixRequestBody` | Request body for the matrix streaming endpoints     |
-| `StreamMatrixResponse`        | Matrix streaming endpoints response body            |
+| `StreamMatrixResponse`     | Matrix streaming endpoints response body            |
 
 ##### Schemas
+
 Validation schemas are provided for validating the endpoints of the protocol v1 specification.
 
 | Schema                     | Remarks                                                          |
-|----------------------------|------------------------------------------------------------------|
+| -------------------------- | ---------------------------------------------------------------- |
 | `TreeAndMatrixBodySchema`  | Validates the request body for the tree and matrix endpoints     |
 | `criteriaSetIdParamSchema` | Validates the criteriaSetId parameter for endpoints which use it |
 | `versionParamSchema`       | Validates the version parameter for endpoints which use it       |
 
 ##### Services
-The `IProtocolV1Service` interface defines a service which implements the v1 protocol. 
 
+The `IProtocolV1Service` interface defines a service which implements the v1 protocol.
 
 ## License
+
 <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/Frame-ApS/criteria-set-protocol">Openframe Criteria Set Protocol</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/andresangulo">Openframe ApS</a> is licensed under <a href="http://creativecommons.org/licenses/by-nd/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC BY-ND 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nd.svg?ref=chooser-v1"></a></p>

package/dist/index.d.ts

@@ -1 +1 @@
-export * as v1 from './v1';
+export * as v1 from "./v1";

package/dist/v1/errors/DataValidationError.d.ts

@@ -1,4 +1,4 @@
-import { ValidationError } from './ValidationError';
+import { ValidationError } from "./ValidationError";
 export declare class DataValidationError extends ValidationError {
     code: string;
     path?: string | undefined;

package/dist/v1/errors/DataValidationError.js

@@ -4,7 +4,7 @@ exports.DataValidationError = void 0;
 const ValidationError_1 = require("./ValidationError");
 class DataValidationError extends ValidationError_1.ValidationError {
     constructor(code, path, args) {
-        super('data', code, path, args);
+        super("data", code, path, args);
         this.code = code;
         this.path = path;
     }

package/dist/v1/errors/ParameterValidationError.d.ts

@@ -1,4 +1,4 @@
-import { ValidationError } from './ValidationError';
+import { ValidationError } from "./ValidationError";
 export declare class ParameterValidationError extends ValidationError {
     code: string;
     path?: string | undefined;

package/dist/v1/errors/ParameterValidationError.js

@@ -4,7 +4,7 @@ exports.ParameterValidationError = void 0;
 const ValidationError_1 = require("./ValidationError");
 class ParameterValidationError extends ValidationError_1.ValidationError {
     constructor(code, path, args) {
-        super('parameter', code, path, args);
+        super("parameter", code, path, args);
         this.code = code;
         this.path = path;
     }

package/dist/v1/errors/ValidationError.d.ts

@@ -1,4 +1,4 @@
-import { ValidationErrorType } from './types';
+import { ValidationErrorType } from "./types";
 export declare abstract class ValidationError extends Error {
     errorType: ValidationErrorType;
     code: string;

package/dist/v1/errors/ValidationError.js

@@ -14,7 +14,7 @@ class ValidationError extends Error {
             errorType: this.errorType,
             code: this.code,
             path: this.path,
-            arguments: this.arguments
+            arguments: this.arguments,
         };
     }
 }

package/dist/v1/errors/index.d.ts

@@ -1,4 +1,4 @@
-export * from './ValidationError';
-export * from './DataValidationError';
-export * from './ParameterValidationError';
-export * from './types';
+export * from "./ValidationError";
+export * from "./DataValidationError";
+export * from "./ParameterValidationError";
+export * from "./types";

package/dist/v1/errors/types.d.ts

@@ -1 +1 @@
-export type ValidationErrorType = 'data' | 'parameter';
+export type ValidationErrorType = "data" | "parameter";

package/dist/v1/index.d.ts

@@ -1,5 +1,5 @@
-export * from './schemas';
-export * from './services';
-export * from './types';
-export * from './utils';
-export * from './errors';
+export * from "./schemas";
+export * from "./services";
+export * from "./types";
+export * from "./utils";
+export * from "./errors";

package/dist/v1/schemas/certification.d.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from "zod";
 export declare const certificationDefinitionTypeSchema: z.ZodEnum<["number", "percentage"]>;
 export declare const numberBasedCertificationDefinitionRulesSchema: z.ZodObject<{
     minimum: z.ZodOptional<z.ZodNumber>;

package/dist/v1/schemas/certification.js

@@ -2,28 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.certificationDefinitionSchema = exports.percentageBasedCertificationDefinitionSchema = exports.numberBasedCertificationDefinitionSchema = exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema = exports.certificationDefinitionTypeSchema = void 0;
 const zod_1 = require("zod");
-exports.certificationDefinitionTypeSchema = zod_1.z.enum(['number', 'percentage']);
+exports.certificationDefinitionTypeSchema = zod_1.z.enum([
+    "number",
+    "percentage",
+]);
 exports.numberBasedCertificationDefinitionRulesSchema = zod_1.z.object({
-    minimum: (0, zod_1.optional)(zod_1.z.number()),
-    exclusiveMinimum: (0, zod_1.optional)(zod_1.z.number()),
-    maximum: (0, zod_1.optional)(zod_1.z.number()),
-    exclusiveMaximum: (0, zod_1.optional)(zod_1.z.number()),
+    minimum: zod_1.z.number().optional(),
+    exclusiveMinimum: zod_1.z.number().optional(),
+    maximum: zod_1.z.number().optional(),
+    exclusiveMaximum: zod_1.z.number().optional(),
 });
 exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema;
 const abstractCertificationDefinitionSchema = zod_1.z.object({
     type: exports.certificationDefinitionTypeSchema,
     code: zod_1.z.string(),
-    icon: (0, zod_1.optional)(zod_1.z.string()),
+    icon: zod_1.z.string().optional(),
     name: zod_1.z.string(),
-    description: (0, zod_1.optional)(zod_1.z.string()),
-    rulesText: zod_1.z.string()
+    description: zod_1.z.string().optional(),
+    rulesText: zod_1.z.string(),
 });
 exports.numberBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema.extend({
-    type: zod_1.z.literal('number'),
-    rules: exports.numberBasedCertificationDefinitionRulesSchema
+    type: zod_1.z.literal("number"),
+    rules: exports.numberBasedCertificationDefinitionRulesSchema,
 });
 exports.percentageBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema.extend({
-    type: zod_1.z.literal('percentage'),
-    rules: exports.percentageBasedCertificationDefinitionRulesSchema
+    type: zod_1.z.literal("percentage"),
+    rules: exports.percentageBasedCertificationDefinitionRulesSchema,
 });
-exports.certificationDefinitionSchema = zod_1.z.discriminatedUnion('type', [exports.numberBasedCertificationDefinitionSchema, exports.percentageBasedCertificationDefinitionSchema]);
+exports.certificationDefinitionSchema = zod_1.z.discriminatedUnion("type", [
+    exports.numberBasedCertificationDefinitionSchema,
+    exports.percentageBasedCertificationDefinitionSchema,
+]);

package/dist/v1/schemas/common.d.ts

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from "zod";
 export declare const colorSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
     red: z.ZodNumber;
     green: z.ZodNumber;
@@ -12,16 +12,18 @@ export declare const colorSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
     green: number;
     blue: number;
 }>]>;
-export declare const elementDataSchema: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
+export declare const taskItemScalarValueSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+export declare const taskItemValueSchema: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>;
+export declare const elementDataSchema: z.ZodObject<{
     value: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>>;
-    text: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    text: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
     text?: string | undefined;
 }, {
     value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
     text?: string | undefined;
-}>>;
+}>;
 export declare const criteriaTreeElementTypeSchema: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
 export declare const abstractElementSchema: z.ZodObject<{
     type: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
@@ -77,25 +79,25 @@ export declare const abstractElementSchema: z.ZodObject<{
         label: string;
         text: string;
     }>]>, "many">>;
-    data: z.ZodOptional<z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
+    data: z.ZodOptional<z.ZodObject<{
         value: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>>;
-        text: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        text: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
         text?: string | undefined;
     }, {
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
         text?: string | undefined;
-    }>>>;
+    }>>;
     sortOrder: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     code: string;
     title: string;
-    data?: (Record<string, any> & {
+    data?: {
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
         text?: string | undefined;
-    }) | undefined;
+    } | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -117,10 +119,10 @@ export declare const abstractElementSchema: z.ZodObject<{
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     code: string;
     title: string;
-    data?: (Record<string, any> & {
+    data?: {
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
         text?: string | undefined;
-    }) | undefined;
+    } | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";

package/dist/v1/schemas/common.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.colorSchema = void 0;
+exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.colorSchema = void 0;
 const zod_1 = require("zod");
-const task_item_1 = require("./task-item");
 const documentation_1 = require("./documentation");
 exports.colorSchema = zod_1.z.union([
     zod_1.z.string(),
@@ -12,17 +11,34 @@ exports.colorSchema = zod_1.z.union([
         blue: zod_1.z.number(),
     }),
 ]);
-exports.elementDataSchema = zod_1.z.intersection(zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.object({
-    value: task_item_1.taskItemValueSchema,
-    text: (0, zod_1.optional)(zod_1.z.string()),
-}).partial());
-exports.criteriaTreeElementTypeSchema = zod_1.z.enum(['theme', 'criterion', 'task-group', 'task', 'task-item']);
+// These are not "common" and are task-item specific, but generate a circular dependency if moved to task-item.ts
+exports.taskItemScalarValueSchema = zod_1.z.union([
+    zod_1.z.string(),
+    zod_1.z.number(),
+    zod_1.z.boolean(),
+    zod_1.z.null(),
+]);
+exports.taskItemValueSchema = zod_1.z.union([
+    exports.taskItemScalarValueSchema,
+    zod_1.z.array(exports.taskItemScalarValueSchema),
+]);
+exports.elementDataSchema = zod_1.z.object({
+    value: exports.taskItemValueSchema.optional(),
+    text: zod_1.z.string().optional(),
+});
+exports.criteriaTreeElementTypeSchema = zod_1.z.enum([
+    "theme",
+    "criterion",
+    "task-group",
+    "task",
+    "task-item",
+]);
 exports.abstractElementSchema = zod_1.z.object({
     type: exports.criteriaTreeElementTypeSchema,
     title: zod_1.z.string(),
     code: zod_1.z.string(),
-    tags: (0, zod_1.optional)(zod_1.z.array(zod_1.z.string())),
-    documentation: (0, zod_1.optional)(zod_1.z.array(documentation_1.documentationItemSchema)),
-    data: (0, zod_1.optional)(exports.elementDataSchema),
-    sortOrder: (0, zod_1.optional)(zod_1.z.number()),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(documentation_1.documentationItemSchema).optional(),
+    data: exports.elementDataSchema.optional(),
+    sortOrder: zod_1.z.number().optional(),
 });