@intlayer/docs 6.1.6 → 7.0.0-canary.1

package/frequent_questions/ko/bun_set_up.md

@@ -0,0 +1,54 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: bun 사용 시 모듈을 찾을 수 없다는 오류가 발생합니다
+description: bun 사용 시 발생하는 오류 수정 방법.
+keywords:
+  - bun
+  - 모듈을 찾을 수 없음
+  - intlayer
+  - 설정
+  - 패키지 관리자
+slugs:
+  - doc
+  - faq
+  - bun-set-up
+---
+
+# bun 사용 시 모듈을 찾을 수 없다는 오류가 발생합니다
+
+## 문제 설명
+
+bun을 사용할 때 다음과 같은 오류가 발생할 수 있습니다:
+
+```bash
+Cannot find package 'intlayer' from '/workspace/packages/@intlayer/config/dist/cjs/utils/ESMxCJSHelpers.cjs' undefined
+```
+
+## 원인
+
+Intlayer는 내부적으로 `require`를 사용합니다. 그리고 bun은 `require` 함수를 전체 프로젝트가 아닌 `@intlayer/config` 패키지의 패키지들만 해결하도록 범위를 제한합니다.
+
+## 해결 방법
+
+### 설정에 `require` 함수를 제공하기
+
+```ts
+const config: IntlayerConfig = {
+  build: {
+    require, // require 함수를 빌드 설정에 제공합니다.
+  },
+};
+
+export default config;
+```
+
+```ts fileName="next.config.ts" codeFormat="typescript"
+import { withIntlayer } from "next-intlayer/server";
+
+const configuration = withIntlayer({
+  require, // require 함수를 Intlayer 설정에 포함시킵니다.
+});
+
+export default configuration;
+```

package/frequent_questions/pt/bun_set_up.md

@@ -0,0 +1,55 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Recebo erro de módulo não encontrado ao usar bun
+description: Corrigir erro ao usar bun.
+keywords:
+  - bun
+  - módulo não encontrado
+  - intlayer
+  - configuração
+  - gerenciador de pacotes
+slugs:
+  - doc
+  - faq
+  - bun-set-up
+---
+
+# Recebo erro de módulo não encontrado ao usar bun
+
+## Descrição do Problema
+
+Ao usar bun, você pode encontrar um erro como este:
+
+```bash
+Cannot find package 'intlayer' from '/workspace/packages/@intlayer/config/dist/cjs/utils/ESMxCJSHelpers.cjs' undefined
+```
+
+## Motivo
+
+O Intlayer usa `require` internamente. E o bun limita a função require para resolver apenas os pacotes do pacote `@intlayer/config`, em vez de todo o projeto.
+
+## Solução
+
+### Forneça a função `require` na configuração
+
+```ts
+ts;
+const config: IntlayerConfig = {
+  build: {
+    require, // forneça a função require para o build
+  },
+};
+
+export default config;
+```
+
+```ts fileName="next.config.ts" codeFormat="typescript"
+import { withIntlayer } from "next-intlayer/server";
+
+const configuration = withIntlayer({
+  require, // forneça a função require para a configuração do Next.js com Intlayer
+});
+
+export default configuration;
+```

package/frequent_questions/ru/bun_set_up.md

@@ -0,0 +1,55 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Я получаю ошибку "module not found" при использовании bun
+description: Исправление ошибки при использовании bun.
+keywords:
+  - bun
+  - module not found
+  - intlayer
+  - конфигурация
+  - менеджер пакетов
+slugs:
+  - doc
+  - faq
+  - bun-set-up
+---
+
+# Я получаю ошибку "module not found" при использовании bun
+
+## Описание проблемы
+
+При использовании bun вы можете столкнуться с ошибкой следующего вида:
+
+```bash
+Cannot find package 'intlayer' from '/workspace/packages/@intlayer/config/dist/cjs/utils/ESMxCJSHelpers.cjs' undefined
+```
+
+## Причина
+
+Intlayer использует `require` внутренне. А bun ограничивает функцию require так, что она разрешает только пакеты из пакета `@intlayer/config`, вместо всего проекта.
+
+## Решение
+
+### Предоставьте функцию `require` в конфигурации
+
+```ts
+ts;
+const config: IntlayerConfig = {
+  build: {
+    require, // предоставляем функцию require в конфигурации
+  },
+};
+
+export default config;
+```
+
+```ts fileName="next.config.ts" codeFormat="typescript"
+import { withIntlayer } from "next-intlayer/server";
+
+const configuration = withIntlayer({
+  require, // передаем функцию require в конфигурацию next-intlayer
+});
+
+export default configuration;
+```

