@dalmore/api-contracts 0.0.0-dev.988f3c3 → 0.0.0-dev.9d42e16

package/common/types/trusted-contact.types.ts

@@ -2,7 +2,11 @@ import { extendZodWithOpenApi } from '@anatine/zod-openapi';
 import { TypeID } from 'typeid-js';
 import { z } from 'zod';
 import { IBaseEntity } from './entity.types';
-import { IPaginationMeta, TrustedContactRelationship } from './common.types';
+import {
+  EmailSchema,
+  IPaginationMeta,
+  TrustedContactRelationship,
+} from './common.types';
 import { PhoneZodSchema } from './phone.type';
 import { AddressSchema } from './address.types';
 import { investorAccountIdSchema } from './investor-account.types';
@@ -68,7 +72,7 @@ export const PostTrustedContactZod = z
   .object({
     firstName: z.string().min(1).max(255).openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).openapi({ example: 'Doe' }),
-    email: z.string().email().openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.openapi({ example: 'john.doe@example.com' }),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z
       .nativeEnum(TrustedContactRelationship)
@@ -92,11 +96,7 @@ export const PatchTrustedContactZod = z
       .optional()
       .openapi({ example: 'John' }),
     lastName: z.string().min(1).max(255).optional().openapi({ example: 'Doe' }),
-    email: z
-      .string()
-      .email()
-      .optional()
-      .openapi({ example: 'john.doe@example.com' }),
+    email: EmailSchema.optional(),
     phone: PhoneZodSchema.nullable().optional(),
     relationship: z.nativeEnum(TrustedContactRelationship).optional().openapi({
       example: TrustedContactRelationship.CHILD,

package/common/types/user.types.ts

@@ -11,6 +11,7 @@ import {
   StringToBooleanSchema,
   UserRole,
   UserType,
+  EmailSchema,
 } from './common.types';
 import { dateOrString, IBaseEntity } from './entity.types';
 import { PhoneZodSchema } from './phone.type';
@@ -147,11 +148,7 @@ export const UserMeUpdateZod = z.object({
   firstName: z.string().optional(),
   lastName: z.string().optional(),
   password: z.string().min(6).optional(),
-  email: z
-    .string()
-    .email()
-    .transform((val) => val.toLowerCase())
-    .optional(),
+  email: EmailSchema.optional(),
 });
 
 export const UserZod = IBaseEntity.extend({

package/common/types/webhook.types.ts

@@ -1,6 +1,148 @@
 import { z } from 'zod';
 import { PersonaStatus } from './common.types';
 
+/**
+ * Hook0 Webhook Provider Types
+ *
+ * Types for interacting with Hook0's webhooks-as-a-service API.
+ * @see https://documentation.hook0.com/api - API Reference
+ */
+
+/**
+ * Hook0 API error response format.
+ * @see https://documentation.hook0.com/api
+ */
+export const Hook0ApiErrorSchema = z.object({
+  type: z.string(),
+  status: z.number(),
+  title: z.string(),
+  detail: z.string(),
+  validation: z.unknown().nullable(),
+  id: z.string(),
+});
+export type Hook0ApiError = z.infer<typeof Hook0ApiErrorSchema>;
+
+/**
+ * Error returned from Hook0 provider operations.
+ * Wraps Hook0 API errors with additional context.
+ */
+export const Hook0ProviderErrorSchema = z.object({
+  message: z.string(),
+  statusCode: z.number().optional(),
+  code: z.string().optional(),
+  apiError: Hook0ApiErrorSchema.optional(),
+});
+export type Hook0ProviderError = z.infer<typeof Hook0ProviderErrorSchema>;
+
+/**
+ * Hook0 subscription target configuration.
+ * Defines where and how webhooks are delivered.
+ * @see https://documentation.hook0.com/reference/subscriptionscreate
+ */
+export const Hook0SubscriptionTargetSchema = z.object({
+  type: z.literal('http'),
+  method: z.string(),
+  url: z.string().url(),
+  headers: z.record(z.string()).optional(),
+});
+export type Hook0SubscriptionTarget = z.infer<
+  typeof Hook0SubscriptionTargetSchema
+>;
+
+/**
+ * Hook0 subscription response from create/get operations.
+ * @see https://documentation.hook0.com/reference/subscriptionscreate
+ * @see https://documentation.hook0.com/reference/subscriptionsget
+ */
+export const Hook0SubscriptionResponseSchema = z.object({
+  subscription_id: z.string().uuid(),
+  application_id: z.string().uuid(),
+  created_at: z.string().datetime().optional(),
+  dedicated_workers: z.array(z.string()).optional(),
+  description: z.string().optional(),
+  event_types: z.array(z.string()).optional(),
+  is_enabled: z.boolean().optional(),
+  label_key: z.string().optional(),
+  label_value: z.string().optional(),
+  labels: z.record(z.string()).optional(),
+  metadata: z.record(z.string()).optional(),
+  secret: z.string(),
+  target: Hook0SubscriptionTargetSchema.optional(),
+});
+export type Hook0SubscriptionResponse = z.infer<
+  typeof Hook0SubscriptionResponseSchema
+>;
+
+/**
+ * Simplified subscription result returned to callers.
+ */
+export const WebhookSubscriptionSchema = z.object({
+  subscriptionId: z.string(),
+  secret: z.string(),
+});
+export type WebhookSubscription = z.infer<typeof WebhookSubscriptionSchema>;
+
+/**
+ * Hook0 event type response from create operation.
+ * @see https://documentation.hook0.com/reference/eventtypescreate
+ */
+export const Hook0EventTypeResponseSchema = z.object({
+  service_name: z.string(),
+  resource_type_name: z.string(),
+  verb_name: z.string(),
+  event_type_name: z.string(),
+});
+export type Hook0EventTypeResponse = z.infer<
+  typeof Hook0EventTypeResponseSchema
+>;
+
+/**
+ * Hook0 event type list item.
+ * @see https://documentation.hook0.com/reference/eventtypeslist
+ */
+export const Hook0EventTypeSchema = z.object({
+  name: z.string(),
+  service: z.string().optional(),
+  resource_type: z.string().optional(),
+  verb: z.string().optional(),
+});
+export type Hook0EventType = z.infer<typeof Hook0EventTypeSchema>;
+
+/**
+ * Hook0 event ingestion response.
+ * @see https://documentation.hook0.com/api/#tag/events-ingestion/POST/api/v1/event/
+ */
+export const Hook0EventResponseSchema = z.object({
+  event_id: z.string().uuid().optional(),
+  received_at: z.string().datetime().optional(),
+});
+export type Hook0EventResponse = z.infer<typeof Hook0EventResponseSchema>;
+
+/**
+ * Simplified event response returned to callers.
+ */
+export const WebhookEventResponseSchema = z.object({
+  eventId: z.string(),
+  receivedAt: z.string(),
+});
+export type WebhookEventResponse = z.infer<typeof WebhookEventResponseSchema>;
+
+/**
+ * Payload sent when ingesting events to Hook0.
+ * Contains activity data to be delivered to webhook subscribers.
+ */
+export const WebhookEventPayloadSchema = z.object({
+  activityId: z.string(),
+  activityType: z.string(),
+  accountId: z.string(),
+  targetId: z.string().nullable(),
+  targetTable: z.string().nullable(),
+  message: z.string(),
+  metadata: z.record(z.unknown()),
+  occurredAt: z.string(),
+});
+export type WebhookEventPayload = z.infer<typeof WebhookEventPayloadSchema>;
+
 export const WebhookReceived = z.object({
   received: z.boolean(),
 });

package/index.ts

@@ -0,0 +1,10 @@
+/**
+ * @dalmore/api-contracts
+ * Main entry point - re-exports clients contract and types
+ */
+
+// Re-export clients contract
+export * from './contracts/clients/index.js';
+
+// Re-export all common types
+export * from './common/types/index.js';

package/package.json

@@ -1,48 +1,42 @@
 {
   "name": "@dalmore/api-contracts",
-  "version": "0.0.0-dev.988f3c3",
+  "version": "0.0.0-dev.9d42e16",
   "description": "Type-safe API contracts for Dalmore Client Portal",
-  "main": "./contracts/index.ts",
-  "types": "./contracts/index.ts",
+  "type": "module",
+  "main": "./index.ts",
+  "types": "./index.ts",
   "exports": {
     ".": {
-      "types": "./contracts/index.ts",
-      "default": "./contracts/index.ts"
-    },
-    "./compliance": {
-      "types": "./contracts/compliance/index.ts",
-      "default": "./contracts/compliance/index.ts"
-    },
-    "./investors": {
-      "types": "./contracts/investors/index.ts",
-      "default": "./contracts/investors/index.ts"
-    },
-    "./issuers": {
-      "types": "./contracts/issuers/index.ts",
-      "default": "./contracts/issuers/index.ts"
+      "types": "./index.ts",
+      "import": "./index.ts",
+      "default": "./index.ts"
     },
     "./clients": {
       "types": "./contracts/clients/index.ts",
+      "import": "./contracts/clients/index.ts",
       "default": "./contracts/clients/index.ts"
     },
-    "./secondaries": {
-      "types": "./contracts/secondaries/index.ts",
-      "default": "./contracts/secondaries/index.ts"
-    },
-    "./compliance-apikey": {
-      "types": "./contracts/compliance-apikey/index.ts",
-      "default": "./contracts/compliance-apikey/index.ts"
-    },
     "./types": {
       "types": "./common/types/index.ts",
+      "import": "./common/types/index.ts",
       "default": "./common/types/index.ts"
-    },
-    "./types/*": {
-      "types": "./common/types/*.ts",
-      "default": "./common/types/*.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./index.ts"
+      ],
+      "clients": [
+        "./contracts/clients/index.ts"
+      ],
+      "types": [
+        "./common/types/index.ts"
+      ]
     }
   },
   "files": [
+    "index.ts",
     "contracts",
     "common"
   ],
@@ -68,9 +62,6 @@
     "typeid-js": "^1.2.0",
     "zod": "^3.24.4"
   },
-  "devDependencies": {
-    "typescript": "^5.8.3"
-  },
   "engines": {
     "node": ">=24.0.0 <25.0.0"
   }

package/contracts/compliance/account-contacts/index.ts

@@ -1,82 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  accountIdSchema,
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  accountContactIdSchema,
-  CompliancePatchAccountContactZod,
-  IAccountContact,
-} from '../../../common/types/account-contact.types';
-import { z } from 'zod';
-
-const c = initContract();
-
-export const accountContactsContract = c.router(
-  {
-    getAccountContacts: {
-      summary: '[ADMIN] Get Account Contacts',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({
-        accountId: accountIdSchema,
-      }),
-      responses: {
-        200: z.array(IAccountContact),
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    getAccountContact: {
-      summary: '[ADMIN] Get account contact by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: accountContactIdSchema,
-      }),
-      query: z.object({
-        accountId: accountIdSchema,
-      }),
-      responses: {
-        200: IAccountContact,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-    patchAccountContact: {
-      summary: '[ADMIN] Update account contact',
-      method: 'PATCH',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: accountContactIdSchema,
-      }),
-      body: CompliancePatchAccountContactZod,
-      responses: {
-        200: IAccountContact,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'account-contacts',
-  },
-);

package/contracts/compliance/account-managers/index.ts

@@ -1,142 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import { z } from 'zod';
-import {
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  PaginationOptionsZod,
-  PreconditionFailedError,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  AccountManagerDeleteQuery,
-  AccountManagerDeleteResponse,
-  accountManagerIdSchema,
-  AccountManagersIncludeQuery,
-  IAccountManagerZod,
-  IPaginatedAccountManager,
-  PatchAccountManagerZod,
-  PostAccountManagerZod,
-  SetDefaultAccountManagerForAllAccountsResponse,
-} from '../../../common/types/account-manager.types';
-
-const c = initContract();
-
-export const accountManagersContract = c.router(
-  {
-    getAccountManagers: {
-      summary: 'Get account managers',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(AccountManagersIncludeQuery),
-      responses: {
-        200: IPaginatedAccountManager,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    getAccountManager: {
-      summary: 'Get account manager by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({}).merge(AccountManagersIncludeQuery),
-      pathParams: z.object({
-        id: accountManagerIdSchema,
-      }),
-      responses: {
-        200: IAccountManagerZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    setDefaultAccountManagerForAllAccounts: {
-      summary: '[ADMIN] Set default account manager for all accounts',
-      method: 'PATCH',
-      path: '/set-default-for-all-accounts',
-      metadata: {
-        auth: true,
-      },
-      body: z.object({}),
-      responses: {
-        200: SetDefaultAccountManagerForAllAccountsResponse,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    patchAccountManager: {
-      summary: 'Update account manager by id',
-      method: 'PATCH',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: accountManagerIdSchema,
-      }),
-      body: PatchAccountManagerZod,
-      responses: {
-        201: IAccountManagerZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postAccountManager: {
-      summary: 'Create account manager',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostAccountManagerZod,
-      responses: {
-        201: IAccountManagerZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    deleteAccountManager: {
-      summary: 'Delete account manager by id',
-      method: 'DELETE',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: accountManagerIdSchema,
-      }),
-      query: AccountManagerDeleteQuery,
-      responses: {
-        201: AccountManagerDeleteResponse,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        412: PreconditionFailedError,
-        500: InternalError,
-      },
-    },
-  },
-
-  {
-    pathPrefix: 'account-managers',
-  },
-);

package/contracts/compliance/account-settings/index.ts

@@ -1,59 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import { z } from 'zod';
-import {
-  accountSettingIdSchema,
-  AccountSettingsFilters,
-  AccountSettingsIncludeQuery,
-  IAccountSettingZod,
-  IPaginatedAccountSetting,
-} from '../../../common/types/account-setting.types';
-import {
-  InternalError,
-  NotFoundError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-} from '../../../common/types';
-
-const c = initContract();
-
-export const accountSettingsContract = c.router(
-  {
-    getAccountSettings: {
-      summary: 'Get account settings',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(AccountSettingsFilters).merge(
-        AccountSettingsIncludeQuery,
-      ),
-      responses: {
-        200: IPaginatedAccountSetting,
-        401: UnauthorizedError,
-        500: InternalError,
-      },
-    },
-    getAccountSetting: {
-      summary: 'Get account setting by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: accountSettingIdSchema,
-      }),
-      query: z.object({}).merge(AccountSettingsIncludeQuery),
-      responses: {
-        200: IAccountSettingZod,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'account-settings',
-  },
-);