@dalmore/api-contracts 0.0.0-dev.f1cb508 → 0.0.0-dev.f48e7e9

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

@@ -32,12 +32,27 @@ export declare enum CapTableSigningStatus {
 export declare const capTableIdSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const capShareClassIdSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const capEntryIdSchema: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * Optional issuer ID filter. Required when account has multiple issuers.
+ * All cap table endpoints should accept this to scope to a specific issuer.
+ */
+export declare const IssuerIdFilterQuery: z.ZodObject<{
+    issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+}, "strip", z.ZodTypeAny, {
+    issuerId?: string | undefined;
+}, {
+    issuerId?: string | undefined;
+}>;
+export type IssuerIdFilterQuery = z.infer<typeof IssuerIdFilterQuery>;
 export declare const CapTableIncludeQuery: z.ZodObject<{
     include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
+    issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
 }, "strip", z.ZodTypeAny, {
     include: string[];
+    issuerId?: string | undefined;
 }, {
     include?: string | undefined;
+    issuerId?: string | undefined;
 }>;
 export declare const CapTableEntryIncludeQuery: z.ZodObject<{
     include: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string[], string | undefined>, string[], string | undefined>;
@@ -217,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;
@@ -230,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;
@@ -258,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;
@@ -269,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;
@@ -317,10 +332,10 @@ export declare const CapTableEntryZod: z.ZodObject<{
     individualId: string | null;
     legalEntityId: string | null;
     investorAccountId: string | null;
+    shareClassId: string;
     pricePerShare: number | null;
     numberOfShares: number;
     capTableId: string;
-    shareClassId: string;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
@@ -343,10 +358,10 @@ export declare const CapTableEntryZod: z.ZodObject<{
     individualId: string | null;
     legalEntityId: string | null;
     investorAccountId: string | null;
+    shareClassId: string;
     pricePerShare: number | null;
     numberOfShares: number;
     capTableId: string;
-    shareClassId: string;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
@@ -399,10 +414,10 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -425,10 +440,10 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -472,10 +487,10 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -507,10 +522,10 @@ export declare const IPaginatedCapTableEntry: z.ZodObject<{
         individualId: string | null;
         legalEntityId: string | null;
         investorAccountId: string | null;
+        shareClassId: string;
         pricePerShare: number | null;
         numberOfShares: number;
         capTableId: string;
-        shareClassId: string;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
@@ -563,17 +578,17 @@ export declare const CapTableShareClassSummaryZod: z.ZodObject<{
     remainingAuthorized: z.ZodNullable<z.ZodNumber>;
     percentage: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    totalAuthorized: number | null;
+    totalShares: number;
     shareClassId: string;
+    totalAuthorized: number | null;
     shareClassName: string;
-    totalShares: number;
     remainingAuthorized: number | null;
     percentage: number;
 }, {
-    totalAuthorized: number | null;
+    totalShares: number;
     shareClassId: string;
+    totalAuthorized: number | null;
     shareClassName: string;
-    totalShares: number;
     remainingAuthorized: number | null;
     percentage: number;
 }>;
@@ -588,17 +603,17 @@ export declare const CapTableSummaryZod: z.ZodObject<{
         remainingAuthorized: z.ZodNullable<z.ZodNumber>;
         percentage: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        totalAuthorized: number | null;
+        totalShares: number;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
-        totalShares: number;
         remainingAuthorized: number | null;
         percentage: number;
     }, {
-        totalAuthorized: number | null;
+        totalShares: number;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
-        totalShares: number;
         remainingAuthorized: number | null;
         percentage: number;
     }>, "many">;
@@ -618,14 +633,14 @@ export declare const CapTableSummaryZod: z.ZodObject<{
     totalAuthorizedShares: z.ZodNullable<z.ZodNumber>;
     stockConversionRate: z.ZodNullable<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
+    totalShares: number;
     totalAuthorizedShares: number | null;
     stockConversionRate: number | null;
-    totalShares: number;
     totalSharesByClass: {
-        totalAuthorized: number | null;
+        totalShares: number;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
-        totalShares: number;
         remainingAuthorized: number | null;
         percentage: number;
     }[];
@@ -637,14 +652,14 @@ export declare const CapTableSummaryZod: z.ZodObject<{
     pendingAllocations: number;
     acceptedAllocations: number;
 }, {
+    totalShares: number;
     totalAuthorizedShares: number | null;
     stockConversionRate: number | null;
-    totalShares: number;
     totalSharesByClass: {
-        totalAuthorized: number | null;
+        totalShares: number;
         shareClassId: string;
+        totalAuthorized: number | null;
         shareClassName: string;
-        totalShares: number;
         remainingAuthorized: number | null;
         percentage: number;
     }[];
@@ -669,16 +684,16 @@ export declare const CapTableHolderAllocationZod: z.ZodObject<{
     status: CapTableEntryStatus;
     id: string;
     source: CapTableEntrySource;
-    numberOfShares: number;
     shareClassId: string;
+    numberOfShares: number;
     allocationDate: string;
     shareClassName: string;
 }, {
     status: CapTableEntryStatus;
     id: string;
     source: CapTableEntrySource;
-    numberOfShares: number;
     shareClassId: string;
+    numberOfShares: number;
     allocationDate: string;
     shareClassName: string;
 }>;
@@ -689,15 +704,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<{
@@ -713,15 +728,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>;
@@ -735,65 +750,163 @@ export declare const CapTableHolderZod: z.ZodObject<{
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }, {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     investorAccountId: string | null;
+    totalShares: number;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
-    totalShares: number;
     totalSharesByClass: {
-        shares: number;
         shareClassId: string;
         shareClassName: string;
         percentage: number;
+        shares: number;
     }[];
     holderId: string;
     allocations: {
         status: CapTableEntryStatus;
         id: string;
         source: CapTableEntrySource;
-        numberOfShares: number;
         shareClassId: string;
+        numberOfShares: number;
         allocationDate: string;
         shareClassName: string;
     }[];
 }, {
     investorAccountId: string | null;
+    totalShares: number;
     holderType: CapTableHolderType;
     holderName: string;
     holderEmail: string | null;
-    totalShares: number;
     totalSharesByClass: {
+        shareClassId: string;
+        shareClassName: string;
+        percentage: number;
         shares: number;
+    }[];
+    holderId: string;
+    allocations: {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        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>;
+    }, "strip", z.ZodTypeAny, {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        numberOfShares: number;
+        allocationDate: string;
+        shareClassName: string;
+    }, {
+        status: CapTableEntryStatus;
+        id: string;
+        source: CapTableEntrySource;
+        shareClassId: string;
+        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;
         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;
+        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;
@@ -808,15 +921,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>;
@@ -830,60 +943,60 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }, {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
         investorAccountId: string | null;
+        totalShares: number;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
-        totalShares: number;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
     }, {
         investorAccountId: string | null;
+        totalShares: number;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
-        totalShares: number;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -910,23 +1023,23 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     items: {
         investorAccountId: string | null;
+        totalShares: number;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
-        totalShares: number;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -941,23 +1054,23 @@ export declare const IPaginatedCapTableHolder: z.ZodObject<{
 }, {
     items: {
         investorAccountId: string | null;
+        totalShares: number;
         holderType: CapTableHolderType;
         holderName: string;
         holderEmail: string | null;
-        totalShares: number;
         totalSharesByClass: {
-            shares: number;
             shareClassId: string;
             shareClassName: string;
             percentage: number;
+            shares: number;
         }[];
         holderId: string;
         allocations: {
             status: CapTableEntryStatus;
             id: string;
             source: CapTableEntrySource;
-            numberOfShares: number;
             shareClassId: string;
+            numberOfShares: number;
             allocationDate: string;
             shareClassName: string;
         }[];
@@ -1122,3 +1235,14 @@ 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>;

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

@@ -80,6 +80,19 @@ export const capEntryIdSchema = z.string().refine((value) => {
     message: 'Invalid cap table entry ID format. Must be a valid TypeID with "cap_table_entry" prefix.',
 });
 // ============================================================================
+// Common Query Parameters
+// ============================================================================
+/**
+ * Optional issuer ID filter. Required when account has multiple issuers.
+ * All cap table endpoints should accept this to scope to a specific issuer.
+ */
+export const IssuerIdFilterQuery = z.object({
+    issuerId: issuerIdSchema.optional().openapi({
+        description: 'Filter by specific issuer ID. Required when account has multiple issuers.',
+        example: 'issuer_01j1xgme...',
+    }),
+});
+// ============================================================================
 // Include Queries
 // ============================================================================
 const capTableInclude = z.enum(['issuer', 'shareClasses', 'entries']);
@@ -94,6 +107,10 @@ export const CapTableIncludeQuery = z.object({
         .openapi({
         example: `${capTableInclude.options.join(',')}`,
     }),
+    issuerId: issuerIdSchema.optional().openapi({
+        description: 'Filter by specific issuer ID. Required when account has multiple issuers.',
+        example: 'issuer_01j1xgme...',
+    }),
 });
 const capTableEntryInclude = z.enum(['capTable', 'shareClass']);
 export const CapTableEntryIncludeQuery = z.object({
@@ -362,6 +379,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,
@@ -403,4 +426,12 @@ 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',
+    }),
+});
 //# sourceMappingURL=cap-table.types.js.map