@de./types 1.0.0

package/src/index.ts

@@ -0,0 +1,48 @@
+// ─── @de./types ───────────────────────────────────────────────────────────────
+//
+// Shared domain types for the De. platform.
+//
+// Consuming projects:
+//   • de.arch, de.auth, de.iotb — import schemas for runtime validation
+//       import { RTLocationSchema, type RTLocation } from '@de./types'
+//
+//   • de.sdk, de.sdk-rn — import TS types only (TypeBox tree-shaken away)
+//       import type { RTLocation, OrderPackage } from '@de./types'
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+// ─── Base / primitive layer ───────────────────────────────────────────────────
+
+export * from './time'
+export * from './measure'
+export * from './geo'
+export * from './billing'
+export * from './entity'
+export * from './context'
+export * from './user'
+export * from './auth'
+export * from './api'
+export * from './faq'
+export * from './order'
+export * from './routing'
+export * from './events'
+
+// ─── Cross-service domain types ───────────────────────────────────────────────
+
+export * from './service'
+export * from './bucket'
+export * from './inventory'
+export * from './operator'
+export * from './sync'
+export * from './de.profile'
+
+// ─── Service-specific types ───────────────────────────────────────────────────
+
+export * from './lsp'
+export * from './csp'
+export * from './iotsp'
+export * from './dev'
+export * from './aux'
+export * from './workspace'
+export * from './realm'
+export * from './shared'

package/src/inventory.ts

