@shipengine/connect-carrier-api 4.16.6 → 4.16.8-beta.1

package/src/app/native-rating-data-validator.ts

@@ -1,61 +1,61 @@
-import { resolve } from 'path';
-import { existsSync, readFileSync } from 'fs';
-import { Carrier } from './metadata/carrier';
-
-interface DataValidationError {
-  message?: string;
-  duplicateKeys?: string[];
-}
-
-const getDuplicateKeys = (dataArray: { key: string }[]): string[] | undefined => {
-  let keys: string[] = [];
-  let keyContainer = Object.create(null);
-  dataArray.forEach((arrayItem) => {
-    if (arrayItem['key']) {
-      if (keyContainer[arrayItem['key']]) {
-        keys.push(arrayItem['key']);
-      } else {
-        keyContainer[arrayItem['key']] = true;
-      }
-    }
-  });
-
-  return keys.length > 0 ? keys : undefined;
-};
-
-const validate = (dataFilePath: string, dataType: string): DataValidationError | undefined => {
-  if (existsSync(dataFilePath)) {
-    const dataBuffer = readFileSync(dataFilePath);
-    const json = JSON.parse(dataBuffer.toString());
-    const data = json?.[dataType] || [];
-
-    const duplicates = getDuplicateKeys(data);
-    if (duplicates) {
-      return {
-        message: `${dataType} in ${dataFilePath} contains duplicate keys.`,
-        duplicateKeys: duplicates,
-      };
-    }
-  }
-};
-
-export const isDataValidationError = (
-  errors: DataValidationError[] | undefined,
-): errors is DataValidationError[] => errors !== undefined;
-
-export const validateRatingData = (carrier: Carrier): DataValidationError[] | undefined => {
-  let errors: DataValidationError[] = [];
-  let basePath = carrier.NativeRating?.Path ?? '';
-
-  let error = validate(resolve(basePath, 'zones.json'), 'zones');
-  if (error) errors.push(error);
-
-  carrier.NativeRating?.RateCards?.forEach((rateCard) => {
-    error = validate(resolve(basePath, rateCard.Id, 'rates.json'), 'rates');
-    if (error) errors.push(error);
-    error = validate(resolve(basePath, rateCard.Id, 'variables.json'), 'variables');
-    if (error) errors.push(error);
-  });
-
-  return errors.length > 0 ? errors : undefined;
-};
+import { resolve } from 'path';
+import { existsSync, readFileSync } from 'fs';
+import { Carrier } from './metadata/carrier';
+
+interface DataValidationError {
+  message?: string;
+  duplicateKeys?: string[];
+}
+
+const getDuplicateKeys = (dataArray: { key: string }[]): string[] | undefined => {
+  let keys: string[] = [];
+  let keyContainer = Object.create(null);
+  dataArray.forEach((arrayItem) => {
+    if (arrayItem['key']) {
+      if (keyContainer[arrayItem['key']]) {
+        keys.push(arrayItem['key']);
+      } else {
+        keyContainer[arrayItem['key']] = true;
+      }
+    }
+  });
+
+  return keys.length > 0 ? keys : undefined;
+};
+
+const validate = (dataFilePath: string, dataType: string): DataValidationError | undefined => {
+  if (existsSync(dataFilePath)) {
+    const dataBuffer = readFileSync(dataFilePath);
+    const json = JSON.parse(dataBuffer.toString());
+    const data = json?.[dataType] || [];
+
+    const duplicates = getDuplicateKeys(data);
+    if (duplicates) {
+      return {
+        message: `${dataType} in ${dataFilePath} contains duplicate keys.`,
+        duplicateKeys: duplicates,
+      };
+    }
+  }
+};
+
+export const isDataValidationError = (
+  errors: DataValidationError[] | undefined,
+): errors is DataValidationError[] => errors !== undefined;
+
+export const validateRatingData = (carrier: Carrier): DataValidationError[] | undefined => {
+  let errors: DataValidationError[] = [];
+  let basePath = carrier.NativeRating?.Path ?? '';
+
+  let error = validate(resolve(basePath, 'zones.json'), 'zones');
+  if (error) errors.push(error);
+
+  carrier.NativeRating?.RateCards?.forEach((rateCard) => {
+    error = validate(resolve(basePath, rateCard.Id, 'rates.json'), 'rates');
+    if (error) errors.push(error);
+    error = validate(resolve(basePath, rateCard.Id, 'variables.json'), 'variables');
+    if (error) errors.push(error);
+  });
+
+  return errors.length > 0 ? errors : undefined;
+};

