@eik/common 4.0.0-next.4 → 4.0.0-next.7

package/types/classes/multiple-config-sources-error.d.ts

@@ -1,9 +0,0 @@
-export = MultipleConfigSourcesError;
-declare const MultipleConfigSourcesError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class MultipleConfigSourcesError extends MultipleConfigSourcesError_base {
-}

package/types/classes/no-files-matched-error.d.ts

@@ -1,13 +0,0 @@
-export = NoFilesMatchedError;
-declare const NoFilesMatchedError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class NoFilesMatchedError extends NoFilesMatchedError_base {
-    /**
-     * @param {string} file
-     */
-    constructor(file: string);
-}

package/types/classes/read-file.d.ts

@@ -1,15 +0,0 @@
-export = ReadFile;
-declare const ReadFile: {
-    new ({ mimeType, etag }?: {
-        mimeType?: string;
-        etag?: string;
-    }): {
-        _mimeType: string;
-        _stream: any;
-        _etag: string;
-        readonly mimeType: string;
-        stream: any;
-        readonly etag: string;
-        readonly [Symbol.toStringTag]: string;
-    };
-};

package/types/classes/remote-file-location.d.ts

@@ -1,21 +0,0 @@
-export = RemoteFileLocation;
-declare class RemoteFileLocation {
-    /**
-     * @param {string} filePathname pathname for file relative to package root eg. /folder/client.js
-     * @param {string} packagePathname pathname for package root eg. /pkg/my-pack/1.0.0
-     * @param {string} origin server origin eg. https://server.com
-     */
-    constructor(filePathname: string, packagePathname: string, origin: string);
-    /**
-     * @type {string} pathname to package root
-     */
-    packagePathname: string;
-    /**
-     * @type {string} pathname to file relative to package root
-     */
-    filePathname: string;
-    /**
-     * @type {URL} WHATWG URL object containing the full remote URL for the file
-     */
-    url: URL;
-}

package/types/classes/resolved-files.d.ts

@@ -1,19 +0,0 @@
-export = ResolvedFiles;
-declare class ResolvedFiles {
-    /**
-     * @param {string[]} files
-     * @param {{definition: [string, string], basePath: string, pattern: string}} meta
-     */
-    constructor(files: string[], meta: {
-        definition: [string, string];
-        basePath: string;
-        pattern: string;
-    });
-    destination: string;
-    source: string;
-    basePath: string;
-    pattern: string;
-    [Symbol.iterator](): Generator<import("./local-file-location"), void, unknown>;
-    [originalFiles]: string[];
-}
-declare const originalFiles: unique symbol;

package/types/classes/single-dest-multiple-source-error.d.ts

@@ -1,13 +0,0 @@
-export = SingleDestMultipleSourcesError;
-declare const SingleDestMultipleSourcesError_base: {
-    new (message: string): import("./custom-error");
-    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
-    prepareStackTrace?: (err: Error, stackTraces: NodeJS.CallSite[]) => any;
-    stackTraceLimit: number;
-};
-declare class SingleDestMultipleSourcesError extends SingleDestMultipleSourcesError_base {
-    /**
-     * @param {string} destFilePath
-     */
-    constructor(destFilePath: string);
-}

package/types/helpers/config-store.d.ts

@@ -1,30 +0,0 @@
-/**
- * Tries to find the configuration for eik in the provided directory.
- *
- * @param {string} configRootDir The base directory for the eik project.
- * @param {function} [loadJSONFromDisk] The function to use to load the file from disk.
- *
- * @returns {EikConfig}
- */
-export declare function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
-/**
- * Tries to find the configuration for eik in the provided directory.
- *
- * @param {string} configRootDir The base directory for the eik project.
- * @param {function} [loadJSONFromDisk] The function to use to load the file from disk.
- *
- * @returns {EikConfig}
- */
-export declare function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
-/**
- * Persist config changes to disk as <cwd>/eik.json
- *
- * @param {import('../classes/eik-config')} config
- */
-export declare function persistToDisk(config: import("../classes/eik-config")): void;
-/**
- * Persist config changes to disk as <cwd>/eik.json
- *
- * @param {import('../classes/eik-config')} config
- */
-export declare function persistToDisk(config: import("../classes/eik-config")): void;

package/types/helpers/get-defaults.d.ts

@@ -1,2 +0,0 @@
-declare function _exports(cwd: string): import("../classes/eik-config");
-export = _exports;

package/types/helpers/index.d.ts

