@shipengine/connect-carrier-api 2.12.18 → 4.0.0-beta

package/src/app/internal/index.ts

@@ -1,3 +0,0 @@
-export * from './connect-runtime-app';
-export * from './route';
-export * from './branded-image';

package/src/app/internal/metadata.ts

@@ -1,86 +0,0 @@
-import { CarrierAppDefinition } from '../carrier-app-definition';
-import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { FunctionSpecification } from '../metadata/function';
-
-import { CarrierAppSpecification } from './carrier-app-specification';
-import { CarrierSpecification } from './carrier-specification';
-import { AuthSpecification } from '../metadata/auth-specification';
-
-const fn = (name: string): FunctionSpecification => ({
-  Name: name,
-  IsSandboxed: false,
-});
-
-const mapFunctions = (app: CarrierAppDefinition): FunctionSpecification[] => {
-  const fns: FunctionSpecification[] = [];
-
-  if (app.Register) {
-    fns.push(fn('Register'));
-  }
-
-  if (app.CreateLabel) {
-    fns.push(fn('CreateLabel'));
-  }
-
-  if (app.VoidLabels) {
-    fns.push(fn('VoidLabels'));
-  }
-
-  if (app.CreateManifest) {
-    fns.push(fn('CreateManifest'));
-  }
-
-  if (app.GetManifest) {
-    fns.push(fn('GetManifest'));
-  }
-
-  if (app.SchedulePickup) {
-    fns.push(fn('SchedulePickup'));
-  }
-
-  if (app.CancelPickup) {
-    fns.push(fn('CancelPickup'));
-  }
-
-  if (app.GetRates) {
-    fns.push(fn('GetRates'));
-  }
-
-  if (app.Track) {
-    fns.push(fn('Track'));
-  }
-
-  if (app.ImportTrackingEvents) {
-    fns.push(fn('ImportTrackingEvents'));
-  }
-
-  return fns;
-};
-
-export class Metadata implements CarrierAppSpecification {
-  Id: string;
-  Name: string;
-  Connector: ShippingProviderConnector;
-  AuthProcess?: AuthSpecification;
-  Carriers: CarrierSpecification[];
-
-  constructor(app: CarrierAppDefinition) {
-    this.Id = app.Metadata.Id;
-    this.Name = app.Metadata.Name;
-    this.AuthProcess = app.Metadata.AuthProcess;
-    if (this.AuthProcess) {
-      this.AuthProcess.Identifier.Version = '2.0';
-    }
-    this.Carriers = app.Metadata.Carriers.map((c) => new CarrierSpecification(c));
-
-    this.Connector = {
-      DiagnosticRoutes: {
-        Liveness: '/diagnostics/liveness',
-        Readiness: '/diagnostics/readiness',
-        Version: '/diagnostics/version',
-      },
-      ApiVersion: '2.0.0',
-      Functions: mapFunctions(app),
-    };
-  }
-}

package/src/app/internal/native-rating-specification.ts

@@ -1,5 +0,0 @@
-/** Specification for a Native Rating implementation */
-export interface NativeRatingSpecification {
-  /** External id of the default rate card */
-  DefaultRateCard: string;
-}

package/src/app/internal/route.ts

@@ -1,31 +0,0 @@
-import { Request } from 'express';
-
-export enum Method {
-  POST = 'post',
-  GET = 'get',
-  PUT = 'put',
-  PATCH = 'patch',
-  DELETE = 'delete',
-}
-
-/** @description The definition for a route that will serve up the contents of a file */
-export interface FileRoute {
-  /** @description The file that should be sent to the client. If this is set, handler will not be used. */
-  file: string | ((req: Request) => string | Promise<string>);
-}
-
-/** @description The definition for a route and how it will be handled */
-export interface HandlerRoute {
-  /** @description The method that will be called to handle this request */
-  handler?: (req: any) => any | Promise<any> | AsyncGenerator<any>;
-  /** @description The optional method used to validate the response for this route. Used for warning purposes. */
-  validateResponse?: (response: any) => string[] | undefined;
-}
-
-/** @description The definition for all types of routes */
-export type Route = {
-  /** @description The path to the endpoint you wish to expose @example "/CreateLabel", "/sales_orders_export" */
-  path: string;
-  /** @description The http verb used for this endpoint @example "GET", "POST" */
-  method: Method;
-} & (FileRoute | HandlerRoute);

