@rindo/core 1.8.12

package/dist/declarations/screenshots.d.ts

@@ -0,0 +1,192 @@
+import { Logger } from './logger';
+export interface ScreenshotConnector {
+    initBuild(opts: ScreenshotConnectorOptions): Promise<void>;
+    completeBuild(masterBuild: ScreenshotBuild): Promise<ScreenshotBuildResults>;
+    getMasterBuild(): Promise<ScreenshotBuild>;
+    pullMasterBuild(): Promise<void>;
+    publishBuild(buildResults: ScreenshotBuildResults): Promise<ScreenshotBuildResults>;
+    getScreenshotCache(): Promise<ScreenshotCache>;
+    updateScreenshotCache(screenshotCache: ScreenshotCache, buildResults: ScreenshotBuildResults): Promise<ScreenshotCache>;
+    generateJsonpDataUris(build: ScreenshotBuild): Promise<void>;
+    sortScreenshots(screenshots: Screenshot[]): Screenshot[];
+    toJson(masterBuild: ScreenshotBuild, screenshotCache: ScreenshotCache): string;
+}
+export interface ScreenshotBuildResults {
+    appNamespace: string;
+    masterBuild: ScreenshotBuild;
+    currentBuild: ScreenshotBuild;
+    compare: ScreenshotCompareResults;
+}
+export interface ScreenshotCompareResults {
+    id: string;
+    a: {
+        id: string;
+        message: string;
+        author: string;
+        url: string;
+        previewUrl: string;
+    };
+    b: {
+        id: string;
+        message: string;
+        author: string;
+        url: string;
+        previewUrl: string;
+    };
+    timestamp: number;
+    url: string;
+    appNamespace: string;
+    diffs: ScreenshotDiff[];
+}
+export interface ScreenshotConnectorOptions {
+    buildId: string;
+    buildMessage: string;
+    buildAuthor?: string;
+    buildUrl?: string;
+    previewUrl?: string;
+    appNamespace: string;
+    buildTimestamp: number;
+    logger: Logger;
+    rootDir: string;
+    cacheDir: string;
+    packageDir: string;
+    screenshotDirName?: string;
+    imagesDirName?: string;
+    buildsDirName?: string;
+    currentBuildDir?: string;
+    updateMaster?: boolean;
+    allowableMismatchedPixels?: number;
+    allowableMismatchedRatio?: number;
+    pixelmatchThreshold?: number;
+    waitBeforeScreenshot?: number;
+    pixelmatchModulePath?: string;
+}
+export interface ScreenshotBuildData {
+    buildId: string;
+    rootDir: string;
+    screenshotDir: string;
+    imagesDir: string;
+    buildsDir: string;
+    currentBuildDir: string;
+    updateMaster: boolean;
+    allowableMismatchedPixels: number;
+    allowableMismatchedRatio: number;
+    pixelmatchThreshold: number;
+    masterScreenshots: {
+        [screenshotId: string]: string;
+    };
+    cache: {
+        [cacheKey: string]: number;
+    };
+    timeoutBeforeScreenshot: number;
+    pixelmatchModulePath: string;
+}
+export interface PixelMatchInput {
+    imageAPath: string;
+    imageBPath: string;
+    width: number;
+    height: number;
+    pixelmatchThreshold: number;
+}
+export interface ScreenshotBuild {
+    id: string;
+    message: string;
+    author?: string;
+    url?: string;
+    previewUrl?: string;
+    appNamespace: string;
+    timestamp: number;
+    screenshots: Screenshot[];
+}
+export interface ScreenshotCache {
+    timestamp?: number;
+    lastBuildId?: string;
+    size?: number;
+    items?: {
+        /**
+         * Cache key
+         */
+        key: string;
+        /**
+         * Timestamp used to remove the oldest data
+         */
+        ts: number;
+        /**
+         * Mismatched pixels
+         */
+        mp: number;
+    }[];
+}
+export interface Screenshot {
+    id: string;
+    desc?: string;
+    image: string;
+    device?: string;
+    userAgent?: string;
+    width?: number;
+    height?: number;
+    deviceScaleFactor?: number;
+    hasTouch?: boolean;
+    isLandscape?: boolean;
+    isMobile?: boolean;
+    testPath?: string;
+    diff?: ScreenshotDiff;
+}
+export interface ScreenshotDiff {
+    mismatchedPixels: number;
+    id?: string;
+    desc?: string;
+    imageA?: string;
+    imageB?: string;
+    device?: string;
+    userAgent?: string;
+    width?: number;
+    height?: number;
+    deviceScaleFactor?: number;
+    hasTouch?: boolean;
+    isLandscape?: boolean;
+    isMobile?: boolean;
+    allowableMismatchedPixels: number;
+    allowableMismatchedRatio: number;
+    testPath?: string;
+    cacheKey?: string;
+}
+export interface ScreenshotOptions {
+    /**
+     * When true, takes a screenshot of the full scrollable page.
+     * Default: `false`
+     */
+    fullPage?: boolean;
+    /**
+     * An object which specifies clipping region of the page.
+     */
+    clip?: ScreenshotBoundingBox;
+    /**
+     * Hides default white background and allows capturing screenshots with transparency.
+     * Default: `false`
+     */
+    omitBackground?: boolean;
+    /**
+     * Matching threshold, ranges from `0` to 1. Smaller values make the comparison
+     * more sensitive. Defaults to the testing config `pixelmatchThreshold` value;
+     */
+    pixelmatchThreshold?: number;
+}
+export interface ScreenshotBoundingBox {
+    /**
+     * The x-coordinate of top-left corner.
+     */
+    x: number;
+    /**
+     * The y-coordinate of top-left corner.
+     */
+    y: number;
+    /**
+     * The width in pixels.
+     */
+    width: number;
+    /**
+     * The height in pixels.
+     */
+    height: number;
+}

