@chrtco/sdk 0.10.54 → 0.10.55

package/dist/{symbol-families-De7sN-p5.d.cts → symbol-family-ids-elOgiCo8.d.cts}

@@ -61,33 +61,35 @@ declare function getColorTable(name: ColorTableName): Record<string, string>;
 declare function resolveColor(token: string, table?: ColorTableName): string;
 
 /**
- * The symbol-artwork families, as one shared vocabulary.
+ * The symbol-artwork family ids, and the one name that used to be an id.
  *
- * `applyS101SymbolSet` / `applyChrtSymbolSet` / `applyRasterSymbolSet`
- * switch a whole generated style document. Consumers that build layers
- * class-by-class (the /map viewer's renderer) need the same decision at
- * the level of a single class — that's `iconExpressionForFamily`, so the
- * viewer and the Style API can never disagree about what a family means.
+ * No imports, on purpose: the style generator, the family helpers and the
+ * workers all read these, and none of them should pull another module in to
+ * do it.
+ *
+ * `raster` WAS the id of the paper-chart family until 2026-11 (shown as
+ * "CHRTraster"). It is `int1` now, after the standard it draws: IHO INT 1, the
+ * symbols of paper charts. The old id is stored and sent in too many places
+ * to drop: the Style API's `?symbols=`, offline packs on devices, CHRTweb's
+ * saved and synced settings, `/map?symbols=` links, and every published SDK.
+ * So every input accepts it, forever, and turns it into `int1` once, where it
+ * comes in. It is never listed as a family of its own.
  */
-type SymbolFamily = "s52" | "s101" | "chrt" | "raster";
-/** Every family, in presentation order. Mirrors the Style API's
- *  `?symbols=` values (SYMBOL_SET_PARAMS in the tile worker). */
-declare const SYMBOL_FAMILIES: readonly SymbolFamily[];
-interface SymbolFamilyMeta {
-    /** Short UI label. */
-    label: string;
-    /** One-line description of what the family is. */
-    description: string;
-}
-declare const SYMBOL_FAMILY_META: Record<SymbolFamily, SymbolFamilyMeta>;
-/** Narrow an arbitrary string to a family, or null. Case-insensitive. */
-declare function parseSymbolFamily(raw: string | null | undefined): SymbolFamily | null;
 /**
- * The icon-image expression for one S-57 class under a given family —
- * the per-class equivalent of the `apply*SymbolSet` style rewrites.
- * Classes a family doesn't restyle fall back to the S-52 expression,
- * exactly as they do on a served style.
+ * A symbol-artwork family: what a style draws its symbols with. `uschart1` is
+ * INT-1 with the aids drawn as U.S. Chart No. 1's NOAA column draws them
+ * (diamond buoys, filled daybeacons; uschart1-marks.ts).
  */
-declare function iconExpressionForFamily(objectClass: string, family: SymbolFamily): string | unknown[];
+type SymbolFamily = "s52" | "s101" | "chrt" | "int1" | "uschart1";
+/** The family ids before 2026-11 that are no longer ids, and what each became. */
+declare const LEGACY_SYMBOL_FAMILY_ALIASES: {
+    readonly raster: "int1";
+};
+/** An old family id that is still accepted as input. */
+type LegacySymbolFamily = keyof typeof LEGACY_SYMBOL_FAMILY_ALIASES;
+/** What an input may say: a family, or an old id for one. */
+type SymbolFamilyInput = SymbolFamily | LegacySymbolFamily;
+/** The family an input names: itself, or what an old id became. */
+declare function normalizeSymbolFamily(family: SymbolFamilyInput): SymbolFamily;
 
-export { type ColorTableName as C, EINK_COLOR_TABLES as E, S52_COLORS as S, EINK_MONO_GREYS as a, S52_DAY as b, S52_DUSK as c, S52_EINK_COLOR as d, S52_EINK_MONO as e, S52_EINK_NIGHT as f, S52_NIGHT as g, SYMBOL_FAMILIES as h, SYMBOL_FAMILY_META as i, type SymbolFamily as j, type SymbolFamilyMeta as k, getColorTable as l, iconExpressionForFamily as m, isEinkColorTable as n, isEinkGreyTable as o, parseSymbolFamily as p, resolveColor as r };
+export { type ColorTableName as C, EINK_COLOR_TABLES as E, LEGACY_SYMBOL_FAMILY_ALIASES as L, type SymbolFamilyInput as S, type SymbolFamily as a, EINK_MONO_GREYS as b, type LegacySymbolFamily as c, S52_COLORS as d, S52_DAY as e, S52_DUSK as f, S52_EINK_COLOR as g, S52_EINK_MONO as h, S52_EINK_NIGHT as i, S52_NIGHT as j, getColorTable as k, isEinkColorTable as l, isEinkGreyTable as m, normalizeSymbolFamily as n, resolveColor as r };

package/dist/{symbol-families-De7sN-p5.d.ts → symbol-family-ids-elOgiCo8.d.ts}

