@contentstack/cli-cm-export 1.10.2 → 1.10.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Contentstack
+Copyright (c) 2024 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/1.10.2 linux-x64 node-v18.18.2
+@contentstack/cli-cm-export/1.10.4 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -10,6 +10,7 @@ const config = {
         'https://eu-api.contentstack.com': 'https://eu-developerhub-api.contentstack.com',
         'https://azure-na-api.contentstack.com': 'https://azure-na-developerhub-api.contentstack.com',
         'https://azure-eu-api.contentstack.com': 'https://azure-eu-developerhub-api.contentstack.com',
+        'https://gcp-na-api.contentstack.com': 'https://gcp-na-developerhub-api.contentstack.com',
     },
     // use below hosts for eu region
     // host:'https://eu-api.contentstack.com/v3',
@@ -17,6 +18,8 @@ const config = {
     // host:'https://azure-na-api.contentstack.com/v3',
     // use below hosts for azure-eu region
     // host:'https://azure-eu-api.contentstack.com/v3',
+    // use below hosts for gcp-na region
+    // host: 'https://gcp-na-api.contentstack.com'
     modules: {
         types: [
             'stack',

package/lib/export/modules/marketplace-apps.d.ts

@@ -1,18 +1,52 @@
-import { NodeCrypto } from '@contentstack/cli-utilities';
-import BaseClass from './base-class';
-import { ModuleClassParams } from '../../types';
-export default class ExportMarketplaceApps extends BaseClass {
-    private httpClient;
-    private marketplaceAppConfig;
-    private listOfApps;
-    private installedApps;
+import { NodeCrypto, ContentstackMarketplaceClient } from '@contentstack/cli-utilities';
+import { ModuleClassParams, MarketplaceAppsConfig, ExportConfig, Installation } from '../../types';
+export default class ExportMarketplaceApps {
+    protected marketplaceAppConfig: MarketplaceAppsConfig;
+    protected installedApps: Installation[];
     developerHubBaseUrl: string;
     marketplaceAppPath: string;
     nodeCrypto: NodeCrypto;
-    constructor({ exportConfig, stackAPIClient }: ModuleClassParams);
+    appSdk: ContentstackMarketplaceClient;
+    exportConfig: ExportConfig;
+    constructor({ exportConfig }: Omit<ModuleClassParams, 'stackAPIClient' | 'moduleName'>);
     start(): Promise<void>;
-    setHttpClient(): Promise<void>;
-    getAllStackSpecificApps(skip?: number): Promise<any>;
-    exportInstalledExtensions(): Promise<void>;
+    /**
+     * The function `exportApps` encrypts the configuration of installed apps using a Node.js crypto
+     * library if it is available.
+     */
+    exportApps(): Promise<any>;
+    /**
+     * The function `getAppManifestAndAppConfig` exports the manifest and configurations of installed
+     * marketplace apps.
+     */
+    getAppManifestAndAppConfig(): Promise<void>;
+    /**
+     * The function `getPrivateAppsManifest` fetches the manifest of a private app and assigns it to the
+     * `manifest` property of the corresponding installed app.
+     * @param {number} index - The `index` parameter is a number that represents the position of the app
+     * in an array or list. It is used to identify the specific app in the `installedApps` array.
+     * @param {App} appInstallation - The `appInstallation` parameter is an object that represents the
+     * installation details of an app. It contains information such as the UID (unique identifier) of the
+     * app's manifest.
+     */
+    getPrivateAppsManifest(index: number, appInstallation: Installation): Promise<void>;
+    /**
+     * The function `getAppConfigurations` exports the configuration of an app installation and encrypts
+     * the server configuration if it exists.
+     * @param {number} index - The `index` parameter is a number that represents the index of the app
+     * installation in an array or list. It is used to identify the specific app installation that needs
+     * to be processed or accessed.
+     * @param {any} appInstallation - The `appInstallation` parameter is an object that represents the
+     * installation details of an app. It contains information such as the app's manifest, unique
+     * identifier (uid), and other installation data.
+     */
     getAppConfigurations(index: number, appInstallation: any): Promise<void>;
+    /**
+     * The function `getStackSpecificApps` retrieves a collection of marketplace apps specific to a stack
+     * and stores them in the `installedApps` array.
+     * @param [skip=0] - The `skip` parameter is used to determine the number of items to skip in the API
+     * response. It is used for pagination purposes, allowing you to fetch a specific range of items from
+     * the API. In this code, it is initially set to 0, indicating that no items should be skipped in
+     */
+    getStackSpecificApps(skip?: number): Promise<void>;
 }

package/lib/export/modules/marketplace-apps.js

@@ -4,19 +4,17 @@ const tslib_1 = require("tslib");
 const map_1 = tslib_1.__importDefault(require("lodash/map"));
 const has_1 = tslib_1.__importDefault(require("lodash/has"));
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
+const omitBy_1 = tslib_1.__importDefault(require("lodash/omitBy"));
 const entries_1 = tslib_1.__importDefault(require("lodash/entries"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../../utils");
-const base_class_1 = tslib_1.__importDefault(require("./base-class"));
-class ExportMarketplaceApps extends base_class_1.default {
-    constructor({ exportConfig, stackAPIClient }) {
-        super({ exportConfig, stackAPIClient });
-        this.httpClient = new cli_utilities_1.HttpClient();
-        this.marketplaceAppConfig = exportConfig.modules.marketplace_apps;
-        this.listOfApps = [];
+class ExportMarketplaceApps {
+    constructor({ exportConfig }) {
         this.installedApps = [];
+        this.exportConfig = exportConfig;
+        this.marketplaceAppConfig = exportConfig.modules.marketplace_apps;
     }
     async start() {
         if (!(0, cli_utilities_1.isAuthenticated)()) {
@@ -28,48 +26,42 @@ class ExportMarketplaceApps extends base_class_1.default {
         await utils_1.fsUtil.makeDirectory(this.marketplaceAppPath);
         this.developerHubBaseUrl = this.exportConfig.developerHubBaseUrl || (await (0, utils_1.getDeveloperHubUrl)(this.exportConfig));
         this.exportConfig.org_uid = await (0, utils_1.getOrgUid)(this.exportConfig);
-        await this.setHttpClient();
-        await this.getAllStackSpecificApps();
-        this.installedApps = this.listOfApps;
-        await this.exportInstalledExtensions();
-    }
-    async setHttpClient() {
-        if (!this.exportConfig.auth_token) {
-            this.httpClient = new cli_utilities_1.OauthDecorator(this.httpClient);
-            const headers = await this.httpClient.preHeadersCheck(this.exportConfig);
-            this.httpClient = this.httpClient.headers(headers);
-        }
-        else {
-            this.httpClient = new cli_utilities_1.HttpClientDecorator(this.httpClient);
-            this.httpClient.headers(this.exportConfig);
-        }
+        // NOTE init marketplace app sdk
+        const host = this.developerHubBaseUrl.split('://').pop();
+        this.appSdk = await (0, cli_utilities_1.marketplaceSDKClient)({ host });
+        await this.exportApps();
     }
-    async getAllStackSpecificApps(skip = 0) {
-        const data = await (0, utils_1.getStackSpecificApps)({
-            developerHubBaseUrl: this.developerHubBaseUrl,
-            config: this.exportConfig,
-            skip,
-        });
-        const { data: apps, count } = data;
-        if (!this.nodeCrypto && (0, find_1.default)(apps, (app) => !(0, isEmpty_1.default)(app.configuration))) {
+    /**
+     * The function `exportApps` encrypts the configuration of installed apps using a Node.js crypto
+     * library if it is available.
+     */
+    async exportApps() {
+        await this.getStackSpecificApps();
+        await this.getAppManifestAndAppConfig();
+        if (!this.nodeCrypto && (0, find_1.default)(this.installedApps, (app) => !(0, isEmpty_1.default)(app.configuration))) {
             this.nodeCrypto = await (0, utils_1.createNodeCryptoInstance)(this.exportConfig);
         }
-        const stackApps = (0, map_1.default)(apps, (app) => {
+        this.installedApps = (0, map_1.default)(this.installedApps, (app) => {
             if ((0, has_1.default)(app, 'configuration')) {
                 app['configuration'] = this.nodeCrypto.encrypt(app.configuration);
             }
             return app;
         });
-        this.listOfApps = [...this.listOfApps, ...stackApps];
-        if (count - (skip + 50) > 0) {
-            return await this.getAllStackSpecificApps(skip + 50);
-        }
     }
-    async exportInstalledExtensions() {
+    /**
+     * The function `getAppManifestAndAppConfig` exports the manifest and configurations of installed
+     * marketplace apps.
+     */
+    async getAppManifestAndAppConfig() {
         if ((0, isEmpty_1.default)(this.installedApps)) {
             (0, utils_1.log)(this.exportConfig, 'No marketplace apps found', 'info');
         }
         else {
+            for (const [index, app] of (0, entries_1.default)(this.installedApps)) {
+                if (app.manifest.visibility === 'private') {
+                    await this.getPrivateAppsManifest(+index, app);
+                }
+            }
             for (const [index, app] of (0, entries_1.default)(this.installedApps)) {
                 await this.getAppConfigurations(+index, app);
             }
@@ -77,24 +69,54 @@ class ExportMarketplaceApps extends base_class_1.default {
             (0, utils_1.log)(this.exportConfig, 'All the marketplace apps have been exported successfully', 'info');
         }
     }
-    async getAppConfigurations(index, appInstallation) {
-        var _a, _b;
-        const sdkClient = await (0, cli_utilities_1.managementSDKClient)({
-            host: this.developerHubBaseUrl.split('://').pop(),
+    /**
+     * The function `getPrivateAppsManifest` fetches the manifest of a private app and assigns it to the
+     * `manifest` property of the corresponding installed app.
+     * @param {number} index - The `index` parameter is a number that represents the position of the app
+     * in an array or list. It is used to identify the specific app in the `installedApps` array.
+     * @param {App} appInstallation - The `appInstallation` parameter is an object that represents the
+     * installation details of an app. It contains information such as the UID (unique identifier) of the
+     * app's manifest.
+     */
+    async getPrivateAppsManifest(index, appInstallation) {
+        const manifest = await this.appSdk
+            .marketplace(this.exportConfig.org_uid)
+            .app(appInstallation.manifest.uid)
+            .fetch({ include_oauth: true })
+            .catch((error) => {
+            (0, utils_1.log)(this.exportConfig, error, 'error');
         });
+        if (manifest) {
+            this.installedApps[index].manifest = manifest;
+        }
+    }
+    /**
+     * The function `getAppConfigurations` exports the configuration of an app installation and encrypts
+     * the server configuration if it exists.
+     * @param {number} index - The `index` parameter is a number that represents the index of the app
+     * installation in an array or list. It is used to identify the specific app installation that needs
+     * to be processed or accessed.
+     * @param {any} appInstallation - The `appInstallation` parameter is an object that represents the
+     * installation details of an app. It contains information such as the app's manifest, unique
+     * identifier (uid), and other installation data.
+     */
+    async getAppConfigurations(index, appInstallation) {
+        var _a;
         const appName = (_a = appInstallation === null || appInstallation === void 0 ? void 0 : appInstallation.manifest) === null || _a === void 0 ? void 0 : _a.name;
         (0, utils_1.log)(this.exportConfig, `Exporting ${appName} app and it's config.`, 'info');
-        await sdkClient
-            .organization(this.exportConfig.org_uid)
-            .app((_b = appInstallation === null || appInstallation === void 0 ? void 0 : appInstallation.manifest) === null || _b === void 0 ? void 0 : _b.uid)
-            .installation(appInstallation === null || appInstallation === void 0 ? void 0 : appInstallation.uid)
+        await this.appSdk
+            .marketplace(this.exportConfig.org_uid)
+            .installation(appInstallation.uid)
             .installationData()
             .then(async (result) => {
             const { data, error } = result;
-            if ((0, has_1.default)(data, 'server_configuration')) {
-                if (!this.nodeCrypto && (0, has_1.default)(data, 'server_configuration')) {
+            if ((0, has_1.default)(data, 'server_configuration') || (0, has_1.default)(data, 'configuration')) {
+                if (!this.nodeCrypto && ((0, has_1.default)(data, 'server_configuration') || (0, has_1.default)(data, 'configuration'))) {
                     this.nodeCrypto = await (0, utils_1.createNodeCryptoInstance)(this.exportConfig);
                 }
+                if (!(0, isEmpty_1.default)(data === null || data === void 0 ? void 0 : data.configuration)) {
+                    this.installedApps[index]['configuration'] = this.nodeCrypto.encrypt(data.configuration);
+                }
                 if (!(0, isEmpty_1.default)(data === null || data === void 0 ? void 0 : data.server_configuration)) {
                     this.installedApps[index]['server_configuration'] = this.nodeCrypto.encrypt(data.server_configuration);
                     (0, utils_1.log)(this.exportConfig, `Exported ${appName} app and it's config.`, 'success');
@@ -113,5 +135,35 @@ class ExportMarketplaceApps extends base_class_1.default {
             (0, utils_1.log)(this.exportConfig, error, 'error');
         });
     }
+    /**
+     * The function `getStackSpecificApps` retrieves a collection of marketplace apps specific to a stack
+     * and stores them in the `installedApps` array.
+     * @param [skip=0] - The `skip` parameter is used to determine the number of items to skip in the API
+     * response. It is used for pagination purposes, allowing you to fetch a specific range of items from
+     * the API. In this code, it is initially set to 0, indicating that no items should be skipped in
+     */
+    async getStackSpecificApps(skip = 0) {
+        const collection = await this.appSdk
+            .marketplace(this.exportConfig.org_uid)
+            .installation()
+            .fetchAll({ target_uids: this.exportConfig.source_stack, skip })
+            .catch((error) => {
+            (0, utils_1.log)(this.exportConfig, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.exportConfig, error, 'error');
+        });
+        if (collection) {
+            const { items: apps, count } = collection;
+            // NOTE Remove all the chain functions
+            const installation = (0, map_1.default)(apps, (app) => (0, omitBy_1.default)(app, (val, _key) => {
+                if (val instanceof Function)
+                    return true;
+                return false;
+            }));
+            this.installedApps = this.installedApps.concat(installation);
+            if (count - (skip + 50) > 0) {
+                await this.getStackSpecificApps(skip + 50);
+            }
+        }
+    }
 }
 exports.default = ExportMarketplaceApps;

package/lib/types/index.d.ts

@@ -106,3 +106,4 @@ export interface TermsConfig {
 }
 export { default as DefaultConfig } from './default-config';
 export { default as ExportConfig } from './export-config';
+export * from './marketplace-app';

package/lib/types/index.js

@@ -1,2 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./marketplace-app"), exports);

package/lib/types/marketplace-app.d.ts

@@ -0,0 +1,54 @@
+type AppLocation = 'cs.cm.stack.config' | 'cs.cm.stack.dashboard' | 'cs.cm.stack.sidebar' | 'cs.cm.stack.custom_field' | 'cs.cm.stack.rte' | 'cs.cm.stack.asset_sidebar' | 'cs.org.config';
+interface ExtensionMeta {
+    uid?: string;
+    name?: string;
+    description?: string;
+    path?: string;
+    signed: boolean;
+    extension_uid?: string;
+    data_type?: string;
+    enabled?: boolean;
+    width?: number;
+    blur?: boolean;
+    default_width?: 'full' | 'half';
+}
+interface Extension {
+    type: AppLocation;
+    meta: ExtensionMeta[];
+}
+interface LocationConfiguration {
+    signed: boolean;
+    base_url: string;
+    locations: Extension[];
+}
+interface AnyProperty {
+    [propName: string]: any;
+}
+type Manifest = {
+    uid: string;
+    name: string;
+    icon?: string;
+    hosting?: any;
+    version?: number;
+    description: string;
+    organization_uid: string;
+    framework_version?: string;
+    oauth?: any;
+    webhook?: any;
+    ui_location: LocationConfiguration;
+    target_type: 'stack' | 'organization';
+    visibility: 'private' | 'public' | 'public_unlisted';
+} & AnyProperty;
+type Installation = {
+    uid: string;
+    status: string;
+    manifest: Manifest;
+    configuration: any;
+    server_configuration: any;
+    target: {
+        type: string;
+        uid: string;
+    };
+    ui_location: LocationConfiguration;
+} & AnyProperty;
+export { Installation, Manifest };

package/lib/types/marketplace-app.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/marketplace-app-helper.d.ts

@@ -3,8 +3,3 @@ import { ExportConfig } from '../types';
 export declare const getDeveloperHubUrl: (exportConfig: ExportConfig) => Promise<any>;
 export declare function getOrgUid(config: ExportConfig): Promise<string>;
 export declare function createNodeCryptoInstance(config: ExportConfig): Promise<NodeCrypto>;
-export declare const getStackSpecificApps: (params: {
-    developerHubBaseUrl: string;
-    config: ExportConfig;
-    skip: number;
-}) => Promise<any>;

package/lib/utils/marketplace-app-helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStackSpecificApps = exports.createNodeCryptoInstance = exports.getOrgUid = exports.getDeveloperHubUrl = void 0;
+exports.createNodeCryptoInstance = exports.getOrgUid = exports.getDeveloperHubUrl = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../utils");
 const interactive_1 = require("./interactive");
@@ -45,18 +45,3 @@ async function createNodeCryptoInstance(config) {
     return new cli_utilities_1.NodeCrypto(cryptoArgs);
 }
 exports.createNodeCryptoInstance = createNodeCryptoInstance;
-const getStackSpecificApps = async (params) => {
-    const { developerHubBaseUrl, config, skip } = params;
-    const appSdkAxiosInstance = await (0, cli_utilities_1.managementSDKClient)({
-        endpoint: developerHubBaseUrl,
-    });
-    return appSdkAxiosInstance.axiosInstance
-        .get(`${developerHubBaseUrl}/installations?target_uids=${config.source_stack}&skip=${skip}`, {
-        headers: {
-            organization_uid: config.org_uid,
-        },
-    })
-        .then((data) => data.data)
-        .catch((error) => (0, utils_1.log)(config, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error'));
-};
-exports.getStackSpecificApps = getStackSpecificApps;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.10.2",
+  "version": "1.10.4",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.10.2",
+  "version": "1.10.4",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.8",
+    "@contentstack/cli-utilities": "~1.5.11",
     "@oclif/core": "^2.9.3",
     "async": "^3.2.4",
     "big-json": "^3.2.0",
@@ -25,10 +25,10 @@
   },
   "devDependencies": {
     "@contentstack/cli-auth": "~1.3.17",
-    "@contentstack/cli-config": "~1.4.15",
+    "@contentstack/cli-config": "~1.6.0",
     "@contentstack/cli-dev-dependencies": "~1.2.4",
     "@oclif/plugin-help": "^5.1.19",
-    "@oclif/test": "^1.2.6",
+    "@oclif/test": "^2.5.6",
     "@types/big-json": "^3.2.0",
     "@types/mkdirp": "^1.0.2",
     "@types/progress-stream": "^2.0.2",
@@ -98,4 +98,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}