@datatechsolutions/tympan-tokens 0.3.0

package/dist/print-aliases.d.ts

@@ -0,0 +1,54 @@
+//#region src/print-aliases.d.ts
+/** Prefix of every print theme name: `data-ty-theme="print-<style>"`. */
+export declare const PRINT_THEME_PREFIX = "print-";
+/**
+ * Deprecated style ids and the current id each one maps to. The styles were
+ * renamed to neutral, descriptive ids (no trademarks, institutions or people's
+ * names); the old ids keep working through `resolvePrintStyleName`,
+ * `resolvePrintStyle`, `LivroPrint estilo` and, as `print-<old id>`, the UI
+ * theme lookup (`resolvePrintThemeName`), with a one-time console warning in
+ * development builds.
+ *
+ * Removal: the aliases (and the `'modulor'` emblem) will be dropped in the
+ * next major version of @datatechsolutions/tympan-tokens and
+ * @datatechsolutions/tympan-print; migrate stored data books to the new ids.
+ */
+export declare const PRINT_STYLE_ALIASES: {
+  readonly economist: 'semanario';
+  readonly ft: 'papel-salmao';
+  readonly schiphol: 'sinalizacao';
+  readonly 'jornal-do-brasil': 'jornal-1959';
+  readonly 'atlas-ibge': 'atlas-oficial';
+  readonly deardata: 'cartao-postal';
+  readonly tufte: 'minimo-de-tinta';
+  readonly holmes: 'infografico-ilustrado';
+  readonly bayer: 'diagrama-modernista';
+  readonly dubois: 'graficos-1900';
+  readonly minard: 'fluxo-historico';
+  readonly mccandless: 'blocos-coloridos';
+  readonly corbusier: 'proporcao-modular';
+  readonly aicher: 'pictogramas';
+  readonly vignelli: 'mapa-de-metro';
+  readonly 'athos-bulcao': 'azulejo-modernista';
+  readonly crouwel: 'grade-holandesa';
+  readonly 'saul-bass': 'papel-recortado';
+};
+/** A deprecated style id (see PRINT_STYLE_ALIASES). */
+export type PrintStyleAlias = keyof typeof PRINT_STYLE_ALIASES;
+/** Warns once per id (development builds only) that a deprecated id was used. @internal */
+export declare function warnDeprecatedPrintId(old: string, current: string, kind?: string): void;
+/**
+ * Deprecated print theme names (`print-<old style id>`) and the current theme
+ * each maps to, derived from PRINT_STYLE_ALIASES (for example
+ * `print-economist` -> `print-semanario`). Same removal schedule: dropped in
+ * the next major version.
+ */
+export declare const PRINT_THEME_ALIASES: Readonly<Record<string, string>>;
+/**
+ * The current name of a theme: a deprecated `print-<old id>` is mapped to its
+ * `print-<new id>` (with a one-time development warning); any other name is
+ * returned unchanged.
+ */
+export declare function resolvePrintThemeName(theme: string): string;
+//#endregion
+//# sourceMappingURL=print-aliases.d.ts.map

package/dist/print-aliases.js

