@parcel/css/node/index.js.flow

A CSS parser, transformer, and minifier written in Rust

// @flow
// This file is autogenerated by build-prefixes.js. DO NOT EDIT!

export type Targets = {|
  android?: number,
  chrome?: number,
  edge?: number,
  firefox?: number,
  ie?: number,
  ios_saf?: number,
  opera?: number,
  safari?: number,
  samsung?: number
|};


export type TransformOptions = {|
  /** The filename being transformed. Used for error messages and source maps. */
  filename: string,
  /** The source code to transform. */
  code: Buffer,
  /** Whether to enable minification. */
  minify?: boolean,
  /** Whether to output a source map. */
  sourceMap?: boolean,
  /** The browser targets for the generated code. */
  targets?: Targets,
  /** Whether to enable various draft syntax. */
  drafts?: Drafts,
  /** Whether to compile this file as a CSS module. */
  cssModules?: boolean,
  /**
   * Whether to analyze dependencies (e.g. `@import` and `url()`).
   * When enabled, `@import` rules are removed, and `url()` dependencies
   * are replaced with hashed placeholders that can be replaced with the final
   * urls later (after bundling). Dependencies are returned as part of the result.
   */
  analyzeDependencies?: boolean,
  /** 
   * Replaces user action pseudo classes with class names that can be applied from JavaScript.
   * This is useful for polyfills, for example.
   */
  pseudoClasses?: PseudoClasses,
  /**
   * A list of class names, ids, and custom identifiers (e.g. @keyframes) that are known
   * to be unused. These will be removed during minification. Note that these are not
   * selectors but individual names (without any . or # prefixes).
   */
  unusedSymbols?: string[]
|};

export type BundleOptions = Omit<TransformOptions, 'code'>;

export type Drafts = {|
  /** Whether to enable CSS nesting. */
  nesting?: boolean,
  /** Whether to enable @custom-media rules. */
  customMedia?: boolean
|};

export type PseudoClasses = {|
  hover?: string,
  active?: string,
  focus?: string,
  focusVisible?: string,
  focusWithin?: string
|};

export type TransformResult = {|
  /** The transformed code. */
  code: Buffer,
  /** The generated source map, if enabled. */
  map: Buffer | void,
  /** CSS module exports, if enabled. */
  exports: CSSModuleExports | void,
  /** `@import` and `url()` dependencies, if enabled. */
  dependencies: Dependency[] | void
|};

export type CSSModuleExports = {
  /** Maps exported (i.e. original) names to local names. */
  [name: string]: CSSModuleExport
};

export type CSSModuleExport = {|
  /** The local (compiled) name for this export. */
  name: string,
  /** Whether the export is referenced in this file. */
  isReferenced: boolean,
  /** Other names that are composed by this export. */
  composes: CSSModuleReference[]
|};

export type CSSModuleReference = LocalCSSModuleReference | GlobalCSSModuleReference | DependencyCSSModuleReference;

export type LocalCSSModuleReference = {|
  type: 'local',
  /** The local (compiled) name for the reference. */
  name: string,
|};

export type GlobalCSSModuleReference = {|
  type: 'global',
  /** The referenced global name. */
  name: string,
|};

export type DependencyCSSModuleReference = {|
  type: 'dependency',
  /** The name to reference within the dependency. */
  name: string,
  /** The dependency specifier for the referenced file. */
  specifier: string
|};

export type Dependency = ImportDependency | UrlDependency;

export type ImportDependency = {|
  type: 'import',
  /** The url of the `@import` dependency. */
  url: string,
  /** The media query for the `@import` rule. */
  media: string | null,
  /** The `supports()` query for the `@import` rule. */
  supports: string | null,
  /** The source location where the `@import` rule was found. */
  loc: SourceLocation
|};

export type UrlDependency = {|
  type: 'url',
  /** The url of the dependency. */
  url: string,
  /** The source location where the `url()` was found. */
  loc: SourceLocation,
  /** The placeholder that the url was replaced with. */
  placeholder: string
|};

export type SourceLocation = {|
  /** The file path in which the dependency exists. */
  filePath: string,
  /** The start location of the dependency. */
  start: Location,
  /** The end location (inclusive) of the dependency. */
  end: Location
|};

export type Location = {|
  /** The line number (1-based). */
  line: number,
  /** The column number (0-based). */
  column: number
|};

/**
 * Compiles a CSS file, including optionally minifying and lowering syntax to the given
 * targets. A source map may also be generated, but this is not enabled by default.
 */
declare export function transform(options: TransformOptions): TransformResult;

export type TransformAttributeOptions = {|
  /** The source code to transform. */
  code: Buffer,
  /** Whether to enable minification. */
  minify?: boolean,
  /** The browser targets for the generated code. */
  targets?: Targets,
  /**
   * Whether to analyze `url()` dependencies.
   * When enabled, `url()` dependencies are replaced with hashed placeholders 
   * that can be replaced with the final urls later (after bundling).
   * Dependencies are returned as part of the result.
   */
   analyzeDependencies?: boolean
|};

export type TransformAttributeResult = {|
  /** The transformed code. */
  code: Buffer,
  /** `@import` and `url()` dependencies, if enabled. */
  dependencies: Dependency[] | void  
|};

/**
 * Compiles a single CSS declaration list, such as an inline style attribute in HTML.
 */
declare export function transformStyleAttribute(options: TransformAttributeOptions): TransformAttributeResult;

/**
 * Converts a browserslist result into targets that can be passed to @parcel/css.
 * @param browserslist the result of calling `browserslist`
 */
declare export function browserslistToTargets(browserslist: string[]): Targets;

/**
 * Bundles a CSS file and its dependencies, inlining @import rules.
 */
declare export function bundle(options: BundleOptions): TransformResult;