@dakkitor/api-contracts 1.1.9 → 1.1.11

package/dist/common/common-schemas.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageResponseSchema = exports.PayRangeSchema = exports.UserSummarySchema = exports.ResourceIdSchema = exports.AutocompleteQuerySchema = exports.LocationDetailsSchema = exports.CreateLocationSchema = exports.NationalitySchema = exports.EnglishLevelSchema = exports.DateRangeSchema = exports.RateUnitSchema = exports.SortOrderSchema = void 0;
+const zod_openapi_1 = require("@anatine/zod-openapi");
+const zod_1 = require("zod");
+(0, zod_openapi_1.extendZodWithOpenApi)(zod_1.z);
+/**
+ * Common enum schemas used across multiple contracts
+ */
+exports.SortOrderSchema = zod_1.z
+    .enum(['ASC', 'DESC'])
+    .openapi({ title: 'SortOrder' });
+exports.RateUnitSchema = zod_1.z
+    .enum(['DAILY', 'HOURLY'])
+    .openapi({ title: 'RateUnit' });
+exports.DateRangeSchema = zod_1.z
+    .object({
+    from: zod_1.z
+        .string()
+        .date()
+        .nullish()
+        .describe('Start of the date range (inclusive)'),
+    to: zod_1.z
+        .string()
+        .date()
+        .nullish()
+        .describe('End of the date range (inclusive)'),
+})
+    .openapi({ title: 'DateRange' });
+exports.EnglishLevelSchema = zod_1.z
+    .enum(['NONE', 'BASIC', 'INTERMEDIATE', 'ADVANCED', 'NATIVE'])
+    .openapi({ title: 'EnglishLevel' });
+exports.NationalitySchema = zod_1.z
+    .enum([
+    'AFGHAN',
+    'ALBANIAN',
+    'ALGERIAN',
+    'AMERICAN',
+    'ANDORRAN',
+    'ANGOLAN',
+    'ANTIGUANS',
+    'ARGENTINEAN',
+    'ARMENIAN',
+    'AUSTRALIAN',
+    'AUSTRIAN',
+    'AZERBAIJANI',
+    'BAHAMIAN',
+    'BAHRAINI',
+    'BANGLADESHI',
+    'BARBADIAN',
+    'BARBUDANS',
+    'BELARUSIAN',
+    'BELGIAN',
+    'BELIZEAN',
+    'BENINESE',
+    'BHUTANESE',
+    'BOLIVIAN',
+    'BOSNIAN',
+    'BRAZILIAN',
+    'BRITISH',
+    'BRUNEIAN',
+    'BULGARIAN',
+    'BURKINABE',
+    'BURMESE',
+    'BURUNDIAN',
+    'CAMBODIAN',
+    'CAMEROONIAN',
+    'CANADIAN',
+    'CAPE_VERDEAN',
+    'CENTRAL_AFRICAN',
+    'CHADIAN',
+    'CHILEAN',
+    'CHINESE',
+    'COLOMBIAN',
+    'COMORAN',
+    'CONGOLESE',
+    'COSTA_RICAN',
+    'CROATIAN',
+    'CUBAN',
+    'CYPRIOT',
+    'CZECH',
+    'DANISH',
+    'DJIBOUTI',
+    'DOMINICAN',
+    'DUTCH',
+    'EAST_TIMORESE',
+    'ECUADOREAN',
+    'EGYPTIAN',
+    'EMIRIAN',
+    'EQUATORIAL_GUINEAN',
+    'ERITREAN',
+    'ESTONIAN',
+    'ETHIOPIAN',
+    'FIJIAN',
+    'FILIPINO',
+    'FINNISH',
+    'FRENCH',
+    'GABONESE',
+    'GAMBIAN',
+    'GEORGIAN',
+    'GERMAN',
+    'GHANAIAN',
+    'GREEK',
+    'GRENADIAN',
+    'GUATEMALAN',
+    'GUINEA_BISSAUAN',
+    'GUINEAN',
+    'GUYANESE',
+    'HAITIAN',
+    'HERZEGOVINIAN',
+    'HONDURAN',
+    'HUNGARIAN',
+    'ICELANDER',
+    'INDIAN',
+    'INDONESIAN',
+    'IRANIAN',
+    'IRAQI',
+    'IRISH',
+    'ISRAELI',
+    'ITALIAN',
+    'IVORIAN',
+    'JAMAICAN',
+    'JAPANESE',
+    'JORDANIAN',
+    'KAZAKHSTANI',
+    'KENYAN',
+    'KITTIAN_AND_NEVISIAN',
+    'KUWAITI',
+    'KYRGYZ',
+    'LAOTIAN',
+    'LATVIAN',
+    'LEBANESE',
+    'LIBERIAN',
+    'LIBYAN',
+    'LIECHTENSTEINER',
+    'LITHUANIAN',
+    'LUXEMBOURGER',
+    'MACEDONIAN',
+    'MALAGASY',
+    'MALAWIAN',
+    'MALAYSIAN',
+    'MALDIVAN',
+    'MALIAN',
+    'MALTESE',
+    'MARSHALLESE',
+    'MAURITANIAN',
+    'MAURITIAN',
+    'MEXICAN',
+    'MICRONESIAN',
+    'MOLDOVAN',
+    'MONACAN',
+    'MONGOLIAN',
+    'MOROCCAN',
+    'MOSOTHO',
+    'MOTSWANA',
+    'MOZAMBICAN',
+    'NAMIBIAN',
+    'NAURUAN',
+    'NEPALESE',
+    'NEW_ZEALANDER',
+    'NI_VANUATU',
+    'NICARAGUAN',
+    'NIGERIEN',
+    'NIGERIAN',
+    'NORTH_KOREAN',
+    'NORTHERN_IRISH',
+    'NORWEGIAN',
+    'OMANI',
+    'PAKISTANI',
+    'PALAUAN',
+    'PANAMANIAN',
+    'PAPUA_NEW_GUINEAN',
+    'PARAGUAYAN',
+    'PERUVIAN',
+    'POLISH',
+    'PORTUGUESE',
+    'QATARI',
+    'ROMANIAN',
+    'RUSSIAN',
+    'RWANDAN',
+    'SAINT_LUCIAN',
+    'SALVADORAN',
+    'SAMOAN',
+    'SAN_MARINESE',
+    'SAO_TOMEAN',
+    'SAUDI',
+    'SCOTTISH',
+    'SENEGALESE',
+    'SERBIAN',
+    'SEYCHELLOIS',
+    'SIERRA_LEONEAN',
+    'SINGAPOREAN',
+    'SLOVAKIAN',
+    'SLOVENIAN',
+    'SOLOMON_ISLANDER',
+    'SOMALI',
+    'SOUTH_AFRICAN',
+    'SOUTH_KOREAN',
+    'SOUTH_SUDANESE',
+    'SPANISH',
+    'SRI_LANKAN',
+    'SUDANESE',
+    'SURINAMER',
+    'SWAZI',
+    'SWEDISH',
+    'SWISS',
+    'SYRIAN',
+    'TAIWANESE',
+    'TAJIK',
+    'TANZANIAN',
+    'THAI',
+    'TOGOLESE',
+    'TONGAN',
+    'TRINIDADIAN_OR_TOBAGONIAN',
+    'TUNISIAN',
+    'TURKISH',
+    'TUVALUAN',
+    'UGANDAN',
+    'UKRAINIAN',
+    'URUGUAYAN',
+    'UZBEKISTANI',
+    'VENEZUELAN',
+    'VIETNAMESE',
+    'WELSH',
+    'YEMENITE',
+    'ZAMBIAN',
+    'ZIMBABWEAN',
+])
+    .openapi({ title: 'Nationality' });
+// Location schemas matching the actual DTOs
+exports.CreateLocationSchema = zod_1.z.object({
+    address: zod_1.z.string().optional().describe('Street address'),
+    postcode: zod_1.z.string().max(8).optional().describe('Postcode'),
+});
+exports.LocationDetailsSchema = zod_1.z.object({
+    address: zod_1.z.string().optional().nullable().describe('Street address'),
+    postcode: zod_1.z.string().optional().nullable().describe('Full postcode'),
+    county: zod_1.z.string().optional().nullable().describe('County'),
+    adminDistrict: zod_1.z
+        .string()
+        .optional()
+        .nullable()
+        .describe('Administrative district'),
+    builtUpArea: zod_1.z.string().optional().nullable().describe('Built-up area'),
+    postTown: zod_1.z.string().optional().nullable().describe('Post town'),
+    areaCovered: zod_1.z.string().optional().nullable().describe('Area covered'),
+});
+/**
+ * Common autocomplete query schema used across all autocomplete endpoints.
+ * Individual contracts can extend this if they need additional fields.
+ */
+exports.AutocompleteQuerySchema = zod_1.z
+    .object({
+    query: zod_1.z
+        .string()
+        .optional()
+        .describe('Search query string to filter results'),
+    id: zod_1.z
+        .string()
+        .uuid()
+        .optional()
+        .describe('Specific record ID to include in results'),
+})
+    .openapi({ title: 'AutocompleteQuery' });
+exports.ResourceIdSchema = zod_1.z.object({
+    id: zod_1.z.string().uuid().describe('The unique identifier of the resource'),
+});
+exports.UserSummarySchema = zod_1.z
+    .object({
+    id: zod_1.z.string().uuid().describe('User ID'),
+    firstName: zod_1.z.string().describe('First Name'),
+    lastName: zod_1.z.string().describe('Last Name'),
+    email: zod_1.z.string().email().describe('Email Address'),
+})
+    .openapi({ title: 'UserSummary' });
+exports.PayRangeSchema = zod_1.z
+    .object({
+    minRate: zod_1.z
+        .number()
+        .min(0)
+        .optional()
+        .nullable()
+        .describe('Minimum hourly pay rate (inclusive)'),
+    maxRate: zod_1.z
+        .number()
+        .min(0)
+        .optional()
+        .nullable()
+        .describe('Maximum hourly pay rate (inclusive)'),
+})
+    .openapi({ title: 'PayRange' });
+exports.MessageResponseSchema = zod_1.z
+    .object({
+    message: zod_1.z.string().describe('Response message'),
+})
+    .openapi({ title: 'MessageResponse' });

