@nordcraft/search 1.0.45 → 1.0.46

package/dist/util/contextlessEvaluateFormula.js

@@ -0,0 +1,77 @@
+import {} from '@nordcraft/core/dist/formula/formula';
+/**
+ * Static evaluation of a formula.
+ *
+ * Can be used by issues to determine if a formula or sub-formula can be reduced to a static value.
+ * When sophisticated enough, it can be used during compile-time to reduce all static subgraphs of a formula to static values, greatly reducing payload and improving runtime performance.
+ *
+ * @returns {
+ *  isStatic: boolean; // Whether the formula is static (i.e., does not depend on any variables, context AND only use pure formulas (no Random, Date, etc.))
+ *  result: unknown; // The evaluated value of the formula
+ * }
+ *
+ * TODO: Make this function more capable of evaluating pure core formulas.
+ * TODO: Memoize the results (using path or a fast hash) to avoid re-evaluating any similar sub-graphs multiple times.
+ * TODO: Add a complex test-suite to ensure it works and develops as expected.
+ */
+export const contextlessEvaluateFormula = (formula) => {
+    // Very basic implementation, just to get started.
+    switch (formula.type) {
+        case 'value': {
+            return {
+                isStatic: true,
+                result: formula.value,
+            };
+        }
+        case 'array': {
+            const results = formula.arguments.map((arg) => contextlessEvaluateFormula(arg.formula));
+            return {
+                isStatic: results.every((res) => res.isStatic),
+                result: results.map((res) => res.result),
+            };
+        }
+        case 'record': {
+            const entries = Object.entries(formula.entries).map(([key, arg]) => [key, contextlessEvaluateFormula(arg.formula)]);
+            const results = entries.map(([, res]) => res);
+            return {
+                isStatic: results.every((res) => res.isStatic),
+                result: Object.fromEntries(entries.map(([key, res]) => [key, res.result])),
+            };
+        }
+        // Static if:
+        // - ALL conditions are static AND truthy
+        // - ANY condition is static and falsy
+        // - EMPTY argument list is always true
+        case 'and': {
+            const results = formula.arguments.map((arg) => contextlessEvaluateFormula(arg.formula));
+            const alwaysTrue = results.length === 0 ||
+                results.every((res) => res.isStatic && Boolean(res.result) === true);
+            const alwaysFalsy = results.some((res) => res.isStatic && Boolean(res.result) === false);
+            return {
+                isStatic: alwaysTrue || alwaysFalsy,
+                result: alwaysTrue ? true : alwaysFalsy ? false : undefined,
+            };
+        }
+        // Static if:
+        // - ANY condition is static AND truthy
+        // - ALL conditions are static AND falsy
+        // - EMPTY argument list is always false
+        case 'or': {
+            const results = formula.arguments.map((arg) => contextlessEvaluateFormula(arg.formula));
+            const alwaysFalsy = results.length === 0 ||
+                results.every((res) => res.isStatic && Boolean(res.result) === false);
+            const alwaysTrue = results.some((res) => res.isStatic && Boolean(res.result) === true);
+            return {
+                isStatic: alwaysTrue || alwaysFalsy,
+                result: alwaysFalsy ? false : alwaysTrue ? true : undefined,
+            };
+        }
+        default:
+            // For now, we assume that any other formula is not static.
+            return {
+                isStatic: false,
+                result: undefined,
+            };
+    }
+};
+//# sourceMappingURL=contextlessEvaluateFormula.js.map

