@tridion-sites/extensions-cli 1.0.4 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+# @tridion-sites/extensions-cli
+
+## 1.1.0
+
+### Minor Changes
+
+-   1b257d330c: CLI supports serving local extensions with deployed ones, fix for package fields of open-api-client (`targetUrl` should be passed to `setupExtensionsResponse`)
+
+### Patch Changes
+
+-   d46c465289: run build before packing addon
+-   d0875fe171: update dependencies
+-   Updated dependencies [d398729dce]
+-   Updated dependencies [b37272386a]
+-   Updated dependencies [d0875fe171]
+-   Updated dependencies [151fa1d3b2]
+-   Updated dependencies [7ff24d55b8]
+-   Updated dependencies [14288f4588]
+-   Updated dependencies [c75025f64f]
+-   Updated dependencies [334d76210f]
+-   Updated dependencies [9e7f89cdc1]
+-   Updated dependencies [cc40577cf7]
+-   Updated dependencies [1b257d330c]
+    -   @tridion-sites/open-api-client@3.0.0
+    -   @tridion-sites/extensions@2.0.0
+    -   @tridion-sites/models@1.1.0

package/dist/addon/template/extension/devServer.js.hbs

@@ -35,6 +35,7 @@ export const getDevServerConfig = ({ targetUrl, manifestPath, addonConfigPath })
                 webAppPath,
                 manifestPath,
                 addonConfigPath,
+                targetUrl,
             });
 
             return middlewares;

package/dist/addon/template/extension/package.json.hbs

@@ -15,6 +15,7 @@
         "build": "webpack --config ./webpack.prod.config.js --progress",
         "dev": "webpack serve --config ./webpack.dev.config.js --progress --env target={{sitesUrl}} manifest=../manifest.json config=../{{addonId}}.config.json",
         "pack": "sites-extensions pack --manifest=../manifest.json --input=../dist --output=../",