@@ -1,15 +0,0 @@
-export const localAssets: typeof import("./local-assets");
-export const getDefaults: (cwd: string) => import("../classes/eik-config");
-export const configStore: {
-    findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("../classes/eik-config");
-    persistToDisk(config: import("../classes/eik-config")): void;
-};
-export const typeSlug: (type: any) => any;
-export const typeTitle: (type: any) => "PACKAGE" | "NPM" | "MAP";
-export const addTrailingSlash: (val: string) => string;
-export const removeTrailingSlash: (val: string) => string;
-export const addLeadingSlash: (val: string) => string;
-export const removeLeadingSlash: (val: string) => string;
-export const resolveFiles: (files: {
-    [k: string]: string;
-}, cwd: string) => Promise<import("../classes/resolved-files")[]>;

package/types/helpers/local-assets.d.ts

@@ -1,8 +0,0 @@
-export = localAssets;
-/**
- * Sets up asset routes for local development. Mounted paths match those on Eik server and values are read from projects eik.json file.
- *
- * @param {object} app - express js or fastify app instance
- * @param {string} rootEikDirectory - (optional) path to folder where eik configuration file can be found
- */
-declare function localAssets(app: object, rootEikDirectory?: string): Promise<void>;

package/types/helpers/path-slashes.d.ts

@@ -1,32 +0,0 @@
-/**
- * Add a trailing slash to a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
-export function addTrailingSlash(val: string): string;
-/**
- * Remove a trailing slash from a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
-export function removeTrailingSlash(val: string): string;
-/**
- * Add a leading slash to a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
-export function addLeadingSlash(val: string): string;
-/**
- * Remove a leading slash from a path if necessary
- *
- * @param {string} val
- *
- * @returns {string}
- */
-export function removeLeadingSlash(val: string): string;

package/types/helpers/resolve-files.d.ts

@@ -1,12 +0,0 @@
-export = resolveFiles;
-/**
- * Uses an Eik JSON "files" definition to resolve files on disk into a data structure
- *
- * @param {{[k: string]: string;}} files
- * @param {string} cwd
- *
- * @returns {Promise<ResolvedFiles[]>}
- */
-declare function resolveFiles(files: {
-    [k: string]: string;
-}, cwd: string): Promise<import("../classes/resolved-files")[]>;

package/types/helpers/type-slug.d.ts

@@ -1,2 +0,0 @@
-declare function _exports(type: any): any;
-export = _exports;

package/types/helpers/type-title.d.ts

@@ -1,2 +0,0 @@
-declare function _exports(type: any): "PACKAGE" | "NPM" | "MAP";
-export = _exports;

package/types/index.d.ts

@@ -1,115 +0,0 @@
-export const validators: typeof import("./validators");
-export const ReadFile: {
-    new ({ mimeType, etag }?: {
-        mimeType?: string;
-        etag?: string;
-    }): {
-        _mimeType: string;
-        _stream: any;
-        _etag: string;
-        readonly mimeType: string;
-        stream: any;
-        readonly etag: string;
-        readonly [Symbol.toStringTag]: string;
-    };
-};
-export const EikConfig: typeof import("./classes/eik-config");
-export const schemas: {
-    schema: {
-        $schema: string;
-        additionalProperties: boolean;
-        type: string;
-        properties: {
-            server: {
-                description: string;
-                type: string;
-                format: string;
-            };
-            name: {
-                description: string;
-                type: string;
-                maxLength: number;
-                minLength: number;
-            };
-            version: {
-                description: string;
-                type: string;
-                minLength: number;
-            };
-            type: {
-                description: string;
-                type: string;
-                enum: string[];
-                default: string;
-            };
-            files: {
-                description: string;
-                oneOf: ({
-                    type: string;
-                    minProperties: number;
-                    additionalProperties: {
-                        type: string;
-                    };
-                    minLength?: undefined;
-                } | {
-                    type: string;
-                    minLength: number;
-                    minProperties?: undefined;
-                    additionalProperties?: undefined;
-                })[];
-            };
-            "import-map": {
-                description: string;
-                oneOf: ({
-                    type: string;
-                    format: string;
-                    items?: undefined;
-                } | {
-                    type: string;
-                    items: {
-                        type: string;
-                        format: string;
-                    };
-                    format?: undefined;
-                })[];
-            };
-            out: {
-                description: string;
-                type: string;
-                format: string;
-                minLength: number;
-            };
-        };
-        required: string[];
-    };
-    validate: typeof import("./schemas/validate");
-    assert: {
-        eikJSON: (value: any) => void;
-        name: (value: any) => void;
-        type: (value: any) => void;
-        version: (value: any) => void;
-        server: (value: any) => void;
-        files: (value: any) => void;
-        importMap: (value: any) => void;
-        out: (value: any) => void;
-    };
-    ValidationError: typeof import("./schemas/validation-error");
-};
-export const stream: typeof import("./stream");
-export const helpers: {
-    localAssets: typeof import("./helpers/local-assets");
-    getDefaults: (cwd: string) => import("./classes/eik-config");
-    configStore: {
-        findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): import("./classes/eik-config");
-        persistToDisk(config: import("./classes/eik-config")): void;
-    };
-    typeSlug: (type: any) => any;
-    typeTitle: (type: any) => "PACKAGE" | "NPM" | "MAP";
-    addTrailingSlash: (val: string) => string;
-    removeTrailingSlash: (val: string) => string;
-    addLeadingSlash: (val: string) => string;
-    removeLeadingSlash: (val: string) => string;
-    resolveFiles: (files: {
-        [k: string]: string;
-    }, cwd: string) => Promise<import("./classes/resolved-files")[]>;
-};