package/dist/util/contextlessEvaluateFormula.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextlessEvaluateFormula.js","sourceRoot":"","sources":["../../src/util/contextlessEvaluateFormula.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,MAAM,sCAAsC,CAAA;AAEnE;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,OAAgB,EAIhB,EAAE;IACF,kDAAkD;IAClD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO;gBACL,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,OAAO,CAAC,KAAK;aACtB,CAAA;QACH,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5C,0BAA0B,CAAC,GAAG,CAAC,OAAO,CAAC,CACxC,CAAA;YAED,OAAO;gBACL,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC9C,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC;aACzC,CAAA;QACH,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CACjD,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,0BAA0B,CAAC,GAAG,CAAC,OAAO,CAAC,CAAU,CACxE,CAAA;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAA;YAE7C,OAAO;gBACL,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC9C,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAC/C;aACF,CAAA;QACH,CAAC;QAED,aAAa;QACb,yCAAyC;QACzC,sCAAsC;QACtC,uCAAuC;QACvC,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5C,0BAA0B,CAAC,GAAG,CAAC,OAAO,CAAC,CACxC,CAAA;YAED,MAAM,UAAU,GACd,OAAO,CAAC,MAAM,KAAK,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,CAAA;YACtE,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAC9B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,CACvD,CAAA;YAED,OAAO;gBACL,QAAQ,EAAE,UAAU,IAAI,WAAW;gBACnC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;aAC5D,CAAA;QACH,CAAC;QAED,aAAa;QACb,uCAAuC;QACvC,wCAAwC;QACxC,wCAAwC;QACxC,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5C,0BAA0B,CAAC,GAAG,CAAC,OAAO,CAAC,CACxC,CAAA;YAED,MAAM,WAAW,GACf,OAAO,CAAC,MAAM,KAAK,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,CAAA;YACvE,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAC7B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,CACtD,CAAA;YAED,OAAO;gBACL,QAAQ,EAAE,UAAU,IAAI,WAAW;gBACnC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;aAC5D,CAAA;QACH,CAAC;QAED;YACE,2DAA2D;YAC3D,OAAO;gBACL,QAAQ,EAAE,KAAK;gBACf,MAAM,EAAE,SAAS;aAClB,CAAA;IACL,CAAC;AACH,CAAC,CAAA"}

package/dist/util/contextlessEvaluateFormula.test.js

@@ -0,0 +1,152 @@
+import { describe, expect, test } from 'bun:test';
+import { contextlessEvaluateFormula } from './contextlessEvaluateFormula';
+describe('contextlessEvaluateFormula', () => {
+    test('should return `true` when the formula is a simple value formula', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'value',
+            value: true,
+        })).toEqual({
+            isStatic: true,
+            result: true,
+        });
+    });
+    test('should not return a result and have `isStatic: false` when the formula uses a non-pure formula ("randomNumber", "Now")', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'apply',
+            name: 'randomNumber',
+            arguments: [],
+        })).toEqual({
+            isStatic: false,
+            result: undefined,
+        });
+        expect(contextlessEvaluateFormula({
+            type: 'apply',
+            name: 'now',
+            arguments: [],
+        })).toEqual({
+            isStatic: false,
+            result: undefined,
+        });
+    });
+    test('should not return a result and have `isStatic: false` when the formula depends on a variable', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'path',
+            path: ['Variables', 'myVariable'],
+        })).toEqual({
+            isStatic: false,
+            result: undefined,
+        });
+    });
+    test('should return a result and static for an array formula where all args are array or value types', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'array',
+            arguments: [
+                { formula: { type: 'value', value: 1 } },
+                {
+                    formula: {
+                        type: 'array',
+                        arguments: [{ formula: { type: 'value', value: 2 } }],
+                    },
+                },
+            ],
+        })).toEqual({
+            isStatic: true,
+            result: [1, [2]],
+        });
+    });
+    test('should return `isStatic: false` for an array formula with a non-static argument', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'array',
+            arguments: [
+                { formula: { type: 'value', value: 1 } },
+                { formula: { type: 'apply', name: 'randomNumber', arguments: [] } },
+            ],
+        })).toEqual({
+            isStatic: false,
+            result: [
+                1,
+                undefined, // The second argument was not static
+            ],
+        });
+    });
+    test('should be static true for `And` formulas with no arguments', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'and',
+            arguments: [],
+        })).toEqual({
+            isStatic: true,
+            result: true,
+        });
+    });
+    test('should be static false for `Or` formulas with no arguments', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'or',
+            arguments: [],
+        })).toEqual({
+            isStatic: true,
+            result: false,
+        });
+    });
+    test('should be static true for `And` formulas with all static truthy arguments', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'and',
+            arguments: [
+                { formula: { type: 'value', value: true } },
+                { formula: { type: 'value', value: true } },
+            ],
+        })).toEqual({
+            isStatic: true,
+            result: true,
+        });
+    });
+    test('should not be static for `And` where any dynamic value exist', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'and',
+            arguments: [
+                { formula: { type: 'value', value: true } },
+                { formula: { type: 'apply', name: 'randomNumber', arguments: [] } },
+            ],
+        })).toEqual({
+            isStatic: false,
+            result: undefined,
+        });
+    });
+    test('should be static false for `And` when any argument is static false, even when dynamic arguments exist', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'and',
+            arguments: [
+                { formula: { type: 'value', value: true } },
+                { formula: { type: 'path', path: ['Variables', 'myVariable'] } },
+                { formula: { type: 'value', value: false } },
+            ],
+        })).toEqual({
+            isStatic: true,
+            result: false,
+        });
+    });
+    test('should not be static for `Or` when any argument is dynamic and all static are falsy', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'or',
+            arguments: [
+                { formula: { type: 'value', value: false } },
+                { formula: { type: 'apply', name: 'randomNumber', arguments: [] } },
+            ],
+        })).toEqual({
+            isStatic: false,
+            result: undefined,
+        });
+    });
+    test('should be static true for `Or` when any argument is static true, even when dynamic arguments exist', () => {
+        expect(contextlessEvaluateFormula({
+            type: 'or',
+            arguments: [
+                { formula: { type: 'value', value: true } },
+                { formula: { type: 'apply', name: 'randomNumber', arguments: [] } },
+            ],
+        })).toEqual({
+            isStatic: true,
+            result: true,
+        });
+    });
+});
+//# sourceMappingURL=contextlessEvaluateFormula.test.js.map

