@community-kitchens/apiinterfaces 1.0.20 → 1.0.22

package/homeChef/types.ts

@@ -1,4 +1,8 @@
-import { Job, VolunteerShift, VolunteerHours } from "../volunteer/types";
+import {
+  Job,
+  VolunteerShift,
+  VolunteerHours,
+} from "../volunteer/jobsAndShifts";
 
 export interface NotificationPayload {
   title: string;

package/index.ts

@@ -3,6 +3,6 @@ export * from "./d4j/types";
 export * from "./form/formTypes";
 export * from "./mealProgram/types";
 export * from "./text/types";
-export * from "./volunteer/types";
+export * from "./volunteer";
 export * from "./homeChef/types";
 export * from "./sign/types";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@community-kitchens/apiinterfaces",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "",
   "license": "ISC",
   "author": "",

package/volunteer/campaign.ts

@@ -0,0 +1,13 @@
+export type Campaign = {
+  mealsDonated: number;
+};
+
+export interface VolunteerCampaign {
+  name: string;
+  startDate?: string;
+  endDate?: string;
+  description?: string;
+  id: string;
+  shortDescription?: string;
+  totalHours?: number;
+}

package/volunteer/checkin.ts

@@ -0,0 +1,32 @@
+export interface VolunteerForCheckIn {
+  hoursId: string;
+  contactId: string;
+  firstName?: string;
+  lastName: string;
+  email?: string;
+  volunteerAgreement: boolean;
+  status: string;
+}
+
+export interface ShiftForCheckIn {
+  id: string;
+  jobName: string;
+  startTime: string;
+  duration: number;
+}
+
+export interface JobForCheckIn {
+  name: string;
+  shifts: string[];
+  id: string;
+}
+
+export interface CheckInArgs {
+  hoursId: string;
+  duration: number;
+}
+
+export type CheckInShiftsResponse = {
+  jobs: Record<string, JobForCheckIn>;
+  shifts: Record<string, ShiftForCheckIn>;
+};

package/volunteer/contact.ts

@@ -0,0 +1,22 @@
+export interface Volunteer {
+  householdId: string;
+  name?: string;
+  id: string;
+  portalUsername?: string;
+  firstName?: string;
+  volunteerAgreement: boolean;
+  email: string;
+  calfreshVolunteer?: boolean;
+}
+
+export interface CreateVolunteerArgs {
+  email: string;
+  firstName: string;
+  lastName: string;
+  calfreshVolunteer?: boolean;
+}
+
+export interface UploadDocArgs {
+  file: File;
+  date: string;
+}

package/volunteer/driver.ts

@@ -0,0 +1,27 @@
+import { Job } from "./jobsAndShifts";
+
+export type CarSize = "Small" | "Medium" | "Large" | "Bike";
+
+export interface DriverInfo {
+  licenseExpiration?: string;
+  insuranceExpiration?: string;
+  volunteerAgreement: boolean;
+  car: CarInfo;
+  driverStatus?: "Active" | "Inactive";
+}
+
+export interface CarInfo {
+  size?: CarSize;
+  make?: string;
+  model?: string;
+  year?: string;
+  color?: string;
+}
+
+export interface DriverJob extends Job {
+  carSizeRequired: CarSize;
+  destination: string;
+  dropoffNotes: string;
+  distance: number;
+  timeRequired?: number;
+}

package/volunteer/hours.ts

@@ -0,0 +1,37 @@
+export interface CancelVolunteerHoursArgs {
+  hoursId: string;
+  contactId?: string;
+}
+
+export interface GetVolunteerHoursArgs {
+  campaignId: string;
+  contactId: string;
+}
+
+export interface VolunteerHours {
+  id: string;
+  mealCount?: string;
+  time: string;
+  job: string;
+  status: string;
+  shift: string;
+  campaign?: string;
+  mealType?: "Entree" | "Soup";
+}
+
+export interface EditHoursArgs {
+  id: string;
+  mealCount: string;
+  cancel: boolean;
+  date: string;
+  fridge: string;
+  mealType: "Soup" | "Entree";
+}
+
+export interface CreateVolunteerHoursArgs {
+  shiftId: string;
+  jobId: string;
+  date: string;
+  contactSalesforceId: string;
+  reserved?: boolean;
+}

package/volunteer/index.ts

@@ -0,0 +1,6 @@
+export * from "./campaign";
+export * from "./checkin";
+export * from "./contact";
+export * from "./driver";
+export * from "./hours";
+export * from "./jobsAndShifts";

package/volunteer/jobsAndShifts.ts

@@ -0,0 +1,40 @@
+export interface VolunteerShift {
+  id: string;
+  startTime: string;
+  open: boolean;
+  job: string;
+  restaurantMeals?: boolean;
+  duration: number;
+  // endTime: string;
+  slots: number;
+  reservedOpen?: boolean;
+  totalSlots?: number;
+}
+
+export type FridgeRegion =
+  | "East Oakland"
+  | "West Oakland"
+  | "Berkeley"
+  | "CK Kitchen";
+
+export interface Job {
+  id: string;
+  name: string;
+  location?: string;
+  locationInfo?: string;
+  locationCity?: string;
+  shifts: VolunteerShift[];
+  active: boolean;
+  ongoing: boolean;
+  description?: string;
+  campaign: string;
+  region?: FridgeRegion;
+  notes?: string;
+  photo?: string;
+  noTextAlert?: boolean;
+}
+
+export interface GetShiftsResponse {
+  jobs: Job[];
+  shifts: VolunteerShift[];
+}

package/volunteer/types.ts

@@ -1,172 +0,0 @@
-export interface VolunteerForCheckIn {
-  hoursId: string;
-  contactId: string;
-  firstName?: string;
-  lastName: string;
-  email?: string;
-  volunteerAgreement: boolean;
-  status: string;
-}
-
-export interface ShiftForCheckIn {
-  id: string;
-  jobName: string;
-  startTime: string;
-  duration: number;
-}
-
-export interface JobForCheckIn {
-  name: string;
-  shifts: string[];
-  id: string;
-}
-
-export interface CheckInArgs {
-  hoursId: string;
-  duration: number;
-}
-
-export type CheckInShiftsResponse = {
-  jobs: Record<string, JobForCheckIn>;
-  shifts: Record<string, ShiftForCheckIn>;
-};
-
-export type CarSize = "Small" | "Medium" | "Large" | "Bike";
-
-export interface DriverInfo {
-  licenseExpiration?: string;
-  insuranceExpiration?: string;
-  volunteerAgreement: boolean;
-  car: CarInfo;
-  driverStatus?: "Active" | "Inactive";
-}
-
-export interface CarInfo {
-  size?: CarSize;
-  make?: string;
-  model?: string;
-  year?: string;
-  color?: string;
-}
-
-export interface UploadDocArgs {
-  file: File;
-  date: string;
-}
-
-export type Campaign = {
-  mealsDonated: number;
-};
-
-export interface VolunteerShift {
-  id: string;
-  startTime: string;
-  open: boolean;
-  job: string;
-  restaurantMeals?: boolean;
-  duration: number;
-  // endTime: string;
-  slots: number;
-  reservedOpen?: boolean;
-  totalSlots?: number;
-}
-
-export type FridgeRegion =
-  | "East Oakland"
-  | "West Oakland"
-  | "Berkeley"
-  | "CK Kitchen";
-
-export interface Job {
-  id: string;
-  name: string;
-  location?: string;
-  locationInfo?: string;
-  locationCity?: string;
-  shifts: VolunteerShift[];
-  active: boolean;
-  ongoing: boolean;
-  description?: string;
-  campaign: string;
-  region?: FridgeRegion;
-  notes?: string;
-  photo?: string;
-  noTextAlert?: boolean;
-}
-
-export interface DriverJob extends Job {
-  carSizeRequired: CarSize;
-  destination: string;
-  dropoffNotes: string;
-  distance: number;
-  timeRequired?: number;
-}
-
-export interface GetShiftsResponse {
-  jobs: Job[];
-  shifts: VolunteerShift[];
-}
-
-export interface VolunteerCampaign {
-  name: string;
-  startDate?: string;
-  endDate?: string;
-  description?: string;
-  id: string;
-  shortDescription?: string;
-}
-
-export interface VolunteerHours {
-  id: string;
-  mealCount?: string;
-  time: string;
-  job: string;
-  status: string;
-  shift: string;
-  campaign?: string;
-  mealType?: "Entree" | "Soup";
-}
-
-export interface EditHoursArgs {
-  id: string;
-  mealCount: string;
-  cancel: boolean;
-  date: string;
-  fridge: string;
-  mealType: "Soup" | "Entree";
-}
-
-export interface CreateVolunteerHoursArgs {
-  shiftId: string;
-  jobId: string;
-  date: string;
-  contactSalesforceId: string;
-  reserved?: boolean;
-}
-
-export interface Volunteer {
-  householdId: string;
-  name?: string;
-  id: string;
-  portalUsername?: string;
-  firstName?: string;
-  volunteerAgreement: boolean;
-  email: string;
-  calfreshVolunteer?: boolean;
-}
-
-export interface CreateVolunteerArgs {
-  email: string;
-  firstName: string;
-  lastName: string;
-}
-
-export interface CancelVolunteerHoursArgs {
-  hoursId: string;
-  contactId?: string;
-}
-
-export interface GetVolunteerHoursArgs {
-  campaignId: string;
-  contactId: string;
-}