foamicons 0.10.1 → 1.0.0

package/README.md

@@ -218,7 +218,7 @@ import { SettingsIcon, FoamSettings } from 'foamicons';
 | `CircleX` | `Close`, `Cancel`, `X`, `Times`, `Clear` |
 | `CircleAlert` | `WarningCircle`, `Error` |
 
-See [`icons/aliases.json`](../../icons/aliases.json) for the complete list.
+See the published metadata for the complete list: `import aliases from 'foamicons/aliases'`
 
 ### Alias Lookup Helpers
 
@@ -237,6 +237,39 @@ getCanonicalName('Settings'); // 'Cog'
 getCanonicalName('Search');   // 'Search' (already canonical)
 ```
 
+## Machine-Readable Metadata
+
+Foamicons ships metadata files for AI tools and editor plugins. No need to parse `dist/index.js`:
+
+```ts
+// Full catalog with all icons, logos, aliases, tags, and variants
+import catalog from 'foamicons/catalog';
+
+// Alias → canonical name mapping
+import aliases from 'foamicons/aliases';
+
+// Canonical name → tags mapping
+import tags from 'foamicons/tags';
+
+// Old name → new name mapping (for migrations)
+import deprecations from 'foamicons/deprecations';
+```
+
+### Typed Name Helpers
+
+```ts
+import {
+  iconNames,        // readonly array of all icon component names
+  logoNames,        // readonly array of all logo component names
+  allNames,         // combined icons + logos
+  baseIconNames,    // base names without variant suffixes
+  baseLogoNames,    // base logo names without variant suffixes
+} from 'foamicons';
+
+// TypeScript types for validation
+import type { IconName, LogoName, BaseIconName, BaseLogoName } from 'foamicons';
+```
+
 ## Props
 
 | Prop                  | Type             | Default          | Description                                        |
@@ -311,6 +344,19 @@ npm run build
 npm test
 ```
 
+## For AI Assistants
+
+If you are an AI helping a user build a UI with foamicons:
+
+1. **Read the catalog first** — `import catalog from 'foamicons/catalog'` gives you every icon, logo, variant, alias, and tag without parsing JS.
+2. **Use canonical PascalCase names** — e.g. `Bell`, not `bell` or `bell-icon`.
+3. **Variants**: base (no suffix), `Duotone`, `Fill`. Logos: base (color), `Dark`, `Fill`.
+4. **Aliases exist but prefer canonical names** in generated code — `Cog` not `Settings`.
+5. **All icons import from `'foamicons'`** — there is one entry point.
+6. **Tailwind/shadcn pattern**: `<Bell className="h-4 w-4 text-muted-foreground" />`.
+7. **Check `foamicons/aliases`** to resolve user intent (e.g. user says "settings icon" → `Cog`).
+8. **See `llms.txt`** in the package root for a compact reference.
+
 ## License
 
 MIT

package/dist/aliases.json