@@ -0,0 +1,71 @@
+//#region src/print-aliases.ts
+/** Prefix of every print theme name: `data-ty-theme="print-<style>"`. */
+const PRINT_THEME_PREFIX = "print-";
+/**
+* Deprecated style ids and the current id each one maps to. The styles were
+* renamed to neutral, descriptive ids (no trademarks, institutions or people's
+* names); the old ids keep working through `resolvePrintStyleName`,
+* `resolvePrintStyle`, `LivroPrint estilo` and, as `print-<old id>`, the UI
+* theme lookup (`resolvePrintThemeName`), with a one-time console warning in
+* development builds.
+*
+* Removal: the aliases (and the `'modulor'` emblem) will be dropped in the
+* next major version of @datatechsolutions/tympan-tokens and
+* @datatechsolutions/tympan-print; migrate stored data books to the new ids.
+*/
+const PRINT_STYLE_ALIASES = {
+	economist: "semanario",
+	ft: "papel-salmao",
+	schiphol: "sinalizacao",
+	"jornal-do-brasil": "jornal-1959",
+	"atlas-ibge": "atlas-oficial",
+	deardata: "cartao-postal",
+	tufte: "minimo-de-tinta",
+	holmes: "infografico-ilustrado",
+	bayer: "diagrama-modernista",
+	dubois: "graficos-1900",
+	minard: "fluxo-historico",
+	mccandless: "blocos-coloridos",
+	corbusier: "proporcao-modular",
+	aicher: "pictogramas",
+	vignelli: "mapa-de-metro",
+	"athos-bulcao": "azulejo-modernista",
+	crouwel: "grade-holandesa",
+	"saul-bass": "papel-recortado"
+};
+const isDev = (() => {
+	try {
+		return globalThis.process?.env?.NODE_ENV !== "production";
+	} catch {
+		return true;
+	}
+})();
+const warned = /* @__PURE__ */ new Set();
+/** Warns once per id (development builds only) that a deprecated id was used. @internal */
+function warnDeprecatedPrintId(old, current, kind = "print style") {
+	if (!isDev || warned.has(old)) return;
+	warned.add(old);
+	console.warn(`[@datatechsolutions/tympan] The ${kind} "${old}" is deprecated; use "${current}". The old id will be removed in the next major version.`);
+}
+/**
+* Deprecated print theme names (`print-<old style id>`) and the current theme
+* each maps to, derived from PRINT_STYLE_ALIASES (for example
+* `print-economist` -> `print-semanario`). Same removal schedule: dropped in
+* the next major version.
+*/
+const PRINT_THEME_ALIASES = Object.fromEntries(Object.entries(PRINT_STYLE_ALIASES).map(([old, current]) => [`${PRINT_THEME_PREFIX}${old}`, `${PRINT_THEME_PREFIX}${current}`]));
+/**
+* The current name of a theme: a deprecated `print-<old id>` is mapped to its
+* `print-<new id>` (with a one-time development warning); any other name is
+* returned unchanged.
+*/
+function resolvePrintThemeName(theme) {
+	if (!Object.hasOwn(PRINT_THEME_ALIASES, theme)) return theme;
+	const current = PRINT_THEME_ALIASES[theme];
+	warnDeprecatedPrintId(theme, current, "theme");
+	return current;
+}
+//#endregion
+export { PRINT_STYLE_ALIASES, PRINT_THEME_ALIASES, PRINT_THEME_PREFIX, resolvePrintThemeName, warnDeprecatedPrintId };
+
+//# sourceMappingURL=print-aliases.js.map

