@powerlines/core 0.15.0 → 0.15.1

package/dist/context/context.d.mts

@@ -0,0 +1,369 @@
+import { ResolveOptions, VirtualFile, VirtualFileSystemInterface } from "../types/fs.mjs";
+import { CallHookOptions, InferHookParameters, InferHookReturnType } from "../types/hooks.mjs";
+import { LogLevelResolvedConfig, Logger, LoggerOptions } from "../types/logging.mjs";
+import { ParsedTypeScriptConfig } from "../types/tsconfig.mjs";
+import { Context, EmitEntryOptions, EmitOptions, EnvironmentContext, FetchOptions, MetaInfo, ParseOptions, PluginContext, ResolveResult, Resolver, TransformResult } from "../types/context.mjs";
+import { ExecutionOptions, InferOverridableConfig, ParsedUserConfig, ResolvedConfig, ResolvedEntryTypeDefinition } from "../types/config.mjs";
+import { PowerlinesBaseContext } from "./base-context.mjs";
+import { EnvPaths } from "@stryke/env/get-env-paths";
+import { FlatCache } from "flat-cache";
+import { ParseResult } from "oxc-parser";
+import { RequestInfo, Response } from "undici";
+import { PackageJson } from "@stryke/types/package-json";
+import { Range } from "semver";
+
+//#region src/context/context.d.ts
+declare class PowerlinesContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig, TSystemContext = unknown> extends PowerlinesBaseContext<TSystemContext> implements Context<TResolvedConfig, TSystemContext> {
+  #private;
+  options: ExecutionOptions;
+  resolver: Resolver;
+  /**
+   * The parsed `package.json` file for the project
+   */
+  packageJson: PackageJson;
+  /**
+   * The parsed `project.json` file for the project
+   */
+  projectJson: Record<string, any> | undefined;
+  /**
+   * The parsed configuration file for the project
+   */
+  configFile: ParsedUserConfig;
+  /**
+   * An object containing the dependencies that should be installed for the project
+   */
+  dependencies: Record<string, string | Range>;
+  /**
+   * An object containing the development dependencies that should be installed for the project
+   */
+  devDependencies: Record<string, string | Range>;
+  /**
+   * The persisted meta information about the current build
+   */
+  persistedMeta: MetaInfo | undefined;
+  /**
+   * The resolved tsconfig file paths for the project
+   */
+  resolvePatterns: RegExp[];
+  /**
+   * The resolved configuration for this context
+   */
+  protected resolvedConfig: TResolvedConfig;
+  /**
+   * The configuration options that were overridden by plugins during the build process, which may include additional properties or modifications made during the configuration loading process.
+   */
+  protected overriddenConfig: InferOverridableConfig<TResolvedConfig>;
+  /**
+   * The configuration options provided inline during execution, such as CLI flags or other parameters that may be relevant to the command being executed. These options can be used to override or supplement the configuration options defined in a configuration file on disk, and are typically provided as part of the execution context when running a Powerlines command.
+   */
+  protected inlineConfig: TResolvedConfig["inlineConfig"];
+  /**
+   * The configuration options read from a configuration file on disk, which may be used to resolve the final configuration for the context. This typically includes the user configuration options defined in the `powerlines.config.ts` file, as well as any inline configuration options provided during execution.
+   */
+  protected userConfig: TResolvedConfig["userConfig"];
+  /**
+   * The configuration options provided by plugins added by the user (and other plugins)
+   */
+  protected pluginConfig: TResolvedConfig["pluginConfig"];
+  /**
+   * The configuration options provided by the environment
+   */
+  protected environmentConfig: any;
+  /**
+   * The resolved entry type definitions for the project
+   */
+  get entry(): ResolvedEntryTypeDefinition[];
+  /**
+   * The TypeScript configuration parsed from the tsconfig file
+   */
+  get tsconfig(): ParsedTypeScriptConfig;
+  /**
+   * Sets the TypeScript configuration parsed from the tsconfig file
+   */
+  set tsconfig(value: ParsedTypeScriptConfig);
+  /**
+   * The virtual file system interface for the project
+   */
+  get fs(): VirtualFileSystemInterface;
+  /**
+   * Get the checksum of the project's current state
+   */
+  get checksum(): string | null;
+  /**
+   * Invokes the configured plugin hooks
+   *
+   * @remarks
+   * By default, it will call the `"pre"`, `"normal"`, and `"post"` ordered hooks in sequence
+   *
+   * @param hook - The hook to call
+   * @param options - The options to provide to the hook
+   * @param args - The arguments to pass to the hook
+   * @returns The result of the hook call
+   */
+  callHook: <TKey extends string>(hook: TKey, options: CallHookOptions & {
+    environment?: string | EnvironmentContext<any>;
+  }, ...args: InferHookParameters<PluginContext<any>, TKey>) => Promise<InferHookReturnType<PluginContext<any>, TKey> | undefined>;
+  /**
+   * The meta information about the current build
+   */
+  get meta(): MetaInfo;
+  /**
+   * The resolved configuration options
+   */
+  get config(): TResolvedConfig;
+  /**
+   * Get the path to the artifacts directory for the project
+   */
+  get artifactsPath(): string;
+  /**
+   * Get the path to the builtin modules used by the project
+   */
+  get builtinsPath(): string;
+  /**
+   * Get the path to the entry directory for the project
+   */
+  get entryPath(): string;
+  /**
+   * Get the path to the infrastructure modules used by the project
+   */
+  get infrastructurePath(): string;
+  /**
+   * Get the path to the data directory for the project
+   */
+  get dataPath(): string;
+  /**
+   * Get the path to the cache directory for the project
+   */
+  get cachePath(): string;
+  /**
+   * Get the path to the generated declaration file for the project
+   */
+  get typesPath(): string;
+  /**
+   * Get the project root relative to the workspace root
+   */
+  get relativeToWorkspaceRoot(): string;
+  /**
+   * The builtin module id that exist in the Powerlines virtual file system
+   */
+  get builtins(): string[];
+  /**
+   * Additional arguments provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed.
+   */
+  get additionalArgs(): Record<string, string | string[]>;
+  /**
+   * The alias mappings for the project used during module resolution
+   *
+   * @remarks
+   * This includes both the built-in module aliases as well as any custom aliases defined in the build configuration.
+   */
+  get alias(): Record<string, string>;
+  get logger(): Logger;
+  /**
+   * The log level for the context, which determines the minimum level of log messages that will be emitted by the logger. This is resolved based on the configuration options provided by the user, and can be set to different levels for development, production, and test environments. The log level can also be overridden by plugins or other parts of the build process to provide more granular control over logging output.
+   */
+  get logLevel(): LogLevelResolvedConfig;
+  /**
+   * The environment paths for the project, which provide the locations of various directories and files used by the Powerlines framework. These paths are resolved based on the organization ID, application ID, and workspace root directory, and can be used to access configuration files, cache directories, and other resources in a consistent manner.
+   */
+  get envPaths(): EnvPaths;
+  /**
+   * Gets the parser cache.
+   */
+  protected get parserCache(): FlatCache;
+  /**
+   * Gets the request cache.
+   */
+  protected get requestCache(): FlatCache;
+  /**
+   * The entry points that exist in the Powerlines virtual file system
+   */
+  protected get resolvedEntry(): ResolvedEntryTypeDefinition[];
+  /**
+   * Creates a new Context instance.
+   *
+   * @param options - The options to use for creating the context, including the resolved configuration and workspace settings.
+   */
+  protected constructor(options: ExecutionOptions);
+  createLogger(options?: LoggerOptions): Logger;
+  /**
+   * A function to perform HTTP fetch requests
+   *
+   * @remarks
+   * This function uses a caching layer to avoid duplicate requests during the Powerlines process.
+   *
+   * @example
+   * ```ts
+   * const response = await context.fetch("https://api.example.com/data");
+   * const data = await response.json();
+   * ```
+   *
+   * @see https://github.com/nodejs/undici
+   *
+   * @param input - The URL to fetch.
+   * @param options - The fetch request options.
+   * @returns A promise that resolves to a response returned by the fetch.
+   */
+  fetch(input: RequestInfo, options?: FetchOptions): Promise<Response>;
+  /**
+   * Parse code using [Oxc-Parser](https://github.com/oxc/oxc) into an (ESTree-compatible)[https://github.com/estree/estree] AST object.
+   *
+   * @remarks
+   * This function can be used to parse TypeScript code into an AST for further analysis or transformation.
+   *
+   * @example
+   * ```ts
+   * const ast = context.parse("const x: number = 42;");
+   * ```
+   *
+   * @see https://rollupjs.org/plugin-development/#this-parse
+   * @see https://github.com/oxc/oxc
+   *
+   * @param code - The source code to parse.
+   * @param options - The options to pass to the parser.
+   * @returns An (ESTree-compatible)[https://github.com/estree/estree] AST object.
+   */
+  parse(code: string, options?: ParseOptions): Promise<ParseResult>;
+  /**
+   * A helper function to resolve modules in the Virtual File System
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolved = await context.resolve("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns A promise that resolves to the resolved module path.
+   */
+  resolve(id: string, importer?: string, options?: ResolveOptions): Promise<ResolveResult | undefined>;
+  /**
+   * A helper function to load modules from the Virtual File System
+   *
+   * @remarks
+   * This function can be used to load modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const module = await context.load("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to load.
+   * @returns A promise that resolves to the loaded module.
+   */
+  load(id: string): Promise<TransformResult | undefined>;
+  /**
+   * Get the builtin virtual files that exist in the Powerlines virtual file system
+   */
+  getBuiltins(): Promise<VirtualFile[]>;
+  /**
+   * Resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emit(code: string, path: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emitSync(code: string, path: string, options?: EmitOptions): void;
+  /**
+   * Resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - A path to write the entry file to
+   * @param options - Optional write file options
+   */
+  emitEntry(code: string, path: string, options?: EmitEntryOptions): Promise<void>;
+  /**
+   * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - A path to write the entry file to
+   * @param options - Optional write file options
+   */
+  emitEntrySync(code: string, path: string, options?: EmitEntryOptions): void;
+  /**
+   * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitBuiltin(code: string, id: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitBuiltinSync(code: string, id: string, options?: EmitOptions): void;
+  /**
+   * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitInfrastructure(code: string, id: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves an infrastructure virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the infrastructure file
+   * @param id - The unique identifier of the infrastructure file
+   * @param options - Optional write file options
+   */
+  emitInfrastructureSync(code: string, id: string, options?: EmitOptions): void;
+  /**
+   * Generates a checksum representing the current context state
+   *
+   * @param path - The root directory of the project to generate the checksum for
+   * @returns A promise that resolves to a string representing the checksum
+   */
+  generateChecksum(path?: string): Promise<string>;
+  /**
+   * A setter function to populate the inline config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the inline configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any inline configuration provided during execution.
+   *
+   * @param config - The inline configuration values to set.
+   * @returns A promise that resolves when the inline configuration values have been set.
+   */
+  setInlineConfig(config: TResolvedConfig["inlineConfig"]): Promise<void>;
+  /**
+   * A setter function to populate the plugin config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the plugin configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any plugin configuration provided during execution.
+   *
+   * @param config - The plugin configuration values to set.
+   * @returns A promise that resolves when the plugin configuration values have been set.
+   */
+  setPluginConfig(config: TResolvedConfig["pluginConfig"]): Promise<void>;
+  /**
+   * A function to merge the various configuration objects (initial, user, inline, and plugin) into a single resolved configuration object that can be used throughout the Powerlines process. This function takes into account the different sources of configuration and their respective priorities, ensuring that the final configuration reflects the intended settings for the project. The merged configuration is then returned as a new object that can be accessed through the `config` property of the context.
+   *
+   * @returns The merged configuration object that combines the initial, user, inline, and plugin configurations.
+   */
+  protected mergeConfig(): TResolvedConfig;
+  /**
+   * A setter function to populate the user config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the user configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any inline configuration provided during execution.
+   *
+   * @param config - The user configuration values to set.
+   * @returns A promise that resolves when the user configuration values have been set.
+   */
+  protected setUserConfig(config: TResolvedConfig["userConfig"]): Promise<void>;
+  /**
+   * Initialize the context with the provided configuration options
+   */
+  protected resolveConfig(): Promise<void>;
+  private createConfigProxy;
+}
+//#endregion
+export { PowerlinesContext };
+//# sourceMappingURL=context.d.mts.map

