@ingredient-icons/core 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -1,41 +1,28 @@
 import { SIZES } from "./data.js";
-export { STYLE, TAXONOMY_COMMIT, TAXONOMY_RELEASE, VERSION } from "./data.js";
+export { CATALOG_RELEASE, STYLE, VERSION } from "./data.js";
+export type { Catalog, CatalogEntry, CatalogNames } from "./catalog.js";
 /** Sizes shipped in the package, in pixels, as square WebP files. */
 export type IconSize = (typeof SIZES)[number];
 export declare const sizes: readonly IconSize[];
 /**
- * Id of the generic icon: a cluster of fresh ingredients, for an ingredient that cannot be placed
- * at all. Not an Open Food Facts id. Show it when `findIcon` returns undefined:
- * `iconUrl(id) ?? iconUrl(GENERIC_ID)`.
+ * Id of the generic icon: a cluster of fresh ingredients, for an ingredient that has no icon
+ * and no parent with one. Not a catalog id: `iconUrl(id) ?? iconUrl(GENERIC_ID)`.
  */
 export declare const GENERIC_ID = "generic";
-/** Every id that has its own icon: Open Food Facts ids, plus `GENERIC_ID`. */
+/** Every id that has its own icon: catalog ids (every family among them), plus `GENERIC_ID`. */
 export declare const ids: readonly string[];
-export interface Icon {
-    /** The id whose icon this is: the one asked for, or the closest ancestor that has one. */
-    id: string;
-    /** File name without extension: "en_shallot". */
-    file: string;
-    /** False when the icon is an ancestor's: peeled tomatoes get the tomato. */
-    exact: boolean;
-}
 /**
- * The icon of an Open Food Facts ingredient id ("en:shallot"), or of its closest
- * ancestor in the taxonomy when it has none of its own. Undefined when neither has one:
- * the caller picks the fallback, such as the generic icon (`GENERIC_ID`).
+ * Path of an id's own icon inside the package ("icons/webp/128/shallot.webp"), or undefined
+ * when it has none. To fall back on a parent's icon, walk up `parent` in `catalog.json`.
  */
-export declare function findIcon(id: string): Icon | undefined;
-/** Path of an icon inside the package: "icons/webp/128/en_shallot.webp". */
 export declare function iconPath(id: string, size?: IconSize): string | undefined;
 /** Default CDN, pinned to this package's version so URLs never change under you. */
-export declare const CDN_URL = "https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.4.0";
+export declare const CDN_URL = "https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.6.0";
 /**
- * URL of an icon. Pass `baseUrl` to serve the package's `icons/` folder yourself
- * instead of the public CDN.
+ * URL of an id's own icon, or undefined when it has none. Pass `baseUrl` to serve the
+ * package's `icons/` folder yourself instead of the public CDN.
  */
 export declare function iconUrl(id: string, { size, baseUrl }?: {
     size?: IconSize;
     baseUrl?: string;
 }): string | undefined;
-/** Name of an id that has an icon, from the Open Food Facts taxonomy ("Ingredient" for `GENERIC_ID`). */
-export declare function iconName(id: string, locale?: "en" | "fr"): string | undefined;

package/dist/index.js

@@ -1,57 +1,28 @@
-import { FILES, NAMES, PARENTS, SIZES, VERSION } from "./data.js";
-export { STYLE, TAXONOMY_COMMIT, TAXONOMY_RELEASE, VERSION } from "./data.js";
+import { IDS, SIZES, VERSION } from "./data.js";
+export { CATALOG_RELEASE, STYLE, VERSION } from "./data.js";
 export const sizes = SIZES;
 /**
- * Id of the generic icon: a cluster of fresh ingredients, for an ingredient that cannot be placed
- * at all. Not an Open Food Facts id. Show it when `findIcon` returns undefined:
- * `iconUrl(id) ?? iconUrl(GENERIC_ID)`.
+ * Id of the generic icon: a cluster of fresh ingredients, for an ingredient that has no icon
+ * and no parent with one. Not a catalog id: `iconUrl(id) ?? iconUrl(GENERIC_ID)`.
  */
 export const GENERIC_ID = "generic";
-/** Every id that has its own icon: Open Food Facts ids, plus `GENERIC_ID`. */
-export const ids = Object.keys(FILES);
-const MAX_DEPTH = 6;
+/** Every id that has its own icon: catalog ids (every family among them), plus `GENERIC_ID`. */
+export const ids = IDS;
+const withIcon = new Set(IDS);
 /**
- * The icon of an Open Food Facts ingredient id ("en:shallot"), or of its closest
- * ancestor in the taxonomy when it has none of its own. Undefined when neither has one:
- * the caller picks the fallback, such as the generic icon (`GENERIC_ID`).
+ * Path of an id's own icon inside the package ("icons/webp/128/shallot.webp"), or undefined
+ * when it has none. To fall back on a parent's icon, walk up `parent` in `catalog.json`.
  */
-export function findIcon(id) {
-    let level = [id];
-    const seen = new Set(level);
-    for (let depth = 0; depth <= MAX_DEPTH && level.length; depth++) {
-        for (const candidate of level) {
-            const file = FILES[candidate];
-            if (file)
-                return { id: candidate, file, exact: depth === 0 };
-        }
-        const next = [];
-        for (const candidate of level)
-            for (const parent of PARENTS[candidate] ?? [])
-                if (!seen.has(parent)) {
-                    seen.add(parent);
-                    next.push(parent);
-                }
-        level = next;
-    }
-    return undefined;
-}
-/** Path of an icon inside the package: "icons/webp/128/en_shallot.webp". */
 export function iconPath(id, size = 128) {
-    const icon = findIcon(id);
-    return icon && `icons/webp/${size}/${icon.file}.webp`;
+    return withIcon.has(id) ? `icons/webp/${size}/${id}.webp` : undefined;
 }
 /** Default CDN, pinned to this package's version so URLs never change under you. */
 export const CDN_URL = `https://cdn.jsdelivr.net/npm/@ingredient-icons/core@${VERSION}`;
 /**
- * URL of an icon. Pass `baseUrl` to serve the package's `icons/` folder yourself
- * instead of the public CDN.
+ * URL of an id's own icon, or undefined when it has none. Pass `baseUrl` to serve the
+ * package's `icons/` folder yourself instead of the public CDN.
  */
 export function iconUrl(id, { size = 128, baseUrl = CDN_URL } = {}) {
     const relative = iconPath(id, size);
     return relative && `${baseUrl.replace(/\/$/, "")}/${relative}`;
 }
-const GENERIC_NAMES = { en: "Ingredient", fr: "Ingrédient" };
-/** Name of an id that has an icon, from the Open Food Facts taxonomy ("Ingredient" for `GENERIC_ID`). */
-export function iconName(id, locale = "en") {
-    return id === GENERIC_ID ? GENERIC_NAMES[locale] : NAMES[id]?.[locale];
-}