@gobolt/genesis 0.7.2-beta.1 → 0.8.0

package/dist/interface/address.d.ts

@@ -0,0 +1,10 @@
+export interface Address {
+    id: string;
+    country: string;
+    city: string;
+    province: string;
+    address: string;
+    address_two: string | null;
+    postal_code: string;
+    nickname: string | null;
+}

package/dist/interface/appointment.d.ts

@@ -0,0 +1,56 @@
+import { Fulfillment, Storage } from '@secondcloset/types';
+import { Address } from './address';
+export type AppointmentOrShipment = Omit<Storage.Appointment, "user_firstname" | "user_lastname"> | Omit<Fulfillment.Appointment, "user_firstname" | "user_lastname">;
+export type AppointmentMissOTIFStatus = {
+    status: "early" | "late";
+    durationMin: number;
+};
+export type AppointmentOntimeOTIFStatus = {
+    status: "on_time";
+};
+export type AppointmentOTIFStatus = AppointmentMissOTIFStatus | AppointmentOntimeOTIFStatus;
+export type BvrAppointmentDetails = {
+    id: string;
+    address: Address;
+    number: string;
+    status: string;
+    job_subtype: string;
+    created_at: string;
+    updated_at: string;
+    organization_name: string | null;
+};
+export type BvrAppointment = {
+    id: string;
+    date: string;
+    type: string;
+    number: string;
+    status: string;
+    timerange: string;
+    address: Address;
+    job_type: string;
+    job_subtype: string;
+    start_time: string | null;
+    end_time: string | null;
+    organization_name: string | null;
+};
+export declare enum AppointmentStatus {
+    request_received = "request_received",
+    confirmed = "confirmed",
+    scheduled = "scheduled",
+    cancelled = "cancelled",
+    ready = "ready",
+    loaded = "loaded",
+    on_the_way = "on_the_way",
+    arrived = "arrived",
+    incomplete = "incomplete",
+    started = "started",
+    done = "done",
+    staging = "staging",
+    completed = "completed",
+    signed = "signed",
+    failed = "failed"
+}
+export declare enum ParcelAppointmentPackageStatus {
+    pending_receiving = "pending_receiving",
+    staged = "staged"
+}

package/dist/interface/appointmentV2.d.ts

@@ -0,0 +1,64 @@
+import { AppointmentStatus, AppointmentSubtype, AppointmentType, DeliveryType, ScServiceCode } from '@secondcloset/types/src/fulfillment';
+export type Address = {
+    addresss: string;
+    line_1: string;
+    line_2: string;
+    city: string;
+    province: string;
+    country: string;
+    postal_code: string;
+    nickname: string | null;
+    is_primary: boolean | null;
+    coordinates: {
+        x: number;
+        y: number;
+    };
+};
+export type Customer = {
+    id: string;
+    name: string;
+    phone_number: string | null;
+    user_id: string | null;
+};
+export type PackageWeight = {
+    weight_unit: string;
+    weight_value: number;
+};
+export type Appointment = {
+    id: string;
+    date: string;
+    timeslot: string;
+    number: string;
+    job_type: AppointmentType;
+    job_subtype: AppointmentSubtype;
+    status: AppointmentStatus;
+    air_skip: string | null;
+    delivery_service_level: ScServiceCode;
+    delivery_type: DeliveryType;
+    service_area: string;
+    organization_name: string | null;
+    timezone: string | null;
+    state: "assigned" | "unassigned";
+    recommended_route_user_count: number;
+    order_id: string;
+    organization_id: string;
+    transport_work_order_id: string | null;
+    route_id: string | null;
+    parcel_service_level: string | null;
+    order_number: string;
+    external_order_number: string | null;
+    order_platform: string | null;
+    external_platform_version: string | null;
+    arrival_eta: string | null;
+    estimated_duration_seconds: number | null;
+    range_of_days_start_date: string | null;
+    range_of_days_end_date: string | null;
+    type: string | null;
+    package_count: number;
+    package_weights: PackageWeight[] | null;
+    package_ids: string[] | null;
+    tracking_numbers: string[] | null;
+    master_tracking_number: string | null;
+    customer: Customer | null;
+    address: Address | null;
+};