@@ -61,33 +61,35 @@ declare function getColorTable(name: ColorTableName): Record<string, string>;
 declare function resolveColor(token: string, table?: ColorTableName): string;
 
 /**
- * The symbol-artwork families, as one shared vocabulary.
+ * The symbol-artwork family ids, and the one name that used to be an id.
  *
- * `applyS101SymbolSet` / `applyChrtSymbolSet` / `applyRasterSymbolSet`
- * switch a whole generated style document. Consumers that build layers
- * class-by-class (the /map viewer's renderer) need the same decision at
- * the level of a single class — that's `iconExpressionForFamily`, so the
- * viewer and the Style API can never disagree about what a family means.
+ * No imports, on purpose: the style generator, the family helpers and the
+ * workers all read these, and none of them should pull another module in to
+ * do it.
+ *
+ * `raster` WAS the id of the paper-chart family until 2026-11 (shown as
+ * "CHRTraster"). It is `int1` now, after the standard it draws: IHO INT 1, the
+ * symbols of paper charts. The old id is stored and sent in too many places
+ * to drop: the Style API's `?symbols=`, offline packs on devices, CHRTweb's
+ * saved and synced settings, `/map?symbols=` links, and every published SDK.
+ * So every input accepts it, forever, and turns it into `int1` once, where it
+ * comes in. It is never listed as a family of its own.
  */
-type SymbolFamily = "s52" | "s101" | "chrt" | "raster";
-/** Every family, in presentation order. Mirrors the Style API's
- *  `?symbols=` values (SYMBOL_SET_PARAMS in the tile worker). */
-declare const SYMBOL_FAMILIES: readonly SymbolFamily[];
-interface SymbolFamilyMeta {
-    /** Short UI label. */
-    label: string;
-    /** One-line description of what the family is. */
-    description: string;
-}
-declare const SYMBOL_FAMILY_META: Record<SymbolFamily, SymbolFamilyMeta>;
-/** Narrow an arbitrary string to a family, or null. Case-insensitive. */
-declare function parseSymbolFamily(raw: string | null | undefined): SymbolFamily | null;
 /**
- * The icon-image expression for one S-57 class under a given family —
- * the per-class equivalent of the `apply*SymbolSet` style rewrites.
- * Classes a family doesn't restyle fall back to the S-52 expression,
- * exactly as they do on a served style.
+ * A symbol-artwork family: what a style draws its symbols with. `uschart1` is
+ * INT-1 with the aids drawn as U.S. Chart No. 1's NOAA column draws them
+ * (diamond buoys, filled daybeacons; uschart1-marks.ts).
  */
-declare function iconExpressionForFamily(objectClass: string, family: SymbolFamily): string | unknown[];
+type SymbolFamily = "s52" | "s101" | "chrt" | "int1" | "uschart1";
+/** The family ids before 2026-11 that are no longer ids, and what each became. */
+declare const LEGACY_SYMBOL_FAMILY_ALIASES: {
+    readonly raster: "int1";
+};
+/** An old family id that is still accepted as input. */
+type LegacySymbolFamily = keyof typeof LEGACY_SYMBOL_FAMILY_ALIASES;
+/** What an input may say: a family, or an old id for one. */
+type SymbolFamilyInput = SymbolFamily | LegacySymbolFamily;
+/** The family an input names: itself, or what an old id became. */
+declare function normalizeSymbolFamily(family: SymbolFamilyInput): SymbolFamily;
 
-export { type ColorTableName as C, EINK_COLOR_TABLES as E, S52_COLORS as S, EINK_MONO_GREYS as a, S52_DAY as b, S52_DUSK as c, S52_EINK_COLOR as d, S52_EINK_MONO as e, S52_EINK_NIGHT as f, S52_NIGHT as g, SYMBOL_FAMILIES as h, SYMBOL_FAMILY_META as i, type SymbolFamily as j, type SymbolFamilyMeta as k, getColorTable as l, iconExpressionForFamily as m, isEinkColorTable as n, isEinkGreyTable as o, parseSymbolFamily as p, resolveColor as r };
+export { type ColorTableName as C, EINK_COLOR_TABLES as E, LEGACY_SYMBOL_FAMILY_ALIASES as L, type SymbolFamilyInput as S, type SymbolFamily as a, EINK_MONO_GREYS as b, type LegacySymbolFamily as c, S52_COLORS as d, S52_DAY as e, S52_DUSK as f, S52_EINK_COLOR as g, S52_EINK_MONO as h, S52_EINK_NIGHT as i, S52_NIGHT as j, getColorTable as k, isEinkColorTable as l, isEinkGreyTable as m, normalizeSymbolFamily as n, resolveColor as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chrtco/sdk",
-  "version": "0.10.54",
+  "version": "0.10.55",
   "description": "Official TypeScript SDK for the CHRT nautical chart API",
   "type": "module",
   "main": "./dist/index.cjs",