Merge branch 'bake' into node-lib

src/node/apiUtils.mjs

@@ -1,121 +1,11 @@
 /**
- * Wrap operations for consumption in Node.
+ * Utility functions for the node environment
  *
  * @author d98762625 [d98762625@gmail.com]
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
 
-import SyncDish from "./SyncDish";
-import OperationConfig from "./config/OperationConfig.json";
-
-/**
- * Extract default arg value from operation argument
- * @param {Object} arg - an arg from an operation
- */
-function extractArg(arg) {
-    if (arg.type === "option") {
-        // pick default option if not already chosen
-        return typeof arg.value === "string" ? arg.value : arg.value[0];
-    }
-
-    if (arg.type === "editableOption") {
-        return typeof arg.value === "string" ? arg.value : arg.value[0].value;
-    }
-
-    if (arg.type === "toggleString") {
-        // ensure string and option exist when user hasn't defined
-        arg.string = arg.string || "";
-        arg.option = arg.option || arg.toggleValues[0];
-        return arg;
-    }
-
-    return arg.value;
-}
-
-/**
- * transformArgs
- *
- * Take the default args array and update with any user-defined
- * operation arguments. Allows user to define arguments in object style,
- * with accommodating name matching. Using named args in the API is more
- * clear to the user.
- *
- * Argument name matching is case and space insensitive
- * @private
- * @param {Object[]} originalArgs
- * @param {Object} newArgs
- */
-function transformArgs(originalArgs, newArgs) {
-    const allArgs = Object.assign([], originalArgs);
-
-    if (newArgs) {
-        Object.keys(newArgs).map((key) => {
-            const index = allArgs.findIndex((arg) => {
-                return arg.name.toLowerCase().replace(/ /g, "") ===
-                    key.toLowerCase().replace(/ /g, "");
-            });
-
-            if (index > -1) {
-                const argument = allArgs[index];
-                if (["toggleString"].indexOf(argument.type) > -1) {
-                    argument.string = newArgs[key].string;
-                    argument.option = newArgs[key].option;
-                } else if (argument.type === "editableOption") {
-                    // takes key: "option", key: {name, val: "string"}, key: {name, val: [...]}
-                    argument.value = typeof newArgs[key] === "string" ? newArgs[key]: newArgs[key].value;
-                } else {
-                    argument.value = newArgs[key];
-                }
-            }
-        });
-    }
-    return allArgs.map(extractArg);
-}
-
-/**
- * Wrap an operation to be consumed by node API.
- * new Operation().run() becomes operation()
- * Perform type conversion on input
- * @private
- * @param {Operation} Operation
- * @returns {Function} The operation's run function, wrapped in
- * some type conversion logic
- */
-export function wrap(OpClass) {
-    /**
-     * Wrapped operation run function
-     * @param {*} input
-     * @param {Object[]} args
-     * @returns {SyncDish} operation's output, on a Dish.
-     * @throws {OperationError} if the operation throws one.
-     */
-    const wrapped = (input, args=null) => {
-        const operation = new OpClass();
-
-        let dish;
-        if (input instanceof SyncDish) {
-            dish = input;
-        } else {
-            dish = new SyncDish();
-            const type = SyncDish.typeEnum(input.constructor.name);
-            dish.set(input, type);
-        }
-        args = transformArgs(operation.args, args);
-        const transformedInput = dish.get(operation.inputType);
-        const result = operation.run(transformedInput, args);
-        return new SyncDish({
-            value: result,
-            type: operation.outputType
-        });
-    };
-
-    // used in chef.help
-    wrapped.opName = OpClass.name;
-    return wrapped;
-}
-
-
 /**
  * SomeName => someName
  * @param {String} name - string to be altered
@@ -134,32 +24,10 @@ export function decapitalise(name) {
     return `${name.charAt(0).toLowerCase()}${name.substr(1)}`;
 }
 
-
 /**
- * @namespace Api
- * @param {String} searchTerm - the name of the operation to get help for.
- * Case and whitespace are ignored in search.
- * @returns {Object} Describe function matching searchTerm.
+ * Remove spaces, make lower case.
+ * @param str
  */
-export function help(searchTerm) {
-    let sanitised = false;
-    if (typeof searchTerm === "string") {
-        sanitised = searchTerm;
-    } else if (typeof searchTerm === "function") {
-        sanitised = searchTerm.opName;
-    }
-
-    if (!sanitised) {
-        return null;
-    }
-
-    const key = Object.keys(OperationConfig)
-        .find(o => o.replace(/ /g, "").toLowerCase() === sanitised.replace(/ /g, "").toLowerCase());
-    if (key) {
-        const result = OperationConfig[key];
-        result.name = key;
-        return result;
-    }
-    return null;
+export function sanitise(str) {
+    return str.replace(/ /g, "").toLowerCase();
 }
-