@iveri/contracts 0.40.0 → 0.42.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-lead-kind.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum ClinicLeadKind {
+    CALLBACK = "callback",
+    QUESTION = "question"
+}

package/dist/api/clinic/clinic-lead-kind.enum.js

@@ -0,0 +1,5 @@
+export var ClinicLeadKind;
+(function (ClinicLeadKind) {
+    ClinicLeadKind["CALLBACK"] = "callback";
+    ClinicLeadKind["QUESTION"] = "question";
+})(ClinicLeadKind || (ClinicLeadKind = {}));

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

@@ -0,0 +1,4 @@
+export declare enum ClinicLeadStatus {
+    NEW = "new",
+    HANDLED = "handled"
+}

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

@@ -0,0 +1,5 @@
+export var ClinicLeadStatus;
+(function (ClinicLeadStatus) {
+    ClinicLeadStatus["NEW"] = "new";
+    ClinicLeadStatus["HANDLED"] = "handled";
+})(ClinicLeadStatus || (ClinicLeadStatus = {}));

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

@@ -0,0 +1,32 @@
+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 { ClinicLeadKind } from './clinic-lead-kind.enum.js';
+import type { ClinicLeadStatus } from './clinic-lead-status.enum.js';
+/** Somebody who asked the clinic to call them back, or asked it something. */
+export interface ClinicLead {
+    id: UUID;
+    kind: ClinicLeadKind;
+    status: ClinicLeadStatus;
+    name: string;
+    phone: string;
+    message: Nullable<string>;
+    locationId: Nullable<UUID>;
+    treatmentId: Nullable<UUID>;
+    /** When this person agreed to be contacted. A lead cannot exist without it. */
+    consentedAt: IsoDateTime;
+    handledAt: Nullable<IsoDateTime>;
+    createdAt: IsoDateTime;
+}
+export interface CreateClinicLeadRequest {
+    kind: ClinicLeadKind;
+    name: string;
+    phone: string;
+    message?: Nullable<string>;
+    locationId?: Nullable<UUID>;
+    treatmentId?: Nullable<UUID>;
+    hasPrivacyConsent: boolean;
+}
+export interface ChangeClinicLeadStatusRequest {
+    status: ClinicLeadStatus;
+}

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

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

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

@@ -0,0 +1,37 @@
+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 { ClinicAppointmentLine } from './clinic-appointment.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+/** A client's own view of a booking, without the room and machine the clinic assigned. */
+export interface MyClinicAppointment {
+    id: UUID;
+    locationId: UUID;
+    specialistName: string;
+    treatmentId: UUID;
+    treatmentName: LocalizedText;
+    status: ClinicAppointmentStatus;
+    startsAt: IsoDateTime;
+    endsAt: IsoDateTime;
+    currency: string;
+    totalMinor: number;
+    lines: ClinicAppointmentLine[];
+    note: Nullable<string>;
+    /** Whether the clinic's rules still let this client cancel it themselves. */
+    canCancel: boolean;
+}
+export interface BookMyClinicAppointmentRequest {
+    locationId: UUID;
+    treatmentId: UUID;
+    optionIds: UUID[];
+    staffMemberId: UUID;
+    startsAt: IsoDateTime;
+    note?: Nullable<string>;
+}
+export interface SaveMyClinicClientRequest {
+    firstName: string;
+    lastName: string;
+    phone: string;
+    email?: Nullable<string>;
+}

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

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

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

@@ -0,0 +1,32 @@
+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 { LocalizedText } from './localized-text.type.js';
+/** How a clinic presents itself to the public, and the rules for booking online. */
+export interface ClinicProfile {
+    id: UUID;
+    /** The name its public address and app build use. Unique across every clinic. */
+    slug: string;
+    name: LocalizedText;
+    tagline: Nullable<LocalizedText>;
+    phone: Nullable<string>;
+    email: Nullable<string>;
+    /** Nothing about the clinic is public until this is true. */
+    isPublished: boolean;
+    /** How long before a booking a client can still cancel it themselves. */
+    clientCancelCutoffHours: number;
+    /** How far ahead a client can book. */
+    bookingHorizonDays: number;
+    createdAt: IsoDateTime;
+    updatedAt: IsoDateTime;
+}
+export interface SaveClinicProfileRequest {
+    slug: string;
+    name: LocalizedText;
+    tagline?: Nullable<LocalizedText>;
+    phone?: Nullable<string>;
+    email?: Nullable<string>;
+    isPublished: boolean;
+    clientCancelCutoffHours: number;
+    bookingHorizonDays: number;
+}

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

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

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