package/frequent_questions/tr/bun_set_up.md

@@ -0,0 +1,55 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: Bun kullanırken modül bulunamadı hatası alıyorum
+description: Bun kullanırken oluşan hatayı düzeltin.
+keywords:
+  - bun
+  - modül bulunamadı
+  - intlayer
+  - yapılandırma
+  - paket yöneticisi
+slugs:
+  - doc
+  - faq
+  - bun-set-up
+---
+
+# Bun kullanırken modül bulunamadı hatası alıyorum
+
+## Sorun Açıklaması
+
+Bun kullanırken aşağıdaki gibi bir hata ile karşılaşabilirsiniz:
+
+```bash
+Cannot find package 'intlayer' from '/workspace/packages/@intlayer/config/dist/cjs/utils/ESMxCJSHelpers.cjs' undefined
+```
+
+## Sebep
+
+Intlayer dahili olarak `require` kullanır. Ve bun, require fonksiyonunu tüm proje yerine sadece `@intlayer/config` paketinin paketlerini çözmek için sınırlar.
+
+## Çözüm
+
+### Yapılandırmada `require` fonksiyonunu sağlayın
+
+```ts
+ts;
+const config: IntlayerConfig = {
+  build: {
+    require, // require fonksiyonunu yapılandırmaya dahil et
+  },
+};
+
+export default config;
+```
+
+```ts fileName="next.config.ts" codeFormat="typescript"
+import { withIntlayer } from "next-intlayer/server";
+
+const configuration = withIntlayer({
+  require, // require fonksiyonunu yapılandırmaya dahil et
+});
+
+export default configuration;
+```

package/frequent_questions/zh/bun_set_up.md

