@dalmore/api-contracts 0.0.0-dev.835d7eb → 0.0.0-dev.8f56ad5

package/common/types/offering.types.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { ComplianceReview, OfferingType, ManagedByType, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType } from './common.types';
+import { ComplianceReview, OfferingType, ManagedByType, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, WarrantSharesCalculationMethod } from './common.types';
 import { OfferingStatus } from './issuer-offering.types';
 import { AssetTemplateType } from './asset.types';
 export declare enum OfferingFeeType {
@@ -113,6 +113,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
     cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     showTotalRaised: z.ZodOptional<z.ZodBoolean>;
     issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
 }, "strip", z.ZodTypeAny, {
     platformSettings: string | null;
     type?: OfferingType | undefined;
@@ -135,6 +136,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
     memorandumId?: string | null | undefined;
     subscriptionAgreementId?: string | null | undefined;
     showTotalRaised?: boolean | undefined;
+    shareClassId?: string | null | undefined;
     entitySubscriptionAgreementTemplateId?: string | null | undefined;
     subscriptionAgreementTemplateId?: string | null | undefined;
     jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -165,6 +167,7 @@ export declare const PatchOfferingBase: z.ZodObject<{
     memorandumId?: string | null | undefined;
     subscriptionAgreementId?: string | null | undefined;
     showTotalRaised?: boolean | undefined;
+    shareClassId?: string | null | undefined;
     entitySubscriptionAgreementTemplateId?: string | null | undefined;
     subscriptionAgreementTemplateId?: string | null | undefined;
     jointSubscriptionAgreementTemplateId?: string | null | undefined;
@@ -214,6 +217,7 @@ export declare const PatchOffering: z.ZodObject<{
     cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     showTotalRaised: z.ZodOptional<z.ZodBoolean>;
     issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
 } & {
     assetName: z.ZodOptional<z.ZodString>;
     assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -266,6 +270,13 @@ export declare const PatchOffering: z.ZodObject<{
     bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
+    totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
+    incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
 }, "strip", z.ZodTypeAny, {
     platformSettings: string | null;
     type?: OfferingType | undefined;
@@ -293,6 +304,14 @@ export declare const PatchOffering: z.ZodObject<{
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -344,6 +363,14 @@ export declare const PatchOffering: z.ZodObject<{
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -365,6 +392,48 @@ export declare const PatchOffering: z.ZodObject<{
     jointSubscriptionAgreementTemplateId?: string | null | undefined;
 }>;
 export type PatchOffering = z.infer<typeof PatchOffering>;
+/**
+ * Optional params for resolveAndValidateOfferingUpdateFields.
+ * All fields are optional and nullable; resolution merges with offering/asset values.
+ */
+export declare const ResolveOfferingUpdateFieldsParamsZod: z.ZodObject<{
+    minInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    maxInvestment: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    targetAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    pricePerUnit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    targetAmount?: number | null | undefined;
+    minInvestment?: number | null | undefined;
+    maxInvestment?: number | null | undefined;
+    pricePerUnit?: number | null | undefined;
+}, {
+    targetAmount?: number | null | undefined;
+    minInvestment?: number | null | undefined;
+    maxInvestment?: number | null | undefined;
+    pricePerUnit?: number | null | undefined;
+}>;
+export type ResolveOfferingUpdateFieldsParams = z.infer<typeof ResolveOfferingUpdateFieldsParamsZod>;
+/**
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
+ */
+export declare const ResolvedOfferingUpdateFieldsZod: z.ZodObject<{
+    pricePerUnit: z.ZodNumber;
+    targetAmount: z.ZodNumber;
+    minInvestment: z.ZodNullable<z.ZodNumber>;
+    maxInvestment: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    targetAmount: number;
+    minInvestment: number | null;
+    maxInvestment: number | null;
+    pricePerUnit: number;
+}, {
+    targetAmount: number;
+    minInvestment: number | null;
+    maxInvestment: number | null;
+    pricePerUnit: number;
+}>;
+export type ResolvedOfferingUpdateFields = z.infer<typeof ResolvedOfferingUpdateFieldsZod>;
 export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -412,6 +481,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
 } & {
     accountId: z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>;
     managedBy: z.ZodOptional<z.ZodNativeEnum<typeof ManagedByType>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     assetName: z.ZodString;
     assetType: z.ZodNativeEnum<typeof AssetType>;
     pricePerUnit: z.ZodNullable<z.ZodNumber>;
@@ -462,10 +532,18 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
         startAmount: number;
         endAmount: number;
     }>, "many">>;
+    warrantsEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
+    incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
 }, "strip", z.ZodTypeAny, {
     accountId: string;
     template: AssetTemplateType;
     platformSettings: string | null;
+    warrantsEnabled: boolean;
     assetName: string;
     assetType: AssetType;
     pricePerUnit: number | null;
@@ -493,6 +571,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -544,6 +629,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -563,6 +656,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     accountId: string;
     template: AssetTemplateType;
     platformSettings: string | null;
+    warrantsEnabled: boolean;
     assetName: string;
     assetType: AssetType;
     pricePerUnit: number | null;
@@ -590,6 +684,13 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -641,6 +742,14 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     hasEscrow?: boolean | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     yield?: number | null | undefined;
     duration?: number | null | undefined;
     durationType?: DurationType | null | undefined;
@@ -658,7 +767,7 @@ export declare const PostComplianceOffering: z.ZodEffects<z.ZodObject<{
     jointSubscriptionAgreementTemplateId?: string | null | undefined;
 }>;
 export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
-export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount"]>;
+export declare const offeringsInclude: z.ZodEnum<["account", "issuer", "trades", "assets", "disbursements", "draftVersion", "publishedVersion", "revisions", "onboardingReviewedBy", "bankAccount", "escrowAccount", "shareClass"]>;
 /**
  * @description Query parameters for including related entities
  * @xample in contract us as -> query: z.object({}).merge(UsersIncludeQuery),
@@ -1196,6 +1305,7 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     cancellationPeriod: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     showTotalRaised: z.ZodOptional<z.ZodBoolean>;
     issuerId: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    shareClassId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
 } & {
     assetName: z.ZodOptional<z.ZodString>;
     assetType: z.ZodOptional<z.ZodNativeEnum<typeof AssetType>>;
@@ -1248,6 +1358,13 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     bankAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     escrowAccountId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
     escrowAgreementFileId: z.ZodOptional<z.ZodNullable<z.ZodLazy<z.ZodEffects<z.ZodString, string, string>>>>;
+    warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
+    totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
+    calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
+    incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, number, number>>>;
 }, "strip", z.ZodTypeAny, {
     platformSettings: string | null;
     type?: OfferingType | undefined;
@@ -1275,6 +1392,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1326,6 +1451,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1603,6 +1736,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -1665,6 +1806,14 @@ export declare const PatchComplianceOffering: z.ZodEffects<z.ZodIntersection<z.Z
     escrowAgreementFileId?: string | null | undefined;
     bankAccountId?: string | null | undefined;
     escrowAccountId?: string | null | undefined;
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    shareClassId?: string | null | undefined;
     assetName?: string | undefined;
     assetType?: AssetType | undefined;
     pricePerUnit?: number | null | undefined;
@@ -2418,6 +2567,7 @@ export type OfferingUpdateFields = {
     managedBy?: ManagedByType | null;
     showTotalRaised?: boolean;
     enabled?: boolean;
+    shareClassId?: string | null;
 };
 export declare const ReviewOfferingOnboarding: z.ZodObject<{
     onboardingStatus: z.ZodNativeEnum<typeof OfferingOnboardingStatus>;
@@ -2613,3 +2763,84 @@ export declare const EscrowValidationContextZod: z.ZodObject<{
     currentEscrowAgreementFileId: string | null;
 }>;
 export type EscrowValidationContext = z.infer<typeof EscrowValidationContextZod>;
+/**
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
+ */
+export declare const WarrantSharesBaseZod: z.ZodObject<{
+    warrantsEnabled: z.ZodBoolean;
+    totalShares: z.ZodNullable<z.ZodNumber>;
+    warrantTermYears: z.ZodNullable<z.ZodNumber>;
+    exercisePrice: z.ZodNullable<z.ZodNumber>;
+    warrantPercentage: z.ZodNullable<z.ZodNumber>;
+    calculationMethod: z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>;
+    incrementThreshold: z.ZodNullable<z.ZodNumber>;
+    fullyDilutedShares: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    warrantsEnabled: boolean;
+    totalShares: number | null;
+    warrantTermYears: number | null;
+    exercisePrice: number | null;
+    warrantPercentage: number | null;
+    calculationMethod: WarrantSharesCalculationMethod | null;
+    incrementThreshold: number | null;
+    fullyDilutedShares: number | null;
+}, {
+    warrantsEnabled: boolean;
+    totalShares: number | null;
+    warrantTermYears: number | null;
+    exercisePrice: number | null;
+    warrantPercentage: number | null;
+    calculationMethod: WarrantSharesCalculationMethod | null;
+    incrementThreshold: number | null;
+    fullyDilutedShares: number | null;
+}>;
+export type WarrantSharesBase = z.infer<typeof WarrantSharesBaseZod>;
+/**
+ * All warrant field keys used when picking warrant data from base or patch.
+ */
+export declare const WARRANT_FIELD_KEYS: (keyof WarrantSharesBase)[];
+/**
+ * Warrant field keys required when enabling warrants (turning warrants on).
+ */
+export declare const WARRANT_REQUIRED_WHEN_ENABLED_KEYS: (keyof WarrantSharesBase)[];
+/**
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
+ */
+export declare const WarrantValidationDataZod: z.ZodObject<{
+    warrantsEnabled: z.ZodOptional<z.ZodBoolean>;
+    totalShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantTermYears: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    exercisePrice: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    warrantPercentage: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    calculationMethod: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof WarrantSharesCalculationMethod>>>;
+    incrementThreshold: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    fullyDilutedShares: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    fullyDilutedShares?: number | null | undefined;
+}, {
+    warrantsEnabled?: boolean | undefined;
+    totalShares?: number | null | undefined;
+    warrantTermYears?: number | null | undefined;
+    exercisePrice?: number | null | undefined;
+    warrantPercentage?: number | null | undefined;
+    calculationMethod?: WarrantSharesCalculationMethod | null | undefined;
+    incrementThreshold?: number | null | undefined;
+    fullyDilutedShares?: number | null | undefined;
+}>;
+export type WarrantValidationData = z.infer<typeof WarrantValidationDataZod>;
+/**
+ * Validated warrant payload to persist on revision and offering.
+ */
+export type WarrantValidationResult = WarrantSharesBase;
+/**
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
+ */
+export declare const WARRANT_DISABLED_FIELD_RESETS: WarrantValidationResult;

package/common/types/offering.types.js

@@ -2,12 +2,13 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import { z } from 'zod';
 import { accountIdSchema } from './account.types.js';
-import { AccountZod, ComplianceReview, dateSchema, IPaginationMeta, OfferingType, ManagedByType, PaginationOptionsZod, UrlSchema, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, StringToBooleanSchema, HttpMethod, } from './common.types.js';
+import { capShareClassIdSchema } from './cap-table.types.js';
+import { AccountZod, ComplianceReview, dateSchema, IPaginationMeta, OfferingType, ManagedByType, PaginationOptionsZod, UrlSchema, SortOrder, SortBy, OfferingVersioningType, OfferingOnboardingStatus, AssetType, DurationType, StringToBooleanSchema, HttpMethod, numberPrecisionSchema, WarrantSharesCalculationMethod, } from './common.types.js';
 import { IBaseEntity } from './entity.types.js';
 import { fileIdSchema, FileZod } from './file.types.js';
 import { IIssuer, issuerIdSchema } from './issuer.types.js';
 import { InvestorsOfferingFiltersZod, InvestorsOfferingsIncludeQuery, } from './investors-offering.types.js';
-import { OfferingStatus, escrowValidationRefinement, postOfferingRefinement, } from './issuer-offering.types.js';
+import { OfferingStatus, escrowValidationRefinement, postOfferingRefinement, warrantsValidationRefinement, } from './issuer-offering.types.js';
 import { postAssetRefinement, AssetTemplateType } from './asset.types.js';
 import { IIssuerBankAccount, issuerBankAccountIdSchema, } from './issuer-bank-account.types.js';
 import { escrowAccountIdSchema, IEscrowAccount } from './escrow-account.types.js';
@@ -97,6 +98,18 @@ export const IOffering = IBaseEntity.extend({
         .lazy(() => IEscrowAccount)
         .nullable()
         .optional(),
+    warrantsEnabled: z.boolean().optional(),
+    totalShares: z.number().nullable().optional(),
+    warrantTermYears: z.number().nullable().optional(),
+    exercisePrice: z.number().nullable().optional(),
+    warrantPercentage: z.number().nullable().optional(),
+    calculationMethod: z
+        .nativeEnum(WarrantSharesCalculationMethod)
+        .nullable()
+        .optional(),
+    incrementThreshold: z.number().nullable().optional(),
+    fullyDilutedShares: z.number().nullable().optional(),
+    shareClassId: z.string().nullable().optional(),
 });
 export const IPaginatedOffering = z.object({
     items: z.array(IOffering),
@@ -156,9 +169,13 @@ export const PatchOfferingBase = z.object({
         .nullable()
         .optional(),
     jointSubscriptionAgreementTemplateId: z.string().optional().nullable(),
-    cancellationPeriod: z.number().min(2).max(5).optional().nullable(),
+    cancellationPeriod: z.number().min(1).max(30).optional().nullable(),
     showTotalRaised: z.boolean().optional(),
     issuerId: issuerIdSchema.optional(),
+    shareClassId: z
+        .lazy(() => capShareClassIdSchema)
+        .nullable()
+        .optional(),
 });
 export const PatchOffering = PatchOfferingBase.merge(z.object({
     assetName: z
@@ -233,10 +250,69 @@ export const PatchOffering = PatchOfferingBase.merge(z.object({
         .lazy(() => fileIdSchema)
         .nullable()
         .optional(),
+    warrantsEnabled: z.boolean().optional().openapi({ example: false }),
+    totalShares: z
+        .number()
+        .int()
+        .positive()
+        .max(10000000000)
+        .nullable()
+        .optional()
+        .openapi({ example: 1000 }),
+    warrantTermYears: z
+        .number()
+        .int()
+        .positive()
+        .max(10000000000)
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
+    exercisePrice: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
+        .nullable()
+        .optional()
+        .openapi({ example: 100 }),
+    warrantPercentage: numberPrecisionSchema(2, z.number().positive().max(100))
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
+    calculationMethod: z
+        .nativeEnum(WarrantSharesCalculationMethod)
+        .nullable()
+        .optional()
+        .openapi({ example: WarrantSharesCalculationMethod.NONE }),
+    incrementThreshold: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
 }));
+/**
+ * Optional params for resolveAndValidateOfferingUpdateFields.
+ * All fields are optional and nullable; resolution merges with offering/asset values.
+ */
+export const ResolveOfferingUpdateFieldsParamsZod = z.object({
+    minInvestment: z.number().nullable().optional(),
+    maxInvestment: z.number().nullable().optional(),
+    targetAmount: z.number().nullable().optional(),
+    pricePerUnit: z.number().nullable().optional(),
+});
+/**
+ * Resolved, validated offering update fields (price per unit, target amount, min/max investment).
+ * Returned by resolveAndValidateOfferingUpdateFields and passed into validateBonusTiersForUpdate.
+ */
+export const ResolvedOfferingUpdateFieldsZod = z.object({
+    pricePerUnit: z.number(),
+    targetAmount: z.number(),
+    minInvestment: z.number().nullable(),
+    maxInvestment: z.number().nullable(),
+});
 export const PostComplianceOffering = PatchOfferingBase.merge(z.object({
     accountId: z.lazy(() => accountIdSchema),
     managedBy: z.nativeEnum(ManagedByType).optional(),
+    shareClassId: z
+        .lazy(() => capShareClassIdSchema)
+        .nullable()
+        .optional()
+        .openapi({ example: 'cap_table_share_class_01j1xgme...' }),
     assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
     assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
     pricePerUnit: z
@@ -293,11 +369,50 @@ export const PostComplianceOffering = PatchOfferingBase.merge(z.object({
         .optional()
         .openapi({ example: 10 }),
     bonusTiers: BonusTierListZod.optional(),
+    warrantsEnabled: z
+        .boolean()
+        .optional()
+        .default(false)
+        .openapi({ example: false }),
+    totalShares: z
+        .number()
+        .int()
+        .positive()
+        .max(10000000000)
+        .nullable()
+        .optional()
+        .openapi({ example: 1000 }),
+    warrantTermYears: z
+        .number()
+        .int()
+        .positive()
+        .max(10000000000)
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
+    exercisePrice: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
+        .nullable()
+        .optional()
+        .openapi({ example: 100 }),
+    warrantPercentage: numberPrecisionSchema(2, z.number().positive().max(100))
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
+    calculationMethod: z
+        .nativeEnum(WarrantSharesCalculationMethod)
+        .nullable()
+        .optional()
+        .openapi({ example: WarrantSharesCalculationMethod.NONE }),
+    incrementThreshold: numberPrecisionSchema(2, z.number().min(0.01).max(10000000000))
+        .nullable()
+        .optional()
+        .openapi({ example: 10 }),
 })).superRefine((data, ctx) => {
     postOfferingRefinement(data, ctx);
     postAssetRefinement(data, ctx);
     escrowValidationRefinement(data, ctx, HttpMethod.POST);
     postBonusTierRefinement(data, ctx);
+    warrantsValidationRefinement(data, ctx);
 });
 export const offeringsInclude = z.enum([
     'account',
@@ -311,6 +426,7 @@ export const offeringsInclude = z.enum([
     'onboardingReviewedBy',
     'bankAccount',
     'escrowAccount',
+    'shareClass',
 ]);
 /**
  * @description Query parameters for including related entities
@@ -599,4 +715,70 @@ export const EscrowValidationContextZod = z.object({
     currentEscrowAccountId: z.string().nullable(),
     currentEscrowAgreementFileId: z.string().nullable(),
 });
+/**
+ * Shape of warrant fields shared by Offering and OfferingRevision for validation.
+ */
+export const WarrantSharesBaseZod = z.object({
+    warrantsEnabled: z.boolean(),
+    totalShares: z.number().nullable(),
+    warrantTermYears: z.number().nullable(),
+    exercisePrice: z.number().nullable(),
+    warrantPercentage: z.number().nullable(),
+    calculationMethod: z.nativeEnum(WarrantSharesCalculationMethod).nullable(),
+    incrementThreshold: z.number().nullable(),
+    fullyDilutedShares: z.number().nullable(),
+});
+/**
+ * All warrant field keys used when picking warrant data from base or patch.
+ */
+export const WARRANT_FIELD_KEYS = [
+    'warrantsEnabled',
+    'totalShares',
+    'warrantTermYears',
+    'exercisePrice',
+    'warrantPercentage',
+    'calculationMethod',
+    'incrementThreshold',
+    'fullyDilutedShares',
+];
+/**
+ * Warrant field keys required when enabling warrants (turning warrants on).
+ */
+export const WARRANT_REQUIRED_WHEN_ENABLED_KEYS = [
+    'totalShares',
+    'warrantTermYears',
+    'exercisePrice',
+    'warrantPercentage',
+    'calculationMethod',
+];
+/**
+ * Patch input for warrant validation (optional warrant fields from PATCH body).
+ */
+export const WarrantValidationDataZod = z.object({
+    warrantsEnabled: z.boolean().optional(),
+    totalShares: z.number().nullable().optional(),
+    warrantTermYears: z.number().nullable().optional(),
+    exercisePrice: z.number().nullable().optional(),
+    warrantPercentage: z.number().nullable().optional(),
+    calculationMethod: z
+        .nativeEnum(WarrantSharesCalculationMethod)
+        .nullable()
+        .optional(),
+    incrementThreshold: z.number().nullable().optional(),
+    fullyDilutedShares: z.number().nullable().optional(),
+});
+/**
+ * Warrant-related fields to reset (nullify) when warrants are disabled.
+ * Used when warrantsEnabled is set to false so revision and offering stay in sync.
+ */
+export const WARRANT_DISABLED_FIELD_RESETS = {
+    warrantsEnabled: false,
+    totalShares: null,
+    warrantTermYears: null,
+    exercisePrice: null,
+    warrantPercentage: null,
+    calculationMethod: null,
+    incrementThreshold: null,
+    fullyDilutedShares: null,
+};
 //# sourceMappingURL=offering.types.js.map