package/types/schemas/assert.d.ts

@@ -1,11 +0,0 @@
-declare const _exports: {
-    eikJSON: (value: any) => void;
-    name: (value: any) => void;
-    type: (value: any) => void;
-    version: (value: any) => void;
-    server: (value: any) => void;
-    files: (value: any) => void;
-    importMap: (value: any) => void;
-    out: (value: any) => void;
-};
-export = _exports;

package/types/schemas/index.d.ts

@@ -1,79 +0,0 @@
-export const schema: {
-    $schema: string;
-    additionalProperties: boolean;
-    type: string;
-    properties: {
-        server: {
-            description: string;
-            type: string;
-            format: string;
-        };
-        name: {
-            description: string;
-            type: string;
-            maxLength: number;
-            minLength: number;
-        };
-        version: {
-            description: string;
-            type: string;
-            minLength: number;
-        };
-        type: {
-            description: string;
-            type: string;
-            enum: string[];
-            default: string;
-        };
-        files: {
-            description: string;
-            oneOf: ({
-                type: string;
-                minProperties: number;
-                additionalProperties: {
-                    type: string;
-                };
-                minLength?: undefined;
-            } | {
-                type: string;
-                minLength: number;
-                minProperties?: undefined;
-                additionalProperties?: undefined;
-            })[];
-        };
-        "import-map": {
-            description: string;
-            oneOf: ({
-                type: string;
-                format: string;
-                items?: undefined;
-            } | {
-                type: string;
-                items: {
-                    type: string;
-                    format: string;
-                };
-                format?: undefined;
-            })[];
-        };
-        out: {
-            description: string;
-            type: string;
-            format: string;
-            minLength: number;
-        };
-    };
-    required: string[];
-};
-export const validate: typeof import("./validate");
-export const assert: {
-    eikJSON: (value: any) => void;
-    name: (value: any) => void;
-    type: (value: any) => void;
-    version: (value: any) => void;
-    server: (value: any) => void;
-    files: (value: any) => void;
-    importMap: (value: any) => void;
-    out: (value: any) => void;
-};
-export const ValidationError: typeof import("./validation-error");

package/types/schemas/validate.d.ts

@@ -1,26 +0,0 @@
-export function eikJSON(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};
-export function name(value: any): any;
-export function version(value: any): any;
-export function type(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};
-export function server(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};
-export function files(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};
-export function importMap(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};
-export function out(data: any): {
-    value: any;
-    error: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
-};

package/types/schemas/validation-error.d.ts

@@ -1,8 +0,0 @@
-export = ValidationError;
-declare class ValidationError extends Error {
-    /**
-     * @param {string} message
-     * @param {Error} err
-     */
-    constructor(message: string, err: Error);
-}

package/types/stream.d.ts

@@ -1,2 +0,0 @@
-export function isStream(stream: any): boolean;
-export function isReadableStream(stream: any): boolean;

package/types/validators/index.d.ts

@@ -1,8 +0,0 @@
-export function origin(value: any): any;
-export function org(value: any): any;
-export function name(value: any): any;
-export function version(value: any): any;
-export function alias(value: any): any;
-export function type(value: any): any;
-export function extra(value: any): any;
-export function semverType(value: any): any;