package/dist/declarations/server.d.ts

@@ -0,0 +1,19 @@
+import { Config } from './config';
+import { Logger } from './logger';
+export interface ServerConfigInput {
+    app: ExpressApp;
+    configPath?: string;
+}
+export interface ServerConfigOutput {
+    config: Config;
+    logger: Logger;
+    wwwDir: string;
+    destroy?: () => void;
+}
+export interface ExpressApp {
+    use?: Function;
+}
+export interface MiddlewareConfig {
+    config: string | Config;
+    destroy?: () => void;
+}

package/dist/declarations/style.d.ts

@@ -0,0 +1,35 @@
+export interface StyleCompiler {
+    modeName: string;
+    styleId: string;
+    styleStr: string;
+    styleIdentifier: string;
+    externalStyles: ExternalStyleCompiler[];
+    compiledStyleText: string;
+    compiledStyleTextScoped: string;
+    compiledStyleTextScopedCommented: string;
+}
+export interface ExternalStyleCompiler {
+    absolutePath: string;
+    relativePath: string;
+    originalComponentPath: string;
+}
+export interface CompilerModeStyles {
+    [modeName: string]: string[];
+}
+export interface ModeStyles {
+    [modeName: string]: string | string[];
+}
+export interface CssImportData {
+    srcImport: string;
+    updatedImport?: string;
+    url: string;
+    filePath?: string;
+    altFilePath?: string;
+    styleText?: string;
+}
+export interface CssToEsmImportData {
+    srcImportText: string;
+    varName: string;
+    url: string;
+    filePath: string;
+}

package/dist/declarations/system.d.ts

