@dalmore/api-contracts 0.0.0-dev.2cea8e5 → 0.0.0-dev.2fec89f

package/common/types/cap-table.types.d.ts

@@ -232,8 +232,8 @@ export declare const CreateCapTableEntryZod: z.ZodObject<{
     individualId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     legalEntityId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    numberOfShares: number;
     shareClassId: string;
+    numberOfShares: number;
     holderType: CapTableHolderType;
     holderName: string;
     allocationDate: string;
@@ -245,8 +245,8 @@ export declare const CreateCapTableEntryZod: z.ZodObject<{
     holderEmail?: string | null | undefined;
     certificateNumber?: string | null | undefined;
 }, {
-    numberOfShares: number;
     shareClassId: string;
+    numberOfShares: number;
     holderType: CapTableHolderType;
     holderName: string;
     allocationDate: string;
@@ -273,9 +273,9 @@ export declare const UpdateCapTableEntryZod: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     status?: CapTableEntryStatus | undefined;
     notes?: string | null | undefined;
+    shareClassId?: string | undefined;
     pricePerShare?: number | null | undefined;
     numberOfShares?: number | undefined;
-    shareClassId?: string | undefined;
     holderType?: CapTableHolderType | undefined;
     holderName?: string | undefined;
     holderEmail?: string | null | undefined;
@@ -284,9 +284,9 @@ export declare const UpdateCapTableEntryZod: z.ZodObject<{
 }, {
     status?: CapTableEntryStatus | undefined;
     notes?: string | null | undefined;
+    shareClassId?: string | undefined;
     pricePerShare?: number | null | undefined;
     numberOfShares?: number | undefined;
-    shareClassId?: string | undefined;
     holderType?: CapTableHolderType | undefined;
     holderName?: string | undefined;
     holderEmail?: string | null | undefined;
@@ -316,6 +316,7 @@ export declare const CapTableEntryZod: z.ZodObject<{
     investorAccountId: z.ZodNullable<z.ZodString>;
     individualId: z.ZodNullable<z.ZodString>;
     legalEntityId: z.ZodNullable<z.ZodString>;
+    tradeId: z.ZodNullable<z.ZodString>;
     signingDocumentId: z.ZodNullable<z.ZodString>;
     signingStatus: z.ZodNativeEnum<typeof CapTableSigningStatus>;
     createdByUserId: z.ZodString;
@@ -332,10 +333,11 @@ export declare const CapTableEntryZod: z.ZodObject<{
     individualId: string | null;
     legalEntityId: string | null;
     investorAccountId: string | null;
+    shareClassId: string;
     pricePerShare: number | null;
+    tradeId: string | null;
     numberOfShares: number;
     capTableId: string;
-    shareClassId: string;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
@@ -358,10 +360,11 @@ export declare const CapTableEntryZod: z.ZodObject<{
     individualId: string | null;
     legalEntityId: string | null;
     investorAccountId: string | null;
+    shareClassId: string;
     pricePerShare: number | null;
+    tradeId: string | null;
     numberOfShares: number;
     capTableId: string;
-    shareClassId: string;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
@@ -398,6 +401,7 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         investorAccountId: z.ZodNullable<z.ZodString>;
         individualId: z.ZodNullable<z.ZodString>;
         legalEntityId: z.ZodNullable<z.ZodString>;
+        tradeId: z.ZodNullable<z.ZodString>;
         signingDocumentId: z.ZodNullable<z.ZodString>;
         signingStatus: z.ZodNativeEnum<typeof CapTableSigningStatus>;
         createdByUserId: z.ZodString;
@@ -414,10 +418,11 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
+        tradeId: string | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -440,10 +445,11 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
+        tradeId: string | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -487,10 +493,11 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
+        tradeId: string | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -522,10 +529,11 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
+        tradeId: string | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -579,15 +587,15 @@ export declare const CapTableShareClassSummaryZod: z.ZodObject<{
     percentage: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
     totalShares: number;
-    totalAuthorized: number | null;
     shareClassId: string;
+    totalAuthorized: number | null;
     shareClassName: string;
     remainingAuthorized: number | null;
     percentage: number;
 }, {
     totalShares: number;
-    totalAuthorized: number | null;
     shareClassId: string;
+    totalAuthorized: number | null;
     shareClassName: string;
     remainingAuthorized: number | null;
     percentage: number;
@@ -604,15 +612,15 @@ export declare const CapTableSummaryZod: z.ZodObject<{
         percentage: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
         totalShares: number;
-        totalAuthorized: number | null;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
         remainingAuthorized: number | null;
         percentage: number;
     }, {
         totalShares: number;
-        totalAuthorized: number | null;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
         remainingAuthorized: number | null;
         percentage: number;
@@ -638,8 +646,8 @@ export declare const CapTableSummaryZod: z.ZodObject<{
     stockConversionRate: number | null;
     totalSharesByClass: {
         totalShares: number;
-        totalAuthorized: number | null;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
         remainingAuthorized: number | null;
         percentage: number;
@@ -657,8 +665,8 @@ export declare const CapTableSummaryZod: z.ZodObject<{
     stockConversionRate: number | null;
     totalSharesByClass: {
         totalShares: number;
-        totalAuthorized: number | null;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
         remainingAuthorized: number | null;
         percentage: number;
@@ -680,20 +688,23 @@ export declare const CapTableHolderAllocationZod: z.ZodObject<{
     allocationDate: z.ZodString;
     status: z.ZodNativeEnum<typeof CapTableEntryStatus>;
     source: z.ZodNativeEnum<typeof CapTableEntrySource>;
+    tradeId: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     status: CapTableEntryStatus;
     id: string;
     source: CapTableEntrySource;
-    numberOfShares: number;
     shareClassId: string;
+    tradeId: string | null;
+    numberOfShares: number;
     allocationDate: string;
     shareClassName: string;
 }, {
     status: CapTableEntryStatus;
     id: string;
     source: CapTableEntrySource;
-    numberOfShares: number;
     shareClassId: string;
+    tradeId: string | null;
+    numberOfShares: number;
     allocationDate: string;
     shareClassName: string;
 }>;
@@ -704,15 +715,15 @@ export declare const CapTableHolderSharesByClassZod: z.ZodObject<{
     shares: z.ZodNumber;
     percentage: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    shares: number;
     shareClassId: string;
     shareClassName: string;
     percentage: number;
-}, {
     shares: number;
+}, {
     shareClassId: string;
     shareClassName: string;
     percentage: number;
+    shares: number;
 }>;
 export type CapTableHolderSharesByClassZod = z.infer<typeof CapTableHolderSharesByClassZod>;
 export declare const CapTableHolderZod: z.ZodObject<{
@@ -728,15 +739,15 @@ export declare const CapTableHolderZod: z.ZodObject<{
         shares: z.ZodNumber;
         percentage: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        shares: number;
         shareClassId: string;
         shareClassName: string;
         percentage: number;
-    }, {
         shares: number;
+    }, {
         shareClassId: string;
         shareClassName: string;
         percentage: number;
+        shares: number;
     }>, "many">;
     allocations: z.ZodArray<z.ZodObject<{
         id: z.ZodEffects<z.ZodString, string, string>;
@@ -746,20 +757,23 @@ export declare const CapTableHolderZod: z.ZodObject<{
         allocationDate: z.ZodString;
         status: z.ZodNativeEnum<typeof CapTableEntryStatus>;
         source: z.ZodNativeEnum<typeof CapTableEntrySource>;
+        tradeId: z.ZodNullable<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }, {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }>, "many">;
@@ -770,18 +784,19 @@ export declare const CapTableHolderZod: z.ZodObject<{
     holderName: string;
     holderEmail: string | null;
     totalSharesByClass: {
-        shares: number;
         shareClassId: string;
         shareClassName: string;
         percentage: number;
+        shares: number;
     }[];
     holderId: string;
     allocations: {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }[];
@@ -792,23 +807,127 @@ export declare const CapTableHolderZod: z.ZodObject<{
     holderName: string;
     holderEmail: string | null;
     totalSharesByClass: {
+        shareClassId: string;
+        shareClassName: string;
+        percentage: number;
         shares: number;
+    }[];
+    holderId: string;
+    allocations: {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
+        allocationDate: string;
+        shareClassName: string;
+    }[];
+}>;
+export type CapTableHolderZod = z.infer<typeof CapTableHolderZod>;
+export declare const CapTableHolderDetailZod: z.ZodObject<{
+    holderId: z.ZodString;
+    holderName: z.ZodString;
+    holderEmail: z.ZodNullable<z.ZodString>;
+    holderType: z.ZodNativeEnum<typeof CapTableHolderType>;
+    investorAccountId: z.ZodNullable<z.ZodString>;
+    totalShares: z.ZodNumber;
+    totalSharesByClass: z.ZodArray<z.ZodObject<{
+        shareClassId: z.ZodString;
+        shareClassName: z.ZodString;
+        shares: z.ZodNumber;
+        percentage: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        shareClassId: string;
+        shareClassName: string;
+        percentage: number;
+        shares: number;
+    }, {
+        shareClassId: string;
+        shareClassName: string;
+        percentage: number;
+        shares: number;
+    }>, "many">;
+    allocations: z.ZodArray<z.ZodObject<{
+        id: z.ZodEffects<z.ZodString, string, string>;
+        shareClassId: z.ZodString;
+        shareClassName: z.ZodString;
+        numberOfShares: z.ZodNumber;
+        allocationDate: z.ZodString;
+        status: z.ZodNativeEnum<typeof CapTableEntryStatus>;
+        source: z.ZodNativeEnum<typeof CapTableEntrySource>;
+        tradeId: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
+        allocationDate: string;
+        shareClassName: string;
+    }, {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
+        allocationDate: string;
+        shareClassName: string;
+    }>, "many">;
+} & {
+    ownershipPercentage: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    investorAccountId: string | null;
+    totalShares: number;
+    holderType: CapTableHolderType;
+    holderName: string;
+    holderEmail: string | null;
+    totalSharesByClass: {
         shareClassId: string;
         shareClassName: string;
         percentage: number;
+        shares: number;
     }[];
     holderId: string;
     allocations: {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
+        shareClassId: string;
+        tradeId: string | null;
         numberOfShares: number;
+        allocationDate: string;
+        shareClassName: string;
+    }[];
+    ownershipPercentage: number;
+}, {
+    investorAccountId: string | null;
+    totalShares: number;
+    holderType: CapTableHolderType;
+    holderName: string;
+    holderEmail: string | null;
+    totalSharesByClass: {
         shareClassId: string;
+        shareClassName: string;
+        percentage: number;
+        shares: number;
+    }[];
+    holderId: string;
+    allocations: {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        tradeId: string | null;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }[];
+    ownershipPercentage: number;
 }>;
-export type CapTableHolderZod = z.infer<typeof CapTableHolderZod>;
+export type CapTableHolderDetailZod = z.infer<typeof CapTableHolderDetailZod>;
 export declare const IPaginatedCapTableHolder: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
         holderId: z.ZodString;
@@ -823,15 +942,15 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
             shares: z.ZodNumber;
             percentage: z.ZodNumber;
         }, "strip", z.ZodTypeAny, {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
-        }, {
             shares: number;
+        }, {
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }>, "many">;
         allocations: z.ZodArray<z.ZodObject<{
             id: z.ZodEffects<z.ZodString, string, string>;
@@ -841,20 +960,23 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
             allocationDate: z.ZodString;
             status: z.ZodNativeEnum<typeof CapTableEntryStatus>;
             source: z.ZodNativeEnum<typeof CapTableEntrySource>;
+            tradeId: z.ZodNullable<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }, {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }>, "many">;
@@ -865,18 +987,19 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
         holderName: string;
         holderEmail: string | null;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -887,18 +1010,19 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
         holderName: string;
         holderEmail: string | null;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -930,18 +1054,19 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
         holderName: string;
         holderEmail: string | null;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -961,18 +1086,19 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
         holderName: string;
         holderEmail: string | null;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            tradeId: string | null;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -1137,3 +1263,49 @@ export declare const CsvImportResultZod: z.ZodObject<{
     failedRows: number;
 }>;
 export type CsvImportResultZod = z.infer<typeof CsvImportResultZod>;
+export declare const CsvTemplateResponseZod: z.ZodObject<{
+    template: z.ZodString;
+    headers: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    headers: string[];
+    template: string;
+}, {
+    headers: string[];
+    template: string;
+}>;
+export type CsvTemplateResponseZod = z.infer<typeof CsvTemplateResponseZod>;
+export declare const InvestorHoldingZod: z.ZodObject<{
+    id: z.ZodEffects<z.ZodString, string, string>;
+    shareClassName: z.ZodString;
+    numberOfShares: z.ZodNumber;
+    pricePerShare: z.ZodNullable<z.ZodNumber>;
+    allocationDate: z.ZodDate;
+    source: z.ZodNativeEnum<typeof CapTableEntrySource>;
+    status: z.ZodNativeEnum<typeof CapTableEntryStatus>;
+    tradeId: z.ZodNullable<z.ZodString>;
+    offeringName: z.ZodNullable<z.ZodString>;
+    issuerName: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status: CapTableEntryStatus;
+    id: string;
+    source: CapTableEntrySource;
+    pricePerShare: number | null;
+    tradeId: string | null;
+    numberOfShares: number;
+    allocationDate: Date;
+    shareClassName: string;
+    offeringName: string | null;
+    issuerName: string | null;
+}, {
+    status: CapTableEntryStatus;
+    id: string;
+    source: CapTableEntrySource;
+    pricePerShare: number | null;
+    tradeId: string | null;
+    numberOfShares: number;
+    allocationDate: Date;
+    shareClassName: string;
+    offeringName: string | null;
+    issuerName: string | null;
+}>;
+export type InvestorHoldingZod = z.infer<typeof InvestorHoldingZod>;

package/common/types/cap-table.types.js

@@ -291,6 +291,7 @@ export const CapTableEntryZod = IBaseEntity.extend({
     }),
     individualId: z.string().nullable(),
     legalEntityId: z.string().nullable(),
+    tradeId: z.string().nullable(),
     signingDocumentId: z.string().nullable(),
     signingStatus: z.nativeEnum(CapTableSigningStatus).openapi({
         example: CapTableSigningStatus.NOT_REQUIRED,
@@ -355,6 +356,7 @@ export const CapTableHolderAllocationZod = z.object({
     source: z.nativeEnum(CapTableEntrySource).openapi({
         example: CapTableEntrySource.MANUAL,
     }),
+    tradeId: z.string().nullable(),
 });
 export const CapTableHolderSharesByClassZod = z.object({
     shareClassId: z.string().openapi({ example: 'cap_share_class_01j1xgme...' }),
@@ -379,6 +381,12 @@ export const CapTableHolderZod = z.object({
     totalSharesByClass: z.array(CapTableHolderSharesByClassZod),
     allocations: z.array(CapTableHolderAllocationZod),
 });
+export const CapTableHolderDetailZod = CapTableHolderZod.extend({
+    ownershipPercentage: z.number().openapi({
+        example: 15.5,
+        description: 'Percentage of total cap table shares owned by this holder (accepted allocations only)',
+    }),
+});
 export const IPaginatedCapTableHolder = z.object({
     items: z.array(CapTableHolderZod),
     meta: IPaginationMeta,
@@ -420,4 +428,31 @@ export const CsvImportResultZod = z.object({
         message: z.string(),
     })),
 });
+export const CsvTemplateResponseZod = z.object({
+    template: z.string().openapi({
+        description: 'CSV template content with headers and example rows',
+    }),
+    headers: z.array(z.string()).openapi({
+        description: 'List of valid column headers for the CSV',
+    }),
+});
+// ============================================================================
+// Investor Holdings Schemas
+// ============================================================================
+export const InvestorHoldingZod = z.object({
+    id: capEntryIdSchema,
+    shareClassName: z.string().openapi({ example: 'Common Stock' }),
+    numberOfShares: z.number().openapi({ example: 1000 }),
+    pricePerShare: z.number().nullable().openapi({ example: 1.0 }),
+    allocationDate: z.coerce.date().openapi({ example: '2024-01-15' }),
+    source: z.nativeEnum(CapTableEntrySource).openapi({
+        example: CapTableEntrySource.TRADE,
+    }),
+    status: z.nativeEnum(CapTableEntryStatus).openapi({
+        example: CapTableEntryStatus.ACCEPTED,
+    }),
+    tradeId: z.string().nullable(),
+    offeringName: z.string().nullable().openapi({ example: 'Series A Offering' }),
+    issuerName: z.string().nullable().openapi({ example: 'Acme Corp' }),
+});
 //# sourceMappingURL=cap-table.types.js.map