@dalmore/api-contracts 0.0.0-dev.0800e07

package/common/types/reports.types.d.ts

@@ -0,0 +1,345 @@
+import { z } from 'zod';
+export declare enum ReportType {
+    COMPLIANCE_OFFICER_REPORT = "COMPLIANCE_OFFICER_REPORT",
+    OFFERING_REPORT = "OFFERING_REPORT"
+}
+export declare const ComplianceOfficerReportFiltersZod: z.ZodObject<{
+    search: z.ZodOptional<z.ZodString>;
+    complianceOfficerIds: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+    /**
+     * Optional date range filter on when the trade was reviewed.
+     */
+    from: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+    to: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodString>, string | null, string | null>, Date | null, string | null>>;
+}, "strip", z.ZodTypeAny, {
+    complianceOfficerIds: string[];
+    from?: Date | null | undefined;
+    to?: Date | null | undefined;
+    search?: string | undefined;
+}, {
+    from?: string | null | undefined;
+    to?: string | null | undefined;
+    search?: string | undefined;
+    complianceOfficerIds?: string | undefined;
+}>;
+export type ComplianceOfficerReportFiltersZod = z.infer<typeof ComplianceOfficerReportFiltersZod>;
+export declare const IComplianceOfficerReportRow: z.ZodObject<{
+    complianceOfficerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    complianceOfficerName: z.ZodString;
+    accountCount: z.ZodNumber;
+    issuerCount: z.ZodNumber;
+    offeringCount: z.ZodNumber;
+    approvedTradesCount: z.ZodNumber;
+    rejectedTradesCount: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    complianceOfficerId: string;
+    complianceOfficerName: string;
+    accountCount: number;
+    issuerCount: number;
+    offeringCount: number;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+}, {
+    complianceOfficerId: string;
+    complianceOfficerName: string;
+    accountCount: number;
+    issuerCount: number;
+    offeringCount: number;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+}>;
+export type IComplianceOfficerReportRow = z.infer<typeof IComplianceOfficerReportRow>;
+export declare const IComplianceOfficerReportDetailRow: z.ZodObject<{
+    accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    accountName: z.ZodString;
+    issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    issuerName: z.ZodString;
+    offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    offeringName: z.ZodString;
+    approvedTradesCount: z.ZodNumber;
+    rejectedTradesCount: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    accountId: string;
+    accountName: string;
+    offeringId: string;
+    issuerId: string;
+    issuerName: string;
+    offeringName: string;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+}, {
+    accountId: string;
+    accountName: string;
+    offeringId: string;
+    issuerId: string;
+    issuerName: string;
+    offeringName: string;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+}>;
+export type IComplianceOfficerReportDetailRow = z.infer<typeof IComplianceOfficerReportDetailRow>;
+export declare const IComplianceOfficerReportRowWithDetails: z.ZodObject<{
+    complianceOfficerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+    complianceOfficerName: z.ZodString;
+    accountCount: z.ZodNumber;
+    issuerCount: z.ZodNumber;
+    offeringCount: z.ZodNumber;
+    approvedTradesCount: z.ZodNumber;
+    rejectedTradesCount: z.ZodNumber;
+} & {
+    rows: z.ZodArray<z.ZodObject<{
+        accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        accountName: z.ZodString;
+        issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        issuerName: z.ZodString;
+        offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        offeringName: z.ZodString;
+        approvedTradesCount: z.ZodNumber;
+        rejectedTradesCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        accountId: string;
+        accountName: string;
+        offeringId: string;
+        issuerId: string;
+        issuerName: string;
+        offeringName: string;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+    }, {
+        accountId: string;
+        accountName: string;
+        offeringId: string;
+        issuerId: string;
+        issuerName: string;
+        offeringName: string;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    complianceOfficerId: string;
+    complianceOfficerName: string;
+    accountCount: number;
+    issuerCount: number;
+    offeringCount: number;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+    rows: {
+        accountId: string;
+        accountName: string;
+        offeringId: string;
+        issuerId: string;
+        issuerName: string;
+        offeringName: string;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+    }[];
+}, {
+    complianceOfficerId: string;
+    complianceOfficerName: string;
+    accountCount: number;
+    issuerCount: number;
+    offeringCount: number;
+    approvedTradesCount: number;
+    rejectedTradesCount: number;
+    rows: {
+        accountId: string;
+        accountName: string;
+        offeringId: string;
+        issuerId: string;
+        issuerName: string;
+        offeringName: string;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+    }[];
+}>;
+export type IComplianceOfficerReportRowWithDetails = z.infer<typeof IComplianceOfficerReportRowWithDetails>;
+export declare const IReportSummary: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof ReportType>;
+    count: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: ReportType;
+    count: number;
+}, {
+    type: ReportType;
+    count: number;
+}>;
+export type IReportSummary = z.infer<typeof IReportSummary>;
+export declare const IPaginatedComplianceOfficerReport: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        complianceOfficerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+        complianceOfficerName: z.ZodString;
+        accountCount: z.ZodNumber;
+        issuerCount: z.ZodNumber;
+        offeringCount: z.ZodNumber;
+        approvedTradesCount: z.ZodNumber;
+        rejectedTradesCount: z.ZodNumber;
+    } & {
+        rows: z.ZodArray<z.ZodObject<{
+            accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+            accountName: z.ZodString;
+            issuerId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+            issuerName: z.ZodString;
+            offeringId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
+            offeringName: z.ZodString;
+            approvedTradesCount: z.ZodNumber;
+            rejectedTradesCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }, {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        complianceOfficerId: string;
+        complianceOfficerName: string;
+        accountCount: number;
+        issuerCount: number;
+        offeringCount: number;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+        rows: {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }[];
+    }, {
+        complianceOfficerId: string;
+        complianceOfficerName: string;
+        accountCount: number;
+        issuerCount: number;
+        offeringCount: number;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+        rows: {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }[];
+    }>, "many">;
+    meta: z.ZodObject<{
+        itemCount: z.ZodNumber;
+        totalItems: z.ZodOptional<z.ZodNumber>;
+        itemsPerPage: z.ZodNumber;
+        totalPages: z.ZodOptional<z.ZodNumber>;
+        currentPage: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }, {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    items: {
+        complianceOfficerId: string;
+        complianceOfficerName: string;
+        accountCount: number;
+        issuerCount: number;
+        offeringCount: number;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+        rows: {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }[];
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}, {
+    items: {
+        complianceOfficerId: string;
+        complianceOfficerName: string;
+        accountCount: number;
+        issuerCount: number;
+        offeringCount: number;
+        approvedTradesCount: number;
+        rejectedTradesCount: number;
+        rows: {
+            accountId: string;
+            accountName: string;
+            offeringId: string;
+            issuerId: string;
+            issuerName: string;
+            offeringName: string;
+            approvedTradesCount: number;
+            rejectedTradesCount: number;
+        }[];
+    }[];
+    meta: {
+        itemCount: number;
+        itemsPerPage: number;
+        currentPage: number;
+        totalItems?: number | undefined;
+        totalPages?: number | undefined;
+    };
+}>;
+export type IPaginatedComplianceOfficerReport = z.infer<typeof IPaginatedComplianceOfficerReport>;
+/** Common filter parameters for compliance officer queries */
+export interface ComplianceOfficerFilterParams {
+    fromDate: Date | null;
+    toDate: Date | null;
+    search: string | undefined;
+    complianceOfficerIds: string[];
+}
+/** Raw row type from compliance officer aggregate query */
+export interface ComplianceOfficerAggregateRow {
+    compliance_officer_id: string;
+    compliance_officer_name: string;
+    account_count: string | number;
+    issuer_count: string | number;
+    offering_count: string | number;
+    approved_trades_count: string | number;
+    rejected_trades_count: string | number;
+}
+/** Raw row type from compliance officer detail query */
+export interface ComplianceOfficerDetailQueryRow {
+    compliance_officer_id: string;
+    account_id: string | null;
+    account_name: string | null;
+    issuer_id: string | null;
+    issuer_name: string | null;
+    offering_id: string | null;
+    offering_name: string | null;
+    approved_trades_count: string | number;
+    rejected_trades_count: string | number;
+}

package/common/types/reports.types.js

@@ -0,0 +1,69 @@
+import { extendZodWithOpenApi } from '@anatine/zod-openapi';
+import { z } from 'zod';
+import { accountIdSchema } from './account.types.js';
+import { dateSchema, IPaginationMeta } from './common.types.js';
+import { issuerIdSchema } from './issuer.types.js';
+import { offeringIdSchema } from './offering.types.js';
+import { userIdSchema } from './user.types.js';
+extendZodWithOpenApi(z);
+export var ReportType;
+(function (ReportType) {
+    ReportType["COMPLIANCE_OFFICER_REPORT"] = "COMPLIANCE_OFFICER_REPORT";
+    ReportType["OFFERING_REPORT"] = "OFFERING_REPORT";
+})(ReportType || (ReportType = {}));
+export const ComplianceOfficerReportFiltersZod = z.object({
+    search: z.string().trim().max(50).optional(),
+    complianceOfficerIds: z
+        .string()
+        .optional()
+        .transform((value) => {
+        if (!value) {
+            return [];
+        }
+        const ids = value.split(',').map((id) => id.trim());
+        return Array.from(new Set(ids));
+    })
+        .refine((value) => {
+        if (!value || value.length === 0)
+            return true;
+        return value.every((id) => userIdSchema.safeParse(id).success);
+    }, {
+        message: 'Invalid compliance officer IDs. Must be a valid user ID. Example: user_01j6aqmtfyfwy9spjdcnh7yqk7',
+    }),
+    /**
+     * Optional date range filter on when the trade was reviewed.
+     */
+    from: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
+    to: dateSchema.optional().openapi({ example: 'MM/DD/YYYY' }),
+});
+export const IComplianceOfficerReportRow = z.object({
+    complianceOfficerId: z.lazy(() => userIdSchema),
+    complianceOfficerName: z.string(),
+    accountCount: z.number(),
+    issuerCount: z.number(),
+    offeringCount: z.number(),
+    approvedTradesCount: z.number(),
+    rejectedTradesCount: z.number(),
+});
+export const IComplianceOfficerReportDetailRow = z.object({
+    accountId: z.lazy(() => accountIdSchema),
+    accountName: z.string(),
+    issuerId: z.lazy(() => issuerIdSchema),
+    issuerName: z.string(),
+    offeringId: z.lazy(() => offeringIdSchema),
+    offeringName: z.string(),
+    approvedTradesCount: z.number(),
+    rejectedTradesCount: z.number(),
+});
+export const IComplianceOfficerReportRowWithDetails = IComplianceOfficerReportRow.extend({
+    rows: z.array(IComplianceOfficerReportDetailRow),
+});
+export const IReportSummary = z.object({
+    type: z.nativeEnum(ReportType),
+    count: z.number(),
+});
+export const IPaginatedComplianceOfficerReport = z.object({
+    items: z.array(IComplianceOfficerReportRowWithDetails),
+    meta: IPaginationMeta,
+});
+//# sourceMappingURL=reports.types.js.map

package/common/types/reports.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.types.js","sourceRoot":"","sources":["reports.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAExB,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qEAAuD,CAAA;IACvD,iDAAmC,CAAA;AACrC,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;QACnB,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,CAAC,CAAC;SACD,MAAM,CACL,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC9C,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC,EACD;QACE,OAAO,EACL,mGAAmG;KACtG,CACF;IACH;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;IAC9D,EAAE,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;CAC7D,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;IAC/C,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE;IACjC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;CAChC,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC;IACxC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC;IACtC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC;IAC1C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;CAChC,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,sCAAsC,GACjD,2BAA2B,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,iCAAiC,CAAC;CACjD,CAAC,CAAC;AAML,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,sCAAsC,CAAC;IACtD,IAAI,EAAE,eAAe;CACtB,CAAC,CAAC"}