@bamboocss/generator 1.12.2 → 1.13.1

package/dist/index.d.cts

@@ -0,0 +1,122 @@
+import { Context, StyleDecoder, Stylesheet } from "@bamboocss/core";
+import { ArtifactId, CssArtifactType, LoadConfigResult, SpecFile, SpecType, SpecTypeMap } from "@bamboocss/types";
+
+//#region src/generator.d.ts
+interface SplitCssArtifact {
+  type: 'layer' | 'recipe' | 'theme';
+  name: string;
+  file: string;
+  code: string;
+  /** Directory relative to styles/ */
+  dir?: string;
+}
+interface SplitCssResult {
+  /** Layer CSS files (reset, global, tokens, utilities) */
+  layers: SplitCssArtifact[];
+  /** Recipe CSS files */
+  recipes: SplitCssArtifact[];
+  /** Theme CSS files (not auto-imported) */
+  themes: SplitCssArtifact[];
+  /** Content for recipes.css */
+  recipesIndex: string;
+  /** Content for main styles.css */
+  index: string;
+}
+declare class Generator extends Context {
+  constructor(conf: LoadConfigResult);
+  getArtifacts: (ids?: ArtifactId[] | undefined) => import("@bamboocss/types").Artifact[];
+  appendCssOfType: (type: CssArtifactType, sheet: Stylesheet) => void;
+  appendLayerParams: (sheet: Stylesheet) => void;
+  appendBaselineCss: (sheet: Stylesheet) => void;
+  appendParserCss: (sheet: Stylesheet) => void;
+  /**
+   * Drop token css variables nothing can reach. Call this only once the sheet holds the
+   * whole stylesheet — a baseline-only sheet has no utilities to reference anything, so
+   * every token would look unused.
+   *
+   * `keep` carries references this cannot see for itself; see `collectTokenReferences`.
+   */
+  pruneTokens: (sheet: Stylesheet, keep?: Set<string>) => {
+    removed: number;
+    kept: number;
+  } | undefined;
+  /**
+   * Drop `@keyframes` nothing can reach. Same completeness requirement as
+   * `pruneTokens`: the sheet has to hold the whole stylesheet, or every keyframe looks
+   * unused for want of a utility to reference it.
+   *
+   * `keep` carries names this cannot see for itself; see `collectKeyframeReferences`.
+   */
+  pruneKeyframes: (sheet: Stylesheet, keep?: Set<string>) => {
+    removed: number;
+    kept: number;
+  } | undefined;
+  /**
+   * Keyframes the themes name.
+   *
+   * A theme is emitted as its own artifact and injected at runtime, so its css is not in
+   * the sheet being pruned. A theme that points an animation token at a different
+   * keyframe than the base does — `--animations-enter: fade-in` in the base and
+   * `slide-up` under `dark` — would otherwise have that keyframe removed, because
+   * nothing in the pruned sheet ever names it.
+   */
+  private getThemeKeyframeNames;
+  /**
+   * Every custom property the token system declares. Used as the allow-list of what may
+   * be removed, so custom properties from `globalCss` are never touched.
+   */
+  private getTokenVarNames;
+  /**
+   * Everything the themes refer to.
+   *
+   * A theme is emitted as its own artifact and injected at runtime, so its css is not in
+   * the sheet being pruned and nothing there points at what it needs. A theme that maps a
+   * token onto a base colour would otherwise be left referring to a declaration that has
+   * been removed.
+   */
+  private getThemeTokenVars;
+  /**
+   * Tokens whose javascript value is a `var()` reference rather than a literal.
+   * `token('colors.text')` hands those to the caller as a reference, so the declaration
+   * has to survive whether or not the generated css mentions it. Ordinary tokens resolve
+   * to a literal in javascript and need no such exemption.
+   *
+   * The two cases mirror `generateTokenJs`, which is what decides the value javascript
+   * actually receives:
+   *
+   * - A virtual token, or one carrying a condition, is handed its own `varRef`.
+   * - A negative token is handed `calc(var(--x) * -1)`, so it is a reference too — but to
+   *   the *positive* token's declaration. Its own var is never declared, so the name has
+   *   to come out of the value.
+   */
+  private getAlwaysKeptTokenVars;
+  getParserCss: (decoder: StyleDecoder) => string;
+  getCss: (stylesheet?: Stylesheet) => string;
+  /**
+   * Get CSS for a specific layer from the stylesheet
+   */
+  getLayerCss: (sheet: Stylesheet, layer: "reset" | "base" | "tokens" | "recipes" | "utilities") => string;
+  /**
+   * Get CSS for a specific recipe
+   */
+  getRecipeCss: (recipeName: string) => string;
+  /**
+   * Get all recipe names from the decoder
+   */
+  getRecipeNames: () => string[];
+  /**
+   * Get all split CSS artifacts for the stylesheet
+   * Used when --splitting flag is enabled
+   */
+  getSplitCssArtifacts: (sheet: Stylesheet) => SplitCssResult;
+  getSpec: () => SpecFile[];
+  getSpecOfType: <T extends SpecType>(type: T) => T extends "color-palette" | "themes" ? SpecTypeMap[T] | undefined : SpecTypeMap[T];
+}
+//#endregion
+//#region src/artifacts/js/themes.d.ts
+/**
+ * Get CSS for a specific theme
+ */
+declare function getThemeCss(ctx: Context, themeName: string): string;
+//#endregion
+export { Generator, SplitCssArtifact, SplitCssResult, getThemeCss };

