@fonderie/client 1.11.1 → 1.13.0

package/brain/signatures.md

@@ -113,6 +113,7 @@ interface IRegisterInput {
     password: string;
     firstName?: string;
     lastName?: string;
+    locale?: string;
 }
 
 interface IResetPasswordInput {
@@ -417,6 +418,9 @@ interface ISetTemplateInput {
 
 new CourierAdminClient(opts: ICourierAdminClientOptions): CourierAdminClient
   .listTemplates(): Promise<IApiResponse<ITemplateEntry[]>>
+  .getTemplateCatalog(): Promise<IApiResponse<ITemplateCatalog>>
+  .getBuiltInTemplate(type: string, locale?: string | null | undefined): Promise<IApiResponse<IBuiltInTemplate>>
+  .resolveTemplate(type: string, locale?: string | null | undefined): Promise<IApiResponse<ITemplateResolution>>
   .getTemplate(type: string, locale?: string | null | undefined): Promise<IApiResponse<ITemplateEntry>>
   .setTemplate(type: string, input: ISetTemplateInput, locale?: string | null | undefined): Promise<IApiResponse<ITemplateEntry>>
   .deleteTemplate(type: string, locale?: string | null | undefined): Promise<IApiResponse<undefined>>
@@ -431,10 +435,22 @@ interface ITemplateGroup {
     system: boolean;
 }
 
+interface ITemplateLanguage {
+    locale: string | null;
+    label: string;
+    saved: boolean;
+    builtIn: boolean;
+    active: boolean;
+}
+
 function groupTemplatesByType(rows: readonly ITemplateEntry[]): ITemplateGroup[]
 
 function missingTemplateLocales(rows: readonly ITemplateEntry[], type: string): string[]
 
+function suggestTemplateLocales(catalog: ITemplateCatalog, type: string): string[]
+
+function templateLanguages(email: ITemplateCatalogEntry, defaultLocale: string): ITemplateLanguage[]
+
 interface IAddAddressInput {
     countryIso: string;
     zipPostalCode: string;
@@ -1465,6 +1481,43 @@ interface ISubscriptionResult {
     subscription: ISubscriptionDTO;
 }
 
+interface IBuiltInTemplate {
+    type: string;
+    locale: string;
+    subject: string | null;
+    html: string | null;
+    text: string;
+}
+
+interface ITemplateCatalog {
+    defaultLocale: string;
+    fallbacks: Record<string, string[]>;
+    emails: ITemplateCatalogEntry[];
+}
+
+interface ITemplateCatalogEntry {
+    type: string;
+    system: boolean;
+    builtIn: {
+        default: boolean;
+        languages: string[];
+    };
+    versions: Array<{
+        locale: string | null;
+        active: boolean;
+        version: number;
+        updatedAt: string;
+    }>;
+}
+
+interface ITemplateResolution {
+    requested: string;
+    chain: string[];
+    defaultLocale: string;
+    sent: string;
+    source: 'saved' | 'built-in';
+}
+
 interface ITemplateEntry {
     system?: boolean;
     type: string;

package/dist/index.cjs

@@ -56,7 +56,9 @@ __export(index_exports, {
   inferConfigValue: () => inferConfigValue,
   isAdminLocale: () => isAdminLocale,
   isMfaRequired: () => isMfaRequired,
-  missingTemplateLocales: () => missingTemplateLocales
+  missingTemplateLocales: () => missingTemplateLocales,
+  suggestTemplateLocales: () => suggestTemplateLocales,
+  templateLanguages: () => templateLanguages
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -2187,6 +2189,41 @@ var CourierAdminClient = class {
       })
     );
   }
+  // Every email — saved or built-in only — with its languages and the app's
+  // locales. The flat listTemplates() only sees saved rows.
+  getTemplateCatalog() {
+    return this.http.request(
+      this.rebase({
+        method: "GET",
+        path: "/admin/template-catalog",
+        token: this.adminToken
+      })
+    );
+  }
+  // Fonderie's own copy in a language (omitted: the English default). 404 when
+  // none ships in that language.
+  getBuiltInTemplate(type, locale) {
+    const q = locale ? `?locale=${encodeURIComponent(locale)}` : "";
+    return this.http.request(
+      this.rebase({
+        method: "GET",
+        path: `/admin/templates/${encodeURIComponent(type)}/built-in${q}`,
+        token: this.adminToken
+      })
+    );
+  }
+  // Who receives what: decided server-side by the same function a real send
+  // runs, so the answer cannot drift from delivery.
+  resolveTemplate(type, locale) {
+    const q = locale ? `?locale=${encodeURIComponent(locale)}` : "";
+    return this.http.request(
+      this.rebase({
+        method: "GET",
+        path: `/admin/templates/${encodeURIComponent(type)}/resolve${q}`,
+        token: this.adminToken
+      })
+    );
+  }
   getTemplate(type, locale) {
     const q = locale ? `?locale=${encodeURIComponent(locale)}` : "";
     return this.http.request(
@@ -2280,6 +2317,40 @@ function missingTemplateLocales(rows, type) {
   const used = new Set(rows.map((r) => r.locale).filter((l) => l !== null && !has.has(l)));
   return [...used].sort();
 }
+function templateLanguages(email, defaultLocale) {
+  const out = /* @__PURE__ */ new Map();
+  const saved = new Map(email.versions.map((v) => [v.locale, v]));
+  const base = saved.get(null);
+  if (base || email.builtIn.default) {
+    out.set("", {
+      locale: null,
+      label: defaultLocale,
+      saved: Boolean(base),
+      builtIn: email.builtIn.default,
+      active: base ? base.active : true
+    });
+  }
+  for (const lang of email.builtIn.languages) {
+    const own = saved.get(lang);
+    out.set(lang, { locale: lang, label: lang, saved: Boolean(own), builtIn: true, active: own ? own.active : true });
+  }
+  for (const v of email.versions) {
+    if (v.locale === null || out.has(v.locale)) continue;
+    out.set(v.locale, { locale: v.locale, label: v.locale, saved: true, builtIn: false, active: v.active });
+  }
+  return [...out.values()].sort((a, b) => a.label.localeCompare(b.label));
+}
+function suggestTemplateLocales(catalog4, type) {
+  const email = catalog4.emails.find((e) => e.type === type);
+  const has = new Set(email ? templateLanguages(email, catalog4.defaultLocale).map((l) => l.label) : []);
+  const used = /* @__PURE__ */ new Set();
+  for (const e of catalog4.emails) {
+    for (const l of templateLanguages(e, catalog4.defaultLocale)) {
+      if (l.locale !== null && !has.has(l.label)) used.add(l.label);
+    }
+  }
+  return [...used].sort();
+}
 
 // src/types.ts
 function isMfaRequired(result) {
@@ -3008,7 +3079,9 @@ var templates = {
     newTemplate: "New template",
     hint: "Every email the app sends. Open one to edit its copy and preview it live.",
     loading: "Loading templates\u2026",
-    openLocale: "Open the {locale} version of {type}"
+    openLocale: "Open the {locale} version of {type}",
+    legend: "Solid: a version you saved. Dashed: Fonderie\u2019s built-in copy, not edited. Struck through: switched off.",
+    languages: "Languages"
   },
   editor: {
     loading: "Loading template\u2026",
@@ -3031,7 +3104,17 @@ var templates = {
     unknownActor: "unknown",
     rollBack: "Roll back",
     confirmDelete: 'Delete "{type}"?',
-    confirmDeleteLocale: 'Delete the {locale} version of "{type}"? People in that locale will receive the default version.'
+    confirmDeleteLocale: 'Delete the {locale} version of "{type}"? People in that locale will receive the default version.',
+    builtInCopy: "Fonderie\u2019s built-in copy. Saving creates your own version of it.",
+    resetToBuiltIn: "Reset to built-in",
+    confirmReset: "Replace your {locale} version with Fonderie\u2019s built-in copy?",
+    chain: "Fallback: {chain}",
+    whoReceives: "Who receives what",
+    whoPlaceholder: "A locale, e.g. fr-BE",
+    check: "Check",
+    receives: "A {requested} user receives the {sent} version.",
+    sourceSaved: "It is your saved version.",
+    sourceBuiltIn: "It is Fonderie\u2019s built-in copy."
   },
   create: {
     titleNew: "New template",
@@ -3050,7 +3133,8 @@ var templates = {
     errorText: "The plain-text body is required \u2014 it is what every email client can show.",
     exists: '"{type}" already exists \u2014 open it from the list to edit.',
     existsLocale: '"{type}" ({locale}) already exists \u2014 open it from the list to edit.',
-    untranslated: "Still the default copy: {fields}. Translate them before adding this locale."
+    untranslated: "Still the default copy: {fields}. Translate them before adding this locale.",
+    errorDefaultLocale: "{locale} is the default version of this email. Edit the default instead."
   }
 };
 var templates_default = templates;
@@ -3704,7 +3788,9 @@ var templates2 = {
     newTemplate: "Nueva plantilla",
     hint: "Cada correo que env\xEDa la aplicaci\xF3n. Abre uno para editar su contenido y ver la vista previa en directo.",
     loading: "Cargando plantillas\u2026",
-    openLocale: "Abrir la versi\xF3n {locale} de {type}"
+    openLocale: "Abrir la versi\xF3n {locale} de {type}",
+    legend: "S\xF3lido: una versi\xF3n que guardaste. Discontinuo: la versi\xF3n integrada de Fonderie, sin editar. Tachado: desactivada.",
+    languages: "Idiomas"
   },
   editor: {
     loading: "Cargando plantilla\u2026",
@@ -3727,7 +3813,17 @@ var templates2 = {
     unknownActor: "desconocido",
     rollBack: "Restaurar",
     confirmDelete: '\xBFEliminar "{type}"?',
-    confirmDeleteLocale: '\xBFEliminar la versi\xF3n {locale} de "{type}"? Las personas de ese idioma recibir\xE1n la versi\xF3n predeterminada.'
+    confirmDeleteLocale: '\xBFEliminar la versi\xF3n {locale} de "{type}"? Las personas de ese idioma recibir\xE1n la versi\xF3n predeterminada.',
+    builtInCopy: "Versi\xF3n integrada de Fonderie. Al guardarla se crea tu propia versi\xF3n.",
+    resetToBuiltIn: "Restablecer la versi\xF3n integrada",
+    confirmReset: "\xBFReemplazar tu versi\xF3n {locale} por la versi\xF3n integrada de Fonderie?",
+    chain: "Respaldo: {chain}",
+    whoReceives: "Qui\xE9n recibe qu\xE9",
+    whoPlaceholder: "Un idioma, p. ej. fr-BE",
+    check: "Comprobar",
+    receives: "Un usuario {requested} recibe la versi\xF3n {sent}.",
+    sourceSaved: "Es tu versi\xF3n guardada.",
+    sourceBuiltIn: "Es la versi\xF3n integrada de Fonderie."
   },
   create: {
     titleNew: "Nueva plantilla",
@@ -3746,7 +3842,8 @@ var templates2 = {
     errorText: "El cuerpo en texto plano es obligatorio \u2014 es lo que puede mostrar cualquier cliente de correo.",
     exists: '"{type}" ya existe \u2014 \xE1brela desde la lista para editarla.',
     existsLocale: '"{type}" ({locale}) ya existe \u2014 \xE1brela desde la lista para editarla.',
-    untranslated: "Todav\xEDa en la versi\xF3n predeterminada: {fields}. Trad\xFAcelos antes de a\xF1adir este idioma."
+    untranslated: "Todav\xEDa en la versi\xF3n predeterminada: {fields}. Trad\xFAcelos antes de a\xF1adir este idioma.",
+    errorDefaultLocale: "{locale} es la versi\xF3n predeterminada de este correo. Edita la predeterminada en su lugar."
   }
 };
 var templates_default2 = templates2;
@@ -4400,7 +4497,9 @@ var templates3 = {
     newTemplate: "Nouveau mod\xE8le",
     hint: "Chaque e-mail envoy\xE9 par l'application. Ouvrez-en un pour modifier son contenu et le pr\xE9visualiser en direct.",
     loading: "Chargement des mod\xE8les\u2026",
-    openLocale: "Ouvrir la version {locale} de {type}"
+    openLocale: "Ouvrir la version {locale} de {type}",
+    legend: "Plein : une version que vous avez enregistr\xE9e. Pointill\xE9s : la version int\xE9gr\xE9e de Fonderie, non modifi\xE9e. Barr\xE9 : d\xE9sactiv\xE9e.",
+    languages: "Langues"
   },
   editor: {
     loading: "Chargement du mod\xE8le\u2026",
@@ -4423,7 +4522,17 @@ var templates3 = {
     unknownActor: "inconnu",
     rollBack: "Restaurer",
     confirmDelete: "Supprimer \xAB {type} \xBB ?",
-    confirmDeleteLocale: "Supprimer la version {locale} de \xAB {type} \xBB ? Les personnes de cette langue recevront la version par d\xE9faut."
+    confirmDeleteLocale: "Supprimer la version {locale} de \xAB {type} \xBB ? Les personnes de cette langue recevront la version par d\xE9faut.",
+    builtInCopy: "Version int\xE9gr\xE9e de Fonderie. L\u2019enregistrer cr\xE9e votre propre version.",
+    resetToBuiltIn: "R\xE9tablir la version int\xE9gr\xE9e",
+    confirmReset: "Remplacer votre version {locale} par la version int\xE9gr\xE9e de Fonderie ?",
+    chain: "Repli : {chain}",
+    whoReceives: "Qui re\xE7oit quoi",
+    whoPlaceholder: "Une langue, p. ex. fr-BE",
+    check: "V\xE9rifier",
+    receives: "Un utilisateur {requested} re\xE7oit la version {sent}.",
+    sourceSaved: "C\u2019est votre version enregistr\xE9e.",
+    sourceBuiltIn: "C\u2019est la version int\xE9gr\xE9e de Fonderie."
   },
   create: {
     titleNew: "Nouveau mod\xE8le",
@@ -4442,7 +4551,8 @@ var templates3 = {
     errorText: "Le corps en texte brut est obligatoire \u2014 c\u2019est ce que tout client e-mail peut afficher.",
     exists: "\xAB {type} \xBB existe d\xE9j\xE0 \u2014 ouvrez-le depuis la liste pour le modifier.",
     existsLocale: "\xAB {type} \xBB ({locale}) existe d\xE9j\xE0 \u2014 ouvrez-le depuis la liste pour le modifier.",
-    untranslated: "Encore dans la version par d\xE9faut : {fields}. Traduisez-les avant d\u2019ajouter cette langue."
+    untranslated: "Encore dans la version par d\xE9faut : {fields}. Traduisez-les avant d\u2019ajouter cette langue.",
+    errorDefaultLocale: "{locale} est la version par d\xE9faut de cet e-mail. Modifiez plut\xF4t la version par d\xE9faut."
   }
 };
 var templates_default3 = templates3;
@@ -4531,6 +4641,8 @@ function formatAdminDate(value, locale = DEFAULT_ADMIN_LOCALE, style = "datetime
   inferConfigValue,
   isAdminLocale,
   isMfaRequired,
-  missingTemplateLocales
+  missingTemplateLocales,
+  suggestTemplateLocales,
+  templateLanguages
 });
 //# sourceMappingURL=index.cjs.map