package/dist/context/context.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.mts","names":[],"sources":["../../src/context/context.ts"],"mappings":";;;;;;;;;;;;;;;cA8Ja,iBAAA,yBACa,cAAA,GAAiB,cAAA,oCAGjC,qBAAA,CAAsB,cAAA,aACnB,OAAA,CAAQ,eAAA,EAAiB,cAAA;EAAA;EA+cE,OAAA,EAAS,gBAAA;EA7bxC,QAAA,EAAW,QAAA;EAvBU;;;EA4BrB,WAAA,EAAc,WAAA;EAvBF;;;EA4BZ,WAAA,EAAa,MAAA;EALC;;;EAUd,UAAA,EAAa,gBAAA;EAKC;;;EAAd,YAAA,EAAc,MAAA,kBAAwB,KAAA;EAerB;;;EAVjB,eAAA,EAAiB,MAAA,kBAAwB,KAAA;EA0BxB;;;EArBjB,aAAA,EAAe,QAAA;EA6DC;;;EAxDhB,eAAA,EAAiB,MAAA;EAyGb;;;EAAA,UApGD,cAAA,EAAgB,eAAA;EAuGf;;;EAAA,UAlGD,gBAAA,EAAkB,sBAAA,CAAuB,eAAA;EAmGhD;;;EAAA,UA7FO,YAAA,EAAc,eAAA;EAqQJ;;;EAAA,UA/PV,UAAA,EAAY,eAAA;EAwTO;;;EAAA,UAlTnB,YAAA,EAAc,eAAA;EAkYc;;;EAAA,UA7X5B,iBAAA;EA6ZC;;;EAAA,IAxZA,KAAA,CAAA,GAAS,2BAAA;EAifuC;;;EAAA,IA/dhD,QAAA,CAAA,GAAY,sBAAA;EAyoBgB;;;EAAA,IA5nB5B,QAAA,CAAS,KAAA,EAAO,sBAAA;EAoqBhB;;;EAAA,IA5pBA,EAAA,CAAA,GAAM,0BAAA;EAyuBd;;;EAAA,IA9tBQ,QAAA,CAAA;EA2zB+C;;;;;;;;;;;EA5yBnD,QAAA,wBACL,IAAA,EAAM,IAAA,EACN,OAAA,EAAS,eAAA;IACP,WAAA,YAAuB,kBAAA;EAAA,MAEtB,IAAA,EAAM,mBAAA,CAAoB,aAAA,OAAoB,IAAA,MAChD,OAAA,CAAQ,mBAAA,CAAoB,aAAA,OAAoB,IAAA;EAlKxC;;;EAAA,IA6KA,IAAA,CAAA,GAkBJ,QAAA;EAnMiB;;;EAAA,IAyMb,MAAA,CAAA,GAAU,eAAA;EAtMS;;;EAAA,IAiNnB,aAAA,CAAA;;;;MAYA,YAAA,CAAA;EA1MO;;;EAAA,IAiNP,SAAA,CAAA;EAvMS;;;EAAA,IA8MT,kBAAA,CAAA;EApMU;;;EAAA,IA2MV,QAAA,CAAA;EAtMqC;;;EAAA,IAiNrC,SAAA,CAAA;EAvMa;;;EAAA,IA0Nb,SAAA,CAAA;EAhNiB;;;EAAA,IAyNjB,uBAAA,CAAA;EA7MD;;;EAAA,IAoNC,QAAA,CAAA;EAzMD;;;EAAA,IAmNC,cAAA,CAAA,GAAkB,MAAA;EA5LN;;;;;;EAAA,IA6NZ,KAAA,CAAA,GAAS,MAAA;EAAA,IAgCA,MAAA,CAAA,GAAU,MAAA;EA9ML;;;EAAA,IAqNd,QAAA,CAAA,GAAY,sBAAA;EAlNnB;;;EAAA,IAyNgB,QAAA,CAAA,GAAY,QAAA;EAvNrB;;;EAAA,cAkOG,WAAA,CAAA,GAAe,SAAA;EAjOlB;;;EAAA,cAkPG,YAAA,CAAA,GAAgB,SAAA;EArNvB;;;EAAA,cAsOO,aAAA,CAAA,GAAiB,2BAAA;EAzMpB;;;;;EAAA,UAmPF,WAAA,CAA6B,OAAA,EAAS,gBAAA;EAI/B,YAAA,CAAa,OAAA,GAAS,aAAA,GAAkB,MAAA;EApL7C;;;;;;;;;;;;;;;;;;EAiNE,KAAA,CACX,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA,CAAQ,QAAA;EApC2B;;;;;;;;;;;;;;;;;;EA6HzB,KAAA,CAAM,IAAA,UAAc,OAAA,GAAS,YAAA,GAAiB,OAAA,CAAA,WAAA;EA4CzD;;;;;;;;;;;;;;;;EADW,OAAA,CACX,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA,GACR,OAAA,CAAQ,aAAA;EAmKT;;;;;;;;;;;;;;EAxCW,IAAA,CAAK,EAAA,WAAa,OAAA,CAAQ,eAAA;EAoJrC;;;EAnIW,WAAA,CAAA,GAAW,OAAA,CAAA,WAAA;EAmKtB;;;;;;;EA/IW,IAAA,CACX,IAAA,UACA,IAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;EAyKuD;;;;;;;EArInD,QAAA,CAAS,IAAA,UAAc,IAAA,UAAc,OAAA,GAAS,WAAA;EA+L9C;;;;;;;EA3JM,SAAA,CACX,IAAA,UACA,IAAA,UACA,OAAA,GAAS,gBAAA,GACR,OAAA;EAiMU;;;;;;;EApKN,aAAA,CACL,IAAA,UACA,IAAA,UACA,OAAA,GAAS,gBAAA;EA0OD;;;;;;;EA5MG,WAAA,CACX,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;EAmlBK;;;;;;;EAxjBD,eAAA,CAAgB,IAAA,UAAc,EAAA,UAAY,OAAA,GAAS,WAAA;;;;;;;;EA2B7C,kBAAA,CACX,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;;;;;;;;EA2BI,sBAAA,CACL,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA;;;;;;;EA2BE,gBAAA,CAAiB,IAAA,YAAgB,OAAA;;;;;;;EAYjC,eAAA,CACX,MAAA,EAAQ,eAAA,mBACP,OAAA;;;;;;;EAsDU,eAAA,CACX,MAAA,EAAQ,eAAA,mBACP,OAAA;;;;;;YAeO,WAAA,CAAA,GAAe,eAAA;;;;;;;YA4BT,aAAA,CACd,MAAA,EAAQ,eAAA,iBACP,OAAA;;;;YAaa,aAAA,CAAA,GAAiB,OAAA;EAAA,QAgWzB,iBAAA;AAAA"}