oc 0.49.6 → 0.49.9

package/dist/resources/settings.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    configFile: {
-        src: './oc.json'
-    },
-    filesToIgnoreOnDevWatch: /node_modules|package\.tar\.gz|_package|\.sw[op]|\.git\/|\.idea\/|\.DS_Store|oc\.json/,
-    maxLoopIterations: 1e9,
-    registry: {
-        acceptRenderedHeader: 'application/vnd.oc.rendered+json',
-        acceptUnrenderedHeader: 'application/vnd.oc.unrendered+json',
-        acceptInfoHeader: 'application/vnd.oc.info+json',
-        componentInfoPath: '/~info',
-        componentPreviewPath: '/~preview',
-        defaultTempPath: './temp/',
-        localStaticRedirectorPath: 'static/'
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    configFile: {
+        src: './oc.json'
+    },
+    filesToIgnoreOnDevWatch: /temp\/__oc|node_modules|package\.tar\.gz|_package|\.sw[op]|\.git\/|\.idea\/|\.DS_Store|oc\.json/,
+    maxLoopIterations: 1e9,
+    registry: {
+        acceptRenderedHeader: 'application/vnd.oc.rendered+json',
+        acceptUnrenderedHeader: 'application/vnd.oc.unrendered+json',
+        acceptInfoHeader: 'application/vnd.oc.info+json',
+        componentInfoPath: '/~info',
+        componentPreviewPath: '/~preview',
+        defaultTempPath: './temp/',
+        localStaticRedirectorPath: 'static/'
+    }
+};

package/dist/types.d.ts