package/src/carrier-app.ts

@@ -1,11 +1,11 @@
-import { obsoleteAppError } from '@shipengine/connect-runtime';
-
-/**
- * @deprecated Connect apps should no longer instantiate themselves.
- * See https://connect.shipengine.com/getting-started/v2-v4-upgrade/ for more information on upgrading.
- */
-export class CarrierApp {
-  constructor(_: unknown) {
-    obsoleteAppError();
-  }
-}
+import { obsoleteAppError } from '@shipengine/connect-runtime';
+
+/**
+ * @deprecated Connect apps should no longer instantiate themselves.
+ * See https://connect.shipengine.com/getting-started/v2-v4-upgrade/ for more information on upgrading.
+ */
+export class CarrierApp {
+  constructor(_: unknown) {
+    obsoleteAppError();
+  }
+}

package/src/constants.ts

@@ -1,2 +1,2 @@
-// Name of the file that will contain rating logic used by Native Rating
-export const rateLogicName = 'rate-shipments.js';
+// Name of the file that will contain rating logic used by Native Rating
+export const rateLogicName = 'rate-shipments.js';

package/src/customs.ts

@@ -1,51 +1,51 @@
-import {
-  DocumentDpi,
-  DocumentTemplate,
-  getDocuments,
-  GetDocumentsRequest,
-} from '@shipengine/connect-runtime';
-import { LabelPackage } from './models/labels/label-package';
-import { CreateLabelRequest } from './requests';
-import { CreateLabelResponse } from './responses';
-
-export const getCustoms = async (
-  carrierName: string,
-  request: CreateLabelRequest | GetDocumentsRequest,
-): Promise<CreateLabelResponse> => {
-  const requestWithCarrierName: GetDocumentsRequest = Object.assign(
-    { document_dpi: DocumentDpi.Dpi_203 },
-    request,
-    { carrier_name: carrierName, metadata: { carrier_code: 'customs' } },
-  );
-
-  return await getDocuments(requestWithCarrierName, <DocumentTemplate>{ api_code: 'customs' });
-};
-
-export const combineDocuments = (
-  labelsResponse: CreateLabelResponse,
-  customsResponse: CreateLabelResponse,
-): CreateLabelResponse => {
-  if (customsResponse?.documents) {
-    //concat documents
-    labelsResponse.documents = labelsResponse?.documents?.concat(customsResponse?.documents);
-    const mergeByTrackingNumber = (
-      labelPackages: LabelPackage[],
-      customsPackages: LabelPackage[],
-    ) =>
-      labelPackages.map((labels) => {
-        const customs = customsPackages.find(
-          (customs) => labels.tracking_number === customs.tracking_number,
-        );
-        if (customs?.documents) {
-          labels.documents = labels.documents?.concat(customs.documents);
-        }
-        return labels;
-      });
-    if (labelsResponse.packages && customsResponse.packages)
-      labelsResponse.packages = mergeByTrackingNumber(
-        labelsResponse.packages,
-        customsResponse.packages,
-      );
-  }
-  return labelsResponse;
-};
+import {
+  DocumentDpi,
+  DocumentTemplate,
+  getDocuments,
+  GetDocumentsRequest,
+} from '@shipengine/connect-runtime';
+import { LabelPackage } from './models/labels/label-package';
+import { CreateLabelRequest } from './requests';
+import { CreateLabelResponse } from './responses';
+
+export const getCustoms = async (
+  carrierName: string,
+  request: CreateLabelRequest | GetDocumentsRequest,
+): Promise<CreateLabelResponse> => {
+  const requestWithCarrierName: GetDocumentsRequest = Object.assign(
+    { document_dpi: DocumentDpi.Dpi_203 },
+    request,
+    { carrier_name: carrierName, metadata: { carrier_code: 'customs' } },
+  );
+
+  return await getDocuments(requestWithCarrierName, <DocumentTemplate>{ api_code: 'customs' });
+};
+
+export const combineDocuments = (
+  labelsResponse: CreateLabelResponse,
+  customsResponse: CreateLabelResponse,
+): CreateLabelResponse => {
+  if (customsResponse?.documents) {
+    //concat documents
+    labelsResponse.documents = labelsResponse?.documents?.concat(customsResponse?.documents);
+    const mergeByTrackingNumber = (
+      labelPackages: LabelPackage[],
+      customsPackages: LabelPackage[],
+    ) =>
+      labelPackages.map((labels) => {
+        const customs = customsPackages.find(
+          (customs) => labels.tracking_number === customs.tracking_number,
+        );
+        if (customs?.documents) {
+          labels.documents = labels.documents?.concat(customs.documents);
+        }
+        return labels;
+      });
+    if (labelsResponse.packages && customsResponse.packages)
+      labelsResponse.packages = mergeByTrackingNumber(
+        labelsResponse.packages,
+        customsResponse.packages,
+      );
+  }
+  return labelsResponse;
+};

