npm - @contractspec/lib.design-system - Versions diffs - 3.7.6 → 3.8.3 - Mend

@contractspec/lib.design-system 3.7.6 → 3.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

package/README.md CHANGED Viewed

@@ -1,133 +1,68 @@
 # @contractspec/lib.design-system
-[![npm version](https://img.shields.io/npm/v/@contractspec/lib.design-system)](https://www.npmjs.com/package/@contractspec/lib.design-system)
-[![npm downloads](https://img.shields.io/npm/dt/@contractspec/lib.design-system)](https://www.npmjs.com/package/@contractspec/lib.design-system)
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/lssm-tech/contractspec)
+Website: https://contractspec.io
+**Design tokens and theming primitives.**
-Website: https://contractspec.io/
+## What It Provides
-High-level design system components, patterns, and layouts for LSSM applications. Built on top of `@contractspec/lib.ui-kit`.
-## Purpose
-To standardize the look and feel of LSSM applications by providing:
-- **Composite Components**: Molecules and Organisms that solve common UI problems (headers, sidebars, cards).
-- **Layouts**: Ready-to-use page structures for dashboards, marketing sites, and lists.
-- **Data Views**: Standardized renderers for lists, tables, and details views.
-- **Forms**: Zod-integrated form layouts and components.
-- **Platform Utilities**: Hooks and helpers for responsive and adaptive design (Mobile/Web).
-- **Legal**: Compliant templates for Terms, Privacy, and GDPR.
+- **Layer**: lib.
+- **Consumers**: accessibility, presentation-runtime-react, video-gen, bundles, apps.
+- Related ContractSpec packages include `@contractspec/lib.ai-agent`, `@contractspec/lib.contracts-runtime-client-react`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.example-shared-ui`, `@contractspec/lib.presentation-runtime-react`, `@contractspec/lib.ui-kit`, ...
 ## Installation
-```bash
-npm install @contractspec/lib.design-system
-# or
-bun add @contractspec/lib.design-system
-```
-## Key Concepts
-- **Platform Agnostic Logic**: Business logic hooks are shared where possible.
-- **Platform Specific UI**: `.mobile.ts(x)` and `.web.ts(x)` extensions allow for tailored experiences while maintaining a unified API.
-- **Contract-Driven**: Components like `DataViewRenderer` and `ZodForm` are designed to work directly with `ContractSpec` definitions.
-- **Theming**: Centralized token bridge and variant definitions.
-## Exports
-### Atoms & Molecules
-- `Button`, `Input`, `Link` (Platform-aware wrappers)
-- `ActionButtons`, `DataChips`, `EmptyState`, `ErrorState`
-- `Breadcrumbs`, `CommandPalette`, `DropdownMenu`, `EntityCard`
-- `FiltersToolbar`, `LangSwitch`, `LoaderBlock`, `StatCard`
-### Organisms (Complex UI)
-- **App Shell**: `AppLayout`, `AppHeader`, `AppSidebar`, `Footer`
-- **Marketing**: `MarketingLayout`, `HeroSection`, `FeaturesSection`, `PricingSection`
-- **Lists**: `ListCardPage`, `ListGridPage`, `ListTablePage`
-- **Legal**: `LegalPageLayout`, `GDPRRights`, `ContactForm`
+`npm install @contractspec/lib.design-system`
-### Data & Forms
+or
-- `DataViewRenderer`: Auto-renders data based on schema.
-- `ZodForm`: Auto-generates forms from Zod schemas.
-- `FormLayout`, `FormDialog`, `FormStepsLayout`
-### Templates
-- `ListPageTemplate`
-- Legal: `PrivacyTemplate`, `TermsTemplate`, `CookiesTemplate`
+`bun add @contractspec/lib.design-system`
 ## Usage
-### App Layout
-```tsx
-import { AppLayout } from '@contractspec/lib.design-system/components/organisms/AppLayout';
-import { AppSidebar } from '@contractspec/lib.design-system/components/organisms/AppSidebar';
-export default function Layout({ children }) {
-  return <AppLayout sidebar={<AppSidebar />}>{children}</AppLayout>;
-}
-```
-### Zod Form
-```tsx
-import { ZodForm } from '@contractspec/lib.design-system/components/forms/ZodForm';
-import * as z from "zod";
-const schema = z.object({
-  name: z.string().min(1),
-  email: z.string().email(),
-});
-export function SignupForm() {
-  return (
-    <ZodForm
-      schema={schema}
-      onSubmit={(data) => console.log(data)}
-      submitLabel="Sign Up"
-    />
-  );
-}
-```
+Import the root entrypoint from `@contractspec/lib.design-system`, or choose a documented subpath when you only need one part of the package surface.
+## Architecture
+- `src/components/` contains reusable UI components and view composition.
+- `src/hooks/` contains custom hooks for host applications.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/lib/` contains package-local helper utilities and adapters.
+- `src/platform` is part of the package's public or composition surface.
+- `src/renderers` is part of the package's public or composition surface.
+- `src/theme` is part of the package's public or composition surface.
+## Public Entry Points
+- Export `.` resolves through `./src/index.ts`.
+## Local Commands
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run test` — bun test --pass-with-no-tests
+- `bun run lint` — bun run lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit -p tsconfig.build.json
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run registry:build` — bun run scripts/build-registry.ts
+- `bun run prebuild` — contractspec-bun-build prebuild
+## Recent Updates
+- Replace eslint+prettier by biomejs to optimize speed.
+- Add data visualization capabilities.
+- Add table capabilities.
+- Resolve lint, build, and type errors across nine packages.
+- Add AI provider ranking system with ranking-driven model selection.
+- Stabilize marketing header interactions.
+## Notes
+- **High blast radius** — all UI surfaces depend on design tokens; treat token names and values as public API.
+- Component hierarchy must be preserved; do not flatten or restructure without coordinating downstream consumers.
+- Token removals or renames are breaking changes.