@unaffi/schema 1.0.0 → 1.1.1

package/README.md

@@ -1,4 +1,46 @@
-# UNAFFI Schema defined in Typescript
+# UNAFFI Schema
+
+This reflects what the API returns, **not** what the DB Schema looks like in MongoDB.
 
-This reflects what the API returns, and not what the DB Schema looks like in MongoDB.
 Can be imported into any repo and be used by both TS and JS (JSDocs) code.
+
+## Installation
+```bash
+npm i --save-dev @unaffi/schema
+```
+
+## Usage
+Example:
+```js
+/** @type {import('@unaffi/schema').Profile} */
+const profile = await getProfile();
+```
+
+or define it at the top of the page to use the type throughout the file:
+```js
+/** @typedef {import('@unaffi/schema').Profile} Profile */
+
+/** @type {Profile} */
+const profile = await getProfile();
+```
+
+## Updating the Schema
+1. **Bump the version** in the `package.json`:
+  ```jsonc
+  {
+    // …
+    "version": "1.0.0", // to "1.0.1"   |   Always update 3rd number, unless it is a large update (such as an extra table added). Never update 1st number unless we restart unaffi's schema entirely.
+    // …
+  } 
+```
+2. Update **Github**:
+  ```bash
+  git add .
+  git commit -m "Your commit message"
+  git push
+  ```
+3. Update **npm**:
+  ```bash
+  npm login
+  npm publish --access public
+  ```

package/base.schema.d.ts

@@ -1,5 +1,5 @@
 export interface Base {
-	archived?: boolean;
-	readonly createdAt?: string;
-	readonly updatedAt?: string;
+  archived?: boolean;
+  readonly createdAt?: string;
+  readonly updatedAt?: string;
 }

package/collections/action.schema.d.ts

@@ -1,24 +1,32 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Action extends Base {
-	readonly action_id: string;
+  readonly action_id: string;
 
-	action_template?: string;
+  action_template?: string;
 
-	data?: {
-		[x: string]: any;
-	};
+  data?: {
+    [x: string]: any;
+  };
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  profile_attributes?: {
+    is_system?: boolean;
+    is_collaborator?: boolean;
+    is_instance_seat?: boolean;
+    is_order_profile?: boolean;
+    is_order_seat?: boolean;
+  };
 
-	order_id?: DB.Order['order_id'];
-	order?: DB.Order;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	instance_id?: DB.Instance['instance_id'];
-	instance?: DB.Instance;
+  order_id?: DB.Order["order_id"];
+  order?: DB.Order;
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  instance_id?: DB.Instance["instance_id"];
+  instance?: DB.Instance;
+
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 }

package/collections/collaborator.schema.d.ts

@@ -1,14 +1,14 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Collaborator extends Base {
-	readonly collaborator_id: string;
+  readonly collaborator_id: string;
 
-	role?: 'owner' | 'admin';
+  role?: "owner" | "admin";
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 }

package/collections/contactpoint.schema.d.ts

@@ -1,20 +1,21 @@
-import type { Base } from '../base.schema';
-import type { Org } from './org.schema';
-import type { Profile } from './profile.schema';
+import type { Base } from "../base.schema";
+import type { Org } from "./org.schema";
+import type { Profile } from "./profile.schema";
 
 export interface Contactpoint extends Base {
-	readonly contactpoint_id: string;
+  readonly contactpoint_id: string;
 
-	type?: string;
-	point?: string;
-	details: {
-		descname?: string;
-		description?: string;
-	};
+  type?: "email_address" | "mobile_number" | "telephone_number";
+  point?: string;
+  details: {
+    descname?: string;
+    description?: string;
+    full_name?: string;
+  };
 
-	org_id?: Org['org_id'];
-	org?: Org;
+  org_id?: Org["org_id"];
+  org?: Org;
 
-	profile_id?: Profile['profile_id'];
-	profile?: Profile;
+  profile_id?: Profile["profile_id"];
+  profile?: Profile;
 }

package/collections/facility.schema.d.ts