@@ -1,285 +1,287 @@
-/// <reference types="node" />
-import { NextFunction, Request, Response } from 'express';
-import { Logger } from './cli/logger';
-import { PackageJson } from 'type-fest';
-export interface Author {
-    email?: string;
-    name?: string;
-    url?: string;
-}
-interface ComponentList {
-    author: Author;
-    name: string;
-    state: string;
-}
-interface ComponentHistory {
-    name: string;
-    publishDate: string;
-    version: string;
-}
-export interface TemplateInfo {
-    externals: Array<{
-        name: string;
-        global: string | string[];
-        url: string;
-    }>;
-    type: string;
-    version: string;
-}
-export interface ComponentsDetails {
-    components: {
-        [componentName: string]: {
-            [componentVersion: string]: {
-                publishDate: number;
-            };
-        };
-    };
-    lastEdit: number;
-}
-export interface ComponentsList {
-    components: Record<string, string[]>;
-    lastEdit: number;
-}
-export interface OcParameter {
-    default?: string | boolean | number;
-    description?: string;
-    example?: string;
-    mandatory?: boolean;
-    type: 'string' | 'boolean' | 'number';
-}
-interface OcConfiguration {
-    container?: boolean;
-    date: number;
-    files: {
-        dataProvider: {
-            hashKey: string;
-            src: string;
-            type: string;
-        };
-        static: string[];
-        template: {
-            hashKey: string;
-            src: string;
-            type: string;
-            version: string;
-        };
-    };
-    packaged: boolean;
-    parameters: Record<string, OcParameter>;
-    plugins?: string[];
-    renderInfo?: boolean;
-    state?: 'deprecated' | 'experimental';
-    stringifiedDate: string;
-    version: string;
-}
-export interface Component extends PackageJson {
-    allVersions: string[];
-    name: string;
-    oc: OcConfiguration;
-    version: string;
-}
-export interface ParsedComponent extends Omit<Component, 'author'> {
-    author: Author;
-}
-export interface VM {
-    availableDependencies: Array<{
-        core: boolean;
-        name: string;
-        version: string;
-        link: string;
-    }>;
-    availablePlugins: Record<string, (...args: unknown[]) => void>;
-    components: ParsedComponent[];
-    componentsHistory?: ComponentHistory[];
-    componentsList: ComponentList[];
-    componentsReleases: number;
-    href: string;
-    ocVersion: string;
-    q: string;
-    stateCounts: {
-        deprecated?: number;
-        experimental?: number;
-    };
-    templates: TemplateInfo[];
-    title: string;
-    type: 'oc-registry' | 'oc-registry-local';
-}
-export interface Config {
-    baseUrl: string;
-    baseUrlFunc?: (opts: {
-        host?: string;
-        secure: boolean;
-    }) => string;
-    beforePublish: (req: Request, res: Response, next: NextFunction) => void;
-    customHeadersToSkipOnWeakVersion: string[];
-    dependencies: string[];
-    discovery: boolean;
-    discoveryFunc?: (opts: {
-        host?: string;
-        secure: boolean;
-    }) => boolean;
-    env: Record<string, string>;
-    executionTimeout?: number;
-    fallbackRegistryUrl: string;
-    hotReloading: boolean;
-    keepAliveTimeout?: number;
-    liveReloadPort: number;
-    components?: string[];
-    local: boolean;
-    path: string;
-    plugins: Record<string, (...args: unknown[]) => void>;
-    pollingInterval: number;
-    port: number | string;
-    postRequestPayloadSize?: number;
-    prefix: string;
-    publishAuth?: {
-        type: string;
-        username: string;
-        password: string;
-    };
-    publishValidation: (data: unknown) => {
-        isValid: boolean;
-        error?: string;
-    } | boolean;
-    refreshInterval?: number;
-    routes?: Array<{
-        route: string;
-        method: string;
-        handler: (req: Request, res: Response) => void;
-    }>;
-    s3?: {
-        bucket: string;
-        region: string;
-        key?: string;
-        secret?: string;
-        componentsDir: string;
-    };
-    storage: {
-        adapter: any;
-        options: Record<string, any> & {
-            componentsDir: string;
-        };
-    };
-    tempDir: string;
-    templates: any[];
-    timeout: number;
-    verbosity: number;
-}
-export interface Cdn {
-    adapterType: string;
-    getFile: (filePath: string, cb: (err: Error | null, data: string) => void) => void;
-    getJson<T>(filePath: string, force: boolean, cb: (err: string | null, data: T) => void): void;
-    getJson<T>(filePath: string, cb: (err: string | null, data: T) => void): void;
-    listSubDirectories: (dir: string, cb: (err: (Error & {
-        code?: string;
-    }) | null, data: string[]) => void) => void;
-    maxConcurrentRequests: number;
-    putDir: (folderPath: string, filePath: string, cb: (err: Error | null) => void) => void;
-    putFileContent: (data: unknown, path: string, isPrivate: boolean, callback: (err: string | null, data: unknown) => void) => void;
-}
-declare type CompiledTemplate = (model: unknown) => string;
-interface CompilerOptions {
-    componentPackage: PackageJson & {
-        oc: OcConfiguration;
-    };
-    componentPath: string;
-    minify: boolean;
-    ocPackage: PackageJson;
-    production: boolean;
-    publishPath: string;
-    verbose: boolean;
-    watch: boolean;
-}
-export interface Template {
-    compile?: (options: CompilerOptions, cb: (err: Error | null) => void) => void;
-    getCompiledTemplate: (templateString: string, key: string, context?: Record<string, unknown>) => CompiledTemplate;
-    getInfo: () => TemplateInfo;
-    render: (options: {
-        model: unknown;
-        template: CompiledTemplate;
-    }, cb: (err: Error | null, data: string) => void) => void;
-}
-export interface Plugin {
-    callback?: (...args: unknown[]) => void;
-    description?: string;
-    name: string;
-    options?: any;
-    register: {
-        register: (options: unknown, dependencies: unknown, next: () => void) => void;
-        execute: (...args: unknown[]) => unknown;
-        dependencies?: string[];
-    };
-}
-export interface RegistryCli {
-    add(registry: string, callback: (err: string | null, data: null) => void): void;
-    get(callback: (err: string | null, data: string[]) => void): void;
-    getApiComponentByHref(href: string, callback: (err: Error | number | null, data: unknown) => void): void;
-    getComponentPreviewUrlByUrl(componentHref: string, callback: (err: Error | number | null, data: string) => void): void;
-    putComponent(options: {
-        username?: string;
-        password?: string;
-        route: string;
-        path: string;
-    }, callback: (err: string | null, data: unknown) => void): void;
-    remove(registry: string, callback: (err: Error | null) => void): void;
-}
-export interface Local {
-    clean: {
-        fetchList: (dirPath: string, callback: (err: Error | null, data: string[]) => void) => void;
-        remove: (list: string[], callback: (err: Error | null, data: string) => void) => void;
-    };
-    cleanup: (compressedPackagePath: string, cb: (err: NodeJS.ErrnoException) => void) => void;
-    compress: (input: string, output: string, cb: (error: Error | string | null) => void) => void;
-    getComponentsByDir: (componentsDir: string, componentsToRun: (err: Error | null, data: string[]) => void | string[], callback: (err: Error | null, data: string[]) => void) => void;
-    init: (options: {
-        componentName: string;
-        logger: Logger;
-        componentPath: string;
-        templateType: string;
-    }, callback: (err: string | null, data: string) => void) => void;
-    mock: (params: {
-        targetType: string;
-        targetValue: string;
-        targetName: string;
-    }, callback: (err: Error) => void) => void;
-    package: (options: {
-        componentPath: string;
-        minify?: boolean;
-        verbose?: boolean;
-        production?: boolean;
-    }, callback: (err: Error | null, data: Component) => void) => void;
-}
-export interface Repository {
-    getCompiledView(componentName: string, componentVersion: string, callback: (err: Error | null, data: string) => void): void;
-    getComponent(componentName: string, componentVersion: string, calllback: (err: string | null, data: Component) => void): void;
-    getComponent(componentName: string, calllback: (err: string | null, data: Component) => void): void;
-    getComponentInfo(componentName: string, componentVersion: string, callback: (err: string | null, data: Component) => void): void;
-    getComponentPath(componentName: string, componentVersion: string): void;
-    getComponents(callback: (err: Error | null, data: string[]) => void): void;
-    getComponentsDetails(callback: (err: string | null, data: ComponentsDetails) => void): void;
-    getComponentVersions(componentName: string, callback: (err: string | null, data: string[]) => void): void;
-    getDataProvider(componentName: string, componentVersion: string, callback: (err: Error | null, data: {
-        content: string;
-        filePath: string;
-    }) => void): void;
-    getStaticClientMapPath: () => string;
-    getStaticClientPath: () => string;
-    getStaticFilePath: (componentName: string, componentVersion: string, filePath: string) => string;
-    getTemplate: (type: string) => Template;
-    getTemplatesInfo: () => TemplateInfo[];
-    init(callback: (err: Error | null, data: ComponentsList | string) => void): void;
-    publishComponent(pkgDetails: any, componentName: string, componentVersion: string, callback: (err: {
-        code: string;
-        msg: string;
-    } | null, data: ComponentsDetails) => void): void;
-}
-declare global {
-    namespace Express {
-        interface Response {
-            conf: Config;
-            errorCode?: string;
-            errorDetails?: string;
-        }
-    }
-}
-export {};
+import { NextFunction, Request, Response } from 'express';
+import { Logger } from './cli/logger';
+import { PackageJson } from 'type-fest';
+export interface Author {
+    email?: string;
+    name?: string;
+    url?: string;
+}
+interface ComponentList {
+    author: Author;
+    name: string;
+    state: string;
+}
+interface ComponentHistory {
+    name: string;
+    publishDate: string;
+    version: string;
+}
+export interface TemplateInfo {
+    externals: Array<{
+        name: string;
+        global: string | string[];
+        url: string;
+    }>;
+    type: string;
+    version: string;
+}
+export interface ComponentsDetails {
+    components: {
+        [componentName: string]: {
+            [componentVersion: string]: {
+                publishDate: number;
+            };
+        };
+    };
+    lastEdit: number;
+}
+export interface ComponentsList {
+    components: Record<string, string[]>;
+    lastEdit: number;
+}
+export interface OcJsonConfig {
+    registries?: string[];
+    mocks?: {
+        plugins?: {
+            dynamic?: Record<string, string>;
+            static?: Record<string, string>;
+        };
+    };
+}
+export interface OcParameter {
+    default?: string | boolean | number;
+    description?: string;
+    example?: string;
+    mandatory?: boolean;
+    type: 'string' | 'boolean' | 'number';
+}
+interface OcConfiguration {
+    container?: boolean;
+    date: number;
+    files: {
+        dataProvider: {
+            hashKey: string;
+            src: string;
+            type: string;
+        };
+        static: string[];
+        template: {
+            hashKey: string;
+            src: string;
+            type: string;
+            version: string;
+        };
+    };
+    packaged: boolean;
+    parameters: Record<string, OcParameter>;
+    plugins?: string[];
+    renderInfo?: boolean;
+    state?: 'deprecated' | 'experimental';
+    stringifiedDate: string;
+    version: string;
+}
+export interface Component extends PackageJson {
+    allVersions: string[];
+    name: string;
+    oc: OcConfiguration;
+    version: string;
+}
+export interface ParsedComponent extends Omit<Component, 'author'> {
+    author: Author;
+}
+export interface VM {
+    availableDependencies: Array<{
+        core: boolean;
+        name: string;
+        version: string;
+        link: string;
+    }>;
+    availablePlugins: Record<string, (...args: unknown[]) => void>;
+    components: ParsedComponent[];
+    componentsHistory?: ComponentHistory[];
+    componentsList: ComponentList[];
+    componentsReleases: number;
+    href: string;
+    ocVersion: string;
+    q: string;
+    stateCounts: {
+        deprecated?: number;
+        experimental?: number;
+    };
+    templates: TemplateInfo[];
+    title: string;
+    type: 'oc-registry' | 'oc-registry-local';
+}
+export declare type Authentication<T = any> = {
+    validate: (config: T) => {
+        isValid: boolean;
+        message: string;
+    };
+    middleware: (config: T) => any;
+};
+export declare type PublishAuthConfig = {
+    type: 'basic';
+    username: string;
+    password: string;
+} | ({
+    type: string | Authentication;
+} & Record<string, any>);
+export interface Config {
+    baseUrl: string;
+    baseUrlFunc?: (opts: {
+        host?: string;
+        secure: boolean;
+    }) => string;
+    beforePublish: (req: Request, res: Response, next: NextFunction) => void;
+    customHeadersToSkipOnWeakVersion: string[];
+    dependencies: string[];
+    discovery: boolean;
+    discoveryFunc?: (opts: {
+        host?: string;
+        secure: boolean;
+    }) => boolean;
+    env: Record<string, string>;
+    executionTimeout?: number;
+    fallbackRegistryUrl: string;
+    hotReloading: boolean;
+    keepAliveTimeout?: number;
+    liveReloadPort: number;
+    components?: string[];
+    local: boolean;
+    path: string;
+    plugins: Record<string, (...args: unknown[]) => void>;
+    pollingInterval: number;
+    port: number | string;
+    postRequestPayloadSize?: number;
+    prefix: string;
+    publishAuth?: PublishAuthConfig;
+    publishValidation: (data: unknown) => {
+        isValid: boolean;
+        error?: string;
+    } | boolean;
+    refreshInterval?: number;
+    routes?: Array<{
+        route: string;
+        method: string;
+        handler: (req: Request, res: Response) => void;
+    }>;
+    s3?: {
+        bucket: string;
+        region: string;
+        key?: string;
+        secret?: string;
+        componentsDir: string;
+    };
+    storage: {
+        adapter: any;
+        options: Record<string, any> & {
+            componentsDir: string;
+        };
+    };
+    tempDir: string;
+    templates: any[];
+    timeout: number;
+    verbosity: number;
+}
+declare type CompiledTemplate = (model: unknown) => string;
+interface CompilerOptions {
+    componentPackage: PackageJson & {
+        oc: OcConfiguration;
+    };
+    componentPath: string;
+    minify: boolean;
+    ocPackage: PackageJson;
+    production: boolean;
+    publishPath: string;
+    verbose: boolean;
+    watch: boolean;
+}
+export interface Template {
+    compile?: (options: CompilerOptions, cb: (err: Error | null) => void) => void;
+    getCompiledTemplate: (templateString: string, key: string, context?: Record<string, unknown>) => CompiledTemplate;
+    getInfo: () => TemplateInfo;
+    render: (options: {
+        model: unknown;
+        template: CompiledTemplate;
+    }, cb: (err: Error | null, data: string) => void) => void;
+}
+export interface Plugin {
+    callback?: (error: unknown) => void;
+    description?: string;
+    name: string;
+    options?: any;
+    register: {
+        register: (options: unknown, dependencies: unknown, next: (error?: unknown) => void) => void;
+        execute: (...args: unknown[]) => unknown;
+        dependencies?: string[];
+    };
+}
+export interface RegistryCli {
+    add(registry: string): Promise<void>;
+    get(): Promise<string[]>;
+    getApiComponentByHref(href: string): Promise<Component>;
+    getComponentPreviewUrlByUrl(componentHref: string): Promise<string>;
+    putComponent(options: {
+        username?: string;
+        password?: string;
+        route: string;
+        path: string;
+    }): Promise<void>;
+    remove(registry: string): Promise<void>;
+}
+export interface Local {
+    clean: {
+        fetchList: (dirPath: string) => Promise<string[]>;
+        remove: (list: string[]) => Promise<void>;
+    };
+    cleanup: (compressedPackagePath: string) => Promise<void>;
+    compress: (input: string, output: string) => Promise<void>;
+    getComponentsByDir: (componentsDir: string, componentsToRun?: string[]) => Promise<string[]>;
+    init: (options: {
+        componentName: string;
+        logger: Logger;
+        componentPath: string;
+        templateType: string;
+    }) => Promise<void>;
+    mock: (params: {
+        targetType: string;
+        targetValue: string;
+        targetName: string;
+    }) => Promise<void>;
+    package: (options: {
+        componentPath: string;
+        minify?: boolean;
+        verbose?: boolean;
+        production?: boolean;
+    }) => Promise<Component>;
+}
+export interface Repository {
+    getCompiledView(componentName: string, componentVersion: string): Promise<string>;
+    getComponent(componentName: string, componentVersion?: string): Promise<Component>;
+    getComponentInfo(componentName: string, componentVersion: string): Promise<Component>;
+    getComponentPath(componentName: string, componentVersion: string): void;
+    getComponents(): Promise<string[]>;
+    getComponentsDetails(): Promise<ComponentsDetails>;
+    getComponentVersions(componentName: string): Promise<string[]>;
+    getDataProvider(componentName: string, componentVersion: string): Promise<{
+        content: string;
+        filePath: string;
+    }>;
+    getStaticClientMapPath: () => string;
+    getStaticClientPath: () => string;
+    getStaticFilePath: (componentName: string, componentVersion: string, filePath: string) => string;
+    getTemplate: (type: string) => Template;
+    getTemplatesInfo: () => TemplateInfo[];
+    init(): Promise<ComponentsList>;
+    publishComponent(pkgDetails: any, componentName: string, componentVersion: string): Promise<ComponentsDetails>;
+}
+declare global {
+    namespace Express {
+        interface Response {
+            conf: Config;
+            errorCode?: string;
+            errorDetails?: string;
+        }
+    }
+}
+export {};

package/dist/types.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });