sheet-i18n 1.3.18 → 1.3.20-canary.0

package/README.md

@@ -26,23 +26,23 @@ It serves as a bridge between your translation data and your application, offeri
 
 The `sheet-i18n` ecosystem is divided into three main packages:
 
-- `sheet-i18n/exporter`
+- `sheet-i18n/importer`
 - `sheet-i18n/react`
 - `@sheet-i18n/cli`
 
 <br/>
 
-<details>
-<summary>🌍 Server Export Function - sheet-i18n/exporter</summary>
+<details open>
+<summary>🌍 Server Export Function - sheet-i18n/importer</summary>
 
-#### `sheet-i18n/exporter`
+#### `sheet-i18n/importer`
 
-The **server-side exporter** subpackage allows you to interact with Google Sheets and export translations directly into your project. This is primarily used in server-side environments, such as Next.js API routes or other backend frameworks, where you want to fetch and store translations from a Google Spreadsheet to be served to clients or used within your server application.
+The **server-side importer** subpackage allows you to interact with Google Sheets and export translations directly into your project. This is primarily used in server-side environments, such as Next.js API routes or other backend frameworks, where you want to fetch and store translations from a Google Spreadsheet to be served to clients or used within your server application.
 
 ```jsx
-import { googleSheetExporter } from 'sheet-i18n/exporter';
+import { googleSheetImporter } from 'sheet-i18n/importer';
 
-const exporter = await googleSheetExporter({
+const importer = await googleSheetImporter({
   credentials: {
     sheetId: 'your-google-sheet-id',
     clientEmail: 'your-client-email',
@@ -51,12 +51,12 @@ const exporter = await googleSheetExporter({
   defaultLocale: 'default-language-in-sheet-header',
 });
 
-await exporter.exportTranslations();
+await importer.importTranslations();
 ```
 
 ### Configuration ⚙️
 
-The configuration object required for using the exporter is as follows:
+The configuration object required for using the importer is as follows:
 
 #### Required 📝
 
@@ -70,9 +70,9 @@ The configuration object required for using the exporter is as follows:
 
 - **`headerStartRowNumber`**: Specifies the row number where the headers begin (if not at the top).
 - **`ignoredSheets`**: A list of sheets to exclude by title. By default, sheets without the `defaultLocale` in headers will be ignored.
-- **`exportPath`**: Path to save exported translations. This is the location where the exported translations will be saved. By default, it will use the current working directory (cwd). This option is only used when calling the `exportTranslations` method.
+- **`importPath`**: Path to save exported translations from your sheet. This is the location where the exported translations will be saved. By default, it will use the current working directory (cwd). This option is only used when calling the `importTranslations` method.
 
-### Exporter Methods 🛠️
+### Importer Methods 🛠️
 
 #### `getTranslations` 📝
 
@@ -107,7 +107,7 @@ In this example:
 - `"en"` contains the translations for English.
   Each locale’s object contains key-value pairs for individual translations.
 
-#### `exportTranslations` 📤
+#### `importTranslations` 📤
 
 - **Description**: This asynchronous function is used in a Node.js environment to export translations directly into your project. It is especially useful if your project includes server-side APIs (like Next.js API routes) and you need to update the locale JSON data in your project. It can be invoked to update or create the locale files within your project, ensuring that the translation data is synced with the local environment.
 
@@ -117,7 +117,7 @@ In this example:
 
 #### Example:
 
-If you call the `exportTranslations` function, it will update or create JSON files in your project for each locale. The result could look like this:
+If you call the `importTranslations` function, it will update or create JSON files in your project for each locale. The result could look like this:
 
 ```ts
 // ko.json
@@ -740,7 +740,7 @@ Example `sheet.config.json`:
     "defaultLocale": "en",
     "supportedLocales": ["en", "fr", "es"],
     "ignoredSheets": ["BASE"],
-    "exportPath": "./src/locales"
+    "importPath": "./src/locales"
   }
 }
 ```
