@commercelayer/app-elements 0.0.40 → 0.0.41

package/dist/utils/tracking.d.ts

@@ -0,0 +1,153 @@
+import { type Parcel, type Shipment } from '@commercelayer/sdk';
+import { z } from 'zod';
+export declare function getParcelTrackingDetail(parcel?: Parcel): TrackingDetail | undefined;
+export declare function getShipmentRates(shipment: Shipment): Rate[];
+export declare function getShipmentRate(shipment: Shipment): Rate | undefined;
+/**
+ * Check whether the `shipment` has just one tracking number.
+ * @param shipment Shipment
+ */
+export declare function hasSingleTracking(shipment: Shipment): boolean;
+/**
+ * Check whether the `shipment` has tracking information or not.
+ * @param shipment Shipment
+ */
+export declare function hasTracking(shipment: Shipment): boolean;
+/**
+ * @docs https://www.easypost.com/docs/api#tracking-detail-object
+ */
+declare const trackingDetailSchema: z.ZodObject<{
+    /** "TrackingDetail" */
+    object: z.ZodLiteral<"TrackingDetail">;
+    /** Description of the scan event */
+    message: z.ZodNullable<z.ZodString>;
+    /** Status of the package at the time of the scan event, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error" */
+    status: z.ZodNullable<z.ZodString>;
+    /** Additional details about the current status, possible values are "unknown", "status_update", "departed_facility", "arrived_at_facility", "out_for_delivery", "arrived_at_destination" */
+    status_detail: z.ZodNullable<z.ZodString>;
+    /** The timestamp when the tracking scan occurred */
+    datetime: z.ZodNullable<z.ZodString>;
+    /** The original source of the information for this scan event, usually the carrier */
+    source: z.ZodNullable<z.ZodString>;
+    /** The location associated with the scan event */
+    tracking_location: z.ZodObject<{
+        /** "TrackingLocation" */
+        object: z.ZodLiteral<"TrackingLocation">;
+        /** The city where the scan event occurred (if available) */
+        city: z.ZodNullable<z.ZodString>;
+        /** The state where the scan event occurred (if available) */
+        state: z.ZodNullable<z.ZodString>;
+        /** The country where the scan event occurred (if available) */
+        country: z.ZodNullable<z.ZodString>;
+        /** The postal code where the scan event occurred (if available) */
+        zip: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        object: "TrackingLocation";
+        city: string | null;
+        state: string | null;
+        country: string | null;
+        zip: string | null;
+    }, {
+        object: "TrackingLocation";
+        city: string | null;
+        state: string | null;
+        country: string | null;
+        zip: string | null;
+    }>;
+    description: z.ZodNullable<z.ZodString>;
+    carrier_code: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    object: "TrackingDetail";
+    source: string | null;
+    description: string | null;
+    status: string | null;
+    message: string | null;
+    status_detail: string | null;
+    datetime: string | null;
+    tracking_location: {
+        object: "TrackingLocation";
+        city: string | null;
+        state: string | null;
+        country: string | null;
+        zip: string | null;
+    };
+    carrier_code: string | null;
+}, {
+    object: "TrackingDetail";
+    source: string | null;
+    description: string | null;
+    status: string | null;
+    message: string | null;
+    status_detail: string | null;
+    datetime: string | null;
+    tracking_location: {
+        object: "TrackingLocation";
+        city: string | null;
+        state: string | null;
+        country: string | null;
+        zip: string | null;
+    };
+    carrier_code: string | null;
+}>;
+/**
+ * @docs https://www.easypost.com/docs/api#rates
+ */
+declare const rateSchema: z.ZodObject<{
+    /** unique, begins with 'rate_' */
+    id: z.ZodString;
+    /** "test" or "production" */
+    mode: z.ZodUnion<[z.ZodLiteral<"test">, z.ZodLiteral<"production">]>;
+    /** service level/name @docs https://www.easypost.com/docs/api#service-levels */
+    service: z.ZodString;
+    /** name of carrier */
+    carrier: z.ZodString;
+    /** ID of the CarrierAccount record used to generate this rate */
+    carrier_account_id: z.ZodString;
+    /** ID of the Shipment this rate belongs to */
+    shipment_id: z.ZodString;
+    /** the actual rate quote for this service */
+    rate: z.ZodNumber;
+    /** currency for the rate */
+    currency: z.ZodString;
+    /** delivery days for this service */
+    delivery_days: z.ZodNumber;
+    /** date for delivery */
+    delivery_date: z.ZodString;
+    /** *This field is deprecated and should be ignored. @deprecated */
+    est_delivery_days: z.ZodNumber;
+    /** formatted date for delivery */
+    formatted_delivery_date: z.ZodString;
+    /** the actual formatted rate quote for this service */
+    formatted_rate: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    mode: "test" | "production";
+    service: string;
+    carrier: string;
+    carrier_account_id: string;
+    shipment_id: string;
+    rate: number;
+    currency: string;
+    delivery_days: number;
+    delivery_date: string;
+    est_delivery_days: number;
+    formatted_delivery_date: string;
+    formatted_rate: string;
+}, {
+    id: string;
+    mode: "test" | "production";
+    service: string;
+    carrier: string;
+    carrier_account_id: string;
+    shipment_id: string;
+    rate: number;
+    currency: string;
+    delivery_days: number;
+    delivery_date: string;
+    est_delivery_days: number;
+    formatted_delivery_date: string;
+    formatted_rate: string;
+}>;
+export type TrackingDetail = z.infer<typeof trackingDetailSchema>;
+export type Rate = z.infer<typeof rateSchema>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercelayer/app-elements",
-  "version": "0.0.40",
+  "version": "0.0.41",
   "type": "module",
   "files": [
     "dist"
@@ -35,7 +35,8 @@
     "react-select": "^5.7.2",
     "swr": "^2.1.5",
     "ts-invariant": "^0.10.3",
-    "type-fest": "^3.7.2"
+    "type-fest": "^3.7.2",
+    "zod": "^3.21.4"
   },
   "devDependencies": {
     "@commercelayer/eslint-config-ts-react": "^1.0.0",