package/dist/util/contextlessEvaluateFormula.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contextlessEvaluateFormula.test.js","sourceRoot":"","sources":["../../src/util/contextlessEvaluateFormula.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAEzE,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,IAAI;SACZ,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,wHAAwH,EAAE,GAAG,EAAE;QAClI,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,EAAE;SACd,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;QAEF,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,EAAE;SACd,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,8FAA8F,EAAE,GAAG,EAAE;QACxG,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;SAClC,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,gGAAgG,EAAE,GAAG,EAAE;QAC1G,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,OAAO;YACb,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gBACxC;oBACE,OAAO,EAAE;wBACP,IAAI,EAAE,OAAO;wBACb,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;qBACtD;iBACF;aACF;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;SACjB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,iFAAiF,EAAE,GAAG,EAAE;QAC3F,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,OAAO;YACb,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gBACxC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;aACpE;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE;gBACN,CAAC;gBACD,SAAS,EAAE,qCAAqC;aACjD;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACtE,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,KAAK;YACX,SAAS,EAAE,EAAE;SACd,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACtE,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,IAAI;YACV,SAAS,EAAE,EAAE;SACd,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACrF,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,KAAK;YACX,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAC3C,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;aAC5C;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACxE,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,KAAK;YACX,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAC3C,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;aACpE;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uGAAuG,EAAE,GAAG,EAAE;QACjH,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,KAAK;YACX,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAC3C,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE,EAAE;gBAChE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;aAC7C;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,qFAAqF,EAAE,GAAG,EAAE;QAC/F,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,IAAI;YACV,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBAC5C,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;aACpE;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,SAAS;SAClB,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,oGAAoG,EAAE,GAAG,EAAE;QAC9G,MAAM,CACJ,0BAA0B,CAAC;YACzB,IAAI,EAAE,IAAI;YACV,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;gBAC3C,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;aACpE;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/util/removeUnused.fix.js

@@ -1,3 +1,20 @@
-import { omit } from '@nordcraft/core/dist/utils/collections';
+import { get, omit, set } from '@nordcraft/core/dist/utils/collections';
 export const removeFromPathFix = ({ path, files }) => omit(files, path);
+/**
+ * Same as removeFromPathFix, but also removes the node from its parent's children.
+ */
+export const removeNodeFromPathFix = (data) => {
+    if (data.nodeType !== 'component-node') {
+        throw new Error('removeNodeFromPathFix can only be used on component nodes');
+    }
+    const componentNodesPath = data.path.slice(0, -1).map(String);
+    const filesWithoutNode = removeFromPathFix(data);
+    const nodes = get(filesWithoutNode, componentNodesPath);
+    for (const key in nodes) {
+        if (nodes[key].children?.includes(data.path[data.path.length - 1])) {
+            nodes[key].children = nodes[key].children.filter((p) => p !== data.path[data.path.length - 1]);
+        }
+    }
+    return set(filesWithoutNode, componentNodesPath, nodes);
+};
 //# sourceMappingURL=removeUnused.fix.js.map

package/dist/util/removeUnused.fix.js.map

@@ -1 +1 @@
-{"version":3,"file":"removeUnused.fix.js","sourceRoot":"","sources":["../../src/util/removeUnused.fix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,wCAAwC,CAAA;AAG7D,MAAM,CAAC,MAAM,iBAAiB,GAA0B,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1E,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA"}
+{"version":3,"file":"removeUnused.fix.js","sourceRoot":"","sources":["../../src/util/removeUnused.fix.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,wCAAwC,CAAA;AAGvE,MAAM,CAAC,MAAM,iBAAiB,GAA0B,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1E,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;AAEnB;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA0B,CAAC,IAAI,EAAE,EAAE;IACnE,IAAI,IAAI,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;IAC9E,CAAC;IAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAC7D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;IAChD,MAAM,KAAK,GAAG,GAAG,CAAC,gBAAgB,EAAE,kBAAkB,CAGrD,CAAA;IACD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IACE,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAW,CAAC,EACxE,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAC7C,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAA;AACzD,CAAC,CAAA"}

package/package.json

@@ -5,7 +5,7 @@
 "license": "Apache-2.0",
 "homepage": "https://github.com/nordcraftengine/nordcraft",
 "dependencies": {
-"@nordcraft/ssr": "1.0.45",
+"@nordcraft/ssr": "1.0.46",
 "jsondiffpatch": "0.7.3",
 "postcss": "8.5.6"
 },
@@ -19,5 +19,5 @@
 "test:watch:only": "bun test --watch --only"
 },
 "files": ["dist", "src"],
-"version": "1.0.45"
+"version": "1.0.46"
 }

package/src/problems.worker.ts

@@ -37,6 +37,7 @@ import { unknownFormulaRule } from './rules/formulas/unknownFormulaRule'
 import { unknownProjectFormulaRule } from './rules/formulas/unknownProjectFormulaRule'
 import { unknownRepeatIndexFormulaRule } from './rules/formulas/unknownRepeatIndexFormulaRule'
 import { unknownRepeatItemFormulaRule } from './rules/formulas/unknownRepeatItemFormulaRule'
+import { noStaticNodeCondition } from './rules/logic/noStaticNodeCondition'
 import { noUnnecessaryConditionFalsy } from './rules/logic/noUnnecessaryConditionFalsy'
 import { noUnnecessaryConditionTruthy } from './rules/logic/noUnnecessaryConditionTruthy'
 import { noReferenceNodeRule } from './rules/noReferenceNodeRule'
