gtx-cli 2.6.31 → 2.7.0

package/dist/utils/credentials.js

@@ -1,120 +0,0 @@
-import { logErrorAndExit } from '../console/logging.js';
-import { logger } from '../console/logger.js';
-import path from 'node:path';
-import fs from 'node:fs';
-import chalk from 'chalk';
-// Fetches project ID and API key by opening the dashboard in the browser
-export async function retrieveCredentials(settings, keyType) {
-    // Generate a session ID
-    const { sessionId } = await generateCredentialsSession(settings.baseUrl, keyType);
-    const urlToOpen = `${settings.dashboardUrl}/cli/wizard/${sessionId}`;
-    await import('open').then((open) => open.default(urlToOpen, {
-        wait: false,
-    }));
-    logger.message(`${chalk.dim(`If the browser window didn't open automatically, please open the following link:`)}\n\n${chalk.cyan(urlToOpen)}`);
-    const spinner = logger.createSpinner('dots');
-    spinner.start('Waiting for response from dashboard...');
-    const credentials = await new Promise(async (resolve, reject) => {
-        const interval = setInterval(async () => {
-            // Ping the dashboard to see if the credentials are set
-            try {
-                const res = await fetch(`${settings.baseUrl}/cli/wizard/${sessionId}`, {
-                    method: 'GET',
-                });
-                if (res.status === 200) {
-                    const data = await res.json();
-                    resolve(data);
-                    clearInterval(interval);
-                    clearTimeout(timeout);
-                    fetch(`${settings.baseUrl}/cli/wizard/${sessionId}`, {
-                        method: 'DELETE',
-                    });
-                }
-            }
-            catch (err) {
-                console.error(err);
-            }
-        }, 2000);
-        // timeout after 1 hour
-        const timeout = setTimeout(() => {
-            spinner.stop('Timed out');
-            clearInterval(interval);
-            logErrorAndExit('Timed out waiting for response from dashboard');
-        }, 1000 * 60 * 60);
-    });
-    spinner.stop('Received credentials');
-    return credentials;
-}
-export async function generateCredentialsSession(url, keyType) {
-    const res = await fetch(`${url}/cli/wizard/session`, {
-        method: 'POST',
-        headers: {
-            'Content-Type': 'application/json',
-        },
-        body: JSON.stringify({
-            keyType,
-        }),
-    });
-    if (!res.ok) {
-        logErrorAndExit('Failed to generate credentials session');
-    }
-    return await res.json();
-}
-// Checks if the credentials are set in the environment variables
-export function areCredentialsSet() {
-    return process.env.GT_PROJECT_ID && process.env.GT_API_KEY;
-}
-// Sets the credentials in .env.local file
-export async function setCredentials(credentials, type, framework, cwd = process.cwd()) {
-    const envFile = path.join(cwd, '.env.local');
-    let envContent = '';
-    // Check if .env.local exists, create it if it doesn't
-    if (!fs.existsSync(envFile)) {
-        // File doesn't exist, create it
-        await fs.promises.writeFile(envFile, '', 'utf8');
-        // Add .env.local to .gitignore if it exists
-        const gitignoreFile = path.join(cwd, '.gitignore');
-        if (fs.existsSync(gitignoreFile)) {
-            const gitignoreContent = await fs.promises.readFile(gitignoreFile, 'utf8');
-            if (!gitignoreContent.includes('.env.local')) {
-                await fs.promises.appendFile(gitignoreFile, '\n.env.local\n', 'utf8');
-            }
-        }
-        else {
-            // Create .gitignore file with .env.local
-            await fs.promises.writeFile(gitignoreFile, '.env.local\n', 'utf8');
-        }
-    }
-    else {
-        // Read existing content
-        envContent = await fs.promises.readFile(envFile, 'utf8');
-    }
-    // Always append the credentials to the file
-    let prefix = '';
-    if (framework === 'next-pages') {
-        prefix = 'NEXT_PUBLIC_';
-    }
-    else if (framework === 'vite') {
-        prefix = 'VITE_';
-    }
-    else if (framework === 'gatsby') {
-        prefix = 'GATSBY_';
-    }
-    else if (framework === 'react') {
-        prefix = 'REACT_APP_';
-    }
-    else if (framework === 'redwood') {
-        prefix = 'REDWOOD_ENV_';
-    }
-    envContent += `\n${prefix}GT_PROJECT_ID=${credentials.projectId}\n`;
-    if (type === 'development') {
-        envContent += `${prefix || ''}GT_DEV_API_KEY=${credentials.apiKey}\n`;
-    }
-    else {
-        envContent += `GT_API_KEY=${credentials.apiKey}\n`;
-    }
-    // Ensure we don't have excessive newlines
-    envContent = envContent.replace(/\n{3,}/g, '\n\n').trim() + '\n';
-    // Write the updated content back to the file
-    await fs.promises.writeFile(envFile, envContent, 'utf8');
-}

package/dist/utils/flattenJsonFiles.d.ts

@@ -1,2 +0,0 @@
-import { Settings } from '../types/index.js';
-export default function flattenJsonFiles(settings: Settings, includeFiles?: Set<string>): Promise<void>;

package/dist/utils/flattenJsonFiles.js

@@ -1,36 +0,0 @@
-import { createFileMapping } from '../formats/files/fileMapping.js';
-import fs from 'node:fs';
-export default async function flattenJsonFiles(settings, includeFiles) {
-    if (!settings.files ||
-        (Object.keys(settings.files.placeholderPaths).length === 1 &&
-            settings.files.placeholderPaths.gt)) {
-        return;
-    }
-    const { resolvedPaths: sourceFiles } = settings.files;
-    const fileMapping = createFileMapping(sourceFiles, settings.files.placeholderPaths, settings.files.transformPaths, settings.locales, settings.defaultLocale);
-    await Promise.all(Object.values(fileMapping).map(async (filesMap) => {
-        const targetFiles = Object.values(filesMap).filter((p) => p.endsWith('.json') && (!includeFiles || includeFiles.has(p)));
-        await Promise.all(targetFiles.map(async (file) => {
-            // Read each json file
-            const json = JSON.parse(fs.readFileSync(file, 'utf8'));
-            // Flatten the json
-            const flattenedJson = flattenJson(json);
-            // Write the flattened json to the target file
-            await fs.promises.writeFile(file, JSON.stringify(flattenedJson, null, 2));
-            return flattenedJson;
-        }));
-    }));
-}
-function flattenJson(json, prefix = '') {
-    const result = {};
-    for (const [key, value] of Object.entries(json)) {
-        const newKey = prefix ? `${prefix}.${key}` : key;
-        if (value !== null && typeof value === 'object' && !Array.isArray(value)) {
-            Object.assign(result, flattenJson(value, newKey));
-        }
-        else {
-            result[newKey] = value;
-        }
-    }
-    return result;
-}

package/dist/utils/gitDiff.d.ts

@@ -1,8 +0,0 @@
-/**
- * Returns a unified diff using the system's git, comparing two paths even if not in a repo.
- * Uses `git diff --no-index` so neither path needs to be tracked by git.
- *
- * Exit codes: 0 (no changes), 1 (changes), >1 (error). We treat 0/1 as success.
- * Throws if git is unavailable or another error occurs.
- */
-export declare function getGitUnifiedDiff(oldPath: string, newPath: string): Promise<string>;

package/dist/utils/gitDiff.js

@@ -1,34 +0,0 @@
-import { execFile } from 'node:child_process';
-import { promisify } from 'node:util';
-const execFileAsync = promisify(execFile);
-/**
- * Returns a unified diff using the system's git, comparing two paths even if not in a repo.
- * Uses `git diff --no-index` so neither path needs to be tracked by git.
- *
- * Exit codes: 0 (no changes), 1 (changes), >1 (error). We treat 0/1 as success.
- * Throws if git is unavailable or another error occurs.
- */
-export async function getGitUnifiedDiff(oldPath, newPath) {
-    try {
-        const res = await execFileAsync('git', [
-            'diff',
-            '--no-index',
-            '--text',
-            '--unified=3',
-            '--no-color',
-            '--',
-            oldPath,
-            newPath,
-        ], {
-            windowsHide: true,
-        });
-        return res.stdout || '';
-    }
-    catch (error) {
-        // Exit code 1 means differences found; stdout contains the diff
-        if (error && error.code === 1 && typeof error.stdout === 'string') {
-            return error.stdout;
-        }
-        throw error;
-    }
-}

package/dist/utils/gt.d.ts

@@ -1,2 +0,0 @@
-import { GT } from 'generaltranslation';
-export declare const gt: GT;

package/dist/utils/gt.js

@@ -1,2 +0,0 @@
-import { GT } from 'generaltranslation';
-export const gt = new GT();

package/dist/utils/hash.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hashes a string using SHA-256 algorithm.
- * @param {string} string - The string to be hashed.
- * @returns {string} The hashed string.
- */
-export declare function hashStringSync(string: string): string;

package/dist/utils/hash.js

@@ -1,11 +0,0 @@
-import crypto from 'crypto';
-/**
- * Hashes a string using SHA-256 algorithm.
- * @param {string} string - The string to be hashed.
- * @returns {string} The hashed string.
- */
-export function hashStringSync(string) {
-    const hash = crypto.createHash('sha256');
-    hash.update(string);
-    return hash.digest('hex');
-}

package/dist/utils/headers.d.ts

@@ -1 +0,0 @@
-export declare function getAuthHeaders(projectId: string, apiKey: string): Record<string, string>;

package/dist/utils/headers.js

@@ -1,14 +0,0 @@
-export function getAuthHeaders(projectId, apiKey) {
-    const authHeaders = {
-        'x-gt-project-id': projectId,
-    };
-    if (apiKey) {
-        if (apiKey.startsWith('gtx-internal-')) {
-            authHeaders['x-gt-internal-api-key'] = apiKey;
-        }
-        else {
-            authHeaders['x-gt-api-key'] = apiKey;
-        }
-    }
-    return authHeaders;
-}

package/dist/utils/localizeRelativeAssets.d.ts

@@ -1,8 +0,0 @@
-import { Settings } from '../types/index.js';
-type RewriteResult = {
-    content: string;
-    hasChanges: boolean;
-};
-export declare function localizeRelativeAssetsForContent(content: string, sourcePath: string, targetPath: string, cwd: string): RewriteResult;
-export default function localizeRelativeAssets(settings: Settings, targetLocales?: string[], includeFiles?: Set<string>): Promise<void>;
-export {};

package/dist/utils/localizeRelativeAssets.js

@@ -1,166 +0,0 @@
-import * as fs from 'fs';
-import path from 'node:path';
-import { unified } from 'unified';
-import remarkParse from 'remark-parse';
-import remarkMdx from 'remark-mdx';
-import remarkFrontmatter from 'remark-frontmatter';
-import remarkStringify from 'remark-stringify';
-import { visit } from 'unist-util-visit';
-import { escapeHtmlInTextNodes, normalizeCJKCharacters } from 'gt-remark';
-import { createFileMapping } from '../formats/files/fileMapping.js';
-function stripQueryAndHash(url) {
-    const match = url.match(/^[^?#]+/);
-    const base = match ? match[0] : url;
-    const suffix = url.slice(base.length);
-    return { base, suffix };
-}
-function isSkippableUrl(url) {
-    if (!url)
-        return true;
-    if (url.startsWith('/'))
-        return true;
-    if (/^(https?:)?\/\//i.test(url))
-        return true;
-    if (url.startsWith('data:'))
-        return true;
-    if (url.startsWith('#'))
-        return true;
-    if (url.startsWith('mailto:'))
-        return true;
-    if (url.startsWith('tel:'))
-        return true;
-    return false;
-}
-function toPosix(p) {
-    return p.replace(/\\/g, '/');
-}
-function isSubPath(child, parent) {
-    const rel = path.relative(parent, child);
-    return rel === '' || (!rel.startsWith('..') && !path.isAbsolute(rel));
-}
-export function localizeRelativeAssetsForContent(content, sourcePath, targetPath, cwd) {
-    let changed = false;
-    let ast;
-    try {
-        const processor = unified()
-            .use(remarkParse)
-            .use(remarkFrontmatter, ['yaml', 'toml'])
-            .use(remarkMdx);
-        ast = processor.runSync(processor.parse(content));
-    }
-    catch {
-        return { content, hasChanges: false };
-    }
-    const sourceDir = path.dirname(sourcePath);
-    const targetDir = path.dirname(targetPath);
-    const maybeRewrite = (url) => {
-        if (isSkippableUrl(url))
-            return null;
-        const { base, suffix } = stripQueryAndHash(url);
-        if (isSkippableUrl(base))
-            return null;
-        const targetResolved = path.resolve(targetDir, base);
-        if (fs.existsSync(targetResolved)) {
-            return null;
-        }
-        const sourceResolved = path.resolve(sourceDir, base);
-        if (!fs.existsSync(sourceResolved)) {
-            return null;
-        }
-        let newPath;
-        if (isSubPath(sourceResolved, cwd)) {
-            newPath = '/' + toPosix(path.relative(cwd, sourceResolved));
-        }
-        else {
-            const rel = toPosix(path.relative(targetDir, sourceResolved));
-            newPath = rel || toPosix(path.basename(sourceResolved));
-        }
-        if (newPath === base)
-            return null;
-        changed = true;
-        return newPath + suffix;
-    };
-    visit(ast, (node) => {
-        if (node.type === 'image' && typeof node.url === 'string') {
-            const newUrl = maybeRewrite(node.url);
-            if (newUrl)
-                node.url = newUrl;
-            return;
-        }
-        if ((node.type === 'mdxJsxFlowElement' ||
-            node.type === 'mdxJsxTextElement') &&
-            node.name === 'img' &&
-            Array.isArray(node.attributes)) {
-            for (const attr of node.attributes) {
-                if (attr &&
-                    attr.type === 'mdxJsxAttribute' &&
-                    attr.name === 'src' &&
-                    typeof attr.value === 'string') {
-                    const newUrl = maybeRewrite(attr.value);
-                    if (newUrl)
-                        attr.value = newUrl;
-                }
-            }
-        }
-    });
-    try {
-        const s = unified()
-            .use(remarkFrontmatter, ['yaml', 'toml'])
-            .use(remarkMdx)
-            .use(normalizeCJKCharacters)
-            .use(escapeHtmlInTextNodes)
-            .use(remarkStringify, {
-            handlers: {
-                text(node) {
-                    return node.value;
-                },
-            },
-        });
-        const outTree = s.runSync(ast);
-        let out = s.stringify(outTree);
-        if (out.endsWith('\n') && !content.endsWith('\n'))
-            out = out.slice(0, -1);
-        if (content.startsWith('\n') && !out.startsWith('\n'))
-            out = '\n' + out;
-        return { content: out, hasChanges: changed };
-    }
-    catch {
-        return { content, hasChanges: false };
-    }
-}
-export default async function localizeRelativeAssets(settings, targetLocales, includeFiles) {
-    if (!settings.files ||
-        (Object.keys(settings.files.placeholderPaths).length === 1 &&
-            settings.files.placeholderPaths.gt)) {
-        return;
-    }
-    const { resolvedPaths: sourceFiles } = settings.files;
-    const locales = targetLocales || settings.locales;
-    const fileMapping = createFileMapping(sourceFiles, settings.files.placeholderPaths, settings.files.transformPaths, settings.locales, settings.defaultLocale);
-    const cwd = process.cwd();
-    const processPromises = Object.entries(fileMapping)
-        .filter(([locale]) => locales.includes(locale))
-        .map(async ([locale, filesMap]) => {
-        const reverseMap = new Map();
-        for (const [sourcePath, targetPath] of Object.entries(filesMap)) {
-            reverseMap.set(targetPath, sourcePath);
-        }
-        const targetFiles = Object.values(filesMap).filter((p) => (p.endsWith('.md') || p.endsWith('.mdx')) &&
-            (!includeFiles || includeFiles.has(p)));
-        await Promise.all(targetFiles.map(async (targetPath) => {
-            if (!fs.existsSync(targetPath))
-                return;
-            const sourcePath = reverseMap.get(targetPath);
-            if (!sourcePath)
-                return;
-            if (!fs.existsSync(sourcePath))
-                return;
-            const content = await fs.promises.readFile(targetPath, 'utf8');
-            const result = localizeRelativeAssetsForContent(content, sourcePath, targetPath, cwd);
-            if (result.hasChanges) {
-                await fs.promises.writeFile(targetPath, result.content);
-            }
-        }));
-    });
-    await Promise.all(processPromises);
-}

package/dist/utils/localizeStaticImports.d.ts

@@ -1,15 +0,0 @@
-import { Settings } from '../types/index.js';
-/**
- * Localizes static imports in content files.
- * Currently only supported for md and mdx files. (/docs/ -> /[locale]/docs/)
- * @param settings - The settings object containing the project configuration.
- * @returns void
- *
- * @TODO This is an experimental feature, and only works in very specific cases. This needs to be improved before
- * it can be enabled by default.
- *
- * Before this becomes a non-experimental feature, we need to:
- * - Support more file types
- * - Support more complex paths
- */
-export default function localizeStaticImports(settings: Settings, includeFiles?: Set<string>): Promise<void>;