oc-server 1.1.4 → 1.1.5

package/dist/cli/cli.d.ts

@@ -0,0 +1 @@
+export declare function cli(): void;

package/dist/cli/cli.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_util_1 = require("node:util");
+const oc_1 = require("./oc");
+const server_1 = require("./server");
+const pkg = require(node_path_1.default.join(process.cwd(), 'package.json'));
+const { templateType } = (0, oc_1.parsePkg)(pkg);
+function cli() {
+    const { positionals: [command], values: { help, port = '5000' }, } = (0, node_util_1.parseArgs)({
+        allowPositionals: true,
+        options: {
+            port: {
+                type: 'string',
+                default: '5000',
+                short: 'p',
+            },
+            help: {
+                type: 'boolean',
+                default: false,
+                short: 'h',
+            },
+        },
+    });
+    if (help || !command) {
+        console.log(`
+    Usage:
+      $ oc-server <command> [options]
+
+    Commands:
+      dev         Start the development server
+
+    Options:
+      -h, --help  Display this message
+    `);
+        if (help && command === 'dev') {
+            console.log(`
+    Usage:
+      $ oc-server <command> [options]
+
+    Commands:
+      dev         Start the development server
+
+    Options:
+      -h, --help  Display this message
+      -p, --port  Port to use (default: 5000)
+    `);
+        }
+        process.exit(0);
+    }
+    let template;
+    try {
+        template = require(`${templateType}-compiler/dist/lib/hmr`);
+    }
+    catch (e) {
+        console.error(`The template ${templateType} is not supported. Try updating to the last version`);
+        process.exit(1);
+    }
+    if (command === 'dev') {
+        (0, server_1.createServer)({ template, port });
+    }
+}
+exports.cli = cli;

package/dist/cli/get-mocked-plugins.d.ts

@@ -0,0 +1,8 @@
+export interface PluginMock {
+    name: string;
+    register: {
+        register: (options: unknown, dependencies: unknown, next: () => void) => void;
+        execute: (...args: unknown[]) => unknown;
+    };
+}
+export default function getMockedPlugins(componentsDir: string): PluginMock[];

package/dist/cli/get-mocked-plugins.js

@@ -0,0 +1,79 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const readJsonSync = (path) => JSON.parse(fs_1.default.readFileSync(path, 'utf-8'));
+const isMockValid = (plugin) => {
+    const isFunction = typeof plugin === 'function';
+    const isValidObject = !!plugin &&
+        typeof plugin === 'object' &&
+        typeof plugin.register === 'function' &&
+        typeof plugin.execute === 'function';
+    return isFunction || isValidObject;
+};
+const defaultRegister = (_options, _dependencies, next) => {
+    next();
+};
+const registerStaticMocks = (mocks) => Object.entries(mocks).map(([pluginName, mockedValue]) => {
+    return {
+        name: pluginName,
+        register: {
+            register: defaultRegister,
+            execute: () => mockedValue,
+        },
+    };
+});
+const registerDynamicMocks = (ocJsonLocation, mocks) => Object.entries(mocks)
+    .map(([pluginName, source]) => {
+    let pluginMock;
+    try {
+        pluginMock = require(path_1.default.resolve(ocJsonLocation, source));
+    }
+    catch (er) {
+        return;
+    }
+    if (!isMockValid(pluginMock)) {
+        return;
+    }
+    const register = pluginMock.register || defaultRegister;
+    const execute = pluginMock.execute || pluginMock;
+    return {
+        name: pluginName,
+        register: { execute, register },
+    };
+})
+    .filter((pluginMock) => !!pluginMock);
+const findPath = (pathToResolve, fileName) => {
+    const rootDir = fs_1.default.realpathSync('.');
+    const fileToResolve = path_1.default.join(pathToResolve, fileName);
+    if (!fs_1.default.existsSync(fileToResolve)) {
+        if (pathToResolve === rootDir) {
+            return undefined;
+        }
+        const getParent = (pathToResolve) => pathToResolve.split('/').slice(0, -1).join('/');
+        const parentDir = pathToResolve ? getParent(pathToResolve) : rootDir;
+        return findPath(parentDir, fileName);
+    }
+    return fileToResolve;
+};
+function getMockedPlugins(componentsDir) {
+    componentsDir = path_1.default.resolve(componentsDir || '.');
+    let plugins = [];
+    const ocJsonFileName = 'oc.json';
+    const ocJsonPath = findPath(componentsDir, ocJsonFileName);
+    if (!ocJsonPath) {
+        return plugins;
+    }
+    const content = readJsonSync(ocJsonPath);
+    const ocJsonLocation = ocJsonPath.slice(0, -ocJsonFileName.length);
+    if (!content.mocks || !content.mocks.plugins) {
+        return plugins;
+    }
+    plugins = plugins.concat(registerStaticMocks(content.mocks.plugins.static ?? {}));
+    plugins = plugins.concat(registerDynamicMocks(ocJsonLocation, content.mocks.plugins.dynamic ?? {}));
+    return plugins;
+}
+exports.default = getMockedPlugins;