package/src/app/native-rating/base-rate-context.ts

@@ -1,101 +0,0 @@
-import { resolve } from 'path';
-import { readFileSync } from 'fs';
-import winston, { format, transports } from 'winston';
-import { NumericCurrency } from './numeric-currency';
-import { RatingContext } from './rating-context';
-import { RateCard } from '../metadata/rate-card';
-
-interface DataLookup {
-  rates: (keys: string[]) => Promise<{ [key: string]: NumericCurrency }>;
-  variables: (keys: string[]) => Promise<{ [key: string]: any }>;
-}
-
-type ZoneLookup = (keys: string[]) => Promise<{ [key: string]: any }>;
-
-/** Predicate that returns true if the value is defined, false if not */
-const valueIsUndefined = <T>([key, value]: [string, T | undefined]): boolean => {
-  const isIncluded = value !== undefined;
-
-  console.log(`${isIncluded ? '✔️' : '❌'} ${key}`);
-
-  return isIncluded;
-};
-
-/** Build a lookup function to find values for a list of keys */
-const buildLookup =
-  <TIn, TOut>(name: string, items: { key: string; value: TIn }[], mapper?: (item: TIn) => TOut) =>
-  (keys: string[]): Promise<{ [dataKey: string]: TOut }> => {
-    console.log(`Getting ${name} keys (${keys.length} total):`);
-    console.group();
-    try {
-      const things = keys.map((key) => {
-        const foundValue = items.find((item) => key === item.key)?.value;
-        const mappedValue = foundValue && mapper ? mapper(foundValue) : foundValue;
-        return [key, mappedValue] as [string, TOut | undefined];
-      });
-
-      const values = Object.fromEntries(things.filter(valueIsUndefined)) as {
-        [key: string]: TOut;
-      };
-      return Promise.resolve(values);
-    } finally {
-      console.groupEnd();
-    }
-  };
-
-const loadData = (basePath: string) => (dataType: string) => {
-  try {
-    const data = readFileSync(resolve(basePath, `${dataType}.json`));
-    const json = JSON.parse(data.toString());
-    return [dataType, json?.[dataType] || []];
-  } catch (err) {
-    return [dataType, []];
-  }
-};
-
-export const createContextBuilder = (basePath: string) => {
-  let zoneLookup: ZoneLookup;
-  const getZoneLookup = () => {
-    if (!zoneLookup) {
-      const zones = loadData(basePath)('zones')[1];
-      zoneLookup = buildLookup('zone', zones);
-    }
-    return zoneLookup;
-  };
-
-  const log = winston.createLogger({
-    transports: [
-      new transports.Console({
-        level: 'debug',
-        format: format.combine(format.colorize(), format.timestamp(), format.metadata()),
-      }),
-    ],
-  });
-
-  return (rateCard: RateCard): RatingContext => {
-    let dataLookup: DataLookup;
-    const getDataLookup = () => {
-      if (!dataLookup) {
-        const loadedData = Object.fromEntries(
-          ['rates', 'variables'].map(loadData(resolve(basePath, rateCard.Id))),
-        );
-
-        dataLookup = {
-          rates: buildLookup('rate', loadedData.rates, (x: any) => ({
-            amount: +x,
-            currency: rateCard.Currency,
-          })),
-          variables: buildLookup('variables', loadedData.variables),
-        };
-      }
-      return dataLookup;
-    };
-
-    return {
-      getRates: (keys: string[]) => getDataLookup().rates(keys),
-      getVariables: (keys: string[]) => getDataLookup().variables(keys),
-      getZone: (keys: string[]) => getZoneLookup()(keys),
-      log,
-    };
-  };
-};

package/src/app/native-rating/context-results.ts

@@ -1,3 +0,0 @@
-export interface ContextResults<T> {
-  [dataKey: string]: T;
-}

package/src/app/native-rating/create-dynamic-carrier.ts

@@ -1,82 +0,0 @@
-import { VM, VMScript } from 'vm2';
-import { RateResultsAndId, RatingCarrier, ShipmentAndId } from './implementation-type';
-import { RatingContext } from './rating-context';
-
-/** Results of the carrier code validation **/
-interface CodeValidationResults {
-  errors?: string[];
-  /** Does the carrier code contain the get zones function */
-  hasGetZonesFunction: boolean;
-}
-
-/** Ensure that the carrier module has the correct shape
- * @param module Object into which code should be exported
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-const validateCode = (module?: any): CodeValidationResults => {
-  if (module?.exports?.default === undefined) {
-    return {
-      errors: ['Code must have a default export'],
-      hasGetZonesFunction: false,
-    };
-  }
-
-  const errors = [];
-  const { rateShipments, getZones } = module.exports.default;
-  const hasGetZonesFunction = getZones !== undefined;
-
-  if (typeof rateShipments !== 'function') {
-    errors.push("Code must contain a function named 'rateShipments'");
-  } else if (rateShipments.length !== 2) {
-    errors.push("'rateShipments' function must have two parameters");
-  }
-
-  return {
-    errors,
-    hasGetZonesFunction,
-  };
-};
-
-/** Create a dynamic carrier
- * @param code Code that should be used for the carrier
- * @returns Carrier with code ready to be executed
- */
-const createDynamicCarrier = (code: string): RatingCarrier => {
-  // This is to make sure that the code we need to run doesn't get excluded because of dangling comments, etc.
-  const resetCode = code + ';\n /* */ \n';
-
-  const validationResults = new VM({
-    sandbox: { module: {}, validateCode },
-  }).run(`${resetCode}; validateCode(module);`);
-  if (validationResults.errors?.length > 0) {
-    throw new Error(validationResults.errors.join('; '));
-  }
-
-  const rateShipmentsScript = new VMScript(
-    `${resetCode} module.exports.default.rateShipments(context, shipment);`,
-  );
-
-  const executionVM = new VM({
-    sandbox: {
-      module: {},
-      context: {},
-      shipment: {},
-      zoneContext: {},
-      origin: {},
-      destination: {},
-    },
-  });
-
-  const carrier: RatingCarrier = {
-    rateShipments: (
-      context: RatingContext,
-      shipment: ShipmentAndId[],
-    ): Promise<RateResultsAndId[]> => {
-      return executionVM.setGlobals({ context, shipment }).run(rateShipmentsScript);
-    },
-  };
-
-  return carrier;
-};
-
-export default createDynamicCarrier;

package/src/app/native-rating/get-rates.ts

@@ -1,9 +0,0 @@
-import { ContextResults } from './context-results';
-import { NumericCurrency } from './numeric-currency';
-
-export type GetRatesResults = ContextResults<NumericCurrency>;
-
-/** Function to get rates from the context */
-export interface GetRates {
-  (dataKeys: string[]): Promise<GetRatesResults>;
-}

package/src/app/native-rating/get-variables.ts

@@ -1,8 +0,0 @@
-import { ContextResults } from './context-results';
-
-export type GetVariableResults = ContextResults<any>;
-
-/** Function to get rating variables from the context */
-export interface GetVariables {
-  (dataKeys: string[]): Promise<GetVariableResults>;
-}

package/src/app/native-rating/get-zone.ts

@@ -1,9 +0,0 @@
-import { ContextResults } from './context-results';
-
-export type GetZoneResults = ContextResults<any>;
-
-/** Function to get zone data from the context */
-export interface GetZone {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (dataKeys: string[]): Promise<GetZoneResults>;
-}

package/src/app/native-rating/implementation-type.ts