@@ -1,26 +1,22 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
-import type { GeoLocation } from '../common';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
+import type { GeoLocation } from "../common";
 
 export interface Facility extends Base {
-	readonly facility_id: string;
+  readonly facility_id: string;
 
-	linked_facility_ids: DB.Facility['facility_id'][];
-	linked_facilities: DB.Facility;
+  linked_facility_ids: DB.Facility["facility_id"][];
+  linked_facilities: DB.Facility;
 
-	details: {
-		descname?: string;
-		description?: string;
-		geo_location?: GeoLocation;
-	};
-	config: {
-		hidden: boolean;
-		disabled: boolean;
-	};
+  details: {
+    descname?: string;
+    description?: string;
+    geo_location?: GeoLocation;
+  };
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	location_id?: DB.Location['location_id'];
-	location?: DB.Location;
+  location_id?: DB.Location["location_id"];
+  location?: DB.Location;
 }

package/collections/file.schema.d.ts

@@ -1,25 +1,29 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface File extends Base {
-	readonly file_id: string;
+  readonly file_id: string;
 
-	details: {
-		descname?: string;
-		description?: string;
-	};
+  details?: {
+    descname?: string;
+    description?: string;
+  };
 
-	readonly upload_info?: {
-		[x: string]: any;
-	};
-	readonly storage_details?: {
-		[x: string]: any;
-	};
-	readonly access_url?: string;
+  readonly upload_info?: {
+    [x: string]: any;
+  };
+  readonly storage_details?: {
+    [x: string]: any;
+  };
+  readonly access_url?: string;
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  uploaded_by?: {
+    profile_id: string;
+  };
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
+
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 }

package/collections/form.schema.d.ts

