@unaffi/schema 1.0.0

package/README.md

@@ -0,0 +1,4 @@
+# UNAFFI Schema defined in Typescript
+
+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.

package/base.schema.d.ts

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

package/collections/action.schema.d.ts

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

package/collections/collaborator.schema.d.ts

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

package/collections/contactpoint.schema.d.ts

@@ -0,0 +1,20 @@
+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;
+
+	type?: string;
+	point?: string;
+	details: {
+		descname?: string;
+		description?: string;
+	};
+
+	org_id?: Org['org_id'];
+	org?: Org;
+
+	profile_id?: Profile['profile_id'];
+	profile?: Profile;
+}

package/collections/facility.schema.d.ts

@@ -0,0 +1,26 @@
+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;
+
+	linked_facility_ids: DB.Facility['facility_id'][];
+	linked_facilities: DB.Facility;
+
+	details: {
+		descname?: string;
+		description?: string;
+		geo_location?: GeoLocation;
+	};
+	config: {
+		hidden: boolean;
+		disabled: boolean;
+	};
+
+	org_id?: DB.Org['org_id'];
+	org?: DB.Org;
+
+	location_id?: DB.Location['location_id'];
+	location?: DB.Location;
+}

package/collections/file.schema.d.ts

@@ -0,0 +1,25 @@
+import type { Base } from '../base.schema';
+import type * as DB from '../index';
+
+export interface File extends Base {
+	readonly file_id: string;
+
+	details: {
+		descname?: string;
+		description?: 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;
+
+	profile_id?: DB.Profile['profile_id'];
+	profile?: DB.Profile;
+}

package/collections/form.schema.d.ts

@@ -0,0 +1,52 @@
+import type { Base } from '../base.schema';
+import type * as DB from '../index';
+
+export interface Form extends Base {
+	readonly form_id: string;
+
+	type?: FormType;
+	details?: {
+		descname?: string;
+		description?: string;
+		// These are the questions to be filled in.
+		fields?: Field[];
+	};
+
+	org_id?: DB.Org['org_id'];
+	org?: DB.Org;
+}
+
+type FormType = 'fields';
+export type FieldType =
+	| 'text'
+	| 'textarea'
+	| 'number'
+	| 'boolean'
+	| 'date'
+	| 'image'
+	| 'map'
+	| 'html'
+	| 'dropdown'
+	| 'time'
+	| 'page'
+	| 'category';
+
+export interface Field {
+	// What type of question
+	fieldtype?: FieldType;
+	// In what field will the answer be stored
+	name?: string;
+	// The question's text
+	label?: string;
+
+	index: number;
+
+	required?: boolean;
+
+	options?: FieldOption[];
+}
+
+export interface FieldOption {
+	label: string;
+	value?: any;
+}

package/collections/instance.schema.d.ts

@@ -0,0 +1,48 @@
+import type { Base } from '../base.schema';
+import type * as DB from '../index';
+
+export interface Instance extends Base {
+	readonly instance_id: string;
+
+	status: InstanceStatuses;
+
+	slots: InstanceSlot[];
+	settings: Settings;
+	seats: DB.Seat[];
+
+	seat_profiles: (DB.Seat & DB.Profile)[];
+
+	is_historical: boolean;
+
+	org_id?: DB.Org['org_id'];
+	org?: DB.Org;
+
+	service_id?: DB.Service['service_id'];
+	service?: DB.Service;
+
+	profile_id?: DB.Profile['profile_id'];
+	profile?: DB.Profile;
+
+	service_schedule?: DB.Schedule;
+
+	actions: DB.Action[];
+}
+
+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 }[];
+};
+
+type Settings = {
+	[x: string]: any;
+};

package/collections/location.schema.d.ts

@@ -0,0 +1,32 @@
+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;
+
+	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;
+	};
+
+	display_contactpoints: DB.Contactpoint[];
+	cover_files: Photo[];
+
+	org_id?: DB.Org['org_id'];
+	org?: DB.Org;
+
+	services?: DB.Service[];
+
+	card_background_file?: Photo;
+}

package/collections/order.schema.d.ts

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

package/collections/org.schema.d.ts

@@ -0,0 +1,34 @@
+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;
+
+	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[];
+
+	// Keeping config to a minimum for now.
+	config: {
+		active_cover_file_ids: Record<string, number>;
+	};
+
+	collaborators?: DB.Collaborator[];
+	facilities?: DB.Facility[];
+}
+
+type CountryCodes = 'ZAF';
+type CurrencyCodes = 'ZAR';

package/collections/payment.schema.d.ts

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

package/collections/profile.schema.d.ts

@@ -0,0 +1,62 @@
+import type { Base } from '../base.schema';
+import type * as DB from '../index';
+
+export interface Profile extends Base {
+	readonly profile_id: string;
+
+	profile_pic_file?: {
+		access_url: string;
+	};
+	cover_pic_file?: {
+		access_url: string;
+	};
+
+	details: {
+		first_name?: string;
+		last_name?: string;
+		mobile_number?: string;
+		email_address?: string;
+		bio?: string;
+
+		profile_pic_file_id?: string;
+		cover_pic_file_id?: string;
+
+		is_dependant: boolean;
+		relationship_to_owner?: string;
+		contact_method: {
+			email?: boolean;
+			sms?: boolean;
+			whatsapp?: boolean;
+		};
+	};
+
+	authentication?: {
+		password: {
+			hash: string;
+		};
+		google: {
+			sub: string;
+		};
+	};
+
+	payment_cards?: PaymentCard[];
+
+	latest_session?: {
+		time: Date;
+	};
+
+	first_session?: {
+		time: Date;
+	};
+
+	parent_profile_id: DB.Profile['profile_id'];
+	parent_profile?: DB.Profile;
+}
+
+export interface PaymentCard {
+	descname?: string;
+	is_default?: boolean;
+	payment_card_id?: string;
+	provider_name?: string;
+	provider_details?: Record<string, any>;
+}

package/collections/schedule.schema.d.ts

@@ -0,0 +1,105 @@
+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;
+}
+
+export interface Session extends Base {
+	readonly session_id: string;
+
+	descname?: string;
+	start_time?: number;
+	duration?: number;
+	slot_duration?: number;
+	max_instances?: number;
+	rates: Rate[];
+
+	schedule_id: string; // Fake
+}
+
+export interface Rate {
+	rate: number;
+	conditions?: Condition[];
+
+	session_id?: string; // Fake
+	schedule_id?: string; // Fake
+}
+
+export interface Condition {
+	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;
+}
+
+type ConditionType = 'seat_in_service';

package/collections/seat.schema.d.ts

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

package/collections/service.schema.d.ts

@@ -0,0 +1,33 @@
+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;
+
+	details: {
+		descname?: string;
+		description?: string;
+		logo_file_id?: string;
+	};
+	config: {
+		active_cover_file_ids: Record<string, boolean>;
+		display_contactpoint_ids: Record<string, boolean>;
+	};
+
+	cover_files: Photo[];
+	display_contactpoints: DB.Contactpoint[];
+
+	org_id?: DB.Org['org_id'];
+	org?: DB.Org;
+
+	servicetype_id?: DB.Servicetype['servicetype_id'];
+	servicetype?: DB.Servicetype;
+
+	location_id?: DB.Location['location_id'];
+	location?: DB.Location;
+
+	schedules?: DB.Schedule[];
+
+	logo_file?: Photo;
+}

package/collections/servicetype.schema.d.ts

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

package/collections/token.schema.d.ts

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

package/common.d.ts

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

package/index.d.ts

@@ -0,0 +1,17 @@
+export * from "./collections/action.schema";
+export * from "./collections/collaborator.schema";
+export * from "./collections/contactpoint.schema";
+export * from "./collections/facility.schema";
+export * from "./collections/file.schema";
+export * from "./collections/form.schema";
+export * from "./collections/instance.schema";
+export * from "./collections/location.schema";
+export * from "./collections/order.schema";
+export * from "./collections/org.schema";
+export * from "./collections/payment.schema";
+export * from "./collections/profile.schema";
+export * from "./collections/schedule.schema";
+export * from "./collections/seat.schema";
+export * from "./collections/service.schema";
+export * from "./collections/servicetype.schema";
+export * from "./collections/token.schema";

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@unaffi/schema",
+  "version": "1.0.0",
+  "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": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UNAFFI/unaffi-schema.git"
+  },
+  "keywords": [
+    "unaffi",
+    "schema"
+  ],
+  "author": "Tertius van Niekerk",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/UNAFFI/unaffi-schema/issues"
+  },
+  "homepage": "https://github.com/UNAFFI/unaffi-schema#readme"
+}