next-yak 9.8.0 → 9.9.0

package/dist/cross-file-resolver/index.d.ts

@@ -0,0 +1,198 @@
+//#region ../yak-internals/cross-file-resolver/types.d.ts
+interface Cache<STORED> {
+  set(key: string, data: STORED): void;
+  get(key: string): STORED | undefined;
+  addDependency?(key: string, filePath: string): void;
+}
+//#endregion
+//#region ../yak-internals/cross-file-resolver/parseModule.d.ts
+declare function parseModule(context: ParseContext, modulePath: string): Promise<ParsedModule>;
+declare function uncachedParseModule(context: ParseContext, modulePath: string): Promise<ParsedModule>;
+type ParseContext = {
+  cache?: {
+    parse?: Cache<ParsedModule>;
+  };
+  transpilationMode?: "Css" | "CssModule";
+  evaluateYakModule?: (modulePath: string) => Promise<Record<string, unknown>> | Record<string, unknown>;
+  extractExports: (modulePath: string) => Promise<ModuleExports> | ModuleExports;
+  getTransformed: (modulePath: string) => Promise<{
+    code: string;
+    map?: string;
+  }> | {
+    code: string;
+    map?: string;
+  };
+};
+type ModuleExports = {
+  importYak: boolean;
+  named: Record<string, ModuleExport>;
+  all: string[];
+};
+type ConstantExport = {
+  type: "constant";
+  value: string | number;
+};
+type RecordExport = {
+  type: "record";
+  value: Record<string, ModuleExport>;
+};
+type UnsupportedExport = {
+  type: "unsupported";
+  hint?: string;
+  /**
+   * Source location of the offending expression. Populated by the parser
+   * when it has access to source text; left undefined for runtime-evaluated
+   * yak modules. The error formatter is responsible for any rendering.
+   */
+  source?: UnsupportedExportSource;
+};
+type UnsupportedExportSource = {
+  /** 1-based line number, 0-based column — same convention as Babel `loc`. */start: {
+    line: number;
+    column: number;
+  };
+  end: {
+    line: number;
+    column: number;
+  };
+  /** The text of `start.line` from the original source — kept so the
+   * error formatter can render a snippet without re-reading the file. */
+  lineText: string;
+};
+type ReExport = {
+  type: "re-export";
+  name: string;
+  from: string;
+};
+type NamespaceReExport = {
+  type: "namespace-re-export";
+  from: string;
+};
+type TagTemplateExport = {
+  type: "tag-template";
+};
+type ModuleExport = ConstantExport | TagTemplateExport | RecordExport | UnsupportedExport | ReExport | NamespaceReExport;
+type ParsedModule = {
+  path: string;
+  exports: ModuleExports;
+} & ({
+  type: "regular";
+  js?: {
+    code: string;
+    map?: string;
+  };
+  styledComponents?: Record<string, StyledComponent>;
+  mixins?: Record<string, Mixin>;
+} | {
+  type: "yak";
+});
+type StyledComponent = {
+  type: "styled-component";
+  value: string;
+  nameParts: string[];
+};
+type Mixin = {
+  type: "mixin";
+  value: string;
+  nameParts: string[];
+};
+//#endregion
+//#region ../yak-internals/cross-file-resolver/resolveCrossFileConstant.d.ts
+/**
+ * Resolves cross-file selectors in css files
+ *
+ * e.g.:
+ * theme.ts:
+ * ```ts
+ * export const colors = {
+ *   primary: "#ff0000",
+ *   secondary: "#00ff00",
+ * };
+ * ```
+ *
+ * styles.ts:
+ * ```ts
+ * import { colors } from "./theme";
+ * export const button = css`
+ *  background-color: ${colors.primary};
+ * `;
+ */
+declare function resolveCrossFileConstant(context: ResolveContext, filePath: string, css: string): Promise<{
+  resolved: string;
+  dependencies: string[];
+}>;
+declare function uncachedResolveCrossFileConstant(context: ResolveContext, filePath: string, css: string): Promise<{
+  resolved: string;
+  dependencies: string[];
+}>;
+type ResolveContext = {
+  parse: (modulePath: string) => Promise<ParsedModule> | ParsedModule;
+  cache?: {
+    resolve?: Cache<Promise<{
+      resolved: ResolvedModule;
+      dependencies: string[];
+    }>>;
+    resolveCrossFileConstant?: Cache<Promise<{
+      resolved: string;
+      dependencies: string[];
+    }>>;
+  };
+  exportAllLimit?: number;
+  resolve: (specifier: string, importer: string) => Promise<string> | string;
+};
+type ExtendedRecordExport = {
+  type: "record";
+  value: Record<string, ResolvedExport>;
+};
+type ResolvedMixin = {
+  type: "mixin";
+  value: string;
+};
+type ResolvedStyledComponent = {
+  type: "styled-component";
+  className: string;
+};
+type ResolvedExport = Exclude<ModuleExport, RecordExport> | ExtendedRecordExport | ResolvedStyledComponent | ResolvedMixin;
+type ResolvedExports = {
+  named: Record<string, ResolvedExport>;
+  all: string[];
+};
+type ResolvedModule = {
+  path: string;
+  exports: ResolvedExports;
+};
+//#endregion
+//#region ../yak-internals/cross-file-resolver/Errors.d.ts
+declare class CauseError extends Error {
+  circular?: boolean;
+  constructor(message: string, options?: {
+    cause?: unknown;
+  });
+}
+declare class ResolveError extends CauseError {}
+/**
+ * Thrown for `unsupported` exports. Subclassed so the surrounding
+ * `resolveModuleExport` catch can recognise that the error already
+ * carries its own "Unable to resolve … in module …" wrapper and
+ * doesn't need another one stacked on top.
+ */
+declare class UnsupportedExportError extends ResolveError {}
+declare class CircularDependencyError extends CauseError {
+  constructor(message: string, options?: {
+    cause?: unknown;
+  });
+}
+//#endregion
+//#region ../yak-internals/loaders/lib/parseExports.d.ts
+/**
+ * Extracts a module's exports for the cross-file resolver by parsing with babel. Nothing is executed.
+ *
+ * Handles `export const`, re-exports with a `from`, `export *`, and `export default`.
+ * Anything else becomes an `unsupported` entry with its source location, or is skipped.
+ *
+ * Throws if the source doesn't parse.
+ */
+declare function parseExports(sourceContents: string): Promise<ModuleExports>;
+//#endregion
+export { CauseError, CircularDependencyError, type Mixin, type ModuleExport, type ModuleExports, type ParseContext, type ParsedModule, type ResolveContext, ResolveError, type ResolvedExport, type ResolvedExports, type ResolvedModule, type StyledComponent, UnsupportedExportError, type UnsupportedExportSource, parseExports, parseModule, resolveCrossFileConstant, uncachedParseModule, uncachedResolveCrossFileConstant };
+//# sourceMappingURL=index.d.ts.map