@ghxstship/xos-icons 0.0.0-stage → 4.16.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GHXSTSHIP Industries LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @ghxstship/xos-icons
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+XOS glyph map and icon registry: the Lucide icon for every department, phase and record kind, the record state glyph shapes, and the closed set of icons XOS draws by name.
+
+This is `@xos/icons` from the Atlas repository at release v4.16.0, published under the `@ghxstship` scope.
+The archive holds the package's TypeScript source as the release tag does.
+
+## Install
+
+The source imports its sibling packages as `@xos/*`, so install it under its workspace name with an npm alias, at an exact version:
+
+```json
+{
+  "dependencies": {
+    "@xos/icons": "npm:@ghxstship/xos-icons@4.16.0"
+  }
+}
+```
+
+## Build
+
+The package ships TypeScript, so the consuming build transpiles it.
+
+- In Next.js, list both names of every installed package in `transpilePackages`, for example `"@xos/icons"` and `"@ghxstship/xos-icons"`. pnpm resolves an alias to the published name, so the alias alone is not enough.
+- The source imports its own files with `.ts` and `.tsx` extensions, so the consumer's `tsconfig.json` sets `allowImportingTsExtensions` (with `noEmit` and bundler module resolution).
+
+## License
+
+MIT. See `LICENSE` and `THIRD_PARTY_NOTICES`.

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,50 @@
+Third-party notices for @xos/icons
+
+The icon sprite, the glyph registry and the icon components in this package draw icons from lucide-react 1.53.0.
+Its license follows in full.
+
+----------------------------------------------------------------------
+
+ISC License
+
+Copyright (c) 2026 Lucide Icons and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
+The following Lucide icons are derived from the Feather project:
+
+airplay, alert-circle, alert-octagon, alert-triangle, aperture, arrow-down-circle, arrow-down-left, arrow-down-right, arrow-down, arrow-left-circle, arrow-left, arrow-right-circle, arrow-right, arrow-up-circle, arrow-up-left, arrow-up-right, arrow-up, at-sign, calendar, cast, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down, chevrons-left, chevrons-right, chevrons-up, circle, clipboard, clock, code, columns, command, compass, corner-down-left, corner-down-right, corner-left-down, corner-left-up, corner-right-down, corner-right-up, corner-up-left, corner-up-right, crosshair, database, divide-circle, divide-square, dollar-sign, download, external-link, feather, frown, hash, headphones, help-circle, info, italic, key, layout, life-buoy, link-2, link, loader, lock, log-in, log-out, maximize, meh, minimize, minimize-2, minus-circle, minus-square, minus, monitor, moon, more-horizontal, more-vertical, move, music, navigation-2, navigation, octagon, pause-circle, percent, plus-circle, plus-square, plus, power, radio, rss, search, server, share, shopping-bag, sidebar, smartphone, smile, square, table-2, tablet, target, terminal, trash-2, trash, triangle, tv, type, upload, x-circle, x-octagon, x-square, x, zoom-in, zoom-out
+
+The MIT License (MIT) (for the icons listed above)
+
+Copyright (c) 2013-present Cole Bemis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,30 @@
 {
   "name": "@ghxstship/xos-icons",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.16.0",
+  "description": "XOS glyph map and icon registry: the Lucide icon for every department, phase and record kind, the record state glyph shapes, and the closed set of icons XOS draws by name.",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./glyphs": "./src/glyphs.ts",
+    "./names": "./src/names.ts",
+    "./sprite.svg": {
+      "types": "./src/sprite.d.ts",
+      "default": "./src/sprite.generated.svg"
+    },
+    "./map.json": "./src/map.json"
+  },
+  "dependencies": {
+    "lucide-react": "1.53.0"
+  },
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ghxstship/atlas.git",
+    "directory": "packages/icons"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  }
+}

package/registry/a09.txt

@@ -0,0 +1,5 @@
+# Icons the Places and Safety pages (A09) draw by name that no other registry lists: tree nodes,
+# empty states and the Safety landing tiles. One lucide-react name per line.
+ClipboardCheck
+FileBadge
+Square

package/registry/a128.txt

