Very Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
/** * A JavaScript/TypeScript interface to the Deno CLI's module graph logic. * * ### Example * * To build and output a graph as a JSON structure to the console: * * ```ts * import { createGraph } from "https://deno.land/x/deno_graph@{VERSION}/mod.ts"; * * const graph = await createGraph("https://deno.land/x/std/testing/asserts.ts"); * * console.log(JSON.stringify(graph, undefined, " ")); * ``` * * @module */
import * as wasm from "./lib/deno_graph.generated.js";import { load as defaultLoad } from "./lib/loader.ts";import type { CacheInfo, LoadResponse, Module, ModuleGraph, ModuleKind, ResolveResult, TypesDependency,} from "./lib/types.d.ts";
export { load } from "./lib/loader.ts";export { MediaType } from "./lib/media_type.ts";export type { CacheInfo, Dependency, LoadResponse, Module, ModuleGraph, ModuleGraphJson, ModuleKind, ResolveResult, TypesDependency,} from "./lib/types.d.ts";
export interface CreateGraphOptions { /** * A callback that is called with the URL string of the resource to be loaded * and a flag indicating if the module was required dynamically. The callback * should resolve with a `LoadResponse` or `undefined` if the module is not * found. If there are other errors encountered, a rejected promise should be * returned. * * @param specifier The URL string of the resource to be loaded and resolved * @param isDynamic A flag that indicates if the module was being loaded * dynamically */ load?( specifier: string, isDynamic: boolean, ): Promise<LoadResponse | undefined>; /** The type of graph to build. `"all"` includes all dependencies of the * roots. `"typesOnly"` skips any code only dependencies that do not impact * the types of the graph, and `"codeOnly"` only includes dependencies that * are runnable code. */ kind?: "all" | "typesOnly" | "codeOnly"; /** The default jsxImportSource to use in JSX/TSX files when no * `@jsxImportSource` pragma is specified. In Deno, this is set to the * `compilerOptions.jsxImportSource` value if `compilerOptions.jsx` is set to * `react-jsx` or `react-jsxdev`. */ defaultJsxImportSource?: string; /** When identifying a `@jsxImportSource` pragma, what module name will be * appended to the import source. This defaults to `jsx-runtime`. */ jsxImportSourceModule?: string; /** An optional callback that will be called with a URL string of the resource * to provide additional meta data about the resource to enrich the module * graph. */ cacheInfo?(specifier: string): CacheInfo; /** An optional callback that allows the default resolution logic of the * module graph to be "overridden". This is intended to allow items like an * import map to be used with the module graph. The callback takes the string * of the module specifier from the referrer and the string URL of the * referrer. The callback then returns a fully qualified resolved URL string * specifier or an object which contains the URL string and the module kind. * If just the string is returned, the module kind is inferred to be ESM. */ resolve?(specifier: string, referrer: string): string | ResolveResult; /** An optional callback that can allow custom logic of how type dependencies * of a module to be provided. This will be called if a module is being added * to the graph that is is non-typed source code (e.g. JavaScript/JSX) and * allow resolution of a type only dependency for the module (e.g. `@types` * or a `.d.ts` file). */ resolveTypes?(specifier: string): TypesDependency | undefined; /** An optional callback that returns `true` if the sub-resource integrity of * the provided specifier and content is valid, otherwise `false`. This allows * for items like lock files to be applied to the module graph. */ check?(specifier: string, content: Uint8Array): boolean; /** An optional callback that returns the sub-resource integrity checksum for * a given set of content. */ getChecksum?(content: Uint8Array): string; /** An optional string to be used when generating an error when the integrity * check of the module graph fails. */ lockFilename?: string; /** An optional record of "injected" dependencies to the module graph. This * allows adding things like TypeScript's `"types"` values into the graph or * a JSX runtime. The key is the referrer specifier to use as a base when * resolving relative specifiers. The value is any module specifiers that are * being imported. */ imports?: Record<string, string[]>;}
/** Create a module graph using the same algorithms that are used in the Deno * CLI, resolving with the module graph for further processing. * * A default `load()` function is provided which will attempt to load local * modules via `Deno.readFile()` and will use `fetch()` to load remote * modules. An alternative `load()` function can be provided via the options. * * ### Example * * ```ts * import { createGraph } from "https://deno.land/x/deno_graph/mod.ts"; * * const graph = await createGraph("https://example.com/a.ts"); * * console.log(graph.toString()); * ``` * * @param rootSpecifier A URL string of the root module specifier to build the * graph from. * @param options A set of options for building the graph */export function createGraph( rootSpecifier: string, options?: CreateGraphOptions,): Promise<ModuleGraph>;/** Create a module graph using the same algorithms that are used in the Deno * CLI, resolving with the module graph for further processing. * * A default `load()` function is provided which will attempt to load local * modules via `Deno.readFile()` and will use `fetch()` to load remote * modules. An alternative `load()` function can be provided via the options. * * ### Example * * ```ts * import { createGraph } from "https://deno.land/x/deno_graph/mod.ts"; * * const graph = await createGraph([ * ["https://example.com/a.ts", "esm"], * ["https://example.com/a.ts", "esm"], * ]); * * console.log(graph.toJSON()); * ``` * * @param rootSpecifiers An array of URL strings or tuples of URL strings and * module kinds of the root module specifiers to build * the graph from. * @param options A set of options for building the graph */export function createGraph( rootSpecifiers: string[] | [string, ModuleKind][], options?: CreateGraphOptions,): Promise<ModuleGraph>;export async function createGraph( rootSpecifiers: string | string[] | [string, ModuleKind][], options: CreateGraphOptions = {},): Promise<ModuleGraph> { rootSpecifiers = Array.isArray(rootSpecifiers) ? rootSpecifiers : [rootSpecifiers]; const { load = defaultLoad, defaultJsxImportSource, jsxImportSourceModule, cacheInfo, resolve, resolveTypes, check, getChecksum, lockFilename, kind, imports, } = options; const { createGraph } = await wasm.instantiate(); return createGraph( rootSpecifiers, load, defaultJsxImportSource, jsxImportSourceModule, cacheInfo, resolve, resolveTypes, check, getChecksum, lockFilename, kind, imports, // deno-lint-ignore no-explicit-any ) as any;}
export interface ParseModuleOptions { /** 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 default jsxImportSource to use in JSX/TSX files when no * `@jsxImportSource` pragma is specified. In Deno, this is set to the * `compilerOptions.jsxImportSource` value if `compilerOptions.jsx` is set to * `react-jsx` or `react-jsxdev`. */ defaultJsxImportSource?: string; /** When identifying a `@jsxImportSource` pragma, what module name will be * appended to the import source. This defaults to `jsx-runtime`. */ jsxImportSourceModule?: string; /** The kind of module to set on the resulting parsed module. */ kind?: ModuleKind; /** An optional callback that allows the default resolution logic of the * module graph to be "overridden". This is intended to allow items like an * import map to be used with the module graph. The callback takes the string * of the module specifier from the referrer and the string URL of the * referrer. The callback then returns a fully qualified resolved URL string * specifier or an object which contains the URL string and the module kind. * If just the string is returned, the module kind is inferred to be ESM. */ resolve?(specifier: string, referrer: string): string | ResolveResult; /** An optional callback that can allow custom logic of how type dependencies * of a module to be provided. This will be called if a module is being added * to the graph that is is non-typed source code (e.g. JavaScript/JSX) and * allow resolution of a type only dependency for the module (e.g. `@types` * or a `.d.ts` file). */ resolveTypes?(specifier: string): string | undefined;}
/** Instantiates the Wasm module used within deno_graph. */export async function init() { await wasm.instantiate();}
/** Parse a module based on the supplied information and return its analyzed * representation. If an error is encountered when parsing, the function will * throw. * * @param specifier The URL text specifier to use when parsing the module. * @param content The content of the module to be parsed. * @param options Options to use when parsing the module. */export function parseModule( specifier: string, content: string, options: ParseModuleOptions = {},): Module { const { headers, defaultJsxImportSource, jsxImportSourceModule, kind, resolve, resolveTypes, } = options;
if (!wasm.isInstantiated()) { throw new Error( "Please call `init()` at least once before calling `parseModule`.", ); }
return wasm.parseModule( specifier, headers, defaultJsxImportSource, jsxImportSourceModule, content, kind, resolve, resolveTypes, ) as Module;}