@openframe-org/criteria-set-protocol 1.2.1 → 1.2.3

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

@@ -1,3 +1,4 @@
 export * from './criteria-set-id-param-schema';
-export * from './tree-and-matrix-body-schema';
+export * from './tree-body-schema';
+export * from './matrix-body-schema';
 export * from './version-param-schema';

package/dist/v1/schemas/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./criteria-set-id-param-schema"), exports);
-__exportStar(require("./tree-and-matrix-body-schema"), exports);
+__exportStar(require("./tree-body-schema"), exports);
+__exportStar(require("./matrix-body-schema"), exports);
 __exportStar(require("./version-param-schema"), exports);

package/dist/v1/schemas/matrix-body-schema.d.ts

@@ -0,0 +1,19 @@
+import * as yup from 'yup';
+/**
+ * Validates the request body for the matrix endpoints
+ */
+export declare const matrixBodySchema: yup.ObjectSchema<{
+    body: {
+        values?: {} | undefined;
+        locale?: string | undefined;
+        parameters?: {} | undefined;
+        additional?: {} | undefined;
+    } | undefined;
+}, yup.AnyObject, {
+    body: {
+        locale: undefined;
+        parameters: {};
+        values: {};
+        additional: undefined;
+    };
+}, "">;

package/dist/v1/schemas/matrix-body-schema.js

@@ -0,0 +1,38 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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.matrixBodySchema = void 0;
+const yup = __importStar(require("yup"));
+/**
+ * Validates the request body for the matrix endpoints
+ */
+exports.matrixBodySchema = yup.object({
+    body: yup.object({
+        locale: yup.string().optional(),
+        parameters: yup.object().optional(),
+        values: yup.object().optional(),
+        additional: yup.mixed().optional()
+    }).optional()
+});

package/dist/v1/schemas/tree-body-schema.d.ts

@@ -0,0 +1,17 @@
+import * as yup from 'yup';
+/**
+ * Validates the request body for the tree and data endpoints
+ */
+export declare const treeBodySchema: yup.ObjectSchema<{
+    body: {
+        values?: {} | undefined;
+        locale?: string | undefined;
+        parameters?: {} | undefined;
+    } | undefined;
+}, yup.AnyObject, {
+    body: {
+        locale: undefined;
+        parameters: {};
+        values: {};
+    };
+}, "">;

package/dist/v1/schemas/tree-body-schema.js

@@ -0,0 +1,37 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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.treeBodySchema = void 0;
+const yup = __importStar(require("yup"));
+/**
+ * Validates the request body for the tree and data endpoints
+ */
+exports.treeBodySchema = yup.object({
+    body: yup.object({
+        locale: yup.string().optional(),
+        parameters: yup.object().optional(),
+        values: yup.object().optional()
+    }).optional()
+});

package/dist/v1/services/i-criteria-set.service.d.ts

@@ -1,8 +1,10 @@
 import { CriteriaTree, Metadata, DataMap, StreamMatrixResponse, TaskItemValueMap } from '../types';
-export type CriteriaSetServiceFunctionParameters<ParametersType extends Record<string, any> = Record<string, any>> = {
+export type TreeAndMapParameters<ParametersType extends Record<string, any> = Record<string, any>> = {
     parameters?: ParametersType;
     values?: TaskItemValueMap | null;
     locale?: string | null;
+};
+export type MatrixParameters<ParametersType extends Record<string, any> = Record<string, any>> = TreeAndMapParameters<ParametersType> & {
     additional?: any;
 };
 export interface ICriteriaSetService<ParametersType extends Record<string, any> = Record<string, any>> {
@@ -10,7 +12,7 @@ export interface ICriteriaSetService<ParametersType extends Record<string, any>
     version: string;
     validateParameters(parameters: ParametersType): Promise<void>;
     getMetadata(): Metadata;
-    getDataMap(parameters: CriteriaSetServiceFunctionParameters<ParametersType>): DataMap;
-    getCriteriaTree(parameters: CriteriaSetServiceFunctionParameters<ParametersType>): CriteriaTree;
-    streamMatrix(parameters: CriteriaSetServiceFunctionParameters<ParametersType>): StreamMatrixResponse;
+    getDataMap(parameters: TreeAndMapParameters<ParametersType>): DataMap;
+    getCriteriaTree(parameters: TreeAndMapParameters<ParametersType>): CriteriaTree;
+    streamMatrix(parameters: MatrixParameters<ParametersType>): StreamMatrixResponse;
 }

package/package.json

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