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

package/common/types/zip.type.ts

@@ -1,36 +0,0 @@
-import { z } from 'zod';
-import { validateCanadaZipCode, validateUSZipCode } from '../helpers';
-import { CountryCode, CountryEnumSchema } from './countries.types';
-
-export function refineAddressZip(
-  country: string | undefined | null,
-  zip: string | undefined | null,
-) {
-  return country === CountryCode['US']
-    ? !zip || validateUSZipCode(zip)
-    : country === CountryCode['CA']
-      ? !zip || validateCanadaZipCode(zip) // it's optional, so if nullish, it's valid
-      : z.string().min(2).max(10).nullable().optional().safeParse(zip).success;
-}
-
-export const ZipSchema = z.string();
-
-export const CountryZipSchema = z
-  .object({
-    country: CountryEnumSchema.nullable().optional(),
-    zip: ZipSchema.nullable().optional(),
-  })
-  .refine(({ zip, country }) => refineAddressZip(country, zip), {
-    message:
-      'zip value is not valid, it shall follow the US(12345 or 12345-6789), CANADA(A1A 1A1) format! it shall be a string for other states',
-  });
-
-export const RequiredCountryZipSchema = z
-  .object({
-    country: CountryEnumSchema,
-    zip: ZipSchema,
-  })
-  .refine(({ zip, country }) => refineAddressZip(country, zip), {
-    message:
-      'zip value is not valid, it shall follow the US(12345 or 12345-6789), CANADA(A1A 1A1) format! it shall be a string for other states',
-  });

package/contracts/clients/accounts/index.ts

