@openframe-org/criteria-set-protocol 2.7.6 → 2.7.8-alpha.0

package/dist/v1/functions.d.ts

@@ -0,0 +1,2 @@
+export type HashableConfiguration = Record<string, string | string[]>;
+export declare const hashConfiguration: (configuration: HashableConfiguration) => string;

package/dist/v1/functions.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hashConfiguration = void 0;
+const node_crypto_1 = require("node:crypto");
+const utils_1 = require("./utils");
+const normalizeText = (text) => {
+    return text.normalize("NFC");
+};
+const isValidConfigurationValue = (value) => {
+    if (typeof value === "string") {
+        return true;
+    }
+    if (!Array.isArray(value)) {
+        return false;
+    }
+    for (const childValue of value) {
+        if (typeof childValue !== "string") {
+            return false;
+        }
+    }
+    return true;
+};
+const compareUtf8 = (stringA, stringB) => {
+    const bufferA = Buffer.from(stringA, "utf8");
+    const bufferB = Buffer.from(stringB, "utf8");
+    const minimum = Math.min(bufferA.length, bufferB.length);
+    for (let index = 0; index < minimum; index++) {
+        const difference = bufferA[index] - bufferB[index];
+        if (difference !== 0) {
+            return difference;
+        }
+    }
+    return bufferA.length - bufferB.length;
+};
+const canonicalizeStringConfiguration = (configuration) => {
+    if ((0, utils_1.isNil)(configuration) || typeof configuration !== "object" || Array.isArray(configuration)) {
+        throw new Error("Cannot canonicalize configuration objects that are not string maps of strings or arrays of strings");
+    }
+    const parts = [];
+    const normalizedConfiguration = {};
+    for (const [key, value] of Object.entries(configuration)) {
+        normalizedConfiguration[normalizeText(key)] = value;
+    }
+    for (const key of Object.keys(normalizedConfiguration).sort(compareUtf8)) {
+        const rawValue = normalizedConfiguration[key];
+        if (!isValidConfigurationValue(rawValue)) {
+            throw new Error(`Invalid configuration value for '${key}': ${rawValue}`);
+        }
+        const encodedKey = JSON.stringify(key);
+        let encodedValue;
+        if (typeof rawValue === "string") {
+            encodedValue = JSON.stringify(normalizeText(rawValue));
+        }
+        else {
+            const normalized = rawValue.map(normalizeText).sort(compareUtf8);
+            encodedValue = `[${normalized.map((entry) => JSON.stringify(entry)).join(",")}]`;
+        }
+        parts.push(`${encodedKey}:${encodedValue}`);
+    }
+    return `{${parts.join(",")}}`;
+};
+const hashConfiguration = (configuration) => {
+    const canonical = canonicalizeStringConfiguration(configuration);
+    return (0, node_crypto_1.createHash)("sha256").update(canonical, "utf8").digest("hex");
+};
+exports.hashConfiguration = hashConfiguration;

package/dist/v1/index.d.ts

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

package/dist/v1/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./schemas"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./functions"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./errors"), exports);

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

@@ -13,8 +13,8 @@ export declare const metadataSchema: z.ZodObject<{
     shortName: z.ZodString;
     group: z.ZodString;
     description: z.ZodString;
-    documentation: z.ZodOptional<z.ZodString>;
-    schemas: z.ZodOptional<z.ZodObject<{
+    documentation: z.ZodNullable<z.ZodString>;
+    schemas: z.ZodNullable<z.ZodObject<{
         properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
         parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, z.core.$strip>>;

package/dist/v1/schemas/metadata.js

@@ -29,10 +29,10 @@ exports.metadataSchema = zod_1.z
         .describe("A detailed description of the criteria set"),
     documentation: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Additional documentation or usage guidelines for the criteria set"),
     schemas: exports.schemaDefinitionsSchema
-        .optional()
+        .nullable()
         .describe("Definitions of property, parameter and result schemas for the criteria set"),
 })
     .describe("Metadata - The metadata for a criteria set");

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

@@ -8,8 +8,8 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
     shortName: z.ZodString;
     group: z.ZodString;
     description: z.ZodString;
-    documentation: z.ZodOptional<z.ZodString>;
-    schemas: z.ZodOptional<z.ZodObject<{
+    documentation: z.ZodNullable<z.ZodString>;
+    schemas: z.ZodNullable<z.ZodObject<{
         properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
         parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, z.core.$strip>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "2.7.6",
+  "version": "2.7.8-alpha.0",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",