@@ -1,34 +0,0 @@
-import { Rate } from '../../models/rates';
-import { GetRatesRequest } from '../../requests/get-rates-request';
-import { RatingContext } from './rating-context';
-
-/** A rate request shipment with its corresponding id */
-export interface ShipmentAndId {
-  /** rate_request_identifier for the rate request */
-  id: string;
-  /** Shipment for the rate request */
-  shipment: GetRatesRequest;
-}
-
-/** Rate results with its corresponding rate request id */
-export interface RateResultsAndId {
-  /** rate_request_identifier for the corresponding rate request */
-  id: string;
-  /** Error, if any */
-  error?: unknown;
-  /** Rates for a given rate request */
-  rates: Rate[];
-}
-
-/** Implementation of a carrier */
-export interface RatingCarrier {
-  /** Rate shipments
-   * @param context Native Rating context that can be used by the implementation to interact with the underlying service
-   * @param shipment Shipments that should be rated
-   * @returns List of rates for the given shipments
-   */
-  rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
-}
-
-/** Signify a validation error from the carrier */
-export class CarrierValidationError extends Error {}

package/src/app/native-rating/index.ts

@@ -1,3 +0,0 @@
-export * from './implementation-type';
-export * from './numeric-currency';
-export * from './rating-context';

package/src/app/native-rating/numeric-currency.ts

@@ -1,5 +0,0 @@
-/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
-export interface NumericCurrency {
-  currency: string;
-  amount: number | undefined;
-}

package/src/app/native-rating/rating-context.ts

@@ -1,19 +0,0 @@
-import { Logger } from 'winston';
-import { GetVariables } from './get-variables';
-import { GetRates } from './get-rates';
-import { GetZone } from './get-zone';
-
-/** Rates request context */
-export interface RatingContext {
-  /** Function to get rates for given keys */
-  getRates: GetRates;
-
-  /** Function to get variables for given keys */
-  getVariables: GetVariables;
-
-  /** Function to get zone for given keys */
-  getZone: GetZone;
-
-  /** Logger that implementers can use */
-  log: Logger;
-}

package/src/models/bill-to.ts

@@ -1,15 +0,0 @@
-import { AddressBase } from './addresses';
-import { BillToParty } from './billing';
-
-/**
- * @description Bill to is a generic object used for billing a part of the shipment, duties, taxes, or otherwise to a party
-        other than the shipper (the shipper is considered the default party responsible). Ref: BillTo extends AddressBase.
-        since address fields are often required when associating billing to
-        another account.  Additionally, this allows for a contact to be specified, if necessary.
- */
-export class BillTo extends AddressBase {
-  /** @description The bill_to_party mentions the type of billing option*/
-  bill_to_party?: BillToParty;
-  /** @description Specified if there is an account number associated with the Bill To Party, and the Bill To Party is not the account holder. */
-  account_number?: string;
-}

package/src/models/billing/billing-to-party.ts

@@ -1,10 +0,0 @@
-/** @description The type of party responsible for a given category of charges associated with a shipment, such as
- * shipping charges or import duties. */
-export enum BillToParty {
-  /** @description The shipper is generally regarded as the party responsible for the billing. */
-  Shipper = 'shipper',
-  /** @description The recipient may be responsible for the billing of some entities, that could include the shipping cost. */
-  Recipient = 'recipient',
-  /** @description A shipper may want to bill to a third-party; especially common for 3PLs and larger volume. merchants */
-  ThirdPartyAccount = 'third_party_account',
-}

package/src/models/cod-payment-type.ts

@@ -1,9 +0,0 @@
-/** @description Specifies which payment method is permitted when Collect on Delivery (COD) is requested on a shipment */
-export enum CodPaymentType {
-  /** @description Any payment method is permitted */
-  Any = 'any',
-  /** @description Only cash is permitted */
-  Cash = 'cash',
-  /** @description Only guaranteed funds are permitted, such as a money order or cashier's check */
-  GuaranteedFunds = 'guaranteed_funds',
-}

package/src/models/collect-on-delivery.ts

@@ -1,10 +0,0 @@
-import { CodPaymentType } from './cod-payment-type';
-import { Currency } from './currency';
-
-/** @description This model represents the option to defer payment for a shipment, otherwise known as Collect on Delivery (COD) */
-export class CollectOnDelivery {
-  /** @description The payment amount for Collect on Delivery (COD) */
-  payment_amount!: Currency;
-  /** @description The payment method permitted for Collect on Delivery (COD) */
-  payment_type?: CodPaymentType;
-}