@@ -162,6 +163,7 @@ const RULES = [
   noReferenceProjectActionRule,
   noReferenceProjectFormulaRule,
   noReferenceVariableRule,
+  noStaticNodeCondition,
   noUnnecessaryConditionFalsy,
   noUnnecessaryConditionTruthy,
   requireExtensionRule,
@@ -196,21 +198,25 @@ const RULES = [
 ]
 
 interface FindProblemsArgs {
+  id: string
   files: ProjectFiles
   options?: Options
 }
 
 interface FixProblemsArgs {
+  id: string
   files: ProjectFiles
   options?: Options
   fixRule: Code
   fixType: FixType
-  id: string
 }
 
 type Message = FindProblemsArgs | FixProblemsArgs
 
-type FindProblemsResponse = Result[]
+interface FindProblemsResponse {
+  id: string
+  results: Result[]
+}
 
 interface FixProblemsResponse {
   id: string
@@ -225,6 +231,11 @@ const respond = (data: Response) => postMessage(data)
 
 const findProblems = (data: FindProblemsArgs) => {
   const { files, options = {} } = data
+  const idRespond = (results: Result[]) =>
+    respond({
+      id: data.id,
+      results,
+    })
   const rules = RULES.filter(
     (rule) =>
       (!options.categories || options.categories.includes(rule.category)) &&
@@ -250,7 +261,7 @@ const findProblems = (data: FindProblemsArgs) => {
       case 'per-file': {
         if (fileType !== problem.path[0] || fileName !== problem.path[1]) {
           if (batch.length > 0) {
-            respond(batch)
+            idRespond(batch)
           }
           batch = []
           fileType = problem.path[0]
@@ -264,7 +275,7 @@ const findProblems = (data: FindProblemsArgs) => {
       default: {
         batch.push(problem)
         if (batch.length >= (options.batchSize ?? 1)) {
-          respond(batch)
+          idRespond(batch)
           batch = []
         }
         break
@@ -273,7 +284,7 @@ const findProblems = (data: FindProblemsArgs) => {
   }
 
   // Send the remaining results
-  respond(batch)
+  idRespond(batch)
 }
 
 const fixProblems = (data: FixProblemsArgs) => {

package/src/rules/logic/noStaticNodeCondition.test.ts

@@ -0,0 +1,290 @@
+import type { ProjectFiles } from '@nordcraft/ssr/dist/ssr.types'
+import { describe, expect, test } from 'bun:test'
+import { fixProject } from '../../fixProject'
+import { searchProject } from '../../searchProject'
+import { noStaticNodeCondition } from './noStaticNodeCondition'
+
+describe('noStaticNodeCondition', () => {
+  test('should report node condition that is always truthy', () => {
+    const problems = Array.from(
+      searchProject({
+        files: {
+          components: {
+            test: {
+              name: 'test',
+              nodes: {
+                root: {
+                  type: 'element',
+                  attrs: {},
+                  classes: {},
+                  events: {},
+                  tag: 'div',
+                  children: [],
+                  style: {},
+                  condition: {
+                    type: 'value',
+                    value: true,
+                  },
+                },
+              },
+              formulas: {},
+              apis: {},
+              attributes: {},
+              variables: {},
+            },
+          },
+        },
+        rules: [noStaticNodeCondition],
+      }),
+    )
+
+    expect(problems).toHaveLength(1)
+    expect(problems[0].code).toBe('no-static-node-condition')
+    expect(problems[0].details).toEqual({
+      result: true,
+    })
+    expect(problems[0].fixes).toEqual(['remove-condition'])
+    expect(problems[0].path).toEqual([
+      'components',
+      'test',
+      'nodes',
+      'root',
+      'condition',
+    ])
+  })
+
+  test('should report node condition that is always falsy', () => {
+    const problems = Array.from(
+      searchProject({
+        files: {
+          components: {
+            test: {
+              name: 'test',
+              nodes: {
+                root: {
+                  type: 'element',
+                  attrs: {},
+                  classes: {},
+                  events: {},
+                  tag: 'div',
+                  children: [],
+                  style: {},
+                  condition: {
+                    type: 'value',
+                    value: false,
+                  },
+                },
+              },
+              formulas: {},
+              apis: {},
+              attributes: {},
+              variables: {},
+            },
+          },
+        },
+        rules: [noStaticNodeCondition],
+      }),
+    )
+
+    expect(problems).toHaveLength(1)
+    expect(problems[0].code).toBe('no-static-node-condition')
+    expect(problems[0].details).toEqual({
+      result: false,
+    })
+  })
+
+  test('should not report node condition that is dynamic', () => {
+    const problems = Array.from(
+      searchProject({
+        files: {
+          components: {
+            test: {
+              name: 'test',
+              nodes: {
+                root: {
+                  type: 'element',
+                  attrs: {},
+                  classes: {},
+                  events: {},
+                  tag: 'div',
+                  children: [],
+                  style: {},
+                  condition: {
+                    type: 'apply',
+                    name: 'randomNumber',
+                    arguments: [],
+                  },
+                },
+              },
+              formulas: {},
+              apis: {},
+              attributes: {},
+              variables: {},
+            },
+          },
+        },
+        rules: [noStaticNodeCondition],
+      }),
+    )
+
+    expect(problems).toHaveLength(0)
+  })
+
+  test('should fix static truthy condition by removing the condition', () => {
+    const files: ProjectFiles = {
+      components: {
+        test: {
+          name: 'test',
+          nodes: {
+            root: {
+              type: 'element',
+              attrs: {},
+              classes: {},
+              events: {},
+              tag: 'div',
+              children: [],
+              style: {},
+              condition: {
+                type: 'value',
+                value: true,
+              },
+            },
+          },
+          formulas: {},
+          apis: {},
+          attributes: {},
+          variables: {},
+        },
+      },
+    }
+    const fixedFiles = fixProject({
+      files,
+      rule: noStaticNodeCondition,
+      fixType: 'remove-condition',
+    })
+    expect(fixedFiles).toMatchInlineSnapshot(`
+      {
+        "components": {
+          "test": {
+            "apis": {},
+            "attributes": {},
+            "formulas": {},
+            "name": "test",
+            "nodes": {
+              "root": {
+                "attrs": {},
+                "children": [],
+                "classes": {},
+                "events": {},
+                "style": {},
+                "tag": "div",
+                "type": "element",
+              },
+            },
+            "variables": {},
+          },
+        },
+      }
+    `)
+  })
+
+  test("should fix static falsy condition by removing the node and any parents' references to it", () => {
+    const files: ProjectFiles = {
+      components: {
+        test: {
+          name: 'test',
+          nodes: {
+            root: {
+              type: 'element',
+              attrs: {},
+              classes: {},
+              events: {},
+              tag: 'div',
+              children: ['alwaysHiddenElement', 'sometimesVisibleElement'],
+              style: {},
+            },
+            alwaysHiddenElement: {
+              type: 'element',
+              attrs: {},
+              classes: {},
+              events: {},
+              tag: 'div',
+              children: [],
+              style: {},
+              condition: {
+                type: 'value',
+                value: false,
+              },
+            },
+            sometimesVisibleElement: {
+              type: 'element',
+              attrs: {},
+              classes: {},
+              events: {},
+              tag: 'div',
+              children: [],
+              style: {},
+              condition: {
+                type: 'path',
+                path: ['Variables', 'maybe'],
+              },
+            },
+          },
+          formulas: {},
+          apis: {},
+          attributes: {},
+          variables: {},
+        },
+      },
+    }
+
+    const fixedFiles = fixProject({
+      files,
+      rule: noStaticNodeCondition,
+      fixType: 'remove-node',
+    })
+
+    expect(fixedFiles).toMatchInlineSnapshot(`
+      {
+        "components": {
+          "test": {
+            "apis": {},
+            "attributes": {},
+            "formulas": {},
+            "name": "test",
+            "nodes": {
+              "root": {
+                "attrs": {},
+                "children": [
+                  "sometimesVisibleElement",
+                ],
+                "classes": {},
+                "events": {},
+                "style": {},
+                "tag": "div",
+                "type": "element",
+              },
+              "sometimesVisibleElement": {
+                "attrs": {},
+                "children": [],
+                "classes": {},
+                "condition": {
+                  "path": [
+                    "Variables",
+                    "maybe",
+                  ],
+                  "type": "path",
+                },
+                "events": {},
+                "style": {},
+                "tag": "div",
+                "type": "element",
+              },
+            },
+            "variables": {},
+          },
+        },
+      }
+    `)
+  })
+})