search filters

src/lib/api/index.ts

@@ -1,29 +1 @@
-export {
-  GetProvidersInputSchema,
-  GetProvidersResponseSchema,
-  type GetProvidersInputType,
-  type GetProvidersResponseType,
-  Gender,
-  Genders as GenderSchema,
-  Ethnicity,
-  Ethnicities as EthnicitySchema,
-  Modality,
-  ClinicalFocus,
-  DeliveryMethod
-} from './providers.schema';
-
-export {
-  GetAvailabilitiesInputSchema,
-  GetAvailabilitiesResponseSchema,
-  type GetAvailabilitiesInputType,
-  type GetAvailabilitiesResponseType
-} from './availabilities.schema';
-
-export {
-  BookAppointmentInputSchema,
-  BookAppointmentResponseSchema,
-  type BookAppointmentInputType,
-  type BookAppointmentResponseType
-} from './booking.schema';
-
-export { type SlotType } from './shared.schema';
+export * from './schema';

src/lib/api/schema/README.md

@@ -0,0 +1,31 @@
+These Zod schemas and enums can be used for a variety of use cases:
+
+- Populating UI elements in the front-end like dropdowns
+- Validating and parsing API inputs
+- Validating and parsing API responses.
+
+## On Validating and Parsing Responses
+
+When it comes to validating and parsing API responses, it might be better to keep the response schemas more flexible. For example, we don't necessarily need to validate that the `ClinicalFocus` field in the response strictly matches the list of predefined enums. Instead, we could simply check that it's an array of strings. However, validating and parsing `ClinicalFocus` on the input side of the API is more crucial, as we want to ensure that what we send to the API is valid and supported.
+
+We can decide on a field-by-field basis how strictly we want to define schemas and types for API inputs and responses.
+
+### Example
+
+**API input schema:**
+
+```
+const ApiInputSchema = z.object({
+  clinicalFocus: z
+    .array(z.enum(['Option 1', 'Option 2']))
+    .optional(),
+});
+```
+
+**API output schema:**
+
+```
+const ApiResponseSchema = z.object({
+  clinicalFocus: z.array(z.string()).optional(),
+});
+```

src/lib/api/schema/atoms/age.schema.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+
+export const AgeSchema = z.coerce.string(); // Both number and string will work

src/lib/api/schema/atoms/clinicalFocus.schema.ts

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+
+export enum ClinicalFocus {
+  ADHD = 'ADHD',
+  Anxiety = 'Anxiety d/o',
+  Autism = 'Autism spectrum',
+  'Gender dysphoria' = 'Gender dysphoria',
+  'Trauma (including PTSD)' = 'Trauma (including PTSD)',
+  Depression = 'Depressive d/o',
+  'Bipolar spectrum' = 'Bipolar spectrum',
+  'Anger management' = 'Anger management',
+  OCD = 'OCD',
+  'Personality d/o' = 'Personality d/o',
+  'Substance use' = 'Substance use',
+  Eating_Disorder = 'Eating d/o',
+  'Psychosis (e.g. schizophrenia)' = 'Psychosis (e.g. schizophrenia)',
+  'Dissociative d/o' = 'Dissociative d/o',
+  'Developmental delay' = 'Developmental delay',
+  'Traumatic brain injury' = 'Traumatic brain injury'
+}
+
+export const ClinicalFocusSchema = z.array(z.nativeEnum(ClinicalFocus));

src/lib/api/schema/atoms/deliveryMethod.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export enum DeliveryMethod {
+  'Virtual' = 'virtual',
+  'In-person' = 'in-person'
+}
+
+export const DeliveryMethodSchema = z.nativeEnum(DeliveryMethod);

src/lib/api/schema/atoms/ethnicity.schema.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+
+export enum Ethnicity {
+  'Asian' = 'Asian',
+  'Black or African American' = 'Black or African American',
+  'Hispanic or Latinx' = 'Hispanic or Latinx',
+  'White' = 'White',
+  'Other' = 'Other'
+}
+export const EthnicitySchema = z.nativeEnum(Ethnicity);