package/src/index.ts

@@ -1,12 +1,12 @@
-export * as models from './models';
-export * as requests from './requests';
-export * as responses from './responses';
-
-export * from './app';
-export * from './constants';
-export * from './models';
-export * from './requests';
-export * from './responses';
-export * from './spec';
-export * from './carrier-app';
-export * from './customs';
+export * as models from './models';
+export * as requests from './requests';
+export * as responses from './responses';
+
+export * from './app';
+export * from './constants';
+export * from './models';
+export * from './requests';
+export * from './responses';
+export * from './spec';
+export * from './carrier-app';
+export * from './customs';

package/src/models/accessibility-types.ts

@@ -1,6 +1,6 @@
-export enum AccessibilityTypes {
-  /** @description Products being shipped accessible during delivery.*/
-  Accessible = 'accessible',
-  /** @description Products being shipped inaccessible during delivery.*/
-  Inaccessible = 'inaccessible',
-}
+export enum AccessibilityTypes {
+  /** @description Products being shipped accessible during delivery.*/
+  Accessible = 'accessible',
+  /** @description Products being shipped inaccessible during delivery.*/
+  Inaccessible = 'inaccessible',
+}

package/src/models/addresses/address-base-schema.ts

@@ -1,19 +1,19 @@
-import Joi from 'joi';
-
-export const AddressBaseSchema = Joi.object({
-  name: Joi.string().optional().empty(),
-  first_name: Joi.string().optional().empty(),
-  last_name: Joi.string().optional().empty(),
-  email: Joi.string().email().optional().empty(),
-  phone_number: Joi.string().optional().empty(),
-  company_name: Joi.string().optional().empty(),
-  address_lines: Joi.array().items(Joi.string()).optional(),
-  city_locality: Joi.string().optional().empty(),
-  state_province: Joi.string().optional().empty(),
-  postal_code: Joi.string().required(),
-  country_code: Joi.string().required(),
-  address_residential_indicator: Joi.string().optional().empty(),
-  is_eu: Joi.boolean().optional(),
-  address_metadata: Joi.object().optional().empty(),
-  instructions: Joi.string().optional().empty(),
-});
+import Joi from 'joi';
+
+export const AddressBaseSchema = Joi.object({
+  name: Joi.string().optional().empty(),
+  first_name: Joi.string().optional().empty(),
+  last_name: Joi.string().optional().empty(),
+  email: Joi.string().email().optional().empty(),
+  phone_number: Joi.string().optional().empty(),
+  company_name: Joi.string().optional().empty(),
+  address_lines: Joi.array().items(Joi.string()).optional(),
+  city_locality: Joi.string().optional().empty(),
+  state_province: Joi.string().optional().empty(),
+  postal_code: Joi.string().required(),
+  country_code: Joi.string().required(),
+  address_residential_indicator: Joi.string().optional().empty(),
+  is_eu: Joi.boolean().optional(),
+  address_metadata: Joi.object().optional().empty(),
+  instructions: Joi.string().optional().empty(),
+});

