@inferencesh/ui 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 inference.sh
+
+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,69 @@
-# Temporary Holding Version
+# @inferencesh/ui
 
-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.
+inference.sh's shared UI, shipped as TypeScript source. The consumer's
+bundler compiles it and the consumer's Tailwind scans it:
+
+```css
+@import "@inferencesh/ui/theme/css/fonts.css";
+@import "tailwindcss";
+@import "@inferencesh/ui/theme/css/globals.css";
+@source "../node_modules/@inferencesh/ui/src/**/*.{ts,tsx}";
+```
+
+Peer dependencies: `react`, `react-dom`, `next-themes`, `tailwindcss`.
+
+## Layout
+
+| path | what | who edits it |
+|---|---|---|
+| `src/shadcn/` | the shadcn components, style `base-nova` on Base UI | the shadcn CLI only |
+| `src/components/` | ours: wrappers over shadcn (`button`, `select`, `toggle-group`), inline-sidebar, tooltip, chart, loaders, theme switchers, `code-block/` | us |
+| `src/markdown/` | markdown and docs-markdown renderers | us |
+| `src/docs/` | table of contents, copy menu, steps, callout, code group, api docs | us |
+| `src/examples/` | API usage examples and the guide markdown generator | us |
+| `src/og/` | OG card rendering | us |
+| `src/theme/` | CSS tokens, themes, fonts, the theme config | us |
+| `src/lib/` | helpers the components need (`safe-content`, `storage`, `schema`, `example-input`) and display helpers both products use (`plans`, `display-name`) | us |
+| `src/hooks/` | `use-mobile`, `use-copy-to-clipboard` | us |
+| `src/utils/` | `cn` (re-exported from shadcn's `cn` package) | us |
+
+## Rules
+
+- `src/shadcn/*` is never hand-edited. Refresh it with
+  `pnpm dlx shadcn@latest add <component> -o` (the diff first: `--diff`).
+  `components.json` points the CLI at this package's paths.
+- A behaviour we want on top of a shadcn component is a wrapper in
+  `src/components/` with the same file name (`select.tsx` wraps
+  `shadcn/select.tsx`). Consumers import the wrapper. A visual opinion that
+  applies everywhere is a rule in `src/theme/css/base.css`.
+- Nothing in here reads the app's data layer or its generated types.
+  Components take plain props; the API types a few of them describe
+  (`MenuDTO`, plans) come from `@inferencesh/sdk`, the public SDK.
+- Imports between our own files are relative. The shadcn files import the
+  package by name (`@inferencesh/ui/shadcn/button`), as the CLI writes
+  them; `vitest.config.ts` and `tsconfig.json` alias that to `src/`.
+
+## Exports
+
+`package.json` `exports` lists every module and asset explicitly; it is
+generated. After adding, renaming or removing a file:
+
+```sh
+pnpm exports          # rewrite package.json
+pnpm exports:check    # CI: fail when it is behind
+```
+
+## Publishing
+
+CI publishes to npm (public, MIT) when a tag `ui-vX.Y.Z` is pushed; the
+tag's version must match `package.json`. Bump the version, commit, then:
+
+```sh
+git tag -a ui-v0.1.1 -m "ui 0.1.1" && git push origin ui-v0.1.1
+```
+
+The workflow authenticates with npm trusted publishing (OIDC) once the
+package on npmjs lists `inference-sh/app` / `publish-ui.yml` as a trusted
+publisher; the `NPM_TOKEN` secret covers the first publish. Consumers
+install it like any npm package; inside the `js` workspace it resolves
+through the workspace.

package/components.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "base-nova",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "src/theme/css/shadcn.css",
+    "baseColor": "neutral",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@inferencesh/ui/components",
+    "utils": "@inferencesh/ui/utils",
+    "ui": "@inferencesh/ui/shadcn",
+    "lib": "@inferencesh/ui/lib",
+    "hooks": "@inferencesh/ui/hooks"
+  },
+  "registries": {}
+}

package/package.json

