@jesscss/core 2.0.0-alpha.4 → 2.0.0-alpha.6

package/src/tree/call.ts

@@ -0,0 +1,593 @@
+import { CALLER, CANONICAL, Node, defineType, F_VISIBLE, F_NON_STATIC, F_MAY_ASYNC, type OptionalLocation, type TreeContext } from './node.js';
+import { type Context } from '../context.js';
+import { isNode } from './util/is-node.js';
+import { N } from './node-type.js';
+import { cast } from './util/cast.js';
+import { callWithContext } from '../define-function.js';
+import { type PrintOptions, getPrintOptions } from './util/print.js';
+import { Paren } from './paren.js';
+import { isThenable } from '@jesscss/awaitable-pipe';
+import { evalMixinDirect, type MixinEntry, type Rules } from './rules.js';
+import { Any } from './any.js';
+import { List, list } from './list.js';
+import { getParent, mergeDependencies, setDependency, setParent, setSourceParent } from './util/field-helpers.js';
+import { finalizeInvocationOutputRules } from './util/mixin-instance-primitives.js';
+import { addParentEdge } from './util/cursor.js';
+
+export type CallValue = {
+  /**
+   * Can be an identifier or something like a mixin or variable lookup
+   *   e.g. $|#mixin|.class() is -> [Call name: [Ref (#mixin.class)], args: []]
+   */
+  name: string | Node;
+  args?: List<Node>;
+  /**
+   * Optional content node, used for passing blocks to mixins/functions.
+   * This is how Jess represents "call with content block" forms like:
+   *   $ > foo(): @{ ... }
+   * or:
+   *   $ > foo(): @($x) { ... }
+   */
+  contentNode?: Node;
+};
+
+export type CallOptions = {
+  /**
+   * Legacy Less feature -- if a ruleset is returned,
+   * all the properties can be marked as important.
+   */
+  markImportant?: boolean;
+  silentFail?: boolean;
+  /** Parser-provided hint for modern color-call syntax (space/slash form). */
+  modernSyntax?: boolean;
+};
+
+/**
+ * This is an exported type that allows extra properties
+ * and specifies the shape of `this` for a function call.
+ */
+export type ExtendedFn<T extends any[] = any[], R = any> = ((this: Context, ...args: T) => R) & {
+  /**
+   * Allow for optional calling, which means an optional
+   * reference to a function will output a stringified
+   * function representation if there's an evaluation error.
+   *
+   * This is done for Less, which sets this for functions
+   * that have a CSS equivalent.
+   */
+  allowOptional?: boolean;
+  evalArgs?: boolean;
+};
+
+/**
+ * @note In Less, the ref for something like `rgb`
+ * is not a string, but is an (optional) variable reference.
+ */
+export type CallChildData = { name: string | Node; args: List<Node> | undefined; contentNode: Node | undefined };
+
+export interface Call {
+  type: 'Call';
+  shortType: 'call';
+}
+
+export class Call extends Node<CallValue, CallOptions, CallChildData> {
+  static override childKeys = ['name', 'args', 'contentNode'] as const;
+
+  name!: string | Node;
+  args: List<Node> | undefined;
+  contentNode: Node | undefined;
+
+  override clone(deep?: boolean, cloneFn?: (n: Node) => Node, ctx?: Context): this {
+    const name = this.get('name', ctx);
+    const args = this.get('args', ctx);
+    const contentNode = this.get('contentNode', ctx);
+    const cloneData: CallValue = {
+      name: deep && name instanceof Node ? name.clone(deep, cloneFn, ctx) : name,
+      args: deep && args instanceof Node ? args.clone(deep, cloneFn, ctx) : args,
+      contentNode: deep && contentNode instanceof Node ? contentNode.clone(deep, cloneFn, ctx) : contentNode
+    };
+
+    let priorChildParents: Array<[Node, Node | undefined]> | undefined;
+    if (!deep) {
+      priorChildParents = [];
+      if (cloneData.name instanceof Node) {
+        priorChildParents.push([cloneData.name, cloneData.name.parent]);
+      }
+      if (cloneData.args instanceof Node) {
+        priorChildParents.push([cloneData.args, cloneData.args.parent]);
+      }
+      if (cloneData.contentNode instanceof Node) {
+        priorChildParents.push([cloneData.contentNode, cloneData.contentNode.parent]);
+      }
+    }
+
+    const options = this._meta?.options;
+    const newNode: this = Reflect.construct(this.constructor, [
+      cloneData,
+      options ? { ...options } : undefined,
+      this.location,
+      this.treeContext
+    ]);
+
+    if (priorChildParents) {
+      for (const [child, priorParent] of priorChildParents) {
+        if (ctx) {
+          setParent(child, newNode, ctx);
+        }
+        Reflect.set(child, 'parent', priorParent);
+      }
+    }
+
+    newNode.inherit(this);
+    return newNode;
+  }
+
+  constructor(value: CallValue, options?: CallOptions, location?: OptionalLocation, treeContext?: TreeContext) {
+    super(value, options, location, treeContext);
+    this.name = value.name;
+    this.args = value.args;
+    this.contentNode = value.contentNode;
+    if (this.name instanceof Node) {
+      this.adopt(this.name);
+    }
+    if (this.args instanceof Node) {
+      this.adopt(this.args);
+    }
+    if (this.contentNode instanceof Node) {
+      this.adopt(this.contentNode);
+    }
+    this.requiredSemi = true;
+    // Function calls are always non-static and may be async
+    this.addFlags(F_VISIBLE, F_NON_STATIC, F_MAY_ASYNC);
+  }
+
+  private _serializeCallArg(node: Node, options: PrintOptions): string {
+    const context = options.context;
+    if (isNode(node, N.Sequence)) {
+      const children = node.get('value', context);
+      const isQuotedConcatSequence = (
+        children.some(child => isNode(child, N.Quoted))
+        && children.every(child => isNode(child, N.Quoted | N.Any | N.Interpolated))
+      );
+      return children
+        .map(child => this._serializeCallArg(child, options).replace(/^[ \t\r\f]+|[ \t\r\f]+$/g, ''))
+        .join(isQuotedConcatSequence ? '' : ' ');
+    }
+    if (isNode(node, N.List)) {
+      const sep = node.options?.sep ?? ',';
+      const joiner = sep === '/' ? ' / ' : `${sep} `;
+      return node.get('value', context)
+        .map(child => this._serializeCallArg(child, options).replace(/^[ \t\r\f]+|[ \t\r\f]+$/g, ''))
+        .join(joiner);
+    }
+    return options.writer!.capture(() => node.toString(options))
+      .replace(/^[ \t\r\f]+|[ \t\r\f]+$/g, '');
+  }
+
+  override toTrimmedString(options?: PrintOptions) {
+    options = getPrintOptions(options);
+    const w = options.writer!;
+    const mark = w.mark();
+    const context = options.context;
+    const { silentFail, markImportant } = this.options ?? {};
+    const name = this.get('name', context);
+    const args = this.get('args', context);
+    const contentNode = this.get('contentNode', context);
+    if (typeof name === 'string') {
+      w.add(name, this);
+    } else {
+      name.toString(options);
+    }
+    if (silentFail) {
+      w.add('?');
+    }
+    w.add('(');
+    if (args) {
+      const normalizedArgs = args.get('value', context).filter(Boolean);
+      const last = normalizedArgs.length - 1;
+      for (let i = 0; i <= last; i++) {
+        const arg = normalizedArgs[i]!;
+        w.add(this._serializeCallArg(arg, options), arg);
+        if (i < last) {
+          w.add(', ');
+        }
+      }
+    }
+    w.add(')');
+    if (markImportant) {
+      w.add(' !important');
+    }
+    if (contentNode) {
+      w.add(': ');
+      contentNode.toString(options);
+    }
+    return w.getSince(mark);
+  }
+
+  /** Recursively makes declarations important */
+  makeImportant(rules: Rules, context?: Context): Rules {
+    const effectiveContext = (
+      context
+      && rules.renderKey !== CANONICAL
+      && context.renderKey !== rules.renderKey
+    )
+      ? { ...context, renderKey: rules.renderKey }
+      : context;
+    const important: Any<'flag'> = new Any('!important', { role: 'flag' });
+    for (const rule of rules.get('value', effectiveContext)) {
+      if (isNode(rule, N.Declaration)) {
+        rule.setCurrentImportant(important, effectiveContext);
+      } else if (isNode(rule, N.Rules)) {
+        this.makeImportant(rule, effectiveContext);
+      } else if (isNode(rule, N.AtRule)) {
+        const nestedRules = rule.get('rules');
+        if (nestedRules) {
+          this.makeImportant(nestedRules, effectiveContext);
+        }
+      } else if (isNode(rule, N.Ruleset)) {
+        const nestedRules = rule.get('rules');
+        if (nestedRules) {
+          this.makeImportant(nestedRules, effectiveContext);
+        }
+      }
+    }
+    return rules;
+  }
+
+  /** Come back and redo -- too hard to reason about as a MaybePromise */
+  override evalNode(context: Context): Promise<Node> {
+    return (async () => {
+      let name = this.get('name', context);
+      let args = this.get('args', context);
+      const callOptions = this.options ?? {};
+      let { markImportant } = callOptions;
+      const applyDependencyToResult = <T extends Node>(
+        result: T,
+        nodes?: readonly (Node | undefined)[]
+      ): T => {
+        const dependency = mergeDependencies(
+          nodes ? [result, ...nodes] : [result],
+          context
+        );
+        if (dependency?.dependsOn && dependency.dependsOn.size > 0) {
+          setDependency(result, {
+            dependsOn: new Set(dependency.dependsOn),
+            sourceExpr: this
+          }, context);
+        }
+        return result;
+      };
+      const adoptCallWhitespace = <T extends Node>(node: T): T => {
+        node.pre = this.pre;
+        node.post = this.post;
+        node.sourceParent ??= this;
+        return node;
+      };
+      const cloneLeafDownstreamResult = <T extends Node>(node: T): T => {
+        return node.clone();
+      };
+      const materializeDownstreamResult = <T extends Node>(node: T): T => {
+        if (node === node.sourceNode) {
+          const childKeys = Reflect.get(node.constructor, 'childKeys');
+          if (childKeys === null) {
+            return cloneLeafDownstreamResult(node);
+          }
+          return node;
+        }
+        return node;
+      };
+      const materializeStylesheetFunctionRulesBoundary = <T extends Node>(node: T): T => {
+        if (node === node.sourceNode && isNode(node, N.Rules)) {
+          return node.clone(false, undefined, context);
+        }
+        return materializeDownstreamResult(node);
+      };
+      const evalArgNodes = async (nodes?: List<Node>) => {
+        if (!nodes) {
+          return undefined;
+        }
+        const out: Node[] = [];
+        for (const node of nodes.get('value')) {
+          out.push(await node.eval(context));
+        }
+        return list(out, nodes.options);
+      };
+      const anchorCallArgNodes = (nodes?: List<Node>) => {
+        if (!nodes) {
+          return;
+        }
+        for (const argNode of nodes.get('value')) {
+          // Anchor property refs and callback mixins to the call-site scope
+          // without cloning the arg tree.
+          if (isNode(argNode, N.Reference) && argNode.options?.type === 'property') {
+            setSourceParent(argNode, this, context);
+          } else if (isNode(argNode, N.Mixin)) {
+            setSourceParent(argNode, this, context);
+          }
+        }
+      };
+
+      context.callStack.push(this);
+      context.parenFrames.push(false);
+
+      if (process.env.JESS_DEBUG_LOCK === 'throw-call') {
+        const rawName = String(name?.valueOf?.() ?? '');
+        if (rawName.includes('.inner-locked-mixin')) {
+          throw new Error(`[lock-call:raw] ${JSON.stringify({
+            rawName,
+            parent: this.parent?.type,
+            sourceParent: this.sourceParent?.type,
+            renderKey: String(this.renderKey),
+            rulesContext: context.rulesContext?.type,
+            lookupScope: context.lookupScope?.type
+          })}`);
+        }
+      }
+      let n = typeof name === 'string' ? name : await name.eval(context);
+      const debugRawKey = isNode(name, N.Reference)
+        ? String(name.key?.valueOf?.() ?? '')
+        : '';
+      if (process.env.JESS_DEBUG_LOCK === 'log-call' && debugRawKey.includes('inner-locked-mixin')) {
+        console.log('[lock-call]', {
+          debugRawKey,
+          resolvedType: Array.isArray(n) ? 'array' : n?.type ?? typeof n,
+          resolvedName: typeof n === 'string' ? n : n?.valueOf?.(),
+          parent: this.parent?.type,
+          sourceParent: this.sourceParent?.type,
+          rulesContext: context.rulesContext?.type,
+          lookupScope: context.lookupScope?.type
+        });
+      }
+      if (process.env.JESS_DEBUG_LOCK === 'throw-call-resolved') {
+        const resolvedName = String(n?.valueOf?.() ?? '');
+        const rawName = String(name?.valueOf?.() ?? '');
+        if (rawName.includes('.inner-locked-mixin') || resolvedName.includes('.inner-locked-mixin')) {
+          throw new Error(`[lock-call:resolved] ${JSON.stringify({
+            rawName,
+            resolvedName,
+            resolvedType: Array.isArray(n) ? 'array' : n?.type,
+            parent: this.parent?.type,
+            sourceParent: this.sourceParent?.type,
+            renderKey: String(this.renderKey),
+            rulesContext: context.rulesContext?.type,
+            lookupScope: context.lookupScope?.type
+          })}`);
+        }
+      }
+      // Resolve mixin reference only at call time (same as variable refs: evaluate when used, not when stored).
+      if (isNode(n, N.Reference) && n.options?.type === 'mixin-ruleset') {
+        n = await n.eval(context);
+      }
+      // Note: Stylesheet-defined functions should be represented as a Reference(type='function')
+      // by parsers that support them. We intentionally avoid implicit string→function lookup here
+      // to prevent surprising behavior for plain CSS function-like calls.
+      // If the evaluated name is a Call node, execute it directly
+      // This handles cases like @alias: .something(foo); @alias();
+      if (isNode(n, N.Call)) {
+        // Execute the inner Call node (it will handle its own callStack push/pop)
+        const result = materializeDownstreamResult(await n.eval(context));
+        // Apply markImportant if needed
+        if (markImportant && isNode(result, N.Rules)) {
+          this.makeImportant(result, context);
+        }
+        // Always pop the outer call's stack entries
+        context.callStack.pop();
+        context.parenFrames.pop();
+        return adoptCallWhitespace(result);
+      } else if (isNode(n, N.Mixin) || isNode(n, N.Ruleset) || Array.isArray(n)) {
+        // Direct mixin invocation — skip getFunctionFromMixins/callWithContext wrapper
+        const originalCaller = context.caller;
+        context.caller = this;
+        try {
+          const result = await evalMixinDirect(context, n as MixinEntry | MixinEntry[], args);
+          if (process.env.JESS_DEBUG_LOCK === 'throw-nil-call' && debugRawKey.includes('inner-locked-mixin') && isNode(result, N.Nil)) {
+            throw new Error(`[lock-call:direct-nil] ${JSON.stringify({
+              debugRawKey,
+              resolvedType: Array.isArray(n) ? 'array' : n?.type,
+              parent: this.parent?.type,
+              sourceParent: this.sourceParent?.type,
+              rulesContext: context.rulesContext?.type,
+              lookupScope: context.lookupScope?.type
+            })}`);
+          }
+          // Result is already fully evaluated by the dispatch primitives — no re-eval.
+          if (markImportant && isNode(result, N.Rules)) {
+            this.makeImportant(result, context);
+          }
+          context.callStack.pop();
+          context.parenFrames.pop();
+          return adoptCallWhitespace(result);
+        } finally {
+          context.caller = originalCaller;
+        }
+      } else if (isNode(n, N.Func)) {
+        // Execute stylesheet-defined functions via their evalCall behavior.
+        const argNodes = await evalArgNodes(args) ?? list([]);
+        const contentNode = this.get('contentNode', context);
+        const originalCaller = context.caller;
+        context.caller = this;
+        try {
+          const result = await n.evalCall(context, argNodes, contentNode);
+          if (process.env.JESS_DEBUG_LOCK === 'throw-nil-call' && debugRawKey.includes('inner-locked-mixin') && isNode(result, N.Nil)) {
+            throw new Error(`[lock-call:func-nil] ${JSON.stringify({
+              debugRawKey,
+              resolvedType: n.type,
+              parent: this.parent?.type,
+              sourceParent: this.sourceParent?.type,
+              rulesContext: context.rulesContext?.type,
+              lookupScope: context.lookupScope?.type
+            })}`);
+          }
+          context.callStack.pop();
+          context.parenFrames.pop();
+          return applyDependencyToResult(
+            adoptCallWhitespace(materializeStylesheetFunctionRulesBoundary(result)),
+            argNodes.get('value')
+          );
+        } finally {
+          context.caller = originalCaller;
+        }
+      } else if (isNode(n, N.Collection)) {
+        // If the evaluated name is Rules or Collection (detached rulesets),
+        // return those rules directly, but only if args are empty
+        // If args are provided, throw an error - you can't call Rules/Collection with arguments
+        if (args && args.get('value').length > 0) {
+          context.callStack.pop();
+          context.parenFrames.pop();
+          throw new ReferenceError(`Cannot call ${n.type} with arguments`);
+        }
+        let rules: Rules = n.createPlacementWrapper(context, context.nextRenderKey());
+        const placementContext: Context = {
+          ...context,
+          renderKey: rules.renderKey,
+          rulesContext: rules
+        };
+        // Detached-ruleset invocation keeps the definition-owned `.parent` /
+        // `.sourceParent` chain and exposes caller ancestry through an
+        // explicit secondary edge.
+        addParentEdge(rules, CALLER, this);
+        rules = await rules.eval(context);
+        finalizeInvocationOutputRules(rules, placementContext);
+        context.callStack.pop();
+        context.parenFrames.pop();
+        // Apply markImportant if needed
+        if (markImportant) {
+          this.makeImportant(rules, context);
+        }
+        return rules;
+      }
+
+      let fn = isNode(n, N.JsFunction) ? n.value : n;
+      if (typeof fn === 'function') {
+        const originalCaller = context.caller;
+        context.caller = this;
+        let didPopCallStack = false;
+        try {
+          const fnOptions = Reflect.get(fn, 'options');
+          const hasParamMetadata = Boolean(fnOptions && Reflect.get(fnOptions, 'params'));
+          if (args) {
+            anchorCallArgNodes(args);
+            if (!hasParamMetadata) {
+              args = await evalArgNodes(args);
+              anchorCallArgNodes(args);
+            }
+          }
+          const result = await (
+            args
+              ? (
+                  hasParamMetadata
+                    ? callWithContext(context, fn, args)
+                    : callWithContext(context, fn, ...[...args.get('value')])
+                )
+              : callWithContext(context, fn)
+          );
+          if (process.env.JESS_DEBUG_LOCK === 'throw-nil-call' && debugRawKey.includes('inner-locked-mixin') && isNode(result, N.Nil)) {
+            throw new Error(`[lock-call:jsfn-nil] ${JSON.stringify({
+              debugRawKey,
+              resolvedType: typeof fn,
+              parent: this.parent?.type,
+              sourceParent: this.sourceParent?.type,
+              rulesContext: context.rulesContext?.type,
+              lookupScope: context.lookupScope?.type
+            })}`);
+          }
+          context.caller = originalCaller;
+          context.callStack.pop();
+          didPopCallStack = true;
+          if (isNode(result)) {
+            let evald = result.eval(context);
+            if (isThenable(evald)) {
+              evald = await evald;
+            }
+            if (process.env.JESS_DEBUG_LOCK === 'throw-nil-call' && debugRawKey.includes('inner-locked-mixin') && isNode(evald, N.Nil)) {
+              throw new Error(`[lock-call:jsfn-post-eval-nil] ${JSON.stringify({
+                debugRawKey,
+                resultType: result.type,
+                parent: this.parent?.type,
+                sourceParent: this.sourceParent?.type,
+                rulesContext: context.rulesContext?.type,
+                lookupScope: context.lookupScope?.type
+              })}`);
+            }
+            if (markImportant && isNode(evald, N.Rules)) {
+              this.makeImportant(evald, context);
+            }
+            return adoptCallWhitespace(evald);
+          }
+          let castResult = cast(result);
+          if (isNode(castResult, N.Rules) && castResult.value.length === 1) {
+            return adoptCallWhitespace(castResult.value[0]!);
+          }
+          return adoptCallWhitespace(castResult);
+        } catch (e) {
+          const unitMode = context?.opts?.unitMode ?? 'loose';
+          const shouldRethrowForMode = unitMode === 'strict';
+          if (e instanceof ReferenceError && e.message.includes('No matching mixins')) {
+            if (getParent(this, context)?.type === 'SelectorCapture') {
+              return adoptCallWhitespace(new Any(String(n.valueOf()), { role: 'ident' }).inherit(this));
+            }
+            if (isNode(name, N.Reference)) {
+              throw new ReferenceError(`No matching mixins found for '${name.get('key').valueOf()}'`);
+            }
+            throw e;
+          }
+          if (!callOptions.silentFail || shouldRethrowForMode) {
+            throw e;
+          }
+          let newCall = this.clone().inherit(this);
+          /** Remove this flag for serialization */
+          newCall.options.silentFail = false;
+          newCall.name = isNode(name, N.Reference) && name.options.fallbackValue === true
+            ? String(name.get('key'))
+            : String(n.valueOf());
+          newCall.args = await evalArgNodes(args);
+          return applyDependencyToResult(adoptCallWhitespace(newCall), newCall.args?.get('value'));
+        } finally {
+          context.caller = originalCaller;
+          context.parenFrames.pop();
+          if (!didPopCallStack) {
+            context.callStack.pop();
+          }
+        }
+      } else {
+        if (n === 'calc') {
+          context.calcFrames++;
+        }
+        const evaluatedArgs = await evalArgNodes(args);
+
+        if (n === 'calc') {
+          context.calcFrames--;
+        }
+        context.parenFrames.pop();
+        context.callStack.pop();
+        const needsMaterializedClone = Boolean(callOptions.silentFail);
+        const node = needsMaterializedClone
+          ? this.clone()
+          : this.clone();
+        node.options.silentFail = false;
+        if (
+          n === 'calc' && evaluatedArgs
+        ) {
+          const evalArgItems = evaluatedArgs.get('value');
+          if (isNode(evalArgItems[0], N.Dimension)) {
+            return applyDependencyToResult(evalArgItems[0]!, evalArgItems);
+          } else if (context.calcFrames !== 0) {
+            return applyDependencyToResult(new Paren(evalArgItems[0]!), evalArgItems);
+          }
+        }
+        node.name = n;
+        node.args = evaluatedArgs;
+        return applyDependencyToResult(adoptCallWhitespace(node), evaluatedArgs?.get('value'));
+      }
+    })().then(value => value);
+  }
+}
+
+type Params = ConstructorParameters<typeof Call>;
+
+export const call = defineType(Call, 'Call') as (
+  value: Params[0],
+  options?: Params[1],
+  location?: Params[2],
+  treeContext?: Params[3]
+) => Call;

