@featherk/icons 0.14.1 → 0.15.1

package/README.md

@@ -70,7 +70,7 @@ variants, data URL usage, and related utilities) see [COMING-SOON.md](docs/COMIN
 
 Font Awesome services are separate from `getCustomIcon()` and the owned icon registry. The package supplies a Vite plugin, Node generator, and CLI to prepare selected icons from the consumer's installed Font Awesome packages; it includes no Free or paid Font Awesome artwork and grants no license rights.
 
-Start with [Choose Font Awesome Icons and Create a Manifest](https://github.com/NantHealth/featherk/blob/integration/packages/icons/docs/fontawesome/CreateFontAwesomeManifest.md) for the UX/Design task of selecting and defining the exact icons your application will use.
+Start with [Choose Font Awesome Icons and Create a Manifest](https://github.com/NantHealth/featherk/blob/integration/packages/icons/docs/fontawesome/CreateFontAwesomeManifest.md) for how UX provides globally unique catalog keys and apps select only the keys they use. The metadata-only Free/Pro catalog is published at `@featherk/icons/fontawesome/catalog`; it contains no Font Awesome artwork.
 
 Dev then follows [Font Awesome setup](https://github.com/NantHealth/featherk/blob/integration/packages/icons/docs/fontawesome/FontAwesome.md) for the default Vite integration. For Dev-owned CLI generation, early type preparation, or non-Vite applications, see [CLI and non-Vite setup](https://github.com/NantHealth/featherk/blob/integration/packages/icons/docs/fontawesome/FontAwesomeCLI.md).
 

package/dist/docs-manifest.d.ts

@@ -0,0 +1,16 @@
+// Generated by scripts/generate-docs-manifest.mjs. Do not edit.
+export type DocName =
+  | "CreateFontAwesomeManifest"
+  | "FontAwesome"
+  | "FontAwesomeCLI"
+  | "LICENSING";
+
+export declare const packageName: "@featherk/icons";
+
+export declare const version: string;
+
+export declare const paths: Record<DocName, string>;
+
+export declare const docs: Record<DocName, string>;
+
+export declare const docUrl: (name: DocName, host?: string) => string;

package/dist/docs-manifest.js

@@ -0,0 +1,21 @@
+// Generated by scripts/generate-docs-manifest.mjs. Do not edit.
+export const packageName = "@featherk/icons";
+
+export const version = "0.15.1";
+
+export const paths = {
+  CreateFontAwesomeManifest: "fontawesome/CreateFontAwesomeManifest.md",
+  FontAwesome: "fontawesome/FontAwesome.md",
+  FontAwesomeCLI: "fontawesome/FontAwesomeCLI.md",
+  LICENSING: "fontawesome/LICENSING.md",
+};
+
+export const docs = {
+  CreateFontAwesomeManifest: "https://cdn.jsdelivr.net/npm/@featherk/icons@0.15.1/docs/fontawesome/CreateFontAwesomeManifest.md",
+  FontAwesome: "https://cdn.jsdelivr.net/npm/@featherk/icons@0.15.1/docs/fontawesome/FontAwesome.md",
+  FontAwesomeCLI: "https://cdn.jsdelivr.net/npm/@featherk/icons@0.15.1/docs/fontawesome/FontAwesomeCLI.md",
+  LICENSING: "https://cdn.jsdelivr.net/npm/@featherk/icons@0.15.1/docs/fontawesome/LICENSING.md",
+};
+
+export const docUrl = (name, host = "https://cdn.jsdelivr.net/npm") =>
+  `${host}/${packageName}@${version}/docs/${paths[name]}`;

package/dist/fontawesome/build.cjs

@@ -1,4 +1,8 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const generate = require("./chunks/generate-Bobf_ghm.cjs");
+const generate = require("./chunks/generate-BBurrhLv.cjs");
+const fontawesome_catalog = require("./catalog.cjs");
 exports.generateFaIcons = generate.generateFaIcons;
+exports.fontAwesomeCatalog = fontawesome_catalog.fontAwesomeCatalog;
+exports.getFontAwesomeInstallCommand = fontawesome_catalog.getFontAwesomeInstallCommand;
+exports.resolveFontAwesomeKeys = fontawesome_catalog.resolveFontAwesomeKeys;

package/dist/fontawesome/build.d.ts

@@ -1,3 +1,5 @@
 export { generateFaIcons } from "./generate";
+export { fontAwesomeCatalog, getFontAwesomeInstallCommand, resolveFontAwesomeKeys, } from "./catalog";
 export type { GenerateFaIconsOptions, GeneratedFaIcons, FontAwesomeProvenance, } from "./generate";
-export type { FontAwesomeSelection, FontAwesomeOptions, FontAwesomeIcon, } from "./types";
+export type { FontAwesomeSelection, FontAwesomeOptions, FontAwesomeIcon, FontAwesomeCatalogEntry, FontAwesomeSourceSelection, FontAwesomeTier, } from "./types";
+export type { FontAwesomeCatalogKey, ResolveFontAwesomeKeysOptions, } from "./catalog";

package/dist/fontawesome/build.mjs

@@ -1,4 +1,8 @@
-import { g } from "./chunks/generate-Bp92GTVi.mjs";
+import { g } from "./chunks/generate-Zq9q2YZD.mjs";
+import { fontAwesomeCatalog, getFontAwesomeInstallCommand, resolveFontAwesomeKeys } from "./catalog.mjs";
 export {
-  g as generateFaIcons
+  fontAwesomeCatalog,
+  g as generateFaIcons,
+  getFontAwesomeInstallCommand,
+  resolveFontAwesomeKeys
 };

package/dist/fontawesome/catalog.cjs

@@ -0,0 +1,224 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const entries = [
+  {
+    key: "rocket",
+    name: "rocket",
+    version: "7.0.0",
+    family: "classic",
+    style: "solid",
+    package: "@fortawesome/free-solid-svg-icons",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faRocket",
+    tier: "free"
+  },
+  {
+    key: "feather",
+    name: "feather",
+    version: "7.0.0",
+    family: "classic",
+    style: "solid",
+    package: "@fortawesome/free-solid-svg-icons",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faFeather",
+    tier: "free"
+  },
+  {
+    key: "heart",
+    name: "heart",
+    version: "7.0.0",
+    family: "classic",
+    style: "solid",
+    package: "@fortawesome/free-solid-svg-icons",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faHeart",
+    tier: "free"
+  },
+  {
+    key: "star",
+    name: "star",
+    version: "7.0.0",
+    family: "classic",
+    style: "solid",
+    package: "@fortawesome/free-solid-svg-icons",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faStar",
+    tier: "free"
+  },
+  {
+    key: "user",
+    name: "user",
+    version: "7.0.0",
+    family: "classic",
+    style: "solid",
+    package: "@fortawesome/free-solid-svg-icons",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faUser",
+    tier: "free"
+  },
+  {
+    key: "rocket-v5",
+    name: "rocket",
+    version: "5.15.4",
+    family: "classic",
+    style: "solid",
+    package: "fa-solid-v5",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faRocket",
+    tier: "free"
+  },
+  {
+    key: "rocket-v6",
+    name: "rocket",
+    version: "6.7.2",
+    family: "classic",
+    style: "solid",
+    package: "fa-solid-v6",
+    registryPackage: "@fortawesome/free-solid-svg-icons",
+    exportName: "faRocket",
+    tier: "free"
+  },
+  {
+    key: "heart-regular",
+    name: "heart",
+    version: "7.0.0",
+    family: "classic",
+    style: "regular",
+    package: "@fortawesome/free-regular-svg-icons",
+    registryPackage: "@fortawesome/free-regular-svg-icons",
+    exportName: "faHeart",
+    tier: "free"
+  },
+  {
+    key: "star-regular",
+    name: "star",
+    version: "7.0.0",
+    family: "classic",
+    style: "regular",
+    package: "@fortawesome/free-regular-svg-icons",
+    registryPackage: "@fortawesome/free-regular-svg-icons",
+    exportName: "faStar",
+    tier: "free"
+  },
+  {
+    key: "user-regular",
+    name: "user",
+    version: "7.0.0",
+    family: "classic",
+    style: "regular",
+    package: "@fortawesome/free-regular-svg-icons",
+    registryPackage: "@fortawesome/free-regular-svg-icons",
+    exportName: "faUser",
+    tier: "free"
+  },
+  {
+    key: "pro-rocket-regular",
+    name: "rocket",
+    version: "7.0.0",
+    family: "classic",
+    style: "regular",
+    package: "@fortawesome/pro-regular-svg-icons",
+    registryPackage: "@fortawesome/pro-regular-svg-icons",
+    exportName: "faRocket",
+    tier: "pro"
+  },
+  {
+    key: "pro-feather-light",
+    name: "feather",
+    version: "7.0.0",
+    family: "classic",
+    style: "light",
+    package: "@fortawesome/pro-light-svg-icons",
+    registryPackage: "@fortawesome/pro-light-svg-icons",
+    exportName: "faFeather",
+    tier: "pro"
+  },
+  {
+    key: "pro-heart-light",
+    name: "heart",
+    version: "7.0.0",
+    family: "classic",
+    style: "light",
+    package: "@fortawesome/pro-light-svg-icons",
+    registryPackage: "@fortawesome/pro-light-svg-icons",
+    exportName: "faHeart",
+    tier: "pro"
+  },
+  {
+    key: "pro-house-light",
+    name: "house",
+    version: "7.0.0",
+    family: "classic",
+    style: "light",
+    package: "@fortawesome/pro-light-svg-icons",
+    registryPackage: "@fortawesome/pro-light-svg-icons",
+    exportName: "faHouse",
+    tier: "pro"
+  }
+];
+function createCatalogIndex(catalog) {
+  const index = /* @__PURE__ */ new Map();
+  for (const entry of catalog) {
+    if (!entry.key.trim()) {
+      throw new Error("Font Awesome catalog keys must not be empty");
+    }
+    if (index.has(entry.key)) {
+      throw new Error(`Duplicate Font Awesome catalog key "${entry.key}"`);
+    }
+    index.set(entry.key, entry);
+  }
+  return index;
+}
+const fontAwesomeCatalog = Object.freeze(
+  entries.map((entry) => Object.freeze(entry))
+);
+const catalogByKey = createCatalogIndex(fontAwesomeCatalog);
+function resolveFontAwesomeKeys(keys, options = {}) {
+  if (!Array.isArray(keys)) {
+    throw new Error("Font Awesome keys must be an array");
+  }
+  const seen = /* @__PURE__ */ new Set();
+  return keys.map((key) => {
+    if (typeof key !== "string" || !key.trim()) {
+      throw new Error("Font Awesome keys must be non-empty strings");
+    }
+    if (seen.has(key)) {
+      throw new Error(`Duplicate Font Awesome key "${key}"`);
+    }
+    seen.add(key);
+    const entry = catalogByKey.get(key);
+    if (!entry) {
+      throw new Error(`Unknown Font Awesome catalog key "${key}"`);
+    }
+    if (entry.tier === "pro" && !options.allowPro) {
+      throw new Error(
+        `Font Awesome key "${key}" is Pro; enable the Pro profile to use it`
+      );
+    }
+    return {
+      key: entry.key,
+      name: entry.name,
+      version: entry.version,
+      family: entry.family,
+      style: entry.style,
+      package: entry.package,
+      exportName: entry.exportName,
+      registryPackage: entry.registryPackage
+    };
+  });
+}
+function getFontAwesomeInstallCommand(keys, options = {}) {
+  resolveFontAwesomeKeys(keys, options);
+  const packages = /* @__PURE__ */ new Set();
+  for (const key of keys) {
+    const entry = catalogByKey.get(key);
+    packages.add(
+      entry.package === entry.registryPackage ? `${entry.registryPackage}@${entry.version}` : `${entry.package}@npm:${entry.registryPackage}@${entry.version}`
+    );
+  }
+  if (packages.size === 0) return void 0;
+  return `npm install --save-dev --save-exact ${[...packages].join(" ")}`;
+}
+exports.fontAwesomeCatalog = fontAwesomeCatalog;
+exports.getFontAwesomeInstallCommand = getFontAwesomeInstallCommand;
+exports.resolveFontAwesomeKeys = resolveFontAwesomeKeys;

package/dist/fontawesome/catalog.d.ts

@@ -0,0 +1,306 @@
+import type { FontAwesomeSourceSelection } from "./types";
+declare const entries: readonly [{
+    readonly key: "rocket";
+    readonly name: "rocket";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+}, {
+    readonly key: "feather";
+    readonly name: "feather";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faFeather";
+    readonly tier: "free";
+}, {
+    readonly key: "heart";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "free";
+}, {
+    readonly key: "star";
+    readonly name: "star";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faStar";
+    readonly tier: "free";
+}, {
+    readonly key: "user";
+    readonly name: "user";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faUser";
+    readonly tier: "free";
+}, {
+    readonly key: "rocket-v5";
+    readonly name: "rocket";
+    readonly version: "5.15.4";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "fa-solid-v5";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+}, {
+    readonly key: "rocket-v6";
+    readonly name: "rocket";
+    readonly version: "6.7.2";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "fa-solid-v6";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+}, {
+    readonly key: "heart-regular";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "free";
+}, {
+    readonly key: "star-regular";
+    readonly name: "star";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faStar";
+    readonly tier: "free";
+}, {
+    readonly key: "user-regular";
+    readonly name: "user";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faUser";
+    readonly tier: "free";
+}, {
+    readonly key: "pro-rocket-regular";
+    readonly name: "rocket";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/pro-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-regular-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "pro";
+}, {
+    readonly key: "pro-feather-light";
+    readonly name: "feather";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faFeather";
+    readonly tier: "pro";
+}, {
+    readonly key: "pro-heart-light";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "pro";
+}, {
+    readonly key: "pro-house-light";
+    readonly name: "house";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faHouse";
+    readonly tier: "pro";
+}];
+/** Complete curated metadata catalog; no icon geometry or artwork is included. */
+export declare const fontAwesomeCatalog: readonly Readonly<{
+    readonly key: "rocket";
+    readonly name: "rocket";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+} | {
+    readonly key: "feather";
+    readonly name: "feather";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faFeather";
+    readonly tier: "free";
+} | {
+    readonly key: "heart";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "free";
+} | {
+    readonly key: "star";
+    readonly name: "star";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faStar";
+    readonly tier: "free";
+} | {
+    readonly key: "user";
+    readonly name: "user";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "@fortawesome/free-solid-svg-icons";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faUser";
+    readonly tier: "free";
+} | {
+    readonly key: "rocket-v5";
+    readonly name: "rocket";
+    readonly version: "5.15.4";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "fa-solid-v5";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+} | {
+    readonly key: "rocket-v6";
+    readonly name: "rocket";
+    readonly version: "6.7.2";
+    readonly family: "classic";
+    readonly style: "solid";
+    readonly package: "fa-solid-v6";
+    readonly registryPackage: "@fortawesome/free-solid-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "free";
+} | {
+    readonly key: "heart-regular";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "free";
+} | {
+    readonly key: "star-regular";
+    readonly name: "star";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faStar";
+    readonly tier: "free";
+} | {
+    readonly key: "user-regular";
+    readonly name: "user";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/free-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/free-regular-svg-icons";
+    readonly exportName: "faUser";
+    readonly tier: "free";
+} | {
+    readonly key: "pro-rocket-regular";
+    readonly name: "rocket";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "regular";
+    readonly package: "@fortawesome/pro-regular-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-regular-svg-icons";
+    readonly exportName: "faRocket";
+    readonly tier: "pro";
+} | {
+    readonly key: "pro-feather-light";
+    readonly name: "feather";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faFeather";
+    readonly tier: "pro";
+} | {
+    readonly key: "pro-heart-light";
+    readonly name: "heart";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faHeart";
+    readonly tier: "pro";
+} | {
+    readonly key: "pro-house-light";
+    readonly name: "house";
+    readonly version: "7.0.0";
+    readonly family: "classic";
+    readonly style: "light";
+    readonly package: "@fortawesome/pro-light-svg-icons";
+    readonly registryPackage: "@fortawesome/pro-light-svg-icons";
+    readonly exportName: "faHouse";
+    readonly tier: "pro";
+}>[];
+/** Union of the UX-assigned keys in {@link fontAwesomeCatalog}. */
+export type FontAwesomeCatalogKey = (typeof entries)[number]["key"];
+/** Profile options used when resolving catalog keys. */
+export interface ResolveFontAwesomeKeysOptions {
+    allowPro?: boolean;
+}
+/**
+ * Resolves selected keys to their exact source package and icon metadata.
+ * The returned records are build-time inputs, not icon artwork.
+ *
+ * @throws If a key is empty, duplicated, unknown, or Pro without opt-in.
+ */
+export declare function resolveFontAwesomeKeys(keys: readonly string[], options?: ResolveFontAwesomeKeysOptions): FontAwesomeSourceSelection[];
+/**
+ * Builds a deduplicated exact npm install command for the selected keys.
+ * Npm aliases are emitted when a local dependency name differs from its
+ * canonical registry package. The command is informational and is not run.
+ *
+ * @returns An install command, or `undefined` when no keys are selected.
+ */
+export declare function getFontAwesomeInstallCommand(keys: readonly string[], options?: ResolveFontAwesomeKeysOptions): string | undefined;
+export {};