immortal-js 1.0.0

package/examples/invoice-service/src/types.ts

@@ -0,0 +1,193 @@
+/**
+ * @file src/types.ts
+ * @description Invoice Service Pro v3 — Complete Domain Type Definitions
+ */
+
+// ─── Currency ─────────────────────────────────────────────────────────────────
+
+export type InvoiceCurrency = "USD" | "EUR" | "GBP" | "AED" | "SAR" | "JPY" | "CAD" | "AUD";
+
+export const CURRENCY_META: Record<InvoiceCurrency, { symbol: string; locale: string; name: string }> = {
+  USD: { symbol: "$",    locale: "en-US",  name: "US Dollar"      },
+  EUR: { symbol: "€",    locale: "de-DE",  name: "Euro"           },
+  GBP: { symbol: "£",    locale: "en-GB",  name: "British Pound"  },
+  AED: { symbol: "AED",  locale: "ar-AE",  name: "UAE Dirham"     },
+  SAR: { symbol: "SAR",  locale: "ar-SA",  name: "Saudi Riyal"    },
+  JPY: { symbol: "¥",    locale: "ja-JP",  name: "Japanese Yen"   },
+  CAD: { symbol: "CA$",  locale: "en-CA",  name: "Canadian Dollar"},
+  AUD: { symbol: "A$",   locale: "en-AU",  name: "Australian Dollar"},
+};
+
+// ─── Invoice Status ────────────────────────────────────────────────────────────
+
+export type InvoiceStatus = "draft" | "sent" | "paid" | "overdue" | "cancelled" | "refunded";
+
+// ─── Core Domain Types ─────────────────────────────────────────────────────────
+
+export interface InvoiceParty {
+  name: string;
+  email: string;
+  phone?: string;
+  address: string;
+  city: string;
+  country: string;
+  taxId?: string;
+  website?: string;
+  logoUrl?: string;
+}
+
+export interface InvoiceLineItem {
+  id: string;
+  description: string;
+  quantity: number;
+  unitPrice: number;   // in cents
+  taxRate: number;     // 0–1, e.g. 0.20 = 20%
+  discount?: number;   // 0–1, e.g. 0.10 = 10% off
+  unit?: string;       // "hrs", "pcs", "mo", etc.
+}
+
+export interface InvoiceActivity {
+  id: string;
+  invoiceId: string;
+  action: "created" | "sent" | "viewed" | "paid" | "overdue" | "cancelled" | "refunded" | "status_changed" | "note_added";
+  note?: string;
+  performedAt: string;
+}
+
+export interface Invoice {
+  id: string;
+  number: string;
+  status: InvoiceStatus;
+  currency: InvoiceCurrency;
+  issuedAt: string;
+  dueAt: string;
+  paidAt?: string;
+  from: InvoiceParty;
+  to: InvoiceParty;
+  lineItems: InvoiceLineItem[];
+  notes?: string;
+  terms?: string;
+  discount?: number;    // global invoice-level discount (0–1)
+  reference?: string;   // PO number / external reference
+  tags?: string[];
+  createdAt: string;
+  updatedAt: string;
+}
+
+// ─── Computed ─────────────────────────────────────────────────────────────────
+
+export interface InvoiceTotals {
+  subtotalCents: number;
+  discountCents: number;
+  taxCents: number;
+  totalCents: number;
+  subtotal: string;
+  discount: string;
+  tax: string;
+  total: string;
+  effectiveTaxRate: string;
+}
+
+// ─── Client (separate from invoice party) ─────────────────────────────────────
+
+export interface Client {
+  id: string;
+  name: string;
+  email: string;
+  phone?: string;
+  address: string;
+  city: string;
+  country: string;
+  taxId?: string;
+  website?: string;
+  notes?: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+// ─── Analytics ────────────────────────────────────────────────────────────────
+
+export interface DashboardStats {
+  totalInvoices: number;
+  totalRevenueCents: number;
+  outstandingCents: number;
+  overdueCents: number;
+  draftCount: number;
+  sentCount: number;
+  paidCount: number;
+  overdueCount: number;
+  cancelledCount: number;
+  totalClients: number;
+  avgInvoiceCents: number;
+  revenueThisMonth: number;
+  revenueLastMonth: number;
+  invoicesByStatus: Record<InvoiceStatus, number>;
+  recentActivity: InvoiceActivity[];
+  topClients: { name: string; totalCents: number; invoiceCount: number }[];
+  monthlyRevenue: { month: string; cents: number }[];
+}
+
+// ─── API Payloads ──────────────────────────────────────────────────────────────
+
+export interface CreateInvoiceDto {
+  currency?: InvoiceCurrency;
+  issuedAt?: string;
+  dueAt?: string;
+  reference?: string;
+  from: InvoiceParty;
+  to: InvoiceParty;
+  lineItems: Omit<InvoiceLineItem, "id">[];
+  notes?: string;
+  terms?: string;
+  discount?: number;
+  tags?: string[];
+}
+
+export interface UpdateInvoiceDto {
+  status?: InvoiceStatus;
+  notes?: string;
+  terms?: string;
+  reference?: string;
+  paidAt?: string;
+  tags?: string[];
+}
+
+export interface CreateClientDto {
+  name: string;
+  email: string;
+  phone?: string;
+  address: string;
+  city: string;
+  country: string;
+  taxId?: string;
+  website?: string;
+  notes?: string;
+}
+
+export interface ApiError {
+  error: string;
+  code: string;
+  timestamp: string;
+  details?: unknown;
+}
+
+export interface PaginatedResponse<T> {
+  data: T[];
+  total: number;
+  page: number;
+  limit: number;
+  totalPages: number;
+}
+
+export interface InvoiceListQuery {
+  status?: InvoiceStatus;
+  currency?: InvoiceCurrency;
+  clientName?: string;
+  search?: string;
+  page?: number;
+  limit?: number;
+  sortBy?: "number" | "issuedAt" | "dueAt" | "total" | "status";
+  sortDir?: "asc" | "desc";
+  dateFrom?: string;
+  dateTo?: string;
+}

package/examples/invoice-service/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "lib": ["ES2022"],
+    "strict": true,
+    "strictNullChecks": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+    "noImplicitOverride": true,
+    "declaration": false,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist", "public"]
+}