@@ -0,0 +1,2 @@
+# A128: the role lens under the org switcher (apps/atlas/components/shell/role-lens-switch.tsx).
+UserRoundSearch

package/registry/a15.txt

@@ -0,0 +1,14 @@
+# Icons the Finance and Reports pages (A15) draw by name that no other registry lists: toolbar
+# actions and empty states. One lucide-react name per line.
+ArrowRightLeft
+Banknote
+ClipboardPaste
+FilePlus2
+FileSpreadsheet
+Handshake
+Package
+BarChart3
+Gauge
+Grid3x3
+ShoppingCart
+FileCheck

package/registry/a35.txt

@@ -0,0 +1,23 @@
+# Icons Atlas pages draw by name that were missing from the registry, so they rendered as blank
+# boxes (A35, RRR-79): found by the accessibility sweep (Folder, ListPlus, ListVideo, Table2) and by a
+# scan of every icon="..." prop in Atlas, Gateway and @xos/ui. One lucide-react name per line.
+Award
+CheckCircle2
+CloudLightning
+Copy
+FileOutput
+Filter
+Folder
+FolderOpen
+LayoutTemplate
+Link
+ListPlus
+ListVideo
+PackageSearch
+Palmtree
+Scale
+ScrollText
+ShieldAlert
+Siren
+Table2
+UserMinus

package/registry/a36.txt

@@ -0,0 +1,2 @@
+# Icons A36 pages draw by name (custom object empty state). One lucide-react name per line.
+Box

package/registry/a61.txt

@@ -0,0 +1,4 @@
+# A61 (RRR-106): the curated feed reaction glyphs (Section 11.10 item 8).
+Heart
+Laugh
+PartyPopper

package/registry/assets.txt

@@ -0,0 +1,11 @@
+# Icons the Assets pages (A12) draw by name through @xos/ui. One lucide-react name per line.
+Archive
+ArrowRightLeft
+ListChecks
+Package
+Pencil
+Plus
+SearchX
+TriangleAlert
+Wrench
+X

package/registry/atlas.txt

@@ -0,0 +1,38 @@
+# Icons the Atlas shell draws by name: sidebar items, chrome actions and shell states (A06).
+Activity
+BookOpen
+Boxes
+Briefcase
+CalendarDays
+ChartColumn
+Circle
+CircleCheck
+CircleUserRound
+Clapperboard
+FileText
+Folder
+FolderKanban
+GripVertical
+HardHat
+House
+IdCard
+Inbox
+Landmark
+Library
+List
+ListChecks
+LogOut
+MapPin
+Menu
+PackageCheck
+Search
+SearchX
+Settings
+ShieldCheck
+ShoppingCart
+Star
+Store
+Truck
+UserRound
+Users
+UtensilsCrossed

package/registry/b3.txt

@@ -0,0 +1,3 @@
+# Icons B3 draws by name (RRR-227, ADR 0142): the segment library and the showcaller portal.
+Layers
+Timer

package/registry/gateway.txt

@@ -0,0 +1,21 @@
+# Icons the Gateway app draws by name that no other registry lists: destinations, engagement
+# tabs, empty states and actions (A27). One lucide-react name per line.
+ArrowLeftRight
+BedDouble
+BellPlus
+BookmarkCheck
+BriefcaseBusiness
+CircleUser
+FileBarChart
+FileCheck
+FileDiff
+Flag
+FolderLock
+Gavel
+Gift
+ListMusic
+ListOrdered
+Mail
+MailCheck
+MessagesSquare
+Receipt

package/registry/logistics-hospitality.txt

@@ -0,0 +1,9 @@
+# Icons the Atlas Logistics and Hospitality pages draw by name (A11): empty states and the drawer
+# close control they open. One lucide-react name per line.
+ClipboardList
+ConciergeBell
+FolderPlus
+Hotel
+Plane
+Warehouse
+X

package/registry/marketing.txt

@@ -0,0 +1,7 @@
+# Icons the Marketing layer of packages/ui draws by name (design handoff section 10): the comparison
+# cell marks and the surface icons of its previews. One lucide-react name per line.
+CircleDashed
+CircleDot
+CircleMinus
+DoorOpen
+LayoutDashboard

