oc 0.50.26 → 0.50.28

package/.github/workflows/node.js.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## Change Log
 
+### v0.50.28
+- [#1442](https://github.com/opencomponents/oc/pull/1442) add routes option in oc.json
+- [#1441](https://github.com/opencomponents/oc/pull/1441) add preload option
+- [#1440](https://github.com/opencomponents/oc/pull/1440) validate command
+- [#1439](https://github.com/opencomponents/oc/pull/1439) add editable fields
+- [#1436](https://github.com/opencomponents/oc/pull/1436) add preview overlay
+- [#1438](https://github.com/opencomponents/oc/pull/1438) feat: add setCookie functionality to component context
+
+### v0.50.27
+- [#1435](https://github.com/opencomponents/oc/pull/1435) Fix loading info correctly
+
 ### v0.50.26
 - [#1434](https://github.com/opencomponents/oc/pull/1434) add fallback client option and new oc.json section for dev
 

package/dist/cli/commands.d.ts

@@ -132,6 +132,25 @@ declare const _default: {
             description: string;
             usage: string;
         };
+        validate: {
+            cmd: string;
+            example: {
+                cmd: string;
+            };
+            options: {
+                skipPackage: {
+                    boolean: boolean;
+                    description: string;
+                    default: boolean;
+                };
+                registries: {
+                    array: boolean;
+                    description: string;
+                };
+            };
+            description: string;
+            usage: string;
+        };
         registry: {
             cmd: string;
             description: string;

package/dist/cli/commands.js

@@ -132,6 +132,25 @@ exports.default = {
             description: 'Publish a component',
             usage: 'Usage: $0 publish <componentPath>'
         },
+        validate: {
+            cmd: 'validate <componentPath>',
+            example: {
+                cmd: '$0 validate my-new-component/'
+            },
+            options: {
+                skipPackage: {
+                    boolean: true,
+                    description: 'Skip packaging step and validate existing package.json',
+                    default: false
+                },
+                registries: {
+                    array: true,
+                    description: 'List of registries to validate against. This setting will take precedence over oc.json file'
+                }
+            },
+            description: 'Validate a component against registry requirements without publishing',
+            usage: 'Usage: $0 validate <componentPath>'
+        },
         registry: {
             cmd: 'registry <command>',
             description: 'Manage oc registries in the current project',

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

@@ -7,5 +7,5 @@ interface PluginMock {
         execute: (...args: unknown[]) => unknown;
     };
 }
-export default function getMockedPlugins(logger: Logger, componentsDir: string): PluginMock[];
+export default function getMockedPlugins(logger: Logger, componentsDir?: string): PluginMock[];
 export {};

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

@@ -5,9 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = getMockedPlugins;
 const node_path_1 = __importDefault(require("node:path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
 const resources_1 = __importDefault(require("../../resources/"));
-const settings_1 = __importDefault(require("../../resources/settings"));
 const ocConfig_1 = require("./ocConfig");
 const isMockValid = (plugin) => {
     const isFunction = typeof plugin === 'function';
@@ -57,29 +55,13 @@ const registerDynamicMocks = (ocJsonLocation, mocks, logger) => Object.entries(m
     };
 })
     .filter((pluginMock) => !!pluginMock);
-const findPath = (pathToResolve, fileName) => {
-    const rootDir = fs_extra_1.default.realpathSync('.');
-    const fileToResolve = node_path_1.default.join(pathToResolve, fileName);
-    if (!fs_extra_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(logger, componentsDir) {
     componentsDir = node_path_1.default.resolve(componentsDir || '.');
     let plugins = [];
-    const ocJsonFileName = settings_1.default.configFile.src.replace('./', '');
-    const ocJsonPath = findPath(componentsDir, ocJsonFileName);
-    if (!ocJsonPath) {
-        return plugins;
-    }
-    const content = (0, ocConfig_1.getOcConfig)(ocJsonPath);
-    const ocJsonLocation = ocJsonPath.slice(0, -ocJsonFileName.length);
+    const content = (0, ocConfig_1.getOcConfig)(componentsDir);
+    const ocJsonLocation = content.sourcePath
+        ? node_path_1.default.dirname(content.sourcePath)
+        : componentsDir;
     if (!content.development?.plugins) {
         return plugins;
     }

package/dist/cli/domain/ocConfig.d.ts

@@ -5,6 +5,16 @@ export interface OpenComponentsConfig {
     registries?: string[];
     /** Development-specific configuration settings */
     development?: {
+        /** Additional Express routes to mount on the registry application */
+        routes?: Array<{
+            route: string;
+            method: string;
+            handler: string;
+        }>;
+        /** JavaScript code to be included in the preview HTML's <head> section.
+         * Can be either a filepath to a JS script or inline JavaScript code.
+         */
+        preload?: string;
         /** Fallback configuration for when components cannot be found locally */
         fallback?: {
             /** URL of the fallback registry to use when components cannot be found locally */
@@ -32,8 +42,15 @@ export interface OpenComponentsConfig {
     };
 }
 type ParsedConfig = {
+    sourcePath?: string;
     registries: string[];
     development: {
+        routes?: Array<{
+            route: string;
+            method: string;
+            handler: string;
+        }>;
+        preload?: string;
         plugins: {
             dynamic?: Record<string, string>;
             static?: Record<string, string>;
@@ -44,6 +61,6 @@ type ParsedConfig = {
         };
     };
 };
-export declare function getOcConfig(path?: string): ParsedConfig;
+export declare function getOcConfig(folder?: string): ParsedConfig;
 export declare function setOcConfig(config: ParsedConfig, path?: string): void;
 export {};

package/dist/cli/domain/ocConfig.js

@@ -6,7 +6,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOcConfig = getOcConfig;
 exports.setOcConfig = setOcConfig;
 const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
 const settings_1 = __importDefault(require("../../resources/settings"));
+const findPath = (pathToResolve, fileName) => {
+    const rootDir = node_fs_1.default.realpathSync('.');
+    const fileToResolve = node_path_1.default.join(pathToResolve, fileName);
+    if (!node_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 parseConfig(config) {
     const plugins = {
         ...(config.mocks?.plugins || {}),
@@ -16,16 +30,22 @@ function parseConfig(config) {
         ...config,
         registries: config.registries || [],
         development: {
+            preload: config.development?.preload,
             plugins,
-            fallback: config.development?.fallback
+            fallback: config.development?.fallback,
+            routes: config.development?.routes
         }
     };
     return parsedConfig;
 }
-function getOcConfig(path) {
+function getOcConfig(folder) {
+    const configPath = folder
+        ? findPath(folder, settings_1.default.configFile.src.replace('./', '')) ||
+            settings_1.default.configFile.src
+        : settings_1.default.configFile.src;
     try {
-        const config = JSON.parse(node_fs_1.default.readFileSync(path || settings_1.default.configFile.src, 'utf8'));
-        return parseConfig(config);
+        const config = JSON.parse(node_fs_1.default.readFileSync(configPath, 'utf8'));
+        return { ...parseConfig(config), sourcePath: configPath };
     }
     catch {
         return {
@@ -37,5 +57,6 @@ function getOcConfig(path) {
     }
 }
 function setOcConfig(config, path) {
-    node_fs_1.default.writeFileSync(path || settings_1.default.configFile.src, JSON.stringify(parseConfig(config), null, 2));
+    const { sourcePath, ...rest } = config;
+    node_fs_1.default.writeFileSync(path || sourcePath || settings_1.default.configFile.src, JSON.stringify(rest, null, 2));
 }

package/dist/cli/domain/registry.d.ts

@@ -14,6 +14,10 @@ export default function registry(opts?: RegistryOptions): {
         path: string;
     }): Promise<void>;
     remove(registry: string): Promise<void>;
+    validateComponent(options: {
+        url: string;
+        packageJson: any;
+    }): Promise<void>;
 };
 export type RegistryCli = ReturnType<typeof registry>;
 export {};

package/dist/cli/domain/registry.js

@@ -144,6 +144,47 @@ function registry(opts = {}) {
             const res = (0, ocConfig_1.getOcConfig)();
             res.registries = res.registries?.filter((x) => x !== registry) || [];
             (0, ocConfig_1.setOcConfig)(res);
+        },
+        async validateComponent(options) {
+            try {
+                const response = await (0, undici_1.request)(options.url, {
+                    method: 'POST',
+                    headers: {
+                        ...requestsHeaders,
+                        'Content-Type': 'application/json'
+                    },
+                    body: JSON.stringify({ packageJson: options.packageJson })
+                });
+                if (response.statusCode === 404) {
+                    throw 'Registry URL is invalid or does not exist';
+                }
+                const result = (await response.body.json());
+                if (response.statusCode !== 200) {
+                    throw result;
+                }
+            }
+            catch (err) {
+                let parsedError = err;
+                let errMsg = '';
+                if (!parsedError || typeof parsedError !== 'object') {
+                    try {
+                        parsedError = JSON.parse(String(parsedError));
+                    }
+                    catch { }
+                }
+                if (!!parsedError.code && parsedError.code === 'ECONNREFUSED') {
+                    errMsg = 'Connection to registry has not been established';
+                }
+                else if (parsedError.code !== 'cli_version_not_valid' &&
+                    parsedError.code !== 'node_version_not_valid' &&
+                    !!parsedError.error) {
+                    errMsg = parsedError.error;
+                }
+                else {
+                    errMsg = parsedError;
+                }
+                throw errMsg;
+            }
         }
     };
 }

package/dist/cli/facade/dev.js

@@ -39,15 +39,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const node_path_1 = __importDefault(require("node:path"));
 const node_util_1 = require("node:util");
 const safe_1 = __importDefault(require("colors/safe"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
 const getport_1 = __importDefault(require("getport"));
 const livereload_1 = __importDefault(require("livereload"));
 const universalify_1 = require("universalify");
 const oc = __importStar(require("../../index"));
 const index_1 = __importDefault(require("../../resources/index"));
-const settings_1 = __importDefault(require("../../resources/settings"));
 const get_mocked_plugins_1 = __importDefault(require("../domain/get-mocked-plugins"));
 const handle_dependencies_1 = __importDefault(require("../domain/handle-dependencies"));
+const ocConfig_1 = require("../domain/ocConfig");
 const watch_1 = __importDefault(require("../domain/watch"));
 const cliMessages = index_1.default.messages.cli;
 const cliErrors = index_1.default.errors.cli;
@@ -59,9 +58,9 @@ const dev = ({ local, logger }) => (0, universalify_1.fromPromise)(async (opts)
     const baseUrl = opts.baseUrl || `http://localhost:${port}/`;
     let fallbackRegistryUrl = opts.fallbackRegistryUrl;
     let fallbackClient = false;
+    const localConfig = (0, ocConfig_1.getOcConfig)(componentsDir);
     if (!fallbackRegistryUrl) {
         try {
-            const localConfig = await fs_extra_1.default.readJson(settings_1.default.configFile.src);
             if (!fallbackRegistryUrl &&
                 typeof localConfig.development?.fallback?.url === 'string') {
                 fallbackRegistryUrl = localConfig.development?.fallback?.url;
@@ -175,25 +174,34 @@ const dev = ({ local, logger }) => (0, universalify_1.fromPromise)(async (opts)
         const refresher = () => liveReloadServer.refresh('/');
         liveReload = { refresher, port: otherPort };
     }
-    const registry = oc.Registry({
-        baseUrl,
-        prefix: opts.prefix || '',
-        dependencies: dependencies.modules,
-        compileClient: true,
-        discovery: true,
-        env: { name: 'local' },
-        fallbackRegistryUrl,
-        fallbackClient,
-        hotReloading,
-        liveReloadPort: liveReload.port,
-        local: true,
-        postRequestPayloadSize,
-        components: opts.components,
-        path: node_path_1.default.resolve(componentsDir),
-        port,
-        templates: dependencies.templates,
-        verbosity: 1
-    });
+    let registry;
+    try {
+        registry = oc.Registry({
+            baseUrl,
+            prefix: opts.prefix || '',
+            dependencies: dependencies.modules,
+            compileClient: true,
+            discovery: true,
+            env: { name: 'local' },
+            fallbackRegistryUrl,
+            fallbackClient,
+            hotReloading,
+            liveReloadPort: liveReload.port,
+            local: true,
+            postRequestPayloadSize,
+            components: opts.components,
+            path: node_path_1.default.resolve(componentsDir),
+            port,
+            templates: dependencies.templates,
+            verbosity: 1,
+            preload: localConfig.development?.preload,
+            routes: localConfig.development?.routes
+        });
+    }
+    catch (err) {
+        logger.err(String(err));
+        throw err;
+    }
     registerPlugins(registry);
     logger.warn(cliMessages.REGISTRY_STARTING(baseUrl));
     if (liveReload.port) {

package/dist/cli/facade/validate.d.ts

@@ -0,0 +1,20 @@
+import type { Local } from '../domain/local';
+import type { RegistryCli } from '../domain/registry';
+import type { Logger } from '../logger';
+declare const validate: ({ logger, registry, local }: {
+    logger: Logger;
+    registry: RegistryCli;
+    local: Local;
+}) => {
+    (opts: {
+        componentPath: string;
+        skipPackage?: boolean;
+        registries?: string[];
+    }): Promise<void>;
+    (opts: {
+        componentPath: string;
+        skipPackage?: boolean;
+        registries?: string[];
+    }, arguments__1: (error: unknown, value: void) => void): void;
+};
+export default validate;

package/dist/cli/facade/validate.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const safe_1 = __importDefault(require("colors/safe"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const universalify_1 = require("universalify");
+const index_1 = __importDefault(require("../../resources/index"));
+const handle_dependencies_1 = __importDefault(require("../domain/handle-dependencies"));
+const validate = ({ logger, registry, local }) => (0, universalify_1.fromPromise)(async (opts) => {
+    const componentPath = opts.componentPath;
+    const skipPackage = opts.skipPackage;
+    const packageDir = node_path_1.default.resolve(componentPath, '_package');
+    let errorMessage;
+    const readPackageJson = () => fs_extra_1.default.readJson(node_path_1.default.join(packageDir, 'package.json'));
+    const packageComponent = async () => {
+        logger.warn(index_1.default.messages.cli.PACKAGING(packageDir));
+        const packageOptions = {
+            production: true,
+            componentPath: node_path_1.default.resolve(componentPath)
+        };
+        const component = await local.package(packageOptions);
+        return component;
+    };
+    const validateComponentWithRegistry = async (options) => {
+        const { registryUrl, packageJson, componentName, componentVersion } = options;
+        const registryNormalised = registryUrl.replace(/\/$/, '');
+        const validateUrl = `${registryNormalised}/~registry/validate/${componentName}/${componentVersion}`;
+        logger.warn(`Validating component against registry: ${registryNormalised}`);
+        try {
+            await registry.validateComponent({
+                url: validateUrl,
+                packageJson
+            });
+            logger.ok(`✓ Validation successful for registry: ${registryNormalised}`);
+        }
+        catch (err) {
+            if (err.code === 'cli_version_not_valid') {
+                const upgradeCommand = index_1.default.commands.cli.UPGRADE(err.details.suggestedVersion);
+                const errorDetails = index_1.default.errors.cli.OC_CLI_VERSION_NEEDS_UPGRADE(safe_1.default.blue(upgradeCommand));
+                errorMessage = index_1.default.errors.cli.VALIDATION_FAIL(errorDetails);
+                logger.err(errorMessage);
+                throw errorMessage;
+            }
+            else if (err.code === 'node_version_not_valid') {
+                const details = index_1.default.errors.cli.NODE_CLI_VERSION_NEEDS_UPGRADE(err.details.suggestedVersion);
+                errorMessage = index_1.default.errors.cli.VALIDATION_FAIL(details);
+                logger.err(errorMessage);
+                throw errorMessage;
+            }
+            else {
+                if (err.message) {
+                    errorMessage = err.message;
+                }
+                else if (err && typeof err === 'object') {
+                    try {
+                        errorMessage = JSON.stringify(err);
+                    }
+                    catch {
+                        errorMessage = String(err);
+                    }
+                }
+                else {
+                    errorMessage = String(err);
+                }
+                errorMessage = `✗ Validation failed for registry ${registryNormalised}: ${errorMessage}`;
+                logger.err(errorMessage);
+                throw errorMessage;
+            }
+        }
+    };
+    const validateWithRegistries = async (registryLocations, component) => {
+        const packageJsonPath = node_path_1.default.join(packageDir, 'package.json');
+        const packageJson = await fs_extra_1.default.readJson(packageJsonPath);
+        for (const registryUrl of registryLocations) {
+            await validateComponentWithRegistry({
+                registryUrl,
+                packageJson,
+                componentName: component.name,
+                componentVersion: component.version
+            });
+        }
+    };
+    try {
+        const registryLocations = opts.registries || (await registry.get());
+        if (!skipPackage) {
+            await (0, handle_dependencies_1.default)({
+                components: [node_path_1.default.resolve(componentPath)],
+                logger
+            }).catch((err) => {
+                logger.err(err);
+                return Promise.reject(err);
+            });
+            const component = await packageComponent().catch((err) => {
+                errorMessage = index_1.default.errors.cli.PACKAGE_CREATION_FAIL(String(err));
+                logger.err(errorMessage);
+                return Promise.reject(errorMessage);
+            });
+            await validateWithRegistries(registryLocations, component);
+        }
+        else {
+            if (fs_extra_1.default.existsSync(packageDir)) {
+                const component = await readPackageJson().catch((err) => {
+                    logger.err(String(err));
+                    return Promise.reject(err);
+                });
+                await validateWithRegistries(registryLocations, component);
+            }
+            else {
+                errorMessage = index_1.default.errors.cli.PACKAGE_FOLDER_MISSING;
+                logger.err(errorMessage);
+                throw errorMessage;
+            }
+        }
+        logger.ok('✓ Component validation completed successfully for all registries');
+    }
+    catch (err) {
+        // Don't log again if it's already been logged by validateComponentWithRegistry
+        if (!String(err).includes('✗ Validation failed for registry')) {
+            logger.err(String(err));
+        }
+        throw err;
+    }
+});
+exports.default = validate;

package/dist/cli/index.js

@@ -20,6 +20,7 @@ const registry_2 = __importDefault(require("./facade/registry"));
 const registry_add_1 = __importDefault(require("./facade/registry-add"));
 const registry_ls_1 = __importDefault(require("./facade/registry-ls"));
 const registry_remove_1 = __importDefault(require("./facade/registry-remove"));
+const validate_1 = __importDefault(require("./facade/validate"));
 const logger_1 = __importDefault(require("./logger"));
 const validate_command_1 = __importDefault(require("./validate-command"));
 const cliFunctions = {
@@ -33,7 +34,8 @@ const cliFunctions = {
     registry: registry_2.default,
     'registry-add': registry_add_1.default,
     'registry-ls': registry_ls_1.default,
-    'registry-remove': registry_remove_1.default
+    'registry-remove': registry_remove_1.default,
+    validate: validate_1.default
 };
 const currentNodeVersion = process.version;
 const minSupportedVersion = '6.0.0';

package/dist/components/oc-client/_package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oc-client",
   "description": "The OpenComponents client-side javascript client",
-  "version": "0.50.26",
+  "version": "0.50.28",
   "repository": "https://github.com/opencomponents/oc/tree/master/components/oc-client",
   "author": "Matteo Figus <matteofigus@gmail.com>",
   "oc": {
@@ -22,14 +22,14 @@
       ],
       "dataProvider": {
         "type": "node.js",
-        "hashKey": "727f134cd2d1054490af2cba0fbd9ffcb9266a87",
+        "hashKey": "8d9e7c4d166e0630573f2c69470003476451d7c5",
         "src": "server.js",
         "size": 613
       }
     },
-    "version": "0.50.26",
+    "version": "0.50.28",
     "packaged": true,
-    "date": 1756236013592
+    "date": 1756715231220
   },
   "devDependencies": {
     "oc-template-es6-compiler": "^1.0.1"

package/dist/components/oc-client/_package/server.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=(t,s)=>{const{staticPath:e,templates:a}=t;return s(null,{staticPath:e,templates:a})},o=(t,s)=>{r(t,(e,a)=>{if(e)return s(e);if(a==null)return s(null,{__oc_emptyResponse:!0});const n=t.action?a:Object.assign({},a,{_staticPath:t.staticPath,_baseUrl:t.baseUrl,_componentName:"oc-client",_componentVersion:"0.50.26"}),c=t.staticPath.indexOf("http")===0?t.staticPath:"https:"+t.staticPath;return s(null,Object.assign({},{component:{key:"8b7545cba94f7c029b9d46108bfe8e4e6040ea09",src:c+"template.js",props:n}}))})};exports.data=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=(t,s)=>{const{staticPath:e,templates:a}=t;return s(null,{staticPath:e,templates:a})},o=(t,s)=>{r(t,(e,a)=>{if(e)return s(e);if(a==null)return s(null,{__oc_emptyResponse:!0});const n=t.action?a:Object.assign({},a,{_staticPath:t.staticPath,_baseUrl:t.baseUrl,_componentName:"oc-client",_componentVersion:"0.50.28"}),c=t.staticPath.indexOf("http")===0?t.staticPath:"https:"+t.staticPath;return s(null,Object.assign({},{component:{key:"8b7545cba94f7c029b9d46108bfe8e4e6040ea09",src:c+"template.js",props:n}}))})};exports.data=o;

package/dist/components/oc-client/_package/src/oc-client.js

@@ -1,4 +1,4 @@
-/*! OpenComponents client v2.1.3 | (c) 2015-2025 OpenComponents community | https://github.com/opencomponents/oc-client-browser/tree/master/LICENSES */
+/*! OpenComponents client v2.1.4 | (c) 2015-2025 OpenComponents community | https://github.com/opencomponents/oc-client-browser/tree/master/LICENSES */
 (() => {
   // <define:__EXTERNALS__>
   var define_EXTERNALS_default = [];
@@ -453,7 +453,7 @@
     oc2.conf = oc2.conf || {};
     oc2.cmd = oc2.cmd || [];
     oc2.renderedComponents = oc2.renderedComponents || {};
-    oc2.clientVersion = "2.1.3";
+    oc2.clientVersion = "2.1.4";
     let isRequired = (name, value) => {
       if (!value) {
         throw name + " parameter is required";