package/dist/common/error-schemas.d.ts

@@ -12,19 +12,19 @@ export declare const ErrorResponseSchema: z.ZodObject<{
     path: z.ZodString;
     correlationId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    statusCode: number;
-    message: string;
     code: string;
-    timestamp: string;
     path: string;
+    message: string;
+    statusCode: number;
+    timestamp: string;
     details?: unknown;
     correlationId?: string | undefined;
 }, {
-    statusCode: number;
-    message: string;
     code: string;
-    timestamp: string;
     path: string;
+    message: string;
+    statusCode: number;
+    timestamp: string;
     details?: unknown;
     correlationId?: string | undefined;
 }>;

package/dist/common/openapi-metadata.d.ts

@@ -32,6 +32,12 @@ export interface OpenApiMetadata {
      * Keys are status codes (e.g., '200', '201', '400', '401', etc.)
      */
     responses?: Record<string, ResponseMetadata>;
+    /**
+     * Indicates if the route is public (no authentication required).
+     * If true, the route will not require JWT authentication in the OpenAPI spec.
+     * If false or undefined, the route requires authentication (default).
+     */
+    isPublic?: boolean;
 }
 /**
  * Standard error response examples and descriptions

package/dist/common/openapi-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openapi-metadata.d.ts","sourceRoot":"","sources":["../../contracts/common/openapi-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC9C;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAiErE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;IACjC;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAWlB;;OAEG;gCAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAWlB;;OAEG;gCAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAUlB;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAuBlB;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;CAUnB,CAAC"}
+{"version":3,"file":"openapi-metadata.d.ts","sourceRoot":"","sources":["../../contracts/common/openapi-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAiErE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB;IACjC;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAWlB;;OAEG;gCAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAWlB;;OAEG;gCAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAUlB;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;IAuBlB;;OAEG;+BAEiB,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,KACjD,eAAe;CAUnB,CAAC"}

package/dist/common/pagination-query.schema.d.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+/**
+ * Common pagination query parameters schema for API requests.
+ * Provides standard page and limit parameters with sensible defaults.
+ */
+export declare const PaginationQuerySchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodNumber>;
+    page: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    limit: number;
+    page: number;
+}, {
+    limit?: number | undefined;
+    page?: number | undefined;
+}>;
+export type PaginationQuery = z.infer<typeof PaginationQuerySchema>;
+//# sourceMappingURL=pagination-query.schema.d.ts.map

package/dist/common/pagination-query.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination-query.schema.d.ts","sourceRoot":"","sources":["../../contracts/common/pagination-query.schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;EAMhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/common/pagination-query.schema.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginationQuerySchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Common pagination query parameters schema for API requests.
+ * Provides standard page and limit parameters with sensible defaults.
+ */
+exports.PaginationQuerySchema = zod_1.z.object({
+    limit: zod_1.z.coerce
+        .number()
+        .default(50)
+        .describe('The number of items to return per page.'),
+    page: zod_1.z.coerce.number().default(1).describe('The page number to retrieve.'),
+});

package/dist/common/pagination.schema.d.ts

@@ -7,16 +7,16 @@ export declare const createPaginatedResponseSchema: <T extends z.ZodTypeAny>(ite
     currentPage: z.ZodNumber;
     totalPages: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    limit: number;
     items: T["_output"][];
     totalCount: number;
-    limit: number;
     skip: number;
     currentPage: number;
     totalPages: number;
 }, {
+    limit: number;
     items: T["_input"][];
     totalCount: number;
-    limit: number;
     skip: number;
     currentPage: number;
     totalPages: number;