package/dist/cli/index.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+process.env.VITE_CJS_IGNORE_WARNING = 'true';
+const cli_1 = require("./cli");
+(0, cli_1.cli)();

package/dist/cli/oc.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+import { PluginMock } from './get-mocked-plugins';
+import type { Request } from 'express';
+interface Package {
+    name: string;
+    version: string;
+    oc?: {
+        parameters?: Record<string, {
+            mandatory: boolean;
+            example: string | number | boolean;
+        }>;
+        files: {
+            data?: string;
+            template?: {
+                type?: string;
+                src?: string;
+            };
+        };
+    };
+}
+export declare function parsePkg(pkg: Package): {
+    name: string;
+    version: string;
+    defaultParams: {};
+    serverEntry: string | undefined;
+    appEntry: string;
+    templateType: string;
+};
+export declare function getContext(plugins: PluginMock[], req: Request, params: any, action?: any): {
+    context: {
+        action: any;
+        acceptLanguage: string | undefined;
+        easeUrl: string;
+        env: {
+            name: string;
+        };
+        params: any;
+        plugins: {
+            [k: string]: (...args: unknown[]) => unknown;
+        };
+        renderComponent: () => never;
+        renderComponents: () => never;
+        requestHeaders: import("http").IncomingHttpHeaders;
+        requestIp: string | undefined;
+        setEmptyResponse: null;
+        staticPath: string;
+        setHeader: (header: string, value: string) => void;
+        templates: string;
+    };
+    responseHeaders: Record<string, string>;
+};
+export {};

package/dist/cli/oc.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContext = exports.parsePkg = void 0;
+function parsePkg(pkg) {
+    const serverEntry = pkg.oc?.files?.data;
+    let appEntry = pkg.oc?.files?.template?.src || '';
+    if (!appEntry) {
+        throw new Error('Missing an entry on your package.json under oc.files.template.src');
+    }
+    if (!appEntry.startsWith('/')) {
+        appEntry = `/${appEntry}`;
+    }
+    const defaultParams = (() => {
+        let params = {};
+        if (pkg.oc?.parameters) {
+            params = Object.fromEntries(Object.entries(pkg.oc.parameters || {})
+                .filter(([, param]) => {
+                return !!param.mandatory && 'example' in param;
+            })
+                .map(([paramName, param]) => [paramName, param.example]));
+        }
+        return params;
+    })();
+    const templateType = pkg.oc?.files?.template?.type;
+    if (!templateType) {
+        throw new Error('Missing an entry on your package.json under oc.files.template.type');
+    }
+    return {
+        name: pkg.name,
+        version: pkg.version,
+        defaultParams,
+        serverEntry,
+        appEntry,
+        templateType,
+    };
+}
+exports.parsePkg = parsePkg;
+function getContext(plugins, req, params, action) {
+    const responseHeaders = {};
+    const context = {
+        action,
+        acceptLanguage: req.headers['accept-language'],
+        easeUrl: '/',
+        env: { name: 'local' },
+        params,
+        plugins: Object.fromEntries(plugins.map((plugin) => [plugin.name, plugin.register.execute])),
+        renderComponent: () => {
+            throw new Error('renderComponent is not implemented in the server context');
+        },
+        renderComponents: () => {
+            throw new Error('renderComponents is not implemented in the server context');
+        },
+        requestHeaders: req.headers,
+        requestIp: req.ip,
+        setEmptyResponse: null,
+        staticPath: '/',
+        setHeader: (header, value) => {
+            if (!(typeof header === 'string' && typeof value === 'string')) {
+                throw new Error('context.setHeader parameters must be strings');
+            }
+            if (header && value) {
+                responseHeaders[header.toLowerCase()] = value;
+            }
+        },
+        templates: 'repository.getTemplatesInfo()',
+    };
+    return { context, responseHeaders };
+}
+exports.getContext = getContext;