@@ -0,0 +1,53 @@
+import type { Nullable } from '../../type/nil.type.js';
+import type { UUID } from '../../type/uuid.type.js';
+import type { LocalizedText } from './localized-text.type.js';
+/**
+ * What anybody on the internet may read.
+ *
+ * Declared apart from the staff shapes on purpose. A field added to one of those does not reach
+ * the public until somebody adds it here too.
+ */
+export interface PublicClinic {
+    slug: string;
+    name: LocalizedText;
+    tagline: Nullable<LocalizedText>;
+    phone: Nullable<string>;
+    email: Nullable<string>;
+    bookingHorizonDays: number;
+}
+export interface PublicSpecialty {
+    id: UUID;
+    slug: string;
+    name: LocalizedText;
+}
+export interface PublicBranch {
+    id: UUID;
+    name: LocalizedText;
+    city: LocalizedText;
+    address: Nullable<string>;
+    phone: Nullable<string>;
+    timeZone: string;
+    specialtyIds: UUID[];
+}
+export interface PublicTreatmentOption {
+    id: UUID;
+    name: LocalizedText;
+    durationMinutes: number;
+    priceMinor: number;
+}
+export interface PublicTreatment {
+    id: UUID;
+    specialtyId: UUID;
+    name: LocalizedText;
+    description: Nullable<LocalizedText>;
+    currency: string;
+    minDaysBetweenSessions: Nullable<number>;
+    isBookableOnline: boolean;
+    options: PublicTreatmentOption[];
+}
+export interface PublicSpecialist {
+    id: UUID;
+    displayName: string;
+    locationId: UUID;
+    treatmentIds: UUID[];
+}

package/dist/api/clinic/clinic-public.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/index.d.ts

@@ -1,7 +1,17 @@
+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-lead-kind.enum.js';
+export * from './clinic-lead-status.enum.js';
+export * from './clinic-lead.type.js';
 export * from './clinic-location.type.js';
+export * from './clinic-my-appointment.type.js';
+export * from './clinic-profile.type.js';
+export * from './clinic-public.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';

package/dist/api/clinic/index.js

@@ -1,7 +1,17 @@
+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-lead-kind.enum.js';
+export * from './clinic-lead-status.enum.js';
+export * from './clinic-lead.type.js';
 export * from './clinic-location.type.js';
+export * from './clinic-my-appointment.type.js';
+export * from './clinic-profile.type.js';
+export * from './clinic-public.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';

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

@@ -434,7 +434,19 @@ export declare enum UserPermission {
     /** 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"
+    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",
+    /** Read callback requests and questions sent from a clinic's website or app. */
+    CLINIC_LEAD_READ = "clinic:lead:read",
+    /** Mark those requests as handled. */
+    CLINIC_LEAD_MANAGE = "clinic:lead:manage"
 }
 /**
  * Every member, for seeding the owner role and validating custom-role input.

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

@@ -497,6 +497,18 @@ export var UserPermission;
     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";
+    /** Read callback requests and questions sent from a clinic's website or app. */
+    UserPermission["CLINIC_LEAD_READ"] = "clinic:lead:read";
+    /** Mark those requests as handled. */
+    UserPermission["CLINIC_LEAD_MANAGE"] = "clinic:lead: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.40.0",
+  "version": "0.42.0",
   "description": "Wire contracts shared by every Iveri backend and frontend. Zero runtime dependencies.",
   "license": "MIT",
   "repository": {