@sortipei/api-contracts 0.1.0

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@sortipei/api-contracts",
+  "version": "0.1.0",
+  "license": "UNLICENCED",
+  "main": "dist/api-contracts.js",
+  "module": "dist/api-contracts.mjs",
+  "types": "dist/index.d.ts",
+  "dependencies": {
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.5",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-file-extension-in-import-ts": "^2.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "tslib": "^2.6.2",
+    "typescript": "5.4.5",
+    "vite": "^5.4.6",
+    "vite-plugin-dts": "^4.2.1"
+  },
+  "scripts": {
+    "build": "tsc --noEmit && vite build"
+  }
+}

package/src/V1/api/event.ts

@@ -0,0 +1,96 @@
+import { EventIdSchema, OrganizerIdSchema } from '../../flavors';
+import {
+  RegionSchema,
+  SafeNonNegativeFloatSchema,
+  SafeNonNegativeIntegerSchema,
+  StringSchema,
+  URLSchema,
+} from '../../shared';
+import { z } from 'zod';
+
+export const EventDTOSchema = z.object({
+  capacity: SafeNonNegativeIntegerSchema.nullable(),
+  description: StringSchema,
+  finishTime: z.string().datetime().nullable(),
+  hasHandicapAccess: z.boolean().nullable(),
+  id: EventIdSchema,
+  imageUrls: URLSchema.array(),
+  isDisplayed: z.boolean(),
+  isPromoted: z.boolean(),
+  link: URLSchema.nullable(),
+  price: SafeNonNegativeFloatSchema.nullable(),
+  region: RegionSchema,
+  startTime: z.string().datetime(),
+  title: StringSchema,
+
+  organizers: z
+    .object({
+      id: OrganizerIdSchema,
+      name: StringSchema,
+    })
+    .array()
+    .min(1),
+});
+
+export const CreateEventDTOSchema = z.object({
+  capacity: SafeNonNegativeIntegerSchema.nullable(),
+  description: StringSchema,
+  finishTime: z.string().datetime().nullable(),
+  hasHandicapAccess: z.boolean().nullable(),
+  id: EventIdSchema,
+  imageUrls: URLSchema.array(),
+  isDisplayed: z.boolean(),
+  link: URLSchema.nullable(),
+  organizersIds: OrganizerIdSchema.array().min(1),
+  price: SafeNonNegativeFloatSchema.nullable(),
+  region: RegionSchema,
+  startTime: z.string().datetime(),
+  title: StringSchema,
+});
+
+export const UpdateEventDTOSchema = CreateEventDTOSchema.omit({
+  id: true,
+});
+
+export const DisplayEventDTOSchema = z.object({
+  isDisplayed: z.boolean(),
+});
+
+export const PromoteEventDTOSchema = z.object({
+  isPromoted: z.boolean(),
+});
+
+export const EventFileUploadsDTOSchema = z
+  .object({
+    publicUrl: URLSchema,
+    uploadUrl: URLSchema,
+  })
+  .array();
+
+export type CreateEventDTO = z.infer<typeof CreateEventDTOSchema>;
+export type UpdateEventDTO = z.infer<typeof UpdateEventDTOSchema>;
+export type DisplayEventDTO = z.infer<typeof DisplayEventDTOSchema>;
+export type PromoteEventDTO = z.infer<typeof PromoteEventDTOSchema>;
+export type EventFileUploadsDTO = z.infer<typeof EventFileUploadsDTOSchema>;
+
+export type EventDTO = z.infer<typeof EventDTOSchema>;
+
+export const constraints = {
+  description: {
+    minLength: 3,
+    maxLength: 10_000,
+  },
+  title: {
+    minLength: 3,
+    maxLength: 100,
+  },
+};
+
+export const ImportDTOSchema = z.object({
+  id: StringSchema,
+  userId: StringSchema,
+  createdAt: StringSchema.datetime(),
+  partialEventState: EventDTOSchema.partial(),
+});
+
+export type ImportDTO = z.infer<typeof ImportDTOSchema>;

package/src/V1/api/index.ts

@@ -0,0 +1,9 @@
+export * from './event';
+export * from './organizer';
+import { constraints as eventsConstraints } from './event';
+import { constraints as organizerConstraints } from './organizer';
+
+export const constraints = {
+  events: eventsConstraints,
+  organizers: organizerConstraints,
+};

package/src/V1/api/organizer.ts

