piral-cli/lib/types/internal.d.ts

The standard CLI for creating and building a Piral instance or a Pilet.

import type { LogLevels } from './common';
import type { ImportmapVersions, NpmClientType, NpmDirectClientType, NpmWapperClientType, PiletSchemaVersion } from './public';
export interface PiralInstanceDetails {
    selected?: boolean;
    port?: number;
    path?: string;
    url?: string;
}
/**
 * Shape of the pilet.json
 */
export interface PiletDefinition {
    schemaVersion?: PiletSchemaVersion;
    importmapVersions?: ImportmapVersions;
    piralInstances?: Record<string, PiralInstanceDetails>;
}
export interface PackageFiles {
    [file: string]: Buffer;
}
export interface FileInfo {
    path: string;
    hash: string;
    changed: boolean;
}
/**
 * The error message tuple. Consists of
 * 0. The log level
 * 1. The unique error code
 * 2. The (short) error message
 */
export type QuickMessage = [LogLevels, string, string];
/**
 * Result of identifying an npm client in a project.
 */
export interface NpmClient {
    /**
     * The proposed client - can be anything.
     */
    proposed?: NpmClientType;
    /**
     * The direct npm client.
     */
    direct: NpmDirectClientType;
    /**
     * The wrapper npm client, if any.
     */
    wrapper?: NpmWapperClientType;
    /**
     * Determines the root directory if the client is curently operating in a monorepo.
     */
    monorepo?: string;
}