@@ -1,61 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  ForbiddenError,
-  IPaginatedAccount,
-  NotFoundError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-  AccountFiltersZod,
-  AccountsIncludeQuery,
-  AccountZod,
-  accountIdSchema,
-  InternalError,
-} from '../../../common/types';
-import { z } from 'zod';
-
-const c = initContract();
-
-export const accountsContract = c.router(
-  {
-    getAccount: {
-      summary: 'Get account by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({}).merge(AccountsIncludeQuery),
-      pathParams: z.object({
-        id: accountIdSchema,
-      }),
-      responses: {
-        200: AccountZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    getAccounts: {
-      summary: 'Get accounts',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query:
-        PaginationOptionsZod.merge(AccountFiltersZod).merge(
-          AccountsIncludeQuery,
-        ),
-      responses: {
-        200: IPaginatedAccount,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'accounts',
-  },
-);

package/contracts/clients/aic/index.ts

@@ -1,59 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  AicIncludeQuery,
-  AicZod,
-  AttachAicFileBodyZod,
-  BadRequestError,
-  ForbiddenError,
-  individualIdSchema,
-  InternalError,
-  UnauthorizedError,
-} from '../../../common/types';
-import { z } from 'zod';
-
-const c = initContract();
-export const aicContract = c.router(
-  {
-    getAic: {
-      summary: 'Get AIC',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        individualId: individualIdSchema,
-      }),
-      query: AicIncludeQuery,
-      responses: {
-        200: AicZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    attachAicFile: {
-      summary: 'Attach AIC File',
-      method: 'PUT',
-      path: '/file',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        individualId: individualIdSchema,
-      }),
-      body: AttachAicFileBodyZod,
-      responses: {
-        200: AicZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'individual/:individualId/aic',
-  },
-);

package/contracts/clients/api-key-logs/index.ts

@@ -1,53 +0,0 @@
-import { initContract } from '@ts-rest/core';
-
-import {
-  BadRequestError,
-  ForbiddenError,
-  InternalError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  IPaginatedApiLogs,
-  ApiLogsTotalsZod,
-  ApiLogsFiltersZod,
-  ApiLogsTotalsFiltersZod,
-} from '../../../common/types/api-key-logs.types';
-
-const c = initContract();
-
-export const clientApiKeyLogsContract = c.router(
-  {
-    // GET /clients/api-key-logs
-    getApiKeyLogs: {
-      summary: 'Get API key logs',
-      method: 'GET',
-      path: '',
-      metadata: { auth: true },
-      query: PaginationOptionsZod.merge(ApiLogsFiltersZod),
-      responses: {
-        200: IPaginatedApiLogs,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    // GET /clients/api-key-logs/totals
-    getApiKeyLogsTotals: {
-      summary: 'Get totals of API key logs',
-      method: 'GET',
-      path: '/totals',
-      metadata: { auth: true },
-      query: ApiLogsTotalsFiltersZod,
-      responses: {
-        200: ApiLogsTotalsZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-  },
-  { pathPrefix: 'api-key-logs' },
-);

package/contracts/clients/api-keys/index.ts

@@ -1,73 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  ForbiddenError,
-  NotFoundError,
-  UnauthorizedError,
-  InternalError,
-  ApiKeyZod,
-  IPaginatedApiKeys,
-  PaginationOptionsZod,
-  BadRequestError,
-  apiKeyIdSchema,
-} from '../../../common/types';
-import { z } from 'zod';
-
-const c = initContract();
-
-export const apiKeysContract = c.router(
-  {
-    getApiKeys: {
-      summary: 'Get API Keys',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod,
-      responses: {
-        200: IPaginatedApiKeys,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-      },
-    },
-    getApiKey: {
-      summary: 'Get API Key',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: apiKeyIdSchema,
-      }),
-      responses: {
-        200: ApiKeyZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-    deactivateApiKey: {
-      summary: 'Deactivate API Key by id',
-      method: 'PATCH',
-      path: '/:id/deactivate',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: apiKeyIdSchema,
-      }),
-      body: z.object({}),
-      responses: {
-        202: ApiKeyZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'api-keys',
-  },
-);

package/contracts/clients/assets/index.ts

@@ -1,102 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import { z } from 'zod';
-import {
-  BadRequestError,
-  ConflictError,
-  ForbiddenError,
-  InternalError,
-  NotFoundError,
-  PaginationOptionsZod,
-  UnauthorizedError,
-} from '../../../common/types';
-import {
-  AssetFiltersZod,
-  assetIdSchema,
-  AssetsIncludeQuery,
-  IAsset,
-  IPaginatedAsset,
-  PostAsset,
-  PutAsset,
-} from '../../../common/types/asset.types';
-
-const c = initContract();
-
-export const assetsContract = c.router(
-  {
-    getAssets: {
-      summary: 'Get assets',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query:
-        PaginationOptionsZod.merge(AssetsIncludeQuery).merge(AssetFiltersZod),
-      responses: {
-        200: IPaginatedAsset,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-      },
-    },
-    getAsset: {
-      summary: 'Get asset by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({}).merge(AssetsIncludeQuery),
-      pathParams: z.object({
-        id: assetIdSchema,
-      }),
-      responses: {
-        200: IAsset,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-      },
-    },
-    postAssets: {
-      summary: 'Create an asset',
-      method: 'POST',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      body: PostAsset,
-      responses: {
-        201: IAsset,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        409: ConflictError,
-        500: InternalError,
-      },
-    },
-    updateAsset: {
-      summary: 'Update asset',
-      method: 'PUT',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: assetIdSchema,
-      }),
-      body: PutAsset,
-      responses: {
-        201: IAsset,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-  },
-
-  {
-    pathPrefix: 'assets',
-  },
-);

package/contracts/clients/auth/index.ts

@@ -1,50 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  AccessTokenResponse,
-  BadRequestError,
-  ClientAuthSuccessResponse,
-  InternalError,
-  IRegisterClientIssuerBodyZod,
-  RegisterBodyInvestors,
-  UnauthorizedError,
-} from '../../../common/types';
-
-const c = initContract();
-
-export const authContract = c.router(
-  {
-    registerInvestor: {
-      summary: 'Register investor with email (API Key Auth)',
-      method: 'POST',
-      path: 'register/investor',
-      metadata: {
-        auth: true,
-      },
-      body: RegisterBodyInvestors,
-      responses: {
-        201: ClientAuthSuccessResponse,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        500: InternalError,
-      },
-    },
-    registerIssuer: {
-      summary: 'Register issuer with email (API Key Auth)',
-      method: 'POST',
-      path: 'register/issuer',
-      metadata: {
-        auth: true,
-      },
-      body: IRegisterClientIssuerBodyZod,
-      responses: {
-        201: AccessTokenResponse,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        500: InternalError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'auth/',
-  },
-);

package/contracts/clients/cart/index.ts

@@ -1,80 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import { z } from 'zod';
-import {
-  UnauthorizedError,
-  ForbiddenError,
-  NotFoundError,
-  BadRequestError,
-  InternalError,
-  TradeZod,
-  userIdSchema,
-  tradeIdSchema,
-} from '../../../common/types';
-import {
-  PatchCartBody,
-  ClientPlacetradeBody,
-  PlaceTradeResponse,
-} from '../../../common/types/cart.types';
-
-const c = initContract();
-
-export const cartContract = c.router(
-  {
-    getTradeCart: {
-      summary: 'Get carts (Trade.status = CART)',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: z.object({
-        userId: userIdSchema,
-      }),
-      responses: {
-        200: TradeZod,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    postCheckout: {
-      summary: 'Place a trade (checkout button)',
-      method: 'POST',
-      path: '/checkout',
-      metadata: {
-        auth: true,
-      },
-      body: ClientPlacetradeBody,
-      responses: {
-        200: PlaceTradeResponse,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        403: ForbiddenError,
-        500: InternalError,
-      },
-    },
-    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/files/index.ts

@@ -1,166 +0,0 @@
-import { initContract } from '@ts-rest/core';
-import {
-  BadGateWayError,
-  BadRequestError,
-  ClientPostFileQueryParams,
-  fileIdSchema,
-  FilesIncludeQuery,
-  FileZod,
-  InternalError,
-  IPaginatedFile,
-  LinkFileZod,
-  NotFoundError,
-  PaginationOptionsZod,
-  PatchFile,
-  UnauthorizedError,
-  UnprocessableError,
-} from '../../../common/types';
-import { z } from 'zod';
-import { authHeader, generateApiDescription } from '../../../common/helpers';
-
-const c = initContract();
-
-export const filesContract = c.router(
-  {
-    postFile: {
-      summary: 'Upload a file',
-      description: generateApiDescription(
-        'Upload a file to the system. CLIENT portal only supports uploads to INDIVIDUALS.',
-        'POST',
-        '/files',
-        {
-          query: {
-            name: 'test',
-            category: 'application',
-            targetId: 'individual_01j5tkg6k2fygr0x06fegt27aj',
-          },
-          headers: authHeader,
-          formData: { file: '@"/Users/local/Desktop/test.csv"' },
-        },
-      ),
-      method: 'POST',
-      path: '',
-      query: ClientPostFileQueryParams,
-      contentType: 'multipart/form-data',
-      body: c.type<{ file: File }>(),
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        201: FileZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        422: UnprocessableError,
-        500: InternalError,
-        502: BadGateWayError,
-      },
-    },
-    linkFile: {
-      summary: 'Links a file to a new resource',
-      method: 'POST',
-      path: '/:id/link',
-      pathParams: z.object({
-        id: fileIdSchema,
-      }),
-      body: LinkFileZod,
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        201: FileZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        422: UnprocessableError,
-        500: InternalError,
-        502: BadGateWayError,
-      },
-    },
-    unlinkFile: {
-      summary: 'Unlinks a file to the parent resource',
-      method: 'POST',
-      path: '/:id/unlink',
-      pathParams: z.object({
-        id: fileIdSchema,
-      }),
-      body: z.object({}),
-      metadata: {
-        auth: true,
-      },
-      responses: {
-        202: FileZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        422: UnprocessableError,
-        500: InternalError,
-        502: BadGateWayError,
-      },
-    },
-    getFiles: {
-      summary: 'Get files',
-      method: 'GET',
-      path: '',
-      metadata: {
-        auth: true,
-      },
-      query: PaginationOptionsZod.merge(FilesIncludeQuery),
-      responses: {
-        200: IPaginatedFile,
-        401: UnauthorizedError,
-      },
-    },
-    getFile: {
-      summary: 'Get file by id',
-      method: 'GET',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: fileIdSchema,
-      }),
-      responses: {
-        200: FileZod,
-        401: UnauthorizedError,
-        404: NotFoundError,
-      },
-    },
-    patchFile: {
-      summary: 'Update file by id',
-      method: 'PATCH',
-      path: '/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: fileIdSchema,
-      }),
-      body: PatchFile,
-      responses: {
-        201: FileZod,
-        400: BadRequestError,
-        401: UnauthorizedError,
-        404: NotFoundError,
-        500: InternalError,
-      },
-    },
-    previewFile: {
-      summary: 'Preview (stream) a file by id',
-      method: 'GET',
-      path: '/preview/:id',
-      metadata: {
-        auth: true,
-      },
-      pathParams: z.object({
-        id: fileIdSchema,
-      }),
-      responses: {
-        200: z.unknown(),
-        401: UnauthorizedError,
-        404: NotFoundError,
-      },
-    },
-  },
-  {
-    pathPrefix: 'files',
-  },
-);