@discover-cloud/shared 1.2.9 → 1.4.0

package/dist/dtos/insights-service.dto.d.ts

@@ -1,22 +1,12 @@
-import { CloudProvider } from "../enums";
 /**
- * INSIGHTS SERVICE DTOs  (@discover-cloud/shared)
- * ─────────────────────────────────────────────────
- * Four groups of types, each with a distinct role:
+ * @file insights-service.dto.ts
+ * @description Data transfer objects (DTOs) for cost tracking, cloud resource inventory,
+ * budgets, and aggregated analytics reports in the Insights Service.
  *
- * Push payloads   — cloud-service → insights-service (internal HTTP).
- *                   Carry raw provider data collected during a sync job.
- *
- * Record DTOs     — insights-service → frontend (public HTTP).
- *                   Stored/enriched records returned to clients.
- *                   All timestamps are ISO 8601 strings (JSON has no Date).
- *
- * Query DTO       — internal query params passed between service layers.
- *                   Never crosses an HTTP boundary — Date is fine here.
- *
- * Summary DTOs    — assembled aggregations with no corresponding domain
- *                   model or mapper. Built directly from DB query results.
+ * All push payloads and query DTOs are scoped to a workspaceId — the sole
+ * multi-tenancy discriminator. userId / organizationId have been removed.
  */
