@lowdefy/operators-js 5.0.0 → 5.2.0

package/dist/operators/client/api.js

@@ -19,12 +19,13 @@ function _api({ params, apiResponses }) {
     }
     const splitKey = params.split('.');
     const [endpoint, ...keyParts] = splitKey;
-    if (endpoint in apiResponses && !apiResponses[endpoint][0].loading) {
+    const entry = apiResponses[endpoint]?.[0];
+    if (entry && (!entry.loading || entry.holdValue)) {
         if (splitKey.length === 1) {
-            return apiResponses[endpoint][0];
+            return entry;
         }
         const key = keyParts.join('.');
-        return get(apiResponses[endpoint][0], key, {
+        return get(entry, key, {
             copy: true,
             default: null
         });

package/dist/operators/client/js.js

@@ -12,17 +12,21 @@
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-*/ function js(operatorContext) {
+*/ import { type } from '@lowdefy/helpers';
+function js(operatorContext) {
     const { jsMap, operators, params } = operatorContext;
-    if (!jsMap[params]) {
-        throw new Error(`_js function not found. The function may not have been built yet. Received hash: ${params}`);
+    const hash = type.isString(params) ? params : params?.fn;
+    const args = type.isObject(params) ? params.args : undefined;
+    if (!jsMap[hash]) {
+        throw new Error(`_js function not found. The function may not have been built yet. Received hash: ${hash}`);
     }
     try {
-        return jsMap[params]({
+        return jsMap[hash]({
             actions: (p)=>operators._actions({
                     ...operatorContext,
                     params: p
                 }),
+            args,
             event: (p)=>operators._event({
                     ...operatorContext,
                     params: p
@@ -57,7 +61,7 @@
                 })
         });
     } catch (error) {
-        throw new Error(`_js function execution error. Function: ${jsMap[params].toString()}`, {
+        throw new Error(`_js function execution error. Function: ${jsMap[hash].toString()}`, {
             cause: error
         });
     }

package/dist/operators/client/js.schema.js

@@ -15,7 +15,27 @@
 */ export default {
     type: 'object',
     params: {
-        type: 'string',
-        description: 'Hash identifier of the pre-built JavaScript function to execute.'
+        oneOf: [
+            {
+                type: 'string',
+                description: 'Hash identifier of the pre-built JavaScript function to execute.'
+            },
+            {
+                type: 'object',
+                required: [
+                    'fn'
+                ],
+                additionalProperties: false,
+                properties: {
+                    fn: {
+                        type: 'string',
+                        description: 'Hash identifier of the pre-built JavaScript function to execute.'
+                    },
+                    args: {
+                        description: 'Pre-resolved values injected into the JavaScript function as `args`.'
+                    }
+                }
+            }
+        ]
     }
 };

package/dist/operators/client/request.js

@@ -19,12 +19,13 @@ function _request({ arrayIndices, params, requests }) {
     }
     const splitKey = params.split('.');
     const [requestId, ...keyParts] = splitKey;
-    if (requestId in requests && !requests[requestId][0].loading) {
+    const entry = requests[requestId]?.[0];
+    if (entry && (!entry.loading || entry.holdValue)) {
         if (splitKey.length === 1) {
-            return serializer.copy(requests[requestId][0].response);
+            return serializer.copy(entry.response);
         }
         const key = keyParts.reduce((acc, value)=>acc === '' ? value : acc.concat('.', value), '');
-        return get(requests[requestId][0].response, applyArrayIndices(arrayIndices, key), {
+        return get(entry.response, applyArrayIndices(arrayIndices, key), {
             copy: true,
             default: null
         });

package/dist/operators/server/js.js

@@ -12,13 +12,17 @@
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-*/ function js(operatorContext) {
+*/ import { type } from '@lowdefy/helpers';
+function js(operatorContext) {
     const { jsMap, operators, location, params } = operatorContext;
-    if (!jsMap[params]) {
-        throw new Error(`_js function not found. The function may not have been built yet. Received hash: ${params}`);
+    const hash = type.isString(params) ? params : params?.fn;
+    const args = type.isObject(params) ? params.args : undefined;
+    if (!jsMap[hash]) {
+        throw new Error(`_js function not found. The function may not have been built yet. Received hash: ${hash}`);
     }
     try {
-        return jsMap[params]({
+        return jsMap[hash]({
+            args,
             payload: (p)=>operators._payload({
                     ...operatorContext,
                     params: p
@@ -45,7 +49,7 @@
                 })
         });
     } catch (error) {
-        throw new Error(`_js function execution error. Function: ${jsMap[params].toString()}`, {
+        throw new Error(`_js function execution error. Function: ${jsMap[hash].toString()}`, {
             cause: error
         });
     }

package/dist/operators/server/js.schema.js

@@ -15,7 +15,27 @@
 */ export default {
     type: 'object',
     params: {
-        type: 'string',
-        description: 'Hash identifier of the pre-built JavaScript function to execute.'
+        oneOf: [
+            {
+                type: 'string',
+                description: 'Hash identifier of the pre-built JavaScript function to execute.'
+            },
+            {
+                type: 'object',
+                required: [
+                    'fn'
+                ],
+                additionalProperties: false,
+                properties: {
+                    fn: {
+                        type: 'string',
+                        description: 'Hash identifier of the pre-built JavaScript function to execute.'
+                    },
+                    args: {
+                        description: 'Pre-resolved values injected into the JavaScript function as `args`.'
+                    }
+                }
+            }
+        ]
     }
 };

package/dist/operators/shared/function.js

@@ -13,7 +13,7 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 */ import { serializer } from '@lowdefy/helpers';
-function _function({ actions, arrayIndices, event, location, operatorPrefix, params, parser }) {
+function _function({ actions, arrayIndices, event, location, operatorPrefix, params, parser, payload, steps }) {
     return (...args)=>{
         const { output, errors } = parser.parse({
             actions,
@@ -22,7 +22,9 @@ function _function({ actions, arrayIndices, event, location, operatorPrefix, par
             event,
             input: serializer.copy(params),
             location,
-            operatorPrefix: `_${operatorPrefix}`
+            operatorPrefix: `_${operatorPrefix}`,
+            payload,
+            steps
         });
         if (errors.length > 0) {
             throw errors[0];

package/dist/operators/shared/string.js

@@ -279,7 +279,38 @@ const meta = {
         prep
     }
 };
+function runFormat({ params, location }) {
+    let template;
+    let lookup;
+    if (type.isArray(params)) {
+        if (!type.isString(params[0])) {
+            throw new Error(`Operator Error: _string.format - first array element must be the template string at ${location}.`);
+        }
+        template = params[0];
+        const values = params.slice(1);
+        lookup = (key)=>values[Number(key)];
+    } else if (type.isObject(params)) {
+        if (!type.isString(params.template)) {
+            throw new Error(`Operator Error: _string.format - "template" must be a string at ${location}.`);
+        }
+        template = params.template;
+        const on = params.on ?? {};
+        lookup = (key)=>on[key];
+    } else {
+        throw new Error(`Operator Error: _string.format accepts an array or object at ${location}.`);
+    }
+    return template.replace(/\{\{|\}\}|\{(\w+)\}/g, (match, key)=>{
+        if (match === '{{') return '{';
+        if (match === '}}') return '}';
+        const v = lookup(key);
+        return type.isNone(v) ? '' : String(v);
+    });
+}
 function _string({ params, location, methodName }) {
+    if (methodName === 'format') return runFormat({
+        params,
+        location
+    });
     return runInstance({
         location,
         meta,

package/dist/operators/shared/string.schema.js

@@ -15,6 +15,6 @@
 */ export default {
     type: 'object',
     params: {
-        description: 'String method params. Accepts array positional args or object with named args depending on method.'
+        description: 'String method params. Accepts array positional args or object with named args depending on method. The "format" method takes a template string with {0}/{1} positional placeholders (array form) or {name} placeholders (object form: { template, on }).'
     }
 };

package/dist/operators/shared/user.js

@@ -12,8 +12,70 @@
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-*/ import { getFromObject } from '@lowdefy/operators';
-function _user({ arrayIndices, location, params, user }) {
+*/ import { type } from '@lowdefy/helpers';
+import { getFromObject } from '@lowdefy/operators';
+const roleMethods = [
+    'hasRole',
+    'hasSomeRoles',
+    'hasAllRoles'
+];
+function getUserRoles({ user, methodName }) {
+    const roles = user?.roles;
+    if (type.isNone(roles)) return [];
+    if (!type.isArray(roles)) {
+        throw new Error(`_user.${methodName} expects "user.roles" to be an array of strings. Received ${JSON.stringify(roles)}.`);
+    }
+    return roles;
+}
+function validateRoleString({ params, methodName }) {
+    if (!type.isString(params)) {
+        throw new Error(`_user.${methodName} accepts a string. Received ${JSON.stringify(params)}.`);
+    }
+    return params;
+}
+function validateRoleArray({ params, methodName }) {
+    if (!type.isArray(params) || !params.every((role)=>type.isString(role))) {
+        throw new Error(`_user.${methodName} accepts an array of strings. Received ${JSON.stringify(params)}.`);
+    }
+    return params;
+}
+function _user({ arrayIndices, location, methodName, params, user }) {
+    if (methodName === 'hasRole') {
+        const role = validateRoleString({
+            params,
+            methodName
+        });
+        const userRoles = getUserRoles({
+            user,
+            methodName
+        });
+        return userRoles.includes(role);
+    }
+    if (methodName === 'hasSomeRoles') {
+        const required = validateRoleArray({
+            params,
+            methodName
+        });
+        const userRoles = getUserRoles({
+            user,
+            methodName
+        });
+        return required.some((role)=>userRoles.includes(role));
+    }
+    if (methodName === 'hasAllRoles') {
+        const required = validateRoleArray({
+            params,
+            methodName
+        });
+        const userRoles = getUserRoles({
+            user,
+            methodName
+        });
+        return required.every((role)=>userRoles.includes(role));
+    }
+    if (!type.isUndefined(methodName)) {
+        throw new Error(`_user.${methodName} is not supported, use one of the following: ${roleMethods.join(', ')}.`);
+    }
     return getFromObject({
         arrayIndices,
         location,

package/dist/operators/shared/user.schema.js

@@ -18,7 +18,7 @@
         oneOf: [
             {
                 type: 'string',
-                description: 'Dot-notation path to value in user object.'
+                description: 'Dot-notation path to value in user object, or a role name when used with a role method.'
             },
             {
                 type: 'integer',
@@ -31,6 +31,13 @@
                 ],
                 description: 'Return all user data.'
             },
+            {
+                type: 'array',
+                items: {
+                    type: 'string'
+                },
+                description: 'Array of role names when used with a role method.'
+            },
             {
                 type: 'object',
                 properties: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/operators-js",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -43,12 +43,12 @@
     "dist/*"
   ],
   "dependencies": {
-    "@lowdefy/helpers": "5.0.0",
-    "@lowdefy/operators": "5.0.0"
+    "@lowdefy/helpers": "5.2.0",
+    "@lowdefy/operators": "5.2.0"
   },
   "devDependencies": {
     "@jest/globals": "28.1.3",
-    "@lowdefy/node-utils": "5.0.0",
+    "@lowdefy/node-utils": "5.2.0",
     "@swc/cli": "0.8.0",
     "@swc/core": "1.15.18",
     "@swc/jest": "0.2.39",