@sales-planner/shared 0.1.0

package/README.md

@@ -0,0 +1,103 @@
+# @sales-planner/shared
+
+Shared TypeScript types for the Sales Planner platform.
+
+## Installation
+
+```bash
+pnpm add @sales-planner/shared
+```
+
+## Usage
+
+```typescript
+import type {
+  User,
+  Tenant,
+  Shop,
+  Sku,
+  SalesHistory,
+  CreateUserDto,
+  CreateTenantDto,
+  UserWithRolesAndTenants,
+} from '@sales-planner/shared';
+```
+
+## Types
+
+### Entities
+
+Core database entities:
+
+| Type | Description |
+|------|-------------|
+| `User` | User account |
+| `Tenant` | Tenant (organization) |
+| `Shop` | Shop within a tenant |
+| `Sku` | SKU (product) in a shop |
+| `SalesHistory` | Monthly sales data for a SKU |
+| `Role` | Role definition (viewer, editor, etc.) |
+| `ApiKey` | API key for authentication |
+| `Marketplace` | Marketplace reference |
+
+### DTOs (Data Transfer Objects)
+
+Request payloads for creating/updating entities:
+
+| Type | Description |
+|------|-------------|
+| `CreateUserDto` | Create a new user |
+| `CreateTenantDto` | Create a new tenant |
+| `CreateTenantWithShopDto` | Create tenant with shop and API key |
+| `CreateShopDto` | Create a new shop |
+| `CreateSkuDto` | Create a new SKU |
+| `UpdateSkuDto` | Update a SKU |
+| `CreateSalesHistoryDto` | Create sales history entry |
+| `UpdateSalesHistoryDto` | Update sales history |
+| `CreateRoleDto` | Create a new role |
+| `CreateApiKeyDto` | Create a new API key |
+| `CreateUserRoleDto` | Assign role to user |
+| `ImportSkuItem` | SKU item for bulk import |
+| `ImportSalesHistoryItem` | Sales history item for bulk import |
+
+### Response Types
+
+API response structures:
+
+| Type | Description |
+|------|-------------|
+| `UserWithRolesAndTenants` | User with their roles and tenant access |
+| `UserRole` | Role assignment with role details |
+| `TenantInfo` | Tenant info with shops |
+| `ShopInfo` | Shop info with user's role |
+| `TenantWithShopAndApiKey` | Result of tenant creation with shop |
+| `ImportResult` | Bulk import result (created/updated counts) |
+| `DeleteDataResult` | Data deletion result |
+| `SkuExportItem` | SKU export format |
+| `SalesHistoryExportItem` | Sales history export format |
+
+### Query Types
+
+Request parameters:
+
+| Type | Description |
+|------|-------------|
+| `ShopContextParams` | Shop context (`tenant_id`, `shop_id`) |
+| `PeriodQuery` | Period filter (`periodFrom`, `periodTo`) |
+
+## Package Structure
+
+```
+src/
+├── entities.ts   # Core entity types
+├── dto.ts        # Data transfer objects
+├── responses.ts  # API response types
+├── query.ts      # Query parameter types
+└── index.ts      # Re-exports all types
+```
+
+## Design Principles
+
+- **Types only** - No runtime code, fully tree-shakeable
+- **Single source of truth** - Used by both API and client packages
+- **ESM** - Native ES modules with `.js` extensions

package/dist/dto.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Data Transfer Objects for create/update operations
+ */
+export interface CreateUserDto {
+    email: string;
+    name: string;
+    default_shop_id?: number;
+}
+export interface CreateTenantDto {
+    title: string;
+    owner_id?: number;
+}
+export interface CreateTenantWithShopDto {
+    tenantTitle: string;
+    shopTitle?: string;
+    userEmail: string;
+    userName: string;
+}
+export interface CreateShopDto {
+    title: string;
+    tenant_id: number;
+}
+export interface CreateSkuDto {
+    code: string;
+    title: string;
+    shop_id: number;
+    tenant_id: number;
+}
+export interface UpdateSkuDto {
+    code?: string;
+    title?: string;
+}
+export interface ImportSkuItem {
+    code: string;
+    title: string;
+}
+export interface CreateSalesHistoryDto {
+    sku_id: number;
+    shop_id: number;
+    tenant_id: number;
+    period: string;
+    quantity: number;
+}
+export interface UpdateSalesHistoryDto {
+    quantity?: number;
+}
+export interface ImportSalesHistoryItem {
+    sku_code: string;
+    period: string;
+    quantity: number;
+}
+export interface CreateApiKeyDto {
+    user_id: number;
+    key?: string;
+    name?: string;
+    expires_at?: string;
+}
+export interface CreateRoleDto {
+    name: string;
+    description?: string;
+}
+export interface CreateUserRoleDto {
+    user_id: number;
+    role_id: number;
+    tenant_id?: number;
+    shop_id?: number;
+}
+//# sourceMappingURL=dto.d.ts.map

