oc 0.50.59 → 0.50.61

package/dist/registry/index.js

@@ -37,7 +37,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = registry;
-const safe_1 = __importDefault(require("colors/safe"));
+const colors_1 = __importDefault(require("../utils/colors"));
+const deprecate_1 = __importDefault(require("../utils/deprecate"));
 const app_start_1 = __importDefault(require("./app-start"));
 const events_handler_1 = __importDefault(require("./domain/events-handler"));
 const options_sanitiser_1 = __importDefault(require("./domain/options-sanitiser"));
@@ -47,6 +48,19 @@ const server_adapter_1 = __importDefault(require("./domain/server-adapter"));
 const validator = __importStar(require("./domain/validators"));
 const middleware = __importStar(require("./middleware"));
 const router_1 = require("./router");
+const warnAboutCallback = () => (0, deprecate_1.default)({
+    id: 'registry-lifecycle-callbacks',
+    subject: 'Registry lifecycle callbacks',
+    replacement: 'the returned promises'
+});
+const toError = (error) => {
+    if (error instanceof Error) {
+        return error;
+    }
+    const errorLike = error;
+    const message = errorLike?.message ?? errorLike?.msg ?? error;
+    return new Error(String(message));
+};
 function registry(inputOptions) {
     const validationResult = validator.validateRegistryConfiguration(inputOptions);
     if (!validationResult.isValid) {
@@ -57,56 +71,100 @@ function registry(inputOptions) {
     const adapter = middleware.bind((0, server_adapter_1.default)(options.server.adapter, options.server.options), options);
     const app = adapter.native();
     const repository = (0, repository_1.default)(options);
-    const close = (callback) => {
+    const closePromise = () => {
         const closeMetadataStore = () => Promise.resolve(repository.close?.()).catch(() => undefined);
-        if (adapter.isListening()) {
+        const closeServer = new Promise((resolve, reject) => {
+            if (!adapter.isListening()) {
+                reject('not opened');
+                return;
+            }
             adapter.close((err) => {
-                void closeMetadataStore().finally(() => callback(err));
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    resolve();
+                }
             });
-            return;
+        });
+        return closeServer.finally(closeMetadataStore);
+    };
+    const close = (callback) => {
+        const promise = closePromise();
+        if (!callback) {
+            return promise;
         }
-        void closeMetadataStore().finally(() => callback('not opened'));
+        warnAboutCallback();
+        const callbackPromise = promise.then(() => callback(), (error) => {
+            callback(error);
+            throw error;
+        });
+        void callbackPromise.catch(() => undefined);
+        return callbackPromise;
     };
     const register = (plugin, callback) => {
+        if (callback) {
+            warnAboutCallback();
+        }
         plugins.push(Object.assign(plugin, { callback }));
+        return Promise.resolve();
     };
-    const start = async (callback) => {
-        const ok = (msg) => console.log(safe_1.default.green(msg));
+    const startPromise = async () => {
+        const ok = (msg) => console.log(colors_1.default.green(msg));
         try {
             options.plugins = await pluginsInitialiser.init(plugins);
             (0, router_1.create)(adapter, options, repository);
             const componentsInfo = await repository.init();
             await (0, app_start_1.default)(repository, options);
-            adapter.listen({
-                port: options.port,
-                timeout: options.timeout,
-                keepAliveTimeout: options.keepAliveTimeout
-            }, (err) => {
-                if (err) {
-                    return callback(err);
-                }
-                events_handler_1.default.fire('start', {});
-                if (options.verbosity) {
-                    ok(`Registry started at port http://localhost:${options.port}${options.prefix}`);
-                    if (componentsInfo) {
-                        const componentsNumber = Object.keys(componentsInfo.components).length;
-                        const componentsReleases = Object.values(componentsInfo.components).reduce((acc, component) => acc + Object.keys(component).length, 0);
-                        ok(`Registry serving ${componentsNumber} components for a total of ${componentsReleases} releases.`);
+            return await new Promise((resolve, reject) => {
+                adapter.listen({
+                    port: options.port,
+                    timeout: options.timeout,
+                    keepAliveTimeout: options.keepAliveTimeout
+                }, (err) => {
+                    if (err) {
+                        reject(toError(err));
+                        return;
                     }
-                }
-                callback(null, { app, server: adapter.httpServer() });
-            });
-            adapter.onServerError((error) => {
-                events_handler_1.default.fire('error', {
-                    code: 'EXPRESS_ERROR',
-                    message: error?.message ?? String(error)
+                    events_handler_1.default.fire('start', {});
+                    if (options.verbosity) {
+                        ok(`Registry started at port http://localhost:${options.port}${options.prefix}`);
+                        if (componentsInfo) {
+                            const componentsNumber = Object.keys(componentsInfo.components).length;
+                            const componentsReleases = Object.values(componentsInfo.components).reduce((acc, component) => acc + Object.keys(component).length, 0);
+                            ok(`Registry serving ${componentsNumber} components for a total of ${componentsReleases} releases.`);
+                        }
+                    }
+                    resolve({ app, server: adapter.httpServer() });
+                });
+                adapter.onServerError((error) => {
+                    events_handler_1.default.fire('error', {
+                        code: 'EXPRESS_ERROR',
+                        message: error?.message ?? String(error)
+                    });
+                    reject(toError(error));
                 });
-                callback(error);
             });
         }
         catch (err) {
-            callback(err?.msg || err);
+            throw toError(err);
+        }
+    };
+    const start = (callback) => {
+        const promise = startPromise();
+        if (!callback) {
+            return promise;
         }
+        warnAboutCallback();
+        const callbackPromise = promise.then((result) => {
+            callback(null, result);
+            return result;
+        }, (error) => {
+            callback(error);
+            throw error;
+        });
+        void callbackPromise.catch(() => undefined);
+        return callbackPromise;
     };
     return {
         close,

package/dist/registry/routes/helpers/get-component.js

@@ -463,7 +463,8 @@ function getComponent(conf, repository) {
             const staticPath = repository
                 .getStaticFilePath(component.name, component.version, '')
                 .replace(/^https:/, '');
-            if (!component.oc.files.dataProvider) {
+            const dataProviderDisabled = conf.dataProvider?.enabled === false;
+            if (dataProviderDisabled || !component.oc.files.dataProvider) {
                 const { __oc_Retry, ...props } = params;
                 props['_staticPath'] = staticPath;
                 props['_baseUrl'] = conf.baseUrl;

package/dist/resources/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const safe_1 = require("colors/safe");
+const colors_1 = require("../utils/colors");
 // Kind of long multi-string messages and functions
 const validFunctionMock = `// simplified mock signature
 module.exports = (a, b) => a+b;`;
@@ -23,24 +23,24 @@ const mockPluginIsNotValid = `Looks like you are trying to register a dynamic mo
 The entry point should be a synchronous function or an object containing an asynchronous register() function and a synchronous execute() function.
 Example:
 
-${(0, safe_1.yellow)(validFunctionMock)}
+${(0, colors_1.yellow)(validFunctionMock)}
 
-${(0, safe_1.yellow)(validMockObject)}`;
+${(0, colors_1.yellow)(validMockObject)}`;
 const initSuccess = (componentName, componentPath) => {
     const success = `Success! Created ${componentName} at ${componentPath}`;
-    return `${(0, safe_1.green)(success)}
+    return `${(0, colors_1.green)(success)}
 
 From here you can run several commands
 
-${(0, safe_1.green)('oc --help')}
+${(0, colors_1.green)('oc --help')}
 To see a detailed list of all the commands available
 
 We suggest that you begin by typing:
 
-${(0, safe_1.green)('oc dev . 3030')}
+${(0, colors_1.green)('oc dev . 3030')}
 
 If you have questions, issues or feedback about OpenComponents, please, join us on Gitter:
-${(0, safe_1.green)('https://gitter.im/opentable/oc')}
+${(0, colors_1.green)('https://gitter.im/opentable/oc')}
 
 Happy coding
 
@@ -156,7 +156,7 @@ exports.default = {
             cleanSuccess: 'Folders removed',
             initSuccess,
             installCompiler: (compiler) => `Installing ${compiler} from npm...`,
-            installCompilerSuccess: (template, compiler, version) => `${(0, safe_1.green)('✔')} Installed ${compiler} [${template} v${version}]`,
+            installCompilerSuccess: (template, compiler, version) => `${(0, colors_1.green)('✔')} Installed ${compiler} [${template} v${version}]`,
             legacyTemplateDeprecationWarning: (legacyType, newType) => `Template-type "${legacyType}" has been deprecated and is now replaced by "${newType}"`,
             CHANGES_DETECTED: (file) => `Changes detected on file: ${file}`,
             CHECKING_DEPENDENCIES: 'Ensuring dependencies are loaded...',

package/dist/types.d.ts

@@ -239,6 +239,23 @@ export interface Config<T = any, TServerAdapter extends HttpServerAdapterFactory
      * @example ["lodash", "moment"]
      */
     dependencies: string[];
+    /**
+     * Configuration for the data provider step, i.e. the component's `server.js`
+     * that produces the model consumed by the view.
+     */
+    dataProvider: {
+        /**
+         * Executes the component's own data provider (`server.js`) when it has one.
+         *
+         * When `false` the registry never fetches nor runs a component's data
+         * provider, even if one exists in the storage: every component is served
+         * through the same path used by components that ship no `server.js`, i.e.
+         * the request parameters are passed straight through as the view model.
+         *
+         * @default true
+         */
+        enabled: boolean;
+    };
     /**
      * Configuration object to enable/disable the HTML discovery page and the API
      */
@@ -279,11 +296,12 @@ export interface Config<T = any, TServerAdapter extends HttpServerAdapterFactory
         secure: boolean;
     }) => boolean;
     /**
-     * Environment variables passed to components in `context.env`.
+     * Environment values passed to components in `context.env` and the data
+     * provider's `process.env` shim.
      *
      * @default {}
      */
-    env: Record<string, string>;
+    env: Record<string, any>;
     /**
      * Maximum execution time of a component’s server-side logic, expressed in
      * seconds. When the timeout elapses the registry returns a 500 error.

package/dist/utils/colors.d.ts

@@ -0,0 +1,14 @@
+declare const colors: {
+    black: import("picocolors/types").Formatter;
+    red: import("picocolors/types").Formatter;
+    green: import("picocolors/types").Formatter;
+    yellow: import("picocolors/types").Formatter;
+    blue: import("picocolors/types").Formatter;
+    magenta: import("picocolors/types").Formatter;
+    cyan: import("picocolors/types").Formatter;
+    white: import("picocolors/types").Formatter;
+    gray: import("picocolors/types").Formatter;
+    grey: import("picocolors/types").Formatter;
+};
+export declare const black: import("picocolors/types").Formatter, red: import("picocolors/types").Formatter, green: import("picocolors/types").Formatter, yellow: import("picocolors/types").Formatter, blue: import("picocolors/types").Formatter, magenta: import("picocolors/types").Formatter, cyan: import("picocolors/types").Formatter, white: import("picocolors/types").Formatter, gray: import("picocolors/types").Formatter, grey: import("picocolors/types").Formatter;
+export default colors;

package/dist/utils/colors.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grey = exports.gray = exports.white = exports.cyan = exports.magenta = exports.blue = exports.yellow = exports.green = exports.red = exports.black = void 0;
+const picocolors_1 = __importDefault(require("picocolors"));
+const colors = {
+    black: picocolors_1.default.black,
+    red: picocolors_1.default.red,
+    green: picocolors_1.default.green,
+    yellow: picocolors_1.default.yellow,
+    blue: picocolors_1.default.blue,
+    magenta: picocolors_1.default.magenta,
+    cyan: picocolors_1.default.cyan,
+    white: picocolors_1.default.white,
+    gray: picocolors_1.default.gray,
+    grey: picocolors_1.default.gray
+};
+exports.black = colors.black, exports.red = colors.red, exports.green = colors.green, exports.yellow = colors.yellow, exports.blue = colors.blue, exports.magenta = colors.magenta, exports.cyan = colors.cyan, exports.white = colors.white, exports.gray = colors.gray, exports.grey = colors.grey;
+exports.default = colors;

package/dist/utils/deprecate.d.ts

@@ -0,0 +1,20 @@
+interface DeprecationNotice {
+    /** Stable identifier used to only warn once per process for this deprecation. */
+    id: string;
+    /** The option/API being removed. */
+    subject: string;
+    /** What to use instead. */
+    replacement: string;
+}
+/**
+ * Emits a single, consistent deprecation notice (once per process, per `id`)
+ * for a config option or API that will be removed in OpenComponents v1.
+ *
+ * Routes through `process.emitWarning` with type `DeprecationWarning`, so it
+ * honors the standard Node.js opt-out mechanisms (`--no-deprecation`, etc.)
+ * without needing a bespoke env var.
+ *
+ * This never changes runtime behavior - it is purely informational.
+ */
+export default function deprecate({ id, subject, replacement }: DeprecationNotice): void;
+export {};

package/dist/utils/deprecate.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = deprecate;
+const warned = new Set();
+/**
+ * Emits a single, consistent deprecation notice (once per process, per `id`)
+ * for a config option or API that will be removed in OpenComponents v1.
+ *
+ * Routes through `process.emitWarning` with type `DeprecationWarning`, so it
+ * honors the standard Node.js opt-out mechanisms (`--no-deprecation`, etc.)
+ * without needing a bespoke env var.
+ *
+ * This never changes runtime behavior - it is purely informational.
+ */
+function deprecate({ id, subject, replacement }) {
+    if (warned.has(id)) {
+        return;
+    }
+    warned.add(id);
+    process.emitWarning(`${subject} is deprecated and will be removed in OpenComponents v1 - use ${replacement} instead.`, 'DeprecationWarning');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "oc",
-	"version": "0.50.59",
+	"version": "0.50.61",
 	"description": "A framework for developing and distributing html components",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -39,7 +39,6 @@
 	"devDependencies": {
 		"@biomejs/biome": "^2.5.0",
 		"@types/accept-language-parser": "^1.5.8",
-		"@types/async": "^3.2.25",
 		"@types/bun": "^1.3.14",
 		"@types/cookie-parser": "^1.4.10",
 		"@types/cross-spawn": "^6.0.6",
@@ -74,11 +73,9 @@
 		"@rdevis/turbo-stream": "^2.4.1",
 		"@types/lodash.isequal": "^4.5.8",
 		"accept-language-parser": "^1.5.0",
-		"async": "^3.2.6",
 		"basic-auth-connect": "^1.1.0",
 		"builtin-modules": "^3.3.0",
 		"chokidar": "^4.0.3",
-		"colors": "^1.4.0",
 		"cookie-parser": "^1.4.7",
 		"cross-spawn": "^7.0.6",
 		"dependency-graph": "^1.0.0",
@@ -92,14 +89,14 @@
 		"livereload": "^0.10.3",
 		"lodash.isequal": "^4.5.0",
 		"morgan": "^1.11.0",
-		"multer": "^2.0.2",
+		"multer": "^2.2.0",
 		"nice-cache": "^0.0.5",
 		"oc-client": "^4.0.3",
 		"oc-client-browser": "^2.1.12",
 		"oc-empty-response-handler": "^1.0.2",
 		"oc-get-unix-utc-timestamp": "^1.0.6",
 		"oc-metadata-adapters-utils": "^0.1.1",
-		"oc-s3-storage-adapter": "^2.2.3",
+		"oc-s3-storage-adapter": "^2.2.4",
 		"oc-storage-adapters-utils": "^2.1.2",
 		"oc-template-es6": "^2.0.0",
 		"oc-template-es6-compiler": "^7.1.4",
@@ -109,6 +106,7 @@
 		"oc-template-jade-compiler": "^7.5.0",
 		"open": "^10.2.0",
 		"parse-author": "^2.0.0",
+		"picocolors": "^1.1.1",
 		"read": "^1.0.7",
 		"require-package-name": "^2.0.1",
 		"response-time": "^2.3.4",