package/registry/ui.txt

@@ -0,0 +1,98 @@
+# Icons packages/ui draws by name: component chrome, feedback tones, pickers and the Icon aliases
+# (more, alert, check-circle, pin, home, undo). Owner: A05. One lucide-react name per line.
+# Canon glyphs (departments, phases, record kinds) come from src/map.json and are not repeated here.
+AlarmClock
+ArrowDown
+ArrowLeft
+ArrowRight
+ArrowUp
+ArrowUpRight
+AudioLines
+BadgeCheck
+Bell
+Bold
+Bookmark
+Building2
+Calendar
+CalendarClock
+CalendarPlus
+CalendarRange
+ChartColumn
+Check
+ChevronDown
+ChevronLeft
+ChevronRight
+ChevronsUpDown
+Circle
+CircleAlert
+CircleCheck
+CircleHelp
+CircleX
+Clock
+Compass
+Download
+Ellipsis
+ExternalLink
+Eye
+File
+FileText
+FolderKanban
+Globe
+Hash
+House
+Image
+Inbox
+Info
+Italic
+Landmark
+LayoutGrid
+LifeBuoy
+Link2
+List
+ListFilter
+Lock
+Map
+MapPin
+Maximize2
+Megaphone
+Menu
+MessageSquare
+Minus
+Navigation
+OctagonAlert
+Paperclip
+Pencil
+Play
+Plus
+Radio
+RefreshCw
+ScanLine
+Search
+SearchX
+Send
+Shapes
+SlidersHorizontal
+Sparkles
+Star
+Sun
+SunMedium
+Table
+ThumbsUp
+Trash2
+TriangleAlert
+Undo2
+Upload
+User
+UserPlus
+Wallet
+WifiOff
+ZoomIn
+ZoomOut
+Camera
+Coffee
+Flashlight
+Nfc
+PenLine
+Phone
+Smartphone
+X

package/registry/views-help.txt

@@ -0,0 +1,32 @@
+# Icons A31 (Views, Help and Support) draws by name: the saved views menu, the view registry's view
+# types (packages/schemas/views.yaml), the help panel, tours, tips and support. One lucide-react name
+# per line.
+Bookmark
+BookmarkPlus
+CalendarRange
+ChartColumn
+ChartGantt
+Columns3
+Grid3x3
+Inbox
+LayoutGrid
+List
+ListTree
+Map
+MapPinned
+Network
+PanelLeft
+Pin
+PinOff
+RefreshCw
+Rss
+Share2
+Sheet
+Table
+Trash2
+Users
+ArrowLeft
+BookOpen
+CircleHelp
+LifeBuoy
+Play

package/scripts/generate-registry.mjs