@@ -0,0 +1,405 @@
+import { Type, Static } from '@sinclair/typebox'
+import { ContextSchema } from './context'
+import { CSPServiceContextSchema } from './csp/base'
+import { LSPServiceContextSchema } from './lsp'
+import { ActionRecordSchema, DateTimeZoneSchema } from './time'
+import { MoneySchema } from './measure'
+import { SyncAlertSeveritySchema, SyncAlertTypeSchema, SyncConflictSchema, SyncDirectionSchema, SyncStatusSchema } from './sync'
+
+// Inventory Item Status Schema (Shared)
+export const InventoryItemStatusSchema = Type.Union([
+  Type.Literal('AVAILABLE'),
+  Type.Literal('RESERVED'),
+  Type.Literal('DAMAGED'),
+  Type.Literal('EXPIRED'),
+  Type.Literal('IN_TRANSIT'),
+  Type.Literal('QUARANTINED')
+])
+
+// Inventory Item Condition Schema (Shared)
+export const InventoryItemConditionSchema = Type.Union([
+  Type.Literal('NEW'),
+  Type.Literal('USED'),
+  Type.Literal('REFURBISHED'),
+  Type.Literal('DAMAGED')
+])
+
+// Inventory Discrepancy Schema
+export const InventoryDiscrepancySchema = Type.Object({
+  id: Type.String(),
+  expectedQuantity: Type.Number({ minimum: 0 }),
+  actualQuantity: Type.Number({ minimum: 0 }),
+  variance: Type.Number(),
+  detected: ActionRecordSchema,
+  reason: Type.Optional(Type.String({ maxLength: 500 })),
+  isResolved: Type.Boolean(),
+  resolved: Type.Optional(ActionRecordSchema)
+})
+
+// Inventory Alert Schema
+export const InventoryAlertSchema = Type.Object({
+  id: Type.String(),
+  type: SyncAlertTypeSchema,
+  severity: SyncAlertSeveritySchema,
+  message: Type.String({ maxLength: 1000 }),
+  triggered: ActionRecordSchema,
+  acknowledged: Type.Optional(ActionRecordSchema),
+  autoResolved: Type.Optional(Type.Boolean())
+})
+
+// Inventory Item Schema
+export const InventoryItemProductSchema = Type.Object({
+  id: Type.String({ description: 'Universal product ID' }),
+  sku: Type.String({ description: 'Master SKU' }),
+  internalId: Type.Optional(Type.String({ description: "RSP's internal product ID" })),
+  internalSku: Type.Optional(Type.String({ description: "RSP's SKU if different" })),
+  name: Type.String({ description: 'Cached product name for quick access' }),
+  lastSynced: Type.Optional(ActionRecordSchema),
+  catalogSyncStatus: SyncStatusSchema,
+  syncConflicts: Type.Optional(Type.Array(SyncConflictSchema))
+})
+export const InventoryItemQuantitySchema = Type.Object({
+  total: Type.Number({ minimum: 0 }),
+  available: Type.Number({ minimum: 0 }),
+  reserved: Type.Optional(Type.Number({ minimum: 0 })),
+  onOrder: Type.Optional(Type.Number({ 
+    minimum: 0,
+    description: 'Quantity on order/in transit'
+  })),
+  damaged: Type.Optional(Type.Number({ minimum: 0 })),
+  expired: Type.Optional(Type.Number({ minimum: 0 }))
+})
+export const InventoryItemSchema = Type.Object({
+  id: Type.String(),
+  slot: Type.String({ description: 'String address of the slot location' }),
+  client: CSPServiceContextSchema,
+  product: InventoryItemProductSchema,
+  quantity: InventoryItemQuantitySchema,
+  lotNumber: Type.Optional(Type.String()),
+  serialNumbers: Type.Optional(Type.Array(Type.String())),
+  batchId: Type.Optional(Type.String()),
+  dates: Type.Object({
+    manufacturing: Type.Optional(DateTimeZoneSchema),
+    expiration: Type.Optional(DateTimeZoneSchema)
+  }),
+  status: InventoryItemStatusSchema,
+  condition: InventoryItemConditionSchema,
+  cost: Type.Optional(MoneySchema),
+  lastCountDate: Type.Optional(DateTimeZoneSchema),
+  cycleCountDue: Type.Optional(Type.Boolean()),
+  discrepancyHistory: Type.Optional(Type.Array(InventoryDiscrepancySchema)),
+  customsInfo: Type.Optional(Type.Object({
+    hsCode: Type.String(),
+    value: MoneySchema,
+    description: Type.String({ maxLength: 500 }),
+    originCountry: Type.String({ 
+      minLength: 2, 
+      maxLength: 2,
+      description: 'ISO 3166-1 alpha-2 country code'
+    })
+  })),
+  notes: Type.Optional(Type.String({ maxLength: 2000 })),
+  alerts: Type.Optional(Type.Array(InventoryAlertSchema)),
+  received: ActionRecordSchema,
+  updated: Type.Optional(ActionRecordSchema)
+})
+
+// Inventory Transaction Schema
+export const InventoryTransactionTypeSchema = Type.Union([
+  Type.Literal('RECEIVING'),
+  Type.Literal('ADJUSTMENT'),
+  Type.Literal('PICK'),
+  Type.Literal('PUTAWAY'),
+  Type.Literal('TRANSFER'),
+  Type.Literal('RETURN'),
+  Type.Literal('DAMAGE'),
+  Type.Literal('CYCLE_COUNT'),
+  Type.Literal('SCRAP'),
+  Type.Literal('CATALOG_SYNC'),
+  Type.Literal('PRODUCT_UPDATE'),
+  Type.Literal('SKU_MAPPING'),
+  Type.Literal('STOCK_ALERT')
+])
+export const InventoryTransactionSchema = Type.Object({
+  id: Type.String(),
+  type: InventoryTransactionTypeSchema,
+  productId: Type.String(),
+  slot: Type.String({ description: 'String address of the slot location' }),
+  quantity: Type.Number(),
+  lotNumber: Type.Optional(Type.String()),
+  serialNumbers: Type.Optional(Type.Array(Type.String())),
+  batchId: Type.Optional(Type.String()),
+  reference: Type.Optional(Type.Object({
+    id: Type.String(),
+    type: Type.Optional(Type.Union([
+      Type.Literal('ORDER'),
+      Type.Literal('TRANSFER'),
+      Type.Literal('RETURN'),
+      Type.Literal('SYNC'),
+      Type.Literal('ADJUSTMENT')
+    ])),
+    reason: Type.Optional(Type.String({ maxLength: 500 }))
+  })),
+  syncContext: Type.Optional(Type.Object({
+    client: CSPServiceContextSchema,
+    orderId: Type.Optional(Type.String()),
+    syncBatchId: Type.Optional(Type.String()),
+    triggered: ActionRecordSchema
+  })),
+  isVerified: Type.Optional(Type.Boolean()),
+  verified: Type.Optional(ActionRecordSchema),
+  notes: Type.Optional(Type.String({ maxLength: 1000 })),
+  performed: ActionRecordSchema
+})
+
+// Generate TypeScript types from schemas
+export type InventoryDiscrepancy = Static<typeof InventoryDiscrepancySchema>
+export type InventoryAlert = Static<typeof InventoryAlertSchema>
+export type InventoryItem = Static<typeof InventoryItemSchema>
+export type InventoryItemStatus = Static<typeof InventoryItemStatusSchema>
+export type InventoryItemCondition = Static<typeof InventoryItemConditionSchema>
+export type InventoryTransactionType = Static<typeof InventoryTransactionTypeSchema>
+export type InventoryTransaction = Static<typeof InventoryTransactionSchema>
+
+// ─── Request Validation Schemas ───────────────────────────────────────────────
+
+import {
+	APIErrorSchema,
+	APIHeadersSchema,
+	APIResponseBaseSchema,
+	APIResponseDataSchemaFactory
+} from './api'
+
+export const LSPInventoryCreateRVS = {
+	headers:  APIHeadersSchema,
+	body:     Type.Omit(InventoryItemSchema, ['id', 'created', 'updated']),
+	response: {
+		201:   APIResponseDataSchemaFactory({ itemId: Type.String() }),
+		'4XX': APIErrorSchema
+	}
+}
+
+export const LSPInventoryUpdateRVS = {
+	headers:  APIHeadersSchema,
+	params:   Type.Object({ itemId: Type.String() }),
+	body:     Type.Partial(Type.Omit(InventoryItemSchema, ['id', 'created', 'updated'])),
+	response: {
+		200:   APIResponseDataSchemaFactory({ item: InventoryItemSchema }),
+		'4XX': APIErrorSchema
+	}
+}
+
+export const LSPInventoryRetrieveRVS = {
+	headers:  APIHeadersSchema,
+	params:   Type.Object({ itemId: Type.String() }),
+	response: {
+		200:   APIResponseDataSchemaFactory({ item: InventoryItemSchema }),
+		'4XX': APIErrorSchema
+	}
+}
+
+export const LSPInventoryFetchRVS = {
+	headers:     APIHeadersSchema,
+	querystring: Type.Object({
+		status:     Type.Optional(Type.String()),
+		locationId: Type.Optional(Type.String()),
+		productId:  Type.Optional(Type.String()),
+		limit:      Type.Optional(Type.Number()),
+		offset:     Type.Optional(Type.Number())
+	}),
+	response: {
+		200:   APIResponseDataSchemaFactory({ items: Type.Array(InventoryItemSchema), total: Type.Number() }),
+		'4XX': APIErrorSchema
+	}
+}
+
+export const LSPInventoryRemoveRVS = {
+	headers:  APIHeadersSchema,
+	params:   Type.Object({ itemId: Type.String() }),
+	response: {
+		200:   APIResponseBaseSchema,
+		'4XX': APIErrorSchema
+	}
+}
+
+export const LSPInventoryAdjustRVS = {
+	headers:  APIHeadersSchema,
+	params:   Type.Object({ itemId: Type.String() }),
+	body:     Type.Object({
+		quantity: Type.Number(),
+		reason:   Type.Optional(Type.String()),
+		notes:    Type.Optional(Type.String())
+	}),
+	response: {
+		200:   APIResponseDataSchemaFactory({ item: InventoryItemSchema, transaction: InventoryTransactionSchema }),
+		'4XX': APIErrorSchema
+	}
+}
+
+export type LSPInventoryCreateValidation   = { body: Static<typeof LSPInventoryCreateRVS.body>, response: Static<(typeof LSPInventoryCreateRVS.response)[201]> }
+export type LSPInventoryUpdateValidation   = { params: Static<typeof LSPInventoryUpdateRVS.params>, body: Static<typeof LSPInventoryUpdateRVS.body>, response: Static<(typeof LSPInventoryUpdateRVS.response)[200]> }
+export type LSPInventoryRetrieveValidation = { params: Static<typeof LSPInventoryRetrieveRVS.params>, response: Static<(typeof LSPInventoryRetrieveRVS.response)[200]> }
+export type LSPInventoryFetchValidation    = { querystring: Static<typeof LSPInventoryFetchRVS.querystring>, response: Static<(typeof LSPInventoryFetchRVS.response)[200]> }
+export type LSPInventoryRemoveValidation   = { params: Static<typeof LSPInventoryRemoveRVS.params>, response: Static<(typeof LSPInventoryRemoveRVS.response)[200]> }
+export type LSPInventoryAdjustValidation   = { params: Static<typeof LSPInventoryAdjustRVS.params>, body: Static<typeof LSPInventoryAdjustRVS.body>, response: Static<(typeof LSPInventoryAdjustRVS.response)[200]> }
+
+// Inventory Reservation Schema
+export const InventoryReservationSchema = Type.Object({
+  id: Type.String(),
+  orderId: Type.String(),
+  items: Type.Array(Type.Object({
+    productId: Type.String(),
+    sku: Type.String(),
+    quantity: Type.Number({ minimum: 1 })
+  })),
+  expiry: Type.Optional(DateTimeZoneSchema),
+  created: ActionRecordSchema,
+  released: Type.Optional(ActionRecordSchema)
+})
+
+// Inventory Sync Request Schema
+export const InventorySyncRequestSchema = Type.Object({
+  direction: SyncDirectionSchema,
+  targetProvider: Type.Optional(LSPServiceContextSchema),
+  items: Type.Optional(Type.Array(Type.Object({
+    productId: Type.String(),
+    sku: Type.Optional(Type.String())
+  }))),
+  fullSync: Type.Optional(Type.Boolean())
+})
+
+// Inventory Sync Log Schema
+export const InventorySyncLogSchema = Type.Object({
+  id: Type.String(),
+  direction: SyncDirectionSchema,
+  provider: Type.Union([ContextSchema, LSPServiceContextSchema]),
+  status: SyncStatusSchema,
+  itemsProcessed: Type.Number({ minimum: 0 }),
+  itemsFailed: Type.Number({ minimum: 0 }),
+  errors: Type.Optional(Type.Array(Type.String())),
+  conflicts: Type.Optional(Type.Array(Type.Any())),
+  errorLog: Type.Optional(Type.Array(Type.Object({
+    productId: Type.String(),
+    sku: Type.String(),
+    error: Type.String()
+  }))),
+  started: ActionRecordSchema,
+  completed: Type.Optional(ActionRecordSchema)
+})
+
+// Inventory Availability Request & Response Schema
+export const InventoryAvailabilityRequestSchema = Type.Object({
+  items: Type.Array(Type.Object({
+    productId: Type.String(),
+    sku: Type.String(),
+    quantity: Type.Number({ minimum: 1 })
+  }))
+})
+
+export type InventoryReservation = Static<typeof InventoryReservationSchema>
+export type InventorySyncRequest = Static<typeof InventorySyncRequestSchema>
+export type InventorySyncLog = Static<typeof InventorySyncLogSchema>
+export type InventoryAvailabilityRequest = Static<typeof InventoryAvailabilityRequestSchema>
+
+// Inventory utility schemas for inventory management
+export const InventoryQuerySchema = Type.Object({
+  workspaceId: Type.Optional(Type.String()),
+  clientId: Type.Optional(Type.String()),
+  productId: Type.Optional(Type.String()),
+  sku: Type.Optional(Type.String()),
+  slot: Type.Optional(Type.String()),
+  status: Type.Optional(Type.Array(InventoryItemStatusSchema)),
+  condition: Type.Optional(Type.Array(InventoryItemConditionSchema)),
+  hasStock: Type.Optional(Type.Boolean()),
+  cycleCountDue: Type.Optional(Type.Boolean()),
+  expiryRange: Type.Optional(Type.Object({
+    from: Type.Optional(DateTimeZoneSchema),
+    to: Type.Optional(DateTimeZoneSchema)
+  })),
+  lotNumber: Type.Optional(Type.String()),
+  batchId: Type.Optional(Type.String()),
+  limit: Type.Optional(Type.Number({ minimum: 1, maximum: 1000 })),
+  offset: Type.Optional(Type.Number({ minimum: 0 }))
+})
+
+export const InventoryStatsSchema = Type.Object({
+  workspaceId: Type.String(),
+  totalItems: Type.Number({ minimum: 0 }),
+  totalQuantity: Type.Number({ minimum: 0 }),
+  totalValue: Type.Optional(MoneySchema),
+  byStatus: Type.Record(InventoryItemStatusSchema, Type.Number({ minimum: 0 })),
+  byCondition: Type.Record(InventoryItemConditionSchema, Type.Number({ minimum: 0 })),
+  lowStock: Type.Number({ minimum: 0, description: 'Items below reorder point' }),
+  expiringItems: Type.Number({ minimum: 0, description: 'Items expiring within 30 days' }),
+  cycleCountDue: Type.Number({ minimum: 0 }),
+  discrepancies: Type.Number({ minimum: 0, description: 'Unresolved discrepancies' }),
+  turnoverRate: Type.Optional(Type.Number({ minimum: 0, description: 'Inventory turnover rate' })),
+  accuracy: Type.Optional(Type.Number({ minimum: 0, maximum: 100, description: 'Inventory accuracy percentage' }))
+})
+
+export const InventoryMovementSchema = Type.Object({
+  id: Type.String(),
+  productId: Type.String(),
+  fromSlot: Type.Optional(Type.String()),
+  toSlot: Type.String(),
+  quantity: Type.Number({ minimum: 1 }),
+  reason: Type.Union([
+    Type.Literal('OPTIMIZATION'),
+    Type.Literal('DAMAGE'),
+    Type.Literal('EXPIRY'),
+    Type.Literal('CONSOLIDATION'),
+    Type.Literal('REPLENISHMENT'),
+    Type.Literal('MANUAL')
+  ]),
+  movementType: Type.Union([
+    Type.Literal('PUTAWAY'),
+    Type.Literal('PICK'),
+    Type.Literal('REPLENISHMENT'),
+    Type.Literal('RELOCATION'),
+    Type.Literal('TRANSFER')
+  ]),
+  priority: Type.Union([
+    Type.Literal('LOW'),
+    Type.Literal('NORMAL'),
+    Type.Literal('HIGH'),
+    Type.Literal('URGENT')
+  ]),
+  assignedTo: Type.Optional(Type.String()),
+  scheduledAt: Type.Optional(DateTimeZoneSchema),
+  startedAt: Type.Optional(DateTimeZoneSchema),
+  completedAt: Type.Optional(DateTimeZoneSchema),
+  status: Type.Union([
+    Type.Literal('PENDING'),
+    Type.Literal('ASSIGNED'),
+    Type.Literal('IN_PROGRESS'),
+    Type.Literal('COMPLETED'),
+    Type.Literal('CANCELLED')
+  ]),
+  notes: Type.Optional(Type.String({ maxLength: 500 })),
+  created: ActionRecordSchema,
+  updated: Type.Optional(ActionRecordSchema)
+})
+
+export const InventoryValuationSchema = Type.Object({
+  workspaceId: Type.String(),
+  calculationMethod: Type.Union([
+    Type.Literal('FIFO'),
+    Type.Literal('LIFO'),
+    Type.Literal('AVERAGE_COST'),
+    Type.Literal('STANDARD_COST')
+  ]),
+  totalValue: MoneySchema,
+  totalUnits: Type.Number({ minimum: 0 }),
+  averageUnitCost: MoneySchema,
+  byCategory: Type.Optional(Type.Record(Type.String(), Type.Object({
+    value: MoneySchema,
+    units: Type.Number({ minimum: 0 }),
+    avgCost: MoneySchema
+  }))),
+  calculated: ActionRecordSchema
+})
+
+export type InventoryQuery = Static<typeof InventoryQuerySchema>
+export type InventoryStats = Static<typeof InventoryStatsSchema>
+export type InventoryMovement = Static<typeof InventoryMovementSchema>
+export type InventoryValuation = Static<typeof InventoryValuationSchema>