@@ -0,0 +1,174 @@
+import { BuildEvents } from './build-events';
+import { CopyResults, CopyTask } from './assets';
+import { Config } from './config';
+import { Diagnostic } from './diagnostics';
+import { FileSystem } from './file-system';
+import { FsWatcher } from './fs-watch';
+import { Logger } from './logger';
+import { OptimizeCssInput, OptimizeCssOutput } from './optimize-css';
+import { PrerenderRequest, PrerenderResults } from './prerender';
+import { TranspileResults, ValidateTypesResults } from './transpile';
+import { WorkerOptions } from './worker';
+export interface RindoSystem {
+    cancelWorkerTasks?(): void;
+    compiler?: {
+        name: string;
+        version: string;
+        typescriptVersion?: string;
+        runtime?: string;
+        packageDir?: string;
+        distDir?: string;
+    };
+    copy?(copyTasks: Required<CopyTask>[], srcDir: string): Promise<CopyResults>;
+    color?: any;
+    cloneDocument?(doc: Document): Document;
+    createFsWatcher?(config: Config, fs: FileSystem, events: BuildEvents): Promise<FsWatcher>;
+    createDocument?(html: string): Document;
+    destroy?(): void;
+    addDestroy?(fn: Function): void;
+    details?: SystemDetails;
+    fs?: FileSystem;
+    generateContentHash?(content: string, length: number): Promise<string>;
+    getLatestCompilerVersion?(logger: Logger, forceCheck: boolean): Promise<string>;
+    getClientPath?(staticName: string): string;
+    getClientCoreFile?(opts: {
+        staticName: string;
+    }): Promise<string>;
+    glob?(pattern: string, options: {
+        cwd?: string;
+        nodir?: boolean;
+    }): Promise<string[]>;
+    initWorkers?(maxConcurrentWorkers: number, maxConcurrentTasksPerWorker: number, logger: Logger): WorkerOptions;
+    lazyRequire?: LazyRequire;
+    loadConfigFile?(configPath: string, process?: any): Config;
+    minifyJs?(input: string, opts?: any): Promise<{
+        output: string;
+        sourceMap?: any;
+        diagnostics?: Diagnostic[];
+    }>;
+    nextTick?(cb: Function): void;
+    open?: (url: string, opts?: any) => Promise<void>;
+    optimizeCss?(inputOpts: OptimizeCssInput): Promise<OptimizeCssOutput>;
+    path?: Path;
+    prerenderUrl?: (prerenderRequest: PrerenderRequest) => Promise<PrerenderResults>;
+    resolveModule?(fromDir: string, moduleId: string, opts?: ResolveModuleOptions): string;
+    rollup?: RollupInterface;
+    scopeCss?: (cssText: string, scopeId: string, commentOriginalSelector: boolean) => Promise<string>;
+    semver?: Semver;
+    serializeNodeToHtml?(elm: Element | Document): string;
+    storage?: Storage;
+    transpileToEs5?(cwd: string, input: string, inlineHelpers: boolean): Promise<TranspileResults>;
+    validateTypes?(compilerOptions: any, emitDtsFiles: boolean, collectionNames: string[], rootTsFiles: string[], isDevMode: boolean): Promise<ValidateTypesResults>;
+}
+export interface ResolveModuleOptions {
+    manuallyResolve?: boolean;
+}
+export interface RollupInterface {
+    rollup: {
+        (config: any): Promise<any>;
+    };
+    plugins: {
+        nodeResolve(opts: any): any;
+        replace(opts: any): any;
+        commonjs(opts: any): any;
+        json(): any;
+    };
+}
+export interface Semver {
+    lt(v1: string, v2: string): boolean;
+    lte(v1: string, v2: string): boolean;
+    gt(v1: string, v2: string): boolean;
+    gte(v1: string, v2: string): boolean;
+    prerelease(v: string): readonly string[] | null;
+    satisfies(version: string, range: string): boolean;
+}
+export interface LazyRequire {
+    ensure(logger: Logger, fromDir: string, moduleIds: string[]): Promise<void>;
+    require(moduleId: string): any;
+    getModulePath(moduleId: string): string;
+}
+export interface SystemDetails {
+    cpuModel: string;
+    cpus: number;
+    freemem(): number;
+    platform: string;
+    runtime: string;
+    runtimeVersion: string;
+    release: string;
+    totalmem: number;
+    tmpDir: string;
+}
+export interface Storage {
+    get(key: string): Promise<any>;
+    set(key: string, value: any): Promise<void>;
+}
+export interface Path {
+    basename(p: string, ext?: string): string;
+    dirname(p: string): string;
+    extname(p: string): string;
+    isAbsolute(p: string): boolean;
+    join(...paths: string[]): string;
+    parse(pathString: string): {
+        root: string;
+        dir: string;
+        base: string;
+        ext: string;
+        name: string;
+    };
+    relative(from: string, to: string): string;
+    resolve(...pathSegments: any[]): string;
+    sep: string;
+}
+export interface PackageJsonData {
+    name?: string;
+    version?: string;
+    main?: string;
+    description?: string;
+    bin?: {
+        [key: string]: string;
+    };
+    browser?: string;
+    module?: string;
+    'jsnext:main'?: string;
+    'collection:main'?: string;
+    unpkg?: string;
+    collection?: string;
+    types?: string;
+    files?: string[];
+    ['dist-tags']?: {
+        latest: string;
+    };
+    dependencies?: {
+        [moduleId: string]: string;
+    };
+    devDependencies?: {
+        [moduleId: string]: string;
+    };
+    lazyDependencies?: {
+        [moduleId: string]: string;
+    };
+    repository?: {
+        type?: string;
+        url?: string;
+    };
+}
+export interface Workbox {
+    generateSW(swConfig: any): Promise<any>;
+    generateFileManifest(): Promise<any>;
+    getFileManifestEntries(): Promise<any>;
+    injectManifest(swConfig: any): Promise<any>;
+    copyWorkboxLibraries(wwwDir: string): Promise<any>;
+}
+export interface Url {
+    href?: string;
+    protocol?: string;
+    auth?: string;
+    hostname?: string;
+    host?: string;
+    port?: string;
+    pathname?: string;
+    path?: string;
+    search?: string;
+    query?: string | any;
+    hash?: string;
+}