@intlayer/cli 5.4.1 → 5.5.0-canary.0

package/dist/esm/audit.mjs

@@ -1,94 +0,0 @@
-import { readFileSync, writeFileSync } from "fs";
-import { join, relative } from "path";
-import { getIntlayerAPI } from "@intlayer/api";
-import {
-  getConfiguration,
-  logger
-} from "@intlayer/config";
-import pLimit from "p-limit";
-import { getContentDeclaration } from "./listContentDeclaration.mjs";
-const projectPath = process.cwd();
-const auditFile = async (filePath, options) => {
-  try {
-    const { defaultLocale, locales } = getConfiguration().internationalization;
-    const relativePath = relative(projectPath, filePath);
-    logger(`Auditing file: ${relativePath}`, {
-      config: {
-        prefix: options?.logPrefix
-      }
-    });
-    const fileContent = readFileSync(filePath, "utf-8");
-    const auditFileResult = await getIntlayerAPI().ai.auditContentDeclaration(
-      {
-        fileContent,
-        filePath,
-        locales,
-        defaultLocale,
-        model: options?.model,
-        openAiApiKey: options?.openAiApiKey,
-        customPrompt: options?.customPrompt
-      },
-      {
-        headers: options?.headers
-      }
-    );
-    if (!auditFileResult.data) {
-      throw new Error("Audit failed");
-    }
-    writeFileSync(filePath, auditFileResult.data.fileContent);
-    logger(`File ${relativePath} updated`, {
-      config: {
-        prefix: options?.logPrefix
-      }
-    });
-    logger(`${auditFileResult.data.tokenUsed} tokens used in the request`, {
-      config: {
-        prefix: options?.logPrefix
-      }
-    });
-  } catch (error) {
-    logger(error, {
-      level: "error",
-      config: {
-        prefix: options?.logPrefix
-      }
-    });
-  }
-};
-const getAbsolutePath = (filePath) => {
-  if (filePath.startsWith(".")) {
-    const absolutePath = join(process.cwd(), filePath);
-    return absolutePath;
-  }
-  return filePath;
-};
-const audit = async (options) => {
-  const { clientId, clientSecret } = getConfiguration(options).editor;
-  let headers = {};
-  if (clientId && clientSecret) {
-    const oAuth2TokenResult = await getIntlayerAPI().auth.getOAuth2AccessToken();
-    const oAuth2AccessToken = oAuth2TokenResult.data?.accessToken;
-    headers = { Authorization: `Bearer ${oAuth2AccessToken}` };
-  } else if (!options?.openAiApiKey) {
-    throw new Error(
-      "Missing OAuth2 client ID or client secret. To get access token go to https://intlayer.org/dashboard/project. You can also provide your own OpenAI API key to audit the content declaration files. For that you need to provide the --openAiApiKey option."
-    );
-  }
-  let contentDeclarationFilesList = options?.files?.map(getAbsolutePath);
-  if (!contentDeclarationFilesList) {
-    const contentDeclarationFilesPath = getContentDeclaration({
-      exclude: options?.excludedGlobs
-    });
-    contentDeclarationFilesList = contentDeclarationFilesPath;
-  }
-  const limit = pLimit(options?.asyncLimit ? Number(options?.asyncLimit) : 5);
-  const pushPromises = contentDeclarationFilesList.map(
-    (filePath) => limit(() => auditFile(filePath, { ...options, headers }))
-  );
-  await Promise.all(pushPromises);
-};
-export {
-  audit,
-  auditFile
-};
-//# sourceMappingURL=audit.mjs.map

