@iveri/contracts 0.39.0 → 0.41.0

package/dist/api/clinic/clinic-appointment-status.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum ClinicAppointmentStatus {
+    BOOKED = "booked",
+    CHECKED_IN = "checked-in",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled",
+    NO_SHOW = "no-show"
+}

package/dist/api/clinic/clinic-appointment-status.enum.js

@@ -0,0 +1,8 @@
+export var ClinicAppointmentStatus;
+(function (ClinicAppointmentStatus) {
+    ClinicAppointmentStatus["BOOKED"] = "booked";
+    ClinicAppointmentStatus["CHECKED_IN"] = "checked-in";
+    ClinicAppointmentStatus["COMPLETED"] = "completed";
+    ClinicAppointmentStatus["CANCELLED"] = "cancelled";
+    ClinicAppointmentStatus["NO_SHOW"] = "no-show";
+})(ClinicAppointmentStatus || (ClinicAppointmentStatus = {}));

package/dist/api/clinic/clinic-appointment.type.d.ts

@@ -0,0 +1,48 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicAppointmentStatus } from './clinic-appointment-status.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** One option as it was when the appointment was booked. A later price change does not touch it. */
+export interface ClinicAppointmentLine {
+    optionId: UUID;
+    name: LocalizedText;
+    durationMinutes: number;
+    priceMinor: number;
+}
+export interface ClinicAppointment {
+    id: UUID;
+    locationId: UUID;
+    staffMemberId: UUID;
+    roomId: UUID;
+    deviceId: Nullable<UUID>;
+    clientId: UUID;
+    clientName: string;
+    clientPhone: string;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    status: ClinicAppointmentStatus;
+    startsAt: IsoDateTime;
+    /** When the treatment itself finishes. */
+    endsAt: IsoDateTime;
+    /** When the specialist, the room and any machine are free again, which includes the buffer. */
+    blockedUntil: IsoDateTime;
+    currency: string;
+    totalMinor: number;
+    lines: ClinicAppointmentLine[];
+    note: Nullable<string>;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicAppointmentRequest {
+    locationId: UUID;
+    treatmentId: UUID;
+    optionIds: UUID[];
+    staffMemberId: UUID;
+    clientId: UUID;
+    startsAt: IsoDateTime;
+    note?: Nullable<string>;
+}
+export interface ChangeClinicAppointmentStatusRequest {
+    status: ClinicAppointmentStatus;
+}

package/dist/api/clinic/clinic-appointment.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-client.type.d.ts

@@ -0,0 +1,25 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+/** Somebody the clinic treats. They need no account to be booked by reception. */
+export interface ClinicClient {
+    id: UUID;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    email: Nullable<string>;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicClientRequest {
+    firstName: string;
+    lastName: string;
+    phone: string;
+    email?: Nullable<string>;
+}
+export interface UpdateClinicClientRequest {
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    email?: Nullable<string>;
+}

package/dist/api/clinic/clinic-client.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-device.type.d.ts

@@ -0,0 +1,23 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+export interface ClinicDevice {
+    id: UUID;
+    locationId: UUID;
+    name: string;
+    /** A clinic-chosen key such as `co2-laser`, which a treatment names when it needs one. */
+    deviceType: string;
+    status: ClinicResourceStatus;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicDeviceRequest {
+    locationId: UUID;
+    name: string;
+    deviceType: string;
+}
+export interface UpdateClinicDeviceRequest {
+    name?: string;
+    deviceType?: string;
+    status?: ClinicResourceStatus;
+}

package/dist/api/clinic/clinic-device.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-location.type.d.ts

@@ -0,0 +1,36 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+export interface ClinicLocation {
+    id: UUID;
+    name: LocalizedText;
+    city: LocalizedText;
+    address: Nullable<string>;
+    phone: Nullable<string>;
+    /** An IANA zone such as `Asia/Tbilisi`. Times are stored in UTC and shown in this zone. */
+    timeZone: string;
+    /** The specialties this branch offers, which clients filter branches by. */
+    specialtyIds: UUID[];
+    status: ClinicResourceStatus;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicLocationRequest {
+    name: LocalizedText;
+    city: LocalizedText;
+    address?: Nullable<string>;
+    phone?: Nullable<string>;
+    timeZone: string;
+    specialtyIds?: UUID[];
+}
+export interface UpdateClinicLocationRequest {
+    name?: LocalizedText;
+    city?: LocalizedText;
+    address?: Nullable<string>;
+    phone?: Nullable<string>;
+    timeZone?: string;
+    specialtyIds?: UUID[];
+    status?: ClinicResourceStatus;
+}

package/dist/api/clinic/clinic-location.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-resource-status.enum.d.ts

@@ -0,0 +1,5 @@
+/** Whether a location, room, device, treatment or staff member can be booked. */
+export declare enum ClinicResourceStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive"
+}

package/dist/api/clinic/clinic-resource-status.enum.js

@@ -0,0 +1,6 @@
+/** Whether a location, room, device, treatment or staff member can be booked. */
+export var ClinicResourceStatus;
+(function (ClinicResourceStatus) {
+    ClinicResourceStatus["ACTIVE"] = "active";
+    ClinicResourceStatus["INACTIVE"] = "inactive";
+})(ClinicResourceStatus || (ClinicResourceStatus = {}));

package/dist/api/clinic/clinic-room.type.d.ts

@@ -0,0 +1,19 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+export interface ClinicRoom {
+    id: UUID;
+    locationId: UUID;
+    name: string;
+    status: ClinicResourceStatus;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicRoomRequest {
+    locationId: UUID;
+    name: string;
+}
+export interface UpdateClinicRoomRequest {
+    name?: string;
+    status?: ClinicResourceStatus;
+}

package/dist/api/clinic/clinic-room.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-slot.type.d.ts

@@ -0,0 +1,9 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+/** A time one specialist can start this treatment, with a room and any machine free for all of it. */
+export interface ClinicSlot {
+    staffMemberId: UUID;
+    startsAt: IsoDateTime;
+    /** When the treatment itself finishes, without the buffer after it. */
+    endsAt: IsoDateTime;
+}

package/dist/api/clinic/clinic-slot.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-specialty.type.d.ts

@@ -0,0 +1,24 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** A line of work such as cosmetology or laser epilation, which a clinic organises treatments by. */
+export interface ClinicSpecialty {
+    id: UUID;
+    name: LocalizedText;
+    /** Fixed after creation, because a public address names it. */
+    slug: string;
+    sortOrder: number;
+    status: ClinicResourceStatus;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicSpecialtyRequest {
+    name: LocalizedText;
+    slug: string;
+}
+export interface UpdateClinicSpecialtyRequest {
+    name?: LocalizedText;
+    sortOrder?: number;
+    status?: ClinicResourceStatus;
+}

package/dist/api/clinic/clinic-specialty.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-staff.type.d.ts

@@ -0,0 +1,55 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+/** One stretch of a weekly schedule, read in the location's own time zone. */
+export interface ClinicWorkingPeriod {
+    /** ISO weekday: 1 is Monday and 7 is Sunday. */
+    dayOfWeek: number;
+    /** 24-hour `HH:mm`. */
+    startTime: string;
+    /** 24-hour `HH:mm`, later than `startTime`. */
+    endTime: string;
+}
+export interface ClinicStaffMember {
+    id: UUID;
+    /** The identity account this person signs in with. */
+    userId: UUID;
+    locationId: UUID;
+    displayName: string;
+    status: ClinicResourceStatus;
+    /** The treatments this person may perform. */
+    treatmentIds: UUID[];
+    workingHours: ClinicWorkingPeriod[];
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicStaffMemberRequest {
+    userId: UUID;
+    locationId: UUID;
+    displayName: string;
+}
+export interface UpdateClinicStaffMemberRequest {
+    locationId?: UUID;
+    displayName?: string;
+    status?: ClinicResourceStatus;
+}
+export interface ReplaceClinicStaffTreatmentsRequest {
+    treatmentIds: UUID[];
+}
+export interface ReplaceClinicWorkingHoursRequest {
+    periods: ClinicWorkingPeriod[];
+}
+export interface ClinicTimeOff {
+    id: UUID;
+    staffMemberId: UUID;
+    startsAt: IsoDateTime;
+    endsAt: IsoDateTime;
+    reason: Nullable<string>;
+    createdAt: IsoDateTime;
+}
+export interface CreateClinicTimeOffRequest {
+    startsAt: IsoDateTime;
+    endsAt: IsoDateTime;
+    reason?: Nullable<string>;
+}

package/dist/api/clinic/clinic-staff.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/clinic-treatment.type.d.ts

@@ -0,0 +1,64 @@
+import type { IsoDateTime } from '../../type/iso-date-time.type.js';
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { ClinicResourceStatus } from './clinic-resource-status.enum.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** One way of buying a treatment. A laser zone is an option; a treatment that does not vary has one. */
+export interface ClinicTreatmentOption {
+    id: UUID;
+    name: LocalizedText;
+    durationMinutes: number;
+    /** Integer minor units of the treatment's currency. */
+    priceMinor: number;
+    sortOrder: number;
+}
+export interface ClinicTreatment {
+    id: UUID;
+    specialtyId: UUID;
+    name: LocalizedText;
+    description: Nullable<LocalizedText>;
+    currency: string;
+    /** Rest time held after the treatment, for cleaning a room or cooling a device. */
+    bufferMinutes: number;
+    /** The device type this treatment occupies, or `null` when it needs none. */
+    requiredDeviceType: Nullable<string>;
+    /** The shortest gap a client may leave between sessions, or `null` when any gap is safe. */
+    minDaysBetweenSessions: Nullable<number>;
+    isBookableOnline: boolean;
+    status: ClinicResourceStatus;
+    options: ClinicTreatmentOption[];
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface CreateClinicTreatmentOptionRequest {
+    name: LocalizedText;
+    durationMinutes: number;
+    priceMinor: number;
+}
+export interface UpdateClinicTreatmentOptionRequest {
+    name?: LocalizedText;
+    durationMinutes?: number;
+    priceMinor?: number;
+    sortOrder?: number;
+}
+export interface CreateClinicTreatmentRequest {
+    specialtyId: UUID;
+    name: LocalizedText;
+    description?: Nullable<LocalizedText>;
+    currency: string;
+    bufferMinutes?: number;
+    requiredDeviceType?: Nullable<string>;
+    minDaysBetweenSessions?: Nullable<number>;
+    isBookableOnline?: boolean;
+    options: CreateClinicTreatmentOptionRequest[];
+}
+export interface UpdateClinicTreatmentRequest {
+    specialtyId?: UUID;
+    name?: LocalizedText;
+    description?: Nullable<LocalizedText>;
+    bufferMinutes?: number;
+    requiredDeviceType?: Nullable<string>;
+    minDaysBetweenSessions?: Nullable<number>;
+    isBookableOnline?: boolean;
+    status?: ClinicResourceStatus;
+}

package/dist/api/clinic/clinic-treatment.type.js

@@ -0,0 +1 @@
+export {};

package/dist/api/clinic/index.d.ts

@@ -0,0 +1,12 @@
+export * from './clinic-appointment-status.enum.js';
+export * from './clinic-appointment.type.js';
+export * from './clinic-client.type.js';
+export * from './clinic-device.type.js';
+export * from './clinic-location.type.js';
+export * from './clinic-resource-status.enum.js';
+export * from './clinic-room.type.js';
+export * from './clinic-slot.type.js';
+export * from './clinic-specialty.type.js';
+export * from './clinic-staff.type.js';
+export * from './clinic-treatment.type.js';
+export * from './localized-text.type.js';

package/dist/api/clinic/index.js

@@ -0,0 +1,12 @@
+export * from './clinic-appointment-status.enum.js';
+export * from './clinic-appointment.type.js';
+export * from './clinic-client.type.js';
+export * from './clinic-device.type.js';
+export * from './clinic-location.type.js';
+export * from './clinic-resource-status.enum.js';
+export * from './clinic-room.type.js';
+export * from './clinic-slot.type.js';
+export * from './clinic-specialty.type.js';
+export * from './clinic-staff.type.js';
+export * from './clinic-treatment.type.js';
+export * from './localized-text.type.js';

package/dist/api/clinic/localized-text.type.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Clinic-written text in each language it has been written in, keyed by locale.
+ *
+ * This is the clinic's own content, so it lives on the row it describes rather than in the
+ * localization service, which holds strings the product's authors wrote.
+ */
+export type LocalizedText = Record<string, string>;

package/dist/api/clinic/localized-text.type.js

@@ -0,0 +1 @@
+export {};

package/dist/enum/user-permission.enum.d.ts

@@ -430,7 +430,19 @@ export declare enum UserPermission {
     /** Confirm or cancel a delivery job; operator actions on another sender's job require this grant. */
     DELIVERY_JOB_OPERATE = "delivery:job:operate",
     /** Read and advance only jobs assigned to the caller's own courier worker. */
-    DELIVERY_JOB_DELIVER = "delivery:job:deliver"
+    DELIVERY_JOB_DELIVER = "delivery:job:deliver",
+    /** Read a clinic's specialties, locations, rooms, devices, treatments and staff. */
+    CLINIC_SETUP_READ = "clinic:setup:read",
+    /** Create and change them, including staff working hours. */
+    CLINIC_SETUP_MANAGE = "clinic:setup:manage",
+    /** Read the appointment calendar and search for free slots. */
+    CLINIC_APPOINTMENT_READ = "clinic:appointment:read",
+    /** Book appointments and move them through their statuses. */
+    CLINIC_APPOINTMENT_MANAGE = "clinic:appointment:manage",
+    /** Read a clinic's clients. */
+    CLINIC_CLIENT_READ = "clinic:client:read",
+    /** Create and change a clinic's clients. */
+    CLINIC_CLIENT_MANAGE = "clinic:client:manage"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/dist/enum/user-permission.enum.js

@@ -492,6 +492,19 @@ export var UserPermission;
     UserPermission["DELIVERY_JOB_OPERATE"] = "delivery:job:operate";
     /** Read and advance only jobs assigned to the caller's own courier worker. */
     UserPermission["DELIVERY_JOB_DELIVER"] = "delivery:job:deliver";
+    // Clinic
+    /** Read a clinic's specialties, locations, rooms, devices, treatments and staff. */
+    UserPermission["CLINIC_SETUP_READ"] = "clinic:setup:read";
+    /** Create and change them, including staff working hours. */
+    UserPermission["CLINIC_SETUP_MANAGE"] = "clinic:setup:manage";
+    /** Read the appointment calendar and search for free slots. */
+    UserPermission["CLINIC_APPOINTMENT_READ"] = "clinic:appointment:read";
+    /** Book appointments and move them through their statuses. */
+    UserPermission["CLINIC_APPOINTMENT_MANAGE"] = "clinic:appointment:manage";
+    /** Read a clinic's clients. */
+    UserPermission["CLINIC_CLIENT_READ"] = "clinic:client:read";
+    /** Create and change a clinic's clients. */
+    UserPermission["CLINIC_CLIENT_MANAGE"] = "clinic:client:manage";
 })(UserPermission || (UserPermission = {}));
 /**
  * Every member, for seeding the owner role and validating custom-role input.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iveri/contracts",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {
@@ -48,6 +48,10 @@
       "types": "./dist/api/realtime/index.d.ts",
       "default": "./dist/api/realtime/index.js"
     },
+    "./clinic": {
+      "types": "./dist/api/clinic/index.d.ts",
+      "default": "./dist/api/clinic/index.js"
+    },
     "./mobility": {
       "types": "./dist/api/mobility/index.d.ts",
       "default": "./dist/api/mobility/index.js"