@@ -0,0 +1,54 @@
+---
+createdAt: 2025-05-20
+updatedAt: 2025-06-29
+title: 使用 bun 时出现模块未找到错误
+description: 解决使用 bun 时的错误。
+keywords:
+  - bun
+  - 模块未找到
+  - intlayer
+  - 配置
+  - 包管理器
+slugs:
+  - doc
+  - faq
+  - bun-set-up
+---
+
+# 使用 bun 时出现模块未找到错误
+
+## 问题描述
+
+使用 bun 时，您可能会遇到如下错误：
+
+```bash
+Cannot find package 'intlayer' from '/workspace/packages/@intlayer/config/dist/cjs/utils/ESMxCJSHelpers.cjs' undefined
+```
+
+## 原因
+
+Intlayer 内部使用了 `require`。而 bun 将 require 函数的作用域限制为只解析 `@intlayer/config` 包的依赖，而不是整个项目。
+
+## 解决方案
+
+### 在配置中提供 `require` 函数
+
+```ts
+const config: IntlayerConfig = {
+  build: {
+    require, // 在构建配置中提供 require 函数
+  },
+};
+
+export default config;
+```
+
+```ts fileName="next.config.ts" codeFormat="typescript"
+import { withIntlayer } from "next-intlayer/server";
+
+const configuration = withIntlayer({
+  require, // 使用 withIntlayer 时传入 require 函数
+});
+
+export default configuration;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "6.1.6",
+  "version": "7.0.0-canary.1",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -47,61 +47,56 @@
     "blog",
     "legal"
   ],
+  "scripts": {
+    "prebuild": "tsx tools/generateEntry.ts",
+    "build": "tsdown --config tsdown.config.ts",
+    "build:ci": "tsdown --config tsdown.config.ts",
+    "clean": "rimraf ./dist .turbo",
+    "dev": "tsdown --config tsdown.config.ts --watch",
+    "format": "biome format . --check",
+    "format:fix": "biome format --write .",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "prepublish": "cp -f ../README.md ./README.md",
+    "review": "bun tools/review.ts",
+    "serve": "webpack serve --config ./webpack.config.ts",
+    "test": "vitest run",
+    "test:markdown": "tsx tools/markdownFormatting.ts",
+    "test:watch": "vitest",
+    "translate": "tsx tools/translate.ts",
+    "transpile": "webpack --config ./webpack.config.ts",
+    "typecheck": "tsc --noEmit --project tsconfig.types.json",
+    "watch": "webpack --config ./webpack.config.ts --watch"
+  },
   "dependencies": {
-    "@intlayer/config": "6.1.6",
-    "@intlayer/core": "6.1.6"
+    "@intlayer/config": "workspace:*",
+    "@intlayer/core": "workspace:*",
+    "@intlayer/types": "workspace:*"
   },
   "devDependencies": {
-    "@types/node": "^24.5.2",
-    "concurrently": "^9.2.1",
-    "eslint": "^9.36.0",
-    "fast-glob": "^3.3.3",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "tsc-alias": "^1.8.16",
-    "tsup": "^8.5.0",
-    "tsx": "^4.20.5",
-    "typescript": "^5.9.2",
-    "vitest": "^3.2.4",
-    "@intlayer/api": "6.1.6",
-    "@utils/ts-config": "1.0.4",
-    "@utils/ts-config-types": "1.0.4",
-    "@utils/tsup-config": "1.0.4",
-    "@intlayer/cli": "6.1.6"
+    "@intlayer/api": "workspace:*",
+    "@intlayer/cli": "workspace:*",
+    "@types/node": "24.9.1",
+    "@utils/ts-config": "workspace:*",
+    "@utils/ts-config-types": "workspace:*",
+    "@utils/tsdown-config": "workspace:*",
+    "fast-glob": "3.3.3",
+    "rimraf": "6.0.1",
+    "tsdown": "0.15.9",
+    "typescript": "5.9.3",
+    "vitest": "4.0.3"
   },
   "peerDependencies": {
-    "@intlayer/core": "6.1.6",
-    "@intlayer/api": "6.1.6",
-    "@intlayer/cli": "6.1.6",
-    "@intlayer/config": "6.1.6"
+    "@intlayer/api": "workspace:*",
+    "@intlayer/cli": "workspace:*",
+    "@intlayer/config": "workspace:*",
+    "@intlayer/core": "workspace:*",
+    "@intlayer/types": "workspace:*"
   },
   "engines": {
     "node": ">=14.18"
   },
   "bug": {
     "url": "https://github.com/aymericzip/intlayer/issues"
-  },
-  "scripts": {
-    "prebuild": "tsx tools/generateEntry.ts",
-    "build": "pnpm clean & pnpm build:ci",
-    "build:ci": "pnpm build:package & pnpm build:types",
-    "build:package": "tsup",
-    "build:types": "tsc --project ./tsconfig.types.json && tsc-alias --project ./tsconfig.types.json",
-    "clean": "rimraf ./dist",
-    "dev": "concurrently --prefix none \"tsup --watch\" \"tsc --project ./tsconfig.types.json --watch\" \"tsc-alias --project ./tsconfig.types.json --watch\"",
-    "lint": "eslint . --cache",
-    "lint:fix": "eslint . --cache --fix",
-    "prettier": "prettier . --check",
-    "prettier:fix": "prettier . --write",
-    "prepublish": "cp -f ../README.md ./README.md",
-    "review": "tsx tools/review.ts",
-    "serve": "webpack serve --config ./webpack.config.ts",
-    "test": "vitest run",
-    "test:markdown": "tsx tools/markdownFormatting.ts",
-    "test:watch": "vitest",
-    "translate": "tsx tools/translate.ts",
-    "transpile": "webpack --config ./webpack.config.ts",
-    "typecheck": "tsup --project ./tsconfig.json --noEmit",
-    "watch": "webpack --config ./webpack.config.ts --watch"
   }
-}
+}

package/src/blog.ts

@@ -1,13 +1,14 @@
-import { LocalesValues } from '@intlayer/config';
+import type { DeclaredLocales, LocalesValues } from '@intlayer/types';
 import {
   defaultLocale,
-  FileMetadata,
+  type FileMetadata,
   getFile,
   getFileBySlug,
   getFileMetadata,
   getFileMetadataBySlug,
   getFileMetadataRecord,
   getFiles,
+  getKeys,
 } from './common';
 import { blogEntry } from './generated/blog.entry';
 
@@ -15,36 +16,43 @@ export type BlogKey = keyof typeof blogEntry;
 export type Blogs = Record<BlogKey, Record<LocalesValues, Promise<string>>>;
 export type BlogMetadata = FileMetadata;
 
-export const getBlogs = async <L extends LocalesValues>(
+export const getBlogsKeys = (): (keyof typeof blogEntry)[] =>
+  getKeys(blogEntry);
+
+export const getBlogs = async <L extends LocalesValues = DeclaredLocales>(
   locale: L = defaultLocale as L
 ): Promise<Record<BlogKey, string>> => await getFiles(blogEntry, locale);
 
-export const getBlog = async <L extends LocalesValues>(
+export const getBlog = async <L extends LocalesValues = DeclaredLocales>(
   docName: BlogKey,
   locale: L = defaultLocale as L
 ): Promise<string> => await getFile(blogEntry, docName, locale);
 
-export const getBlogMetadataRecord = async <L extends LocalesValues>(
+export const getBlogMetadataRecord = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   locale: L = defaultLocale as L
 ): Promise<Record<BlogKey, FileMetadata>> =>
   await getFileMetadataRecord(blogEntry, locale);
 
 export const getBlogMetadata = async <
   D extends BlogKey,
-  L extends LocalesValues,
+  L extends LocalesValues = DeclaredLocales,
 >(
   docName: D,
   locale: L = defaultLocale as L
 ): Promise<FileMetadata> => await getFileMetadata(blogEntry, docName, locale);
 
-export const getBlogMetadataBySlug = async <L extends LocalesValues>(
+export const getBlogMetadataBySlug = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false
 ): Promise<FileMetadata[]> =>
   await getFileMetadataBySlug(blogEntry, slugs, locale, strict);
 
-export const getBlogBySlug = async <L extends LocalesValues>(
+export const getBlogBySlug = async <L extends LocalesValues = DeclaredLocales>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false

package/src/common.ts

@@ -1,6 +1,6 @@
-import { Locales, LocalesValues } from '@intlayer/config';
+import { join } from 'node:path';
 import { getLocalizedUrl, getMarkdownMetadata } from '@intlayer/core';
-import { join } from 'path';
+import { Locales, type LocalesValues } from '@intlayer/types';
 
 export const defaultLocale = Locales.ENGLISH;
 
@@ -8,6 +8,9 @@ export const GITHUB_URL_PREFIX =
   'https://github.com/aymericzip/intlayer/blob/main/docs';
 export const URL_PREFIX = 'https://intlayer.org/';
 
+export const getKeys = <T extends Record<string, any>>(obj: T): (keyof T)[] =>
+  Object.keys(obj) as (keyof T)[];
+
 export const getFiles = async <
   F extends Record<`./${string}`, Record<LocalesValues, Promise<string>>>,
 >(
@@ -97,13 +100,9 @@ export const getFileMetadata = async <
   docKey: keyof F,
   locale: LocalesValues = defaultLocale as LocalesValues
 ): Promise<R> => {
-  try {
-    const file = await getFile(files, docKey, locale);
+  const file = await getFile(files, docKey, locale);
 
-    return formatMetadata(docKey as string, file, locale) as R;
-  } catch (error) {
-    throw error;
-  }
+  return formatMetadata(docKey as string, file, locale) as R;
 };
 
 export const getFileMetadataRecord = async <

package/src/doc.ts

@@ -1,13 +1,14 @@
-import { LocalesValues } from '@intlayer/config';
+import type { DeclaredLocales, LocalesValues } from '@intlayer/types';
 import {
-  FileMetadata,
   defaultLocale,
+  type FileMetadata,
   getFile,
   getFileBySlug,
   getFileMetadata,
   getFileMetadataBySlug,
   getFileMetadataRecord,
   getFiles,
+  getKeys,
 } from './common';
 import { docsEntry } from './generated/docs.entry';
 
@@ -15,33 +16,42 @@ export type DocKey = keyof typeof docsEntry;
 export type Docs = Record<DocKey, Record<LocalesValues, Promise<string>>>;
 export type DocMetadata = FileMetadata;
 
-export const getDocs = async <L extends LocalesValues>(
+export const getDocsKeys = (): (keyof typeof docsEntry)[] => getKeys(docsEntry);
+
+export const getDocs = async <L extends LocalesValues = DeclaredLocales>(
   locale: L = defaultLocale as L
 ): Promise<Record<DocKey, string>> => await getFiles(docsEntry, locale);
 
-export const getDoc = async <L extends LocalesValues>(
+export const getDoc = async <L extends LocalesValues = DeclaredLocales>(
   docName: keyof typeof docsEntry,
   locale: L = defaultLocale as L
 ): Promise<string> => await getFile(docsEntry, docName, locale);
 
-export const getDocMetadataRecord = async <L extends LocalesValues>(
+export const getDocMetadataRecord = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   locale: L = defaultLocale as L
 ): Promise<Record<DocKey, FileMetadata>> =>
   await getFileMetadataRecord(docsEntry, locale);
 
-export const getDocMetadata = async <D extends DocKey, L extends LocalesValues>(
+export const getDocMetadata = async <
+  D extends DocKey,
+  L extends LocalesValues = DeclaredLocales,
+>(
   docName: D,
   locale: L = defaultLocale as L
 ): Promise<FileMetadata> => await getFileMetadata(docsEntry, docName, locale);
 
-export const getDocMetadataBySlug = async <L extends LocalesValues>(
+export const getDocMetadataBySlug = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false
 ): Promise<FileMetadata[]> =>
   await getFileMetadataBySlug(docsEntry, slugs, locale, strict);
 
-export const getDocBySlug = async <L extends LocalesValues>(
+export const getDocBySlug = async <L extends LocalesValues = DeclaredLocales>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false

package/src/frequentQuestions.ts

@@ -1,13 +1,14 @@
-import { Locales, LocalesValues } from '@intlayer/config';
+import type { DeclaredLocales, LocalesValues } from '@intlayer/types';
 import {
   defaultLocale,
-  FileMetadata,
+  type FileMetadata,
   getFile,
   getFileBySlug,
   getFileMetadata,
   getFileMetadataBySlug,
   getFileMetadataRecord,
   getFiles,
+  getKeys,
 } from './common';
 import { frequentQuestionsEntry } from './generated/frequentQuestions.entry';
 
@@ -18,38 +19,52 @@ export type FrequentQuestions = Record<
 >;
 export type FrequentQuestionMetadata = FileMetadata;
 
-export const getFrequentQuestions = async <L extends Locales>(
+export const getFrequentQuestionsKeys =
+  (): (keyof typeof frequentQuestionsEntry)[] =>
+    getKeys(frequentQuestionsEntry);
+
+export const getFrequentQuestions = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   locale: L = defaultLocale as L
 ): Promise<Record<FrequentQuestionKey, string>> =>
   getFiles(frequentQuestionsEntry, locale);
 
-export const getFrequentQuestion = async <L extends Locales>(
+export const getFrequentQuestion = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   docName: FrequentQuestionKey,
   locale: L = defaultLocale as L
 ): Promise<string> => getFile(frequentQuestionsEntry, docName, locale);
 
-export const getFrequentQuestionMetadataRecord = async <L extends Locales>(
+export const getFrequentQuestionMetadataRecord = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   locale: L = defaultLocale as L
 ): Promise<Record<FrequentQuestionKey, FileMetadata>> =>
   getFileMetadataRecord(frequentQuestionsEntry, locale);
 
 export const getFrequentQuestionMetadata = async <
   D extends FrequentQuestionKey,
-  L extends Locales,
+  L extends LocalesValues = DeclaredLocales,
 >(
   docName: D,
   locale: L = defaultLocale as L
 ): Promise<FileMetadata> =>
   getFileMetadata(frequentQuestionsEntry, docName, locale);
 
-export const getFrequentQuestionMetadataBySlug = async <L extends Locales>(
+export const getFrequentQuestionMetadataBySlug = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false
 ): Promise<FileMetadata[]> =>
   await getFileMetadataBySlug(frequentQuestionsEntry, slugs, locale, strict);
 
-export const getFrequentQuestionBySlug = async <L extends Locales>(
+export const getFrequentQuestionBySlug = async <
+  L extends LocalesValues = DeclaredLocales,
+>(
   slugs: string | string[],
   locale: L = defaultLocale as L,
   strict = false