@contentstack/cli-utilities 1.18.5 → 1.19.0

package/lib/feature-status/build-auth-headers.d.ts

@@ -0,0 +1,9 @@
+export interface AuthHeaders {
+    [key: string]: string;
+}
+export declare function buildAuthHeaders(ctx?: {
+    managementToken?: string;
+    apiKey?: string;
+    authToken?: string;
+    orgUid?: string;
+}): AuthHeaders;

package/lib/feature-status/build-auth-headers.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAuthHeaders = void 0;
+const tslib_1 = require("tslib");
+const config_handler_1 = tslib_1.__importDefault(require("../config-handler"));
+function buildAuthHeaders(ctx) {
+    var _a, _b;
+    // 1. Management token takes priority (no 'Bearer' prefix — API contract)
+    if ((ctx === null || ctx === void 0 ? void 0 : ctx.managementToken) && (ctx === null || ctx === void 0 ? void 0 : ctx.apiKey)) {
+        return {
+            Authorization: ctx.managementToken,
+            api_key: ctx.apiKey,
+        };
+    }
+    // 2. OAuth
+    const oauthToken = config_handler_1.default.get('oauthAccessToken');
+    if (oauthToken) {
+        return { Authorization: `Bearer ${oauthToken}` };
+    }
+    // 3. Authtoken + organization_uid
+    const authtoken = (_a = ctx === null || ctx === void 0 ? void 0 : ctx.authToken) !== null && _a !== void 0 ? _a : config_handler_1.default.get('authtoken');
+    const orgUid = (_b = ctx === null || ctx === void 0 ? void 0 : ctx.orgUid) !== null && _b !== void 0 ? _b : config_handler_1.default.get('oauthOrgUid');
+    if (authtoken && orgUid) {
+        return { authtoken, organization_uid: orgUid };
+    }
+    // 4. Authtoken + api_key
+    if (authtoken && (ctx === null || ctx === void 0 ? void 0 : ctx.apiKey)) {
+        return { authtoken, api_key: ctx.apiKey };
+    }
+    throw new Error('PLAN_CHECK: Cannot build auth headers — no valid credentials available. ' +
+        'Please log in or provide a management token alias.');
+}
+exports.buildAuthHeaders = buildAuthHeaders;

package/lib/feature-status/feature-status-handler.d.ts

@@ -0,0 +1,3 @@
+import { FeatureStatus, FeatureCtx } from './types';
+export declare function isFeatureEnabled(featureUid: string, ctx?: FeatureCtx): Promise<FeatureStatus>;
+export declare function assertFeatureEnabled(featureUid: string, ctx?: FeatureCtx): Promise<FeatureStatus>;

package/lib/feature-status/feature-status-handler.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertFeatureEnabled = exports.isFeatureEnabled = void 0;
+const http_client_1 = require("../http-client");
+const resolve_auth_host_1 = require("./resolve-auth-host");
+const build_auth_headers_1 = require("./build-auth-headers");
+async function isFeatureEnabled(featureUid, ctx) {
+    const host = (0, resolve_auth_host_1.resolveAuthHost)(ctx);
+    const headers = (0, build_auth_headers_1.buildAuthHeaders)(ctx);
+    const client = new http_client_1.HttpClient();
+    client.baseUrl(host).headers(headers);
+    const res = await client.get(`/v1/feature-status?feature_uid=${encodeURIComponent(featureUid)}`);
+    if (res.status < 200 || res.status >= 300) {
+        throw new Error(`PLAN_CHECK: feature-status API returned ${res.status} for "${featureUid}".`);
+    }
+    return res.data;
+}
+exports.isFeatureEnabled = isFeatureEnabled;
+async function assertFeatureEnabled(featureUid, ctx) {
+    let status;
+    try {
+        status = await isFeatureEnabled(featureUid, ctx);
+    }
+    catch (e) {
+        throw new Error(`Could not verify your plan for "${featureUid}". ` +
+            `This command requires a confirmed plan status to run. ` +
+            `Please retry; if the problem persists contact support. (${e.message})`);
+    }
+    if (!status.is_part_of_plan) {
+        throw new Error(`"${featureUid}" is not part of your current plan. Please upgrade your plan to use this feature.`);
+    }
+    if (status.status !== 'enabled') {
+        throw new Error(`"${featureUid}" is not enabled for your plan (status: ${status.status}).`);
+    }
+    return status;
+}
+exports.assertFeatureEnabled = assertFeatureEnabled;

package/lib/feature-status/feature-uids.d.ts

@@ -0,0 +1,5 @@
+export declare const FEATURE: {
+    readonly ASSET_MANAGEMENT: "amAssets";
+    readonly ASSET_SCANNING: "assetsScan";
+};
+export type FeatureUid = (typeof FEATURE)[keyof typeof FEATURE];

package/lib/feature-status/feature-uids.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FEATURE = void 0;
+exports.FEATURE = {
+    ASSET_MANAGEMENT: 'amAssets',
+    ASSET_SCANNING: 'assetsScan',
+};

package/lib/feature-status/index.d.ts