@@ -0,0 +1,138 @@
+/**
+ * Writes src/names.generated.ts, src/registry.generated.ts and src/sprite.generated.svg: the closed set of lucide-react icons XOS draws by name, imported
+ * one by one so bundlers keep only these icons (RRR-70). Sources are every registry/<owner>.txt
+ * (one PascalCase lucide-react name per line, `#` starts a comment) plus every glyph in src/map.json.
+ * Each owner keeps its own list, so parallel branches never conflict in a shared file (ADR 0021);
+ * on a conflict in the generated file, rerun this script.
+ *
+ * Usage: node scripts/generate-registry.mjs [--check]
+ * With --check, writes nothing and exits 1 when the generated file is out of date or a name does
+ * not exist in the pinned lucide-react.
+ */
+import { readFileSync, readdirSync, writeFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+import * as prettier from "prettier";
+
+const root = join(dirname(fileURLToPath(import.meta.url)), "..");
+const lucide = createRequire(import.meta.url)("lucide-react");
+
+const owners = new Map();
+function add(name, owner) {
+  if (!owners.has(name)) owners.set(name, new Set());
+  owners.get(name).add(owner);
+}
+
+const map = JSON.parse(readFileSync(join(root, "src/map.json"), "utf8"));
+for (const table of [map.departments, map.phases, map.recordKinds]) {
+  for (const name of Object.values(table)) add(name, "map.json");
+}
+
+const registryDir = join(root, "registry");
+for (const file of readdirSync(registryDir)
+  .filter((f) => f.endsWith(".txt"))
+  .sort()) {
+  const lines = readFileSync(join(registryDir, file), "utf8").split(/\r?\n/);
+  for (const raw of lines) {
+    const name = raw.replace(/#.*/, "").trim();
+    if (name) add(name, file);
+  }
+}
+
+const problems = [];
+for (const [name, from] of owners) {
+  const where = [...from].join(", ");
+  if (!/^[A-Z][A-Za-z0-9]*$/.test(name)) {
+    problems.push(`${name} (${where}) is not a PascalCase lucide-react name`);
+  } else if (name.startsWith("Lucide") || name.endsWith("Icon") || name === "Icon") {
+    problems.push(`${name} (${where}) is an alias form; list the base name`);
+  } else if (typeof lucide[name] !== "object" && typeof lucide[name] !== "function") {
+    problems.push(`${name} (${where}) does not exist in lucide-react ${map.library.version}`);
+  }
+}
+if (problems.length > 0) {
+  console.error(`Icon registry has ${problems.length} invalid names:\n  ${problems.join("\n  ")}`);
+  process.exit(1);
+}
+
+const names = [...owners.keys()].sort();
+const header = `/* Generated by scripts/generate-registry.mjs from registry/*.txt and src/map.json. Do not edit; run \`pnpm --filter @xos/icons generate:registry\`. */`;
+
+const namesSource = `${header}
+
+/** Every icon name XOS draws by name, sorted. Imports nothing, so a bundle that only checks names stays small. */
+export const registeredIconNames = ${JSON.stringify(names)} as const;
+
+export type RegisteredIconName = (typeof registeredIconNames)[number];
+`;
+
+const registrySource = `${header}
+import type { LucideIcon } from "lucide-react";
+import { ${names.map((n) => `${n} as Lucide${n}`).join(", ")} } from "lucide-react";
+import { registeredIconNames, type RegisteredIconName } from "./names.generated.ts";
+
+export { registeredIconNames, type RegisteredIconName };
+
+/** The lucide-react component for each registered name. Only these icons reach a bundle. */
+export const iconRegistry: Readonly<Record<RegisteredIconName, LucideIcon>> = /* @__PURE__ */ Object.freeze({ ${names
+  .map((n) => `${n}: Lucide${n}`)
+  .join(", ")} });
+`;
+
+/** XML attribute text: lucide's path data never needs more than these escapes. */
+function attr(value) {
+  return String(value).replaceAll("&", "&amp;").replaceAll('"', "&quot;").replaceAll("<", "&lt;");
+}
+
+/**
+ * The web icon sprite (ADR 0027): one <symbol> per registered icon, drawn from the same pinned
+ * lucide-react data as the components. Symbols carry only geometry, so the referencing <svg> sets
+ * stroke, size and color for each use.
+ */
+function symbol(name) {
+  const data = lucide[name].render({}, null).props.icon;
+  const size = data.size ?? 24;
+  const children = data.node
+    .map(([tag, attrs]) => {
+      const text = Object.entries(attrs)
+        .filter(([k]) => k !== "key")
+        .map(([k, v]) => ` ${k}="${attr(v)}"`)
+        .join("");
+      return `<${tag}${text}/>`;
+    })
+    .join("");
+  return `<symbol id="${name}" viewBox="0 0 ${size} ${size}">${children}</symbol>`;
+}
+// Width and height let Next.js read the file as a static image import; uses ignore them.
+const sprite = `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">\n${names.map(symbol).join("\n")}\n</svg>\n`;
+
+const outputs = [];
+for (const [file, source] of [
+  ["src/names.generated.ts", namesSource],
+  ["src/registry.generated.ts", registrySource],
+]) {
+  const path = join(root, file);
+  const config = (await prettier.resolveConfig(path)) ?? {};
+  outputs.push([file, await prettier.format(source, { ...config, filepath: path })]);
+}
+outputs.push(["src/sprite.generated.svg", sprite]);
+
+if (process.argv.includes("--check")) {
+  const stale = outputs.filter(([file, output]) => {
+    try {
+      return readFileSync(join(root, file), "utf8") !== output;
+    } catch {
+      return true;
+    }
+  });
+  if (stale.length > 0) {
+    console.error(
+      `${stale.map(([file]) => file).join(", ")} out of date. Run pnpm --filter @xos/icons generate:registry.`,
+    );
+    process.exit(1);
+  }
+} else {
+  for (const [file, output] of outputs) writeFileSync(join(root, file), output);
+  console.log(`Wrote ${names.length} icons to the names, registry and sprite files in src/.`);
+}

package/src/glyphs.ts

@@ -0,0 +1,78 @@
+import map from "./map.json" with { type: "json" };
+
+/**
+ * XOS glyph map (design handoff, section 2): the lucide-react icon for each department, phase and
+ * record kind, keyed by canon code, and the shape each record state draws. src/map.json is the
+ * single source; every Lucide name in it resolves in the pinned lucide-react.
+ */
+
+export type DepartmentCode = keyof typeof map.departments;
+export type PhaseCode = keyof typeof map.phases;
+export type RecordKind = keyof typeof map.recordKinds;
+export type RecordState = keyof typeof map.stateIcons;
+
+/** A Lucide component name used by an XOS glyph, in PascalCase (`Hammer`). */
+export type GlyphIconName =
+  | (typeof map.departments)[DepartmentCode]
+  | (typeof map.phases)[PhaseCode]
+  | (typeof map.recordKinds)[RecordKind];
+
+/** The shape a record state icon draws. State icons are custom (StateIcon), not Lucide. */
+export type StateGlyph = (typeof map.stateIcons)[RecordState];
+
+/** Icon library facts the glyphs are drawn with: package, pinned version, license and stroke width. */
+export const iconLibrary: Readonly<typeof map.library> = map.library;
+
+export const departmentCodes = Object.keys(map.departments) as DepartmentCode[];
+export const phaseCodes = Object.keys(map.phases) as PhaseCode[];
+export const recordKinds = Object.keys(map.recordKinds) as RecordKind[];
+export const recordStates = Object.keys(map.stateIcons) as RecordState[];
+
+function has<T extends object>(table: T, key: string): key is Extract<keyof T, string> {
+  return Object.hasOwn(table, key);
+}
+
+export function isDepartmentCode(value: string): value is DepartmentCode {
+  return has(map.departments, value);
+}
+
+export function isPhaseCode(value: string): value is PhaseCode {
+  return has(map.phases, value);
+}
+
+export function isRecordKind(value: string): value is RecordKind {
+  return has(map.recordKinds, value);
+}
+
+export function isRecordState(value: string): value is RecordState {
+  return has(map.stateIcons, value);
+}
+
+/** Lucide icon for a department code (`"4000"` is Tent). */
+export function departmentIcon(code: DepartmentCode): GlyphIconName {
+  return map.departments[code];
+}
+
+/** Lucide icon for a phase code (`"BLD"` is Hammer). */
+export function phaseIcon(code: PhaseCode): GlyphIconName {
+  return map.phases[code];
+}
+
+/** Lucide icon for a record kind (`"Task"` is SquareCheck). */
+export function recordKindIcon(kind: RecordKind): GlyphIconName {
+  return map.recordKinds[kind];
+}
+
+/** Shape drawn by the record state icon (`"blocked"` is an octagon). */
+export function stateGlyph(state: RecordState): StateGlyph {
+  return map.stateIcons[state];
+}
+
+/** Every distinct Lucide name the glyph map uses, sorted. */
+export const glyphIconNames: readonly GlyphIconName[] = [
+  ...new Set<GlyphIconName>([
+    ...Object.values(map.departments),
+    ...Object.values(map.phases),
+    ...Object.values(map.recordKinds),
+  ]),
+].sort();

package/src/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @xos/icons: the glyph map, the icon names XOS draws, the lucide-react components behind them
+ * (native and server use) and the web sprite (`@xos/icons/sprite.svg`). Web bundles import the
+ * `glyphs` and `names` entries, which pull in no icon components (ADR 0027).
+ */
+export * from "./glyphs.ts";
+export * from "./names.ts";
+export * from "./registry.ts";