package/src/models/addresses/address-base.ts

@@ -1,34 +1,34 @@
-import { AddressResidentialIndicator } from './address-residential-indicator';
-
-export class AddressBase {
-  /** @description The full name of the contact contact associated with the address */
-  name?: string;
-  /** @description The first name of the contact associated with the address */
-  first_name?: string;
-  /** @description The last name of the contact associated with the address */
-  last_name?: string;
-  /** @description The email of the contact associated with the address */
-  email?: string;
-  /** @description The phone number of the contact associated with the address (No Newline Characters) */
-  phone_number?: string;
-  /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
-  company_name?: string;
-  /** @description The address lines of the address (No Newline Characters) max length 100 characters */
-  address_lines?: string[];
-  /** @description City or locality (No Newline Characters) */
-  city_locality?: string;
-  /** @description State or province (No Newline Characters) */
-  state_province?: string;
-  /** @description Zip or postal code (No Newline Characters) */
-  postal_code!: string;
-  /** @description ISO 3166-1 two-letter country code max length 2 characters  */
-  country_code!: string;
-  /** @description Whether the address is residential or commercial */
-  address_residential_indicator?: AddressResidentialIndicator;
-  /** @description Whether the country of the shipment address is a member of the EU */
-  is_eu?: boolean;
-  /** @description Additional metadata provided for specific requests */
-  address_metadata?: { [key: string]: string };
-  /** @description Instructions to help the carrier navigate to the address */
-  instructions?: string;
-}
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export class AddressBase {
+  /** @description The full name of the contact contact associated with the address */
+  name?: string;
+  /** @description The first name of the contact associated with the address */
+  first_name?: string;
+  /** @description The last name of the contact associated with the address */
+  last_name?: string;
+  /** @description The email of the contact associated with the address */
+  email?: string;
+  /** @description The phone number of the contact associated with the address (No Newline Characters) */
+  phone_number?: string;
+  /** @description The name of the company associated with this address (No Newline Characters) max length 100 characters */
+  company_name?: string;
+  /** @description The address lines of the address (No Newline Characters) max length 100 characters */
+  address_lines?: string[];
+  /** @description City or locality (No Newline Characters) */
+  city_locality?: string;
+  /** @description State or province (No Newline Characters) */
+  state_province?: string;
+  /** @description Zip or postal code (No Newline Characters) */
+  postal_code!: string;
+  /** @description ISO 3166-1 two-letter country code max length 2 characters  */
+  country_code!: string;
+  /** @description Whether the address is residential or commercial */
+  address_residential_indicator?: AddressResidentialIndicator;
+  /** @description Whether the country of the shipment address is a member of the EU */
+  is_eu?: boolean;
+  /** @description Additional metadata provided for specific requests */
+  address_metadata?: { [key: string]: string };
+  /** @description Instructions to help the carrier navigate to the address */
+  instructions?: string;
+}

package/src/models/addresses/address-residential-indicator-schema.ts

@@ -1,6 +1,6 @@
-import Joi from 'joi';
-import { AddressResidentialIndicator } from './address-residential-indicator';
-
-export const AddressResidentialIndicatorSchema = Joi.string().valid(
-  ...Object.values(AddressResidentialIndicator),
-);
+import Joi from 'joi';
+import { AddressResidentialIndicator } from './address-residential-indicator';
+
+export const AddressResidentialIndicatorSchema = Joi.string().valid(
+  ...Object.values(AddressResidentialIndicator),
+);