@@ -0,0 +1,5 @@
+export * from './types';
+export * from './feature-uids';
+export { resolveAuthHost } from './resolve-auth-host';
+export { buildAuthHeaders } from './build-auth-headers';
+export { isFeatureEnabled, assertFeatureEnabled } from './feature-status-handler';

package/lib/feature-status/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertFeatureEnabled = exports.isFeatureEnabled = exports.buildAuthHeaders = exports.resolveAuthHost = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./feature-uids"), exports);
+var resolve_auth_host_1 = require("./resolve-auth-host");
+Object.defineProperty(exports, "resolveAuthHost", { enumerable: true, get: function () { return resolve_auth_host_1.resolveAuthHost; } });
+var build_auth_headers_1 = require("./build-auth-headers");
+Object.defineProperty(exports, "buildAuthHeaders", { enumerable: true, get: function () { return build_auth_headers_1.buildAuthHeaders; } });
+var feature_status_handler_1 = require("./feature-status-handler");
+Object.defineProperty(exports, "isFeatureEnabled", { enumerable: true, get: function () { return feature_status_handler_1.isFeatureEnabled; } });
+Object.defineProperty(exports, "assertFeatureEnabled", { enumerable: true, get: function () { return feature_status_handler_1.assertFeatureEnabled; } });

package/lib/feature-status/resolve-auth-host.d.ts

@@ -0,0 +1,8 @@
+export declare function resolveAuthHost(ctx?: {
+    region?: {
+        endpoints?: {
+            auth?: string;
+        };
+        cma?: string;
+    };
+}): string;

package/lib/feature-status/resolve-auth-host.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveAuthHost = void 0;
+const tslib_1 = require("tslib");
+const config_handler_1 = tslib_1.__importDefault(require("../config-handler"));
+// Mirrors config:set:region's own custom-region fallback (region.ts's transformUrl) —
+// same heuristic, applied retroactively for a custom region that predates auth-api.
+// Computed fresh on each call, never persisted back to config.
+function deriveAuthFromCma(cma) {
+    let transformed = cma.replace('api', 'auth-api');
+    if (transformed.startsWith('http')) {
+        transformed = transformed.split('//')[1];
+    }
+    transformed = transformed.replace(/^dev\d+/, 'dev');
+    transformed = transformed.endsWith('io') ? transformed.replace('io', 'com') : transformed;
+    return `https://${transformed}`;
+}
+function resolveAuthHost(ctx) {
+    var _a, _b;
+    const region = ((_a = ctx === null || ctx === void 0 ? void 0 : ctx.region) !== null && _a !== void 0 ? _a : config_handler_1.default.get('region'));
+    let authUrl = (_b = region === null || region === void 0 ? void 0 : region.endpoints) === null || _b === void 0 ? void 0 : _b.auth;
+    if (!authUrl && (region === null || region === void 0 ? void 0 : region.cma)) {
+        authUrl = deriveAuthFromCma(region.cma);
+    }
+    if (!authUrl) {
+        throw new Error('PLAN_CHECK: Auth host is not configured for the current region. ' +
+            "Re-run `csdx config:set:region` to refresh region endpoints.");
+    }
+    return String(authUrl).replace(/\/$/, '');
+}
+exports.resolveAuthHost = resolveAuthHost;

package/lib/feature-status/types.d.ts

@@ -0,0 +1,21 @@
+export interface FeatureStatus {
+    org_uid: string;
+    feature_key: string;
+    status: 'enabled' | 'disabled' | string;
+    limit: number;
+    max_limit: number;
+    is_part_of_plan: boolean;
+}
+export interface FeatureCtx {
+    apiKey?: string;
+    orgUid?: string;
+    managementToken?: string;
+    authToken?: string;
+    region?: {
+        name?: string;
+        cma?: string;
+        endpoints?: {
+            auth?: string;
+        };
+    };
+}

package/lib/feature-status/types.js

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

package/lib/index.d.ts

@@ -27,3 +27,6 @@ export { default as TablePrompt } from './inquirer-table-prompt';
 export { Logger };
 export { default as authenticationHandler } from './authentication-handler';
 export { v2Logger as log, cliErrorHandler, handleAndLogError, getLogPath } from './logger/log';
+export * from './feature-status';
+export * from './region-endpoints';
+export { refreshRegionEndpoints } from './region-refresh';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.log = exports.authenticationHandler = exports.Logger = exports.TablePrompt = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.CLITable = exports.createLogContext = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
+exports.refreshRegionEndpoints = exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.log = exports.authenticationHandler = exports.Logger = exports.TablePrompt = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.CLITable = exports.createLogContext = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("./logger"));
 exports.Logger = logger_1.default;
@@ -72,3 +72,7 @@ Object.defineProperty(exports, "log", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "cliErrorHandler", { enumerable: true, get: function () { return log_1.cliErrorHandler; } });
 Object.defineProperty(exports, "handleAndLogError", { enumerable: true, get: function () { return log_1.handleAndLogError; } });
 Object.defineProperty(exports, "getLogPath", { enumerable: true, get: function () { return log_1.getLogPath; } });
