@elsapiens/sdk 0.1.0

package/README.md

@@ -0,0 +1,349 @@
+# @elsapiens/sdk
+
+The complete elSapiens SDK - a unified package that re-exports all sub-packages.
+
+## Installation
+
+```bash
+npm install @elsapiens/sdk
+# or
+pnpm add @elsapiens/sdk
+```
+
+This single package includes:
+- `@elsapiens/utils` - Utility functions
+- `@elsapiens/styles` - CSS and Tailwind preset
+- `@elsapiens/ui` - UI components (50+)
+- `@elsapiens/services` - API and backend services
+- `@elsapiens/providers` - React context providers
+- `@elsapiens/hooks` - Custom React hooks
+- `@elsapiens/layout` - Layout components
+- `@elsapiens/shell` - Shell/wrapper components
+- `@elsapiens/help` - Help system components
+
+## Quick Start
+
+```tsx
+import {
+  SDKProvider,
+  AppShell,
+  Button,
+  Card,
+  CardHeader,
+  CardTitle,
+  CardContent,
+  useToast,
+} from '@elsapiens/sdk';
+import '@elsapiens/sdk/styles';
+
+const config = {
+  app: { name: 'My App' },
+  auth: { enabled: true, authUrl: '/api/auth' },
+  api: { baseUrl: '/api/v1' },
+};
+
+function App() {
+  return (
+    <SDKProvider config={config}>
+      <AppShell navItems={navItems}>
+        <Dashboard />
+      </AppShell>
+    </SDKProvider>
+  );
+}
+
+function Dashboard() {
+  const { toast } = useToast();
+
+  return (
+    <div className="p-6">
+      <Card>
+        <CardHeader>
+          <CardTitle>Welcome</CardTitle>
+        </CardHeader>
+        <CardContent>
+          <Button onClick={() => toast.success('Hello!')}>
+            Click Me
+          </Button>
+        </CardContent>
+      </Card>
+    </div>
+  );
+}
+```
+
+## Import Paths
+
+### Default Import (All Exports)
+
+```tsx
+import {
+  // Utils
+  cn,
+  formatCurrency,
+  formatDate,
+  debounce,
+
+  // UI Components
+  Button,
+  Input,
+  Card,
+  Modal,
+  Table,
+  LineChart,
+
+  // Services
+  createApiClient,
+  createAuthService,
+
+  // Providers
+  SDKProvider,
+  ThemeProvider,
+  useTheme,
+
+  // Hooks
+  useApp,
+  useFileUpload,
+  useToast,
+
+  // Layout
+  AppShell,
+  Sidebar,
+  PageHeader,
+
+  // Shell
+  AuthGuard,
+  ErrorBoundary,
+
+  // Help
+  HelpIcon,
+  HelpPanel,
+} from '@elsapiens/sdk';
+```
+
+### Sub-path Imports (Tree-Shaking)
+
+For smaller bundle sizes, import from specific sub-paths:
+
+```tsx
+// UI components only
+import { Button, Card, Modal } from '@elsapiens/sdk/ui';
+
+// Layout components only
+import { AppShell, Sidebar } from '@elsapiens/sdk/layout';
+
+// Shell components only
+import { AuthGuard, ErrorBoundary } from '@elsapiens/sdk/shell';
+
+// Help components only
+import { HelpIcon, HelpPanel } from '@elsapiens/sdk/help';
+
+// Providers only
+import { SDKProvider, useTheme } from '@elsapiens/sdk/providers';
+
+// Hooks only
+import { useApp, useFileUpload } from '@elsapiens/sdk/hooks';
+
+// Services only
+import { createApiClient } from '@elsapiens/sdk/services';
+
+// Utils only
+import { cn, formatCurrency } from '@elsapiens/sdk/utils';
+
+// Styles
+import '@elsapiens/sdk/styles';
+```
+
+## Package Contents
+
+### Utils (`@elsapiens/sdk/utils`)
+
+```tsx
+// CSS utilities
+cn(...classes)
+
+// Formatters
+formatCurrency(value, currency?, locale?)
+formatNumber(value, options?)
+formatDate(date, format?)
+formatRelativeTime(date)
+formatFileSize(bytes)
+
+// Validators
+isEmail(value)
+isUrl(value)
+required(message?)
+email(message?)
+compose(...validators)
+
+// Keyboard
+parseShortcut(shortcut)
+matchesShortcut(event, shortcut)
+formatShortcut(shortcut)
+
+// Utilities
+debounce(fn, delay)
+throttle(fn, interval)
+```
+
+### UI Components (`@elsapiens/sdk/ui`)
+
+**Form:** Button, Input, Textarea, Select, SearchableSelect, MultiSelect, DatePicker, TimePicker, Toggle, Checkbox, RadioGroup, Slider, FileUpload
+
+**Display:** Card, Badge, Avatar, Table, Progress, Skeleton, Tabs, Stepper
+
+**Interaction:** Modal, Toast, Tooltip, Popover
+
+**Charts:** LineChart, AreaChart, BarChart, PieChart, DonutChart, Sparkline
+
+### Services (`@elsapiens/sdk/services`)
+
+```tsx
+createApiClient(config)
+createAuthService(config)
+createHealthCheck(config)
+createShortcutManager()
+createHelpRegistry()
+createGeolocationService()
+createLogger(name)
+```
+
+### Providers (`@elsapiens/sdk/providers`)
+
+```tsx
+SDKProvider
+ThemeProvider → useTheme()
+AuthProvider → useAuth()
+OrganizationProvider → useOrganization()
+ShortcutProvider → useShortcuts()
+HelpProvider → useHelp()
+```
+
+### Hooks (`@elsapiens/sdk/hooks`)
+
+```tsx
+useApp()
+useFileUpload(options)
+useTimezone()
+useToast()
+useTheme()
+useAuth()
+useOrganization()
+useShortcuts()
+useHelp()
+```
+
+### Layout (`@elsapiens/sdk/layout`)
+
+```tsx
+AppShell
+Sidebar
+TopBar
+PageHeader
+PageTransition
+UserInfo
+```
+
+### Shell (`@elsapiens/sdk/shell`)
+
+```tsx
+AuthGuard
+ErrorBoundary
+OrgSwitcher
+AppSelector
+ServicesDownPage
+```
+
+### Help (`@elsapiens/sdk/help`)
+
+```tsx
+HelpIcon
+HelpTooltip
+HelpPanel
+HelpSearch
+ShortcutHelpPanel
+```
+
+## Configuration
+
+```tsx
+import { SDKProvider } from '@elsapiens/sdk';
+import type { SDKConfig } from '@elsapiens/sdk';
+
+const config: SDKConfig = {
+  app: {
+    name: 'My Application',
+    logo: '/logo.svg',
+    version: '1.0.0',
+  },
+
+  auth: {
+    enabled: true,
+    authUrl: '/api/auth',
+    tokenKey: 'auth_token',
+  },
+
+  api: {
+    baseUrl: '/api/v1',
+    timeout: 30000,
+  },
+
+  theme: {
+    defaultTheme: 'system', // 'light' | 'dark' | 'system'
+  },
+
+  features: {
+    darkMode: true,
+    shortcuts: true,
+    help: true,
+  },
+};
+
+<SDKProvider config={config}>
+  <App />
+</SDKProvider>
+```
+
+## Tailwind Configuration
+
+```js
+// tailwind.config.js
+import elsapiensPreset from '@elsapiens/sdk/styles/tailwind-preset';
+
+export default {
+  presets: [elsapiensPreset],
+  content: [
+    './src/**/*.{js,ts,jsx,tsx}',
+    './node_modules/@elsapiens/**/*.{js,ts,jsx,tsx}',
+  ],
+};
+```
+
+## Peer Dependencies
+
+```json
+{
+  "react": "^18.2.0",
+  "react-dom": "^18.2.0",
+  "react-router-dom": "^6.0.0"
+}
+```
+
+## Individual Packages
+
+If you only need specific functionality, install individual packages:
+
+```bash
+# Core utilities and styles
+npm install @elsapiens/utils @elsapiens/styles
+
+# UI components only
+npm install @elsapiens/ui @elsapiens/utils
+
+# Full SDK
+npm install @elsapiens/sdk
+```
+
+## License
+
+MIT