@@ -759,7 +759,7 @@ Example `sheet.config.json`:
   - **`supportedLocales(required)`**: List of locales supported in your sheet (default: [defaultLocale]).
   - **headerStartRowNumber** (optional): Row number where headers start (default: 1).
   - **ignoredSheets** (optional): Titles of sheets to exclude from the translation process.
-  - **exportPath** (optional): Directory path to save exported translations based on the current working directory (default: `.`).
+  - **importPath** (optional): Directory path to save exported translations based on the current working directory (default: `.`).
 
 ## Commands
 
@@ -834,7 +834,7 @@ Registers translation data to Google Sheets.
 
 2. It updates rows and adds "translation" entries using the `GOOGLETRANSLATE` function supported by Google Spreadsheets for automated translations.
 
-3. After registering, it asks whether you want to update the locale JSON data locally. It then exports the JSON data to the `exportPath` specified in `sheet.config.json` (default is the current working directory).
+3. After registering, it asks whether you want to update the locale JSON data locally. It then exports the JSON data to the `importPath` specified in `sheet.config.json` (default is the current working directory).
 
 #### Options:
 
@@ -896,7 +896,7 @@ The configuration of export command is based on **`sheet.config.json`** on your
     },
     "defaultLocale": "The base language of your application in sheet header",
     "ignoredSheets": ["BASE"],
-    "exportPath": "The path of export directory of translation data. (default: current working directory)"
+    "importPath": "The path of export directory of translation data. (default: current working directory)"
   }
 }
 ```

package/dist/importer/index.d.ts

@@ -0,0 +1 @@
+export * from '@sheet-i18n/importer';

package/dist/{exporter → importer}/index.js

@@ -14,11 +14,11 @@ var __copyProps = (to, from, except, desc) => {
 var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/exporter/index.ts
-var exporter_exports = {};
-module.exports = __toCommonJS(exporter_exports);
-__reExport(exporter_exports, require("@sheet-i18n/exporter"), module.exports);
+// src/importer/index.ts
+var importer_exports = {};
+module.exports = __toCommonJS(importer_exports);
+__reExport(importer_exports, require("@sheet-i18n/importer"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ...require("@sheet-i18n/exporter")
+  ...require("@sheet-i18n/importer")
 });

package/dist/importer/index.mjs

@@ -0,0 +1,2 @@
+// src/importer/index.ts
+export * from "@sheet-i18n/importer";

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 import '@sheet-i18n/react';
-import '@sheet-i18n/exporter';
+import '@sheet-i18n/importer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sheet-i18n",
-  "version": "1.3.18",
+  "version": "1.3.20-canary.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/chltjdrhd777/sheet-i18n"
@@ -12,10 +12,10 @@
     "dist/**/*"
   ],
   "exports": {
-    "./exporter": {
-      "require": "./dist/exporter/index.js",
-      "import": "./dist/exporter/index.mjs",
-      "types": "./dist/exporter/index.d.ts"
+    "./importer": {
+      "require": "./dist/importer/index.js",
+      "import": "./dist/importer/index.mjs",
+      "types": "./dist/importer/index.d.ts"
     },
     "./react": {
       "require": "./dist/react/index.js",
@@ -36,13 +36,13 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@sheet-i18n/react": "1.0.12",
-    "@sheet-i18n/exporter": "1.3.11"
+    "@sheet-i18n/importer": "1.3.13-canary.0",
+    "@sheet-i18n/react": "1.0.14-canary.0"
   },
   "devDependencies": {
     "tsup": "^6.0.0",
     "typescript": "^5.0.0",
-    "@sheet-i18n/typescript-config": "1.3.9"
+    "@sheet-i18n/typescript-config": "1.3.11-canary.0"
   },
   "scripts": {
     "build": "tsup",

package/dist/exporter/index.d.ts

@@ -1 +0,0 @@
-export * from '@sheet-i18n/exporter';

package/dist/exporter/index.mjs

@@ -1,2 +0,0 @@
-// src/exporter/index.ts
-export * from "@sheet-i18n/exporter";