+import { CloudProvider, RecommendationCategory, RecommendationStatus, Severity, AlertStatus, ReportType, ReportStatus, ReportFormat, ResourceEventType } from '../enums';
 export interface PushCostItem {
     service: string;
     region: string;
@@ -43,27 +33,66 @@ export interface PushBudgetItem {
     forecastSpend: number;
     period: string;
 }
+export interface PushResourceEventItem {
+    resourceId: string;
+    resourceType: string;
+    eventType: ResourceEventType;
+    severity?: Severity;
+    title: string;
+    description?: string;
+    before?: Record<string, unknown>;
+    after?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    occurredAt: string;
+}
+export interface PushRecommendationItem {
+    resourceId?: string;
+    resourceType?: string;
+    category: RecommendationCategory;
+    severity?: Severity;
+    title: string;
+    description: string;
+    estimatedSaving?: number;
+    estimatedSavingCurrency?: string;
+    metadata?: Record<string, unknown>;
+    expiresAt?: string;
+}
 export interface PushCostPayload {
     cloudAccountId: string;
-    userId: string;
+    /** Workspace that owns this data — the sole tenancy scope. */
     provider: CloudProvider;
     costs: PushCostItem[];
 }
 export interface PushResourcePayload {
     cloudAccountId: string;
-    userId: string;
+    /** Workspace that owns this data — the sole tenancy scope. */
     provider: CloudProvider;
     resources: PushResourceItem[];
 }
 export interface PushBudgetPayload {
     cloudAccountId: string;
-    userId: string;
+    /** Workspace that owns this data — the sole tenancy scope. */
+    provider: CloudProvider;
     budgets: PushBudgetItem[];
 }
+/**
+ * Bundled fetch-result payload — matches the shape cloud-service's
+ * SyncOrchestrator.publishSyncData() emits on "cloud.fetch.completed".
+ * Used by the event consumer rather than a direct HTTP push.
+ */
+export interface PushResourceEventPayload {
+    cloudAccountId: string;
+    provider: CloudProvider;
+    events: PushResourceEventItem[];
+}
+export interface PushRecommendationPayload {
+    cloudAccountId: string;
+    provider: CloudProvider;
+    recommendations: PushRecommendationItem[];
+}
 export interface CostRecordDto {
     id: string;
     cloudAccountId: string;
-    userId: string;
     provider: CloudProvider;
     service: string;
     region: string;
@@ -77,7 +106,6 @@ export interface CostRecordDto {
 export interface ResourceRecordDto {
     id: string;
     cloudAccountId: string;
-    userId: string;
     provider: CloudProvider;
     resourceType: string;
     resourceId: string;
@@ -88,10 +116,23 @@ export interface ResourceRecordDto {
     metadata: Record<string, unknown>;
     recordedAt: string;
 }
+export interface LatestResourceSnapshotDto {
+    resourceId: string;
+    resourceType: string;
+    cloudAccountId: string;
+    provider: CloudProvider;
+    region: string;
+    name: string | null;
+    status: string;
+    tags: Record<string, string>;
+    metadata: Record<string, unknown>;
+    firstSeenAt: string;
+    lastSeenAt: string;
+    deletedAt: string | null;
+}
 export interface BudgetRecordDto {
     id: string;
     cloudAccountId: string;
-    userId: string;
     name: string;
     limitAmount: number;
     currency: string;
@@ -103,19 +144,129 @@ export interface BudgetRecordDto {
     isForecastOver: boolean;
     recordedAt: string;
 }
+export interface ResourceEventDto {
+    id: string;
+    cloudAccountId: string;
+    provider: CloudProvider;
+    resourceId: string;
+    resourceType: string;
+    eventType: ResourceEventType;
+    severity: Severity;
+    title: string;
+    description: string | null;
+    before: Record<string, unknown> | null;
+    after: Record<string, unknown> | null;
+    metadata: Record<string, unknown>;
+    occurredAt: string;
+    detectedAt: string;
+}
+export interface RecommendationDto {
+    id: string;
+    cloudAccountId: string;
+    provider: CloudProvider;
+    resourceId: string | null;
+    resourceType: string | null;
+    category: RecommendationCategory;
+    severity: Severity;
+    title: string;
+    description: string;
+    estimatedSaving: number | null;
+    estimatedSavingCurrency: string;
+    status: RecommendationStatus;
+    metadata: Record<string, unknown>;
+    appliedAt: string | null;
+    appliedBy: string | null;
+    dismissedAt: string | null;
+    dismissedBy: string | null;
+    expiresAt: string | null;
+    staleAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AlertDto {
+    id: string;
+    cloudAccountId: string | null;
+    provider: CloudProvider | null;
+    alertRuleId: string | null;
+    resourceId: string | null;
+    resourceType: string | null;
+    severity: Severity;
+    status: AlertStatus;
+    title: string;
+    message: string;
+    metadata: Record<string, unknown>;
+    acknowledgedAt: string | null;
+    acknowledgedBy: string | null;
+    resolvedAt: string | null;
+    resolvedBy: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ReportDto {
+    id: string;
+    cloudAccountId: string | null;
+    name: string;
+    type: ReportType;
+    format: ReportFormat;
+    status: ReportStatus;
+    filters: Record<string, unknown>;
+    storageUrl: string | null;
+    fileSizeBytes: string | null;
+    mimeType: string | null;
+    errorMessage: string | null;
+    generatedBy: string;
+    generatedAt: string | null;
+    expiresAt: string | null;
+    cleanedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ExchangeRateDto {
+    id: string;
+    fromCurrency: string;
+    toCurrency: string;
+    rate: number;
+    source: string;
+    effectiveDate: string;
+    createdAt: string;
+}
+export interface IngestionSnapshotDto {
+    id: string;
+    cloudAccountId: string;
+    syncJobId: string;
+    resourcesFound: number;
+    resourcesAdded: number;
+    resourcesUpdated: number;
+    resourcesRemoved: number;
+    costRecordsImported: number;
+    budgetsImported: number;
+    durationMs: number | null;
+    createdAt: string;
+}
+export interface BulkWriteResultDto {
+    count: number;
+}
+export interface CloudAccountPurgeResultDto {
+    cloudAccountId: string;
+    costRecords: number;
+    resourceRecords: number;
+    resourceEvents: number;
+    budgetSnapshots: number;
+    recommendations: number;
+    alerts: number;
+    reports: number;
+    ingestionSnapshots: number;
+}
 /**
- * CostQueryDto
- * Used by the insights-service query layer internally.
- * Date fields are fine here — this never reaches JSON serialisation.
- * If this ever needs to cross HTTP, convert from/to to ISO 8601 strings.
+ * Parameter model for cost queries.
+ * Scoped to a workspaceId — callers must always provide this.
  */
 export interface CostQueryDto {
-    userId?: string;
     cloudAccountId?: string;
     provider?: CloudProvider;
     from?: Date;
     to?: Date;
-    groupBy?: "service" | "region" | "provider" | "day" | "month";
+    groupBy?: 'service' | 'region' | 'provider' | 'day' | 'month';
 }
 export interface DashboardSummaryDto {
     totalSpend: number;
@@ -127,8 +278,9 @@ export interface DashboardSummaryDto {
         label: string;
         amount: number;
     }[];
-    costTrend: {
-        date: string;
-        amount: number;
-    }[];
+    costTrend: CostTrendDto[];
+}
+export interface CostTrendDto {
+    date: string;
+    amount: number;
 }

package/dist/dtos/insights-service.dto.js

@@ -1,2 +1,10 @@
 "use strict";
+/**
+ * @file insights-service.dto.ts
+ * @description Data transfer objects (DTOs) for cost tracking, cloud resource inventory,
+ * budgets, and aggregated analytics reports in the Insights Service.
+ *
+ * All push payloads and query DTOs are scoped to a workspaceId — the sole
+ * multi-tenancy discriminator. userId / organizationId have been removed.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/dtos/response.dto.d.ts

@@ -1,25 +1,6 @@
 /**
- * RESPONSE DTOs  (@discover-cloud/shared)
- * ─────────────────────────────────────────
- * Shared HTTP response shapes used across all services.
- * Every response — success or error — is wrapped in the ApiSuccessResponse
- * or ApiErrorResponse envelope so clients have a consistent shape to key on.
- *
- * Envelope shape:
- *   {
- *     success: true,
- *     data: T,
- *     meta: { requestId, timestamp }
- *   }
- *   or
- *   {
- *     success: false,
- *     error: { code, message, details? },
- *     meta: { requestId, timestamp }
- *   }
- *
- * The success() and failure() utils in shared/utils construct these
- * envelopes — don't build them manually in controllers.
+ * @file response.dto.ts
+ * @description Shared HTTP response envelopes, pagination models, and generic response contracts.
  */
 export interface ApiMeta {
     requestId: string;
@@ -39,39 +20,9 @@ export interface ApiErrorResponse {
     };
     meta: ApiMeta;
 }
-/**
- * TokensResponseDto
- * Returned on successful login or token refresh.
- *
- * accessToken  — short-lived JWT returned in the response body.
- * refreshToken — long-lived token sent as an HttpOnly cookie by the auth
- *                service; it is intentionally absent from this DTO.
- *                Mobile clients that cannot use cookies should request a
- *                separate endpoint that returns the refresh token explicitly.
- */
-export interface TokensResponseDto {
-    accessToken: string;
-}
-/**
- * MessageResponseDto
- * Use for simple confirmations where no structured data is needed.
- * Example: { message: "Email verification sent" }
- */
 export interface MessageResponseDto {
     message: string;
 }
-/**
- * ActionResponseDto
- * Use when the client needs a machine-readable signal of what happened,
- * e.g. for polling loops, event-driven UIs, or audit trails.
- *
- * action  — stable machine-readable identifier, e.g. "account.suspended"
- * message — human-readable description for display or logging
- *
- * Boolean-only DTOs (LoggedOutResponseDto, SuspendedResponseDto, etc.)
- * are intentionally collapsed into this shape — a boolean that is always
- * true on a 200 response carries no additional information.
- */
 export interface ActionResponseDto {
     action: string;
     message: string;
@@ -84,42 +35,20 @@ export interface PaginationMeta {
     hasNext: boolean;
     hasPrev: boolean;
 }
-/**
- * PaginatedResponseDto
- * Wrap paginated list results in this before passing to success().
- *
- * Usage:
- *   success<PaginatedResponseDto<CloudAccountDto>>(res, req, {
- *     items: accounts,
- *     pagination: { page, pageSize, totalItems, totalPages, hasNext, hasPrev },
- *   });
- */
 export interface PaginatedResponseDto<T> {
     items: T[];
     pagination: PaginationMeta;
 }
-/**
- * LoginResultDto
- * Internal auth service response returned after successful login.
- *
- * The optional cookie metadata allows controllers or gateways
- * to apply refresh-token cookies without coupling shared DTOs
- * to a specific HTTP framework.
- */
-export interface CookieMetadataDto {
-    httpOnly?: boolean;
-    secure?: boolean;
-    sameSite?: boolean | "strict" | "lax" | "none";
-    maxAge?: number;
-    path?: string;
-    domain?: string;
+export interface AuthTokenDto {
+    accessToken: string;
+}
+export interface MachineTokenDto {
+    accessToken: string;
+    expiresIn: number;
 }
-export interface LoginResultCookieDto {
-    name: string;
-    value: string;
-    options: CookieMetadataDto;
+export interface CountResponseDto {
+    count: number;
 }
-export interface LoginResultDto {
-    tokens: TokensResponseDto;
-    cookie?: LoginResultCookieDto;
+export interface SecretResponseDto {
+    secret: string;
 }

package/dist/dtos/response.dto.js

@@ -1,25 +1,6 @@
 "use strict";
 /**
- * RESPONSE DTOs  (@discover-cloud/shared)
- * ─────────────────────────────────────────
- * Shared HTTP response shapes used across all services.
- * Every response — success or error — is wrapped in the ApiSuccessResponse
- * or ApiErrorResponse envelope so clients have a consistent shape to key on.
- *
- * Envelope shape:
- *   {
- *     success: true,
- *     data: T,
- *     meta: { requestId, timestamp }
- *   }
- *   or
- *   {
- *     success: false,
- *     error: { code, message, details? },
- *     meta: { requestId, timestamp }
- *   }
- *
- * The success() and failure() utils in shared/utils construct these
- * envelopes — don't build them manually in controllers.
+ * @file response.dto.ts
+ * @description Shared HTTP response envelopes, pagination models, and generic response contracts.
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/dtos/user-service.dto.d.ts

@@ -1,11 +1,5 @@
-import { OrganizationRole, MembershipStatus, OrganizationStatus, Theme, Currency } from "../enums";
-/**
- * USER SERVICE DTOs  (@discover-cloud/shared)
- * ─────────────────────────────────────────────
- * Shapes returned by the user service over HTTP.
- * All timestamps are ISO 8601 strings — JSON has no Date type.
- * Domain models use Date internally; mappers convert at the boundary.
- */
+import { Currency, Theme, OrganizationStatus, MembershipStatus, WorkspaceType, RoleType, RoleCategory, RoleAssignmentStatus, InviteScopeType, InviteStatus, AlertRuleMetric, AlertRuleOperator, NotificationChannelType, ScopeType } from '../enums';
+import { PaginatedResponseDto } from './response.dto';
 export interface UserDto {
     id: string;
     email: string;
@@ -19,23 +13,27 @@ export interface UserProfileDto {
     avatarUrl: string | null;
     jobTitle: string | null;
     bio: string | null;
-    timezone: string | null;
-    locale: string;
     country: string | null;
     pronouns: string | null;
+    phoneNumber: string | null;
     createdAt: string;
     updatedAt: string;
 }
 export interface UserPreferencesDto {
     id: string;
     userId: string;
+    locale: string;
+    timezone: string;
     theme: Theme;
-    language: string;
     currency: Currency;
-    emailAlerts: boolean;
+    emailNotifications: boolean;
     createdAt: string;
     updatedAt: string;
 }
+export interface UserWithProfileDto extends UserDto {
+    profile: UserProfileDto | null;
+    preferences: UserPreferencesDto | null;
+}
 export interface OrganizationDto {
     id: string;
     name: string;
@@ -45,12 +43,164 @@ export interface OrganizationDto {
     updatedAt: string;
     deletedAt: string | null;
 }
+export interface OrganizationWithMembersCountDto extends OrganizationDto {
+    membersCount: number;
+}
 export interface OrganizationMemberDto {
     id: string;
     userId: string;
     organizationId: string;
-    role: OrganizationRole;
     status: MembershipStatus;
     createdAt: string;
     updatedAt: string;
 }
+export interface WorkspaceDto {
+    id: string;
+    name: string;
+    slug: string;
+    type: WorkspaceType;
+    organizationId: string | null;
+    ownerId: string;
+    /** JSON resource filter defining which cloud resources belong to this workspace. */
+    resourceFilter: Record<string, unknown> | null;
+    linkedToOrgAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+}
+/** Maps a Workspace to the Cloud Accounts it can access. */
+export interface WorkspaceCloudAccountDto {
+    workspaceId: string;
+    cloudAccountId: string;
+    createdAt: string;
+}
+export interface WorkspaceMemberDto {
+    id: string;
+    workspaceId: string;
+    userId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface PermissionDto {
+    id: string;
+    key: string;
+    resource: string;
+    action: string;
+    description: string | null;
+    serviceOwner: string;
+    dangerous: boolean;
+    createdAt: string;
+}
+export interface RoleDto {
+    id: string;
+    name: string;
+    type: RoleType;
+    category: RoleCategory;
+    organizationId: string | null;
+    isProtected: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface RoleWithPermissionsDto extends RoleDto {
+    permissions: PermissionDto[];
+}
+export interface WorkspaceMemberWithRolesDto {
+    member: WorkspaceMemberDto;
+    user: UserDto;
+    roles: RoleDto[];
+}
+export interface RoleAssignmentDto {
+    id: string;
+    userId: string;
+    roleId: string;
+    scopeType: string;
+    organizationId: string | null;
+    workspaceId: string | null;
+    status: RoleAssignmentStatus;
+    role?: RoleDto;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface InviteDto {
+    id: string;
+    email: string;
+    token: string;
+    userId: string | null;
+    scopeType: InviteScopeType;
+    organizationId: string | null;
+    workspaceId: string | null;
+    roleId: string;
+    status: InviteStatus;
+    invitedById: string;
+    invitedAt: string;
+    expiresAt: string;
+    acceptedAt: string | null;
+    rejectedAt: string | null;
+    revokedById: string | null;
+    revokedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProvisionUserResponseDto {
+    user: UserWithProfileDto;
+    personalWorkspace: WorkspaceDto;
+}
+export interface AlertRuleDto {
+    id: string;
+    workspaceId: string;
+    createdBy: string;
+    name: string;
+    metric: AlertRuleMetric;
+    operator: AlertRuleOperator;
+    threshold: number;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AlertRuleChannelDto {
+    id: string;
+    alertRuleId: string;
+    type: NotificationChannelType;
+    destination: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AlertRuleWithChannelsDto extends AlertRuleDto {
+    channels: AlertRuleChannelDto[];
+}
+export interface PermissionCheckDto {
+    userId: string;
+    permissionKey: string;
+    scopeType: ScopeType;
+    organizationId?: string;
+    workspaceId?: string;
+}
+export interface PermissionCheckResultDto extends PermissionCheckDto {
+    allowed: boolean;
+}
+export interface UserContextDto {
+    user: UserDto;
+    organizations: OrganizationDto[];
+    workspaces: WorkspaceDto[];
+    permissions: PermissionDto[];
+}
+export interface SecurityContextDto {
+    user: UserDto;
+    roles: RoleAssignmentDto[];
+}
+export interface MyInvitesListDto {
+    organizations: PaginatedResponseDto<InviteDto>;
+    workspaces: PaginatedResponseDto<InviteDto>;
+}
+export interface ResentInviteDto {
+    invite: InviteDto;
+    token: string;
+}
+export interface PermissionPreviewDto {
+    count: number;
+    permissions: PermissionDto[];
+}
+export interface PurgeStatsDto {
+    workspaces: number;
+    organizations: number;
+}