@uparjak/core-interface

Core TypeScript interfaces and types for the Uparjak e-commerce platform.

Installation

# Using yarn
yarn add @uparjak/core-interface

# Using npm
npm install @uparjak/core-interface

Usage

import { 
  User, 
  Organization, 
  Store, 
  Product,
  Order,
  Payment,
  AdminUser,
  BaseEntity 
} from '@uparjak/core-interface';

// Use the types in your application
const user: User = {
  id: '1',
  name: 'John Doe',
  email: '[email protected]',
  role: 'BUYER',
  isActive: true,
  createdAt: new Date().toISOString(),
  updatedAt: new Date().toISOString()
};

Available Types

Core Entities

• BaseEntity - Base interface for all entities
• User - User entity with roles (BUYER, SELLER, ADMIN)
• AdminUser - Admin-specific user interface
• Organization - Organization entity
• Store - Store entity
• Product - Product entity
• Order - Order entity
• Payment - Payment entity

Admin System Types

• AdminPageProps - Props for admin pages
• AdminDashboardData - Dashboard data structure
• AnalyticsData - Analytics data structure
• BackupData - Backup data structure

Form Types

• Various form interfaces for different entities
• Validation types
• Form state management types

API Interface Types

• Request/Response types
• API endpoint interfaces
• Error handling types

Development

Building the Package

# Install dependencies
yarn install

# Build the package
yarn build

# Clean build output
yarn clean

Publishing

# Build and publish
yarn publish

License

MIT

Contributing

Please read our contributing guidelines before submitting pull requests.

Support

For support and questions, please open an issue on our GitHub repository.