package/dist/help.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/help';

package/dist/help.js

@@ -0,0 +1 @@
+export * from '@elsapiens/help';

package/dist/hooks.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/hooks';

package/dist/hooks.js

@@ -0,0 +1 @@
+export * from '@elsapiens/hooks';

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from '@elsapiens/utils';
+export * from '@elsapiens/ui';
+export * from '@elsapiens/services';
+export * from '@elsapiens/providers';
+export * from '@elsapiens/hooks';
+export { AppShell, AppShellProps, PageTransition, PageTransitionProps, Sidebar, SidebarProps, TopBar, TopBarProps, UserInfo, UserInfoProps } from '@elsapiens/layout';
+export * from '@elsapiens/shell';
+export * from '@elsapiens/help';

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from '@elsapiens/utils';
+export * from '@elsapiens/ui';
+export * from '@elsapiens/services';
+export * from '@elsapiens/providers';
+export * from '@elsapiens/hooks';
+export { AppShell, PageTransition, Sidebar, TopBar, UserInfo } from '@elsapiens/layout';
+export * from '@elsapiens/shell';
+export * from '@elsapiens/help';

package/dist/layout.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/layout';

package/dist/layout.js

@@ -0,0 +1 @@
+export * from '@elsapiens/layout';

package/dist/providers.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/providers';

