@gesslar/sassy 0.21.1 → 0.22.0

package/types/ThemePool.d.ts

@@ -0,0 +1,81 @@
+/**
+ * ThemePool represents a collection of ThemeTokens serving both as a
+ * lookup of string>ThemeToken and dependencies.
+ *
+ * @class ThemePool
+ */
+export default class ThemePool {
+    /**
+     * Returns the map of encoded theme token ids to their token object.
+     *
+     * @returns {Map<string, ThemeToken>} Map of tokens to their children.
+     */
+    getTokens(): Map<string, ThemeToken>;
+    /**
+     * Retrieves a resolved token by its name.
+     *
+     * @param {string} name - The token to look up.
+     * @returns {string|undefined} The resolved token string or undefined.
+     */
+    lookup(name: string): string | undefined;
+    /**
+     * Sets a resolved value for a token key.
+     *
+     * @param {string} key - The token key.
+     * @param {string} value - The resolved value.
+     */
+    resolve(key: string, value: string): void;
+    /**
+     * Sets a raw resolved value for a token key.
+     *
+     * @param {string} key - The token key.
+     * @param {string} value - The raw resolved value.
+     */
+    rawResolve(key: string, value: string): void;
+    /**
+     * Checks if a token name exists in resolved map.
+     *
+     * @param {string} name - The token name to check.
+     * @returns {boolean} True if the token exists.
+     */
+    has(name: string): boolean;
+    /**
+     * Checks if a token exists by its name.
+     *
+     * @param {ThemeToken} token - The token to check.
+     * @returns {boolean} True if the token exists.
+     */
+    hasToken(token: ThemeToken): boolean;
+    /**
+     * Retrieves a token's dependency.
+     *
+     * @param {ThemeToken} token - The token to look up.
+     * @returns {ThemeToken?} The dependent token with the given token, or undefined.
+     */
+    reverseLookup(token: ThemeToken): ThemeToken | null;
+    /**
+     * Adds a token to the pool, optionally setting up dependencies if required.
+     *
+     * @param {ThemeToken} token - The token to add.
+     * @param {ThemeToken} [dependency] - The dependent token.
+     * @returns {ThemeToken} The token that was added.
+     */
+    addToken(token: ThemeToken, dependency?: ThemeToken): ThemeToken;
+    /**
+     * Finds a token by its value.
+     *
+     * @param {string} value - The value to search for.
+     * @returns {ThemeToken|undefined} The found token or undefined.
+     */
+    findToken(value: string): ThemeToken | undefined;
+    /**
+     * Checks if one token is an ancestor of another using reverse lookup.
+     *
+     * @param {ThemeToken} candidate - Potential ancestor token.
+     * @param {ThemeToken} token - Potential descendant token.
+     * @returns {boolean} True if candidate is an ancestor of token.
+     */
+    isAncestorOf(candidate: ThemeToken, token: ThemeToken): boolean;
+    #private;
+}
+import ThemeToken from "./ThemeToken.js";

package/types/ThemeToken.d.ts

@@ -0,0 +1,150 @@
+/**
+ * ThemeToken represents a single token in a theme tree, encapsulating theme
+ * token data and relationships.
+ *
+ * Provides property management, factory methods, tree integration, and
+ * serialization.
+ *
+ * @class ThemeToken
+ */
+export default class ThemeToken {
+    /**
+     * Constructs a ThemeToken with a given token name.
+     *
+     * @param {string} name - The token name for this token.
+     */
+    constructor(name: string);
+    /**
+     * Adds this token to a ThemePool with optional dependency.
+     *
+     * @param {ThemePool} pool - The pool to add to.
+     * @param {ThemeToken} [dependency] - Optional dependency token.
+     * @returns {ThemeToken} This token instance.
+     */
+    addToPool(pool?: ThemePool, dependency?: ThemeToken): ThemeToken;
+    /**
+     * Sets the name of this token (only if not already set).
+     *
+     * @param {string} name - The token name.
+     * @returns {ThemeToken} This token instance.
+     */
+    setName(name: string): ThemeToken;
+    /**
+     * Gets the name of this token.
+     *
+     * @returns {string} The token name.
+     */
+    getName(): string;
+    /**
+     * Sets the kind of this token (only if not already set).
+     *
+     * @param {string} kind - The token kind.
+     * @returns {ThemeToken} This token instance.
+     */
+    setKind(kind: string): ThemeToken;
+    /**
+     * Gets the kind of this token.
+     *
+     * @returns {string} The token kind.
+     */
+    getKind(): string;
+    /**
+     * Sets the value of this token.
+     *
+     * @param {string} value - The token value.
+     * @returns {ThemeToken} This token instance.
+     */
+    setValue(value: string): ThemeToken;
+    /**
+     * Gets the value of this token.
+     *
+     * @returns {string} The token value.
+     */
+    getValue(): string;
+    /**
+     * Sets the raw value of this token (only if not already set).
+     *
+     * @param {string} raw - The raw token value.
+     * @returns {ThemeToken} This token instance.
+     */
+    setRawValue(raw: string): ThemeToken;
+    /**
+     * Gets the raw value of this token.
+     *
+     * @returns {string} The raw token value.
+     */
+    getRawValue(): string;
+    /**
+     * Sets the dependency of this token (only if not already set).
+     *
+     * @param {ThemeToken} dependency - The dependency token.
+     * @returns {ThemeToken} This token instance.
+     */
+    setDependency(dependency: ThemeToken): ThemeToken;
+    /**
+     * Gets the dependency of this token.
+     *
+     * @returns {ThemeToken|null} The dependency token or null.
+     */
+    getDependency(): ThemeToken | null;
+    /**
+     * Sets the parent token key.
+     *
+     * @param {string} tokenKey - The parent token key.
+     * @returns {ThemeToken} This token instance.
+     */
+    setParentTokenKey(tokenKey: string): ThemeToken;
+    /**
+     * Gets the parent token key.
+     *
+     * @returns {string|null} The parent token key or null.
+     */
+    getParentTokenKey(): string | null;
+    /**
+     * Adds a trail of tokens to this token's trail array.
+     *
+     * @param {Array<ThemeToken>} trail - Array of tokens to add.
+     * @returns {ThemeToken} This token instance.
+     */
+    addTrail(trail: Array<ThemeToken>): ThemeToken;
+    /**
+     * Gets the trail array of this token.
+     *
+     * @returns {Array<ThemeToken>} The trail array.
+     */
+    getTrail(): Array<ThemeToken>;
+    /**
+     * Sets the parsed color object for this token.
+     *
+     * @param {object} parsedColor - The parsed Culori color object
+     * @returns {ThemeToken} This token instance.
+     */
+    setParsedColor(parsedColor: object): ThemeToken;
+    /**
+     * Gets the parsed color object of this token.
+     *
+     * @returns {object|null} The parsed Culori color object or null.
+     */
+    getParsedColor(): object | null;
+    /**
+     * Checks if this token has an ancestor with the given token name.
+     *
+     * @param {string} name - The name of the ancestor token to check for.
+     * @returns {boolean} True if ancestor exists.
+     */
+    hasDependency(name: string): boolean;
+    /**
+     * Gets the ThemePool associated with this token.
+     *
+     * @returns {ThemePool} The associated pool.
+     */
+    getPool(): ThemePool;
+    /**
+     * Returns a JSON representation of the ThemeToken.
+     *
+     * @returns {object} JSON representation of the ThemeToken
+     */
+    toJSON(): object;
+    #private;
+}
+import ThemePool from "./ThemePool.js";