package/dist/dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dto.d.ts","sourceRoot":"","sources":["../src/dto.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/dto.js

@@ -0,0 +1,4 @@
+/**
+ * Data Transfer Objects for create/update operations
+ */
+export {};

package/dist/entities.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Core database entities
+ */
+export interface User {
+    id: number;
+    email: string;
+    name: string;
+    default_shop_id: number | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Tenant {
+    id: number;
+    title: string;
+    owner_id: number | null;
+    created_by: number;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Shop {
+    id: number;
+    title: string;
+    tenant_id: number;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Sku {
+    id: number;
+    code: string;
+    title: string;
+    shop_id: number;
+    tenant_id: number;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface SalesHistory {
+    id: number;
+    sku_id: number;
+    shop_id: number;
+    tenant_id: number;
+    period: string;
+    quantity: number;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Role {
+    id: number;
+    name: string;
+    description: string | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface ApiKey {
+    id: number;
+    user_id: number;
+    key: string;
+    name: string | null;
+    expires_at: Date | null;
+    last_used_at: Date | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Marketplace {
+    id: string;
+    title: string;
+    created_at: Date;
+    updated_at: Date;
+}
+//# sourceMappingURL=entities.d.ts.map

package/dist/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../src/entities.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,GAAG;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CAClB"}

package/dist/entities.js

@@ -0,0 +1,4 @@
+/**
+ * Core database entities
+ */
+export {};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './entities.js';
+export * from './dto.js';
+export * from './responses.js';
+export * from './query.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,eAAe,CAAC;AAG9B,cAAc,UAAU,CAAC;AAGzB,cAAc,gBAAgB,CAAC;AAG/B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+// Entities
+export * from './entities.js';
+// DTOs
+export * from './dto.js';
+// Response types
+export * from './responses.js';
+// Query types
+export * from './query.js';

package/dist/query.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Query parameter types
+ */
+export interface ShopContextParams {
+    shop_id: number;
+    tenant_id: number;
+    [key: string]: string | number | undefined;
+}
+export interface PeriodQuery {
+    period_from?: string;
+    period_to?: string;
+}
+//# sourceMappingURL=query.d.ts.map

package/dist/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CAC5C;AAED,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/query.js

@@ -0,0 +1,4 @@
+/**
+ * Query parameter types
+ */
+export {};

package/dist/responses.d.ts

@@ -0,0 +1,60 @@
+/**
+ * API response types
+ */
+import type { Tenant, User } from './entities.js';
+export interface UserRole {
+    id: number;
+    role_name: string;
+    tenant_id: number | null;
+    tenant_title: string | null;
+    shop_id: number | null;
+    shop_title: string | null;
+}
+export interface ShopInfo {
+    id: number;
+    title: string;
+}
+export interface TenantInfo {
+    id: number;
+    title: string;
+    is_owner: boolean;
+    shops: ShopInfo[];
+}
+export interface UserWithRolesAndTenants extends User {
+    roles: UserRole[];
+    tenants: TenantInfo[];
+}
+export interface TenantWithShopAndApiKey {
+    tenant: Tenant;
+    shop: {
+        id: number;
+        title: string;
+        tenant_id: number;
+    };
+    user: {
+        id: number;
+        email: string;
+        name: string;
+    };
+    apiKey: string;
+}
+export interface ImportResult {
+    created: number;
+    updated: number;
+    skus_created?: number;
+    errors: string[];
+}
+export interface DeleteDataResult {
+    skusDeleted: number;
+    salesHistoryDeleted: number;
+}
+export interface SalesHistoryExportItem {
+    sku_code: string;
+    period: string;
+    quantity: number;
+}
+export interface SkuExportItem {
+    code: string;
+    title: string;
+}
+//# sourceMappingURL=responses.d.ts.map

package/dist/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../src/responses.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAElD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,uBAAwB,SAAQ,IAAI;IACnD,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf"}

package/dist/responses.js

@@ -0,0 +1,4 @@
+/**
+ * API response types
+ */
+export {};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@sales-planner/shared",
+  "version": "0.1.0",
+  "description": "Shared types and DTOs for Sales Planner API",
+  "author": "Damir Manapov",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3"
+  }
+}