package/dist/interface/appointmentsState.d.ts

@@ -0,0 +1,20 @@
+import { Storage } from '@secondcloset/types';
+import { AppointmentOrShipment } from './appointment';
+export type AppointmentsLibrary = {
+    [appointmentID: string]: AppointmentOrShipment;
+};
+type AppointmentsMarkers = {
+    [stringifiedMarkerKey: string]: string[];
+};
+type AppointmentsIDsMap = {
+    [appointmentID: string]: string;
+};
+export interface AppointmentsState {
+    appointmentsLibrary: AppointmentsLibrary;
+    appointmentsMarkers: AppointmentsMarkers;
+    inventoryPickupCrossDockDeliveryPairs: AppointmentsIDsMap;
+    reverseLogisticsReturnToSenderPairs: AppointmentsIDsMap;
+    inventoryOnHandAppointmentIDMap: AppointmentsIDsMap;
+    appointmentTimeslots: Storage.AppointmentSlot[];
+}
+export {};

package/dist/interface/common.d.ts

@@ -0,0 +1,2 @@
+export type Location = [number, number];
+export type Environment = "staging" | "preprod" | "production";

package/dist/interface/completionData.d.ts

@@ -0,0 +1,18 @@
+interface CompletionLocation {
+    type: "Point" | string;
+    coordinates: [number, number];
+}
+export interface CompletionData {
+    id: string;
+    appointment_id: string;
+    route_id: string;
+    user_id: string;
+    completion_location: CompletionLocation;
+    is_wrong_location: boolean;
+    wrong_location_reason: string | null;
+    distance_to_appointment_in_meters: number;
+    deleted_at: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export {};

package/dist/interface/deliveryPartner.d.ts

@@ -0,0 +1,24 @@
+import { ServiceArea } from '@secondcloset/types/src/_common';
+export interface DeliveryPartner {
+    id: string;
+    type: DeliveryPartnerType;
+    company_name: string;
+    email?: string;
+    address?: string;
+    phone_number?: string;
+    incorporation_id?: string;
+    website?: string;
+    created_at: string;
+}
+export type DeliveryPartnerType = "fleet_operator" | "independent_operator";
+export type DeliveryPartnerDriver = {
+    id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    service_areas: ServiceArea[];
+    terms_and_conditions_signed: boolean;
+    terms_and_conditions_signed_at: string;
+    company_name?: string;
+    created_at: string;
+};

package/dist/interface/organization.d.ts

@@ -0,0 +1,9 @@
+export interface OrganizationName {
+    id: string;
+    name: string;
+}
+export type Organization = OrganizationName & {
+    phone_number: string | null;
+    email: string | null;
+    created_at: string;
+};

package/dist/interface/pagination.d.ts

@@ -0,0 +1,8 @@
+export interface Pagination {
+    count: number;
+    pages: number;
+    per_page: number;
+    current: number;
+    next: number | null;
+    previous: number | null;
+}

package/dist/interface/roles.d.ts

@@ -0,0 +1,9 @@
+export interface Permission {
+    id: string;
+    name: string;
+}
+export interface Role {
+    id: string;
+    name: string;
+    permissions: Permission[];
+}

package/dist/interface/route.d.ts

@@ -0,0 +1,72 @@
+import { Storage } from '@secondcloset/types';
+import { AppointmentOrShipment } from './appointment';
+import { VehicleKind, VehicleType } from './vehicle';
+export interface RouteItem {
+    appointment_id: string;
+    appointment_type: "fulfillment" | "storage";
+    type: AppointmentOrShipment;
+    status: string;
+    number: string;
+    date: string;
+    timerange: Storage.AppointmentSlot;
+    sequence: number;
+}
+export interface RouteUser {
+    user_id: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    subrole: string;
+    assigned_role: string;
+    delivery_partner_id?: string;
+    delivery_partner_name?: string;
+}
+export type Route = {
+    id: string;
+    route_date: string;
+    route_name: string;
+    route_number: string;
+    route_status: string;
+    route_color: string;
+    dispatch_time: string;
+    notes: string;
+    vehicle_id: string | null;
+    vehicle_type: VehicleType | null;
+    created_at: string;
+    route_items: RouteItem[];
+    route_users: RouteUser[];
+    estimated_travel_distance_in_meters: number | null;
+    estimated_travel_time_in_seconds: number | null;
+    automation_job_id: string | null;
+    route_items_updated: boolean;
+    hub_id: string | null;
+    published_at: string | null;
+    recommended_route_user_count: number | null;
+    color?: string | null;
+    dominant_delivery_type?: string;
+    dominant_zone_id?: string;
+    dominant_zone_name?: string;
+} & RouteVehicleKind;
+export type RouteVehicleKind = {
+    vehicle_kind_id: string;
+    vehicle_kind_name: string;
+    vehicle_kind_fuel_type: VehicleKind["fuel_type"];
+} | {
+    vehicle_kind_id: null;
+    vehicle_kind_name: null;
+    vehicle_kind_fuel_type: null;
+};
+export interface InternalVehicle {
+    id: string;
+    type: Extract<VehicleType, "internal">;
+}
+export interface DSPVehicle {
+    id: null;
+    type: Extract<VehicleType, "dsp_default">;
+}
+export type RouteActionReason = {
+    name: string;
+    notes?: string;
+};
+export type RouteDeleteReason = RouteActionReason;
+export type RouteUpdateReason = RouteActionReason;

package/dist/interface/routeAnalysis.d.ts

@@ -0,0 +1,107 @@
+import { ServiceArea } from '@secondcloset/types/src/_common';
+import { AppointmentOrShipment } from './appointment';
+type RouteItem = {
+    appointment_id: string;
+    type: string;
+    status: string;
+    number: string;
+    date: string;
+    timerange: string;
+    stop_duration: number;
+    timezone: string;
+    sequence: number;
+    total_weight: number;
+    total_items_count: number;
+    estimated_duration_seconds?: number;
+    delivery_type: Exclude<AppointmentOrShipment["delivery_type"], undefined>;
+    delivery_service_level: Exclude<AppointmentOrShipment["delivery_service_level"], undefined>;
+    coordinates: {
+        lat: number;
+        lng: number;
+    };
+};
+export type RouteAnalysisStatisticsAppointment = Omit<RouteItem, "type"> & {
+    appointment_id: string | "warehouse-id" | "depot";
+    type: number;
+    is_pickup?: boolean;
+    stop_duration: number;
+    arrival_eta?: string;
+    departure_eta?: string;
+    mapbox_arrival_eta?: string;
+    mapbox_departure_eta?: string;
+    travel_distance_in_meters?: number;
+    actual_travel_distance_in_meters?: number;
+    actual_travel_duration_in_seconds?: number;
+    total_duration_in_seconds?: number;
+    travel_duration_in_seconds?: number;
+    skip_prediction?: boolean;
+    date?: string;
+    number?: string;
+    status?: string;
+    sequence?: number;
+    timezone?: string;
+    timerange?: string;
+    coordinates?: {
+        lat: number;
+        lng: number;
+    };
+    total_weight?: number;
+    delivery_type?: string;
+    total_items_count?: number;
+    delivery_service_level?: string;
+    estimated_duration_seconds?: number | null;
+    service_area?: {
+        name?: ServiceArea;
+    };
+    start_time?: string | null;
+    end_time?: string | null;
+    organization_id?: string;
+    organization_name?: string | null;
+    failed_reason?: string | null;
+    incomplete_at?: string | null;
+};
+type RouteAnalysisStatistics = {
+    appointments: RouteAnalysisStatisticsAppointment[];
+    total_duration_in_seconds: number;
+    total_travel_distance_in_meters: number;
+    total_weight: number;
+    total_items_count: number;
+    route_polyline?: number[][];
+};
+export type RouteAnalysis = {
+    id: string;
+    external_route_id: string;
+    analysis: RouteAnalysisStatistics;
+    analysis_snapshot: RouteAnalysisStatistics;
+    analysis_snapshot_planning?: RouteAnalysisStatistics | null;
+};
+export type RouteAnalysisMap = {
+    [routeID: string]: RouteAnalysis;
+};
+export type RouteAnalysisTotal = {
+    id: string;
+    external_route_id: string;
+    total_duration_in_seconds: number;
+    total_travel_distance_in_meters: number;
+    total_weight_in_grams: number;
+    total_items_count: number;
+    total_stops_count: number;
+    created_at: string;
+    updated_at: string;
+    route_progress_info?: {
+        completed_appointments: number;
+        failed_appointments: number;
+        total_appointments: number;
+    };
+};
+export type RouteAnalysisTotalMap = {
+    [routeID: string]: RouteAnalysisTotal;
+};
+export type RoutePolyline = {
+    external_route_id: string;
+    route_polyline: number[][] | null;
+};
+export type RoutePolylineMap = {
+    [routeID: string]: RoutePolyline;
+};
+export {};

package/dist/interface/routeAutomationJob.d.ts

@@ -0,0 +1,94 @@
+import { ServiceArea } from '@secondcloset/types/src/_common';
+export declare enum JobStatus {
+    CREATING_ROUTES = "creating_routes",
+    CREATING_DISTANCE_ETAS = "creating_distance_etas",
+    ACTIVE = "active",
+    COMPLETED = "completed",
+    COMPLETED_WITHOUT_STATISTICS = "completed_without_statistics",
+    FAILED = "failed",
+    CANCELLED = "cancelled"
+}
+export declare const OngoingJobStatus: JobStatus[];
+export type AutomationJobStatisticsAppointment = {
+    id: string;
+    route_id?: string;
+    stop_duration: number;
+    timerange?: string;
+    ets: string;
+    etd: string;
+    type: number;
+    nextmv_arrival_eta: string;
+    nextmv_departure_eta: string;
+    google_arrival_eta: string;
+    google_departure_eta: string;
+    google_duration_in_seconds: number;
+    google_travel_duration_in_seconds: number;
+    google_travel_distance_in_meters: number;
+    duration_in_seconds: number;
+    travel_duration_in_seconds: number;
+};
+export type AutomationJobStatistics = {
+    vehicle_id: string;
+    route_id: string;
+    job_id: string;
+    appointments: AutomationJobStatisticsAppointment[];
+    total_google_duration_in_seconds: number;
+    total_google_travel_duration_in_seconds: number;
+    total_google_travel_distance_in_meters?: number;
+    total_duration_in_seconds: number;
+    total_travel_duration_in_seconds: number;
+    total_stop_time: number;
+    aph: number;
+    google_aph: number;
+    total_items_count: number;
+    total_weight: number;
+};
+export interface AutomateRoutingDtoConfiguration {
+    vehicle_penalization: number;
+    min_max_factor: number;
+    max_stops: number;
+    min_stops: number;
+    morning_threshold: number;
+    afternoon_threshold: number;
+    evening_threshold: number;
+    wrong_route_length: number;
+    timeslot_threshold_penalization: number;
+    time_on_road_penalization: number;
+    speed_scaling_factor: number;
+    dont_use_selector: boolean;
+    unassigned_penalty: number;
+    route_automation_runtime: number;
+    timezone: string;
+    limits: {
+        [key: number]: number;
+    };
+}
+export interface RouteAutomationJob {
+    appointment_ids: string[];
+    completed_at: string | null;
+    created_at: string;
+    date: string;
+    id: string;
+    output: string | null;
+    input: {
+        configuration: Partial<AutomateRoutingDtoConfiguration>;
+        date?: string;
+        speed?: number;
+    };
+    service_area: ServiceArea;
+    status: JobStatus;
+    updated_at: string;
+    vehicle_ids: string[];
+    user_id: string;
+    user_name: string;
+    version: string;
+    queue?: {
+        count?: number;
+        state?: string;
+    };
+    statistics?: AutomationJobStatistics[];
+    total_vehicles_count: number;
+    total_assigned_count: number;
+    total_unassigned_count: number;
+    total_routes_count: number;
+}

package/dist/interface/routeAutomationLog.d.ts

@@ -0,0 +1,9 @@
+import { RouteAutomationJob } from './routeAutomationJob';
+export type RouteAutomationLogKind = "started" | "completed" | "completed_without_statistics" | "active" | "failed" | "cancelled";
+export type RouteAutomationLog = {
+    id: string;
+    job: RouteAutomationJob;
+    kind: RouteAutomationLogKind;
+    created_at: Date;
+    userName: string;
+};

package/dist/interface/routeEvent.d.ts

@@ -0,0 +1,55 @@
+export type RouteEvent = {
+    id: string;
+    route_id: string;
+    route_date: string;
+    route_name: string | null;
+    route_number: string | null;
+    service_area: string;
+    user_email: string | null;
+    action: RouteEventAction;
+    method: RouteEventActionMethod;
+    reason: string | null;
+    notes: string | null;
+    changes: RouteEventChanges | null;
+    created_at: string;
+};
+export type RouteEventKind = "route_event_create" | "route_event_update" | "route_event_delete";
+export interface RouteEventWithKind extends RouteEvent {
+    kind: RouteEventKind;
+}
+export declare enum RouteEventAction {
+    CREATE = "create",
+    UPDATE = "update",
+    DELETE = "delete",
+    START = "start",
+    COMPLETE = "complete"
+}
+export declare enum RouteEventActionMethod {
+    MANUAL = "manual",
+    SYSTEM = "system"
+}
+type RouteEventKeyTypeMap = {
+    dispatch_time: string;
+    hub_id: string;
+    hub_name: string;
+    num_appts: number;
+    num_route_users: number;
+    published_at: string;
+    route_date: string;
+    route_name: string;
+    route_status: string;
+    sequence_changed: boolean;
+    vehicle_id: string;
+    vehicle_kind_id: string;
+    vehicle_kind_fuel_type: string;
+    vehicle_kind_name: string;
+};
+type RouteEventChangeValue<T> = {
+    from: T | null;
+    to: T | null;
+} | null;
+type RouteEventChangeKeys = keyof RouteEventKeyTypeMap;
+export type RouteEventChanges = {
+    [key in RouteEventChangeKeys]: RouteEventChangeValue<RouteEventKeyTypeMap[key]>;
+};
+export {};

package/dist/interface/serviceArea.d.ts

@@ -0,0 +1,17 @@
+import { FacilityCode, ServiceArea as ServiceAreaName } from '@secondcloset/types/src/_common';
+export type CountryCode = "CA" | "US";
+export type Address = {
+    country: CountryCode;
+    province: string;
+};
+export type ServiceAreaData = {
+    id: number;
+    name: ServiceAreaName;
+    timezone: string;
+    timezone_iana: string;
+    humanized_name: string;
+    address: Address;
+    facilities: FacilityCode[];
+    created_at: string;
+    updated_at: string;
+};

package/dist/interface/util.d.ts

@@ -0,0 +1,3 @@
+export type ConvertDateToString<T extends Record<string, unknown>, K extends keyof T> = {
+    [Key in keyof T]: Key extends K ? string : T[Key];
+};