+tslib_1.__exportStar(require("./feature-status"), exports);
+tslib_1.__exportStar(require("./region-endpoints"), exports);
+var region_refresh_1 = require("./region-refresh");
+Object.defineProperty(exports, "refreshRegionEndpoints", { enumerable: true, get: function () { return region_refresh_1.refreshRegionEndpoints; } });

package/lib/region-endpoints.d.ts

@@ -0,0 +1,25 @@
+export interface RegionEndpoints {
+    [key: string]: string;
+}
+export interface CanonicalRegion {
+    name: string;
+    cma: string;
+    cda: string;
+    uiHost: string;
+    developerHubUrl: string;
+    launchHubUrl: string;
+    personalizeUrl: string;
+    composableStudioUrl: string;
+    endpoints: RegionEndpoints;
+}
+/**
+ * Resolve the canonical endpoint set for a region name/alias via @contentstack/utils.
+ * Returns null when the name isn't a recognized region (e.g. a custom region name).
+ */
+export declare function resolveCanonicalEndpoints(name: string): RegionEndpoints | null;
+/**
+ * Build a region object from a raw endpoints map, keeping the existing named
+ * fields (cma/cda/uiHost/...) plus a full raw `endpoints` passthrough so any
+ * future endpoint Contentstack adds is available without further code changes.
+ */
+export declare function buildRegionFromEndpoints(name: string, endpoints: RegionEndpoints): CanonicalRegion;

package/lib/region-endpoints.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRegionFromEndpoints = exports.resolveCanonicalEndpoints = void 0;
+const utils_1 = require("@contentstack/utils");
+/**
+ * Resolve the canonical endpoint set for a region name/alias via @contentstack/utils.
+ * Returns null when the name isn't a recognized region (e.g. a custom region name).
+ */
+function resolveCanonicalEndpoints(name) {
+    try {
+        const endpoints = (0, utils_1.getContentstackEndpoint)(name);
+        if (!endpoints || typeof endpoints === 'string')
+            return null;
+        return endpoints;
+    }
+    catch (_a) {
+        return null;
+    }
+}
+exports.resolveCanonicalEndpoints = resolveCanonicalEndpoints;
+/**
+ * Build a region object from a raw endpoints map, keeping the existing named
+ * fields (cma/cda/uiHost/...) plus a full raw `endpoints` passthrough so any
+ * future endpoint Contentstack adds is available without further code changes.
+ */
+function buildRegionFromEndpoints(name, endpoints) {
+    return {
+        name,
+        cma: endpoints.contentManagement,
+        cda: endpoints.contentDelivery,
+        uiHost: endpoints.application,
+        developerHubUrl: endpoints.developerHub,
+        launchHubUrl: endpoints.launch,
+        personalizeUrl: endpoints.personalizeManagement,
+        composableStudioUrl: endpoints.composableStudio,
+        endpoints,
+    };
+}
+exports.buildRegionFromEndpoints = buildRegionFromEndpoints;

package/lib/region-refresh.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Self-heals the persisted region config on every CLI invocation so that
+ * customers who set their region on an older CLI version (before a field
+ * like authUrl existed) get it backfilled without re-running
+ * `csdx config:set:region`. Only named/built-in regions are touched — a
+ * custom region's name won't resolve via resolveCanonicalEndpoints, so it's
+ * left untouched. Never throws.
+ */
+export declare function refreshRegionEndpoints(): void;

package/lib/region-refresh.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshRegionEndpoints = void 0;
+const tslib_1 = require("tslib");
+const config_handler_1 = tslib_1.__importDefault(require("./config-handler"));
+const region_endpoints_1 = require("./region-endpoints");
+/**
+ * Self-heals the persisted region config on every CLI invocation so that
+ * customers who set their region on an older CLI version (before a field
+ * like authUrl existed) get it backfilled without re-running
+ * `csdx config:set:region`. Only named/built-in regions are touched — a
+ * custom region's name won't resolve via resolveCanonicalEndpoints, so it's
+ * left untouched. Never throws.
+ */
+function refreshRegionEndpoints() {
+    const stored = config_handler_1.default.get('region');
+    if (!(stored === null || stored === void 0 ? void 0 : stored.name))
+        return;
+    const endpoints = (0, region_endpoints_1.resolveCanonicalEndpoints)(stored.name);
+    if (!endpoints)
+        return;
+    const merged = Object.assign(Object.assign({}, stored), (0, region_endpoints_1.buildRegionFromEndpoints)(stored.name, endpoints));
+    if (JSON.stringify(merged) !== JSON.stringify(stored)) {
+        config_handler_1.default.set('region', merged);
+    }
+}
+exports.refreshRegionEndpoints = refreshRegionEndpoints;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.18.5",
+  "version": "1.19.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -29,6 +29,7 @@
   "dependencies": {
     "@contentstack/management": "~1.30.1",
     "@contentstack/marketplace-sdk": "^1.5.1",
+    "@contentstack/utils": "~1.9.1",
     "@oclif/core": "^4.11.4",
     "axios": "^1.16.1",
     "chalk": "^4.1.2",
@@ -82,4 +83,4 @@
     "ts-node": "^10.9.2",
     "typescript": "^4.9.5"
   }
-}
+}