package/dist/esm/audit.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/audit.ts"],"sourcesContent":["import { readFileSync, writeFileSync } from 'fs';\nimport { join, relative } from 'path';\nimport { getIntlayerAPI } from '@intlayer/api';\nimport {\n  getConfiguration,\n  GetConfigurationOptions,\n  logger,\n} from '@intlayer/config';\nimport pLimit from 'p-limit';\nimport { getContentDeclaration } from './listContentDeclaration';\n\n// Depending on your implementation, you may need the OpenAI API client.\n// For instance, you can use `openai` npm package (https://www.npmjs.com/package/openai).\n\ntype AuditOptions = {\n  files?: string[];\n  model?: string;\n  customPrompt?: string;\n  asyncLimit?: number;\n  openAiApiKey?: string;\n  excludedGlobs?: string[];\n  headers?: Record<string, string>;\n  logPrefix?: string;\n} & GetConfigurationOptions;\n\nconst projectPath = process.cwd();\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n * @async\n * @function\n * @param filePath - The relative or absolute path to the target file.\n * @param options - Optional configuration for the audit process.\n * @returns This function returns a Promise that resolves once the audit is complete.\n */\nexport const auditFile = async (filePath: string, options?: AuditOptions) => {\n  try {\n    const { defaultLocale, locales } = getConfiguration().internationalization;\n\n    const relativePath = relative(projectPath, filePath);\n    logger(`Auditing file: ${relativePath}`, {\n      config: {\n        prefix: options?.logPrefix,\n      },\n    });\n\n    // Read the file's content.\n    const fileContent = readFileSync(filePath, 'utf-8');\n\n    // Example of how you might request a completion from ChatGPT:\n    const auditFileResult = await getIntlayerAPI().ai.auditContentDeclaration(\n      {\n        fileContent,\n        filePath,\n        locales,\n        defaultLocale,\n        model: options?.model,\n        openAiApiKey: options?.openAiApiKey,\n        customPrompt: options?.customPrompt,\n      },\n      {\n        headers: options?.headers,\n      }\n    );\n\n    if (!auditFileResult.data) {\n      throw new Error('Audit failed');\n    }\n\n    writeFileSync(filePath, auditFileResult.data.fileContent);\n\n    logger(`File ${relativePath} updated`, {\n      config: {\n        prefix: options?.logPrefix,\n      },\n    });\n\n    logger(`${auditFileResult.data.tokenUsed} tokens used in the request`, {\n      config: {\n        prefix: options?.logPrefix,\n      },\n    });\n  } catch (error) {\n    logger(error, {\n      level: 'error',\n      config: {\n        prefix: options?.logPrefix,\n      },\n    });\n  }\n};\n\nconst getAbsolutePath = (filePath: string): string => {\n  if (filePath.startsWith('.')) {\n    const absolutePath = join(process.cwd(), filePath);\n\n    return absolutePath;\n  }\n  return filePath;\n};\n\n/**\n * Audits the content declaration files by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n * @async\n * @function\n * @param options - Optional configuration for the audit process.\n * @returns This function returns a Promise that resolves once the audit is complete.\n */\nexport const audit = async (options: AuditOptions) => {\n  const { clientId, clientSecret } = getConfiguration(options).editor;\n  let headers: Record<string, string> = {};\n\n  if (clientId && clientSecret) {\n    const oAuth2TokenResult =\n      await getIntlayerAPI().auth.getOAuth2AccessToken();\n\n    const oAuth2AccessToken = oAuth2TokenResult.data?.accessToken;\n\n    headers = { Authorization: `Bearer ${oAuth2AccessToken}` };\n  } else if (!options?.openAiApiKey) {\n    throw new Error(\n      'Missing OAuth2 client ID or client secret. To get access token go to https://intlayer.org/dashboard/project. You can also provide your own OpenAI API key to audit the content declaration files. For that you need to provide the --openAiApiKey option.'\n    );\n  }\n\n  let contentDeclarationFilesList = options?.files?.map(getAbsolutePath);\n\n  if (!contentDeclarationFilesList) {\n    // Retrieve all content declaration file paths using a helper function.\n    const contentDeclarationFilesPath = getContentDeclaration({\n      exclude: options?.excludedGlobs,\n    });\n\n    contentDeclarationFilesList = contentDeclarationFilesPath;\n  }\n\n  const limit = pLimit(options?.asyncLimit ? Number(options?.asyncLimit) : 5); // Limit the number of concurrent requests\n  const pushPromises = contentDeclarationFilesList.map((filePath) =>\n    limit(() => auditFile(filePath, { ...options, headers }))\n  );\n  await Promise.all(pushPromises);\n};\n"],"mappings":"AAAA,SAAS,cAAc,qBAAqB;AAC5C,SAAS,MAAM,gBAAgB;AAC/B,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EAEA;AAAA,OACK;AACP,OAAO,YAAY;AACnB,SAAS,6BAA6B;AAgBtC,MAAM,cAAc,QAAQ,IAAI;AAczB,MAAM,YAAY,OAAO,UAAkB,YAA2B;AAC3E,MAAI;AACF,UAAM,EAAE,eAAe,QAAQ,IAAI,iBAAiB,EAAE;AAEtD,UAAM,eAAe,SAAS,aAAa,QAAQ;AACnD,WAAO,kBAAkB,YAAY,IAAI;AAAA,MACvC,QAAQ;AAAA,QACN,QAAQ,SAAS;AAAA,MACnB;AAAA,IACF,CAAC;AAGD,UAAM,cAAc,aAAa,UAAU,OAAO;AAGlD,UAAM,kBAAkB,MAAM,eAAe,EAAE,GAAG;AAAA,MAChD;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,OAAO,SAAS;AAAA,QAChB,cAAc,SAAS;AAAA,QACvB,cAAc,SAAS;AAAA,MACzB;AAAA,MACA;AAAA,QACE,SAAS,SAAS;AAAA,MACpB;AAAA,IACF;AAEA,QAAI,CAAC,gBAAgB,MAAM;AACzB,YAAM,IAAI,MAAM,cAAc;AAAA,IAChC;AAEA,kBAAc,UAAU,gBAAgB,KAAK,WAAW;AAExD,WAAO,QAAQ,YAAY,YAAY;AAAA,MACrC,QAAQ;AAAA,QACN,QAAQ,SAAS;AAAA,MACnB;AAAA,IACF,CAAC;AAED,WAAO,GAAG,gBAAgB,KAAK,SAAS,+BAA+B;AAAA,MACrE,QAAQ;AAAA,QACN,QAAQ,SAAS;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH,SAAS,OAAO;AACd,WAAO,OAAO;AAAA,MACZ,OAAO;AAAA,MACP,QAAQ;AAAA,QACN,QAAQ,SAAS;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEA,MAAM,kBAAkB,CAAC,aAA6B;AACpD,MAAI,SAAS,WAAW,GAAG,GAAG;AAC5B,UAAM,eAAe,KAAK,QAAQ,IAAI,GAAG,QAAQ;AAEjD,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAaO,MAAM,QAAQ,OAAO,YAA0B;AACpD,QAAM,EAAE,UAAU,aAAa,IAAI,iBAAiB,OAAO,EAAE;AAC7D,MAAI,UAAkC,CAAC;AAEvC,MAAI,YAAY,cAAc;AAC5B,UAAM,oBACJ,MAAM,eAAe,EAAE,KAAK,qBAAqB;AAEnD,UAAM,oBAAoB,kBAAkB,MAAM;AAElD,cAAU,EAAE,eAAe,UAAU,iBAAiB,GAAG;AAAA,EAC3D,WAAW,CAAC,SAAS,cAAc;AACjC,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,MAAI,8BAA8B,SAAS,OAAO,IAAI,eAAe;AAErE,MAAI,CAAC,6BAA6B;AAEhC,UAAM,8BAA8B,sBAAsB;AAAA,MACxD,SAAS,SAAS;AAAA,IACpB,CAAC;AAED,kCAA8B;AAAA,EAChC;AAEA,QAAM,QAAQ,OAAO,SAAS,aAAa,OAAO,SAAS,UAAU,IAAI,CAAC;AAC1E,QAAM,eAAe,4BAA4B;AAAA,IAAI,CAAC,aACpD,MAAM,MAAM,UAAU,UAAU,EAAE,GAAG,SAAS,QAAQ,CAAC,CAAC;AAAA,EAC1D;AACA,QAAM,QAAQ,IAAI,YAAY;AAChC;","names":[]}

