@vocab/phrase 2.1.1 → 2.1.2-fix-messageformat-import-20250923004826

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,31 @@
1
+ import { UserConfig } from "@vocab/core";
2
+
3
+ //#region src/pull-translations.d.ts
4
+ interface PullOptions {
5
+ branch?: string;
6
+ deleteUnusedKeys?: boolean;
7
+ errorOnNoGlobalKeyTranslation?: boolean;
8
+ }
9
+ declare function pull({
10
+ branch,
11
+ errorOnNoGlobalKeyTranslation
12
+ }: PullOptions, config: UserConfig): Promise<void>;
13
+ //#endregion
14
+ //#region src/push-translations.d.ts
15
+ interface PushOptions {
16
+ branch: string;
17
+ deleteUnusedKeys?: boolean;
18
+ ignore?: string[];
19
+ }
20
+ /**
21
+ * Uploads translations to the Phrase API for each language.
22
+ * A unique namespace is appended to each key using the file path the key came from.
23
+ */
24
+ declare function push({
25
+ branch,
26
+ deleteUnusedKeys,
27
+ ignore
28
+ }: PushOptions, config: UserConfig): Promise<void>;
29
+ //#endregion
30
+ export { pull, push };
31
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1,31 @@
1
+ import { UserConfig } from "@vocab/core";
2
+
3
+ //#region src/pull-translations.d.ts
4
+ interface PullOptions {
5
+ branch?: string;
6
+ deleteUnusedKeys?: boolean;
7
+ errorOnNoGlobalKeyTranslation?: boolean;
8
+ }
9
+ declare function pull({
10
+ branch,
11
+ errorOnNoGlobalKeyTranslation
12
+ }: PullOptions, config: UserConfig): Promise<void>;
13
+ //#endregion
14
+ //#region src/push-translations.d.ts
15
+ interface PushOptions {
16
+ branch: string;
17
+ deleteUnusedKeys?: boolean;
18
+ ignore?: string[];
19
+ }
20
+ /**
21
+ * Uploads translations to the Phrase API for each language.
22
+ * A unique namespace is appended to each key using the file path the key came from.
23
+ */
24
+ declare function push({
25
+ branch,
26
+ deleteUnusedKeys,
27
+ ignore
28
+ }: PushOptions, config: UserConfig): Promise<void>;
29
+ //#endregion
30
+ export { pull, push };
31
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.js ADDED
@@ -0,0 +1,289 @@
1
+ //#region rolldown:runtime
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __copyProps = (to, from, except, desc) => {
9
+ if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
10
+ key = keys[i];
11
+ if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
12
+ get: ((k) => from[k]).bind(null, key),
13
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
14
+ });
15
+ }
16
+ return to;
17
+ };
18
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
19
+ value: mod,
20
+ enumerable: true
21
+ }) : target, mod));
22
+
23
+ //#endregion
24
+ let fs = require("fs");
25
+ fs = __toESM(fs);
26
+ let path = require("path");
27
+ path = __toESM(path);
28
+ let __vocab_core = require("@vocab/core");
29
+ __vocab_core = __toESM(__vocab_core);
30
+ let picocolors = require("picocolors");
31
+ picocolors = __toESM(picocolors);
32
+ let debug = require("debug");
33
+ debug = __toESM(debug);
34
+ let csv_stringify_sync = require("csv-stringify/sync");
35
+ csv_stringify_sync = __toESM(csv_stringify_sync);
36
+
37
+ //#region src/file.ts
38
+ const mkdir = fs.promises.mkdir;
39
+ const writeFile = fs.promises.writeFile;
40
+
41
+ //#endregion
42
+ //#region src/logger.ts
43
+ const trace = (0, debug.default)(`vocab:phrase`);
44
+ const log = (...params) => {
45
+ console.log(picocolors.default.yellow("Vocab"), ...params);
46
+ };
47
+
48
+ //#endregion
49
+ //#region src/csv.ts
50
+ function translationsToCsv(translations, devLanguage) {
51
+ const languages = Object.keys(translations);
52
+ const altLanguages = languages.filter((language) => language !== devLanguage);
53
+ const devLanguageTranslations = translations[devLanguage];
54
+ const csvFilesByLanguage = Object.fromEntries(languages.map((language) => [language, []]));
55
+ Object.entries(devLanguageTranslations).map(([key, { message, description, tags }]) => {
56
+ const sharedData = [
57
+ key,
58
+ description,
59
+ tags?.join(",")
60
+ ];
61
+ const devLanguageRow = [...sharedData, message];
62
+ csvFilesByLanguage[devLanguage].push(devLanguageRow);
63
+ altLanguages.map((language) => {
64
+ const altTranslationMessage = translations[language]?.[key]?.message;
65
+ if (altTranslationMessage) csvFilesByLanguage[language].push([...sharedData, altTranslationMessage]);
66
+ });
67
+ });
68
+ const csvFileStrings = Object.fromEntries(Object.entries(csvFilesByLanguage).filter(([_, csvFile]) => csvFile.length > 0).map(([language, csvFile]) => {
69
+ const csvFileString = (0, csv_stringify_sync.stringify)(csvFile, {
70
+ delimiter: ",",
71
+ header: false
72
+ });
73
+ return [language, csvFileString];
74
+ }));
75
+ const keyIndex = 1;
76
+ const commentIndex = keyIndex + 1;
77
+ const tagColumn = commentIndex + 1;
78
+ const messageIndex = tagColumn + 1;
79
+ return {
80
+ csvFileStrings,
81
+ keyIndex,
82
+ messageIndex,
83
+ commentIndex,
84
+ tagColumn
85
+ };
86
+ }
87
+
88
+ //#endregion
89
+ //#region src/phrase-api.ts
90
+ function _callPhrase(path$2, options = {}) {
91
+ const phraseApiToken = process.env.PHRASE_API_TOKEN;
92
+ if (!phraseApiToken) throw new Error("Missing PHRASE_API_TOKEN");
93
+ return fetch(path$2, {
94
+ ...options,
95
+ headers: {
96
+ Authorization: `token ${phraseApiToken}`,
97
+ "User-Agent": "Vocab Client (https://github.com/seek-oss/vocab)",
98
+ ...options.headers
99
+ }
100
+ }).then(async (response) => {
101
+ console.log(`${path$2}: ${response.status} - ${response.statusText}`);
102
+ const secondsUntilLimitReset = Math.ceil(Number.parseFloat(response.headers.get("X-Rate-Limit-Reset") || "0") - Date.now() / 1e3);
103
+ console.log(`Rate Limit: ${response.headers.get("X-Rate-Limit-Remaining")} of ${response.headers.get("X-Rate-Limit-Limit")} remaining. (${secondsUntilLimitReset} seconds remaining)`);
104
+ trace("\nLink:", response.headers.get("Link"), "\n");
105
+ try {
106
+ const result = await response.json();
107
+ trace(`Internal Result (Length: ${result.length})\n`);
108
+ if ((!options.method || options.method === "GET") && response.headers.get("Link")?.includes("rel=next")) {
109
+ const [, nextPageUrl] = response.headers.get("Link")?.match(/<([^>]*)>; rel=next/) ?? [];
110
+ if (!nextPageUrl) throw new Error("Can't parse next page URL");
111
+ console.log("Results received with next page: ", nextPageUrl);
112
+ const nextPageResult = await _callPhrase(nextPageUrl, options);
113
+ return [...result, ...nextPageResult];
114
+ }
115
+ return result;
116
+ } catch (e) {
117
+ console.error("Unable to parse response as JSON", e);
118
+ return response.text();
119
+ }
120
+ });
121
+ }
122
+ async function callPhrase(relativePath, options = {}) {
123
+ const projectId = process.env.PHRASE_PROJECT_ID;
124
+ if (!projectId) throw new Error("Missing PHRASE_PROJECT_ID");
125
+ return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then((result) => {
126
+ if (Array.isArray(result)) console.log("Result length:", result.length);
127
+ return result;
128
+ }).catch((error) => {
129
+ console.error(`Error calling phrase for ${relativePath}:`, error);
130
+ throw Error;
131
+ });
132
+ }
133
+ async function pullAllTranslations(branch) {
134
+ const phraseResult = await callPhrase(`translations?branch=${branch}&per_page=100`);
135
+ const translations = {};
136
+ for (const r of phraseResult) {
137
+ if (!translations[r.locale.name]) translations[r.locale.name] = {};
138
+ translations[r.locale.name][r.key.name] = { message: r.content };
139
+ }
140
+ return translations;
141
+ }
142
+ async function pushTranslations(translationsByLanguage, { devLanguage, branch }) {
143
+ const { csvFileStrings, keyIndex, commentIndex, tagColumn, messageIndex } = translationsToCsv(translationsByLanguage, devLanguage);
144
+ let devLanguageUploadId = "";
145
+ for (const [language, csvFileString] of Object.entries(csvFileStrings)) {
146
+ const formData = new FormData();
147
+ formData.append("file", new Blob([csvFileString], { type: "text/csv" }), `${language}.translations.csv`);
148
+ formData.append("file_format", "csv");
149
+ formData.append("branch", branch);
150
+ formData.append("update_translations", "true");
151
+ formData.append("update_descriptions", "true");
152
+ formData.append(`locale_mapping[${language}]`, messageIndex.toString());
153
+ formData.append("format_options[key_index]", keyIndex.toString());
154
+ formData.append("format_options[comment_index]", commentIndex.toString());
155
+ formData.append("format_options[tag_column]", tagColumn.toString());
156
+ formData.append("format_options[enable_pluralization]", "false");
157
+ log(`Uploading translations for language ${language}`);
158
+ const result = await callPhrase(`uploads`, {
159
+ method: "POST",
160
+ body: formData
161
+ });
162
+ trace("Upload result:\n", result);
163
+ if (result && "id" in result) {
164
+ log("Upload ID:", result.id, "\n");
165
+ log("Successfully Uploaded\n");
166
+ } else {
167
+ log(`Error uploading: ${result?.message}\n`);
168
+ log("Response:", result);
169
+ throw new Error("Error uploading");
170
+ }
171
+ if (language === devLanguage) devLanguageUploadId = result.id;
172
+ }
173
+ return { devLanguageUploadId };
174
+ }
175
+ async function deleteUnusedKeys(uploadId, branch) {
176
+ const query = `unmentioned_in_upload:${uploadId}`;
177
+ const { records_affected } = await callPhrase("keys", {
178
+ method: "DELETE",
179
+ headers: { "Content-Type": "application/json" },
180
+ body: JSON.stringify({
181
+ branch,
182
+ q: query
183
+ })
184
+ });
185
+ log("Successfully deleted", records_affected, "unused keys from branch", branch);
186
+ }
187
+ async function ensureBranch(branch) {
188
+ await callPhrase(`branches`, {
189
+ method: "POST",
190
+ headers: { "Content-Type": "application/json" },
191
+ body: JSON.stringify({ name: branch })
192
+ });
193
+ log("Created branch:", branch);
194
+ }
195
+
196
+ //#endregion
197
+ //#region src/pull-translations.ts
198
+ async function pull({ branch = "local-development", errorOnNoGlobalKeyTranslation }, config) {
199
+ trace(`Pulling translations from branch ${branch}`);
200
+ await ensureBranch(branch);
201
+ const alternativeLanguages = (0, __vocab_core.getAltLanguages)(config);
202
+ const allPhraseTranslations = await pullAllTranslations(branch);
203
+ trace(`Pulling translations from Phrase for languages ${config.devLanguage} and ${alternativeLanguages.join(", ")}`);
204
+ const phraseLanguages = Object.keys(allPhraseTranslations);
205
+ trace(`Found Phrase translations for languages ${phraseLanguages.join(", ")}`);
206
+ if (!phraseLanguages.includes(config.devLanguage)) throw new Error(`Phrase did not return any translations for the configured development language "${config.devLanguage}".\nPlease ensure this language is present in your Phrase project's configuration.`);
207
+ const allVocabTranslations = await (0, __vocab_core.loadAllTranslations)({
208
+ fallbacks: "none",
209
+ includeNodeModules: false,
210
+ withTags: true
211
+ }, config);
212
+ for (const loadedTranslation of allVocabTranslations) {
213
+ const devTranslations = loadedTranslation.languages[config.devLanguage];
214
+ if (!devTranslations) throw new Error("No dev language translations loaded");
215
+ const defaultValues = { ...devTranslations };
216
+ const localKeys = Object.keys(defaultValues);
217
+ for (const key of localKeys) defaultValues[key] = {
218
+ ...defaultValues[key],
219
+ ...allPhraseTranslations[config.devLanguage][defaultValues[key].globalKey ?? (0, __vocab_core.getUniqueKey)(key, loadedTranslation.namespace)]
220
+ };
221
+ if (Object.keys(loadedTranslation.metadata).length > 0) defaultValues._meta = loadedTranslation.metadata;
222
+ await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
223
+ for (const alternativeLanguage of alternativeLanguages) if (alternativeLanguage in allPhraseTranslations) {
224
+ const altTranslations = { ...loadedTranslation.languages[alternativeLanguage] };
225
+ const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
226
+ for (const key of localKeys) {
227
+ const phraseKey = defaultValues[key].globalKey ?? (0, __vocab_core.getUniqueKey)(key, loadedTranslation.namespace);
228
+ const phraseTranslationMessage = phraseAltTranslations[phraseKey]?.message;
229
+ if (!phraseTranslationMessage) {
230
+ trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
231
+ if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) throw new Error(`Missing translation for global key ${key} in language ${alternativeLanguage}`);
232
+ continue;
233
+ }
234
+ altTranslations[key] = {
235
+ ...altTranslations[key],
236
+ message: phraseTranslationMessage
237
+ };
238
+ }
239
+ const altTranslationFilePath = (0, __vocab_core.getAltLanguageFilePath)(loadedTranslation.filePath, alternativeLanguage);
240
+ await mkdir(path.default.dirname(altTranslationFilePath), { recursive: true });
241
+ await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
242
+ }
243
+ }
244
+ }
245
+
246
+ //#endregion
247
+ //#region src/push-translations.ts
248
+ /**
249
+ * Uploads translations to the Phrase API for each language.
250
+ * A unique namespace is appended to each key using the file path the key came from.
251
+ */
252
+ async function push({ branch, deleteUnusedKeys: deleteUnusedKeys$1, ignore }, config) {
253
+ if (ignore) trace(`ignoring files on paths: ${ignore.join(", ")}`);
254
+ const allLanguageTranslations = await (0, __vocab_core.loadAllTranslations)({
255
+ fallbacks: "none",
256
+ includeNodeModules: false,
257
+ withTags: true
258
+ }, {
259
+ ...config,
260
+ ignore: [...config.ignore || [], ...ignore || []]
261
+ });
262
+ trace(`Pushing translations to branch ${branch}`);
263
+ const allLanguages = config.languages.map((v) => v.name);
264
+ await ensureBranch(branch);
265
+ trace(`Pushing translations to phrase for languages ${allLanguages.join(", ")}`);
266
+ const phraseTranslations = {};
267
+ for (const loadedTranslation of allLanguageTranslations) for (const language of allLanguages) {
268
+ const localTranslations = loadedTranslation.languages[language];
269
+ if (!localTranslations) continue;
270
+ if (!phraseTranslations[language]) phraseTranslations[language] = {};
271
+ const { metadata: { tags: sharedTags = [] } } = loadedTranslation;
272
+ for (const localKey of Object.keys(localTranslations)) {
273
+ const { tags = [],...localTranslation } = localTranslations[localKey];
274
+ if (language === config.devLanguage) localTranslation.tags = [...tags, ...sharedTags];
275
+ const phraseKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey ?? (0, __vocab_core.getUniqueKey)(localKey, loadedTranslation.namespace);
276
+ phraseTranslations[language][phraseKey] = localTranslation;
277
+ }
278
+ }
279
+ const { devLanguageUploadId } = await pushTranslations(phraseTranslations, {
280
+ devLanguage: config.devLanguage,
281
+ branch
282
+ });
283
+ if (deleteUnusedKeys$1) await deleteUnusedKeys(devLanguageUploadId, branch);
284
+ }
285
+
286
+ //#endregion
287
+ exports.pull = pull;
288
+ exports.push = push;
289
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","names":["pc","csvFilesByLanguage: Record<LanguageName, CsvFile>","path","translations: TranslationsByLanguage","defaultValues: TranslationFileContents","phraseTranslations: TranslationsByLanguage","deleteUnusedKeys","phraseDeleteUnusedKeys"],"sources":["../src/file.ts","../src/logger.ts","../src/csv.ts","../src/phrase-api.ts","../src/pull-translations.ts","../src/push-translations.ts"],"sourcesContent":["import { promises as fs } from 'fs';\n\nexport const mkdir = fs.mkdir;\nexport const writeFile = fs.writeFile;\n","import pc from 'picocolors';\nimport debug from 'debug';\n\nexport const trace = debug(`vocab:phrase`);\n\nexport const log = (...params: unknown[]) => {\n // eslint-disable-next-line no-console\n console.log(pc.yellow('Vocab'), ...params);\n};\n","import { stringify } from 'csv-stringify/sync';\nimport type { LanguageName, TranslationsByLanguage } from '@vocab/core';\n\ntype Value = string | undefined;\ntype CsvRow = Value[];\ntype CsvFile = CsvRow[];\n\nexport function translationsToCsv(\n translations: TranslationsByLanguage,\n devLanguage: string,\n) {\n const languages = Object.keys(translations);\n const altLanguages = languages.filter((language) => language !== devLanguage);\n\n const devLanguageTranslations = translations[devLanguage];\n\n const csvFilesByLanguage: Record<LanguageName, CsvFile> = Object.fromEntries(\n languages.map((language) => [language, []]),\n );\n\n Object.entries(devLanguageTranslations).map(\n ([key, { message, description, tags }]) => {\n const sharedData = [key, description, tags?.join(',')];\n const devLanguageRow = [...sharedData, message];\n csvFilesByLanguage[devLanguage].push(devLanguageRow);\n\n altLanguages.map((language) => {\n const altTranslationMessage = translations[language]?.[key]?.message;\n\n if (altTranslationMessage) {\n csvFilesByLanguage[language].push([\n ...sharedData,\n altTranslationMessage,\n ]);\n }\n });\n },\n );\n\n const csvFileStrings = Object.fromEntries(\n Object.entries(csvFilesByLanguage)\n // Ensure CSV files are only created if the language has at least 1 translation\n .filter(([_, csvFile]) => csvFile.length > 0)\n .map(([language, csvFile]) => {\n const csvFileString = stringify(csvFile, {\n delimiter: ',',\n header: false,\n });\n\n return [language, csvFileString];\n }),\n );\n\n // Column indices start at 1\n const keyIndex = 1;\n const commentIndex = keyIndex + 1;\n const tagColumn = commentIndex + 1;\n const messageIndex = tagColumn + 1;\n\n return { csvFileStrings, keyIndex, messageIndex, commentIndex, tagColumn };\n}\n","/* eslint-disable no-console */\nimport type { TranslationsByLanguage } from '@vocab/core';\nimport { log, trace } from './logger';\nimport { translationsToCsv } from './csv';\n\nfunction _callPhrase(path: string, options: Parameters<typeof fetch>[1] = {}) {\n const phraseApiToken = process.env.PHRASE_API_TOKEN;\n\n if (!phraseApiToken) {\n throw new Error('Missing PHRASE_API_TOKEN');\n }\n\n return fetch(path, {\n ...options,\n headers: {\n Authorization: `token ${phraseApiToken}`,\n // Provide identification via User Agent as requested in https://developers.phrase.com/api/#overview--identification-via-user-agent\n 'User-Agent': 'Vocab Client (https://github.com/seek-oss/vocab)',\n ...options.headers,\n },\n }).then(async (response) => {\n console.log(`${path}: ${response.status} - ${response.statusText}`);\n\n const secondsUntilLimitReset = Math.ceil(\n Number.parseFloat(response.headers.get('X-Rate-Limit-Reset') || '0') -\n Date.now() / 1000,\n );\n console.log(\n `Rate Limit: ${response.headers.get(\n 'X-Rate-Limit-Remaining',\n )} of ${response.headers.get(\n 'X-Rate-Limit-Limit',\n )} remaining. (${secondsUntilLimitReset} seconds remaining)`,\n );\n\n trace('\\nLink:', response.headers.get('Link'), '\\n');\n // Print All Headers:\n // console.log(Array.from(r.headers.entries()));\n\n try {\n const result = await response.json();\n\n trace(`Internal Result (Length: ${result.length})\\n`);\n\n if (\n (!options.method || options.method === 'GET') &&\n response.headers.get('Link')?.includes('rel=next')\n ) {\n const [, nextPageUrl] =\n response.headers.get('Link')?.match(/<([^>]*)>; rel=next/) ?? [];\n\n if (!nextPageUrl) {\n throw new Error(\"Can't parse next page URL\");\n }\n\n console.log('Results received with next page: ', nextPageUrl);\n\n const nextPageResult = (await _callPhrase(nextPageUrl, options)) as any;\n\n return [...result, ...nextPageResult];\n }\n\n return result;\n } catch (e) {\n console.error('Unable to parse response as JSON', e);\n return response.text();\n }\n });\n}\n\nexport async function callPhrase<T = any>(\n relativePath: string,\n options: Parameters<typeof fetch>[1] = {},\n): Promise<T> {\n const projectId = process.env.PHRASE_PROJECT_ID;\n\n if (!projectId) {\n throw new Error('Missing PHRASE_PROJECT_ID');\n }\n return _callPhrase(\n `https://api.phrase.com/v2/projects/${projectId}/${relativePath}`,\n options,\n )\n .then((result) => {\n if (Array.isArray(result)) {\n console.log('Result length:', result.length);\n }\n return result;\n })\n .catch((error) => {\n console.error(`Error calling phrase for ${relativePath}:`, error);\n throw Error;\n });\n}\n\nexport async function pullAllTranslations(\n branch: string,\n): Promise<TranslationsByLanguage> {\n const phraseResult = await callPhrase<\n Array<{\n key: { name: string };\n locale: { name: string };\n content: string;\n }>\n >(`translations?branch=${branch}&per_page=100`);\n\n const translations: TranslationsByLanguage = {};\n\n for (const r of phraseResult) {\n if (!translations[r.locale.name]) {\n translations[r.locale.name] = {};\n }\n translations[r.locale.name][r.key.name] = { message: r.content };\n }\n\n return translations;\n}\n\nexport async function pushTranslations(\n translationsByLanguage: TranslationsByLanguage,\n { devLanguage, branch }: { devLanguage: string; branch: string },\n) {\n const { csvFileStrings, keyIndex, commentIndex, tagColumn, messageIndex } =\n translationsToCsv(translationsByLanguage, devLanguage);\n\n let devLanguageUploadId = '';\n\n for (const [language, csvFileString] of Object.entries(csvFileStrings)) {\n const formData = new FormData();\n\n formData.append(\n 'file',\n new Blob([csvFileString], {\n type: 'text/csv',\n }),\n `${language}.translations.csv`,\n );\n\n formData.append('file_format', 'csv');\n formData.append('branch', branch);\n formData.append('update_translations', 'true');\n formData.append('update_descriptions', 'true');\n\n formData.append(`locale_mapping[${language}]`, messageIndex.toString());\n\n formData.append('format_options[key_index]', keyIndex.toString());\n formData.append('format_options[comment_index]', commentIndex.toString());\n formData.append('format_options[tag_column]', tagColumn.toString());\n formData.append('format_options[enable_pluralization]', 'false');\n\n log(`Uploading translations for language ${language}`);\n\n const result = await callPhrase<\n | {\n id: string;\n }\n | {\n message: string;\n errors: unknown[];\n }\n | undefined\n >(`uploads`, {\n method: 'POST',\n body: formData,\n });\n\n trace('Upload result:\\n', result);\n\n if (result && 'id' in result) {\n log('Upload ID:', result.id, '\\n');\n log('Successfully Uploaded\\n');\n } else {\n log(`Error uploading: ${result?.message}\\n`);\n log('Response:', result);\n throw new Error('Error uploading');\n }\n\n if (language === devLanguage) {\n devLanguageUploadId = result.id;\n }\n }\n\n return {\n devLanguageUploadId,\n };\n}\n\nexport async function deleteUnusedKeys(uploadId: string, branch: string) {\n const query = `unmentioned_in_upload:${uploadId}`;\n const { records_affected } = await callPhrase<{ records_affected: number }>(\n 'keys',\n {\n method: 'DELETE',\n headers: {\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ branch, q: query }),\n },\n );\n\n log(\n 'Successfully deleted',\n records_affected,\n 'unused keys from branch',\n branch,\n );\n}\n\nexport async function ensureBranch(branch: string) {\n await callPhrase(`branches`, {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ name: branch }),\n });\n\n log('Created branch:', branch);\n}\n","import { writeFile, mkdir } from './file';\nimport path from 'path';\n\nimport {\n type TranslationFileContents,\n type UserConfig,\n loadAllTranslations,\n getAltLanguageFilePath,\n getAltLanguages,\n getUniqueKey,\n} from '@vocab/core';\n\nimport { pullAllTranslations, ensureBranch } from './phrase-api';\nimport { trace } from './logger';\n\ninterface PullOptions {\n branch?: string;\n deleteUnusedKeys?: boolean;\n errorOnNoGlobalKeyTranslation?: boolean;\n}\n\nexport async function pull(\n { branch = 'local-development', errorOnNoGlobalKeyTranslation }: PullOptions,\n config: UserConfig,\n) {\n trace(`Pulling translations from branch ${branch}`);\n await ensureBranch(branch);\n const alternativeLanguages = getAltLanguages(config);\n const allPhraseTranslations = await pullAllTranslations(branch);\n trace(\n `Pulling translations from Phrase for languages ${\n config.devLanguage\n } and ${alternativeLanguages.join(', ')}`,\n );\n\n const phraseLanguages = Object.keys(allPhraseTranslations);\n trace(\n `Found Phrase translations for languages ${phraseLanguages.join(', ')}`,\n );\n\n if (!phraseLanguages.includes(config.devLanguage)) {\n throw new Error(\n `Phrase did not return any translations for the configured development language \"${config.devLanguage}\".\\nPlease ensure this language is present in your Phrase project's configuration.`,\n );\n }\n\n const allVocabTranslations = await loadAllTranslations(\n { fallbacks: 'none', includeNodeModules: false, withTags: true },\n config,\n );\n\n for (const loadedTranslation of allVocabTranslations) {\n const devTranslations = loadedTranslation.languages[config.devLanguage];\n\n if (!devTranslations) {\n throw new Error('No dev language translations loaded');\n }\n\n const defaultValues: TranslationFileContents = { ...devTranslations };\n const localKeys = Object.keys(defaultValues);\n\n for (const key of localKeys) {\n defaultValues[key] = {\n ...defaultValues[key],\n ...allPhraseTranslations[config.devLanguage][\n defaultValues[key].globalKey ??\n getUniqueKey(key, loadedTranslation.namespace)\n ],\n };\n }\n\n // Only write a `_meta` field if necessary\n if (Object.keys(loadedTranslation.metadata).length > 0) {\n defaultValues._meta = loadedTranslation.metadata;\n }\n\n await writeFile(\n loadedTranslation.filePath,\n `${JSON.stringify(defaultValues, null, 2)}\\n`,\n );\n\n for (const alternativeLanguage of alternativeLanguages) {\n if (alternativeLanguage in allPhraseTranslations) {\n const altTranslations = {\n ...loadedTranslation.languages[alternativeLanguage],\n };\n const phraseAltTranslations =\n allPhraseTranslations[alternativeLanguage];\n\n for (const key of localKeys) {\n const phraseKey =\n defaultValues[key].globalKey ??\n getUniqueKey(key, loadedTranslation.namespace);\n const phraseTranslationMessage =\n phraseAltTranslations[phraseKey]?.message;\n\n if (!phraseTranslationMessage) {\n trace(\n `Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`,\n );\n if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) {\n throw new Error(\n `Missing translation for global key ${key} in language ${alternativeLanguage}`,\n );\n }\n continue;\n }\n\n altTranslations[key] = {\n ...altTranslations[key],\n message: phraseTranslationMessage,\n };\n }\n\n const altTranslationFilePath = getAltLanguageFilePath(\n loadedTranslation.filePath,\n alternativeLanguage,\n );\n\n await mkdir(path.dirname(altTranslationFilePath), {\n recursive: true,\n });\n await writeFile(\n altTranslationFilePath,\n `${JSON.stringify(altTranslations, null, 2)}\\n`,\n );\n }\n }\n }\n}\n","import {\n loadAllTranslations,\n getUniqueKey,\n type TranslationData,\n type TranslationsByLanguage,\n type UserConfig,\n} from '@vocab/core';\nimport {\n ensureBranch,\n deleteUnusedKeys as phraseDeleteUnusedKeys,\n pushTranslations,\n} from './phrase-api';\nimport { trace } from './logger';\n\ninterface PushOptions {\n branch: string;\n deleteUnusedKeys?: boolean;\n ignore?: string[];\n}\n\n/**\n * Uploads translations to the Phrase API for each language.\n * A unique namespace is appended to each key using the file path the key came from.\n */\nexport async function push(\n { branch, deleteUnusedKeys, ignore }: PushOptions,\n config: UserConfig,\n) {\n if (ignore) {\n trace(`ignoring files on paths: ${ignore.join(', ')}`);\n }\n const allLanguageTranslations = await loadAllTranslations(\n { fallbacks: 'none', includeNodeModules: false, withTags: true },\n {\n ...config,\n ignore: [...(config.ignore || []), ...(ignore || [])],\n },\n );\n trace(`Pushing translations to branch ${branch}`);\n const allLanguages = config.languages.map((v) => v.name);\n await ensureBranch(branch);\n\n trace(\n `Pushing translations to phrase for languages ${allLanguages.join(', ')}`,\n );\n\n const phraseTranslations: TranslationsByLanguage = {};\n\n for (const loadedTranslation of allLanguageTranslations) {\n for (const language of allLanguages) {\n const localTranslations = loadedTranslation.languages[language];\n if (!localTranslations) {\n continue;\n }\n if (!phraseTranslations[language]) {\n phraseTranslations[language] = {};\n }\n\n const {\n metadata: { tags: sharedTags = [] },\n } = loadedTranslation;\n\n for (const localKey of Object.keys(localTranslations)) {\n const { tags = [], ...localTranslation } = localTranslations[localKey];\n if (language === config.devLanguage) {\n (localTranslation as TranslationData).tags = [...tags, ...sharedTags];\n }\n const globalKey =\n loadedTranslation.languages[config.devLanguage][localKey].globalKey;\n\n const phraseKey =\n globalKey ?? getUniqueKey(localKey, loadedTranslation.namespace);\n\n phraseTranslations[language][phraseKey] = localTranslation;\n }\n }\n }\n\n const { devLanguageUploadId } = await pushTranslations(phraseTranslations, {\n devLanguage: config.devLanguage,\n branch,\n });\n\n if (deleteUnusedKeys) {\n await phraseDeleteUnusedKeys(devLanguageUploadId, branch);\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,MAAa,QAAQ,YAAG;AACxB,MAAa,YAAY,YAAG;;;;ACA5B,MAAa,2BAAc,eAAe;AAE1C,MAAa,OAAO,GAAG,WAAsB;AAE3C,SAAQ,IAAIA,mBAAG,OAAO,QAAQ,EAAE,GAAG,OAAO;;;;;ACA5C,SAAgB,kBACd,cACA,aACA;CACA,MAAM,YAAY,OAAO,KAAK,aAAa;CAC3C,MAAM,eAAe,UAAU,QAAQ,aAAa,aAAa,YAAY;CAE7E,MAAM,0BAA0B,aAAa;CAE7C,MAAMC,qBAAoD,OAAO,YAC/D,UAAU,KAAK,aAAa,CAAC,UAAU,EAAE,CAAC,CAAC,CAC5C;AAED,QAAO,QAAQ,wBAAwB,CAAC,KACrC,CAAC,KAAK,EAAE,SAAS,aAAa,YAAY;EACzC,MAAM,aAAa;GAAC;GAAK;GAAa,MAAM,KAAK,IAAI;GAAC;EACtD,MAAM,iBAAiB,CAAC,GAAG,YAAY,QAAQ;AAC/C,qBAAmB,aAAa,KAAK,eAAe;AAEpD,eAAa,KAAK,aAAa;GAC7B,MAAM,wBAAwB,aAAa,YAAY,MAAM;AAE7D,OAAI,sBACF,oBAAmB,UAAU,KAAK,CAChC,GAAG,YACH,sBACD,CAAC;IAEJ;GAEL;CAED,MAAM,iBAAiB,OAAO,YAC5B,OAAO,QAAQ,mBAAmB,CAE/B,QAAQ,CAAC,GAAG,aAAa,QAAQ,SAAS,EAAE,CAC5C,KAAK,CAAC,UAAU,aAAa;EAC5B,MAAM,kDAA0B,SAAS;GACvC,WAAW;GACX,QAAQ;GACT,CAAC;AAEF,SAAO,CAAC,UAAU,cAAc;GAChC,CACL;CAGD,MAAM,WAAW;CACjB,MAAM,eAAe,WAAW;CAChC,MAAM,YAAY,eAAe;CACjC,MAAM,eAAe,YAAY;AAEjC,QAAO;EAAE;EAAgB;EAAU;EAAc;EAAc;EAAW;;;;;ACtD5E,SAAS,YAAY,QAAc,UAAuC,EAAE,EAAE;CAC5E,MAAM,iBAAiB,QAAQ,IAAI;AAEnC,KAAI,CAAC,eACH,OAAM,IAAI,MAAM,2BAA2B;AAG7C,QAAO,MAAMC,QAAM;EACjB,GAAG;EACH,SAAS;GACP,eAAe,SAAS;GAExB,cAAc;GACd,GAAG,QAAQ;GACZ;EACF,CAAC,CAAC,KAAK,OAAO,aAAa;AAC1B,UAAQ,IAAI,GAAGA,OAAK,IAAI,SAAS,OAAO,KAAK,SAAS,aAAa;EAEnE,MAAM,yBAAyB,KAAK,KAClC,OAAO,WAAW,SAAS,QAAQ,IAAI,qBAAqB,IAAI,IAAI,GAClE,KAAK,KAAK,GAAG,IAChB;AACD,UAAQ,IACN,eAAe,SAAS,QAAQ,IAC9B,yBACD,CAAC,MAAM,SAAS,QAAQ,IACvB,qBACD,CAAC,eAAe,uBAAuB,qBACzC;AAED,QAAM,WAAW,SAAS,QAAQ,IAAI,OAAO,EAAE,KAAK;AAIpD,MAAI;GACF,MAAM,SAAS,MAAM,SAAS,MAAM;AAEpC,SAAM,4BAA4B,OAAO,OAAO,KAAK;AAErD,QACG,CAAC,QAAQ,UAAU,QAAQ,WAAW,UACvC,SAAS,QAAQ,IAAI,OAAO,EAAE,SAAS,WAAW,EAClD;IACA,MAAM,GAAG,eACP,SAAS,QAAQ,IAAI,OAAO,EAAE,MAAM,sBAAsB,IAAI,EAAE;AAElE,QAAI,CAAC,YACH,OAAM,IAAI,MAAM,4BAA4B;AAG9C,YAAQ,IAAI,qCAAqC,YAAY;IAE7D,MAAM,iBAAkB,MAAM,YAAY,aAAa,QAAQ;AAE/D,WAAO,CAAC,GAAG,QAAQ,GAAG,eAAe;;AAGvC,UAAO;WACA,GAAG;AACV,WAAQ,MAAM,oCAAoC,EAAE;AACpD,UAAO,SAAS,MAAM;;GAExB;;AAGJ,eAAsB,WACpB,cACA,UAAuC,EAAE,EAC7B;CACZ,MAAM,YAAY,QAAQ,IAAI;AAE9B,KAAI,CAAC,UACH,OAAM,IAAI,MAAM,4BAA4B;AAE9C,QAAO,YACL,sCAAsC,UAAU,GAAG,gBACnD,QACD,CACE,MAAM,WAAW;AAChB,MAAI,MAAM,QAAQ,OAAO,CACvB,SAAQ,IAAI,kBAAkB,OAAO,OAAO;AAE9C,SAAO;GACP,CACD,OAAO,UAAU;AAChB,UAAQ,MAAM,4BAA4B,aAAa,IAAI,MAAM;AACjE,QAAM;GACN;;AAGN,eAAsB,oBACpB,QACiC;CACjC,MAAM,eAAe,MAAM,WAMzB,uBAAuB,OAAO,eAAe;CAE/C,MAAMC,eAAuC,EAAE;AAE/C,MAAK,MAAM,KAAK,cAAc;AAC5B,MAAI,CAAC,aAAa,EAAE,OAAO,MACzB,cAAa,EAAE,OAAO,QAAQ,EAAE;AAElC,eAAa,EAAE,OAAO,MAAM,EAAE,IAAI,QAAQ,EAAE,SAAS,EAAE,SAAS;;AAGlE,QAAO;;AAGT,eAAsB,iBACpB,wBACA,EAAE,aAAa,UACf;CACA,MAAM,EAAE,gBAAgB,UAAU,cAAc,WAAW,iBACzD,kBAAkB,wBAAwB,YAAY;CAExD,IAAI,sBAAsB;AAE1B,MAAK,MAAM,CAAC,UAAU,kBAAkB,OAAO,QAAQ,eAAe,EAAE;EACtE,MAAM,WAAW,IAAI,UAAU;AAE/B,WAAS,OACP,QACA,IAAI,KAAK,CAAC,cAAc,EAAE,EACxB,MAAM,YACP,CAAC,EACF,GAAG,SAAS,mBACb;AAED,WAAS,OAAO,eAAe,MAAM;AACrC,WAAS,OAAO,UAAU,OAAO;AACjC,WAAS,OAAO,uBAAuB,OAAO;AAC9C,WAAS,OAAO,uBAAuB,OAAO;AAE9C,WAAS,OAAO,kBAAkB,SAAS,IAAI,aAAa,UAAU,CAAC;AAEvE,WAAS,OAAO,6BAA6B,SAAS,UAAU,CAAC;AACjE,WAAS,OAAO,iCAAiC,aAAa,UAAU,CAAC;AACzE,WAAS,OAAO,8BAA8B,UAAU,UAAU,CAAC;AACnE,WAAS,OAAO,wCAAwC,QAAQ;AAEhE,MAAI,uCAAuC,WAAW;EAEtD,MAAM,SAAS,MAAM,WASnB,WAAW;GACX,QAAQ;GACR,MAAM;GACP,CAAC;AAEF,QAAM,oBAAoB,OAAO;AAEjC,MAAI,UAAU,QAAQ,QAAQ;AAC5B,OAAI,cAAc,OAAO,IAAI,KAAK;AAClC,OAAI,0BAA0B;SACzB;AACL,OAAI,oBAAoB,QAAQ,QAAQ,IAAI;AAC5C,OAAI,aAAa,OAAO;AACxB,SAAM,IAAI,MAAM,kBAAkB;;AAGpC,MAAI,aAAa,YACf,uBAAsB,OAAO;;AAIjC,QAAO,EACL,qBACD;;AAGH,eAAsB,iBAAiB,UAAkB,QAAgB;CACvE,MAAM,QAAQ,yBAAyB;CACvC,MAAM,EAAE,qBAAqB,MAAM,WACjC,QACA;EACE,QAAQ;EACR,SAAS,EACP,gBAAgB,oBACjB;EACD,MAAM,KAAK,UAAU;GAAE;GAAQ,GAAG;GAAO,CAAC;EAC3C,CACF;AAED,KACE,wBACA,kBACA,2BACA,OACD;;AAGH,eAAsB,aAAa,QAAgB;AACjD,OAAM,WAAW,YAAY;EAC3B,QAAQ;EACR,SAAS,EACP,gBAAgB,oBACjB;EACD,MAAM,KAAK,UAAU,EAAE,MAAM,QAAQ,CAAC;EACvC,CAAC;AAEF,KAAI,mBAAmB,OAAO;;;;;ACpMhC,eAAsB,KACpB,EAAE,SAAS,qBAAqB,iCAChC,QACA;AACA,OAAM,oCAAoC,SAAS;AACnD,OAAM,aAAa,OAAO;CAC1B,MAAM,yDAAuC,OAAO;CACpD,MAAM,wBAAwB,MAAM,oBAAoB,OAAO;AAC/D,OACE,kDACE,OAAO,YACR,OAAO,qBAAqB,KAAK,KAAK,GACxC;CAED,MAAM,kBAAkB,OAAO,KAAK,sBAAsB;AAC1D,OACE,2CAA2C,gBAAgB,KAAK,KAAK,GACtE;AAED,KAAI,CAAC,gBAAgB,SAAS,OAAO,YAAY,CAC/C,OAAM,IAAI,MACR,mFAAmF,OAAO,YAAY,oFACvG;CAGH,MAAM,uBAAuB,4CAC3B;EAAE,WAAW;EAAQ,oBAAoB;EAAO,UAAU;EAAM,EAChE,OACD;AAED,MAAK,MAAM,qBAAqB,sBAAsB;EACpD,MAAM,kBAAkB,kBAAkB,UAAU,OAAO;AAE3D,MAAI,CAAC,gBACH,OAAM,IAAI,MAAM,sCAAsC;EAGxD,MAAMC,gBAAyC,EAAE,GAAG,iBAAiB;EACrE,MAAM,YAAY,OAAO,KAAK,cAAc;AAE5C,OAAK,MAAM,OAAO,UAChB,eAAc,OAAO;GACnB,GAAG,cAAc;GACjB,GAAG,sBAAsB,OAAO,aAC9B,cAAc,KAAK,4CACJ,KAAK,kBAAkB,UAAU;GAEnD;AAIH,MAAI,OAAO,KAAK,kBAAkB,SAAS,CAAC,SAAS,EACnD,eAAc,QAAQ,kBAAkB;AAG1C,QAAM,UACJ,kBAAkB,UAClB,GAAG,KAAK,UAAU,eAAe,MAAM,EAAE,CAAC,IAC3C;AAED,OAAK,MAAM,uBAAuB,qBAChC,KAAI,uBAAuB,uBAAuB;GAChD,MAAM,kBAAkB,EACtB,GAAG,kBAAkB,UAAU,sBAChC;GACD,MAAM,wBACJ,sBAAsB;AAExB,QAAK,MAAM,OAAO,WAAW;IAC3B,MAAM,YACJ,cAAc,KAAK,4CACN,KAAK,kBAAkB,UAAU;IAChD,MAAM,2BACJ,sBAAsB,YAAY;AAEpC,QAAI,CAAC,0BAA0B;AAC7B,WACE,+CAA+C,IAAI,gBAAgB,UAAU,eAAe,oBAAoB,GACjH;AACD,SAAI,iCAAiC,cAAc,KAAK,UACtD,OAAM,IAAI,MACR,sCAAsC,IAAI,eAAe,sBAC1D;AAEH;;AAGF,oBAAgB,OAAO;KACrB,GAAG,gBAAgB;KACnB,SAAS;KACV;;GAGH,MAAM,kEACJ,kBAAkB,UAClB,oBACD;AAED,SAAM,MAAM,aAAK,QAAQ,uBAAuB,EAAE,EAChD,WAAW,MACZ,CAAC;AACF,SAAM,UACJ,wBACA,GAAG,KAAK,UAAU,iBAAiB,MAAM,EAAE,CAAC,IAC7C;;;;;;;;;;;ACrGT,eAAsB,KACpB,EAAE,QAAQ,sCAAkB,UAC5B,QACA;AACA,KAAI,OACF,OAAM,4BAA4B,OAAO,KAAK,KAAK,GAAG;CAExD,MAAM,0BAA0B,4CAC9B;EAAE,WAAW;EAAQ,oBAAoB;EAAO,UAAU;EAAM,EAChE;EACE,GAAG;EACH,QAAQ,CAAC,GAAI,OAAO,UAAU,EAAE,EAAG,GAAI,UAAU,EAAE,CAAE;EACtD,CACF;AACD,OAAM,kCAAkC,SAAS;CACjD,MAAM,eAAe,OAAO,UAAU,KAAK,MAAM,EAAE,KAAK;AACxD,OAAM,aAAa,OAAO;AAE1B,OACE,gDAAgD,aAAa,KAAK,KAAK,GACxE;CAED,MAAMC,qBAA6C,EAAE;AAErD,MAAK,MAAM,qBAAqB,wBAC9B,MAAK,MAAM,YAAY,cAAc;EACnC,MAAM,oBAAoB,kBAAkB,UAAU;AACtD,MAAI,CAAC,kBACH;AAEF,MAAI,CAAC,mBAAmB,UACtB,oBAAmB,YAAY,EAAE;EAGnC,MAAM,EACJ,UAAU,EAAE,MAAM,aAAa,EAAE,OAC/B;AAEJ,OAAK,MAAM,YAAY,OAAO,KAAK,kBAAkB,EAAE;GACrD,MAAM,EAAE,OAAO,EAAE,CAAE,GAAG,qBAAqB,kBAAkB;AAC7D,OAAI,aAAa,OAAO,YACtB,CAAC,iBAAqC,OAAO,CAAC,GAAG,MAAM,GAAG,WAAW;GAKvE,MAAM,YAFJ,kBAAkB,UAAU,OAAO,aAAa,UAAU,4CAGhC,UAAU,kBAAkB,UAAU;AAElE,sBAAmB,UAAU,aAAa;;;CAKhD,MAAM,EAAE,wBAAwB,MAAM,iBAAiB,oBAAoB;EACzE,aAAa,OAAO;EACpB;EACD,CAAC;AAEF,KAAIC,mBACF,OAAMC,iBAAuB,qBAAqB,OAAO"}
package/dist/index.mjs ADDED
@@ -0,0 +1,259 @@
1
+ import { promises } from "fs";
2
+ import path from "path";
3
+ import { getAltLanguageFilePath, getAltLanguages, getUniqueKey, loadAllTranslations } from "@vocab/core";
4
+ import pc from "picocolors";
5
+ import debug from "debug";
6
+ import { stringify } from "csv-stringify/sync";
7
+
8
+ //#region src/file.ts
9
+ const mkdir = promises.mkdir;
10
+ const writeFile = promises.writeFile;
11
+
12
+ //#endregion
13
+ //#region src/logger.ts
14
+ const trace = debug(`vocab:phrase`);
15
+ const log = (...params) => {
16
+ console.log(pc.yellow("Vocab"), ...params);
17
+ };
18
+
19
+ //#endregion
20
+ //#region src/csv.ts
21
+ function translationsToCsv(translations, devLanguage) {
22
+ const languages = Object.keys(translations);
23
+ const altLanguages = languages.filter((language) => language !== devLanguage);
24
+ const devLanguageTranslations = translations[devLanguage];
25
+ const csvFilesByLanguage = Object.fromEntries(languages.map((language) => [language, []]));
26
+ Object.entries(devLanguageTranslations).map(([key, { message, description, tags }]) => {
27
+ const sharedData = [
28
+ key,
29
+ description,
30
+ tags?.join(",")
31
+ ];
32
+ const devLanguageRow = [...sharedData, message];
33
+ csvFilesByLanguage[devLanguage].push(devLanguageRow);
34
+ altLanguages.map((language) => {
35
+ const altTranslationMessage = translations[language]?.[key]?.message;
36
+ if (altTranslationMessage) csvFilesByLanguage[language].push([...sharedData, altTranslationMessage]);
37
+ });
38
+ });
39
+ const csvFileStrings = Object.fromEntries(Object.entries(csvFilesByLanguage).filter(([_, csvFile]) => csvFile.length > 0).map(([language, csvFile]) => {
40
+ const csvFileString = stringify(csvFile, {
41
+ delimiter: ",",
42
+ header: false
43
+ });
44
+ return [language, csvFileString];
45
+ }));
46
+ const keyIndex = 1;
47
+ const commentIndex = keyIndex + 1;
48
+ const tagColumn = commentIndex + 1;
49
+ const messageIndex = tagColumn + 1;
50
+ return {
51
+ csvFileStrings,
52
+ keyIndex,
53
+ messageIndex,
54
+ commentIndex,
55
+ tagColumn
56
+ };
57
+ }
58
+
59
+ //#endregion
60
+ //#region src/phrase-api.ts
61
+ function _callPhrase(path$1, options = {}) {
62
+ const phraseApiToken = process.env.PHRASE_API_TOKEN;
63
+ if (!phraseApiToken) throw new Error("Missing PHRASE_API_TOKEN");
64
+ return fetch(path$1, {
65
+ ...options,
66
+ headers: {
67
+ Authorization: `token ${phraseApiToken}`,
68
+ "User-Agent": "Vocab Client (https://github.com/seek-oss/vocab)",
69
+ ...options.headers
70
+ }
71
+ }).then(async (response) => {
72
+ console.log(`${path$1}: ${response.status} - ${response.statusText}`);
73
+ const secondsUntilLimitReset = Math.ceil(Number.parseFloat(response.headers.get("X-Rate-Limit-Reset") || "0") - Date.now() / 1e3);
74
+ console.log(`Rate Limit: ${response.headers.get("X-Rate-Limit-Remaining")} of ${response.headers.get("X-Rate-Limit-Limit")} remaining. (${secondsUntilLimitReset} seconds remaining)`);
75
+ trace("\nLink:", response.headers.get("Link"), "\n");
76
+ try {
77
+ const result = await response.json();
78
+ trace(`Internal Result (Length: ${result.length})\n`);
79
+ if ((!options.method || options.method === "GET") && response.headers.get("Link")?.includes("rel=next")) {
80
+ const [, nextPageUrl] = response.headers.get("Link")?.match(/<([^>]*)>; rel=next/) ?? [];
81
+ if (!nextPageUrl) throw new Error("Can't parse next page URL");
82
+ console.log("Results received with next page: ", nextPageUrl);
83
+ const nextPageResult = await _callPhrase(nextPageUrl, options);
84
+ return [...result, ...nextPageResult];
85
+ }
86
+ return result;
87
+ } catch (e) {
88
+ console.error("Unable to parse response as JSON", e);
89
+ return response.text();
90
+ }
91
+ });
92
+ }
93
+ async function callPhrase(relativePath, options = {}) {
94
+ const projectId = process.env.PHRASE_PROJECT_ID;
95
+ if (!projectId) throw new Error("Missing PHRASE_PROJECT_ID");
96
+ return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then((result) => {
97
+ if (Array.isArray(result)) console.log("Result length:", result.length);
98
+ return result;
99
+ }).catch((error) => {
100
+ console.error(`Error calling phrase for ${relativePath}:`, error);
101
+ throw Error;
102
+ });
103
+ }
104
+ async function pullAllTranslations(branch) {
105
+ const phraseResult = await callPhrase(`translations?branch=${branch}&per_page=100`);
106
+ const translations = {};
107
+ for (const r of phraseResult) {
108
+ if (!translations[r.locale.name]) translations[r.locale.name] = {};
109
+ translations[r.locale.name][r.key.name] = { message: r.content };
110
+ }
111
+ return translations;
112
+ }
113
+ async function pushTranslations(translationsByLanguage, { devLanguage, branch }) {
114
+ const { csvFileStrings, keyIndex, commentIndex, tagColumn, messageIndex } = translationsToCsv(translationsByLanguage, devLanguage);
115
+ let devLanguageUploadId = "";
116
+ for (const [language, csvFileString] of Object.entries(csvFileStrings)) {
117
+ const formData = new FormData();
118
+ formData.append("file", new Blob([csvFileString], { type: "text/csv" }), `${language}.translations.csv`);
119
+ formData.append("file_format", "csv");
120
+ formData.append("branch", branch);
121
+ formData.append("update_translations", "true");
122
+ formData.append("update_descriptions", "true");
123
+ formData.append(`locale_mapping[${language}]`, messageIndex.toString());
124
+ formData.append("format_options[key_index]", keyIndex.toString());
125
+ formData.append("format_options[comment_index]", commentIndex.toString());
126
+ formData.append("format_options[tag_column]", tagColumn.toString());
127
+ formData.append("format_options[enable_pluralization]", "false");
128
+ log(`Uploading translations for language ${language}`);
129
+ const result = await callPhrase(`uploads`, {
130
+ method: "POST",
131
+ body: formData
132
+ });
133
+ trace("Upload result:\n", result);
134
+ if (result && "id" in result) {
135
+ log("Upload ID:", result.id, "\n");
136
+ log("Successfully Uploaded\n");
137
+ } else {
138
+ log(`Error uploading: ${result?.message}\n`);
139
+ log("Response:", result);
140
+ throw new Error("Error uploading");
141
+ }
142
+ if (language === devLanguage) devLanguageUploadId = result.id;
143
+ }
144
+ return { devLanguageUploadId };
145
+ }
146
+ async function deleteUnusedKeys(uploadId, branch) {
147
+ const query = `unmentioned_in_upload:${uploadId}`;
148
+ const { records_affected } = await callPhrase("keys", {
149
+ method: "DELETE",
150
+ headers: { "Content-Type": "application/json" },
151
+ body: JSON.stringify({
152
+ branch,
153
+ q: query
154
+ })
155
+ });
156
+ log("Successfully deleted", records_affected, "unused keys from branch", branch);
157
+ }
158
+ async function ensureBranch(branch) {
159
+ await callPhrase(`branches`, {
160
+ method: "POST",
161
+ headers: { "Content-Type": "application/json" },
162
+ body: JSON.stringify({ name: branch })
163
+ });
164
+ log("Created branch:", branch);
165
+ }
166
+
167
+ //#endregion
168
+ //#region src/pull-translations.ts
169
+ async function pull({ branch = "local-development", errorOnNoGlobalKeyTranslation }, config) {
170
+ trace(`Pulling translations from branch ${branch}`);
171
+ await ensureBranch(branch);
172
+ const alternativeLanguages = getAltLanguages(config);
173
+ const allPhraseTranslations = await pullAllTranslations(branch);
174
+ trace(`Pulling translations from Phrase for languages ${config.devLanguage} and ${alternativeLanguages.join(", ")}`);
175
+ const phraseLanguages = Object.keys(allPhraseTranslations);
176
+ trace(`Found Phrase translations for languages ${phraseLanguages.join(", ")}`);
177
+ if (!phraseLanguages.includes(config.devLanguage)) throw new Error(`Phrase did not return any translations for the configured development language "${config.devLanguage}".\nPlease ensure this language is present in your Phrase project's configuration.`);
178
+ const allVocabTranslations = await loadAllTranslations({
179
+ fallbacks: "none",
180
+ includeNodeModules: false,
181
+ withTags: true
182
+ }, config);
183
+ for (const loadedTranslation of allVocabTranslations) {
184
+ const devTranslations = loadedTranslation.languages[config.devLanguage];
185
+ if (!devTranslations) throw new Error("No dev language translations loaded");
186
+ const defaultValues = { ...devTranslations };
187
+ const localKeys = Object.keys(defaultValues);
188
+ for (const key of localKeys) defaultValues[key] = {
189
+ ...defaultValues[key],
190
+ ...allPhraseTranslations[config.devLanguage][defaultValues[key].globalKey ?? getUniqueKey(key, loadedTranslation.namespace)]
191
+ };
192
+ if (Object.keys(loadedTranslation.metadata).length > 0) defaultValues._meta = loadedTranslation.metadata;
193
+ await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
194
+ for (const alternativeLanguage of alternativeLanguages) if (alternativeLanguage in allPhraseTranslations) {
195
+ const altTranslations = { ...loadedTranslation.languages[alternativeLanguage] };
196
+ const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
197
+ for (const key of localKeys) {
198
+ const phraseKey = defaultValues[key].globalKey ?? getUniqueKey(key, loadedTranslation.namespace);
199
+ const phraseTranslationMessage = phraseAltTranslations[phraseKey]?.message;
200
+ if (!phraseTranslationMessage) {
201
+ trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
202
+ if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) throw new Error(`Missing translation for global key ${key} in language ${alternativeLanguage}`);
203
+ continue;
204
+ }
205
+ altTranslations[key] = {
206
+ ...altTranslations[key],
207
+ message: phraseTranslationMessage
208
+ };
209
+ }
210
+ const altTranslationFilePath = getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
211
+ await mkdir(path.dirname(altTranslationFilePath), { recursive: true });
212
+ await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
213
+ }
214
+ }
215
+ }
216
+
217
+ //#endregion
218
+ //#region src/push-translations.ts
219
+ /**
220
+ * Uploads translations to the Phrase API for each language.
221
+ * A unique namespace is appended to each key using the file path the key came from.
222
+ */
223
+ async function push({ branch, deleteUnusedKeys: deleteUnusedKeys$1, ignore }, config) {
224
+ if (ignore) trace(`ignoring files on paths: ${ignore.join(", ")}`);
225
+ const allLanguageTranslations = await loadAllTranslations({
226
+ fallbacks: "none",
227
+ includeNodeModules: false,
228
+ withTags: true
229
+ }, {
230
+ ...config,
231
+ ignore: [...config.ignore || [], ...ignore || []]
232
+ });
233
+ trace(`Pushing translations to branch ${branch}`);
234
+ const allLanguages = config.languages.map((v) => v.name);
235
+ await ensureBranch(branch);
236
+ trace(`Pushing translations to phrase for languages ${allLanguages.join(", ")}`);
237
+ const phraseTranslations = {};
238
+ for (const loadedTranslation of allLanguageTranslations) for (const language of allLanguages) {
239
+ const localTranslations = loadedTranslation.languages[language];
240
+ if (!localTranslations) continue;
241
+ if (!phraseTranslations[language]) phraseTranslations[language] = {};
242
+ const { metadata: { tags: sharedTags = [] } } = loadedTranslation;
243
+ for (const localKey of Object.keys(localTranslations)) {
244
+ const { tags = [],...localTranslation } = localTranslations[localKey];
245
+ if (language === config.devLanguage) localTranslation.tags = [...tags, ...sharedTags];
246
+ const phraseKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey ?? getUniqueKey(localKey, loadedTranslation.namespace);
247
+ phraseTranslations[language][phraseKey] = localTranslation;
248
+ }
249
+ }
250
+ const { devLanguageUploadId } = await pushTranslations(phraseTranslations, {
251
+ devLanguage: config.devLanguage,
252
+ branch
253
+ });
254
+ if (deleteUnusedKeys$1) await deleteUnusedKeys(devLanguageUploadId, branch);
255
+ }
256
+
257
+ //#endregion
258
+ export { pull, push };
259
+ //# sourceMappingURL=index.mjs.map