@@ -0,0 +1,27 @@
+import { EventIdSchema, OrganizerIdSchema } from '../../flavors';
+import { StringSchema } from '../../shared';
+import { z } from 'zod';
+
+export const OrganizerDTOSchema = z.object({
+  eventsIds: EventIdSchema.array(),
+  id: OrganizerIdSchema,
+  name: StringSchema,
+});
+
+export const CreateOrganizerDTOSchema = z.object({
+  id: OrganizerIdSchema,
+  name: StringSchema,
+});
+
+export const UpdateOrganizerDTOSchema = CreateOrganizerDTOSchema.omit({ id: true });
+
+export type CreateOrganizerDTO = z.infer<typeof CreateOrganizerDTOSchema>;
+export type UpdateOrganizerDTO = z.infer<typeof UpdateOrganizerDTOSchema>;
+export type OrganizerDTO = z.infer<typeof OrganizerDTOSchema>;
+
+export const constraints = {
+  name: {
+    minLength: 3,
+    maxLength: 100,
+  },
+};

package/src/V1/external/index.ts

@@ -0,0 +1 @@
+export * from './partial-imported-event';

package/src/V1/external/partial-imported-event.ts

@@ -0,0 +1,11 @@
+import { StringSchema } from '../../shared';
+import { z } from 'zod';
+import { EventDTOSchema } from '../api/event';
+
+export const CreatePartialImportedEventDTOSchema = z.object({
+  partialEventState: EventDTOSchema.partial(),
+  token: StringSchema,
+  userId: StringSchema,
+});
+
+export type CreatePartialImportedEventDTO = z.infer<typeof CreatePartialImportedEventDTOSchema>;

package/src/V1/index.ts

@@ -0,0 +1,4 @@
+import * as api from './api';
+import * as external from './external';
+
+export { api, external };

package/src/errors.ts

@@ -0,0 +1,3 @@
+export enum ErrorCodes {
+  OrganizerHasEvents = '60001',
+}

package/src/flavors.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { UUIDSchema } from './shared';
+
+export const EventIdSchema = UUIDSchema.brand('EventId');
+export type EventId = z.infer<typeof EventIdSchema>;
+
+export const createEventId = (id: string = crypto.randomUUID()): EventId => EventIdSchema.parse(id);
+
+export const OrganizerIdSchema = UUIDSchema.brand('OrganizerId');
+export type OrganizerId = z.infer<typeof OrganizerIdSchema>;
+
+export const createOrganizerId = (id: string = crypto.randomUUID()): OrganizerId => OrganizerIdSchema.parse(id);

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './errors';
+export * from './flavors';
+export * from './shared';
+
+export * as V1 from './V1';

package/src/shared/event.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+
+export enum Region {
+  East = 'East',
+  North = 'North',
+  South = 'South',
+  West = 'West',
+}
+
+export const RegionSchema = z.nativeEnum(Region);

package/src/shared/index.ts

@@ -0,0 +1,2 @@
+export * from './schemas';
+export * from './event';

package/src/shared/schemas.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+
+export const StringSchema = z.string().trim();
+export const UUIDSchema = StringSchema.uuid();
+
+const DateLikeSchema = z.union([z.number(), z.string(), z.date()]);
+const DateLikeOrNullSchema = z.union([z.number(), z.null(), z.string(), z.date()]);
+
+export const CoerceDateSchema = DateLikeSchema.pipe(z.coerce.date());
+export const CoerceNullableDateSchema = DateLikeOrNullSchema.pipe(z.coerce.date()).nullable();
+
+const SafeFloatSchema = z.number().finite().safe();
+const SafeIntegerSchema = SafeFloatSchema.int();
+
+export const SafeNonNegativeIntegerSchema = SafeIntegerSchema.nonnegative();
+export const SafeNonNegativeFloatSchema = SafeFloatSchema.nonnegative();
+
+export const URLSchema = StringSchema.url();

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../tsconfig.packages.json",
+  "compilerOptions": {
+    "allowJs": false,
+    "alwaysStrict": true,
+    "composite": true,
+    "lib": ["es5", "ES2015", "ES2016"],
+    "outDir": "dist",
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "skipLibCheck": true,
+    "strict": true,
+    "module": "ES6",
+    "moduleResolution": "node",
+    "target": "es6"
+  },
+  "include": ["src"]
+}

package/vite.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+
+export default defineConfig({
+  plugins: [dts()],
+  build: {
+    emptyOutDir: true,
+    outDir: 'dist',
+    minify: false,
+    lib: {
+      entry: 'src/index.ts',
+      formats: ['es', 'cjs'],
+    },
+  },
+});