package/dist/providers.js

@@ -0,0 +1 @@
+export * from '@elsapiens/providers';

package/dist/services.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/services';

package/dist/services.js

@@ -0,0 +1 @@
+export * from '@elsapiens/services';

package/dist/shell.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/shell';

package/dist/shell.js

@@ -0,0 +1 @@
+export * from '@elsapiens/shell';

package/dist/ui.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/ui';

package/dist/ui.js

@@ -0,0 +1 @@
+export * from '@elsapiens/ui';

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export * from '@elsapiens/utils';

package/dist/utils.js

@@ -0,0 +1 @@
+export * from '@elsapiens/utils';

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@elsapiens/sdk",
+  "version": "0.1.0",
+  "description": "elSapiens SDK - Complete React component library for micro-frontend applications",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./ui": {
+      "import": {
+        "types": "./dist/ui.d.ts",
+        "default": "./dist/ui.js"
+      }
+    },
+    "./layout": {
+      "import": {
+        "types": "./dist/layout.d.ts",
+        "default": "./dist/layout.js"
+      }
+    },
+    "./shell": {
+      "import": {
+        "types": "./dist/shell.d.ts",
+        "default": "./dist/shell.js"
+      }
+    },
+    "./help": {
+      "import": {
+        "types": "./dist/help.d.ts",
+        "default": "./dist/help.js"
+      }
+    },
+    "./providers": {
+      "import": {
+        "types": "./dist/providers.d.ts",
+        "default": "./dist/providers.js"
+      }
+    },
+    "./hooks": {
+      "import": {
+        "types": "./dist/hooks.d.ts",
+        "default": "./dist/hooks.js"
+      }
+    },
+    "./services": {
+      "import": {
+        "types": "./dist/services.d.ts",
+        "default": "./dist/services.js"
+      }
+    },
+    "./utils": {
+      "import": {
+        "types": "./dist/utils.d.ts",
+        "default": "./dist/utils.js"
+      }
+    },
+    "./styles": "@elsapiens/styles",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@elsapiens/utils": "0.1.0",
+    "@elsapiens/ui": "0.1.0",
+    "@elsapiens/providers": "0.1.0",
+    "@elsapiens/services": "0.1.0",
+    "@elsapiens/hooks": "0.1.0",
+    "@elsapiens/help": "0.1.0",
+    "@elsapiens/layout": "0.1.0",
+    "@elsapiens/shell": "0.1.0",
+    "@elsapiens/styles": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.47",
+    "@types/react-dom": "^18.2.18",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.21.0"
+  },
+  "peerDependenciesMeta": {
+    "react-router-dom": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsup --config tsup.config.ts",
+    "dev": "tsup --config tsup.config.ts --watch",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit"
+  }
+}