+        "prepack": "npm run build",
         "lint": "eslint . --fix && prettier --write \"src/**/*\""
     },
     "peerDependencies": {
@@ -24,7 +25,7 @@
         "react": "18.2.0",
         "react-dom": "18.2.0",
         "styled-components": "5.3.6",
-        "tinymce": "6.4.2"
+        "tinymce": "6.7.1"
     },
     "devDependencies": {
         "@babel/core": "7.21.8",
@@ -58,7 +59,7 @@
         "react-dom": "18.2.0",
         "react-is": "18.2.0",
         "styled-components": "5.3.6",
-        "tinymce": "6.4.2",
+        "tinymce": "6.7.1",
         "tsconfig-paths-webpack-plugin": "4.0.1",
         "typescript": "5.0.4",
         "webpack": "5.82.1",

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import type { Application } from 'express';
 import type { FrontendAddon } from '@tridion-sites/open-api-client';
 
 export declare const extensionsRequestBasePath = "/api/uiExtensionsRepository";
@@ -9,26 +10,14 @@ export declare interface GetLocalFrontendAddonParams {
     addonConfigPath?: string;
 }
 
-declare interface Request_2 extends Record<string, any> {
-}
-
-declare type RequestListener = (request: Request_2, response: Response_2) => void;
-
-declare interface Response_2 extends Record<string, any> {
-    json: (result: any) => void;
-}
-
-export declare const setupExtensionsResponse: ({ app, webAppPath, manifestPath, addonConfigPath, }: SetupExtensionsResponseParams) => void;
-
-declare interface SetupExtensionsResponseApp extends Record<string, any> {
-    get: (path: string, listener: RequestListener) => void;
-}
+export declare const setupExtensionsResponse: ({ app, webAppPath, manifestPath, addonConfigPath, targetUrl, }: SetupExtensionsResponseParams) => void;
 
 export declare interface SetupExtensionsResponseParams {
-    app: SetupExtensionsResponseApp;
+    app: Application;
     webAppPath: string;
     manifestPath: string;
     addonConfigPath?: string;
+    targetUrl?: string;
 }
 
 export { }

package/dist/index.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 import { resolve, basename } from 'node:path';
 import { w as writeJsonFile, r as readJsonFile, A as AddonManifest } from './addonManifest-45b9450a.js';
+import { OpenAPI, ExtensionsService } from '@tridion-sites/open-api-client';
 import 'node:fs';
 
 class AddonConfiguration {
@@ -67,15 +68,45 @@ const getLocalFrontendAddon = ({ manifestPath, addonConfigPath }) => {
     return localAddon;
 };
 
-const setupExtensionsResponse = ({ app, webAppPath, manifestPath, addonConfigPath, }) => {
+const getHeadersFromRequest = (request) => {
+    const headers = {};
+    // The keys and values are in the same list. It is not a list of tuples. So, the even-numbered offsets are key values, and the odd-numbered offsets are the associated values.
+    // So iteration goes over n+2 starting from 0.
+    for (let index = 0; index < request.rawHeaders.length; index = index + 2) {
+        const key = request.rawHeaders[index];
+        const value = request.rawHeaders[index + 1];
+        headers[key] = value;
+    }
+    return headers;
+};
+/**
+ * Regexp to catch slashes at the end of url.
+ * @example
+ * http://domain.com/
+ * http://domain.com/ui/
+ * http://domain.com/broken//
+ */
+const endlineSlashesRegexp = /\/+$/gm;
+const setupExtensionsResponse = ({ app, webAppPath, manifestPath, addonConfigPath, targetUrl, }) => {
     const basePath = webAppPath.endsWith('/') ? webAppPath : `${webAppPath}/`;
-    app.get(`${basePath}api/v2.0/extensions`, (request, response) => {
+    app.get(`${basePath}api/v2.0/extensions`, async (request, response) => {
         const localAddon = getLocalFrontendAddon({
             manifestPath,
             addonConfigPath,
         });
-        const liveAddons = /*await ExtensionsService.getExtensions()*/ [];
-        const result = [...liveAddons, localAddon];
+        const result = [localAddon];
+        if (targetUrl) {
+            /**
+             * Extension service uses OpenAPI parameters for every call it makes.
+             * `BASE` should be assigned to base URL where API lives.
+             * `HEADERS` should include original request's cookies for authorization.
+             */
+            OpenAPI.BASE =
+                `${targetUrl.replace(endlineSlashesRegexp, '')}${basePath.replace(endlineSlashesRegexp, '')}` || '';
+            OpenAPI.HEADERS = getHeadersFromRequest(request);
+            const liveAddons = (await ExtensionsService.getExtensions()) || [];
+            result.push(...liveAddons);
+        }
         response.json(result);
     });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tridion-sites/extensions-cli",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "CLI to create, develop, build and package extensions for Tridion Sites",
   "author": "RWS",
   "homepage": "https://www.rws.com",
@@ -24,35 +24,36 @@
     "test": "sites-extensions"
   },
   "dependencies": {
-    "@tridion-sites/extensions": "1.0.3",
-    "@tridion-sites/models": "1.0.0",
-    "@tridion-sites/open-api-client": "2.0.0",
-    "archiver": "5.3.1",
-    "chalk": "5.2.0",
-    "commander": "10.0.0",
+    "@tridion-sites/extensions": "2.0.0",
+    "@tridion-sites/models": "1.1.0",
+    "@tridion-sites/open-api-client": "3.0.0",
+    "archiver": "6.0.1",
+    "chalk": "5.3.0",
+    "commander": "11.0.0",
     "cross-spawn": "7.0.3",
     "decamelize": "6.0.0",
-    "fs-extra": "11.1.0",
-    "handlebars": "4.7.7",
-    "inquirer": "9.1.4",
+    "fs-extra": "11.1.1",
+    "handlebars": "4.7.8",
+    "inquirer": "9.2.11",
     "valid-filename": "4.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "24.0.1",
-    "@rollup/plugin-node-resolve": "15.0.1",
-    "@rollup/plugin-typescript": "11.0.0",
-    "@types/archiver": "5.3.1",
-    "@types/compression": "1.7.2",
-    "@types/cross-spawn": "6.0.2",
+    "@rollup/plugin-commonjs": "25.0.4",
+    "@rollup/plugin-node-resolve": "15.2.1",
+    "@rollup/plugin-typescript": "11.1.3",
+    "@types/archiver": "5.3.2",
+    "@types/compression": "1.7.3",
+    "@types/cross-spawn": "6.0.3",
+    "@types/express": "4.17.18",
     "@types/fs-extra": "11.0.1",
     "@types/inquirer": "9.0.3",
-    "@types/node": "18.11.18",
-    "@web/rollup-plugin-copy": "0.3.0",
-    "rimraf": "4.1.2",
-    "rollup": "3.11.0",
+    "@types/node": "20.6.0",
+    "@web/rollup-plugin-copy": "0.4.0",
+    "rimraf": "5.0.1",
+    "rollup": "3.29.1",
     "rollup-plugin-delete": "2.0.0",
-    "rollup-plugin-node-externals": "5.1.0",
-    "typescript": "5.0.4",
+    "rollup-plugin-node-externals": "6.1.1",
+    "typescript": "5.2.2",
     "typescript-transform-paths": "3.4.6"
   }
 }