@forge/manifest 7.7.0-next.12 → 7.7.0-next.13

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @forge/manifest
 
+## 7.7.0-next.13
+
+### Patch Changes
+
+- 23f6675: Make `@forge/manifest` depends on `@forge/i18n` to access i18n related helper functions.
+- 27249cd: Make i18n fallback syntax confirm to industry convention. That is, `en-US: en-GB` indicate `en-GB` is fallback to `en-US`
+- 5f82d22: Update manifest definitions
+- Updated dependencies [23f6675]
+- Updated dependencies [27249cd]
+  - @forge/i18n@0.0.1-next.12
+
 ## 7.7.0-next.12
 
 ### Patch Changes

package/out/schema/manifest-schema.json

@@ -23257,7 +23257,8 @@
                             },
                             "name": {
                                 "type": "string",
-                                "minLength": 1
+                                "minLength": 1,
+                                "maxLength": 30
                             },
                             "description": {
                                 "minLength": 1,

package/out/utils/i18n/index.d.ts

@@ -1,3 +1,2 @@
 export * from './module-i18n-helper';
-export * from './translation-value-getter';
 //# sourceMappingURL=index.d.ts.map

package/out/utils/i18n/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC"}

package/out/utils/i18n/index.js

@@ -2,4 +2,3 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./module-i18n-helper"), exports);
-tslib_1.__exportStar(require("./translation-value-getter"), exports);

package/out/utils/i18n/module-i18n-helper.d.ts

@@ -1,10 +1,3 @@
 import { Modules } from '../../schema/manifest';
-export declare type ModuleI18nProperties = {
-    propertyPath: string[];
-    moduleName: string;
-    key: string;
-}[];
-export declare const extractI18nPropertiesFromModules: (modules: Modules) => ModuleI18nProperties;
-export declare const extractI18nKeysFromModules: (modules: Modules) => string[];
 export declare const extractInternalI18nPropertyKeysFromModules: (modules: Modules) => [string, string][];
 //# sourceMappingURL=module-i18n-helper.d.ts.map

package/out/utils/i18n/module-i18n-helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module-i18n-helper.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/module-i18n-helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,oBAAY,oBAAoB,GAAG;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACb,EAAE,CAAC;AA8EJ,eAAO,MAAM,gCAAgC,YAAa,OAAO,yBAWhE,CAAC;AAGF,eAAO,MAAM,0BAA0B,YAAa,OAAO,KAAG,MAAM,EAWnE,CAAC;AAEF,eAAO,MAAM,0CAA0C,YAAa,OAAO,KAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAS7F,CAAC"}
+{"version":3,"file":"module-i18n-helper.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/module-i18n-helper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAsChD,eAAO,MAAM,0CAA0C,YAAa,OAAO,KAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAS7F,CAAC"}

package/out/utils/i18n/module-i18n-helper.js

@@ -1,33 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractInternalI18nPropertyKeysFromModules = exports.extractI18nKeysFromModules = exports.extractI18nPropertiesFromModules = void 0;
+exports.extractInternalI18nPropertyKeysFromModules = void 0;
+const i18n_1 = require("@forge/i18n");
+const INTERNAL_I18N_PROPERTY_KEY_SUFFIX = '__i18n';
 const isObject = (value) => {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 };
-const isI18nValue = (value) => {
-    return typeof value?.i18n === 'string';
-};
-const getI18nKeysFromObject = (obj) => {
-    const visited = new Set();
-    const visit = (value, i18nPath) => {
-        if (!isObject(value) || visited.has(value)) {
-            return [];
-        }
-        visited.add(value);
-        return Object.entries(value).flatMap(([propKey, propValue]) => {
-            const currentPath = [...i18nPath, propKey];
-            if (isI18nValue(propValue)) {
-                return [{ propertyPath: currentPath, key: propValue.i18n }];
-            }
-            else if (Array.isArray(propValue)) {
-                return propValue.flatMap((item) => visit(item, currentPath));
-            }
-            return visit(propValue, currentPath);
-        });
-    };
-    return visit(obj, []);
-};
-const INTERNAL_I18N_PROPERTY_KEY_SUFFIX = '__i18n';
 const isInternalI18nPropertyKey = (key) => {
     return key.length > INTERNAL_I18N_PROPERTY_KEY_SUFFIX.length && key.endsWith(INTERNAL_I18N_PROPERTY_KEY_SUFFIX);
 };
@@ -53,39 +31,9 @@ const getInternalI18nPropertyKeysFromObject = (obj) => {
     };
     return visit(obj);
 };
