@ingredient-icons/core 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,27 +1,34 @@
 import { SIZES } from "./data.js";
-export { STYLE, TAXONOMY_COMMIT, VERSION } from "./data.js";
+export { STYLE, TAXONOMY_COMMIT, TAXONOMY_RELEASE, VERSION } from "./data.js";
 /** Sizes shipped in the package, in pixels, as square WebP files. */
 export type IconSize = (typeof SIZES)[number];
 export declare const sizes: readonly IconSize[];
-/** Every Open Food Facts id that has its own icon. */
+/**
+ * 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)`.
+ */
+export declare const GENERIC_ID = "generic";
+/** Every id that has its own icon: Open Food Facts ids, 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: cherry tomatoes get the tomato. */
+    /** 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.
+ * 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`).
  */
 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.2.0";
+export declare const CDN_URL = "https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.4.0";
 /**
  * URL of an icon. Pass `baseUrl` to serve the package's `icons/` folder yourself
  * instead of the public CDN.
@@ -30,5 +37,5 @@ 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. */
+/** 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,12 +1,19 @@
 import { FILES, NAMES, PARENTS, SIZES, VERSION } from "./data.js";
-export { STYLE, TAXONOMY_COMMIT, VERSION } from "./data.js";
+export { STYLE, TAXONOMY_COMMIT, TAXONOMY_RELEASE, VERSION } from "./data.js";
 export const sizes = SIZES;
-/** Every Open Food Facts id that has its own icon. */
+/**
+ * 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)`.
+ */
+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;
 /**
  * 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.
+ * 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`).
  */
 export function findIcon(id) {
     let level = [id];
@@ -43,7 +50,8 @@ export function iconUrl(id, { size = 128, baseUrl = CDN_URL } = {}) {
     const relative = iconPath(id, size);
     return relative && `${baseUrl.replace(/\/$/, "")}/${relative}`;
 }
-/** Name of an id that has an icon, from the Open Food Facts taxonomy. */
+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 NAMES[id]?.[locale];
+    return id === GENERIC_ID ? GENERIC_NAMES[locale] : NAMES[id]?.[locale];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingredient-icons/core",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Soft 3D icons for cooking ingredients, keyed by the Open Food Facts taxonomy, with ancestor fallback",
   "license": "(MIT AND CC0-1.0 AND ODbL-1.0)",
   "type": "module",