@openframe-org/criteria-set-protocol 2.0.15 → 2.0.16

package/dist/index.js

@@ -15,23 +15,13 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.v1 = void 0;
 exports.v1 = __importStar(require("./v1"));

package/dist/services/i-versioned.service.d.ts

@@ -0,0 +1,16 @@
+import { ProtocolVersionServiceMap } from '../types';
+/**
+ * Interface for versioned services
+ *
+ * Services that implement this interface can be managed by the VersionsService
+ */
+export interface IVersionedService {
+    /**
+     * The SemVer version of the service
+     */
+    version: string;
+    /**
+     * Whether the service supports the given protocol version
+     */
+    supportsProtocol: <ProtocolVersion extends number>(protocolVersion: ProtocolVersion) => this is ProtocolVersionServiceMap<ProtocolVersion>;
+}

package/dist/services/i-versioned.service.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './i-versioned.service';
+export * from './versions.service';

package/dist/services/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./i-versioned.service"), exports);
+__exportStar(require("./versions.service"), exports);

package/dist/services/versions.service.d.ts

@@ -0,0 +1,38 @@
+import { IVersionedService } from './i-versioned.service';
+import { ProtocolVersionServiceMap } from '../types';
+/**
+ * Service for managing versions of services
+ *
+ * The VersionsService class is a utility class for services which implement different versions of the protocol, and different versions of their
+ * own service. For example, say you have a v1service, v11service, v2service and v21service with versions 1.0, 1.1, 2.0 and 2.1 respectively.
+ * The VersionsService class can be used to manage these services:
+ *
+ * const versionsService = new VersionsService([v1service, v11service, v2service, v21service]);
+ * versionsService.getLatestVersion(); // v21service
+ * versionsService.getServiceVersions(1); // [v1service, v11service]
+ * versionsService.getServiceVersions(2); // [v2service, v21service]
+ * versionsService.get('1.1'); // v11service
+ */
+export declare class VersionsService {
+    protected versions: IVersionedService[];
+    /**
+     * @param versions An array of services implementing IVersionedService
+     */
+    constructor(versions: IVersionedService[]);
+    /**
+     * Get all services
+     */
+    getAll(): IVersionedService[];
+    /**
+     * Retrieve the services which are compatible with the requested protocol version
+     */
+    getServiceVersions<ProtocolVersion extends number, ProtocolImplementingService = ProtocolVersionServiceMap<ProtocolVersion>>(protocolVersion: ProtocolVersion): ProtocolImplementingService[];
+    /**
+     * Retrieve a service by version
+     */
+    get(version: string): IVersionedService | undefined;
+    /**
+     * Retrieve the latest service
+     */
+    getLatestVersion(): IVersionedService;
+}

package/dist/services/versions.service.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionsService = void 0;
+/**
+ * Service for managing versions of services
+ *
+ * The VersionsService class is a utility class for services which implement different versions of the protocol, and different versions of their
+ * own service. For example, say you have a v1service, v11service, v2service and v21service with versions 1.0, 1.1, 2.0 and 2.1 respectively.
+ * The VersionsService class can be used to manage these services:
+ *
+ * const versionsService = new VersionsService([v1service, v11service, v2service, v21service]);
+ * versionsService.getLatestVersion(); // v21service
+ * versionsService.getServiceVersions(1); // [v1service, v11service]
+ * versionsService.getServiceVersions(2); // [v2service, v21service]
+ * versionsService.get('1.1'); // v11service
+ */
+class VersionsService {
+    /**
+     * @param versions An array of services implementing IVersionedService
+     */
+    constructor(versions) {
+        this.versions = versions;
+    }
+    /**
+     * Get all services
+     */
+    getAll() {
+        return this.versions;
+    }
+    /**
+     * Retrieve the services which are compatible with the requested protocol version
+     */
+    getServiceVersions(protocolVersion) {
+        return this.versions.filter((service) => service.supportsProtocol(protocolVersion));
+    }
+    /**
+     * Retrieve a service by version
+     */
+    get(version) {
+        return this.versions.find((service) => service.version === version);
+    }
+    /**
+     * Retrieve the latest service
+     */
+    getLatestVersion() {
+        return this.versions[this.versions.length - 1];
+    }
+}
+exports.VersionsService = VersionsService;

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+import { IProtocolV1Service } from './v1/services/i-protocol-v1.service';
+export type ProtocolVersionServiceMap<Version extends number> = Version extends 1 ? IProtocolV1Service : unknown;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -58,9 +58,9 @@ export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.obj
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -71,9 +71,9 @@ export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.obj
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -110,9 +110,9 @@ export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -123,9 +123,9 @@ export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -162,9 +162,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -175,9 +175,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -213,9 +213,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -226,9 +226,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;

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

@@ -140,8 +140,8 @@ export declare const abstractElementSchema: z.ZodObject<{
     }>>;
     sortOrder: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
+    code: string;
     title: string;
     data?: {
         type?: "number" | "percentage" | undefined;
@@ -174,8 +174,8 @@ export declare const abstractElementSchema: z.ZodObject<{
     })[] | undefined;
     sortOrder?: number | undefined;
 }, {
-    code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
+    code: string;
     title: string;
     data?: {
         type?: "number" | "percentage" | undefined;

package/dist/v1/schemas/criteria-set-id-param-schema.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+/**
+ * Validates the criteriaSetId parameter for endpoints which use it
+ */
+export declare const criteriaSetIdParamSchema: z.ZodObject<{
+    criteriaSetId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    criteriaSetId: string;
+}, {
+    criteriaSetId: string;
+}>;

package/dist/v1/schemas/criteria-set-id-param-schema.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.criteriaSetIdParamSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Validates the criteriaSetId parameter for endpoints which use it
+ */
+exports.criteriaSetIdParamSchema = zod_1.z.object({
+    criteriaSetId: zod_1.z.string()
+        .regex(/^[a-zA-Z0-9.\-_]+$/, 'Criteria set ID must contain only full stops, alphanumeric characters, dashes and underscores')
+});

package/dist/v1/schemas/criteria-set.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+export declare const criteriaSetOptionsSchema: z.ZodObject<{
+    renderDetailedViewInDashboard: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    renderDetailedViewInDashboard?: boolean | undefined;
+}, {
+    renderDetailedViewInDashboard?: boolean | undefined;
+}>;

package/dist/v1/schemas/criteria-set.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.criteriaSetOptionsSchema = void 0;
+const zod_1 = require("zod");
+exports.criteriaSetOptionsSchema = zod_1.z.object({
+    renderDetailedViewInDashboard: zod_1.z.boolean().optional(),
+});