-const getAllModuleEntries = (modules) => {
-    return Object.entries(modules).flatMap(([moduleKey, moduleEntries]) => {
-        if (moduleEntries && Array.isArray(moduleEntries) && moduleEntries.length > 0) {
-            return moduleEntries.map((moduleEntry) => [moduleEntry, moduleKey]);
-        }
-        return [];
-    });
-};
-const extractI18nPropertiesFromModules = (modules) => {
-    const moduleI18nProperties = [];
-    for (const moduleEntry of getAllModuleEntries(modules)) {
-        const i18nKeysForEntryValue = getI18nKeysFromObject(moduleEntry[0]);
-        for (const i18nObj of i18nKeysForEntryValue) {
-            moduleI18nProperties.push({ moduleName: moduleEntry[1], ...i18nObj });
-        }
-    }
-    return moduleI18nProperties;
-};
-exports.extractI18nPropertiesFromModules = extractI18nPropertiesFromModules;
-const extractI18nKeysFromModules = (modules) => {
-    const i18nKeys = new Set();
-    for (const moduleEntry of getAllModuleEntries(modules)) {
-        const i18nKeysForEntryValue = getI18nKeysFromObject(moduleEntry[0]);
-        for (const { key } of i18nKeysForEntryValue) {
-            i18nKeys.add(key);
-        }
-    }
-    return i18nKeys.size > 0 ? Array.from(i18nKeys) : [];
-};
-exports.extractI18nKeysFromModules = extractI18nKeysFromModules;
 const extractInternalI18nPropertyKeysFromModules = (modules) => {
     const i18nKeys = new Set();
-    for (const [moduleEntryObject, moduleKey] of getAllModuleEntries(modules)) {
+    for (const [moduleEntryObject, moduleKey] of (0, i18n_1.getI18nSupportedModuleEntries)(modules)) {
         const i18nKeysForEntryValue = getInternalI18nPropertyKeysFromObject(moduleEntryObject);
         for (const key of i18nKeysForEntryValue) {
             i18nKeys.add(`${key},${moduleKey}`);

package/out/utils/i18n/type-check.d.ts

@@ -0,0 +1,7 @@
+import { ForgeSupportedLocaleCode as ExpectedForgeSupportedLocaleCode } from '@forge/i18n';
+import { ForgeSupportedLocaleCode as ActualForgeSupportedLocaleCode } from '../../schema/manifest';
+declare type IsSameType<T, U> = T extends U ? (U extends T ? true : false) : false;
+declare type AreForgeSupportedLocaleCodesConsistent = IsSameType<ExpectedForgeSupportedLocaleCode, ActualForgeSupportedLocaleCode>;
+export declare const __supportedForgeLocaleCodeConsistencyCheck: AreForgeSupportedLocaleCodesConsistent;
+export {};
+//# sourceMappingURL=type-check.d.ts.map

package/out/utils/i18n/type-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-check.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/type-check.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,IAAI,gCAAgC,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,wBAAwB,IAAI,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AAEnG,aAAK,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAE3E,aAAK,sCAAsC,GAAG,UAAU,CACtD,gCAAgC,EAChC,8BAA8B,CAC/B,CAAC;AAEF,eAAO,MAAM,0CAA0C,EAAE,sCAA6C,CAAC"}

package/out/utils/i18n/type-check.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__supportedForgeLocaleCodeConsistencyCheck = void 0;
+exports.__supportedForgeLocaleCodeConsistencyCheck = true;

package/out/validators/translations-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"translations-validator.d.ts","sourceRoot":"","sources":["../../src/validators/translations-validator.ts"],"names":[],"mappings":"AAKA,OAAO,EAA+C,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAItG,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAmB,MAAM,UAAU,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAW3D,qBAAa,qBACX,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAEzF,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,GAAG,CAA8D;IAEzE,OAAO,CAAC,8BAA8B;IA4CtC,OAAO,CAAC,6BAA6B;IA+CrC,OAAO,CAAC,mBAAmB;IAwB3B,OAAO,CAAC,gCAAgC;IAoBxC,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,qBAAqB;IA4B7B,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,wBAAwB;IAiDhC,OAAO,CAAC,oBAAoB;IA2B5B,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,iCAAiC;IAwBzC,OAAO,CAAC,0BAA0B;IAalC,OAAO,CAAC,4CAA4C;IAe9C,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;CA0BrD"}
+{"version":3,"file":"translations-validator.d.ts","sourceRoot":"","sources":["../../src/validators/translations-validator.ts"],"names":[],"mappings":"AAOA,OAAO,EAA+C,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAItG,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAmB,MAAM,UAAU,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAM3D,qBAAa,qBACX,YAAW,kBAAkB,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC;IAEzF,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,GAAG,CAA8D;IAEzE,OAAO,CAAC,8BAA8B;IA4CtC,OAAO,CAAC,6BAA6B;IAwCrC,OAAO,CAAC,mBAAmB;IAwB3B,OAAO,CAAC,gCAAgC;IAoBxC,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,qBAAqB;IA4B7B,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,wBAAwB;IAiDhC,OAAO,CAAC,oBAAoB;IA2B5B,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,iCAAiC;IAwBzC,OAAO,CAAC,0BAA0B;IAalC,OAAO,CAAC,4CAA4C;IAe9C,QAAQ,CACZ,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,SAAS,GACnD,OAAO,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;CA0BrD"}

package/out/validators/translations-validator.js

@@ -6,6 +6,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = require("path");
 const lodash_1 = require("lodash");
 const ajv_1 = tslib_1.__importDefault(require("ajv"));
+const i18n_1 = require("@forge/i18n");
 const manifest_schema_json_1 = tslib_1.__importDefault(require("../schema/manifest-schema.json"));
 const text_1 = require("../text");
 const text_2 = require("../text");
@@ -51,36 +52,29 @@ class TranslationsValidator {
     }
     ensureValidFallbackDefinition(validationErrors, manifest) {
         const { resources, fallback } = manifest.yamlContent.translations;
-        const defaultLanguage = fallback.default;
         const resourcesSet = new Set(resources.map((resource) => resource.key));
-        const fallbackLanguages = Object.keys(fallback).filter((fallbackLanguage) => fallbackLanguage !== 'default');
-        const allFallbackLanguagesSet = new Set([defaultLanguage, ...fallbackLanguages]);
-        for (const fallbackLanguage of allFallbackLanguagesSet) {
-            if (!resourcesSet.has(fallbackLanguage)) {
+        const fallbackLocales = new Set(Object.values(fallback).flatMap((locales) => Array.isArray(locales) ? locales : [locales]));
+        for (const fallbackLocale of fallbackLocales) {
+            if (!resourcesSet.has(fallbackLocale)) {
+                const targetLocale = Object.entries(fallback).find(([, locales]) => locales === fallbackLocale || locales.includes(fallbackLocale))?.[0];
                 validationErrors.push({
-                    message: text_1.errors.translations.missingTranslationsJsonFile(fallbackLanguage),
+                    message: text_1.errors.translations.missingTranslationsJsonFile(fallbackLocale),
                     reference: text_2.References.SchemaError,
                     level: 'error',
-                    ...(0, utils_1.findPosition)(fallbackLanguage === defaultLanguage ? `default: ${fallbackLanguage}` : `${fallbackLanguage}:`, manifest.yamlContentByLine)
+                    ...(0, utils_1.findPosition)(`${targetLocale}:`, manifest.yamlContentByLine)
                 });
             }
         }
-        const allLanguagesList = [
-            defaultLanguage,
-            ...fallbackLanguages,
-            ...fallbackLanguages.flatMap((language) => fallback[language])
-        ];
-        const [, duplicates] = allLanguagesList.reduce(([languageSet, duplicates], language) => {
-            languageSet.has(language) ? duplicates.add(language) : languageSet.add(language);
-            return [languageSet, duplicates];
-        }, [new Set(), new Set()]);
-        for (const duplicate of duplicates) {
-            validationErrors.push({
-                message: text_1.errors.translations.duplicateFallbackConfig(duplicate),
-                reference: text_2.References.SchemaError,
-                level: 'error',
-                ...(0, utils_1.findPosition)(duplicate, manifest.yamlContentByLine)
-            });
+        for (const [targetLocale, fallbackLocales] of Object.entries(fallback)) {
+            const locales = [targetLocale, ...(Array.isArray(fallbackLocales) ? fallbackLocales : [fallbackLocales])];
+            if (locales.length !== new Set(locales).size) {
+                validationErrors.push({
+                    message: text_1.errors.translations.duplicateFallbackConfig(targetLocale),
+                    reference: text_2.References.SchemaError,
+                    level: 'error',
+                    ...(0, utils_1.findPosition)(`${targetLocale}:`, manifest.yamlContentByLine)
+                });
+            }
         }
     }
     getAllLocalesLookup(validationErrors, i18nKeys, translationsLookup, manifest) {
@@ -99,7 +93,7 @@ class TranslationsValidator {
     }
     ensureI18nKeysExistInDefaultJson(validationErrors, i18nKeys, translationsLookup, locale, manifest) {
         for (const i18nKey of i18nKeys) {
-            const i18nValue = (0, utils_1.getTranslationValue)(translationsLookup, i18nKey, locale);
+            const i18nValue = (0, i18n_1.getTranslationValue)(translationsLookup, i18nKey, locale);
             if (!i18nValue) {
                 validationErrors.push({
                     message: text_1.errors.translations.i18nKeyNotFound(i18nKey),
@@ -112,7 +106,7 @@ class TranslationsValidator {
     }
     getI18nMap(i18nKeys, translationsLookup, locale) {
         return i18nKeys.reduce((i18nMap, key) => {
-            const i18nValue = (0, utils_1.getTranslationValue)(translationsLookup, key, locale);
+            const i18nValue = (0, i18n_1.getTranslationValue)(translationsLookup, key, locale);
             if (i18nValue) {
                 i18nMap.set(key, i18nValue);
             }
@@ -252,7 +246,7 @@ class TranslationsValidator {
                 manifestObject: manifest
             };
         }
-        const moduleI18nProperties = (0, utils_1.extractI18nPropertiesFromModules)(manifest?.typedContent?.modules ?? {});
+        const moduleI18nProperties = (0, i18n_1.extractI18nPropertiesFromModules)(manifest?.typedContent?.modules ?? {});
         const i18nKeys = moduleI18nProperties.map((i18nConfig) => i18nConfig.key);
         const i18nConfig = manifest?.yamlContent?.translations;
         if (!i18nConfig) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/manifest",
-  "version": "7.7.0-next.12",
+  "version": "7.7.0-next.13",
   "description": "Definitions and validations of the Forge manifest",
   "main": "out/index.js",
   "scripts": {
@@ -24,6 +24,7 @@
   "author": "Atlassian",
   "license": "UNLICENSED",
   "dependencies": {
+    "@forge/i18n": "0.0.1-next.12",
     "@sentry/node": "7.100.1",
     "ajv": "^8.12.0",
     "ajv-formats": "2.1.1",

package/out/utils/i18n/translation-value-getter.d.ts

@@ -1,11 +0,0 @@
-import { type ForgeSupportedLocaleCode } from '../../schema/manifest';
-interface TranslationContent {
-    [key: string]: string | TranslationContent;
-}
-declare type TranslationContentByLocaleCode = {
-    [key in ForgeSupportedLocaleCode]?: TranslationContent;
-};
-export declare const getTranslationValue: (translationLookup: TranslationContentByLocaleCode, i18nKey: string, locale: ForgeSupportedLocaleCode) => string | null;
-export declare const getTranslationValueFromContent: (translationContent: TranslationContent, i18nKey: string) => string | null;
-export {};
-//# sourceMappingURL=translation-value-getter.d.ts.map

package/out/utils/i18n/translation-value-getter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"translation-value-getter.d.ts","sourceRoot":"","sources":["../../../src/utils/i18n/translation-value-getter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAEtE,UAAU,kBAAkB;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC;CAC5C;AAED,aAAK,8BAA8B,GAAG;KACnC,GAAG,IAAI,wBAAwB,CAAC,CAAC,EAAE,kBAAkB;CACvD,CAAC;AAIF,eAAO,MAAM,mBAAmB,sBACX,8BAA8B,WACxC,MAAM,UACP,wBAAwB,KAC/B,MAAM,GAAG,IAMX,CAAC;AAEF,eAAO,MAAM,8BAA8B,uBACrB,kBAAkB,WAC7B,MAAM,KACd,MAAM,GAAG,IAUX,CAAC"}

package/out/utils/i18n/translation-value-getter.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTranslationValueFromContent = exports.getTranslationValue = void 0;
-const tslib_1 = require("tslib");
-const get_1 = tslib_1.__importDefault(require("lodash/get"));
-const getTranslationValue = (translationLookup, i18nKey, locale) => {
-    const translation = translationLookup[locale];
-    if (!translation) {
-        return null;
-    }
-    return (0, exports.getTranslationValueFromContent)(translation, i18nKey);
-};
-exports.getTranslationValue = getTranslationValue;
-const getTranslationValueFromContent = (translationContent, i18nKey) => {
-    let translationValue = translationContent[i18nKey];
-    if (!translationValue) {
-        const keyTokens = i18nKey.split('.');
-        if (keyTokens.length > 1) {
-            translationValue = (0, get_1.default)(translationContent, keyTokens, null);
-        }
-    }
-    return typeof translationValue === 'string' ? translationValue : null;
-};
-exports.getTranslationValueFromContent = getTranslationValueFromContent;