@intlayer/docs 5.5.11 → 5.6.0

package/legal/zh/terms_of_service.md

@@ -0,0 +1,55 @@
+---
+createdAt: 2025-04-18
+updatedAt: 2025-06-29
+title: Intlayer 服务条款
+description: 了解 Intlayer 如何处理通过我们的网站和 CMS 收集的信息。请参阅文档以了解不同的格式和使用案例。
+keywords:
+  - 国际化
+  - 文档
+  - Intlayer
+  - 服务条款
+  - 服务
+  - 使用
+  - 许可
+  - 责任
+  - 隐私
+  - 贡献
+  - 归属
+  - 条款修改
+slugs:
+  - terms-of-service
+---
+
+# Intlayer 使用条款
+
+## 1. 条款接受
+
+通过使用 Intlayer，您同意受这些使用条款的约束。如果您不接受这些条款，请不要使用该工具。
+
+## 2. 许可
+
+Intlayer 采用 **Apache 2.0 许可证** 进行分发，该许可证允许在开源和商业项目中使用、修改和分发代码。用户被允许根据我们[贡献指南](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md)中制定的规则修改源代码并通过拉取请求提交贡献。严禁为商业用途盗用代码。
+
+## 3. 商业使用
+
+您被允许将 Intlayer 用于商业项目。然而，禁止在未进行重大改造或实质性增值的情况下，直接复用代码以创建基于 Intlayer 的竞争工具。
+
+## 4. 责任
+
+Intlayer 的维护者致力于在发现漏洞和安全问题后尽快修复。但对于因这些问题对用户基础设施造成的任何损害，维护者不承担任何责任。我们鼓励用户通过我们的[问题跟踪系统](https://github.com/aymericzip/intlayer/issues)报告问题。
+
+## 5. 隐私
+
+Intlayer 不会收集或存储任何用户的个人数据。
+
+## 6. 贡献
+
+鼓励用户按照我们的贡献指南中的指引为 Intlayer 做出贡献。任何提交的代码必须符合既定的质量标准，并将在集成前由维护者进行审核。
+
+## 7. 归属
+
+任何为扩展或利用 Intlayer 代码而开发的工具，必须明确标注 Intlayer 作为代码的基础。此归属必须在源代码中以及任何用户或宣传文档中可见。
+
+## 8. 条款修改
+
+本使用条款可随时修改。用户将被告知使用条款的任何重大变更，并且必须接受这些变更才能继续使用 Intlayer。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/docs",
-  "version": "5.5.11",
+  "version": "5.6.0",
   "private": false,
   "description": "Intlayer documentation",
   "keywords": [
@@ -45,11 +45,12 @@
     "src",
     "dist",
     "frequent_questions",
-    "blog"
+    "blog",
+    "legal"
   ],
   "dependencies": {
-    "@intlayer/config": "5.5.11",
-    "intlayer": "5.5.11"
+    "@intlayer/config": "5.6.0",
+    "intlayer": "5.6.0"
   },
   "devDependencies": {
     "@types/node": "^22.15.30",
@@ -64,16 +65,16 @@
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
     "vitest": "^3.2.2",
-    "@intlayer/api": "5.5.11",
     "@utils/ts-config": "1.0.4",
-    "@utils/ts-config-types": "1.0.4",
     "@utils/tsup-config": "1.0.4",
-    "@intlayer/cli": "5.5.11"
+    "@utils/ts-config-types": "1.0.4",
+    "@intlayer/api": "5.6.0",
+    "@intlayer/cli": "5.6.0"
   },
   "peerDependencies": {
-    "@intlayer/api": "5.5.11",
-    "@intlayer/cli": "5.5.11",
-    "@intlayer/config": "5.5.11"
+    "@intlayer/api": "5.6.0",
+    "@intlayer/cli": "5.6.0",
+    "@intlayer/config": "5.6.0"
   },
   "engines": {
     "node": ">=14.18"
@@ -82,12 +83,12 @@
     "url": "https://github.com/aymericzip/intlayer/issues"
   },
   "scripts": {
+    "prebuild": "tsx tools/generateEntry.ts",
     "build": "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\"",
-    "generateEntry": "tsx tools/generateEntry.ts",
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --cache --fix",
     "prettier": "prettier . --check",

package/src/blog.ts

@@ -39,11 +39,13 @@ export const getBlogMetadata = async <
 
 export const getBlogMetadataBySlug = async <L extends LocalesValues>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
+  locale: L = defaultLocale as L,
+  strict = false
 ): Promise<FileMetadata[]> =>
-  await getFileMetadataBySlug(blogEntry, slugs, locale);
+  await getFileMetadataBySlug(blogEntry, slugs, locale, strict);
 
 export const getBlogBySlug = async <L extends LocalesValues>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
-): Promise<string[]> => await getFileBySlug(blogEntry, slugs, locale);
+  locale: L = defaultLocale as L,
+  strict = false
+): Promise<string[]> => await getFileBySlug(blogEntry, slugs, locale, strict);