@@ -0,0 +1,482 @@
+{
+  "SoundWave": "AudioLines",
+  "AudioEqualizer": "AudioLines",
+  "Warning": "Alert",
+  "Caution": "Alert",
+  "Attention": "Alert",
+  "Box": "Archive",
+  "Storage": "Archive",
+  "Direction": "ArchiveArrowUp",
+  "Ascending": "ArchiveArrowUp",
+  "Down": "ArrowDown",
+  "South": "ArrowDown",
+  "Descending": "ArrowDown01",
+  "SortNumeric": "ArrowDown01",
+  "InstagramDown": "ArrowDownIG",
+  "IgDown": "ArrowDownIG",
+  "SortAsc": "ArrowDownNarrowWide",
+  "SortAscending": "ArrowDownNarrowWide",
+  "Snapchat": "ArrowDownSC",
+  "Tiktok": "ArrowDownTT",
+  "Sort": "ArrowDownUp",
+  "Reorder": "ArrowDownUp",
+  "Swap": "ArrowDownUp",
+  "SortDescAlt": "ArrowDownWideNarrow",
+  "Youtube": "ArrowDownYT",
+  "Left": "ArrowLeft",
+  "Back": "ArrowLeft",
+  "West": "ArrowLeft",
+  "Previous": "ArrowLeft",
+  "Right": "ArrowRight",
+  "East": "ArrowRight",
+  "Next": "ArrowRight",
+  "Indent": "ArrowRightToLine",
+  "Fold": "ArrowRightToLine",
+  "Up": "ArrowUp",
+  "North": "ArrowUp",
+  "SortAlphaAsc": "ArrowUpAZ",
+  "SortAZ": "ArrowUpAZ",
+  "InstagramUp": "ArrowUpIG",
+  "IgUp": "ArrowUpIG",
+  "SortAscAlt": "ArrowUpNarrowWide",
+  "SortDesc": "ArrowUpWideNarrow",
+  "SortDescending": "ArrowUpWideNarrow",
+  "SortAlphaDesc": "ArrowUpZA",
+  "SortZA": "ArrowUpZA",
+  "Block": "Ban",
+  "Forbidden": "Ban",
+  "Prohibited": "Ban",
+  "NotAllowed": "Ban",
+  "Notification": "Bell",
+  "Alarm": "Bell",
+  "Strong": "Bold",
+  "TextBold": "Bold",
+  "Flag": "Bookmark",
+  "Saved": "Bookmark",
+  "Date": "Calendar",
+  "Schedule": "Calendar",
+  "Event": "Calendar",
+  "Analytics": "ChartColumnSquare",
+  "Stats": "ChartColumnSquare",
+  "Graph": "ChartColumnSquare",
+  "BarChart": "ChartColumnSquare",
+  "CheckSquare": "Checkbox",
+  "Task": "Checkbox",
+  "Check": "Checkmark",
+  "Done": "Checkmark",
+  "Complete": "Checkmark",
+  "Tick": "Checkmark",
+  "Success": "Checkmark",
+  "CaretDown": "ChevronDown",
+  "Collapse": "ChevronDown",
+  "Dropdown": "ChevronDown",
+  "CaretLeft": "ChevronLeft",
+  "CaretRight": "ChevronRight",
+  "CaretUp": "ChevronUp",
+  "Expand": "ChevronUp",
+  "Accordion": "ChevronUpDown",
+  "WarningCircle": "CircleAlert",
+  "CautionCircle": "CircleAlert",
+  "AttentionCircle": "CircleAlert",
+  "Error": "CircleAlert",
+  "CircleCheckbox": "CircleCheck",
+  "CheckCircle": "CircleCheck",
+  "Money": "CircleDollarSign",
+  "Price": "CircleDollarSign",
+  "Payment": "CircleDollarSign",
+  "Dollar": "CircleDollarSign",
+  "Help": "CircleQuestionMark",
+  "Question": "CircleQuestionMark",
+  "Faq": "CircleQuestionMark",
+  "Support": "CircleQuestionMark",
+  "CloseCircle": "CircleX",
+  "CancelCircle": "CircleX",
+  "Clear": "CircleX",
+  "Cc": "ClosedCaption",
+  "Subtitles": "ClosedCaption",
+  "Captions": "ClosedCaption",
+  "Checklist": "ClipboardList",
+  "Tasks": "ClipboardList",
+  "Todo": "ClipboardList",
+  "Roster": "ClipboardList",
+  "Time": "Clock",
+  "Watch": "Clock",
+  "Settings": "Cog",
+  "Gear": "Cog",
+  "Preferences": "Cog",
+  "Config": "Cog",
+  "Configuration": "Cog",
+  "Options": "Cog",
+  "Cogwheel": "Cog",
+  "ColumnLayout": "Columns3",
+  "ThreeColumns": "Columns3",
+  "Cmd": "Command",
+  "Keyboard": "Command",
+  "Shortcut": "Command",
+  "AddContent": "ContentPlus",
+  "NewPost": "ContentPlus",
+  "CreateContent": "ContentPlus",
+  "Duplicate": "Copy",
+  "Clone": "Copy",
+  "Export": "Download",
+  "Get": "Download",
+  "HalfMoon": "Eclipse",
+  "Contrast": "Eclipse",
+  "OpenNew": "ExternalLink",
+  "External": "ExternalLink",
+  "Document": "File",
+  "Page": "File",
+  "DownloadFile": "FileArrowDown",
+  "FileBack": "FileArrowLeft",
+  "FilePrevious": "FileArrowLeft",
+  "FileTransfer": "FileArrowLeftRight",
+  "FileExchange": "FileArrowLeftRight",
+  "FileSync": "FileArrowLeftRight",
+  "FileForward": "FileArrowRight",
+  "FileNext": "FileArrowRight",
+  "UploadFile": "FileArrowUp",
+  "FileDone": "FileCheck",
+  "FileComplete": "FileCheck",
+  "FileVerified": "FileCheck",
+  "FileSettings": "FileCog",
+  "FileConfig": "FileCog",
+  "NewFile": "FilePlus",
+  "AddFile": "FilePlus",
+  "CreateFile": "FilePlus",
+  "FileAccount": "FileUser",
+  "FileProfile": "FileUser",
+  "UserDocument": "FileUser",
+  "FileDelete": "FileX",
+  "FileRemove": "FileX",
+  "FileCancel": "FileX",
+  "View": "Eye",
+  "Show": "Eye",
+  "Visible": "Eye",
+  "Visibility": "Eye",
+  "Hide": "EyeOff",
+  "Hidden": "EyeOff",
+  "Invisible": "EyeOff",
+  "Fire": "Flame",
+  "Hot": "Flame",
+  "Trending": "Flame",
+  "Directory": "Folder",
+  "FolderAnalytics": "FolderChartColumn",
+  "FolderStats": "FolderChartColumn",
+  "FolderDone": "FolderCheck",
+  "FolderComplete": "FolderCheck",
+  "FolderSettings": "FolderCog",
+  "FolderConfig": "FolderCog",
+  "FolderAdd": "FolderPlus",
+  "NewFolder": "FolderPlus",
+  "FolderDelete": "FolderX",
+  "FolderRemove": "FolderX",
+  "Sad": "Frown",
+  "Unhappy": "Frown",
+  "Negative": "Frown",
+  "FullScreen": "Fullscreen",
+  "MaximizeScreen": "Fullscreen",
+  "World": "Globe",
+  "Web": "Globe",
+  "Internet": "Globe",
+  "Language": "Globe",
+  "Carousel": "GalleryHorizontal",
+  "Slider": "GalleryHorizontal",
+  "CarouselEnd": "GalleryHorizontalEnd",
+  "SliderEnd": "GalleryHorizontalEnd",
+  "GalleryPreview": "GalleryThumbnails",
+  "ThumbnailGrid": "GalleryThumbnails",
+  "GalleryList": "GalleryVertical",
+  "VerticalGallery": "GalleryVertical",
+  "GalleryListEnd": "GalleryVerticalEnd",
+  "VerticalGalleryEnd": "GalleryVerticalEnd",
+  "Love": "Heart",
+  "Emotion": "Heart",
+  "Likes": "Heart",
+  "Recent": "History",
+  "Past": "History",
+  "Undo": "History",
+  "Wifi": "Hotspot",
+  "Signal": "Hotspot",
+  "Wireless": "Hotspot",
+  "Home": "House",
+  "Photo": "Image",
+  "Picture": "Image",
+  "Media": "Image",
+  "Photos": "Images",
+  "Pictures": "Images",
+  "Gallery": "Images",
+  "Mailbox": "Inbox",
+  "Tray": "Inbox",
+  "Information": "Info",
+  "About": "Info",
+  "Details": "Info",
+  "Emphasis": "Italic",
+  "TextItalic": "Italic",
+  "Url": "Link",
+  "Chain": "Link",
+  "Connect": "Link",
+  "DashboardLayout": "LayoutDashboard",
+  "Widgets": "LayoutDashboard",
+  "Grid2x2": "LayoutGrid",
+  "Grid": "LayoutGrid",
+  "Tiles": "LayoutGrid",
+  "ListLayout": "LayoutList",
+  "ListView": "LayoutList",
+  "PanelBottom": "LayoutPanelBottom",
+  "BottomPanel": "LayoutPanelBottom",
+  "Grid1x2": "LayoutPanelLeft",
+  "PanelLeftLayout": "LayoutPanelLeft",
+  "PanelRightLayout": "LayoutPanelRight",
+  "RightPanel": "LayoutPanelRight",
+  "PanelTop": "LayoutPanelTop",
+  "TopPanel": "LayoutPanelTop",
+  "Rows2": "LayoutRows",
+  "HorizontalSplit": "LayoutRows",
+  "Rows": "LayoutRows",
+  "PageTemplate": "LayoutTemplate",
+  "Wireframe": "LayoutTemplate",
+  "Items": "List",
+  "Bullets": "List",
+  "Filter": "ListFilter",
+  "Funnel": "ListFilter",
+  "NumberedList": "ListOrdered",
+  "Ol": "ListOrdered",
+  "Loading": "LoaderCircle",
+  "Spinner": "LoaderCircle",
+  "Progress": "LoaderCircle",
+  "Secure": "Lock",
+  "Locked": "Lock",
+  "Private": "Lock",
+  "Protected": "Lock",
+  "Logout": "LogOut",
+  "SignOut": "LogOut",
+  "Exit": "LogOut",
+  "Signout": "LogOut",
+  "Email": "Mail",
+  "Envelope": "Mail",
+  "Message": "Mail",
+  "Location": "MapPin",
+  "Marker": "MapPin",
+  "Place": "MapPin",
+  "Geo": "MapPin",
+  "ExpandWindow": "Maximize",
+  "Enlarge": "Maximize",
+  "MediaPacks": "ContentUser",
+  "PressKit": "ContentUser",
+  "BrandAssets": "ContentUser",
+  "Mediapacks": "ContentUser",
+  "Announce": "Megaphone",
+  "Broadcast": "Megaphone",
+  "Marketing": "Megaphone",
+  "Promote": "Megaphone",
+  "Hamburger": "Menu",
+  "Navigation": "Menu",
+  "Bars": "Menu",
+  "Comment": "MessageSquare",
+  "ChatSingle": "MessageSquare",
+  "Chat": "MessagesSquare",
+  "Conversation": "MessagesSquare",
+  "Comments": "MessagesSquare",
+  "Chats": "MessagesSquare",
+  "Subtract": "Minus",
+  "Reduce": "Minus",
+  "Decrease": "Minus",
+  "Dark": "Moon",
+  "Night": "Moon",
+  "DarkMode": "Moon",
+  "Click": "MousePointerClick",
+  "Cursor": "MousePointerClick",
+  "Drag": "Move",
+  "Reposition": "Move",
+  "SidebarLeft": "PanelLeft",
+  "DrawerLeft": "PanelLeft",
+  "SidebarCollapse": "PanelLeftChevronLeft",
+  "PanelClose": "PanelLeftChevronLeft",
+  "SidebarExpand": "PanelLeftChevronRight",
+  "PanelOpen": "PanelLeftChevronRight",
+  "SidebarRight": "PanelRight",
+  "DrawerRight": "PanelRight",
+  "ColorPalette": "Palette",
+  "PaintPalette": "Palette",
+  "Swatch": "Palette",
+  "Hold": "Pause",
+  "Suspend": "Pause",
+  "Edit": "Pencil",
+  "Write": "Pencil",
+  "Modify": "Pencil",
+  "Thumbtack": "Pin",
+  "Tack": "Pin",
+  "Stick": "Pin",
+  "Start": "Play",
+  "PlayButton": "Play",
+  "Add": "Plus",
+  "New": "Plus",
+  "Create": "Plus",
+  "QuoteLeft": "QuotationMarkLeft",
+  "BlockquoteStart": "QuotationMarkLeft",
+  "OpenQuote": "QuotationMarkLeft",
+  "QuoteRight": "QuotationMarkRight",
+  "BlockquoteEnd": "QuotationMarkRight",
+  "CloseQuote": "QuotationMarkRight",
+  "Audience": "Reach",
+  "Impressions": "Reach",
+  "Views": "Reach",
+  "Film": "Reel",
+  "Short": "Reel",
+  "ShortVideo": "Reel",
+  "Refresh": "RefreshCw",
+  "Reload": "RefreshCw",
+  "Sync": "RefreshCw",
+  "ClearFormat": "RemoveFormatting",
+  "PlainText": "RemoveFormatting",
+  "Contacts": "Rolodex",
+  "AddressBook": "Rolodex",
+  "CardIndex": "Rolodex",
+  "Alphabet": "Rolodex",
+  "Respond": "Reply",
+  "Answer": "Reply",
+  "Rotate": "RotateCw",
+  "Turn": "RotateCw",
+  "Redo": "RotateCw",
+  "Launch": "Rocket",
+  "Startup": "Rocket",
+  "Floppy": "Save",
+  "Disk": "Save",
+  "Preserve": "Save",
+  "Find": "Search",
+  "Lookup": "Search",
+  "MagnifyingGlass": "Search",
+  "Query": "Search",
+  "Explore": "Search",
+  "FindUser": "SearchUser",
+  "UserSearch": "SearchUser",
+  "LookupPerson": "SearchUser",
+  "SearchPerson": "SearchUser",
+  "Forward": "Share",
+  "ShareLink": "Share",
+  "Controls": "SlidersHorizontal",
+  "Adjust": "SlidersHorizontal",
+  "Filters": "SlidersHorizontal",
+  "Equalizer": "SlidersHorizontal",
+  "Happy": "Smile",
+  "Positive": "Smile",
+  "Smiley": "Smile",
+  "Magic": "Sparkles",
+  "Ai": "Sparkles",
+  "Shine": "Sparkles",
+  "Generate": "Sparkles",
+  "Stop": "Square",
+  "Compose": "SquarePen",
+  "WriteNew": "SquarePen",
+  "Draft": "SquarePen",
+  "Editor": "SquarePen",
+  "Favorite": "Star",
+  "Favourite": "Star",
+  "Rating": "Star",
+  "Light": "Sun",
+  "Day": "Sun",
+  "Bright": "Sun",
+  "Label": "Tag",
+  "Badge": "Tag",
+  "Labels": "Tags",
+  "Categories": "Tags",
+  "Bullseye": "Target",
+  "Goal": "Target",
+  "Aim": "Target",
+  "Center": "TextAlignCenter",
+  "AlignRight": "TextAlignEnd",
+  "Justify": "TextAlignJustify",
+  "AlignLeft": "TextAlignStart",
+  "Dislike": "ThumbsDown",
+  "Disapprove": "ThumbsDown",
+  "No": "ThumbsDown",
+  "Like": "ThumbsUp",
+  "Approve": "ThumbsUp",
+  "Yes": "ThumbsUp",
+  "Delete": "Trash",
+  "Remove": "Trash",
+  "Bin": "Trash",
+  "Garbage": "Trash",
+  "Decline": "TrendingDown",
+  "Falling": "TrendingDown",
+  "Downtrend": "TrendingDown",
+  "Growth": "TrendingUp",
+  "Increase": "TrendingUp",
+  "Rising": "TrendingUp",
+  "SortToggle": "TriangleDownUp",
+  "OrderToggle": "TriangleDownUp",
+  "Toolbox": "ToolCase",
+  "Toolkit": "ToolCase",
+  "Disconnect": "Unlink",
+  "Break": "Unlink",
+  "Unsecure": "Unlock",
+  "Unlocked": "Unlock",
+  "Public": "Unlock",
+  "Import": "Upload",
+  "Send": "Upload",
+  "Person": "User",
+  "Profile": "User",
+  "Account": "User",
+  "People": "Users",
+  "Group": "Users",
+  "Team": "Users",
+  "Persons": "Users",
+  "Sound": "Volume2",
+  "Audio": "Volume2",
+  "Speaker": "Volume2",
+  "Volume": "Volume2",
+  "Mute": "VolumeOff",
+  "Silent": "VolumeOff",
+  "NoSound": "VolumeOff",
+  "SpeakerOff": "VolumeOff",
+  "Verified": "BadgeCheckbox",
+  "Certified": "BadgeCheckbox",
+  "Approved": "BadgeCheckbox",
+  "Mind": "Brain",
+  "Intelligence": "Brain",
+  "Thinking": "Brain",
+  "AreaChart": "ChartArea",
+  "GraphArea": "ChartArea",
+  "StackedBar": "ChartBarStacked",
+  "BarChartStacked": "ChartBarStacked",
+  "ColumnChart": "ChartColumn",
+  "VerticalBarChart": "ChartColumn",
+  "NetworkGraph": "ChartNetwork",
+  "NodeGraph": "ChartNetwork",
+  "Connections": "ChartNetwork",
+  "MixedChart": "ChartNoAxesCombined",
+  "ComboChart": "ChartNoAxesCombined",
+  "PieChart": "ChartPie",
+  "DonutChart": "ChartPie",
+  "RotateLeft": "RotateCcw",
+  "CounterClockwise": "RotateCcw",
+  "Security": "Shield",
+  "Protect": "Shield",
+  "Defense": "Shield",
+  "ShieldVerified": "ShieldCheck",
+  "ShieldSecure": "ShieldCheck",
+  "Unprotected": "ShieldOff",
+  "Insecure": "ShieldOff",
+  "Vulnerable": "ShieldOff",
+  "AddSecurity": "ShieldPlus",
+  "NewShield": "ShieldPlus",
+  "UserSecurity": "ShieldUser",
+  "Privacy": "ShieldUser",
+  "ShieldRemove": "ShieldX",
+  "ShieldCancel": "ShieldX",
+  "Unshielded": "ShieldX",
+  "Camera": "Video",
+  "Record": "Video",
+  "VideoCamera": "Video",
+  "Lightning": "Zap",
+  "Bolt": "Zap",
+  "Flash": "Zap",
+  "Power": "Zap",
+  "LightningOff": "ZapOff",
+  "NoFlash": "ZapOff",
+  "PowerOff": "ZapOff",
+  "Close": "X",
+  "Cancel": "X",
+  "Times": "X",
+  "Dismiss": "X"
+}