@grnsft/if 0.1.9 → 0.2.0

package/build/util/validations.js

@@ -1,22 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateImpl = void 0;
+exports.validate = exports.validateManifest = void 0;
 const zod_1 = require("zod");
 const errors_1 = require("./errors");
-const aggregator_1 = require("../types/aggregator");
+const aggregation_1 = require("../types/aggregation");
 const parameters_1 = require("../types/parameters");
-const { ImplValidationError } = errors_1.ERRORS;
+const { ManifestValidationError, InputValidationError } = errors_1.ERRORS;
 /**
- * Validation schema for impl files.
+ * Validation schema for manifests.
  */
-const implValidation = zod_1.z.object({
+const manifestValidation = zod_1.z.object({
     name: zod_1.z.string(),
     'if-version': zod_1.z.string().optional().nullable(),
-    description: zod_1.z.string().nullable(),
+    description: zod_1.z.string().nullable().default(''),
     aggregation: zod_1.z
         .object({
         metrics: zod_1.z.array(zod_1.z.string()),
-        type: zod_1.z.enum(aggregator_1.AGGREGATION_METHODS),
+        type: zod_1.z.enum(aggregation_1.AGGREGATION_METHODS),
     })
         .optional(),
     params: zod_1.z
@@ -34,39 +34,46 @@ const implValidation = zod_1.z.object({
         complexity: zod_1.z.string().optional(),
         category: zod_1.z.string().optional(),
     })
-        .nullable(),
+        .nullable()
+        .default({}),
     initialize: zod_1.z.object({
-        models: zod_1.z.array(zod_1.z.object({
-            name: zod_1.z.string(),
+        plugins: zod_1.z.record(zod_1.z.string(), zod_1.z.object({
             path: zod_1.z.string(),
-            model: zod_1.z.string(),
-            config: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+            method: zod_1.z.string(),
+            'global-config': zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
         })),
+        outputs: zod_1.z.array(zod_1.z.string()).optional(),
     }),
-    graph: zod_1.z
-        .object({
-        children: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
-    })
-        .required(),
+    tree: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
 });
 /**
- * Validates given `impl` object to match pattern.
+ * Validates given `manifest` object to match pattern.
  */
-const validateImpl = (impl) => {
-    const validatedImpl = implValidation.safeParse(impl);
-    if (!validatedImpl.success) {
-        const prettifyErrorMessage = (issues) => {
-            const issuesArray = JSON.parse(issues);
-            return issuesArray.map((issue) => {
-                const { code, path, message } = issue;
-                const flattenPath = path.map(part => typeof part === 'number' ? `[${part}]` : part);
-                const fullPath = flattenPath.join('.');
-                return `"${fullPath}" parameter is ${message.toLowerCase()}. Error code: ${code}.`;
-            });
-        };
-        throw new ImplValidationError(prettifyErrorMessage(validatedImpl.error.message));
+const validateManifest = (manifest) => {
+    return (0, exports.validate)(manifestValidation, manifest, ManifestValidationError);
+};
+exports.validateManifest = validateManifest;
+/**
+ * Validates given `object` with given `schema`.
+ */
+const validate = (schema, object, errorConstructor = InputValidationError) => {
+    const validationResult = schema.safeParse(object);
+    if (!validationResult.success) {
+        throw new errorConstructor(prettifyErrorMessage(validationResult.error.message));
     }
-    return validatedImpl.data;
+    return validationResult.data;
+};
+exports.validate = validate;
+const prettifyErrorMessage = (issues) => {
+    const issuesArray = JSON.parse(issues);
+    return issuesArray.map((issue) => {
+        const { code, path, message } = issue;
+        const flattenPath = path.map(part => typeof part === 'number' ? `[${part}]` : part);
+        const fullPath = flattenPath.join('.');
+        if (code === 'custom') {
+            return `${message.toLowerCase()}. Error code: ${code}.`;
+        }
+        return `"${fullPath}" parameter is ${message.toLowerCase()}. Error code: ${code}.`;
+    });
 };
-exports.validateImpl = validateImpl;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbC92YWxpZGF0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw2QkFBZ0M7QUFFaEMscUNBQWdDO0FBRWhDLG9EQUF3RDtBQUN4RCxvREFBc0Q7QUFHdEQsTUFBTSxFQUFDLG1CQUFtQixFQUFDLEdBQUcsZUFBTSxDQUFDO0FBRXJDOztHQUVHO0FBQ0gsTUFBTSxjQUFjLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUM5QixJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtJQUNoQixZQUFZLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUM5QyxXQUFXLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUNsQyxXQUFXLEVBQUUsT0FBQztTQUNYLE1BQU0sQ0FBQztRQUNOLE9BQU8sRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUM1QixJQUFJLEVBQUUsT0FBQyxDQUFDLElBQUksQ0FBQyxnQ0FBbUIsQ0FBQztLQUNsQyxDQUFDO1NBQ0QsUUFBUSxFQUFFO0lBQ2IsTUFBTSxFQUFFLE9BQUM7U0FDTixLQUFLLENBQ0osT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2hCLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3ZCLFdBQVcsRUFBRSxPQUFDLENBQUMsSUFBSSxDQUFDLDhCQUFpQixDQUFDO1FBQ3RDLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0tBQ2pCLENBQUMsQ0FDSDtTQUNBLFFBQVEsRUFBRTtTQUNWLFFBQVEsRUFBRTtJQUNiLElBQUksRUFBRSxPQUFDO1NBQ0osTUFBTSxDQUFDO1FBQ04sSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7UUFDM0IsVUFBVSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7UUFDakMsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7S0FDaEMsQ0FBQztTQUNELFFBQVEsRUFBRTtJQUNiLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxDQUFDO1FBQ25CLE1BQU0sRUFBRSxPQUFDLENBQUMsS0FBSyxDQUNiLE9BQUMsQ0FBQyxNQUFNLENBQUM7WUFDUCxJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtZQUNoQixJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtZQUNoQixLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRTtZQUNqQixNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sQ0FBQyxPQUFDLENBQUMsTUFBTSxFQUFFLEVBQUUsT0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsUUFBUSxFQUFFO1NBQ2pELENBQUMsQ0FDSDtLQUNGLENBQUM7SUFDRixLQUFLLEVBQUUsT0FBQztTQUNMLE1BQU0sQ0FBQztRQUNOLFFBQVEsRUFBRSxPQUFDLENBQUMsTUFBTSxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxPQUFDLENBQUMsR0FBRyxFQUFFLENBQUM7S0FDeEMsQ0FBQztTQUNELFFBQVEsRUFBRTtDQUNkLENBQUMsQ0FBQztBQUVIOztHQUVHO0FBQ0ksTUFBTSxZQUFZLEdBQUcsQ0FBQyxJQUFVLEVBQUUsRUFBRTtJQUN6QyxNQUFNLGFBQWEsR0FBRyxjQUFjLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXJELElBQUksQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFO1FBQzFCLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxNQUFjLEVBQUUsRUFBRTtZQUM5QyxNQUFNLFdBQVcsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1lBRXZDLE9BQU8sV0FBVyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEtBQWUsRUFBRSxFQUFFO2dCQUN6QyxNQUFNLEVBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxPQUFPLEVBQUMsR0FBRyxLQUFLLENBQUM7Z0JBQ3BDLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FDbEMsT0FBTyxJQUFJLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQzlDLENBQUM7Z0JBQ0YsTUFBTSxRQUFRLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztnQkFFdkMsT0FBTyxJQUFJLFFBQVEsa0JBQWtCLE9BQU8sQ0FBQyxXQUFXLEVBQUUsaUJBQWlCLElBQUksR0FBRyxDQUFDO1lBQ3JGLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQyxDQUFDO1FBRUYsTUFBTSxJQUFJLG1CQUFtQixDQUMzQixvQkFBb0IsQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUNsRCxDQUFDO0tBQ0g7SUFFRCxPQUFPLGFBQWEsQ0FBQyxJQUFJLENBQUM7QUFDNUIsQ0FBQyxDQUFDO0FBeEJXLFFBQUEsWUFBWSxnQkF3QnZCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtab2RJc3N1ZSwgen0gZnJvbSAnem9kJztcblxuaW1wb3J0IHtFUlJPUlN9IGZyb20gJy4vZXJyb3JzJztcblxuaW1wb3J0IHtBR0dSRUdBVElPTl9NRVRIT0RTfSBmcm9tICcuLi90eXBlcy9hZ2dyZWdhdG9yJztcbmltcG9ydCB7QUdHUkVHQVRJT05fVFlQRVN9IGZyb20gJy4uL3R5cGVzL3BhcmFtZXRlcnMnO1xuaW1wb3J0IHtJbXBsfSBmcm9tICcuLi90eXBlcy9pbXBsJztcblxuY29uc3Qge0ltcGxWYWxpZGF0aW9uRXJyb3J9ID0gRVJST1JTO1xuXG4vKipcbiAqIFZhbGlkYXRpb24gc2NoZW1hIGZvciBpbXBsIGZpbGVzLlxuICovXG5jb25zdCBpbXBsVmFsaWRhdGlvbiA9IHoub2JqZWN0KHtcbiAgbmFtZTogei5zdHJpbmcoKSxcbiAgJ2lmLXZlcnNpb24nOiB6LnN0cmluZygpLm9wdGlvbmFsKCkubnVsbGFibGUoKSxcbiAgZGVzY3JpcHRpb246IHouc3RyaW5nKCkubnVsbGFibGUoKSxcbiAgYWdncmVnYXRpb246IHpcbiAgICAub2JqZWN0KHtcbiAgICAgIG1ldHJpY3M6IHouYXJyYXkoei5zdHJpbmcoKSksXG4gICAgICB0eXBlOiB6LmVudW0oQUdHUkVHQVRJT05fTUVUSE9EUyksXG4gICAgfSlcbiAgICAub3B0aW9uYWwoKSxcbiAgcGFyYW1zOiB6XG4gICAgLmFycmF5KFxuICAgICAgei5vYmplY3Qoe1xuICAgICAgICBuYW1lOiB6LnN0cmluZygpLFxuICAgICAgICBkZXNjcmlwdGlvbjogei5zdHJpbmcoKSxcbiAgICAgICAgYWdncmVnYXRpb246IHouZW51bShBR0dSRUdBVElPTl9UWVBFUyksXG4gICAgICAgIHVuaXQ6IHouc3RyaW5nKCksXG4gICAgICB9KVxuICAgIClcbiAgICAub3B0aW9uYWwoKVxuICAgIC5udWxsYWJsZSgpLFxuICB0YWdzOiB6XG4gICAgLm9iamVjdCh7XG4gICAgICBraW5kOiB6LnN0cmluZygpLm9wdGlvbmFsKCksXG4gICAgICBjb21wbGV4aXR5OiB6LnN0cmluZygpLm9wdGlvbmFsKCksXG4gICAgICBjYXRlZ29yeTogei5zdHJpbmcoKS5vcHRpb25hbCgpLFxuICAgIH0pXG4gICAgLm51bGxhYmxlKCksXG4gIGluaXRpYWxpemU6IHoub2JqZWN0KHtcbiAgICBtb2RlbHM6IHouYXJyYXkoXG4gICAgICB6Lm9iamVjdCh7XG4gICAgICAgIG5hbWU6IHouc3RyaW5nKCksXG4gICAgICAgIHBhdGg6IHouc3RyaW5nKCksXG4gICAgICAgIG1vZGVsOiB6LnN0cmluZygpLFxuICAgICAgICBjb25maWc6IHoucmVjb3JkKHouc3RyaW5nKCksIHouYW55KCkpLm9wdGlvbmFsKCksXG4gICAgICB9KVxuICAgICksXG4gIH0pLFxuICBncmFwaDogelxuICAgIC5vYmplY3Qoe1xuICAgICAgY2hpbGRyZW46IHoucmVjb3JkKHouc3RyaW5nKCksIHouYW55KCkpLFxuICAgIH0pXG4gICAgLnJlcXVpcmVkKCksXG59KTtcblxuLyoqXG4gKiBWYWxpZGF0ZXMgZ2l2ZW4gYGltcGxgIG9iamVjdCB0byBtYXRjaCBwYXR0ZXJuLlxuICovXG5leHBvcnQgY29uc3QgdmFsaWRhdGVJbXBsID0gKGltcGw6IEltcGwpID0+IHtcbiAgY29uc3QgdmFsaWRhdGVkSW1wbCA9IGltcGxWYWxpZGF0aW9uLnNhZmVQYXJzZShpbXBsKTtcblxuICBpZiAoIXZhbGlkYXRlZEltcGwuc3VjY2Vzcykge1xuICAgIGNvbnN0IHByZXR0aWZ5RXJyb3JNZXNzYWdlID0gKGlzc3Vlczogc3RyaW5nKSA9PiB7XG4gICAgICBjb25zdCBpc3N1ZXNBcnJheSA9IEpTT04ucGFyc2UoaXNzdWVzKTtcblxuICAgICAgcmV0dXJuIGlzc3Vlc0FycmF5Lm1hcCgoaXNzdWU6IFpvZElzc3VlKSA9PiB7XG4gICAgICAgIGNvbnN0IHtjb2RlLCBwYXRoLCBtZXNzYWdlfSA9IGlzc3VlO1xuICAgICAgICBjb25zdCBmbGF0dGVuUGF0aCA9IHBhdGgubWFwKHBhcnQgPT5cbiAgICAgICAgICB0eXBlb2YgcGFydCA9PT0gJ251bWJlcicgPyBgWyR7cGFydH1dYCA6IHBhcnRcbiAgICAgICAgKTtcbiAgICAgICAgY29uc3QgZnVsbFBhdGggPSBmbGF0dGVuUGF0aC5qb2luKCcuJyk7XG5cbiAgICAgICAgcmV0dXJuIGBcIiR7ZnVsbFBhdGh9XCIgcGFyYW1ldGVyIGlzICR7bWVzc2FnZS50b0xvd2VyQ2FzZSgpfS4gRXJyb3IgY29kZTogJHtjb2RlfS5gO1xuICAgICAgfSk7XG4gICAgfTtcblxuICAgIHRocm93IG5ldyBJbXBsVmFsaWRhdGlvbkVycm9yKFxuICAgICAgcHJldHRpZnlFcnJvck1lc3NhZ2UodmFsaWRhdGVkSW1wbC5lcnJvci5tZXNzYWdlKVxuICAgICk7XG4gIH1cblxuICByZXR1cm4gdmFsaWRhdGVkSW1wbC5kYXRhO1xufTtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdXRpbC92YWxpZGF0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSw2QkFBMkM7QUFFM0MscUNBQWdDO0FBRWhDLHNEQUF5RDtBQUN6RCxvREFBc0Q7QUFHdEQsTUFBTSxFQUFDLHVCQUF1QixFQUFFLG9CQUFvQixFQUFDLEdBQUcsZUFBTSxDQUFDO0FBRS9EOztHQUVHO0FBQ0gsTUFBTSxrQkFBa0IsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQ2xDLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0lBQ2hCLFlBQVksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsUUFBUSxFQUFFO0lBQzlDLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsUUFBUSxFQUFFLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztJQUM5QyxXQUFXLEVBQUUsT0FBQztTQUNYLE1BQU0sQ0FBQztRQUNOLE9BQU8sRUFBRSxPQUFDLENBQUMsS0FBSyxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUM1QixJQUFJLEVBQUUsT0FBQyxDQUFDLElBQUksQ0FBQyxpQ0FBbUIsQ0FBQztLQUNsQyxDQUFDO1NBQ0QsUUFBUSxFQUFFO0lBQ2IsTUFBTSxFQUFFLE9BQUM7U0FDTixLQUFLLENBQ0osT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNQLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ2hCLFdBQVcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1FBQ3ZCLFdBQVcsRUFBRSxPQUFDLENBQUMsSUFBSSxDQUFDLDhCQUFpQixDQUFDO1FBQ3RDLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0tBQ2pCLENBQUMsQ0FDSDtTQUNBLFFBQVEsRUFBRTtTQUNWLFFBQVEsRUFBRTtJQUNiLElBQUksRUFBRSxPQUFDO1NBQ0osTUFBTSxDQUFDO1FBQ04sSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7UUFDM0IsVUFBVSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7UUFDakMsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxRQUFRLEVBQUU7S0FDaEMsQ0FBQztTQUNELFFBQVEsRUFBRTtTQUNWLE9BQU8sQ0FBQyxFQUFFLENBQUM7SUFDZCxVQUFVLEVBQUUsT0FBQyxDQUFDLE1BQU0sQ0FBQztRQUNuQixPQUFPLEVBQUUsT0FBQyxDQUFDLE1BQU0sQ0FDZixPQUFDLENBQUMsTUFBTSxFQUFFLEVBQ1YsT0FBQyxDQUFDLE1BQU0sQ0FBQztZQUNQLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1lBQ2hCLE1BQU0sRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO1lBQ2xCLGVBQWUsRUFBRSxPQUFDLENBQUMsTUFBTSxDQUFDLE9BQUMsQ0FBQyxNQUFNLEVBQUUsRUFBRSxPQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQyxRQUFRLEVBQUU7U0FDMUQsQ0FBQyxDQUNIO1FBQ0QsT0FBTyxFQUFFLE9BQUMsQ0FBQyxLQUFLLENBQUMsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsUUFBUSxFQUFFO0tBQ3hDLENBQUM7SUFDRixJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sQ0FBQyxPQUFDLENBQUMsTUFBTSxFQUFFLEVBQUUsT0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDO0NBQ3BDLENBQUMsQ0FBQztBQUVIOztHQUVHO0FBQ0ksTUFBTSxnQkFBZ0IsR0FBRyxDQUFDLFFBQWtCLEVBQUUsRUFBRTtJQUNyRCxPQUFPLElBQUEsZ0JBQVEsRUFBQyxrQkFBa0IsRUFBRSxRQUFRLEVBQUUsdUJBQXVCLENBQUMsQ0FBQztBQUN6RSxDQUFDLENBQUM7QUFGVyxRQUFBLGdCQUFnQixvQkFFM0I7QUFFRjs7R0FFRztBQUNJLE1BQU0sUUFBUSxHQUFHLENBQ3RCLE1BQW9CLEVBQ3BCLE1BQVcsRUFDWCxtQkFBcUMsb0JBQW9CLEVBQ3pELEVBQUU7SUFDRixNQUFNLGdCQUFnQixHQUFHLE1BQU0sQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFbEQsSUFBSSxDQUFDLGdCQUFnQixDQUFDLE9BQU8sRUFBRTtRQUM3QixNQUFNLElBQUksZ0JBQWdCLENBQ3hCLG9CQUFvQixDQUFDLGdCQUFnQixDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FDckQsQ0FBQztLQUNIO0lBRUQsT0FBTyxnQkFBZ0IsQ0FBQyxJQUFJLENBQUM7QUFDL0IsQ0FBQyxDQUFDO0FBZFcsUUFBQSxRQUFRLFlBY25CO0FBRUYsTUFBTSxvQkFBb0IsR0FBRyxDQUFDLE1BQWMsRUFBRSxFQUFFO0lBQzlDLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFdkMsT0FBTyxXQUFXLENBQUMsR0FBRyxDQUFDLENBQUMsS0FBZSxFQUFFLEVBQUU7UUFDekMsTUFBTSxFQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFDLEdBQUcsS0FBSyxDQUFDO1FBQ3BDLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FDbEMsT0FBTyxJQUFJLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQzlDLENBQUM7UUFDRixNQUFNLFFBQVEsR0FBRyxXQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBRXZDLElBQUksSUFBSSxLQUFLLFFBQVEsRUFBRTtZQUNyQixPQUFPLEdBQUcsT0FBTyxDQUFDLFdBQVcsRUFBRSxpQkFBaUIsSUFBSSxHQUFHLENBQUM7U0FDekQ7UUFDRCxPQUFPLElBQUksUUFBUSxrQkFBa0IsT0FBTyxDQUFDLFdBQVcsRUFBRSxpQkFBaUIsSUFBSSxHQUFHLENBQUM7SUFDckYsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge1pvZElzc3VlLCBab2RTY2hlbWEsIHp9IGZyb20gJ3pvZCc7XG5cbmltcG9ydCB7RVJST1JTfSBmcm9tICcuL2Vycm9ycyc7XG5cbmltcG9ydCB7QUdHUkVHQVRJT05fTUVUSE9EU30gZnJvbSAnLi4vdHlwZXMvYWdncmVnYXRpb24nO1xuaW1wb3J0IHtBR0dSRUdBVElPTl9UWVBFU30gZnJvbSAnLi4vdHlwZXMvcGFyYW1ldGVycyc7XG5pbXBvcnQge01hbmlmZXN0fSBmcm9tICcuLi90eXBlcy9tYW5pZmVzdCc7XG5cbmNvbnN0IHtNYW5pZmVzdFZhbGlkYXRpb25FcnJvciwgSW5wdXRWYWxpZGF0aW9uRXJyb3J9ID0gRVJST1JTO1xuXG4vKipcbiAqIFZhbGlkYXRpb24gc2NoZW1hIGZvciBtYW5pZmVzdHMuXG4gKi9cbmNvbnN0IG1hbmlmZXN0VmFsaWRhdGlvbiA9IHoub2JqZWN0KHtcbiAgbmFtZTogei5zdHJpbmcoKSxcbiAgJ2lmLXZlcnNpb24nOiB6LnN0cmluZygpLm9wdGlvbmFsKCkubnVsbGFibGUoKSxcbiAgZGVzY3JpcHRpb246IHouc3RyaW5nKCkubnVsbGFibGUoKS5kZWZhdWx0KCcnKSxcbiAgYWdncmVnYXRpb246IHpcbiAgICAub2JqZWN0KHtcbiAgICAgIG1ldHJpY3M6IHouYXJyYXkoei5zdHJpbmcoKSksXG4gICAgICB0eXBlOiB6LmVudW0oQUdHUkVHQVRJT05fTUVUSE9EUyksXG4gICAgfSlcbiAgICAub3B0aW9uYWwoKSxcbiAgcGFyYW1zOiB6XG4gICAgLmFycmF5KFxuICAgICAgei5vYmplY3Qoe1xuICAgICAgICBuYW1lOiB6LnN0cmluZygpLFxuICAgICAgICBkZXNjcmlwdGlvbjogei5zdHJpbmcoKSxcbiAgICAgICAgYWdncmVnYXRpb246IHouZW51bShBR0dSRUdBVElPTl9UWVBFUyksXG4gICAgICAgIHVuaXQ6IHouc3RyaW5nKCksXG4gICAgICB9KVxuICAgIClcbiAgICAub3B0aW9uYWwoKVxuICAgIC5udWxsYWJsZSgpLFxuICB0YWdzOiB6XG4gICAgLm9iamVjdCh7XG4gICAgICBraW5kOiB6LnN0cmluZygpLm9wdGlvbmFsKCksXG4gICAgICBjb21wbGV4aXR5OiB6LnN0cmluZygpLm9wdGlvbmFsKCksXG4gICAgICBjYXRlZ29yeTogei5zdHJpbmcoKS5vcHRpb25hbCgpLFxuICAgIH0pXG4gICAgLm51bGxhYmxlKClcbiAgICAuZGVmYXVsdCh7fSksXG4gIGluaXRpYWxpemU6IHoub2JqZWN0KHtcbiAgICBwbHVnaW5zOiB6LnJlY29yZChcbiAgICAgIHouc3RyaW5nKCksXG4gICAgICB6Lm9iamVjdCh7XG4gICAgICAgIHBhdGg6IHouc3RyaW5nKCksXG4gICAgICAgIG1ldGhvZDogei5zdHJpbmcoKSxcbiAgICAgICAgJ2dsb2JhbC1jb25maWcnOiB6LnJlY29yZCh6LnN0cmluZygpLCB6LmFueSgpKS5vcHRpb25hbCgpLFxuICAgICAgfSlcbiAgICApLFxuICAgIG91dHB1dHM6IHouYXJyYXkoei5zdHJpbmcoKSkub3B0aW9uYWwoKSxcbiAgfSksXG4gIHRyZWU6IHoucmVjb3JkKHouc3RyaW5nKCksIHouYW55KCkpLFxufSk7XG5cbi8qKlxuICogVmFsaWRhdGVzIGdpdmVuIGBtYW5pZmVzdGAgb2JqZWN0IHRvIG1hdGNoIHBhdHRlcm4uXG4gKi9cbmV4cG9ydCBjb25zdCB2YWxpZGF0ZU1hbmlmZXN0ID0gKG1hbmlmZXN0OiBNYW5pZmVzdCkgPT4ge1xuICByZXR1cm4gdmFsaWRhdGUobWFuaWZlc3RWYWxpZGF0aW9uLCBtYW5pZmVzdCwgTWFuaWZlc3RWYWxpZGF0aW9uRXJyb3IpO1xufTtcblxuLyoqXG4gKiBWYWxpZGF0ZXMgZ2l2ZW4gYG9iamVjdGAgd2l0aCBnaXZlbiBgc2NoZW1hYC5cbiAqL1xuZXhwb3J0IGNvbnN0IHZhbGlkYXRlID0gPFQ+KFxuICBzY2hlbWE6IFpvZFNjaGVtYTxUPixcbiAgb2JqZWN0OiBhbnksXG4gIGVycm9yQ29uc3RydWN0b3I6IEVycm9yQ29uc3RydWN0b3IgPSBJbnB1dFZhbGlkYXRpb25FcnJvclxuKSA9PiB7XG4gIGNvbnN0IHZhbGlkYXRpb25SZXN1bHQgPSBzY2hlbWEuc2FmZVBhcnNlKG9iamVjdCk7XG5cbiAgaWYgKCF2YWxpZGF0aW9uUmVzdWx0LnN1Y2Nlc3MpIHtcbiAgICB0aHJvdyBuZXcgZXJyb3JDb25zdHJ1Y3RvcihcbiAgICAgIHByZXR0aWZ5RXJyb3JNZXNzYWdlKHZhbGlkYXRpb25SZXN1bHQuZXJyb3IubWVzc2FnZSlcbiAgICApO1xuICB9XG5cbiAgcmV0dXJuIHZhbGlkYXRpb25SZXN1bHQuZGF0YTtcbn07XG5cbmNvbnN0IHByZXR0aWZ5RXJyb3JNZXNzYWdlID0gKGlzc3Vlczogc3RyaW5nKSA9PiB7XG4gIGNvbnN0IGlzc3Vlc0FycmF5ID0gSlNPTi5wYXJzZShpc3N1ZXMpO1xuXG4gIHJldHVybiBpc3N1ZXNBcnJheS5tYXAoKGlzc3VlOiBab2RJc3N1ZSkgPT4ge1xuICAgIGNvbnN0IHtjb2RlLCBwYXRoLCBtZXNzYWdlfSA9IGlzc3VlO1xuICAgIGNvbnN0IGZsYXR0ZW5QYXRoID0gcGF0aC5tYXAocGFydCA9PlxuICAgICAgdHlwZW9mIHBhcnQgPT09ICdudW1iZXInID8gYFske3BhcnR9XWAgOiBwYXJ0XG4gICAgKTtcbiAgICBjb25zdCBmdWxsUGF0aCA9IGZsYXR0ZW5QYXRoLmpvaW4oJy4nKTtcblxuICAgIGlmIChjb2RlID09PSAnY3VzdG9tJykge1xuICAgICAgcmV0dXJuIGAke21lc3NhZ2UudG9Mb3dlckNhc2UoKX0uIEVycm9yIGNvZGU6ICR7Y29kZX0uYDtcbiAgICB9XG4gICAgcmV0dXJuIGBcIiR7ZnVsbFBhdGh9XCIgcGFyYW1ldGVyIGlzICR7bWVzc2FnZS50b0xvd2VyQ2FzZSgpfS4gRXJyb3IgY29kZTogJHtjb2RlfS5gO1xuICB9KTtcbn07XG4iXX0=

package/examples/{impls/test → manifests}/azure-importer.yml

@@ -2,23 +2,23 @@ name: azure-importer
 description: example impl invoking Azure Importer model
 tags:
 initialize:
-  models:
-    - name: azure-importer
-      path: "@grnsft/if-unofficial-models"
-      model: AzureImporterModel
+  plugins:
+    azure-importer:
+      path: "@grnsft/if-unofficial-plugins"
+      method: AzureImporter
       kind: plugin
-graph:
+tree:
   children:
     child:
       pipeline:
         - azure-importer
       config:
         azure-importer:
-      inputs:
-        - timestamp: "2023-11-02T10:35:31.820Z"
-          duration: 3600
           azure-observation-window: 5 min # value and unit must be space separated
           azure-observation-aggregation: "average"
           azure-subscription-id: 42a3c589-87ce-4478-8ed6-9adc11b81965
           azure-resource-group: Group1
           azure-vm-name: VM1
+      inputs:
+        - timestamp: "2023-11-02T10:35:31.820Z"
+          duration: 3600

package/examples/manifests/basic-demo.yml

@@ -0,0 +1,75 @@
+name: basic-demo
+description: null
+tags: null
+initialize:
+  plugins:
+    mock-observations:
+      path: "@grnsft/if-plugins"
+      method: MockObservations
+      global-config:
+        timestamp-from: 2024-02-26T00:00
+        timestamp-to: 2024-02-26T00:10
+        duration: 60
+        components:
+          - cloud/instance-type: Standard_A1_v2
+          - cloud/instance-type: Standard_A2_v2
+        generators:
+          common:
+            cloud/vendor: azure
+            cloud/region: uk-west
+            geolocation: 37.7749,-122.4194
+          randint:
+            cpu/utilization:
+              min: 1
+              max: 99
+    teads-curve:
+      path: "@grnsft/if-unofficial-plugins"
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    group-by:
+      path: "builtin"
+      method: GroupBy
+    cloud-metadata:
+      method: CloudInstanceMetadata
+      path: "@grnsft/if-plugins"
+    operational-carbon:
+      path: "@grnsft/if-plugins"
+      method: Multiply
+      global-config:
+        input-parameters: ["cpu/energy", "grid/carbon-intensity"]
+        output-parameter: "cpu/carbon"
+    watttime:
+      path: "@grnsft/if-unofficial-plugins"
+      method: WattTimeGridEmissions
+      global-config:
+        # username: ENV_WATT_TIME_USERNAME
+        # password: ENV_WATT_TIME_PASSWORD
+        username: manushak
+        password: "@watt-time17"
+tree:
+  children:
+    application:
+      pipeline:
+        - mock-observations
+        # - group-by
+        - cloud-metadata
+        - teads-curve
+        - watttime
+        - operational-carbon
+      defaults:
+        grid/carbon-intensity: 250
+        geolocation: 37.7749,-122.4194
+      # config:
+      #   group-by:
+      #     group:
+      #       - cloud/region
+      #       - cloud/instance-type
+      inputs:
+        - timestamp: "2024-02-26 00:00:00"
+          duration: 60
+          cloud/instance-type: Standard_A1_v2
+          cloud/vendor: azure
+          cloud/region: uk-west
+          geolocation: 37.7749,-122.4194
+          cpu/utilization: 15

package/examples/manifests/basic.yml

@@ -0,0 +1,27 @@
+name: basic-demo
+description:
+tags:
+initialize:
+  plugins:
+    teads-curve: 
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+      pipeline:
+        - teads-curve
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          cpu/utilization: 20
+        - timestamp: 2023-07-06T00:01
+          duration: 1
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:02
+          duration: 1
+          cpu/utilization: 20

package/examples/manifests/boavizta-pipeline.yml

@@ -0,0 +1,85 @@
+name: boavizta-demo
+description:
+tags:
+initialize:
+  plugins:
+    boavizta-cpu:
+      method: BoaviztaCpuOutput
+      path: '@grnsft/if-unofficial-plugins'
+      global-config:
+        allocation: LINEAR
+        verbose: true
+    "sum":
+      path: "@grnsft/if-plugins"
+      method: Sum
+      global-config:
+        input-parameters: 
+          - cpu/energy
+          - network/energy
+        output-parameter: energy 
+    "sci-m":
+      path: "@grnsft/if-plugins"
+      method: SciM
+    "sci-o":
+      path: "@grnsft/if-plugins"
+      method: SciO
+    "sci":
+      path: "@grnsft/if-plugins"
+      method: Sci
+      global-config:
+        functional-unit: ''
+        functional-unit-time: '1-day'
+    "time-sync":
+      method: TimeSync
+      path: "builtin"
+      global-config:
+        start-time: "2023-12-12T00:00:00.000Z"
+        end-time: "2023-12-12T00:01:00.000Z"
+        interval: 5
+        allow-padding: true
+tree:
+  children:
+    child-1:
+      pipeline:
+        - boavizta-cpu
+        - sum
+        - sci-m
+        - sci-o
+        - time-sync
+        - sci
+      config:
+      defaults:
+        cpu/thermal-design-power: 100
+        grid/carbon-intensity: 800
+        device/emissions-embodied: 1533.120 # gCO2eq
+        time-reserved: 3600 # 1hr in seconds
+        device/expected-lifespan: 94608000 # 3 years in seconds
+        resources-reserved: 1
+        resources-total: 8
+        cpu/number-cores: 24
+        cpu/name: Intel® Core™ i7-1185G7
+      inputs:
+        - timestamp: "2023-12-12T00:00:00.000Z"
+          cloud/instance-type: A1 
+          region: uk-west
+          duration: 1
+          cpu/utilization: 50
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:01.000Z"
+          duration: 5
+          cpu/utilization: 20
+          cloud/instance-type: A1 
+          region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:06.000Z"
+          duration: 7
+          cpu/utilization: 15
+          cloud/instance-type: A1 
+          region: uk-west
+          network/energy: 0.000001
+        - timestamp: "2023-12-12T00:00:13.000Z"
+          duration: 30
+          cloud/instance-type: A1 
+          region: uk-west
+          cpu/utilization: 15
+          network/energy: 0.000001

package/examples/{impls/test → manifests}/boavizta.yml

@@ -2,26 +2,25 @@ name: boavizta
 description: calls boavizta api
 tags:
 initialize:
-  models:
-    - name: boavizta-cpu
-      model: BoaviztaCpuOutputModel
-      path: "@grnsft/if-unofficial-models"
-      config:
+  plugins:
+    "boavizta-cpu":
+      method: BoaviztaCpuOutput
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
         allocation: LINEAR
         verbose: true
-graph:
+tree:
   children:
     child:
       pipeline:
         - boavizta-cpu
-      config:
-        boavizta-cpu:
-          core-units: 24
-          physical-processor: Intel® Core™ i7-1185G7
+      defaults:
+        cpu/number-cores: 24
+        cpu/name: Intel® Core™ i7-1185G7
       inputs:
         - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
           duration: 3600 # Secs
-          cpu-util: 18.392
+          cpu/utilization: 18.392
         - timestamp: 2023-08-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
           duration: 3600 # Secs
-          cpu-util: 16
+          cpu/utilization: 16

package/examples/{impls/test → manifests}/ccf.yml

@@ -2,20 +2,19 @@ name: ccf-demo
 description: example impl invoking CCF model
 tags:
 initialize:
-  models:
-    - name: ccf
-      model: CloudCarbonFootprint
-      path: "@grnsft/if-unofficial-models"
-graph:
+  plugins:
+    ccf:
+      method: CloudCarbonFootprint
+      path: "@grnsft/if-unofficial-plugins"
+tree:
   children:
     child:
       pipeline:
         - ccf
-      config:
-        ccf:
-          vendor: 'aws'
-          instance-type: 'm5n.large'
+      defaults:
+        cloud/vendor: "aws"
+        cloud/instance-type: "m5n.large"
       inputs:
         - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
           duration: 1
-          cpu-util: 10
+          cpu/utilization: 10

package/examples/manifests/cim.yml

@@ -0,0 +1,20 @@
+name: cloud-instance-metadata
+description: example impl invoking Cloud Instance Metadata plugin
+tags:
+initialize:
+  plugins:
+    cloud-instance-metadata:
+      method: CloudInstanceMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - cloud-instance-metadata
+      config:
+      inputs:
+        - timestamp: 2023-07-06T00:00 # [KEYWORD] [NO-SUBFIELDS] time when measurement occurred
+          cloud/vendor: aws
+          cloud/instance-type: m5n.large
+          duration: 100
+          cpu/utilization: 10

package/examples/manifests/cloud-metadata.yml

@@ -0,0 +1,41 @@
+name: coud-instanmce-metadata-demo
+description: null
+tags: null
+initialize:
+  plugins:
+    teads-curve:
+      path: '@grnsft/if-unofficial-plugins'
+      method: TeadsCurve
+      global-config:
+        interpolation: spline
+    cloud-instance-metadata:
+      method: CloudInstanceMetadata
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child-0:
+      defaults:
+        cpu/thermal-design-power: 100
+        cloud/vendor: aws
+        cloud/instance-type: m5n.large
+      pipeline:
+        - teads-curve
+        - cloud-instance-metadata
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 10
+          cpu/utilization: 80
+        - timestamp: 2023-07-06T00:01
+          duration: 10
+          cpu/utilization: 80
+      outputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 10
+          cpu/utilization: 80
+          cpu/thermal-design-power: 100
+          cpu/energy: 0.00025568089430894314
+        - timestamp: 2023-07-06T00:01
+          duration: 10
+          cpu/utilization: 80
+          cpu/thermal-design-power: 100
+          cpu/energy: 0.00025568089430894314

package/examples/manifests/co2js.yml

@@ -0,0 +1,30 @@
+name: co2js-demo
+description: example impl invoking CO2.JS model
+tags:
+initialize:
+  plugins:
+    co2js:
+      method: Co2js
+      path: "@grnsft/if-unofficial-plugins"
+      global-config:
+        options:
+          dataReloadRatio: 0.6
+          firstVisitPercentage: 0.9
+          returnVisitPercentage: 0.1
+          gridIntensity:
+            device: 560.98
+            dataCenter:
+              country: "TWN"
+tree:
+  children:
+    child:
+      pipeline:
+        - co2js
+      config:
+        co2js:
+          type: swd
+          green-web-host: true
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          network/data/bytes: 1000000

package/examples/manifests/coefficient.yml

@@ -0,0 +1,23 @@
+name: coefficient-demo
+description:
+tags:
+initialize:
+  plugins:
+    coefficient:
+      method: Coefficient
+      path: "@grnsft/if-plugins"
+      global-config:
+        input-parameter: "carbon"
+        coefficient: 3
+        output-parameter: "carbon-product"
+tree:
+  children:
+    child:
+      pipeline:
+        - coefficient
+      config:
+        sum:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          carbon: 30

package/examples/manifests/csv-export.yml

@@ -0,0 +1,34 @@
+name: csv-export-demo
+description: example exporting output to a csv file
+tags:
+initialize:
+  plugins:
+    csv-exporter:
+      method: CsvExport
+      path: "@grnsft/if-plugins"
+tree:
+  children:
+    child:
+      pipeline:
+        - csv-exporter
+      config:
+        csv-exporter:
+          output-path: ./examples/outputs/csv-test.csv
+          headers:
+            - timestamp
+            - duration
+            - carbon
+            - energy
+      inputs:
+        - timestamp: 2023-07-06T00:00
+          duration: 1
+          operational-carbon: 0.02
+          embodied-carbon: 5
+          energy: 3.5
+          carbon: 5.02
+        - timestamp: 2023-07-06T00:10
+          duration: 1
+          operational-carbon: 0.03
+          embodied-carbon: 4
+          energy: 2.9
+          carbon: 4.03

package/examples/manifests/e-mem.yml

@@ -0,0 +1,21 @@
+name: e-mem
+description:
+tags:
+initialize:
+  plugins:
+    e-mem:
+      method: EMem
+      path: "@grnsft/if-plugins"
+      global-config:
+        energy-per-gb: 0.002
+tree:
+  children:
+    child:
+      pipeline:
+        - e-mem
+      config:
+      inputs:
+        - timestamp: 2023-08-06T00:00
+          duration: 3600
+          memory/utilization: 40
+          memory/capacity: 1

package/examples/{impls/test → manifests}/e-net.yml

@@ -2,11 +2,13 @@ name: sci-e-demo
 description:
 tags:
 initialize:
-  models:
-    - name: e-net
-      model: ENetModel
-      path: '@grnsft/if-models'
-graph:
+  plugins:
+    e-net:
+      method: ENet
+      path: "@grnsft/if-plugins"
+      global-config:
+        energy-per-gb: 0.02
+tree:
   children:
     child:
       pipeline:
@@ -16,6 +18,5 @@ graph:
       inputs:
         - timestamp: 2023-08-06T00:00
           duration: 3600
-          data-in: 1
-          data-out: 2
-          network-energy-coefficient: 0.02
+          network/data-in: 1
+          network/data-out: 2