package/src/invoice.ts

@@ -0,0 +1,37 @@
+import { Type, Static } from '@sinclair/typebox'
+
+// ─── Service cost ─────────────────────────────────────────────────────────────
+
+export const ServiceCostSchema = Type.Object({
+	description:  Type.String(),
+	per:          Type.Union([Type.Literal('mb'), Type.Literal('day'), Type.Literal('quota')]),
+	unit:         Type.Number(),
+	costPerUnit:  Type.Number(),
+	currency:     Type.Object({
+		code:   Type.String(),
+		name:   Type.String(),
+		symbol: Type.String()
+	})
+})
+export const BillingItemSchema = Type.Composite([
+	ServiceCostSchema,
+	Type.Object({ usage: Type.Number() })
+])
+export const BillingSchema = Type.Object({
+	id:     Type.String(),
+	nsp:    Type.String(),
+	status: Type.Union([
+		Type.Literal('CURRENT'),
+		Type.Literal('DUE'),
+		Type.Literal('OVERDUE'),
+		Type.Literal('SETTLED')
+	]),
+	items: Type.Record(Type.String(), BillingItemSchema),
+	due:   Type.Number()
+})
+
+// ─── TypeScript types ─────────────────────────────────────────────────────────
+
+export type ServiceCost  = Static<typeof ServiceCostSchema>
+export type BillingItem  = Static<typeof BillingItemSchema>
+export type Billing      = Static<typeof BillingSchema>