package/types/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/index.d.ts

@@ -0,0 +1,9 @@
+export { default as Theme } from "./Theme.js";
+export { default as Compiler } from "./Compiler.js";
+export { default as Evaluator } from "./Evaluator.js";
+export { default as Command } from "./Command.js";
+export { default as BuildCommand } from "./BuildCommand.js";
+export { default as LintCommand } from "./LintCommand.js";
+export { default as ResolveCommand } from "./ResolveCommand.js";
+export { default as Session } from "./Session.js";
+export { default as Colour } from "./Colour.js";

package/src/Cache.js

@@ -1,74 +0,0 @@
-import Sass from "./Sass.js"
-import File from "./File.js"
-import FileObject from "./FileObject.js"
-
-/**
- * File system cache for theme compilation data with automatic invalidation.
- * Provides intelligent caching of parsed JSON5/YAML files with mtime-based
- * cache invalidation to optimize parallel theme compilation performance.
- *
- * The cache eliminates redundant file reads and parsing when multiple themes
- * import the same dependency files, while ensuring data freshness through
- * modification time checking.
- */
-export default class Cache {
-  /** @type {Map<string, Date>} Map of file paths to last modification times */
-  #modifiedTimes = new Map()
-  /** @type {Map<string, object>} Map of file paths to parsed file data */
-  #dataCache = new Map()
-
-  /**
-   * Removes cached data for a specific file from both time and data maps.
-   * Used when files are modified or when cache consistency needs to be
-   * maintained.
-   *
-   * @private
-   * @param {FileObject} file - The file object to remove from cache
-   * @returns {void}
-   */
-  #cleanup(file) {
-    this.#modifiedTimes.delete(file.path)
-    this.#dataCache.delete(file.path)
-  }
-
-  /**
-   * Loads and caches parsed file data with automatic invalidation based on
-   * modification time.
-   *
-   * Implements a sophisticated caching strategy that checks file modification
-   * times to determine whether cached data is still valid, ensuring data
-   * freshness while optimizing performance for repeated file access during
-   * parallel theme compilation.
-   *
-   * @param {FileObject} fileObject - The file object to load and cache
-   * @returns {Promise<object>} The parsed file data (JSON5 or YAML)
-   * @throws {Sass} If the file cannot be found or accessed
-   */
-  async loadCachedData(fileObject) {
-    const lastModified = await File.fileModified(fileObject)
-
-    if(lastModified === null)
-      throw Sass.new(`Unable to find file '${fileObject.path}'`)
-
-    if(this.#modifiedTimes.has(fileObject.path)) {
-      const lastCached = this.#modifiedTimes.get(fileObject.path)
-
-      if(lastModified > lastCached) {
-        this.#cleanup(fileObject)
-      } else {
-        if(!(this.#dataCache.has(fileObject.path)))
-          this.#cleanup(fileObject)
-        else {
-          return this.#dataCache.get(fileObject.path)
-        }
-      }
-    }
-
-    const data = await File.loadDataFile(fileObject)
-
-    this.#modifiedTimes.set(fileObject.path, lastModified)
-    this.#dataCache.set(fileObject.path, data)
-
-    return data
-  }
-}