@orsetra/shared-types 1.0.0

package/README.md

@@ -0,0 +1,84 @@
+# @orsetra/shared-types
+
+Shared TypeScript type definitions for Orsetra platform.
+
+## Installation
+
+```bash
+npm install @orsetra/shared-types
+# or
+pnpm add @orsetra/shared-types
+# or
+yarn add @orsetra/shared-types
+```
+
+## Usage
+
+```typescript
+import type { User, ApiResponse, PaginatedData } from '@orsetra/shared-types'
+
+// Use the types in your code
+const user: User = {
+  id: '123',
+  email: 'user@example.com',
+  name: 'John Doe',
+}
+
+const response: ApiResponse<User> = {
+  success: true,
+  data: user,
+}
+```
+
+## Available Types
+
+### Common Types
+
+- **User** - User entity type
+- **ApiResponse<T>** - Generic API response wrapper
+- **PaginatedData<T>** - Paginated data structure
+- **ErrorResponse** - Error response structure
+
+### Import Specific Types
+
+```typescript
+import type { User } from '@orsetra/shared-types/types/common'
+```
+
+## Type Safety
+
+All types are strictly typed and provide full IntelliSense support in modern IDEs.
+
+```typescript
+import type { ApiResponse } from '@orsetra/shared-types'
+
+function handleResponse(response: ApiResponse<User>) {
+  if (response.success) {
+    // TypeScript knows response.data is User
+    console.log(response.data.email)
+  } else {
+    // TypeScript knows response.error exists
+    console.error(response.error)
+  }
+}
+```
+
+## Extending Types
+
+You can extend the shared types in your own projects:
+
+```typescript
+import type { User } from '@orsetra/shared-types'
+
+interface ExtendedUser extends User {
+  customField: string
+}
+```
+
+## License
+
+MIT
+
+## Repository
+
+[GitHub](https://github.com/orsetra/console-ui/tree/main/packages/shared-types)

package/index.ts

@@ -0,0 +1,2 @@
+// Shared types across all micro-frontends
+export * from './types/common'

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@orsetra/shared-types",
+  "version": "1.0.0",
+  "description": "Shared TypeScript types for Orsetra platform",
+  "main": "./index.ts",
+  "types": "./index.ts",
+  "exports": {
+    ".": "./index.ts",
+    "./types/*": "./types/*.ts"
+  },
+  "files": [
+    "index.ts",
+    "types",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/orsetra/console-ui.git",
+    "directory": "packages/shared-types"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "orsetra"
+  ],
+  "devDependencies": {
+    "typescript": "^5"
+  }
+}

package/types/common.ts

@@ -0,0 +1,12 @@
+// Common types
+export interface User {
+  id: string
+  email: string
+  name: string
+}
+
+export interface ApiResponse<T> {
+  data: T
+  error?: string
+  status: number
+}