src/lib/api/schema/atoms/gender.schema.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+export enum Gender {
+  Male = 'M',
+  Female = 'F',
+  'Non-binary/non-conforming' = 'Non-binary/non-conforming'
+}
+
+export const GenderSchema = z.nativeEnum(Gender);

src/lib/api/schema/atoms/index.ts

@@ -0,0 +1,9 @@
+export * from './age.schema';
+export * from './clinicalFocus.schema';
+export * from './deliveryMethod.schema';
+export * from './ethnicity.schema';
+export * from './gender.schema';
+export * from './language.schema';
+export * from './locationFacility.schema';
+export * from './locationState.schema';
+export * from './therapeuticModality.schema';

src/lib/api/schema/atoms/language.schema.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+
+export const LanguageSchema = z.string();

src/lib/api/schema/atoms/locationFacility.schema.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+
+export enum LocationFacility {
+  CherryCreek = 'Cherry Creek',
+  GreenwoodVillage = 'Greenwood Village',
+  CentralPark = 'Central Park',
+  Lakewood = 'Lakewood',
+  Boulder = 'Boulder',
+  HighlandsRanch = 'Highlands Ranch',
+  Broomfield = 'Broomfield',
+  Parker = 'Parker',
+  Gaithersburg = 'Gaithersburg',
+  Frederick = 'Frederick',
+  Ballston = 'Ballston',
+  Downtown = 'Downtown',
+  Tysons = 'Tysons',
+  SilverSpring = 'Silver Spring',
+  BrooklynHeights = 'Brooklyn Heights',
+  UnionSquare = 'Union Square',
+  LongIslandCity = 'Long Island City',
+  ColumbusCircle = 'Columbus Circle',
+  Williamsburg = 'Williamsburg',
+  WallStreet = 'Wall Street',
+  Astoria = 'Astoria',
+  Gowanus = 'Gowanus',
+  MidtownEast = 'Midtown East',
+  Manhasset = 'Manhasset',
+  Melville = 'Melville',
+  ValleyStream = 'Valley Stream',
+  Massapequa = 'Massapequa',
+  Woodlands = 'Woodlands',
+  UpperKirby = 'Upper Kirby',
+  Austin = 'Austin'
+}
+
+export const LocationFacilitySchema = z.nativeEnum(LocationFacility);

src/lib/api/schema/atoms/locationState.schema.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+export enum LocationState {
+  CO = 'CO',
+  NY = 'NY',
+  TX = 'TX',
+  VA = 'VA',
+  MD = 'MD',
+  DC = 'DC'
+}
+
+/**
+ * The back-end can receive any string (no validation) but the front-end needs to display
+ * a list of supported states
+ */
+export const LocationStateSchema = z.nativeEnum(LocationState);

src/lib/api/schema/atoms/therapeuticModality.schema.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+
+export enum Modality {
+  'Psychiatric' = 'Psychiatric',
+  'Therapy' = 'Therapy'
+}
+
+export const TherapeuticModalitySchema = z.nativeEnum(Modality);

src/lib/api/schema/index.ts

@@ -0,0 +1,24 @@
+export * from './atoms';
+
+export {
+  GetProvidersInputSchema,
+  GetProvidersResponseSchema,
+  type GetProvidersInputType,
+  type GetProvidersResponseType
+} from './providers.schema';
+
+export {
+  GetAvailabilitiesInputSchema,
+  GetAvailabilitiesResponseSchema,
+  type GetAvailabilitiesInputType,
+  type GetAvailabilitiesResponseType
+} from './availabilities.schema';
+
+export {
+  BookAppointmentInputSchema,
+  BookAppointmentResponseSchema,
+  type BookAppointmentInputType,
+  type BookAppointmentResponseType
+} from './booking.schema';
+
+export { type SlotType } from './shared.schema';