package/dist/index.d.mts

@@ -0,0 +1,122 @@
+import { Context, StyleDecoder, Stylesheet } from "@bamboocss/core";
+import { ArtifactId, CssArtifactType, LoadConfigResult, SpecFile, SpecType, SpecTypeMap } from "@bamboocss/types";
+
+//#region src/generator.d.ts
+interface SplitCssArtifact {
+  type: 'layer' | 'recipe' | 'theme';
+  name: string;
+  file: string;
+  code: string;
+  /** Directory relative to styles/ */
+  dir?: string;
+}
+interface SplitCssResult {
+  /** Layer CSS files (reset, global, tokens, utilities) */
+  layers: SplitCssArtifact[];
+  /** Recipe CSS files */
+  recipes: SplitCssArtifact[];
+  /** Theme CSS files (not auto-imported) */
+  themes: SplitCssArtifact[];
+  /** Content for recipes.css */
+  recipesIndex: string;
+  /** Content for main styles.css */
+  index: string;
+}
+declare class Generator extends Context {
+  constructor(conf: LoadConfigResult);
+  getArtifacts: (ids?: ArtifactId[] | undefined) => import("@bamboocss/types").Artifact[];
+  appendCssOfType: (type: CssArtifactType, sheet: Stylesheet) => void;
+  appendLayerParams: (sheet: Stylesheet) => void;
+  appendBaselineCss: (sheet: Stylesheet) => void;
+  appendParserCss: (sheet: Stylesheet) => void;
+  /**
+   * Drop token css variables nothing can reach. Call this only once the sheet holds the
+   * whole stylesheet — a baseline-only sheet has no utilities to reference anything, so
+   * every token would look unused.
+   *
+   * `keep` carries references this cannot see for itself; see `collectTokenReferences`.
+   */
+  pruneTokens: (sheet: Stylesheet, keep?: Set<string>) => {
+    removed: number;
+    kept: number;
+  } | undefined;
+  /**
+   * Drop `@keyframes` nothing can reach. Same completeness requirement as
+   * `pruneTokens`: the sheet has to hold the whole stylesheet, or every keyframe looks
+   * unused for want of a utility to reference it.
+   *
+   * `keep` carries names this cannot see for itself; see `collectKeyframeReferences`.
+   */
+  pruneKeyframes: (sheet: Stylesheet, keep?: Set<string>) => {
+    removed: number;
+    kept: number;
+  } | undefined;
+  /**
+   * Keyframes the themes name.
+   *
+   * A theme is emitted as its own artifact and injected at runtime, so its css is not in
+   * the sheet being pruned. A theme that points an animation token at a different
+   * keyframe than the base does — `--animations-enter: fade-in` in the base and
+   * `slide-up` under `dark` — would otherwise have that keyframe removed, because
+   * nothing in the pruned sheet ever names it.
+   */
+  private getThemeKeyframeNames;
+  /**
+   * Every custom property the token system declares. Used as the allow-list of what may
+   * be removed, so custom properties from `globalCss` are never touched.
+   */
+  private getTokenVarNames;
+  /**
+   * Everything the themes refer to.
+   *
+   * A theme is emitted as its own artifact and injected at runtime, so its css is not in
+   * the sheet being pruned and nothing there points at what it needs. A theme that maps a
+   * token onto a base colour would otherwise be left referring to a declaration that has
+   * been removed.
+   */
+  private getThemeTokenVars;
+  /**
+   * Tokens whose javascript value is a `var()` reference rather than a literal.
+   * `token('colors.text')` hands those to the caller as a reference, so the declaration
+   * has to survive whether or not the generated css mentions it. Ordinary tokens resolve
+   * to a literal in javascript and need no such exemption.
+   *
+   * The two cases mirror `generateTokenJs`, which is what decides the value javascript
+   * actually receives:
+   *
+   * - A virtual token, or one carrying a condition, is handed its own `varRef`.
+   * - A negative token is handed `calc(var(--x) * -1)`, so it is a reference too — but to
+   *   the *positive* token's declaration. Its own var is never declared, so the name has
+   *   to come out of the value.
+   */
+  private getAlwaysKeptTokenVars;
+  getParserCss: (decoder: StyleDecoder) => string;
+  getCss: (stylesheet?: Stylesheet) => string;
+  /**
+   * Get CSS for a specific layer from the stylesheet
+   */
+  getLayerCss: (sheet: Stylesheet, layer: "reset" | "base" | "tokens" | "recipes" | "utilities") => string;
+  /**
+   * Get CSS for a specific recipe
+   */
+  getRecipeCss: (recipeName: string) => string;
+  /**
+   * Get all recipe names from the decoder
+   */
+  getRecipeNames: () => string[];
+  /**
+   * Get all split CSS artifacts for the stylesheet
+   * Used when --splitting flag is enabled
+   */
+  getSplitCssArtifacts: (sheet: Stylesheet) => SplitCssResult;
+  getSpec: () => SpecFile[];
+  getSpecOfType: <T extends SpecType>(type: T) => T extends "color-palette" | "themes" ? SpecTypeMap[T] | undefined : SpecTypeMap[T];
+}
+//#endregion
+//#region src/artifacts/js/themes.d.ts
+/**
+ * Get CSS for a specific theme
+ */
+declare function getThemeCss(ctx: Context, themeName: string): string;
+//#endregion
+export { Generator, SplitCssArtifact, SplitCssResult, getThemeCss };