package/src/tree/collection.ts

@@ -0,0 +1,52 @@
+import type { MaybePromise } from 'awaitable-pipe/lib/utils';
+import { defineType, type Node } from './node.js';
+import { Rules } from './rules.js';
+import { getPrintOptions, type PrintOptions } from './util/print.js';
+import type { Context } from '../context.js';
+
+/**
+ * A collection is essentially like an anonymous mixin,
+ * except that properties are arbitrary, so its intended
+ * for map data.
+ *
+ * Even though it doesn't allow everything that a regular set
+ * of rules does, we extend Rules just to make evaluation easier.
+ *
+ * Can be used like Sass property nesting.
+ * @see https://sass-lang.com/documentation/style-rules/declarations/#nesting
+ */
+export interface Collection {
+  type: 'Collection';
+  shortType: 'coll';
+}
+
+export class Collection extends Rules {
+  override toTrimmedString(options?: PrintOptions) {
+    return this.toBraced(options);
+  }
+
+  /**
+   * Collection rules aren't evaluated by default. They're evaluated
+   * at access time OR if assigned to a property.
+   */
+  override evalNode(context: Context): MaybePromise<this> {
+    return this;
+  }
+
+  override preEval(context: Context): this | Promise<this> {
+    if (this.preEvaluated) {
+      return this;
+    }
+    this.preEvaluated = true;
+    return this;
+  }
+}
+
+type Params = ConstructorParameters<typeof Collection>;
+
+export const coll = defineType(Collection, 'Collection', 'coll') as (
+  value: Params[0],
+  options?: Params[1],
+  location?: Params[2],
+  treeContext?: Params[3]
+) => Collection;