package/src/models/addresses/address-residential-indicator.ts

@@ -1,9 +1,9 @@
-/** @description Used for indicating whether an address is residential or commercial */
-export enum AddressResidentialIndicator {
-  /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
-  Unknown = 'unknown',
-  /** @description Indicates that the address is in a residential area */
-  Yes = 'yes',
-  /** @description Indicates that the address is not in a residential area */
-  No = 'no',
-}
+/** @description Used for indicating whether an address is residential or commercial */
+export enum AddressResidentialIndicator {
+  /** @description Indicates that it is unknown whether or not the address is in a residential or commercial area */
+  Unknown = 'unknown',
+  /** @description Indicates that the address is in a residential area */
+  Yes = 'yes',
+  /** @description Indicates that the address is not in a residential area */
+  No = 'no',
+}

package/src/models/addresses/geolocation-item.ts

@@ -1,13 +1,13 @@
-/** @description Geolocation additional information for an address. */
-export class GeolocationItem {
-  /** @description Specifies the supported geolocation types. */
-  type?: GeolocationType;
-  /** @description The geolocation value. */
-  value?: string;
-}
-
-/** @description Supported geolocation types. */
-export enum GeolocationType {
-  /** @description what3words field to help identify the location */
-  what3words = 'what3words',
-}
+/** @description Geolocation additional information for an address. */
+export class GeolocationItem {
+  /** @description Specifies the supported geolocation types. */
+  type?: GeolocationType;
+  /** @description The geolocation value. */
+  value?: string;
+}
+
+/** @description Supported geolocation types. */
+export enum GeolocationType {
+  /** @description what3words field to help identify the location */
+  what3words = 'what3words',
+}

package/src/models/addresses/index.ts

@@ -1,7 +1,7 @@
-export * from './address-base';
-export * from './address-residential-indicator';
-export * from './ship-from';
-export * from './ship-from-display';
-export * from './ship-to';
-export * from './pudo-location';
-export * from './pudo-location-schema';
+export * from './address-base';
+export * from './address-residential-indicator';
+export * from './ship-from';
+export * from './ship-from-display';
+export * from './ship-to';
+export * from './pudo-location';
+export * from './pudo-location-schema';

package/src/models/addresses/pickup-address.ts

@@ -0,0 +1,3 @@
+import { AddressBase } from './address-base';
+
+export class PickupAddress extends AddressBase {}

package/src/models/addresses/pudo-location-schema.ts

@@ -1,7 +1,7 @@
-import Joi from 'joi';
-import { AddressBaseSchema } from './address-base-schema';
-
-export const PudoLocationSchema = AddressBaseSchema.keys({
-  carrier_code: Joi.string().optional(),
-  location_id: Joi.string().optional(),
-});
+import Joi from 'joi';
+import { AddressBaseSchema } from './address-base-schema';
+
+export const PudoLocationSchema = AddressBaseSchema.keys({
+  carrier_code: Joi.string().optional(),
+  location_id: Joi.string().optional(),
+});

package/src/models/addresses/pudo-location.ts

@@ -1,9 +1,9 @@
-import { AddressBase } from './address-base';
-
-/** @description Pickup/Dropoff location used by carriers */
-export class PudoLocation extends AddressBase {
-  /** @description Standardized carrier code the location id belongs to */
-  carrier_code?: string;
-  /** @description Location id needed to look up the location */
-  location_id?: string;
-}
+import { AddressBase } from './address-base';
+
+/** @description Pickup/Dropoff location used by carriers */
+export class PudoLocation extends AddressBase {
+  /** @description Standardized carrier code the location id belongs to */
+  carrier_code?: string;
+  /** @description Location id needed to look up the location */
+  location_id?: string;
+}