package/dist/types/audit.d.ts

@@ -1,38 +0,0 @@
-import { GetConfigurationOptions } from '@intlayer/config';
-type AuditOptions = {
-    files?: string[];
-    model?: string;
-    customPrompt?: string;
-    asyncLimit?: number;
-    openAiApiKey?: string;
-    excludedGlobs?: string[];
-    headers?: Record<string, string>;
-    logPrefix?: string;
-} & GetConfigurationOptions;
-/**
- * Audits a content declaration file by constructing a prompt for ChatGPT.
- * The prompt includes details about the project's locales, file paths of content declarations,
- * and requests for identifying issues or inconsistencies. It prints the prompt for each file,
- * and could be adapted to send requests to the ChatGPT model.
- *
- * @async
- * @function
- * @param filePath - The relative or absolute path to the target file.
- * @param options - Optional configuration for the audit process.
- * @returns This function returns a Promise that resolves once the audit is complete.
- */
-export declare const auditFile: (filePath: string, options?: AuditOptions) => Promise<void>;
-/**
- * Audits the content declaration files by constructing a prompt for ChatGPT.
- * The prompt includes details about the project's locales, file paths of content declarations,
- * and requests for identifying issues or inconsistencies. It prints the prompt for each file,
- * and could be adapted to send requests to the ChatGPT model.
- *
- * @async
- * @function
- * @param options - Optional configuration for the audit process.
- * @returns This function returns a Promise that resolves once the audit is complete.
- */
-export declare const audit: (options: AuditOptions) => Promise<void>;
-export {};
-//# sourceMappingURL=audit.d.ts.map

package/dist/types/audit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"audit.d.ts","sourceRoot":"","sources":["../../src/audit.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,uBAAuB,EAExB,MAAM,kBAAkB,CAAC;AAO1B,KAAK,YAAY,GAAG;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,uBAAuB,CAAC;AAI5B;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GAAU,UAAU,MAAM,EAAE,UAAU,YAAY,kBAuDvE,CAAC;AAWF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,GAAU,SAAS,YAAY,kBAiChD,CAAC"}