@dalmore/api-contracts 0.0.0-dev.58a860b → 0.0.0-dev.ab1033d

package/common/types/asset.types.ts

@@ -29,7 +29,7 @@ export const assetIdSchema = z.string().refine(
     message: `Invalid asset ID format. Must be a valid TypeID with "asset" prefix. Example: asset_01j5y5ghx5fg68d663j1fvy2x7`,
   },
 );
-export enum TemplateType {
+export enum AssetTemplateType {
   STANDARD = 'STANDARD',
   TIERED = 'TIERED',
 }
@@ -51,7 +51,7 @@ export const IAsset = IBaseEntity.extend({
     .lazy(() => IOffering)
     .optional()
     .nullable(), // Use z.lazy here
-  template: z.nativeEnum(TemplateType),
+  template: z.nativeEnum(AssetTemplateType),
   tiers: z.array(z.number().positive()).nullable(),
   enableBonus: z.boolean(),
 });
@@ -102,16 +102,16 @@ const PostAssetBase = z.object({
     .optional()
     .openapi({ example: DurationType.DAY }),
   template: z
-    .nativeEnum(TemplateType)
-    .default(TemplateType.STANDARD)
-    .openapi({ example: TemplateType.STANDARD }),
+    .nativeEnum(AssetTemplateType)
+    .default(AssetTemplateType.STANDARD)
+    .openapi({ example: AssetTemplateType.STANDARD }),
   tiers: z.array(z.number().positive()).nullable().optional(),
   enableBonus: z.boolean().default(false).openapi({ example: false }),
 });
 
-const postAssetRefinement = (data: any, ctx: any) => {
+export const postAssetRefinement = (data: any, ctx: any) => {
   // If type is bond, yield and duration must be provided (cannot be null or undefined)
-  if (data.type === AssetType.BOND) {
+  if (data.assetType === AssetType.BOND || data.type === AssetType.BOND) {
     if (data.yield === null || data.yield === undefined) {
       ctx.addIssue({
         path: ['yield'],
@@ -139,7 +139,7 @@ const postAssetRefinement = (data: any, ctx: any) => {
   }
 
   // If type is stock, yield and duration must be either null or undefined
-  if (data.type === AssetType.STOCK) {
+  if (data.assetType === AssetType.STOCK || data.type === AssetType.STOCK) {
     if (data.yield !== null && data.yield !== undefined) {
       ctx.addIssue({
         path: ['yield'],
@@ -162,7 +162,7 @@ const postAssetRefinement = (data: any, ctx: any) => {
       });
     }
   }
-  if (data.template === TemplateType.TIERED) {
+  if (data.template === AssetTemplateType.TIERED) {
     if (data.tiers === null || data.tiers === undefined) {
       ctx.addIssue({
         path: ['tiers'],
@@ -172,7 +172,7 @@ const postAssetRefinement = (data: any, ctx: any) => {
     }
   }
   // If template is STANDARD, tiers must be null or undefined
-  if (data.template === TemplateType.STANDARD) {
+  if (data.template === AssetTemplateType.STANDARD) {
     if (data.tiers !== null && data.tiers !== undefined) {
       ctx.addIssue({
         path: ['tiers'],
@@ -233,9 +233,9 @@ export const PutAsset = z.object({
     .optional()
     .openapi({ example: DurationType.DAY }),
   template: z
-    .nativeEnum(TemplateType)
-    .default(TemplateType.STANDARD)
-    .openapi({ example: TemplateType.STANDARD })
+    .nativeEnum(AssetTemplateType)
+    .default(AssetTemplateType.STANDARD)
+    .openapi({ example: AssetTemplateType.STANDARD })
     .nullable()
     .optional(),
   tiers: z.array(z.number().positive()).nullable().optional(),
@@ -262,7 +262,7 @@ export const AssetsIncludeQuery = z.object({
           assetsInclude.options.includes(include as any),
         ),
       {
-        message: `Invalid include option provided. Valid options are: ${assetsInclude.options.join(', ')}`,
+        message: `Invalid include option provided. Valid options are: ${assetsInclude.options.join(',')}`,
       },
     )
     .openapi({

package/common/types/issuer-offering.types.ts

@@ -8,10 +8,12 @@ import {
   ManagedByType,
   OfferingVersioningType,
   ComplianceReview,
+  DurationType,
+  AssetType,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { IIssuer, issuerIdSchema } from './issuer.types';
-import { IAsset } from './asset.types';
+import { IAsset, postAssetRefinement, AssetTemplateType } from './asset.types';
 import { fileIdSchema, FileZod } from './file.types';
 import { accountIdSchema } from './account.types';
 
@@ -128,20 +130,59 @@ export const PostIssuerOffering = z
       .nullable()
       .openapi({ example: 'This is a description of the offering.' }),
     managedBy: z.nativeEnum(ManagedByType).optional(),
+    assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
+    assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
+    pricePerUnit: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 2000 }),
+    totalUnits: z
+      .number()
+      .min(1)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 5200 }),
+    yield: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1200 }),
+    duration: z
+      .number()
+      .min(1)
+      .max(1000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1 }),
+    durationType: z
+      .nativeEnum(DurationType)
+      .nullable()
+      .optional()
+      .openapi({ example: DurationType.DAY }),
+    template: z
+      .nativeEnum(AssetTemplateType)
+      .default(AssetTemplateType.STANDARD)
+      .openapi({ example: AssetTemplateType.STANDARD }),
+    tiers: z.array(z.number().positive()).nullable().optional(),
   })
-  .refine(
-    (data) => {
-      // Check if both values are present, and if so, ensure minInvestment is less than maxInvestment
-      if (data.minInvestment && data.maxInvestment) {
-        return data.minInvestment < data.maxInvestment;
+  .superRefine((data, ctx) => {
+    // Check if both values are present, and if so, ensure minInvestment is less than maxInvestment
+    if (data.minInvestment && data.maxInvestment) {
+      if (data.minInvestment >= data.maxInvestment) {
+        ctx.addIssue({
+          path: ['minInvestment'],
+          message: 'Minimum investment must be less than maximum investment.',
+          code: z.ZodIssueCode.custom,
+        });
       }
-      return true; // If one or both values are undefined, skip this check
-    },
-    {
-      message: 'Minimum investment must be less than maximum investment.',
-      path: ['minInvestment'],
-    },
-  );
+    }
+    // Apply asset-specific refinements
+    postAssetRefinement(data, ctx);
+  });
 
 export type PostIssuerOffering = z.infer<typeof PostIssuerOffering>;
 export const PatchIssuerOffering = z.object({
@@ -212,6 +253,52 @@ export const PatchIssuerOffering = z.object({
   managedBy: z.nativeEnum(ManagedByType).optional(),
   showTotalRaised: z.boolean().optional(),
   issuerId: issuerIdSchema.optional(),
+  assetName: z.string().min(2).max(50).optional().openapi({ example: 'Z' }),
+  assetType: z
+    .nativeEnum(AssetType)
+    .optional()
+    .openapi({ example: AssetType.STOCK }),
+  pricePerUnit: z
+    .number()
+    .min(0.01)
+    .max(10000000000)
+    .nullable()
+    .optional()
+    .openapi({ example: 2000 }),
+  totalUnits: z
+    .number()
+    .min(1)
+    .max(10000000000)
+    .nullable()
+    .optional()
+    .openapi({ example: 5200 }),
+  yield: z
+    .number()
+    .min(0.01)
+    .max(10000000000)
+    .nullable()
+    .optional()
+    .openapi({ example: 1200 }),
+  duration: z
+    .number()
+    .min(1)
+    .max(1000)
+    .nullable()
+    .optional()
+    .openapi({ example: 1 }),
+  durationType: z
+    .nativeEnum(DurationType)
+    .nullable()
+    .optional()
+    .openapi({ example: DurationType.DAY }),
+  template: z
+    .nativeEnum(AssetTemplateType)
+    .default(AssetTemplateType.STANDARD)
+    .openapi({ example: AssetTemplateType.STANDARD })
+    .nullable()
+    .optional(),
+  tiers: z.array(z.number().positive()).nullable().optional(),
+  enabled: z.boolean().optional(),
 });
 export type PatchIssuerOffering = z.infer<typeof PatchIssuerOffering>;
 

package/common/types/offering.types.ts

@@ -15,6 +15,8 @@ import {
   SortBy,
   OfferingVersioningType,
   OfferingOnboardingStatus,
+  AssetType,
+  DurationType,
 } from './common.types';
 import { IBaseEntity } from './entity.types';
 import { fileIdSchema, FileZod } from './file.types';
@@ -24,6 +26,7 @@ import {
   InvestorsOfferingsIncludeQuery,
 } from './investors-offering.types';
 import { OfferingStatus } from './issuer-offering.types';
+import { postAssetRefinement, AssetTemplateType } from './asset.types';
 
 export enum OfferingFeeType {
   FIXED = 'FIXED',
@@ -115,7 +118,7 @@ export const IPaginatedOffering = z.object({
 });
 export type IPaginatedOffering = z.infer<typeof IPaginatedOffering>;
 
-export const PatchOffering = z.object({
+export const PatchOfferingBase = z.object({
   name: z.string().optional(),
   description: z.string().nullable().optional(),
   tid: z.string().optional(),
@@ -148,8 +151,8 @@ export const PatchOffering = z.object({
     .openapi({ example: 5000 })
     .optional()
     .nullable(),
-  startAt: dateSchema.optional(),
-  endAt: dateSchema.optional(),
+  startAt: dateSchema.optional().openapi({ example: '10/20/2024' }),
+  endAt: dateSchema.optional().openapi({ example: '10/27/2024' }),
   platform: z.string().optional(),
   coverArtId: z
     .lazy(() => fileIdSchema)
@@ -175,16 +178,106 @@ export const PatchOffering = z.object({
   showTotalRaised: z.boolean().optional(),
   issuerId: issuerIdSchema.optional(),
 });
-
+export const PatchOffering = PatchOfferingBase.merge(
+  z.object({
+    assetName: z
+      .string()
+      .min(2)
+      .max(50)
+      .optional()
+      .openapi({ example: 'Asset name' }),
+    assetType: z
+      .nativeEnum(AssetType)
+      .optional()
+      .openapi({ example: AssetType.STOCK }),
+    pricePerUnit: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 2000 }),
+    totalUnits: z
+      .number()
+      .min(1)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 5200 }),
+    yield: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1200 }),
+    duration: z
+      .number()
+      .min(1)
+      .max(1000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1 }),
+    durationType: z
+      .nativeEnum(DurationType)
+      .nullable()
+      .optional()
+      .openapi({ example: DurationType.DAY }),
+    template: z
+      .nativeEnum(AssetTemplateType)
+      .default(AssetTemplateType.STANDARD)
+      .openapi({ example: AssetTemplateType.STANDARD })
+      .nullable()
+      .optional(),
+    tiers: z.array(z.number().positive()).nullable().optional(),
+  }),
+);
 export type PatchOffering = z.infer<typeof PatchOffering>;
 
-export const PostComplianceOffering = PatchOffering.merge(
+export const PostComplianceOffering = PatchOfferingBase.merge(
   z.object({
     accountId: accountIdSchema,
+    managedBy: z.nativeEnum(ManagedByType).optional(),
+    assetName: z.string().min(2).max(50).openapi({ example: 'Asset name' }),
+    assetType: z.nativeEnum(AssetType).openapi({ example: AssetType.STOCK }),
+    pricePerUnit: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 2000 }),
+    totalUnits: z
+      .number()
+      .min(1)
+      .max(10000000000)
+      .nullable()
+      .openapi({ example: 5200 }),
+    yield: z
+      .number()
+      .min(0.01)
+      .max(10000000000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1200 }),
+    duration: z
+      .number()
+      .min(1)
+      .max(1000)
+      .nullable()
+      .optional()
+      .openapi({ example: 1 }),
+    durationType: z
+      .nativeEnum(DurationType)
+      .nullable()
+      .optional()
+      .openapi({ example: DurationType.DAY }),
+    template: z
+      .nativeEnum(AssetTemplateType)
+      .default(AssetTemplateType.STANDARD)
+      .openapi({ example: AssetTemplateType.STANDARD }),
+    tiers: z.array(z.number().positive()).nullable().optional(),
   }),
-).extend({
-  managedBy: z.nativeEnum(ManagedByType).optional(),
-});
+).superRefine(postAssetRefinement);
 export type PostComplianceOffering = z.infer<typeof PostComplianceOffering>;
 
 export const offeringsInclude = z.enum([
@@ -546,11 +639,9 @@ export type PaginatedPendingOfferingSummaryResponse = z.infer<
 >;
 
 export type OfferingUpdateFields = {
-  platform?: string;
-  platformSettings?: string | null;
   managedBy?: ManagedByType | null;
-  enabled?: boolean;
   showTotalRaised?: boolean;
+  enabled?: boolean;
 };
 
 export const ReviewOfferingOnboarding = z.object({

package/common/types/trade.types.ts

@@ -55,8 +55,71 @@ import {
 } from './secondary-trade.types';
 import { InvestorAccount } from '../../investor-accounts/entities/investor-account.entity';
 import { Trade } from '../../trades/entities/trade.entity';
+import { fileIdSchema } from './file.types';
 
 extendZodWithOpenApi(z);
+
+// Zod schemas for attach subdoc endpoints
+export const PostAttachSubdocBody = z.object({
+  lineItemId: tradeLineItemIdSchema.openapi({
+    example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
+  }),
+  fileId: z
+    .lazy(() => fileIdSchema)
+    .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
+  primarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .openapi({ example: 'SIGNED' }),
+  secondarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+});
+export type PostAttachSubdocBody = z.infer<typeof PostAttachSubdocBody>;
+
+export const PutAttachSubdocBody = z.object({
+  lineItemId: tradeLineItemIdSchema
+    .optional()
+    .openapi({ example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja' }),
+  fileId: z
+    .lazy(() => fileIdSchema)
+    .optional()
+    .openapi({ example: 'file_01je6ht4b8fbmttkzh2hs82xqp' }),
+  primarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+  secondarySignatureStatus: z
+    .nativeEnum(SignatureStatus)
+    .optional()
+    .openapi({ example: 'SIGNED' }),
+});
+export type PutAttachSubdocBody = z.infer<typeof PutAttachSubdocBody>;
+
+export const PatchSubdocSignatureBody = z.object({
+  lineItemId: tradeLineItemIdSchema.optional().openapi({
+    example: 'trade_line_item_01kctsycw3fq7sj6hedvy62cja',
+    description:
+      'Optional. If not provided, updates the first line item with an attached subdoc. Required for trades with multiple line items.',
+  }),
+  primarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
+    example: 'SIGNED',
+    description: 'Primary signer signature status',
+  }),
+  secondarySignatureStatus: z.nativeEnum(SignatureStatus).optional().openapi({
+    example: 'SIGNED',
+    description:
+      'Secondary signer signature status. Only applicable for JOINT investor accounts.',
+  }),
+});
+export type PatchSubdocSignatureBody = z.infer<typeof PatchSubdocSignatureBody>;
+
+export const AttachSubdocResponse = z.object({
+  success: z.boolean(),
+  message: z.string(),
+});
+export type AttachSubdocResponse = z.infer<typeof AttachSubdocResponse>;
+
 export const CheckResultsSchema = z.object({
   fundingStatus: z.boolean(),
   agreementStatus: z.boolean(),

package/contracts/clients/cart/index.ts

@@ -0,0 +1,40 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import {
+  UnauthorizedError,
+  ForbiddenError,
+  BadRequestError,
+  InternalError,
+  TradeZod,
+  tradeIdSchema,
+} from '../../../common/types';
+import { PatchCartBody } from '../../../common/types/cart.types';
+
+const c = initContract();
+
+export const cartContract = c.router(
+  {
+    patchCart: {
+      summary: 'Patch a cart',
+      method: 'PATCH',
+      path: '/:id',
+      metadata: {
+        auth: true,
+      },
+      pathParams: z.object({
+        id: tradeIdSchema,
+      }),
+      body: PatchCartBody,
+      responses: {
+        200: TradeZod,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        500: InternalError,
+      },
+    },
+  },
+  {
+    pathPrefix: 'carts',
+  },
+);

package/contracts/clients/index.ts

@@ -3,6 +3,7 @@ import { accountsContract } from './accounts';
 import { apiKeysContract } from './api-keys';
 import { clientApiKeyLogsContract } from './api-key-logs';
 import { assetsContract } from './assets';
+import { cartContract } from './cart';
 import { filesContract } from './files';
 import { individualsContract } from './individuals';
 import { investorAccountsContract } from './investor-accounts';
@@ -27,6 +28,7 @@ export const clientsContract = c.router(
     apiKeys: apiKeysContract,
     apiKeyLogs: clientApiKeyLogsContract,
     assets: assetsContract,
+    cart: cartContract,
     files: filesContract,
     filesPublic: filesPublicContract,
     individuals: individualsContract,

package/contracts/clients/trades/index.ts

@@ -16,6 +16,10 @@ import {
   tradeIdOrTidSchema,
   TradesIncludeQuery,
   TradeZod,
+  PostAttachSubdocBody,
+  PutAttachSubdocBody,
+  PatchSubdocSignatureBody,
+  AttachSubdocResponse,
 } from '../../../common/types/trade.types';
 import { z } from 'zod';
 import {
@@ -115,6 +119,66 @@ export const tradesContract = c.router(
         500: InternalError,
       },
     },
+    postAttachSubdoc: {
+      summary: 'Attach subdoc to trade',
+      method: 'POST',
+      path: '/:id/attach-subdoc',
+      pathParams: z.object({
+        id: tradeIdOrTidSchema,
+      }),
+      metadata: {
+        auth: true,
+      },
+      body: PostAttachSubdocBody,
+      responses: {
+        200: AttachSubdocResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    putAttachSubdoc: {
+      summary: 'Update attached subdoc for trade',
+      method: 'PUT',
+      path: '/:id/attach-subdoc',
+      pathParams: z.object({
+        id: tradeIdOrTidSchema,
+      }),
+      metadata: {
+        auth: true,
+      },
+      body: PutAttachSubdocBody,
+      responses: {
+        200: AttachSubdocResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
+    patchSubdocSign: {
+      summary: 'Update subdoc signature statuses for trade',
+      method: 'PATCH',
+      path: '/:id/sign',
+      pathParams: z.object({
+        id: tradeIdOrTidSchema,
+      }),
+      metadata: {
+        auth: true,
+      },
+      body: PatchSubdocSignatureBody,
+      responses: {
+        200: AttachSubdocResponse,
+        400: BadRequestError,
+        401: UnauthorizedError,
+        403: ForbiddenError,
+        404: NotFoundError,
+        500: InternalError,
+      },
+    },
   },
   {
     pathPrefix: 'trades',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "0.0.0-dev.58a860b",
+  "version": "0.0.0-dev.ab1033d",
   "description": "Type-safe API contracts for Dalmore Client Portal",
   "main": "./contracts/index.ts",
   "types": "./contracts/index.ts",