@mawesome/npm-vm 0.0.0-stage → 0.1.0

package/dist/internal.d.cts

@@ -0,0 +1,139 @@
+import { _ as ParsedSpecs, b as parseVersionSpec, c as NpmVmError, d as RegistrySignature, f as Selection, g as OnFail, h as NpmSpec, i as ResolveSource, l as isNpmVmError, m as sriHex, n as ResolveProviders, o as resolveNpmWith, p as selectCandidate, r as ResolveResult, s as EXIT, t as ResolveOptions, u as Candidate, v as SpecError, x as OwnNpm, y as parseSpecs } from "./index-B071ZJDk.cjs";
+//#region src/state/lease.d.ts
+interface Lease {
+  path: string;
+  release(): void;
+}
+//#endregion
+//#region src/setup/home.d.ts
+interface MachineId {
+  /** sha256 of the platform id, first 16 hex chars (spec DIST-2). */
+  id: string;
+  /** True when only the hostname was available, which cloned machines can share. */
+  fallback: boolean;
+}
+/** Every directory the tool uses (spec DIST-1 and SET-1). */
+interface Dirs {
+  home: string;
+  cache: string;
+  state: string;
+  tmp: string;
+  journal: string;
+  machine: MachineId;
+}
+//#endregion
+//#region src/install/keys.d.ts
+/** A registry signing key as `https://registry.npmjs.org/-/npm/v1/keys` lists it (spec SEC-1). */
+interface RegistryKey {
+  keyid: string;
+  /** SPKI DER, base64. */
+  key: string;
+  expires: string | null;
+  /** A revoked key never verifies anything, whatever the dates say. */
+  revoked?: boolean;
+}
+//#endregion
+//#region src/install/cache.d.ts
+interface PublishedEntry {
+  entryPath: string;
+  lease: Lease;
+}
+//#endregion
+//#region src/install/fetch.d.ts
+/** One published version as `npm view` reports it. */
+interface RegistryVersion {
+  version: string;
+  enginesNode: string | null;
+  integrity: string;
+  tarball: string;
+  signatures: RegistrySignature[];
+  /** `dist.attestations.url`, present for packages published with provenance. */
+  attestationsUrl: string | null;
+}
+//#endregion
+//#region src/install/verify.d.ts
+interface Digests {
+  /** `sha512-<base64>`, the SRI form the registry uses. */
+  sha512: string;
+  sha512hex: string;
+  sha256hex: string;
+  sha224hex: string;
+}
+//#endregion
+//#region src/install/index.d.ts
+interface InstallContext {
+  dirs: Dirs;
+  own: OwnNpm | null;
+  env: NodeJS.ProcessEnv;
+  nodeVersion: string;
+  /** The Node that runs the transport and, through the shims, npm itself. */
+  nodePath: string;
+  keys: readonly RegistryKey[];
+}
+interface ContextNode {
+  /** The Node binary the shims resolve through PATH; the Action passes the one setup-node installed. */
+  execPath: string;
+  version: string;
+}
+export declare function createContext(env?: NodeJS.ProcessEnv, home?: string, node?: ContextNode): InstallContext;
+/** A downloaded tarball plus what the registry said about it, ready for verification. */
+interface PackedSource {
+  file: string;
+  published: RegistryVersion;
+  publishedAt: () => Promise<string | null>;
+  registry: string;
+}
+interface EnsureOptions {
+  /** Called with the verified tarball before it is extracted, so a caller can keep a copy (the Action's cache). */
+  onPacked?: (source: PackedSource, digests: Digests) => Promise<void>;
+  /** Never contact the registry; defaults to `NPM_VM_OFFLINE` in the context env. */
+  offline?: boolean;
+}
+interface Installer extends ResolveProviders {
+  /** Makes the selected npm runnable: validates a cached entry or downloads, verifies and publishes one (spec SEC-4, SEC-5). */
+  ensure(selection: Selection, options?: EnsureOptions): Promise<{
+    entryPath: string;
+    lease: Lease;
+  }>;
+  /** Verifies and publishes a tarball obtained elsewhere, such as a restored CI cache (spec SEC-1 to SEC-5). */
+  installTarball(selection: Selection, source: PackedSource): Promise<PublishedEntry>;
+  /** A short stable id of the configured registry, for cache keys that must not mix registries. */
+  registryIdentity(): Promise<string>;
+}
+export declare function createInstaller(context: InstallContext): Installer;
+//#endregion
+//#region src/commands/context.d.ts
+interface CommandIo {
+  out(text: string): void;
+  err(text: string): void;
+  /** Asks a yes/no question; a non-interactive session answers no. */
+  confirm(question: string): Promise<boolean>;
+  interactive: boolean;
+}
+//#endregion
+//#region src/commands/dispatch.d.ts
+interface DispatchOptions {
+  /** The home the launcher runs from; the bin entry leaves it to the env and defaults. */
+  home?: string;
+  io?: CommandIo;
+  env?: NodeJS.ProcessEnv;
+}
+declare function run(argv: string[], options: DispatchOptions): Promise<number>;
+//#endregion
+//#region src/project.d.ts
+interface ProjectLocation {
+  /** npm's `localPrefix` for this argv and cwd (spec RES-2). */
+  root: string;
+  /** Global mode, computed as npm does (spec RES-3). */
+  global: boolean;
+  /** The `--prefix` the command line carries, resolved, when it carries one. */
+  cliPrefix: string | null;
+}
+/**
+ * Mirrors `@npmcli/config` `loadLocalPrefix` (spec RES-2): a CLI prefix is final.
+ * Otherwise the nearest ancestor with `package.json` or `node_modules` wins, promoted to a parent whose `workspaces` include it unless `--no-workspaces` or global mode.
+ */
+export declare function findProject(argv: readonly string[], cwd: string, env?: NodeJS.ProcessEnv): ProjectLocation;
+//#endregion
+export { type Candidate, type CommandIo, type DispatchOptions, EXIT, type EnsureOptions, type InstallContext, type Installer, type NpmSpec, NpmVmError, type OnFail, type PackedSource, type ParsedSpecs, type ResolveOptions, type ResolveProviders, type ResolveResult, type ResolveSource, type Selection, SpecError, isNpmVmError, parseSpecs, parseVersionSpec, resolveNpmWith, run as runCommand, selectCandidate, sriHex };
+//# sourceMappingURL=internal.d.cts.map