@@ -1,6 +1,233 @@
 {
   "name": "@inferencesh/ui",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "description": "inference.sh's shared UI: the shadcn components (CLI-owned, base-nova on Base UI), our components on top of them, the markdown and docs renderers, OG cards and the theme. Shipped as TypeScript source; the consumer's bundler and Tailwind compile it.",
+  "license": "MIT",
+  "homepage": "https://inference.sh",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/inference-sh/app.git",
+    "directory": "packages/ui"
+  },
+  "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/lib/testdata",
+    "components.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "exports": "node scripts/exports.mjs",
+    "exports:check": "node scripts/exports.mjs --check"
+  },
+  "peerDependencies": {
+    "next-themes": "^0.4.6",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tailwindcss": "^4.3.3"
+  },
+  "dependencies": {
+    "@base-ui/react": "^1.6.0",
+    "@inferencesh/sdk": "^0.39.0",
+    "@shadcn/react": "^0.3.0",
+    "class-variance-authority": "^0.7.1",
+    "cmdk": "^1.1.1",
+    "cn": "^0.5.2",
+    "country-data-list": "^1.6.3",
+    "embla-carousel-react": "^8.6.0",
+    "input-otp": "^1.4.2",
+    "lucide-react": "^1.31.0",
+    "motion": "^12.42.2",
+    "react-circle-flags": "^0.0.30",
+    "react-colorful": "^5.8.0",
+    "react-day-picker": "^10.0.1",
+    "react-hook-form": "^7.82.0",
+    "react-markdown": "^10.1.0",
+    "react-resizable-panels": "^4",
+    "recharts": "^3.10.0",
+    "rehype-raw": "^7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "remark-gfm": "^4.0.1",
+    "sonner": "^2.0.7",
+    "tw-animate-css": "^1.4.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/mdast": "^4.0.4",
+    "@types/node": "^26.2.0",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "happy-dom": "^21.0.4",
+    "typescript": "~7.0.2",
+    "vitest": "^4.1.12"
+  },
+  "exports": {
+    "./components/audio-player": "./src/components/audio-player.tsx",
+    "./components/button": "./src/components/button.tsx",
+    "./components/chart": "./src/components/chart.tsx",
+    "./components/circuit": "./src/components/circuit.tsx",
+    "./components/code-block/code-block": "./src/components/code-block/code-block.tsx",
+    "./components/code-block": "./src/components/code-block/index.ts",
+    "./components/code-block/languages": "./src/components/code-block/languages.ts",
+    "./components/code-block/styles": "./src/components/code-block/styles.ts",
+    "./components/code-block/tokenizer": "./src/components/code-block/tokenizer.ts",
+    "./components/code-block/types": "./src/components/code-block/types.ts",
+    "./components/code-block/utils": "./src/components/code-block/utils.ts",
+    "./components/code": "./src/components/code.tsx",
+    "./components/cookie-consent": "./src/components/cookie-consent.tsx",
+    "./components/copy-button": "./src/components/copy-button.tsx",
+    "./components/country-dropdown": "./src/components/country-dropdown.tsx",
+    "./components/glow-loader-fast": "./src/components/glow-loader-fast.tsx",
+    "./components/glow-loader-mono": "./src/components/glow-loader-mono.tsx",
+    "./components/glow-loader-sm-fast": "./src/components/glow-loader-sm-fast.tsx",
+    "./components/glow-loader-sm-mono": "./src/components/glow-loader-sm-mono.tsx",
+    "./components/glow-loader-sm": "./src/components/glow-loader-sm.tsx",
+    "./components/glow-loader": "./src/components/glow-loader.tsx",
+    "./components/glow-logo": "./src/components/glow-logo.tsx",
+    "./components/gradient": "./src/components/gradient.tsx",
+    "./components": "./src/components/index.ts",
+    "./components/inline-sidebar": "./src/components/inline-sidebar.tsx",
+    "./components/input-color": "./src/components/input-color.tsx",
+    "./components/logo-base": "./src/components/logo-base.tsx",
+    "./components/logo-color": "./src/components/logo-color.tsx",
+    "./components/logo-full": "./src/components/logo-full.tsx",
+    "./components/logo-svg": "./src/components/logo-svg.tsx",
+    "./components/menu-navigation": "./src/components/menu-navigation.tsx",
+    "./components/multi-select": "./src/components/multi-select.tsx",
+    "./components/pastel-gradient": "./src/components/pastel-gradient.tsx",
+    "./components/pixel-symmetry": "./src/components/pixel-symmetry.tsx",
+    "./components/progress": "./src/components/progress.tsx",
+    "./components/scroll-more": "./src/components/scroll-more.tsx",
+    "./components/select": "./src/components/select.tsx",
+    "./components/shimmering-text": "./src/components/shimmering-text.tsx",
+    "./components/sidebar-light": "./src/components/sidebar-light.tsx",
+    "./components/sonner": "./src/components/sonner.tsx",
+    "./components/theme-switcher-sidebar": "./src/components/theme-switcher-sidebar.tsx",
+    "./components/theme-switcher-simple": "./src/components/theme-switcher-simple.tsx",
+    "./components/theme-switcher": "./src/components/theme-switcher.tsx",
+    "./components/toggle-group": "./src/components/toggle-group.tsx",
+    "./components/tooltip-button": "./src/components/tooltip-button.tsx",
+    "./components/tooltip": "./src/components/tooltip.tsx",
+    "./components/tree-view": "./src/components/tree-view.tsx",
+    "./components/unglow-loader": "./src/components/unglow-loader.tsx",
+    "./components/waveform": "./src/components/waveform.tsx",
+    "./components/zoomable-image": "./src/components/zoomable-image.tsx",
+    "./docs/api-docs": "./src/docs/api-docs.tsx",
+    "./docs/callout": "./src/docs/callout.tsx",
+    "./docs/code-group": "./src/docs/code-group.tsx",
+    "./docs/copy-menu": "./src/docs/copy-menu.tsx",
+    "./docs/doc-tabs": "./src/docs/doc-tabs.tsx",
+    "./docs": "./src/docs/index.ts",
+    "./docs/steps": "./src/docs/steps.tsx",
+    "./docs/table-of-contents": "./src/docs/table-of-contents.tsx",
+    "./examples/guide-markdown": "./src/examples/guide-markdown.ts",
+    "./examples": "./src/examples/index.ts",
+    "./hooks/use-copy-to-clipboard": "./src/hooks/use-copy-to-clipboard.ts",
+    "./hooks/use-mobile": "./src/hooks/use-mobile.ts",
+    "./lib/display-name": "./src/lib/display-name.ts",
+    "./lib/example-input": "./src/lib/example-input.ts",
+    "./lib/plans": "./src/lib/plans.ts",
+    "./lib/safe-content": "./src/lib/safe-content.ts",
+    "./lib/schema": "./src/lib/schema.ts",
+    "./lib/storage": "./src/lib/storage.ts",
+    "./markdown/docs-markdown-renderer": "./src/markdown/docs-markdown-renderer.tsx",
+    "./markdown/helpers": "./src/markdown/helpers.ts",
+    "./markdown": "./src/markdown/index.ts",
+    "./markdown/markdown-renderer": "./src/markdown/markdown-renderer.tsx",
+    "./markdown/youtube-embed": "./src/markdown/youtube-embed.tsx",
+    "./og/image": "./src/og/image.ts",
+    "./og": "./src/og/index.tsx",
+    "./og/query": "./src/og/query.ts",
+    "./shadcn/accordion": "./src/shadcn/accordion.tsx",
+    "./shadcn/alert-dialog": "./src/shadcn/alert-dialog.tsx",
+    "./shadcn/alert": "./src/shadcn/alert.tsx",
+    "./shadcn/aspect-ratio": "./src/shadcn/aspect-ratio.tsx",
+    "./shadcn/attachment": "./src/shadcn/attachment.tsx",
+    "./shadcn/avatar": "./src/shadcn/avatar.tsx",
+    "./shadcn/badge": "./src/shadcn/badge.tsx",
+    "./shadcn/breadcrumb": "./src/shadcn/breadcrumb.tsx",
+    "./shadcn/bubble": "./src/shadcn/bubble.tsx",
+    "./shadcn/button-group": "./src/shadcn/button-group.tsx",
+    "./shadcn/button": "./src/shadcn/button.tsx",
+    "./shadcn/calendar": "./src/shadcn/calendar.tsx",
+    "./shadcn/card": "./src/shadcn/card.tsx",
+    "./shadcn/carousel": "./src/shadcn/carousel.tsx",
+    "./shadcn/chart": "./src/shadcn/chart.tsx",
+    "./shadcn/checkbox": "./src/shadcn/checkbox.tsx",
+    "./shadcn/collapsible": "./src/shadcn/collapsible.tsx",
+    "./shadcn/combobox": "./src/shadcn/combobox.tsx",
+    "./shadcn/command": "./src/shadcn/command.tsx",
+    "./shadcn/context-menu": "./src/shadcn/context-menu.tsx",
+    "./shadcn/dialog": "./src/shadcn/dialog.tsx",
+    "./shadcn/direction": "./src/shadcn/direction.tsx",
+    "./shadcn/drawer": "./src/shadcn/drawer.tsx",
+    "./shadcn/dropdown-menu": "./src/shadcn/dropdown-menu.tsx",
+    "./shadcn/empty": "./src/shadcn/empty.tsx",
+    "./shadcn/field": "./src/shadcn/field.tsx",
+    "./shadcn/form": "./src/shadcn/form.tsx",
+    "./shadcn/hover-card": "./src/shadcn/hover-card.tsx",
+    "./shadcn": "./src/shadcn/index.ts",
+    "./shadcn/input-group": "./src/shadcn/input-group.tsx",
+    "./shadcn/input-otp": "./src/shadcn/input-otp.tsx",
+    "./shadcn/input": "./src/shadcn/input.tsx",
+    "./shadcn/item": "./src/shadcn/item.tsx",
+    "./shadcn/kbd": "./src/shadcn/kbd.tsx",
+    "./shadcn/label": "./src/shadcn/label.tsx",
+    "./shadcn/marker": "./src/shadcn/marker.tsx",
+    "./shadcn/menubar": "./src/shadcn/menubar.tsx",
+    "./shadcn/message-scroller": "./src/shadcn/message-scroller.tsx",
+    "./shadcn/message": "./src/shadcn/message.tsx",
+    "./shadcn/native-select": "./src/shadcn/native-select.tsx",
+    "./shadcn/navigation-menu": "./src/shadcn/navigation-menu.tsx",
+    "./shadcn/pagination": "./src/shadcn/pagination.tsx",
+    "./shadcn/popover": "./src/shadcn/popover.tsx",
+    "./shadcn/progress": "./src/shadcn/progress.tsx",
+    "./shadcn/radio-group": "./src/shadcn/radio-group.tsx",
+    "./shadcn/resizable": "./src/shadcn/resizable.tsx",
+    "./shadcn/scroll-area": "./src/shadcn/scroll-area.tsx",
+    "./shadcn/select": "./src/shadcn/select.tsx",
+    "./shadcn/separator": "./src/shadcn/separator.tsx",
+    "./shadcn/sheet": "./src/shadcn/sheet.tsx",
+    "./shadcn/sidebar": "./src/shadcn/sidebar.tsx",
+    "./shadcn/skeleton": "./src/shadcn/skeleton.tsx",
+    "./shadcn/slider": "./src/shadcn/slider.tsx",
+    "./shadcn/sonner": "./src/shadcn/sonner.tsx",
+    "./shadcn/spinner": "./src/shadcn/spinner.tsx",
+    "./shadcn/switch": "./src/shadcn/switch.tsx",
+    "./shadcn/table": "./src/shadcn/table.tsx",
+    "./shadcn/tabs": "./src/shadcn/tabs.tsx",
+    "./shadcn/textarea": "./src/shadcn/textarea.tsx",
+    "./shadcn/toggle-group": "./src/shadcn/toggle-group.tsx",
+    "./shadcn/toggle": "./src/shadcn/toggle.tsx",
+    "./shadcn/tooltip": "./src/shadcn/tooltip.tsx",
+    "./theme/config": "./src/theme/config.ts",
+    "./theme/css/base.css": "./src/theme/css/base.css",
+    "./theme/css/bitboy.css": "./src/theme/css/bitboy.css",
+    "./theme/css/dark.css": "./src/theme/css/dark.css",
+    "./theme/css/designer.css": "./src/theme/css/designer.css",
+    "./theme/css/fonts.css": "./src/theme/css/fonts.css",
+    "./theme/css/globals.css": "./src/theme/css/globals.css",
+    "./theme/css/hackintosh.css": "./src/theme/css/hackintosh.css",
+    "./theme/css/llama.css": "./src/theme/css/llama.css",
+    "./theme/css/safelist.css": "./src/theme/css/safelist.css",
+    "./theme/css/shadcn.css": "./src/theme/css/shadcn.css",
+    "./theme/css/theme.css": "./src/theme/css/theme.css",
+    "./theme/embed-theme": "./src/theme/embed-theme.ts",
+    "./theme/fonts/FiraCode-VF.woff2": "./src/theme/fonts/FiraCode-VF.woff2",
+    "./theme/fonts/Hack-Regular.woff2": "./src/theme/fonts/Hack-Regular.woff2",
+    "./theme/fonts/Mona-Sans.woff2": "./src/theme/fonts/Mona-Sans.woff2",
+    "./theme": "./src/theme/index.ts",
+    "./utils/cn": "./src/utils/cn.ts",
+    "./utils": "./src/utils/index.ts"
+  }
+}