package/src/models/addresses/service-point-address.ts

@@ -1,8 +1,8 @@
-import { LatLong } from '../tracking/lat-long';
-import { AddressBase } from './address-base';
-
-/** @description The basic address type related to service points */
-export class ServicePointAddress extends AddressBase {
-  /** @description Geographical location */
-  geo?: LatLong;
-}
+import { LatLong } from '../tracking/lat-long';
+import { AddressBase } from './address-base';
+
+/** @description The basic address type related to service points */
+export class ServicePointAddress extends AddressBase {
+  /** @description Geographical location */
+  geo?: LatLong;
+}

package/src/models/addresses/ship-from-display.ts

@@ -1,4 +1,4 @@
-import { AddressBase } from './address-base';
-
-/** @description The address that should be displayed on the label as the ship from location */
-export class ShipFromDisplay extends AddressBase {}
+import { AddressBase } from './address-base';
+
+/** @description The address that should be displayed on the label as the ship from location */
+export class ShipFromDisplay extends AddressBase {}

package/src/models/addresses/ship-from.ts

@@ -1,8 +1,8 @@
-import { AddressBase } from './address-base';
-import { TaxIdentifier } from '../taxes/tax-identifier';
-
-/** @description The address for where the shipment will be shipped from */
-export class ShipFrom extends AddressBase {
-  /** @description Tax IDs associated with the exporter */
-  tax_identifiers?: TaxIdentifier[];
-}
+import { AddressBase } from './address-base';
+import { TaxIdentifier } from '../taxes/tax-identifier';
+
+/** @description The address for where the shipment will be shipped from */
+export class ShipFrom extends AddressBase {
+  /** @description Tax IDs associated with the exporter */
+  tax_identifiers?: TaxIdentifier[];
+}

package/src/models/addresses/ship-to.ts

@@ -1,11 +1,11 @@
-import { AddressBase } from './address-base';
-import { TaxIdentifier } from '../taxes/tax-identifier';
-import { GeolocationItem } from './geolocation-item';
-
-/** @description The address that a shipment will be delivered to */
-export class ShipTo extends AddressBase {
-  /** @description Tax IDs associated with the consignee */
-  tax_identifiers?: TaxIdentifier[];
-  /** @description List of Geolocation objects to help identify the location. */
-  geolocation?: GeolocationItem[];
-}
+import { AddressBase } from './address-base';
+import { TaxIdentifier } from '../taxes/tax-identifier';
+import { GeolocationItem } from './geolocation-item';
+
+/** @description The address that a shipment will be delivered to */
+export class ShipTo extends AddressBase {
+  /** @description Tax IDs associated with the consignee */
+  tax_identifiers?: TaxIdentifier[];
+  /** @description List of Geolocation objects to help identify the location. */
+  geolocation?: GeolocationItem[];
+}

package/src/models/advanced-options-schema.ts

@@ -1,11 +1,11 @@
-import Joi from 'joi';
-import { CurrencySchema } from './currency-schema';
-
-export const AdvancedOptionsSchema = Joi.object({
-  contains_alcohol: Joi.boolean().optional(),
-  no_postage: Joi.boolean().optional(),
-  nonmachineable: Joi.boolean().optional(),
-  bill_duties_to_sender: Joi.boolean().optional(),
-  saturday_delivery: Joi.boolean().optional(),
-  tip: CurrencySchema.optional(),
-}).pattern(/.*/, Joi.any());
+import Joi from 'joi';
+import { CurrencySchema } from './currency-schema';
+
+export const AdvancedOptionsSchema = Joi.object({
+  contains_alcohol: Joi.boolean().optional(),
+  no_postage: Joi.boolean().optional(),
+  nonmachineable: Joi.boolean().optional(),
+  bill_duties_to_sender: Joi.boolean().optional(),
+  saturday_delivery: Joi.boolean().optional(),
+  tip: CurrencySchema.optional(),
+}).pattern(/.*/, Joi.any());