package/src/common.ts

@@ -66,6 +66,9 @@ export type FileMetadata = {
   keywords: string[];
   updatedAt: string;
   createdAt: string;
+  author?: string;
+  youtubeVideo?: string;
+  applicationTemplate?: string;
 };
 
 export const formatMetadata = (
@@ -76,10 +79,12 @@ export const formatMetadata = (
   const metadata = getMarkdownMetadata(file);
   const relativeUrl = join('/', ...(metadata.slugs ?? []));
 
+  const slicedDocKey = docKey.slice(1);
+
   return {
     ...metadata,
     docKey,
-    githubUrl: join(GITHUB_URL_PREFIX, docKey as string).replace(
+    githubUrl: `${GITHUB_URL_PREFIX}${slicedDocKey}`.replace(
       '/en/',
       `/${locale}/`
     ),
@@ -127,7 +132,8 @@ export const getFileMetadataBySlug = async <
 >(
   files: F,
   slugs: string | string[],
-  locale: LocalesValues = defaultLocale as LocalesValues
+  locale: LocalesValues = defaultLocale as LocalesValues,
+  strict = false
 ) => {
   const slugsArray = Array.isArray(slugs) ? slugs : [slugs];
   const filesMetadata = await getFileMetadataRecord(
@@ -135,11 +141,17 @@ export const getFileMetadataBySlug = async <
     defaultLocale as LocalesValues
   );
 
-  const fileMetadataArray: FileMetadata[] = Object.values(filesMetadata).filter(
+  let fileMetadataArray: FileMetadata[] = Object.values(filesMetadata).filter(
     (fileMetadata) =>
       slugsArray.every((slug) => fileMetadata.slugs?.includes(slug))
   );
 
+  if (strict) {
+    fileMetadataArray = fileMetadataArray.filter(
+      (fileMetadata) => fileMetadata.slugs.length === slugsArray.length
+    );
+  }
+
   if (locale !== defaultLocale) {
     const localizedFileMetadata = await Promise.all(
       fileMetadataArray.map(
@@ -159,7 +171,8 @@ export const getFileBySlug = async <
 >(
   files: F,
   slugs: string | string[],
-  locale: LocalesValues = defaultLocale as LocalesValues
+  locale: LocalesValues = defaultLocale as LocalesValues,
+  strict = false
 ) => {
   const slugsArray = Array.isArray(slugs) ? slugs : [slugs];
   const filesMetadata = await getFileMetadataRecord(
@@ -167,11 +180,16 @@ export const getFileBySlug = async <
     defaultLocale as LocalesValues
   );
 
-  const fileMetadataArray = Object.values(filesMetadata).filter(
-    (fileMetadata) =>
-      fileMetadata.slugs.every((slug) => slugsArray.includes(slug))
+  let fileMetadataArray = Object.values(filesMetadata).filter((fileMetadata) =>
+    slugsArray.every((slug) => fileMetadata.slugs?.includes(slug))
   );
 
+  if (strict) {
+    fileMetadataArray = fileMetadataArray.filter(
+      (fileMetadata) => fileMetadata.slugs.length === slugsArray.length
+    );
+  }
+
   const fileList = await Promise.all(
     fileMetadataArray.map(async (fileMetadata) => {
       const file = await getFile(files, fileMetadata.docKey, locale);

package/src/doc.ts

@@ -36,11 +36,13 @@ export const getDocMetadata = async <D extends DocKey, L extends LocalesValues>(
 
 export const getDocMetadataBySlug = async <L extends LocalesValues>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
+  locale: L = defaultLocale as L,
+  strict = false
 ): Promise<FileMetadata[]> =>
-  await getFileMetadataBySlug(docsEntry, slugs, locale);
+  await getFileMetadataBySlug(docsEntry, slugs, locale, strict);
 
 export const getDocBySlug = async <L extends LocalesValues>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
-): Promise<string[]> => await getFileBySlug(docsEntry, slugs, locale);
+  locale: L = defaultLocale as L,
+  strict = false
+): Promise<string[]> => await getFileBySlug(docsEntry, slugs, locale, strict);

package/src/frequentQuestions.ts

@@ -44,12 +44,14 @@ export const getFrequentQuestionMetadata = async <
 
 export const getFrequentQuestionMetadataBySlug = async <L extends Locales>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
+  locale: L = defaultLocale as L,
+  strict = false
 ): Promise<FileMetadata[]> =>
-  await getFileMetadataBySlug(frequentQuestionsEntry, slugs, locale);
+  await getFileMetadataBySlug(frequentQuestionsEntry, slugs, locale, strict);
 
 export const getFrequentQuestionBySlug = async <L extends Locales>(
   slugs: string | string[],
-  locale: L = defaultLocale as L
+  locale: L = defaultLocale as L,
+  strict = false
 ): Promise<string[]> =>
-  await getFileBySlug(frequentQuestionsEntry, slugs, locale);
+  await getFileBySlug(frequentQuestionsEntry, slugs, locale, strict);