@sitecore-content-sdk/cli 0.2.0-beta.10 → 0.2.0-beta.11

package/dist/esm/utils/auth/tenant-store.js

@@ -0,0 +1,170 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+const CLAIMS = 'https://auth.sitecorecloud.io/claims';
+const rootDir = path.join(os.homedir(), '.sitecore', 'sitecore-tools');
+/**
+ * Get the full path to the tenant-specific folder.
+ * @param {string} tenantId - The tenant ID.
+ * @returns The absolute path to the tenant directory.
+ */
+function getTenantPath(tenantId) {
+    return path.join(rootDir, tenantId);
+}
+/**
+ * Write the authentication configuration for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @param {TenantAuth} authInfo - The tenant's auth data.
+ */
+export function writeTenantAuthInfo(tenantId, authInfo) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const dir = getTenantPath(tenantId);
+            fs.mkdirSync(dir, { recursive: true });
+            fs.writeFileSync(path.join(dir, 'auth.json'), JSON.stringify(authInfo, null, 2));
+        }
+        catch (error) {
+            console.error(`\n Failed to write auth.json for tenant '${tenantId}': ${error.message}`);
+        }
+    });
+}
+/**
+ * Read the authentication configuration for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @returns Parsed auth config or null if not found or failed to read.
+ */
+export function readTenantAuthInfo(tenantId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = path.join(getTenantPath(tenantId), 'auth.json');
+        if (!fs.existsSync(filePath))
+            return null;
+        try {
+            const raw = fs.readFileSync(filePath, 'utf-8');
+            return JSON.parse(raw);
+        }
+        catch (error) {
+            console.error(`\n Failed to read auth.json for tenant '${tenantId}': ${error.message}`);
+            return null;
+        }
+    });
+}
+/**
+ * Write the public metadata information for a tenant.
+ * @param {TenantInfo} info - The tenant info object.
+ */
+export function writeTenantInfo(info) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const dir = getTenantPath(info.tenantId);
+            fs.mkdirSync(dir, { recursive: true });
+            fs.writeFileSync(path.join(dir, 'info.json'), JSON.stringify(info, null, 2));
+        }
+        catch (error) {
+            console.error(`\n Failed to write info.json for tenant '${info.tenantId}': ${error.message}`);
+        }
+    });
+}
+/**
+ * Read the public metadata information for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @returns Parsed tenant info or null if not found or failed to read.
+ */
+export function readTenantInfo(tenantId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const infoFilePath = path.join(getTenantPath(tenantId), 'info.json');
+        if (!fs.existsSync(infoFilePath)) {
+            return null;
+        }
+        try {
+            const content = fs.readFileSync(infoFilePath, 'utf-8');
+            return JSON.parse(content);
+        }
+        catch (error) {
+            console.error(`\n Failed to read info.json for tenant '${tenantId}': ${error.message}`);
+            return null;
+        }
+    });
+}
+/**
+ * Deletes the stored auth.json file for the given tenant.
+ * @param {string} tenantId - The tenant ID.
+ */
+export function deleteTenantAuthInfo(tenantId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = path.join(getTenantPath(tenantId), 'auth.json');
+        try {
+            if (fs.existsSync(filePath)) {
+                fs.unlinkSync(filePath);
+            }
+        }
+        catch (error) {
+            console.error(`\n Failed to delete auth.json for tenant '${tenantId}': ${error.message}`);
+        }
+    });
+}
+/**
+ * Scans the CLI root directory and returns all valid tenant infos.
+ * @returns A list of TenantInfo objects found in {tenant-id}/info.json files.
+ */
+export function getAllTenantsInfo() {
+    if (!fs.existsSync(rootDir))
+        return [];
+    const subDirs = fs
+        .readdirSync(rootDir)
+        .filter((entry) => fs.statSync(path.join(rootDir, entry)).isDirectory());
+    const tenants = [];
+    for (const dir of subDirs) {
+        const infoPath = path.join(rootDir, dir, 'info.json');
+        if (fs.existsSync(infoPath)) {
+            try {
+                const content = fs.readFileSync(infoPath, 'utf-8');
+                const data = JSON.parse(content);
+                if (data.tenantId && data.tenantName && data.organizationId && data.clientId) {
+                    tenants.push({
+                        tenantId: data.tenantId,
+                        tenantName: data.tenantName,
+                        organizationId: data.organizationId,
+                        clientId: data.clientId,
+                        authority: data.authority,
+                        audience: data.audience,
+                        baseUrl: data.baseUrl,
+                    });
+                }
+            }
+            catch (error) {
+                console.error('\n Failed to read tenant info file', error.message);
+            }
+        }
+    }
+    return tenants;
+}
+/**
+ * Decodes a JWT without verifying its signature.
+ * @param {string} token - The access token string.
+ * @returns Decoded payload object or null if invalid.
+ */
+export function decodeJwtPayload(token) {
+    try {
+        const base64Payload = token.split('.')[1];
+        const payload = Buffer.from(base64Payload, 'base64').toString('utf-8');
+        const decoded = JSON.parse(payload);
+        return {
+            tokenTenantId: decoded === null || decoded === void 0 ? void 0 : decoded[`${CLAIMS}/tenant_id`],
+            tokenOrgId: decoded === null || decoded === void 0 ? void 0 : decoded[`${CLAIMS}/org_id`],
+            tokenTenantName: decoded === null || decoded === void 0 ? void 0 : decoded[`${CLAIMS}/tenant_name`],
+        };
+    }
+    catch (error) {
+        console.error('\n Failed to decode access token:', error.message);
+        return null;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-content-sdk/cli",
-  "version": "0.2.0-beta.10",
+  "version": "0.2.0-beta.11",
   "description": "Sitecore Content SDK CLI",
   "main": "dist/cjs/cli.js",
   "module": "dist/esm/cli.js",
@@ -34,7 +34,7 @@
     "url": "https://github.com/sitecore/content-sdk/issues"
   },
   "dependencies": {
-    "@sitecore-content-sdk/core": "0.2.0-beta.10",
+    "@sitecore-content-sdk/core": "0.2.0-beta.11",
     "dotenv": "^16.5.0",
     "dotenv-expand": "^12.0.2",
     "resolve": "^1.22.10",
@@ -60,7 +60,7 @@
     "ts-node": "^10.9.1",
     "typescript": "~5.8.3"
   },
-  "gitHead": "09e81ed8bdcda02e595ddaac7b5d911d5b1b689e",
+  "gitHead": "6333d92ea071db49f8467e4c6259c6a82ae3a69f",
   "files": [
     "dist",
     "types"

package/types/scripts/auth/index.d.ts

@@ -0,0 +1,7 @@
+import { Argv } from 'yargs';
+/**
+ * Registers the `auth` command group and its subcommands (`login`, `logout`, `status`, `list`) with Yargs.
+ * @param {Argv} yargs - The Yargs instance used to define CLI commands.
+ * @returns The configured Yargs command group for authentication operations.
+ */
+export declare function builder(yargs: Argv): Argv<{}>;

package/types/scripts/auth/list.d.ts

@@ -0,0 +1,2 @@
+import { CommandModule } from 'yargs';
+export declare const list: CommandModule;

package/types/scripts/auth/login.d.ts

@@ -0,0 +1,3 @@
+import { CommandModule } from 'yargs';
+import { TenantArgs } from './models';
+export declare const login: CommandModule<object, TenantArgs>;

package/types/scripts/auth/logout.d.ts

@@ -0,0 +1,2 @@
+import { CommandModule } from 'yargs';
+export declare const logout: CommandModule;

package/types/scripts/auth/models.d.ts

@@ -0,0 +1,94 @@
+/**
+ * CLI arguments used for authentication and tenant identification.
+ */
+export interface TenantArgs {
+    /**
+     * OAuth2 client ID used to identify the application
+     */
+    clientId: string;
+    /**
+     * Client secret used for client credentials flow
+     */
+    clientSecret?: string;
+    /**
+     * Organization ID associated with the tenant
+     */
+    organizationId?: string;
+    /**
+     * Tenant ID used for scoping the login
+     */
+    tenantId?: string;
+    /**
+     * OAuth2 audience (e.g., API base URL the token is intended for)
+     */
+    audience?: string;
+    /**
+     * Auth authority/issuer URL (e.g., Sitecore identity endpoint)
+     */
+    authority?: string;
+    /**
+     * Base URL for the target Sitecore Content Management API
+     */
+    baseUrl?: string;
+}
+export interface TenantSettings {
+    /**
+     * Currently active tenant ID tracked by the CLI
+     */
+    activeTenant?: string;
+}
+/**
+ * Auth configuration stored per tenant for accessing Sitecore APIs.
+ */
+export interface TenantAuth {
+    /**
+     * Access token issued by the identity provider
+     */
+    access_token: string;
+    /**
+     * Token expiration duration in seconds
+     */
+    expires_in: number;
+    /**
+     * Exact ISO timestamp when the token expires
+     */
+    expires_at: string;
+    /**
+     * Secret used for client credentials flow and re-authenticate
+     */
+    clientSecret?: string;
+    refresh_token?: string;
+}
+/**
+ * Public metadata for a known tenant.
+ */
+export interface TenantInfo {
+    /**
+     * Unique ID of the tenant
+     */
+    tenantId: string;
+    /**
+     *  Human-readable name of the tenant
+     */
+    tenantName: string;
+    /**
+     * Organization ID the tenant belongs to
+     */
+    organizationId: string;
+    /**
+     * Client ID associated with this tenant's authentication
+     */
+    clientId: string;
+    /**
+     * OAuth2 audience (e.g., API base URL the token is intended for)
+     */
+    audience: string;
+    /**
+     * Auth authority/issuer URL (e.g., Sitecore identity endpoint)
+     */
+    authority: string;
+    /**
+     * Base URL for the target Sitecore Content Management API
+     */
+    baseUrl: string;
+}

package/types/scripts/auth/status.d.ts

@@ -0,0 +1,2 @@
+import { CommandModule } from 'yargs';
+export declare const status: CommandModule;

package/types/scripts/index.d.ts

@@ -1,2 +1,4 @@
 import * as project from './project';
+import * as auth from './auth';
 export { project };
+export { auth };

package/types/utils/auth/flow.d.ts

@@ -0,0 +1,24 @@
+import { TenantArgs } from '../../scripts/auth/models';
+export declare const AUTH0_DOMAIN = "https://auth.sitecorecloud.io";
+export declare const AUDIENCE = "https://api.sitecorecloud.io";
+export declare const BASE_URL = "https://edge-platform.sitecorecloud.io/cs/api";
+/**
+ * Performs the OAuth 2.0 client credentials flow to obtain a JWT access token
+ * from the Sitecore Identity Provider using the provided client credentials.
+ * @param {object} [args] - The arguments for client credentials flow
+ * @param {string} [args.clientId] - The client ID registered with Sitecore Identity
+ * @param {string} [args.clientSecret] - The client secret associated with the client ID
+ * @param {string} [args.organizationId] - The ID of the organization the client belongs to
+ * @param {string} [args.tenantId] - The tenant ID representing the specific Sitecore environment
+ * @param {string} [args.audience] - The API audience the token is intended for. Defaults to `AUDIENCE`
+ * @param {string} [args.authority] - The auth server base URL. Defaults to `AUTH0_DOMAIN`
+ * @param {string} [args.baseUrl] - The base URL for the API, used to construct the audience
+ * @returns A Promise that resolves to the access token response (including access token, token type, expiry, etc.)
+ * @throws Will log and exit the process if the request fails or returns a non-OK status
+ */
+export declare function clientCredentialsFlow({ clientId, clientSecret, organizationId, tenantId, audience, authority, baseUrl, }: TenantArgs): Promise<{
+    data: any;
+    tokenOrgId: any;
+    tokenTenantId: any;
+    tokenTenantName: any;
+}>;

package/types/utils/auth/renewal.d.ts

@@ -0,0 +1,22 @@
+import { TenantAuth, TenantInfo } from './../../scripts/auth/models';
+/**
+ * Validates whether a given auth config is still valid (i.e., not expired).
+ * @param {TenantAuth} authInfo - The tenant auth configuration.
+ * @returns True if the token is still valid, false if expired.
+ */
+export declare function validateAuthInfo(authInfo: TenantAuth): boolean;
+/**
+ * Renews the token for a given tenant using stored credentials.
+ * @param {TenantAuth} authInfo - Current authentication info for the tenant.
+ * @param {TenantInfo} tenantInfo - Public metadata about the tenant (e.g., clientId).
+ * @returns Promise<void>
+ * @throws If credentials are missing or renewal fails.
+ */
+export declare function renewClientToken(authInfo: TenantAuth, tenantInfo: TenantInfo): Promise<void>;
+/**
+ * Ensures a valid token exists, renews it if expired.
+ * Returns tenant context if successful, otherwise null.
+ */
+export declare function renewAuthIfExpired(): Promise<{
+    tenantId: string;
+} | null>;

package/types/utils/auth/tenant-state.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Gets the ID of the currently active tenant from settings.json.
+ * @returns The active tenant ID if present, otherwise null.
+ */
+export declare function getActiveTenant(): string | null;
+/**
+ * Sets the currently active tenant by writing to settings.json.
+ * @param {string} tenantId - The tenant ID to set as active.
+ */
+export declare function setActiveTenant(tenantId: string): void;
+/**
+ * Clears the currently active tenant from settings.json by deleting the file.
+ */
+export declare function clearActiveTenant(): void;

package/types/utils/auth/tenant-store.d.ts

@@ -0,0 +1,40 @@
+import { TenantAuth, TenantInfo } from './../../scripts/auth/models';
+/**
+ * Write the authentication configuration for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @param {TenantAuth} authInfo - The tenant's auth data.
+ */
+export declare function writeTenantAuthInfo(tenantId: string, authInfo: TenantAuth): Promise<void>;
+/**
+ * Read the authentication configuration for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @returns Parsed auth config or null if not found or failed to read.
+ */
+export declare function readTenantAuthInfo(tenantId: string): Promise<TenantAuth | null>;
+/**
+ * Write the public metadata information for a tenant.
+ * @param {TenantInfo} info - The tenant info object.
+ */
+export declare function writeTenantInfo(info: TenantInfo): Promise<void>;
+/**
+ * Read the public metadata information for a tenant.
+ * @param {string} tenantId - The tenant ID.
+ * @returns Parsed tenant info or null if not found or failed to read.
+ */
+export declare function readTenantInfo(tenantId: string): Promise<TenantInfo | null>;
+/**
+ * Deletes the stored auth.json file for the given tenant.
+ * @param {string} tenantId - The tenant ID.
+ */
+export declare function deleteTenantAuthInfo(tenantId: string): Promise<void>;
+/**
+ * Scans the CLI root directory and returns all valid tenant infos.
+ * @returns A list of TenantInfo objects found in {tenant-id}/info.json files.
+ */
+export declare function getAllTenantsInfo(): TenantInfo[];
+/**
+ * Decodes a JWT without verifying its signature.
+ * @param {string} token - The access token string.
+ * @returns Decoded payload object or null if invalid.
+ */
+export declare function decodeJwtPayload(token: string): Record<string, any> | null;