@@ -18,6 +18,7 @@ export interface Form extends Base {
 
 type FormType = 'fields';
 export type FieldType =
+	| 'info'
 	| 'text'
 	| 'textarea'
 	| 'number'

package/collections/instance.schema.d.ts

@@ -1,48 +1,55 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Instance extends Base {
-	readonly instance_id: string;
+  readonly instance_id: string;
 
-	status: InstanceStatuses;
+  status: InstanceStatuses;
 
-	slots: InstanceSlot[];
-	settings: Settings;
-	seats: DB.Seat[];
+  slots: InstanceSlot[];
+  settings: Settings;
+  seats: DB.Seat[];
 
-	seat_profiles: (DB.Seat & DB.Profile)[];
+  seat_profiles: (DB.Seat & DB.Profile)[];
 
-	is_historical: boolean;
+  is_historical: boolean;
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	service_id?: DB.Service['service_id'];
-	service?: DB.Service;
+  service_id?: DB.Service["service_id"];
+  service?: DB.Service;
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 
-	service_schedule?: DB.Schedule;
+  service_schedule?: DB.Schedule;
 
-	actions: DB.Action[];
+  actions: DB.Action[];
 }
 
-type InstanceStatuses = 'signup-pending' | 'payment-pending' | 'confirmed' | 'seats-pending';
+type InstanceStatuses = "signup-pending" | "payment-pending" | "confirmed" | "seats-pending";
 
 export type InstanceSlot = {
-	date: string;
-	start_time: number;
-	end_time: number;
-	start_date: string;
-	end_date: string;
-	schedule_id: string;
-	session_id: string;
-	order_allowed: boolean;
-	rates: DB.Rate[];
-	public_instances: { instance_id: string }[];
+  date: string;
+  start_time: number;
+  end_time: number;
+  start_date: string;
+  end_date: string;
+  schedule_id: string;
+  session_id: string;
+  order_allowed: boolean;
+  rates: DB.Rate[];
+  public_instances: { instance_id: string }[];
+};
+
+export type RateSummary = {
+  applicable_rate?: number;
+  standard_rate?: number;
+  discount?: number;
+  is_eligible?: boolean;
 };
 
 type Settings = {
-	[x: string]: any;
+  [x: string]: any;
 };

package/collections/location.schema.d.ts

@@ -1,32 +1,38 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
-import type { GeoLocation, Photo } from '../common';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
+import type { GeoLocation, Photo } from "../common";
 
 export interface Location extends Base {
-	readonly location_id: string;
+  readonly location_id: string;
 
-	details: {
-		descname?: string;
-		description?: string;
-		address_string?: string;
-		is_obscured: boolean;
-		address: {
-			street?: string;
-			city?: string;
-			region?: string;
-			postal_code?: string;
-		};
-		geo_location?: GeoLocation;
-		card_background_file_id: string;
-	};
+  details: {
+    descname?: string;
+    description?: string;
+    address_string?: string;
+    visibility: "public" | "private";
+    address: {
+      street?: string;
+      city?: string;
+      region?: string;
+      postal_code?: string;
+    };
+    geo_location?: GeoLocation;
+    card_background_file_id: string;
+  };
 
-	display_contactpoints: DB.Contactpoint[];
-	cover_files: Photo[];
+  display_contactpoints: DB.Contactpoint[];
+  cover_files: Photo[];
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	services?: DB.Service[];
+  services?: DB.Service[];
 
-	card_background_file?: Photo;
+  card_background_file?: Photo;
+
+  config: {
+	disable?: boolean;
+	hidden?: boolean;
+	active_cover_file_ids: Record<string, number>;
+  };
 }

package/collections/order.schema.d.ts

@@ -1,27 +1,27 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Order extends Base {
-	readonly order_id: string;
+  readonly order_id: string;
 
-	reference_number?: string;
+  reference_number?: string;
 
-	status?: string;
+  status?: string;
 
-	authorized_payment?: Record<string, any>;
-	fees_summary?: Record<string, any>;
+  authorized_payment?: Record<string, any>;
+  fees_summary?: Record<string, any>;
 
-	seats?: DB.Seat[];
-	seat_profiles?: DB.Profile[];
+  seats?: DB.Seat[];
+  seat_profiles?: DB.Profile[];
 
-	org_id: string;
-	org?: DB.Org;
+  org_id: string;
+  org?: DB.Org;
 
-	instance_id: string;
-	instance?: DB.Instance;
+  instance_id: string;
+  instance?: DB.Instance;
 
-	profile_id: string;
-	profile?: DB.Profile;
+  profile_id: string;
+  profile?: DB.Profile;
 
-	actions?: DB.Action[];
+  actions?: DB.Action[];
 }

package/collections/org.schema.d.ts

@@ -1,34 +1,37 @@
-import type { Base } from '../base.schema';
-import type { Photo } from '../common';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type { Photo } from "../common";
+import type * as DB from "../index";
 
 export interface Org extends Base {
-	readonly org_id: string;
+  readonly org_id: string;
 
-	details: {
-		descname?: string;
-		description?: string;
-		country_code: CountryCodes;
-		currency_code: CurrencyCodes;
-		logo_file_id: string;
-		card_background_file_id: string;
-	};
+  dashboard_id?: string;
+  details: {
+    descname?: string;
+    description?: string;
+    country_code: CountryCodes;
+    currency_code: CurrencyCodes;
+    logo_file_id: string;
+    card_background_file_id: string;
+  };
 
-	display_contactpoints: DB.Contactpoint[];
-	cover_files: Photo[];
-	logo_file?: Photo;
-	card_background_file?: Photo;
-	locations?: DB.Location[];
-	services?: DB.Service[];
+  display_contactpoints: DB.Contactpoint[];
+  cover_files: Photo[];
+  logo_file?: Photo;
+  card_background_file?: Photo;
+  locations?: DB.Location[];
+  services?: DB.Service[];
 
-	// Keeping config to a minimum for now.
-	config: {
-		active_cover_file_ids: Record<string, number>;
-	};
+  // Keeping config to a minimum for now.
+  config: {
+    disable?: boolean;
+    hidden?: boolean;
+    active_cover_file_ids: Record<string, number>;
+  };
 
-	collaborators?: DB.Collaborator[];
-	facilities?: DB.Facility[];
+  collaborators?: DB.Collaborator[];
+  facilities?: DB.Facility[];
 }
 
-type CountryCodes = 'ZAF';
-type CurrencyCodes = 'ZAR';
+type CountryCodes = "ZAF";
+type CurrencyCodes = "ZAR";

package/collections/payment.schema.d.ts

@@ -1,29 +1,27 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Payment extends Base {
-	readonly payment_id: string;
+  readonly payment_id: string;
 
-	status: PaymentStatus;
-	payment_provider: PaymentProvider;
-	provider_details: { url: string };
-	amount?: number;
+  status: PaymentStatus;
+  payment_provider: PaymentProvider;
+  provider_details: { url: string };
+  amount?: number;
 
-	reason: {
-		instance_id?: DB.Instance['instance_id'];
-	};
+  reason?: "new_payment_card" | "order";
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 }
 
-type PaymentStatus = 'pending' | 'initialized' | 'paid';
+type PaymentStatus = "pending" | "initialized" | "paid";
 type PaymentProvider = {
-	name?: 'paystack';
-	details?: {
-		[x: string]: any;
-	};
+  name?: "paystack";
+  details?: {
+    [x: string]: any;
+  };
 };

package/collections/profile.schema.d.ts

@@ -12,9 +12,11 @@ export interface Profile extends Base {
 	};
 
 	details: {
-		first_name?: string;
-		last_name?: string;
+		names?: string;
+		surname?: string;
+		preferred_name?: string;
 		mobile_number?: string;
+		unaffi_number?: string;
 		email_address?: string;
 		bio?: string;
 

package/collections/schedule.schema.d.ts

@@ -1,105 +1,105 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Schedule extends Base {
-	readonly schedule_id: string;
-
-	details: {
-		descname?: string;
-		description?: string;
-		date?: string;
-		hide_overlapping_schedules: boolean;
-		repeat_settings: {
-			frequency?: 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'YEARLY';
-			interval?: number;
-			count?: number;
-			until?: string;
-			byweekday?: ('SU' | 'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA')[];
-			byweekno?: number[];
-			bymonth?: number[];
-			bymonthday?: number[];
-			bysetpos?: number[];
-		};
-		instance_settings: {
-			is_public: boolean;
-			max_seats?: number;
-			min_seats: number;
-			max_slots?: number;
-			min_slots: number;
-			max_lead_time?: number;
-			min_lead_time: number;
-			rate_application: 'per_slot' | 'per_seat';
-			approval_required?: boolean;
-			signup_form?: {
-				form_id: DB.Form['form_id'];
-			};
-		};
-	};
-	config: {
-		hidden: boolean;
-		disabled: boolean;
-	};
-
-	parent_schedule?: {
-		schedule_id: DB.Schedule['schedule_id'];
-		session_id: Session['session_id'];
-	};
-
-	sessions: Session[];
-
-	next_scheduled_slot?: DB.InstanceSlot;
-
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
-
-	service_id?: DB.Service['service_id'];
-	service?: DB.Service;
-
-	facility_ids?: DB.Facility['facility_id'][];
-	facilities?: DB.Facility;
-
-	instance_id?: DB.Instance['instance_id'];
-	instance?: DB.Instance;
-
-	signup_form?: DB.Form;
+  readonly schedule_id: string;
+
+  details: {
+    descname?: string;
+    description?: string;
+    date?: string;
+    hide_overlapping_schedules: boolean;
+    timezone?: string;
+    repeat_settings: {
+      frequency?: "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY";
+      interval?: number;
+      count?: number;
+      until?: string;
+      byweekday?: ("SU" | "MO" | "TU" | "WE" | "TH" | "FR" | "SA")[];
+      byweekno?: number[];
+      bymonth?: number[];
+      bymonthday?: number[];
+      bysetpos?: number[];
+    };
+    instance_settings: {
+      is_public: boolean;
+      max_seats?: number;
+      min_seats: number;
+      max_slots?: number;
+      min_slots: number;
+      max_lead_time?: number;
+      min_lead_time: number;
+      rate_application: "per_slot" | "per_seat";
+      approval_required?: boolean;
+      signup_form?: {
+        form_id: DB.Form["form_id"];
+      };
+    };
+  };
+  config: {
+    hidden: boolean;
+  };
+
+  parent_schedule?: {
+    schedule_id: DB.Schedule["schedule_id"];
+    session_id: Session["session_id"];
+  };
+
+  sessions: Session[];
+
+  next_scheduled_slot?: DB.InstanceSlot;
+
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
+
+  service_id?: DB.Service["service_id"];
+  service?: DB.Service;
+
+  facility_ids?: DB.Facility["facility_id"][];
+  facilities?: DB.Facility;
+
+  instance_id?: DB.Instance["instance_id"];
+  instance?: DB.Instance;
+
+  signup_form?: DB.Form;
 }
 
 export interface Session extends Base {
-	readonly session_id: string;
+  readonly session_id: string;
 
-	descname?: string;
-	start_time?: number;
-	duration?: number;
-	slot_duration?: number;
-	max_instances?: number;
-	rates: Rate[];
+  descname?: string;
+  start_time?: number;
+  duration?: number;
+  slot_duration?: number;
+  max_instances?: number;
+  rates: Rate[];
 
-	schedule_id: string; // Fake
+  schedule_id: string; // Fake
 }
 
 export interface Rate {
-	rate: number;
-	conditions?: Condition[];
+  rate: number;
+  conditions?: Condition[];
 
-	session_id?: string; // Fake
-	schedule_id?: string; // Fake
+  session_id?: string; // Fake
+  schedule_id?: string; // Fake
 }
 
 export interface Condition {
-	type?: ConditionType;
-	service_id?: DB.Service['service_id'];
+  type?: ConditionType;
+  service_id?: DB.Service["service_id"];
 }
 
 // This is compiled by the API – does not appear in the Schema
 export interface Slot {
-	applicable_rate: number;
-	schedule_id: string;
-	session_id: string;
-	date: string;
-	start_time: number;
-	end_time: number;
-	duration: number;
-	rate: number;
+  applicable_rate: number;
+  schedule_id: string;
+  session_id: string;
+  date: string;
+  start_time: number;
+  end_time: number;
+  duration: number;
+  rate: number;
 }
 
-type ConditionType = 'seat_in_service';
+type ConditionType = "seat_in_service";

package/collections/searchentry.schema.d.ts

@@ -0,0 +1,28 @@
+import { Base } from "../base.schema";
+import { GeoLocation } from "../common";
+import { File } from "./file.schema";
+import { Servicetype } from "./servicetype.schema";
+
+export interface Searchentry extends Base {
+  readonly searchentry_id: string;
+
+  details?: {
+    descname?: string;
+    description?: string;
+    url?: string;
+    address_string?: string;
+    date?: string;
+    price?: string;
+    geo_location?: GeoLocation;
+    card_background_file_id?: string;
+    repeat_period?: "daily" | "weekly" | "monthly" | "none";
+    org_name?: string;
+  };
+
+  type?: "community" | "facility_hire" | "activity" | "none";
+
+  card_background_file?: Partial<File>;
+
+  servicetype_ids: string[];
+  servicetypes?: Servicetype[];
+}

package/collections/seat.schema.d.ts

@@ -1,19 +1,19 @@
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Seat extends Base {
-	readonly seat_id: string;
+  readonly seat_id: string;
 
-	profile_id?: DB.Profile['profile_id'];
-	profile?: DB.Profile;
+  profile_id?: DB.Profile["profile_id"];
+  profile?: DB.Profile;
 
-	email_address?: string;
-	amount_due?: number;
+  email_address?: string;
+  amount_due?: number;
 
-    applicable_rate?: number;
-    standard_rate?: number;
-    discount?: number;
+  applicable_rate?: number;
+  standard_rate?: number;
+  discount?: number;
 
-	instance_id?: DB.Instance['instance_id'];
-	instance?: DB.Instance;
-}
+  instance_id?: DB.Instance["instance_id"];
+  instance?: DB.Instance;
+}

package/collections/service.schema.d.ts

@@ -1,33 +1,35 @@
-import type { Photo } from '../common';
-import type { Base } from '../base.schema';
-import type * as DB from '../index';
+import type { Photo } from "../common";
+import type { Base } from "../base.schema";
+import type * as DB from "../index";
 
 export interface Service extends Base {
-	readonly service_id: string;
+  readonly service_id: string;
 
-	details: {
-		descname?: string;
-		description?: string;
-		logo_file_id?: string;
-	};
-	config: {
-		active_cover_file_ids: Record<string, boolean>;
-		display_contactpoint_ids: Record<string, boolean>;
-	};
+  details: {
+    descname?: string;
+    description?: string;
+    logo_file_id?: string;
+  };
 
-	cover_files: Photo[];
-	display_contactpoints: DB.Contactpoint[];
+  cover_files: Photo[];
+  display_contactpoints: DB.Contactpoint[];
 
-	org_id?: DB.Org['org_id'];
-	org?: DB.Org;
+  org_id?: DB.Org["org_id"];
+  org?: DB.Org;
 
-	servicetype_id?: DB.Servicetype['servicetype_id'];
-	servicetype?: DB.Servicetype;
+  servicetype_id?: DB.Servicetype["servicetype_id"];
+  servicetype?: DB.Servicetype;
 
-	location_id?: DB.Location['location_id'];
-	location?: DB.Location;
+  location_id?: DB.Location["location_id"];
+  location?: DB.Location;
 
-	schedules?: DB.Schedule[];
+  schedules?: DB.Schedule[];
 
-	logo_file?: Photo;
+  logo_file?: Photo;
+
+  config: {
+    disable?: boolean;
+    hidden?: boolean;
+    active_cover_file_ids: Record<string, number>;
+  };
 }

package/collections/servicetype.schema.d.ts

@@ -1,19 +1,17 @@
-import type { Base } from '../base.schema';
+import type { Base } from "../base.schema";
 
 export interface Servicetype extends Base {
-	readonly servicetype_id: string;
+  readonly servicetype_id: string;
 
-	details: {
-		descname?: string;
-		description?: string;
-		servicecategory: ServiceCategories;
-		icon_class?: string;
-		sport_icon_class?: string;
-	};
-	config: {
-		hidden: boolean;
-		disabled: boolean;
-	};
+  details: {
+    descname?: string;
+    description?: string;
+    servicecategory: ServiceCategories;
+    icon_class?: string;
+  };
+  config: {
+    hidden: boolean;
+  };
 }
 
-type ServiceCategories = 'membership' | 'facility_hire' | 'activity' | 'event';
+type ServiceCategories = "membership" | "facility_hire" | "activity";

package/collections/token.schema.d.ts

@@ -1,13 +1,13 @@
-import type { Base } from '../base.schema';
+import type { Base } from "../base.schema";
 
 export interface Token extends Base {
-	readonly token_id: string;
+  readonly token_id: string;
 
-	expiry_date?: string;
-	token_category?: TokenCategory;
-	payload: {
-		[x: string]: any;
-	};
+  expiry_date?: string;
+  token_category?: TokenCategory;
+  payload: {
+    [x: string]: any;
+  };
 }
 
-type TokenCategory = 'account_verification' | 'account_recovery' | 'whatsapp_token';
+type TokenCategory = "account_verification" | "account_recovery" | "whatsapp_token";

package/common.d.ts

@@ -1,18 +1,18 @@
 export type Coordinates = { readonly lat: number; readonly lng: number };
-export type GeoLocation = { readonly type: 'Point'; coordinates: Readonly<[number, number]> };
+export type GeoLocation = { readonly type: "Point"; coordinates: [number, number] };
 export type Photo = {
-	readonly file_id?: string;
-	readonly access_url?: string;
-	readonly source?: string;
+  readonly file_id?: string;
+  readonly access_url?: string;
+  readonly source?: string;
 };
 export type ContactInfo = {
-	operating_hours?: string;
-	mobile_number?: string;
-	email_address?: string;
+  operating_hours?: string;
+  mobile_number?: string;
+  email_address?: string;
 };
 
 export type ContactMethod = {
-	whatsapp?: boolean;
-	email?: boolean;
-	sms?: boolean;
+  whatsapp?: boolean;
+  email?: boolean;
+  sms?: boolean;
 };

package/index.d.ts

@@ -11,6 +11,7 @@ export * from "./collections/org.schema";
 export * from "./collections/payment.schema";
 export * from "./collections/profile.schema";
 export * from "./collections/schedule.schema";
+export * from "./collections/searchentry.schema";
 export * from "./collections/seat.schema";
 export * from "./collections/service.schema";
 export * from "./collections/servicetype.schema";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unaffi/schema",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "This reflects what the API returns, and not what the DB Schema looks like in MongoDB. Can be imported into any repo and be used by both TS and JS (JSDocs) code.",
   "types": "index.d.ts",
   "scripts": {