123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
// Copyright 2018-2021 the Deno authors. All rights reserved. MIT license.
import type { MediaType } from "./media_type.ts";
/** Additional meta data that is used to enrich the output of the module * graph. */export interface CacheInfo {  /** The string path to where the local version of the content is located. For   * non `file:` URLs, this is the location of the cached content, otherwise it   * is the absolute path to the local file. */  local?: string;  /** The string path to where a transpiled version of the source content is   * located, if any. */  emit?: string;  /** The string path to where an external source map of the transpiled source   * content is located, if any. */  map?: string;}
export interface TypesDependency {  /** The string URL to the type information for the module. */  types: string;  /** An optional range which indicates the source of the dependency. */  source?: Range;}
export interface LoadResponse {  /** The string URL of the resource. If there were redirects, the final   * specifier should be set here, otherwise the requested specifier. */  specifier: string;  /** For remote resources, a record of headers should be set, where the key's   * have been normalized to be lower case values. */  headers?: Record<string, string>;  /** The string value of the loaded resources. */  content: string;}
export interface PositionJson {  /** The line number of a position within a source file. The number is a zero   * based index. */  line: number;  /** The character number of a position within a source file. The number is a   * zero based index. */  character: number;}
export interface Range {  /** A string URL representing a source of a dependency. */  specifier: string;  /** The start location of a range of text in a source file. */  start?: PositionJson;  /** The end location of a range of text in a source file. */  end?: PositionJson;}
export interface RangeJson {  /** The start location of a range of text in a source file. */  start: PositionJson;  /** The end location of a range of text in a source file. */  end: PositionJson;}
export interface ResolvedDependency {  /** The fully resolved string URL of the dependency, which should be   * resolvable in the module graph. If there was an error, `error` will be set   * and this will be undefined. */  specifier?: string;  /** Any error encountered when trying to resolved the specifier. If this is   * defined, `specifier` will be undefined. */  error?: string;  /** The range within the source code where the specifier was identified. */  span: RangeJson;}
export interface TypesDependencyJson {  /** The string specifier that was used for the dependency. */  specifier: string;  /** An object pointing to the resolved dependency. */  dependency: ResolvedDependency;}
export interface DependencyJson {  /** The string specifier that was used for the dependency. */  specifier: string;  /** An object pointing to the resolved _code_ dependency. */  code?: ResolvedDependency;  /** An object pointing to the resolved _type_ dependency of a module. This is   * populated when the `@deno-types` directive was used to supply a type   * definition file for a dependency. */  type?: ResolvedDependency;  /** A flag indicating if the dependency was dynamic. (e.g.   * `await import("mod.ts")`) */  isDynamic?: true;}
export interface ModuleJson extends CacheInfo {  /** The string URL of the module. */  specifier: string;  /** Any error encountered when attempting to load the module. */  error?: string;  /** An array of dependencies that were identified in the module. */  dependencies?: DependencyJson[];  /** If the module had a types dependency, the information about that   * dependency. */  typesDependency?: TypesDependencyJson;  /** The resolved media type of the module, which determines how Deno will   * handle the module. */  mediaType?: MediaType;  /** The size of the source content of the module in bytes. */  size?: number;  /** If available, the calculated checksum of the module which can be used for   * validating the integrity of the module. */  checksum?: string;}
/** The plain-object representation of a module graph that is suitable for * serialization to JSON. */export interface ModuleGraphJson {  /** The module specifiers (URL string) of the _roots_ of the module graph of   * which the module graph was built for. */  roots: string[];  /** An array of modules that are part of the module graph. */  modules: ModuleJson[];  /** A record/map of any redirects encountered when resolving modules. The   * key was the requested module specifier and the value is the redirected   * module specifier. */  redirects: Record<string, string>;}
export interface Dependency {  /** An object pointing to the resolved _code_ dependency. */  code?: ResolvedDependency;  /** An object pointing to the resolved _type_ dependency of a module. This is   * populated when the `@deno-types` directive was used to supply a type   * definition file for a dependency. */  type?: ResolvedDependency;  /** A flag indicating if the dependency was dynamic. (e.g.   * `await import("mod.ts")`) */  isDynamic?: true;}
export class Module {  private constructor();
  /** Any cache information that was available on the module when the graph   * was built. */  readonly cacheInfo?: CacheInfo;  /** The calculated checksum of the source of the module if available when the   * graph was built. */  readonly checksum?: string;  /** A record of the dependencies, where the key is the string specifier of   * the dependency and the value is the dependency object. */  readonly dependencies?: Record<string, Dependency>;  /** The media type assigned to the module. This determines how Deno will   * handle the module. */  readonly mediaType: MediaType;  /** The size of the source content in bytes. */  readonly size: number;  /** The source content of the module. */  readonly source: string;  /** The fully qualified string URL of the module. */  readonly specifier: string;  /** The types dependency for the module, where the first value in the tuple   * was the string specifier used and the second value is the resolved   * dependency. */  readonly typesDependency?: [string, ResolvedDependency];
  /** Explicitly free the memory used by the module. */  free(): void;
  /** Returns a plain-object representation of the module suitable for   * serialization as JSON. */  toJSON(): ModuleJson;}
/** An interface to the web assembly structure of a built module graph. */export class ModuleGraph {  private constructor();
  /** The modules that are part of the module graph. */  readonly modules: Module[];
  /** The root specifiers that were used to build the module graph from. */  readonly roots: string[];
  /** Explicitly free the memory used by the module graph. The web assembly   * bindings does use weak references, meaning that the memory should be   * automatically garbage collected when the graph falls out of use. */  free(): void;
  /** Retrieve a module from the module graph, if an error was encountered when   * loading the module, this method will throw with that error. */  get(specifier: string): Module | undefined;
  /** Determine if the graph sources are valid by calling the passed `check()`   * function. If any of the modules in the graph fail the check, then an   * error is thrown. */  lock(): void;
  /** Given a string URL, return the resolved string URL accounting for any   * redirections that might have occurred when resolving the module graph. */  resolve(specifier: string): string;
  /** Given a string specifier of a module's dependency and the referring   * module's string URL, return the string URL of the dependency, otherwise   * return undefined. */  resolveDependency(specifier: string, referrer: string): string | undefined;
  /** Returns a plain-object representation of the module graph suitable for   * serialization as JSON, similar to the `deno info --json` output. */  toJSON(): ModuleGraphJson;
  /** Provides a string output representation of the module graph similar to   * `deno info` with or without ANSI color escape sequences. If `noColor` is   * expressly `true`, the string will be returned without color escape   * sequences. If `noColor` is expressly `false` the returned string will   * include ANSI color escape sequences. If not expressly set, `Deno.noColor`   * will be used, or if the `Deno` namespace isn't present, will default to   * `true` and not provide ANSI color escape sequences.   *   * @param noColor An optional flag indicating if ANSI color escape codes   *                should be included in the returned string. */  toString(noColor?: boolean): string;}