package/dist/cli/server.d.ts

@@ -0,0 +1,13 @@
+export declare function createServer({ template, port, }: {
+    template: Template;
+    port: string;
+}): Promise<void>;
+interface Template {
+    appBlock: (opts: {
+        name: string;
+        version: string;
+        entry: string;
+    }) => string;
+    plugin?: () => any;
+}
+export {};

package/dist/{cli.js → cli/server.js}

@@ -1,10 +1,9 @@
-#!/usr/bin/env node
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-process.env.VITE_CJS_IGNORE_WARNING = 'true';
+exports.createServer = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const node_vm_1 = __importDefault(require("node:vm"));
@@ -13,31 +12,11 @@ const vite_1 = require("vite");
 const esbuild_1 = __importDefault(require("esbuild"));
 const oc_client_browser_1 = __importDefault(require("oc-client-browser"));
 const cssModulesPlugin_1 = __importDefault(require("oc-vite-compiler/dist/lib/cssModulesPlugin"));
-const get_mocked_plugins_js_1 = __importDefault(require("oc/dist/cli/domain/get-mocked-plugins.js"));
-const node_util_1 = require("node:util");
+const oc_1 = require("./oc");
+const get_mocked_plugins_1 = __importDefault(require("./get-mocked-plugins"));
 const promisify = (fn) => (...args) => new Promise((resolve, reject) => fn(...args, (err, data) => (err ? reject(err) : resolve(data))));