package/dist/internal.d.ts

@@ -0,0 +1,139 @@
+import { _ as ParsedSpecs, b as parseVersionSpec, c as NpmVmError, d as RegistrySignature, f as Selection, g as OnFail, h as NpmSpec, i as ResolveSource, l as isNpmVmError, m as sriHex, n as ResolveProviders, o as resolveNpmWith, p as selectCandidate, r as ResolveResult, s as EXIT, t as ResolveOptions, u as Candidate, v as SpecError, x as OwnNpm, y as parseSpecs } from "./index-B071ZJDk.js";
+//#region src/state/lease.d.ts
+interface Lease {
+  path: string;
+  release(): void;
+}
+//#endregion
+//#region src/setup/home.d.ts
+interface MachineId {
+  /** sha256 of the platform id, first 16 hex chars (spec DIST-2). */
+  id: string;
+  /** True when only the hostname was available, which cloned machines can share. */
+  fallback: boolean;
+}
+/** Every directory the tool uses (spec DIST-1 and SET-1). */
+interface Dirs {
+  home: string;
+  cache: string;
+  state: string;
+  tmp: string;
+  journal: string;
+  machine: MachineId;
+}
+//#endregion
+//#region src/install/keys.d.ts
+/** A registry signing key as `https://registry.npmjs.org/-/npm/v1/keys` lists it (spec SEC-1). */
+interface RegistryKey {
+  keyid: string;
+  /** SPKI DER, base64. */
+  key: string;
+  expires: string | null;
+  /** A revoked key never verifies anything, whatever the dates say. */
+  revoked?: boolean;
+}
+//#endregion
+//#region src/install/cache.d.ts
+interface PublishedEntry {
+  entryPath: string;
+  lease: Lease;
+}
+//#endregion
+//#region src/install/fetch.d.ts
+/** One published version as `npm view` reports it. */
+interface RegistryVersion {
+  version: string;
+  enginesNode: string | null;
+  integrity: string;
+  tarball: string;
+  signatures: RegistrySignature[];
+  /** `dist.attestations.url`, present for packages published with provenance. */
+  attestationsUrl: string | null;
+}
+//#endregion
+//#region src/install/verify.d.ts
+interface Digests {
+  /** `sha512-<base64>`, the SRI form the registry uses. */
+  sha512: string;
+  sha512hex: string;
+  sha256hex: string;
+  sha224hex: string;
+}
+//#endregion
+//#region src/install/index.d.ts
+interface InstallContext {
+  dirs: Dirs;
+  own: OwnNpm | null;
+  env: NodeJS.ProcessEnv;
+  nodeVersion: string;
+  /** The Node that runs the transport and, through the shims, npm itself. */
+  nodePath: string;
+  keys: readonly RegistryKey[];
+}
+interface ContextNode {
+  /** The Node binary the shims resolve through PATH; the Action passes the one setup-node installed. */
+  execPath: string;
+  version: string;
+}
+export declare function createContext(env?: NodeJS.ProcessEnv, home?: string, node?: ContextNode): InstallContext;
+/** A downloaded tarball plus what the registry said about it, ready for verification. */
+interface PackedSource {
+  file: string;
+  published: RegistryVersion;
+  publishedAt: () => Promise<string | null>;
+  registry: string;
+}
+interface EnsureOptions {
+  /** Called with the verified tarball before it is extracted, so a caller can keep a copy (the Action's cache). */
+  onPacked?: (source: PackedSource, digests: Digests) => Promise<void>;
+  /** Never contact the registry; defaults to `NPM_VM_OFFLINE` in the context env. */
+  offline?: boolean;
+}
+interface Installer extends ResolveProviders {
+  /** Makes the selected npm runnable: validates a cached entry or downloads, verifies and publishes one (spec SEC-4, SEC-5). */
+  ensure(selection: Selection, options?: EnsureOptions): Promise<{
+    entryPath: string;
+    lease: Lease;
+  }>;
+  /** Verifies and publishes a tarball obtained elsewhere, such as a restored CI cache (spec SEC-1 to SEC-5). */
+  installTarball(selection: Selection, source: PackedSource): Promise<PublishedEntry>;
+  /** A short stable id of the configured registry, for cache keys that must not mix registries. */
+  registryIdentity(): Promise<string>;
+}
+export declare function createInstaller(context: InstallContext): Installer;
+//#endregion
+//#region src/commands/context.d.ts
+interface CommandIo {
+  out(text: string): void;
+  err(text: string): void;
+  /** Asks a yes/no question; a non-interactive session answers no. */
+  confirm(question: string): Promise<boolean>;
+  interactive: boolean;
+}
+//#endregion
+//#region src/commands/dispatch.d.ts
+interface DispatchOptions {
+  /** The home the launcher runs from; the bin entry leaves it to the env and defaults. */
+  home?: string;
+  io?: CommandIo;
+  env?: NodeJS.ProcessEnv;
+}
+declare function run(argv: string[], options: DispatchOptions): Promise<number>;
+//#endregion
+//#region src/project.d.ts
+interface ProjectLocation {
+  /** npm's `localPrefix` for this argv and cwd (spec RES-2). */
+  root: string;
+  /** Global mode, computed as npm does (spec RES-3). */
+  global: boolean;
+  /** The `--prefix` the command line carries, resolved, when it carries one. */
+  cliPrefix: string | null;
+}
+/**
+ * Mirrors `@npmcli/config` `loadLocalPrefix` (spec RES-2): a CLI prefix is final.
+ * Otherwise the nearest ancestor with `package.json` or `node_modules` wins, promoted to a parent whose `workspaces` include it unless `--no-workspaces` or global mode.
+ */
+export declare function findProject(argv: readonly string[], cwd: string, env?: NodeJS.ProcessEnv): ProjectLocation;
+//#endregion
+export { type Candidate, type CommandIo, type DispatchOptions, EXIT, type EnsureOptions, type InstallContext, type Installer, type NpmSpec, NpmVmError, type OnFail, type PackedSource, type ParsedSpecs, type ResolveOptions, type ResolveProviders, type ResolveResult, type ResolveSource, type Selection, SpecError, isNpmVmError, parseSpecs, parseVersionSpec, resolveNpmWith, run as runCommand, selectCandidate, sriHex };
+//# sourceMappingURL=internal.d.ts.map