@intlayer/docs 7.0.6 → 7.0.8-canary.0

package/docs/id/packages/intlayer/getLocalizedUrl.md

@@ -0,0 +1,309 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getLocalizedUrl | intlayer
+description: Lihat cara menggunakan fungsi getLocalizedUrl untuk paket intlayer
+keywords:
+  - getLocalizedUrl
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocalizedUrl
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getLocalizedUrl` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getLocalizedUrl` menghasilkan URL yang dilokalisasi dengan menambahkan prefix locale yang ditentukan pada URL yang diberikan. Fungsi ini menangani URL absolut maupun relatif, memastikan bahwa prefix locale yang benar diterapkan berdasarkan konfigurasi.
+
+**Fitur Utama:**
+
+- Hanya 2 parameter yang diperlukan: `url` dan `currentLocale`
+- 3 parameter opsional: `locales`, `defaultLocale`, dan `prefixDefault`
+- Menggunakan konfigurasi internasionalisasi proyek Anda sebagai default
+- Dapat digunakan dengan parameter minimal untuk kasus sederhana atau dikustomisasi sepenuhnya untuk skenario kompleks
+
+---
+
+## Tanda Tangan Fungsi
+
+```typescript
+getLocalizedUrl(
+  url: string,                   // Wajib
+  currentLocale: Locales,        // Wajib
+  locales?: Locales[],           // Opsional
+  defaultLocale?: Locales,       // Opsional
+  prefixDefault?: boolean        // Opsional
+): string
+```
+
+---
+
+## Parameter
+
+### Parameter Wajib
+
+- `url: string`
+  - **Deskripsi**: String URL asli yang akan diberi prefix locale.
+  - **Tipe**: `string`
+  - **Wajib**: Ya
+
+- `currentLocale: Locales`
+  - **Deskripsi**: Locale saat ini yang digunakan untuk melokalisasi URL.
+  - **Tipe**: `Locales`
+  - **Wajib**: Ya
+
+### Parameter Opsional
+
+- `locales?: Locales[]`
+  - **Deskripsi**: Array locale yang didukung. Jika tidak disediakan, menggunakan locale yang dikonfigurasi dari konfigurasi proyek Anda.
+  - **Tipe**: `Locales[]`
+  - **Wajib**: Tidak (Opsional)
+  - **Default**: [`Konfigurasi Proyek`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/configuration.md#middleware)
+
+- `defaultLocale?: Locales`
+  - **Deskripsi**: Locale default untuk aplikasi. Jika tidak disediakan, menggunakan locale default yang dikonfigurasi dari konfigurasi proyek Anda.
+  - **Tipe**: `Locales`
+  - **Wajib**: Tidak (Opsional)
+  - **Default**: [`Konfigurasi Proyek`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/configuration.md#middleware)
+
+- `prefixDefault?: boolean`
+  - **Deskripsi**: Apakah akan menambahkan prefix pada URL untuk locale default. Jika tidak disediakan, menggunakan nilai yang dikonfigurasi dari konfigurasi proyek Anda.
+  - **Tipe**: `boolean`
+  - **Wajib**: Tidak (Opsional)
+  - **Default**: [`Konfigurasi Proyek`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/id/configuration.md#middleware)
+
+### Mengembalikan
+
+- **Tipe**: `string`
+- **Deskripsi**: URL yang sudah dilokalisasi untuk locale yang ditentukan.
+
+---
+
+## Contoh Penggunaan
+
+### Penggunaan Dasar (Hanya Parameter Wajib)
+
+Ketika Anda telah mengonfigurasi proyek Anda dengan pengaturan internasionalisasi, Anda dapat menggunakan fungsi ini hanya dengan parameter yang wajib:
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Menggunakan konfigurasi proyek Anda untuk locales, defaultLocale, dan prefixDefault
+getLocalizedUrl("/about", Locales.FRENCH);
+// Output: "/fr/about" (asumsi Bahasa Perancis didukung dalam konfigurasi Anda)
+
+getLocalizedUrl("/about", Locales.ENGLISH);
+// Output: "/about" atau "/en/about" (tergantung pada pengaturan prefixDefault Anda)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Menggunakan konfigurasi proyek Anda
+getLocalizedUrl("/about", Locales.FRENCH);
+// Output: "/fr/about"
+```
+
+```javascript codeFormat="commonjs"
+const { getLocalizedUrl, Locales } = require("intlayer");
+
+// Menggunakan konfigurasi proyek Anda
+getLocalizedUrl("/about", Locales.FRENCH);
+typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Secara eksplisit memberikan semua parameter opsional
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH], // locales
+  Locales.ENGLISH, // defaultLocale
+  false // prefixDefault
+);
+
+// Output: "/fr/about" untuk locale Bahasa Perancis
+// Output: "/about" untuk locale default (Bahasa Inggris)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Secara eksplisit memberikan semua parameter opsional
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH], // locales
+  Locales.ENGLISH, // defaultLocale
+  false // prefixDefault
+);
+
+// Output: "/fr/about" untuk locale Bahasa Perancis
+// Output: "/about" untuk locale default (Bahasa Inggris)
+```
+
+```javascript codeFormat="commonjs"
+const { getLocalizedUrl, Locales } = require("intlayer");
+
+// Secara eksplisit memberikan semua parameter opsional
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH], // locales
+  Locales.ENGLISH, // defaultLocale
+  false // prefixDefault
+);
+
+// Output: "/fr/about" untuk locale Bahasa Perancis
+// Output: "/about" untuk locale default (Bahasa Inggris)
+```
+
+### Partial Configuration Override
+
+Anda juga dapat memberikan hanya beberapa parameter opsional. Fungsi akan menggunakan konfigurasi proyek Anda untuk parameter yang tidak Anda tentukan:
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+// Hanya override locales, gunakan konfigurasi proyek untuk defaultLocale dan prefixDefault
+getLocalizedUrl(
+  "/about",
+  Locales.SPANISH,
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH] // Hanya tentukan locales
+);
+
+// Hanya override prefixDefault, gunakan konfigurasi proyek untuk locales dan defaultLocale
+getLocalizedUrl(
+  "/about",
+  Locales.ENGLISH,
+  undefined, // Gunakan konfigurasi proyek untuk locales
+  undefined, // Gunakan konfigurasi proyek untuk defaultLocale
+  true // Paksa prefix untuk locale default
+);
+```
+
+### URL Absolut
+
+```typescript
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.FRENCH, // Locale Saat Ini
+  [Locales.ENGLISH, Locales.FRENCH], // Locale yang Didukung
+  Locales.ENGLISH, // Locale Default
+  false // Prefix Locale Default
+); // Output: "https://example.com/fr/about" untuk bahasa Perancis
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Saat Ini
+  [Locales.ENGLISH, Locales.FRENCH], // Locale yang Didukung
+  Locales.ENGLISH, // Locale Default
+  false // Prefix Locale Default
+); // Output: "https://example.com/about" untuk bahasa Inggris
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Saat Ini
+  [Locales.ENGLISH, Locales.FRENCH], // Locale yang Didukung
+  Locales.ENGLISH, // Locale Default
+  true // Prefix Locale Default
+); // Output: "https://example.com/en/about" untuk bahasa Inggris
+```
+
+### Locale Tidak Didukung
+
+```typescript
+getLocalizedUrl(
+  "/about",
+  Locales.ITALIAN, // Locale Saat Ini
+  [Locales.ENGLISH, Locales.FRENCH], // Locale yang Didukung
+  Locales.ENGLISH // Locale Default
+); // Output: "/about" (tidak ada prefix yang diterapkan untuk locale yang tidak didukung)
+```
+
+---
+
+## Kasus Tepi
+
+- **Tidak Ada Segmen Locale:**
+  - Jika URL tidak mengandung segmen locale, fungsi dengan aman menambahkan prefix locale yang sesuai.
+
+- **Locale Default:**
+  - Ketika `prefixDefault` adalah `false`, fungsi tidak menambahkan prefix pada URL untuk locale default.
+
+- **Locale Tidak Didukung:**
+  - Untuk locale yang tidak tercantum dalam `locales`, fungsi tidak menerapkan prefix apapun.
+
+---
+
+## Penggunaan dalam Aplikasi
+
+Dalam aplikasi multibahasa, mengonfigurasi pengaturan internasionalisasi dengan `locales` dan `defaultLocale` sangat penting untuk memastikan bahasa yang benar ditampilkan. Berikut adalah contoh bagaimana `getLocalizedUrl` dapat digunakan dalam pengaturan aplikasi:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Konfigurasi untuk locale yang didukung dan locale default
+export default {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+```javascript codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+Konfigurasi di atas memastikan bahwa aplikasi mengenali `ENGLISH`, `FRENCH`, dan `SPANISH` sebagai bahasa yang didukung dan menggunakan `ENGLISH` sebagai bahasa cadangan.
+
+Dengan menggunakan konfigurasi ini, fungsi `getLocalizedUrl` dapat secara dinamis menghasilkan URL yang dilokalkan berdasarkan preferensi bahasa pengguna:
+
+```typescript
+getLocalizedUrl("/about", Locales.FRENCH); // Output: "/fr/about"
+getLocalizedUrl("/about", Locales.SPANISH); // Output: "/es/about"
+getLocalizedUrl("/about", Locales.ENGLISH); // Output: "/about"
+```
+
+Dengan mengintegrasikan `getLocalizedUrl`, pengembang dapat mempertahankan struktur URL yang konsisten di berbagai bahasa, meningkatkan pengalaman pengguna sekaligus SEO.

package/docs/id/packages/intlayer/getMultilingualUrls.md

@@ -0,0 +1,223 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getMultilingualUrls | intlayer
+description: Lihat cara menggunakan fungsi getMultilingualUrls untuk paket intlayer
+keywords:
+  - getMultilingualUrls
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getMultilingualUrls
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getMultilingualUrls` di `intlayer`
+
+## Deskripsi
+
+Fungsi `getMultilingualUrls` menghasilkan pemetaan URL multibahasa dengan menambahkan prefix locale yang didukung pada URL yang diberikan. Fungsi ini dapat menangani URL absolut maupun relatif, dengan menerapkan prefix locale yang sesuai berdasarkan konfigurasi yang diberikan atau nilai default.
+
+---
+
+## Parameter
+
+- `url: string`
+  - **Deskripsi**: String URL asli yang akan diberi prefix locale.
+  - **Tipe**: `string`
+
+- `locales: Locales[]`
+  - **Deskripsi**: Array opsional dari locale yang didukung. Defaultnya adalah locale yang dikonfigurasi dalam proyek.
+  - **Tipe**: `Locales[]`
+  - **Default**: `localesDefault`
+
+- `defaultLocale: Locales`
+  - **Deskripsi**: Locale default untuk aplikasi. Defaultnya adalah locale default yang dikonfigurasi dalam proyek.
+  - **Tipe**: `Locales`
+  - **Default**: `defaultLocaleDefault`
+
+- `prefixDefault: boolean`
+  - **Deskripsi**: Apakah akan menambahkan prefix pada locale default. Defaultnya adalah nilai yang dikonfigurasi dalam proyek.
+  - **Tipe**: `boolean`
+  - **Default**: `prefixDefaultDefault`
+
+### Mengembalikan
+
+- **Tipe**: `IConfigLocales<string>`
+- **Deskripsi**: Objek yang memetakan setiap locale ke URL multibahasa yang sesuai.
+
+---
+
+## Contoh Penggunaan
+
+### URL Relatif
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Output: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Output: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Output: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### URL Absolut
+
+```typescript
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  true
+);
+// Output: {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard"
+// }
+```
+
+---
+
+## Kasus Tepi
+
+- **Tidak Ada Segmen Locale:**
+  - Fungsi menghapus segmen locale yang sudah ada dari URL sebelum menghasilkan pemetaan multibahasa.
+
+- **Locale Default:**
+  - Ketika `prefixDefault` adalah `false`, fungsi tidak menambahkan prefix pada URL untuk locale default.
+
+- **Locale yang Tidak Didukung:**
+  - Hanya locale yang disediakan dalam array `locales` yang dipertimbangkan untuk menghasilkan URL.
+
+---
+
+## Penggunaan dalam Aplikasi
+
+Dalam aplikasi multibahasa, mengonfigurasi pengaturan internasionalisasi dengan `locales` dan `defaultLocale` sangat penting untuk memastikan bahasa yang benar ditampilkan. Berikut adalah contoh bagaimana `getMultilingualUrls` dapat digunakan dalam pengaturan aplikasi:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Konfigurasi untuk locale yang didukung dan locale default
+export default {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+```javascript codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Konfigurasi untuk locale yang didukung dan locale default
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Konfigurasi untuk locale yang didukung dan locale default
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+
+module.exports = config;
+```
+
+Konfigurasi di atas memastikan bahwa aplikasi mengenali `ENGLISH`, `FRENCH`, dan `SPANISH` sebagai bahasa yang didukung dan menggunakan `ENGLISH` sebagai bahasa fallback.
+
+Dengan menggunakan konfigurasi ini, fungsi `getMultilingualUrls` dapat secara dinamis menghasilkan pemetaan URL multibahasa berdasarkan locale yang didukung oleh aplikasi:
+
+```typescript
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH
+);
+// Output:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH,
+  true
+);
+// Output:
+// {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard",
+//   es: "https://example.com/es/dashboard"
+// }
+```
+
+Dengan mengintegrasikan `getMultilingualUrls`, pengembang dapat mempertahankan struktur URL yang konsisten di berbagai bahasa, meningkatkan pengalaman pengguna sekaligus SEO.

package/docs/id/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,75 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentasi Fungsi getPathWithoutLocale | intlayer
+description: Lihat cara menggunakan fungsi getPathWithoutLocale untuk paket intlayer
+keywords:
+  - getPathWithoutLocale
+  - terjemahan
+  - Intlayer
+  - intlayer
+  - Internasionalisasi
+  - Dokumentasi
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPathWithoutLocale
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inisialisasi riwayat
+---
+
+# Dokumentasi: Fungsi `getPathWithoutLocale` di `intlayer`
+
+## Deskripsi
+
+Menghapus segmen locale dari URL atau pathname yang diberikan jika ada. Fungsi ini bekerja dengan URL absolut maupun pathname relatif.
+
+## Parameter
+
+- `inputUrl: string`
+  - **Deskripsi**: String URL lengkap atau pathname yang akan diproses.
+  - **Tipe**: `string`
+
+- `locales: Locales[]`
+  - **Deskripsi**: Array opsional dari locale yang didukung. Default-nya adalah locale yang dikonfigurasi dalam proyek.
+  - **Tipe**: `Locales[]`
+
+## Mengembalikan
+
+- **Tipe**: `string`
+- **Deskripsi**: String URL atau pathname tanpa segmen locale.
+
+## Contoh Penggunaan
+
+```typescript codeFormat="typescript"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="esm"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="commonjs"
+const { getPathWithoutLocale } = require("intlayer");
+
+console.log(getPathWithoutLocale("/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Output: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Output: "https://example.com/dashboard"
+```