@eik/common 4.0.0-next.5 → 4.0.0-next.6

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,20 +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<LocalFileLocation, void, unknown>;
-    [originalFiles]: string[];
-}
-import LocalFileLocation = require("./local-file-location");
-declare const originalFiles: unique symbol;

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

@@ -1,4 +0,0 @@
-export = SingleDestMultipleSourcesError;
-declare class SingleDestMultipleSourcesError extends CustomError {
-}
-import CustomError = require("./custom-error");

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

@@ -1,31 +0,0 @@
-import EikConfig = require("../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 function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
-/**
- * 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 function findInDirectory(configRootDir: string, loadJSONFromDisk?: Function): EikConfig;
-/**
- * Persist config changes to disk as <cwd>/eik.json
- *
- * @param {import('../classes/eik-config')} config
- */
-export function persistToDisk(config: EikConfig): void;
-/**
- * Persist config changes to disk as <cwd>/eik.json
- *
- * @param {import('../classes/eik-config')} config
- */
-export function persistToDisk(config: EikConfig): 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,11 +0,0 @@
-import localAssets = require("./local-assets");
-import getDefaults = require("./get-defaults");
-import configStore = require("./config-store");
-import typeSlug = require("./type-slug");
-import typeTitle = require("./type-title");
-import { addTrailingSlash } from "./path-slashes";
-import { removeTrailingSlash } from "./path-slashes";
-import { addLeadingSlash } from "./path-slashes";
-import { removeLeadingSlash } from "./path-slashes";
-import resolveFiles = require("./resolve-files");
-export { localAssets, getDefaults, configStore, typeSlug, typeTitle, addTrailingSlash, removeTrailingSlash, addLeadingSlash, removeLeadingSlash, resolveFiles };

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,13 +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<ResolvedFiles[]>;
-import ResolvedFiles = require("../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,7 +0,0 @@
-import validators = require("./validators");
-import ReadFile = require("./classes/read-file");
-import EikConfig = require("./classes/eik-config");
-import schemas = require("./schemas");
-import stream = require("./stream");
-import helpers = require("./helpers");
-export { validators, ReadFile, EikConfig, schemas, stream, helpers };

package/types/schemas/assert.d.ts

@@ -1,8 +0,0 @@
-export function eikJSON(value: any): void;
-export function name(value: any): void;
-export function type(value: any): void;
-export function version(value: any): void;
-export function server(value: any): void;
-export function files(value: any): void;
-export function importMap(value: any): void;
-export function out(value: any): void;

package/types/schemas/index.d.ts

@@ -1,71 +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[];
-};
-import validate = require("./validate");
-import assert = require("./assert");
-import ValidationError = require("./validation-error");
-export { validate, assert, ValidationError };

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;