@vendure/ui-devkit 2.2.0-next.3 → 2.2.0-next.5

package/compiler/compile.js

@@ -1,262 +1,262 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileUiExtensions = void 0;
-const child_process_1 = require("child_process");
-const chokidar_1 = require("chokidar");
-const fs = __importStar(require("fs-extra"));
-const path = __importStar(require("path"));
-const constants_1 = require("./constants");
-const scaffold_1 = require("./scaffold");
-const translations_1 = require("./translations");
-const utils_1 = require("./utils");
-/**
- * @description
- * Compiles the Admin UI app with the specified extensions.
- *
- * @docsCategory UiDevkit
- */
-function compileUiExtensions(options) {
-    const { devMode, watchPort, command } = options;
-    const usingYarn = command && command === 'npm' ? false : (0, utils_1.shouldUseYarn)();
-    if (devMode) {
-        return runWatchMode({
-            watchPort: watchPort || 4200,
-            usingYarn,
-            ...options,
-        });
-    }
-    else {
-        return runCompileMode({
-            usingYarn,
-            ...options,
-        });
-    }
-}
-exports.compileUiExtensions = compileUiExtensions;
-function runCompileMode({ outputPath, baseHref, extensions, usingYarn, additionalProcessArguments, ngCompilerPath, }) {
-    const distPath = path.join(outputPath, 'dist');
-    const compile = () => new Promise(async (resolve, reject) => {
-        await (0, scaffold_1.setupScaffold)(outputPath, extensions);
-        await (0, scaffold_1.setBaseHref)(outputPath, baseHref || constants_1.DEFAULT_BASE_HREF);
-        let cmd = usingYarn ? 'yarn' : 'npm';
-        let commandArgs = ['run', 'build'];
-        if (ngCompilerPath) {
-            cmd = 'node';
-            commandArgs = [ngCompilerPath, 'build', '--configuration production'];
-        }
-        else {
-            if (!usingYarn) {
-                // npm requires `--` before any command line args being passed to a script
-                commandArgs.splice(2, 0, '--');
-            }
-        }
-        console.log(`Running ${cmd} ${commandArgs.join(' ')}`);
-        const buildProcess = (0, child_process_1.spawn)(cmd, [...commandArgs, ...buildProcessArguments(additionalProcessArguments)], {
-            cwd: outputPath,
-            shell: true,
-            stdio: 'inherit',
-        });
-        buildProcess.on('close', code => {
-            if (code !== 0) {
-                reject(code);
-            }
-            else {
-                resolve();
-            }
-        });
-    });
-    return {
-        path: distPath,
-        compile,
-        route: baseHrefToRoute(baseHref || constants_1.DEFAULT_BASE_HREF),
-    };
-}
-function runWatchMode({ outputPath, baseHref, watchPort, extensions, usingYarn, additionalProcessArguments, ngCompilerPath, }) {
-    const devkitPath = require.resolve('@vendure/ui-devkit');
-    let buildProcess;
-    let watcher;
-    let close = () => {
-        /* */
-    };
-    const compile = () => new Promise(async (resolve, reject) => {
-        await (0, scaffold_1.setupScaffold)(outputPath, extensions);
-        await (0, scaffold_1.setBaseHref)(outputPath, baseHref || constants_1.DEFAULT_BASE_HREF);
-        const adminUiExtensions = extensions.filter(utils_1.isAdminUiExtension);
-        const normalizedExtensions = (0, utils_1.normalizeExtensions)(adminUiExtensions);
-        const globalStylesExtensions = extensions.filter(utils_1.isGlobalStylesExtension);
-        const staticAssetExtensions = extensions.filter(utils_1.isStaticAssetExtension);
-        const allTranslationFiles = (0, translations_1.getAllTranslationFiles)(extensions.filter(utils_1.isTranslationExtension));
-        let cmd = usingYarn ? 'yarn' : 'npm';
-        let commandArgs = ['run', 'start'];
-        if (ngCompilerPath) {
-            cmd = 'node';
-            commandArgs = [ngCompilerPath, 'serve'];
-        }
-        buildProcess = (0, child_process_1.spawn)(cmd, [
-            ...commandArgs,
-            `--port=${watchPort || 4200}`,
-            ...buildProcessArguments(additionalProcessArguments),
-        ], {
-            cwd: outputPath,
-            shell: true,
-            stdio: 'inherit',
-        });
-        buildProcess.on('close', code => {
-            if (code !== 0) {
-                reject(code);
-            }
-            else {
-                resolve();
-            }
-            close();
-        });
-        for (const extension of normalizedExtensions) {
-            if (!watcher) {
-                watcher = (0, chokidar_1.watch)(extension.extensionPath, {
-                    depth: 4,
-                    ignored: '**/node_modules/',
-                });
-            }
-            else {
-                watcher.add(extension.extensionPath);
-            }
-        }
-        for (const extension of staticAssetExtensions) {
-            for (const staticAssetDef of extension.staticAssets) {
-                const assetPath = (0, utils_1.getStaticAssetPath)(staticAssetDef);
-                if (!watcher) {
-                    watcher = (0, chokidar_1.watch)(assetPath);
-                }
-                else {
-                    watcher.add(assetPath);
-                }
-            }
-        }
-        for (const extension of globalStylesExtensions) {
-            const globalStylePaths = Array.isArray(extension.globalStyles)
-                ? extension.globalStyles
-                : [extension.globalStyles];
-            for (const stylePath of globalStylePaths) {
-                if (!watcher) {
-                    watcher = (0, chokidar_1.watch)(stylePath);
-                }
-                else {
-                    watcher.add(stylePath);
-                }
-            }
-        }
-        for (const translationFiles of Object.values(allTranslationFiles)) {
-            if (!translationFiles) {
-                continue;
-            }
-            for (const file of translationFiles) {
-                if (!watcher) {
-                    watcher = (0, chokidar_1.watch)(file);
-                }
-                else {
-                    watcher.add(file);
-                }
-            }
-        }
-        if (watcher) {
-            // watch the ui-devkit package files too
-            watcher.add(devkitPath);
-        }
-        if (watcher) {
-            const allStaticAssetDefs = staticAssetExtensions.reduce((defs, e) => [...defs, ...(e.staticAssets || [])], []);
-            const allGlobalStyles = globalStylesExtensions.reduce((defs, e) => [
-                ...defs,
-                ...(Array.isArray(e.globalStyles) ? e.globalStyles : [e.globalStyles]),
-            ], []);
-            watcher.on('change', async (filePath) => {
-                const extension = normalizedExtensions.find(e => filePath.includes(e.extensionPath));
-                if (extension) {
-                    const outputDir = path.join(outputPath, constants_1.MODULES_OUTPUT_DIR, extension.id);
-                    const filePart = path.relative(extension.extensionPath, filePath);
-                    const dest = path.join(outputDir, filePart);
-                    await fs.copyFile(filePath, dest);
-                }
-                if (filePath.includes(devkitPath)) {
-                    (0, utils_1.copyUiDevkit)(outputPath);
-                }
-                for (const staticAssetDef of allStaticAssetDefs) {
-                    const assetPath = (0, utils_1.getStaticAssetPath)(staticAssetDef);
-                    if (filePath.includes(assetPath)) {
-                        await (0, utils_1.copyStaticAsset)(outputPath, staticAssetDef);
-                        return;
-                    }
-                }
-                for (const stylePath of allGlobalStyles) {
-                    if (filePath.includes(stylePath)) {
-                        await (0, scaffold_1.copyGlobalStyleFile)(outputPath, stylePath);
-                        return;
-                    }
-                }
-                for (const languageCode of Object.keys(allTranslationFiles)) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    const translationFiles = allTranslationFiles[languageCode];
-                    for (const file of translationFiles) {
-                        if (filePath.includes(path.normalize(file))) {
-                            await (0, translations_1.mergeExtensionTranslations)(outputPath, {
-                                [languageCode]: translationFiles,
-                            });
-                        }
-                    }
-                }
-            });
-        }
-        resolve();
-    });
-    close = () => {
-        if (watcher) {
-            void watcher.close();
-        }
-        if (buildProcess) {
-            buildProcess.kill();
-        }
-        process.exit();
-    };
-    process.on('SIGINT', close);
-    return {
-        sourcePath: outputPath,
-        port: watchPort || 4200,
-        compile,
-        route: baseHrefToRoute(baseHref || constants_1.DEFAULT_BASE_HREF),
-    };
-}
-function buildProcessArguments(args) {
-    return (args ?? []).map(arg => {
-        if (Array.isArray(arg)) {
-            const [key, value] = arg;
-            return `${key}=${value}`;
-        }
-        return arg;
-    });
-}
-function baseHrefToRoute(baseHref) {
-    return baseHref.replace(/^\//, '').replace(/\/$/, '');
-}
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileUiExtensions = void 0;
+const child_process_1 = require("child_process");
+const chokidar_1 = require("chokidar");
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+const constants_1 = require("./constants");
+const scaffold_1 = require("./scaffold");
+const translations_1 = require("./translations");
+const utils_1 = require("./utils");
+/**
+ * @description
+ * Compiles the Admin UI app with the specified extensions.
+ *
+ * @docsCategory UiDevkit
+ */
+function compileUiExtensions(options) {
+    const { devMode, watchPort, command } = options;
+    const usingYarn = command && command === 'npm' ? false : (0, utils_1.shouldUseYarn)();
+    if (devMode) {
+        return runWatchMode({
+            watchPort: watchPort || 4200,
+            usingYarn,
+            ...options,
+        });
+    }
+    else {
+        return runCompileMode({
+            usingYarn,
+            ...options,
+        });
+    }
+}
+exports.compileUiExtensions = compileUiExtensions;
+function runCompileMode({ outputPath, baseHref, extensions, usingYarn, additionalProcessArguments, ngCompilerPath, }) {
+    const distPath = path.join(outputPath, 'dist');
+    const compile = () => new Promise(async (resolve, reject) => {
+        await (0, scaffold_1.setupScaffold)(outputPath, extensions);
+        await (0, scaffold_1.setBaseHref)(outputPath, baseHref || constants_1.DEFAULT_BASE_HREF);
+        let cmd = usingYarn ? 'yarn' : 'npm';
+        let commandArgs = ['run', 'build'];
+        if (ngCompilerPath) {
+            cmd = 'node';
+            commandArgs = [ngCompilerPath, 'build', '--configuration production'];
+        }
+        else {
+            if (!usingYarn) {
+                // npm requires `--` before any command line args being passed to a script
+                commandArgs.splice(2, 0, '--');
+            }
+        }
+        console.log(`Running ${cmd} ${commandArgs.join(' ')}`);
+        const buildProcess = (0, child_process_1.spawn)(cmd, [...commandArgs, ...buildProcessArguments(additionalProcessArguments)], {
+            cwd: outputPath,
+            shell: true,
+            stdio: 'inherit',
+        });
+        buildProcess.on('close', code => {
+            if (code !== 0) {
+                reject(code);
+            }
+            else {
+                resolve();
+            }
+        });
+    });
+    return {
+        path: distPath,
+        compile,
+        route: baseHrefToRoute(baseHref || constants_1.DEFAULT_BASE_HREF),
+    };
+}
+function runWatchMode({ outputPath, baseHref, watchPort, extensions, usingYarn, additionalProcessArguments, ngCompilerPath, }) {
+    const devkitPath = require.resolve('@vendure/ui-devkit');
+    let buildProcess;
+    let watcher;
+    let close = () => {
+        /* */
+    };
+    const compile = () => new Promise(async (resolve, reject) => {
+        await (0, scaffold_1.setupScaffold)(outputPath, extensions);
+        await (0, scaffold_1.setBaseHref)(outputPath, baseHref || constants_1.DEFAULT_BASE_HREF);
+        const adminUiExtensions = extensions.filter(utils_1.isAdminUiExtension);
+        const normalizedExtensions = (0, utils_1.normalizeExtensions)(adminUiExtensions);
+        const globalStylesExtensions = extensions.filter(utils_1.isGlobalStylesExtension);
+        const staticAssetExtensions = extensions.filter(utils_1.isStaticAssetExtension);
+        const allTranslationFiles = (0, translations_1.getAllTranslationFiles)(extensions.filter(utils_1.isTranslationExtension));
+        let cmd = usingYarn ? 'yarn' : 'npm';
+        let commandArgs = ['run', 'start'];
+        if (ngCompilerPath) {
+            cmd = 'node';
+            commandArgs = [ngCompilerPath, 'serve'];
+        }
+        buildProcess = (0, child_process_1.spawn)(cmd, [
+            ...commandArgs,
+            `--port=${watchPort || 4200}`,
+            ...buildProcessArguments(additionalProcessArguments),
+        ], {
+            cwd: outputPath,
+            shell: true,
+            stdio: 'inherit',
+        });
+        buildProcess.on('close', code => {
+            if (code !== 0) {
+                reject(code);
+            }
+            else {
+                resolve();
+            }
+            close();
+        });
+        for (const extension of normalizedExtensions) {
+            if (!watcher) {
+                watcher = (0, chokidar_1.watch)(extension.extensionPath, {
+                    depth: 4,
+                    ignored: '**/node_modules/',
+                });
+            }
+            else {
+                watcher.add(extension.extensionPath);
+            }
+        }
+        for (const extension of staticAssetExtensions) {
+            for (const staticAssetDef of extension.staticAssets) {
+                const assetPath = (0, utils_1.getStaticAssetPath)(staticAssetDef);
+                if (!watcher) {
+                    watcher = (0, chokidar_1.watch)(assetPath);
+                }
+                else {
+                    watcher.add(assetPath);
+                }
+            }
+        }
+        for (const extension of globalStylesExtensions) {
+            const globalStylePaths = Array.isArray(extension.globalStyles)
+                ? extension.globalStyles
+                : [extension.globalStyles];
+            for (const stylePath of globalStylePaths) {
+                if (!watcher) {
+                    watcher = (0, chokidar_1.watch)(stylePath);
+                }
+                else {
+                    watcher.add(stylePath);
+                }
+            }
+        }
+        for (const translationFiles of Object.values(allTranslationFiles)) {
+            if (!translationFiles) {
+                continue;
+            }
+            for (const file of translationFiles) {
+                if (!watcher) {
+                    watcher = (0, chokidar_1.watch)(file);
+                }
+                else {
+                    watcher.add(file);
+                }
+            }
+        }
+        if (watcher) {
+            // watch the ui-devkit package files too
+            watcher.add(devkitPath);
+        }
+        if (watcher) {
+            const allStaticAssetDefs = staticAssetExtensions.reduce((defs, e) => [...defs, ...(e.staticAssets || [])], []);
+            const allGlobalStyles = globalStylesExtensions.reduce((defs, e) => [
+                ...defs,
+                ...(Array.isArray(e.globalStyles) ? e.globalStyles : [e.globalStyles]),
+            ], []);
+            watcher.on('change', async (filePath) => {
+                const extension = normalizedExtensions.find(e => filePath.includes(e.extensionPath));
+                if (extension) {
+                    const outputDir = path.join(outputPath, constants_1.MODULES_OUTPUT_DIR, extension.id);
+                    const filePart = path.relative(extension.extensionPath, filePath);
+                    const dest = path.join(outputDir, filePart);
+                    await fs.copyFile(filePath, dest);
+                }
+                if (filePath.includes(devkitPath)) {
+                    (0, utils_1.copyUiDevkit)(outputPath);
+                }
+                for (const staticAssetDef of allStaticAssetDefs) {
+                    const assetPath = (0, utils_1.getStaticAssetPath)(staticAssetDef);
+                    if (filePath.includes(assetPath)) {
+                        await (0, utils_1.copyStaticAsset)(outputPath, staticAssetDef);
+                        return;
+                    }
+                }
+                for (const stylePath of allGlobalStyles) {
+                    if (filePath.includes(stylePath)) {
+                        await (0, scaffold_1.copyGlobalStyleFile)(outputPath, stylePath);
+                        return;
+                    }
+                }
+                for (const languageCode of Object.keys(allTranslationFiles)) {
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const translationFiles = allTranslationFiles[languageCode];
+                    for (const file of translationFiles) {
+                        if (filePath.includes(path.normalize(file))) {
+                            await (0, translations_1.mergeExtensionTranslations)(outputPath, {
+                                [languageCode]: translationFiles,
+                            });
+                        }
+                    }
+                }
+            });
+        }
+        resolve();
+    });
+    close = () => {
+        if (watcher) {
+            void watcher.close();
+        }
+        if (buildProcess) {
+            buildProcess.kill();
+        }
+        process.exit();
+    };
+    process.on('SIGINT', close);
+    return {
+        sourcePath: outputPath,
+        port: watchPort || 4200,
+        compile,
+        route: baseHrefToRoute(baseHref || constants_1.DEFAULT_BASE_HREF),
+    };
+}
+function buildProcessArguments(args) {
+    return (args ?? []).map(arg => {
+        if (Array.isArray(arg)) {
+            const [key, value] = arg;
+            return `${key}=${value}`;
+        }
+        return arg;
+    });
+}
+function baseHrefToRoute(baseHref) {
+    return baseHref.replace(/^\//, '').replace(/\/$/, '');
+}
 //# sourceMappingURL=compile.js.map

package/compiler/constants.d.ts

@@ -1,6 +1,6 @@
-export declare const STATIC_ASSETS_OUTPUT_DIR = "static-assets";
-export declare const GLOBAL_STYLES_OUTPUT_DIR = "global-styles";
-export declare const EXTENSION_ROUTES_FILE = "src/extension.routes.ts";
-export declare const SHARED_EXTENSIONS_FILE = "src/shared-extensions.module.ts";
-export declare const MODULES_OUTPUT_DIR = "src/extensions";
-export declare const DEFAULT_BASE_HREF = "/admin/";
+export declare const STATIC_ASSETS_OUTPUT_DIR = "static-assets";
+export declare const GLOBAL_STYLES_OUTPUT_DIR = "global-styles";
+export declare const EXTENSION_ROUTES_FILE = "src/extension.routes.ts";
+export declare const SHARED_EXTENSIONS_FILE = "src/shared-extensions.module.ts";
+export declare const MODULES_OUTPUT_DIR = "src/extensions";
+export declare const DEFAULT_BASE_HREF = "/admin/";

package/compiler/constants.js

@@ -1,10 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_BASE_HREF = exports.MODULES_OUTPUT_DIR = exports.SHARED_EXTENSIONS_FILE = exports.EXTENSION_ROUTES_FILE = exports.GLOBAL_STYLES_OUTPUT_DIR = exports.STATIC_ASSETS_OUTPUT_DIR = void 0;
-exports.STATIC_ASSETS_OUTPUT_DIR = 'static-assets';
-exports.GLOBAL_STYLES_OUTPUT_DIR = 'global-styles';
-exports.EXTENSION_ROUTES_FILE = 'src/extension.routes.ts';
-exports.SHARED_EXTENSIONS_FILE = 'src/shared-extensions.module.ts';
-exports.MODULES_OUTPUT_DIR = 'src/extensions';
-exports.DEFAULT_BASE_HREF = '/admin/';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BASE_HREF = exports.MODULES_OUTPUT_DIR = exports.SHARED_EXTENSIONS_FILE = exports.EXTENSION_ROUTES_FILE = exports.GLOBAL_STYLES_OUTPUT_DIR = exports.STATIC_ASSETS_OUTPUT_DIR = void 0;
+exports.STATIC_ASSETS_OUTPUT_DIR = 'static-assets';
+exports.GLOBAL_STYLES_OUTPUT_DIR = 'global-styles';
+exports.EXTENSION_ROUTES_FILE = 'src/extension.routes.ts';
+exports.SHARED_EXTENSIONS_FILE = 'src/shared-extensions.module.ts';
+exports.MODULES_OUTPUT_DIR = 'src/extensions';
+exports.DEFAULT_BASE_HREF = '/admin/';
 //# sourceMappingURL=constants.js.map

package/compiler/helpers.d.ts

@@ -1,25 +1,25 @@
-import { BrandingOptions, StaticAssetExtension } from './types';
-/**
- * @description
- * A helper function to simplify the process of setting custom branding images.
- *
- * @example
- * ```ts
- * compileUiExtensions({
- *   outputPath: path.join(__dirname, '../admin-ui'),
- *   extensions: [
- *     setBranding({
- *       // This is used as the branding in the top-left above the navigation
- *       smallLogoPath: path.join(__dirname, 'images/my-logo-sm.png'),
- *       // This is used on the login page
- *       largeLogoPath: path.join(__dirname, 'images/my-logo-lg.png'),
- *       faviconPath: path.join(__dirname, 'images/my-favicon.ico'),
- *     }),
- *   ],
- * });
- * ```
- *
- * @docsCategory UiDevkit
- * @docsPage helpers
- */
-export declare function setBranding(options: BrandingOptions): StaticAssetExtension;
+import { BrandingOptions, StaticAssetExtension } from './types';
+/**
+ * @description
+ * A helper function to simplify the process of setting custom branding images.
+ *
+ * @example
+ * ```ts
+ * compileUiExtensions({
+ *   outputPath: path.join(__dirname, '../admin-ui'),
+ *   extensions: [
+ *     setBranding({
+ *       // This is used as the branding in the top-left above the navigation
+ *       smallLogoPath: path.join(__dirname, 'images/my-logo-sm.png'),
+ *       // This is used on the login page
+ *       largeLogoPath: path.join(__dirname, 'images/my-logo-lg.png'),
+ *       faviconPath: path.join(__dirname, 'images/my-favicon.ico'),
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * @docsCategory UiDevkit
+ * @docsPage helpers
+ */
+export declare function setBranding(options: BrandingOptions): StaticAssetExtension;