-const plugins = (0, get_mocked_plugins_js_1.default)({ err: () => { }, log: () => { }, ok: () => { }, warn: () => { } }, node_path_1.default.join(process.cwd(), '..'));
-const pkg = require(node_path_1.default.join(process.cwd(), 'package.json'));
-const serverEntry = pkg.oc?.files?.data;
-let appEntry = pkg.oc?.files?.template?.src || '';
-if (!appEntry) {
-    console.log('Missing an entry on your package.json under oc.files.template.src');
-    process.exit(1);
-}
-if (!appEntry.startsWith('/')) {
-    appEntry = `/${appEntry}`;
-}
-const defaultParams = (() => {
-    let params = {};
-    if (pkg.oc?.parameters) {
-        params = Object.fromEntries(Object.entries(pkg.oc.parameters || {})
-            .filter(([, param]) => {
-            return !!param.mandatory && 'example' in param;
-        })
-            .map(([paramName, param]) => [paramName, param.example]));
-    }
-    return params;
-})();
+const pk = require(node_path_1.default.join(process.cwd(), 'package.json'));
+const { name, version, appEntry, serverEntry, defaultParams } = (0, oc_1.parsePkg)(pk);
 function getDataProvider() {
     if (!serverEntry) {
         return async (context) => ({ ...(context.params ?? {}) });
@@ -57,37 +36,6 @@ function getDataProvider() {
     const dataProvider = backend.data || backend.server.getData();
     return promisify(dataProvider);
 }
-function getContext(req, params, action) {
-    const responseHeaders = {};
-    const context = {
-        action,
-        acceptLanguage: req.headers['accept-language'],
-        easeUrl: '/',
-        env: { name: 'local' },
-        params,
-        plugins: Object.fromEntries(plugins.map((plugin) => [plugin.name, plugin.register.execute])),
-        renderComponent: () => {
-            throw new Error('renderComponent is not implemented in the server context');
-        },
-        renderComponents: () => {
-            throw new Error('renderComponents is not implemented in the server context');
-        },
-        requestHeaders: req.headers,
-        requestIp: req.ip,
-        setEmptyResponse: null,
-        staticPath: '/',
-        setHeader: (header, value) => {
-            if (!(typeof header === 'string' && typeof value === 'string')) {
-                throw new Error('context.setHeader parameters must be strings');
-            }
-            if (header && value) {
-                responseHeaders[header.toLowerCase()] = value;
-            }
-        },
-        templates: 'repository.getTemplatesInfo()',
-    };
-    return { context, responseHeaders };
-}
 function getBaseTemplate(appBlock) {
     const baseTemplate = `
 <!DOCTYPE html>
@@ -106,7 +54,7 @@ function getBaseTemplate(appBlock) {
   </head>
   <body>
     <script src="/oc-client/client.js"></script>
-    ${appBlock({ name: pkg.name, version: pkg.version, entry: appEntry })}
+    ${appBlock({ name, version, entry: appEntry })}
   </body>
 </html>
   `;
@@ -127,8 +75,8 @@ async function getHtmlTemplate(appBlock, filePath = 'index.html') {
         }
       </script>
       ${appBlock({
-            name: pkg.name,
-            version: pkg.version,
+            name,
+            version,
             entry: appEntry,
         })}</body>`);
     }
@@ -141,6 +89,7 @@ async function createServer({ template, port, }) {
     const { dev: clientJs } = oc_client_browser_1.default.compileSync();
     const app = (0, express_1.default)();
     const dataProvider = getDataProvider();
+    const plugins = (0, get_mocked_plugins_1.default)(node_path_1.default.join(process.cwd(), '..'));
     for (const plugin of plugins) {
         plugin.register.register(null, null, () => { });
     }
@@ -161,7 +110,7 @@ async function createServer({ template, port, }) {
     app.post('/', async (req, res, next) => {
         try {
             const { action, parameters } = req.body.components[0];
-            const { context, responseHeaders } = getContext(req, parameters, action);
+            const { context, responseHeaders } = (0, oc_1.getContext)(plugins, req, parameters, action);
             const props = await dataProvider(context);
             const response = [
                 {
@@ -192,7 +141,7 @@ async function createServer({ template, port, }) {
         const url = req.originalUrl;
         try {
             const params = defaultParams;
-            const { context, responseHeaders } = getContext(req, params);
+            const { context, responseHeaders } = (0, oc_1.getContext)(plugins, req, params);
             let htmlTemplate = await getHtmlTemplate(template.appBlock);
             const data = await dataProvider(context);
             htmlTemplate = htmlTemplate.replace('__INITIAL_DATA__', JSON.stringify(data));
@@ -210,63 +159,4 @@ async function createServer({ template, port, }) {
     app.listen(port);
     console.log(`Listening on: http://localhost:${port}`);
 }
-const major = Number(process.versions.node.split('.')[0]) || 0;
-if (major < 22) {
-    console.error('This script requires Node.js v22 or higher');
-    process.exit(1);
-}
-function cli(template) {
-    const { positionals: [command], values: { help, port = '5000' }, } = (0, node_util_1.parseArgs)({
-        allowPositionals: true,
-        options: {
-            port: {
-                type: 'string',
-                default: '5000',
-                short: 'p',
-            },
-            help: {
-                type: 'boolean',
-                default: false,
-                short: 'h',
-            },
-        },
-    });
-    if (help || !command) {
-        console.log(`
-    Usage:
-      $ oc-server <command> [options]
-
-    Commands:
-      dev         Start the development server
-
-    Options:
-      -h, --help  Display this message
-    `);
-        if (help && command === 'dev') {
-            console.log(`
-    Usage:
-      $ oc-server <command> [options]
-
-    Commands:
-      dev         Start the development server
-
-    Options:
-      -h, --help  Display this message
-      -p, --port  Port to use (default: 5000)
-    `);
-        }
-        process.exit(0);
-    }
-    if (command === 'dev') {
-        createServer({ template, port });
-    }
-}
-let template;
-try {
-    template = require(`${pkg.oc?.files?.template?.type}-compiler/dist/lib/hmr`);
-}
-catch (e) {
-    console.error(`The template ${pkg.oc?.files?.template?.type} is not supported. Try updating to the last version`);
-    process.exit(1);
-}
-cli(template);
+exports.createServer = createServer;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "oc-server",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "bin": "dist/cli.js",
+  "bin": "dist/cli/index.js",
   "scripts": {
     "build": "tsc",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
@@ -21,10 +21,11 @@
     "dist/**"
   ],
   "license": "MIT",
-  "dependencies": {
-    "oc": "^0.49.57"
-  },
   "devDependencies": {
     "@types/express": "^4.17.21"
+  },
+  "dependencies": {
+    "express": "^4.19.2",
+    "oc-client-browser": "^1.8.0"
   }
-}
+}