package/dist/print-aliases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-aliases.js","names":[],"sources":["../src/print-aliases.ts"],"sourcesContent":["// Deprecated ids of the print book styles and of their UI themes. Kept in a\n// module of its own, with no runtime imports, so that hosts which only need to\n// resolve a stored theme name (ThemeProvider, themeInitScript) can import it\n// from `@datatechsolutions/tympan-tokens/print-aliases` without loading the\n// presets or generating the print themes.\n\nimport type { PrintPresetName } from './print-presets.ts'\n\n/** Prefix of every print theme name: `data-ty-theme=\"print-<style>\"`. */\nexport const PRINT_THEME_PREFIX = 'print-'\n\n/**\n * Deprecated style ids and the current id each one maps to. The styles were\n * renamed to neutral, descriptive ids (no trademarks, institutions or people's\n * names); the old ids keep working through `resolvePrintStyleName`,\n * `resolvePrintStyle`, `LivroPrint estilo` and, as `print-<old id>`, the UI\n * theme lookup (`resolvePrintThemeName`), with a one-time console warning in\n * development builds.\n *\n * Removal: the aliases (and the `'modulor'` emblem) will be dropped in the\n * next major version of @datatechsolutions/tympan-tokens and\n * @datatechsolutions/tympan-print; migrate stored data books to the new ids.\n */\nexport const PRINT_STYLE_ALIASES = {\n  economist: 'semanario',\n  ft: 'papel-salmao',\n  schiphol: 'sinalizacao',\n  'jornal-do-brasil': 'jornal-1959',\n  'atlas-ibge': 'atlas-oficial',\n  deardata: 'cartao-postal',\n  tufte: 'minimo-de-tinta',\n  holmes: 'infografico-ilustrado',\n  bayer: 'diagrama-modernista',\n  dubois: 'graficos-1900',\n  minard: 'fluxo-historico',\n  mccandless: 'blocos-coloridos',\n  corbusier: 'proporcao-modular',\n  aicher: 'pictogramas',\n  vignelli: 'mapa-de-metro',\n  'athos-bulcao': 'azulejo-modernista',\n  crouwel: 'grade-holandesa',\n  'saul-bass': 'papel-recortado',\n} as const satisfies Record<string, PrintPresetName>\n\n/** A deprecated style id (see PRINT_STYLE_ALIASES). */\nexport type PrintStyleAlias = keyof typeof PRINT_STYLE_ALIASES\n\nconst isDev = (() => {\n  try {\n    return (globalThis as { process?: { env?: Record<string, string | undefined> } }).process?.env?.NODE_ENV !== 'production'\n  } catch {\n    return true\n  }\n})()\nconst warned = new Set<string>()\n\n/** Warns once per id (development builds only) that a deprecated id was used. @internal */\nexport function warnDeprecatedPrintId(old: string, current: string, kind = 'print style'): void {\n  if (!isDev || warned.has(old)) return\n  warned.add(old)\n  console.warn(`[@datatechsolutions/tympan] The ${kind} \"${old}\" is deprecated; use \"${current}\". The old id will be removed in the next major version.`)\n}\n\n/**\n * Deprecated print theme names (`print-<old style id>`) and the current theme\n * each maps to, derived from PRINT_STYLE_ALIASES (for example\n * `print-economist` -> `print-semanario`). Same removal schedule: dropped in\n * the next major version.\n */\nexport const PRINT_THEME_ALIASES: Readonly<Record<string, string>> = Object.fromEntries(\n  Object.entries(PRINT_STYLE_ALIASES).map(([old, current]) => [`${PRINT_THEME_PREFIX}${old}`, `${PRINT_THEME_PREFIX}${current}`]),\n)\n\n/**\n * The current name of a theme: a deprecated `print-<old id>` is mapped to its\n * `print-<new id>` (with a one-time development warning); any other name is\n * returned unchanged.\n */\nexport function resolvePrintThemeName(theme: string): string {\n  if (!Object.hasOwn(PRINT_THEME_ALIASES, theme)) return theme\n  const current = PRINT_THEME_ALIASES[theme]!\n  warnDeprecatedPrintId(theme, current, 'theme')\n  return current\n}\n"],"mappings":";;AASA,MAAa,qBAAqB;;;;;;;;;;;;;AAclC,MAAa,sBAAsB;CACjC,WAAW;CACX,IAAI;CACJ,UAAU;CACV,oBAAoB;CACpB,cAAc;CACd,UAAU;CACV,OAAO;CACP,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,QAAQ;CACR,YAAY;CACZ,WAAW;CACX,QAAQ;CACR,UAAU;CACV,gBAAgB;CAChB,SAAS;CACT,aAAa;AACf;AAKA,MAAM,eAAe;CACnB,IAAI;EACF,OAAQ,WAA0E,SAAS,KAAK,aAAa;CAC/G,QAAQ;EACN,OAAO;CACT;AACF,EAAA,CAAG;AACH,MAAM,yBAAS,IAAI,IAAY;;AAG/B,SAAgB,sBAAsB,KAAa,SAAiB,OAAO,eAAqB;CAC9F,IAAI,CAAC,SAAS,OAAO,IAAI,GAAG,GAAG;CAC/B,OAAO,IAAI,GAAG;CACd,QAAQ,KAAK,mCAAmC,KAAK,IAAI,IAAI,wBAAwB,QAAQ,yDAAyD;AACxJ;;;;;;;AAQA,MAAa,sBAAwD,OAAO,YAC1E,OAAO,QAAQ,mBAAmB,CAAC,CAAC,KAAK,CAAC,KAAK,aAAa,CAAC,GAAG,qBAAqB,OAAO,GAAG,qBAAqB,SAAS,CAAC,CAChI;;;;;;AAOA,SAAgB,sBAAsB,OAAuB;CAC3D,IAAI,CAAC,OAAO,OAAO,qBAAqB,KAAK,GAAG,OAAO;CACvD,MAAM,UAAU,oBAAoB;CACpC,sBAAsB,OAAO,SAAS,OAAO;CAC7C,OAAO;AACT"}