@shipengine/connect-carrier-api 4.0.0-beta → 4.0.0-beta.3

package/lib/app/carrier-app-definition.d.ts

@@ -2,6 +2,7 @@ import { ImportedTrackingEvent } from '../models';
 import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, GetManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest, GetRelayPointsRequest, GetServicePointsRequest, GetServicePointRequest, ImportTrackingEventsRequest } from '../requests';
 import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse, GetRelayPointsResponse, GetServicePointsResponse, GetServicePointResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
+import { RequestResponseInfo } from '@shipengine/connect-runtime';
 /**
  * @description This defines a connect carrier app
  */
@@ -92,4 +93,10 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to import tracking events
      */
     ImportTrackingEvents?: (request: ImportTrackingEventsRequest) => AsyncGenerator<ImportedTrackingEvent>;
+    /** @description A method that gets additional context to log from the request when logging */
+    getAdditionalContext?: (req: Request) => Record<string, string>;
+    /** @description A method that redacts external HTTP requests and responses to prevent logging sensitive information */
+    redactExternalRequest?: (req: RequestResponseInfo) => Promise<RequestResponseInfo> | RequestResponseInfo;
+    /** @description A method that gets additional information to return with the diagnostic version route */
+    getAdditionalVersionInfo?: () => Promise<Record<string, string>> | Record<string, string>;
 }

package/lib/models/index.d.ts

@@ -18,6 +18,7 @@ export * from './inbound-content-types';
 export * from './insurance-providers';
 export * from './labels';
 export * from './manifests';
+export * from './native-rating';
 export * from './package';
 export * from './pickup';
 export * from './rates';

package/lib/models/index.js

@@ -21,6 +21,7 @@ tslib_1.__exportStar(require("./inbound-content-types"), exports);
 tslib_1.__exportStar(require("./insurance-providers"), exports);
 tslib_1.__exportStar(require("./labels"), exports);
 tslib_1.__exportStar(require("./manifests"), exports);
+tslib_1.__exportStar(require("./native-rating"), exports);
 tslib_1.__exportStar(require("./package"), exports);
 tslib_1.__exportStar(require("./pickup"), exports);
 tslib_1.__exportStar(require("./rates"), exports);

package/lib/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B;AAC5B,6DAAmC;AACnC,0DAAgC;AAChC,oDAA0B;AAC1B,+DAAqC;AACrC,4DAAkC;AAClC,qDAA2B;AAC3B,oDAA0B;AAC1B,kEAAwC;AACxC,2DAAiC;AACjC,sDAA4B;AAC5B,mDAAyB;AACzB,8DAAoC;AACpC,8DAAoC;AACpC,uDAA6B;AAC7B,yEAA+C;AAC/C,kEAAwC;AACxC,gEAAsC;AACtC,mDAAyB;AACzB,sDAA4B;AAC5B,0DAAgC;AAChC,oDAA0B;AAC1B,mDAAyB;AACzB,kDAAwB;AACxB,yDAA+B;AAC/B,yDAA+B;AAC/B,qEAA2C;AAC3C,8DAAoC;AACpC,kDAAwB;AACxB,+DAAqC;AACrC,wDAA8B;AAC9B,qDAA2B;AAC3B,kDAAwB"}

package/lib/models/native-rating/context-results.d.ts

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

package/lib/models/native-rating/context-results.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context-results.js.map

package/lib/models/native-rating/context-results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-results.js","sourceRoot":"","sources":["../../../src/models/native-rating/context-results.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-rates.d.ts

@@ -0,0 +1,7 @@
+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/lib/models/native-rating/get-rates.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-rates.js.map

package/lib/models/native-rating/get-rates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-rates.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-rates.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-variables.d.ts

@@ -0,0 +1,6 @@
+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/lib/models/native-rating/get-variables.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-variables.js.map

package/lib/models/native-rating/get-variables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-variables.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-variables.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/get-zone.d.ts

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

package/lib/models/native-rating/get-zone.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=get-zone.js.map

package/lib/models/native-rating/get-zone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-zone.js","sourceRoot":"","sources":["../../../src/models/native-rating/get-zone.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/implementation-type.d.ts

@@ -0,0 +1,30 @@
+import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
+import type { 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 declare class CarrierValidationError extends Error {
+}

package/lib/models/native-rating/implementation-type.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CarrierValidationError = void 0;
+/** Signify a validation error from the carrier */
+class CarrierValidationError extends Error {
+}
+exports.CarrierValidationError = CarrierValidationError;
+//# sourceMappingURL=implementation-type.js.map

package/lib/models/native-rating/implementation-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"implementation-type.js","sourceRoot":"","sources":["../../../src/models/native-rating/implementation-type.ts"],"names":[],"mappings":";;;AA+BA,kDAAkD;AAClD,MAAa,sBAAuB,SAAQ,KAAK;CAAG;AAApD,wDAAoD"}

package/lib/models/native-rating/index.d.ts

@@ -0,0 +1,7 @@
+export * from './context-results';
+export * from './get-rates';
+export * from './get-variables';
+export * from './get-zone';
+export * from './implementation-type';
+export * from './numeric-currency';
+export * from './rating-context';

package/lib/models/native-rating/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./context-results"), exports);
+tslib_1.__exportStar(require("./get-rates"), exports);
+tslib_1.__exportStar(require("./get-variables"), exports);
+tslib_1.__exportStar(require("./get-zone"), exports);
+tslib_1.__exportStar(require("./implementation-type"), exports);
+tslib_1.__exportStar(require("./numeric-currency"), exports);
+tslib_1.__exportStar(require("./rating-context"), exports);
+//# sourceMappingURL=index.js.map

package/lib/models/native-rating/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/native-rating/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC;AAClC,sDAA4B;AAC5B,0DAAgC;AAChC,qDAA2B;AAC3B,gEAAsC;AACtC,6DAAmC;AACnC,2DAAiC"}

package/lib/models/native-rating/numeric-currency.d.ts

@@ -0,0 +1,5 @@
+/** 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/lib/models/native-rating/numeric-currency.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=numeric-currency.js.map

package/lib/models/native-rating/numeric-currency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-currency.js","sourceRoot":"","sources":["../../../src/models/native-rating/numeric-currency.ts"],"names":[],"mappings":""}

package/lib/models/native-rating/rating-context.d.ts

@@ -0,0 +1,15 @@
+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/lib/models/native-rating/rating-context.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rating-context.js.map

package/lib/models/native-rating/rating-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rating-context.js","sourceRoot":"","sources":["../../../src/models/native-rating/rating-context.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.0.0-beta",
+  "version": "4.0.0-beta.3",
   "description": "This is the typescript/javascript definitions for carrier api",
-  "homepage": "https://github.com/ShipEngine/connect",
+  "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {
@@ -17,7 +17,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "github.com/shipengine/connect"
+    "url": "github.com/shipstation/ipaas-connect"
   },
   "keywords": [
     "ipaas",
@@ -44,7 +44,7 @@
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.0.0-beta",
+    "@shipengine/connect-runtime": "^4.0.0-beta.2",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

package/src/app/carrier-app-definition.ts

@@ -39,6 +39,8 @@ import {
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 
+import { RequestResponseInfo } from '@shipengine/connect-runtime';
+
 /**
  * @description This defines a connect carrier app
  */
@@ -153,4 +155,12 @@ export interface CarrierAppDefinition {
   ImportTrackingEvents?: (
     request: ImportTrackingEventsRequest,
   ) => AsyncGenerator<ImportedTrackingEvent>;
+  /** @description A method that gets additional context to log from the request when logging */
+  getAdditionalContext?: (req: Request) => Record<string, string>;
+  /** @description A method that redacts external HTTP requests and responses to prevent logging sensitive information */
+  redactExternalRequest?: (
+    req: RequestResponseInfo,
+  ) => Promise<RequestResponseInfo> | RequestResponseInfo;
+  /** @description A method that gets additional information to return with the diagnostic version route */
+  getAdditionalVersionInfo?: () => Promise<Record<string, string>> | Record<string, string>;
 }

package/src/models/index.ts

@@ -18,6 +18,7 @@ export * from './inbound-content-types';
 export * from './insurance-providers';
 export * from './labels';
 export * from './manifests';
+export * from './native-rating';
 export * from './package';
 export * from './pickup';
 export * from './rates';

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

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

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

@@ -0,0 +1,9 @@
+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/models/native-rating/get-variables.ts

@@ -0,0 +1,8 @@
+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/models/native-rating/get-zone.ts

@@ -0,0 +1,9 @@
+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/models/native-rating/implementation-type.ts

@@ -0,0 +1,33 @@
+import type { GetRatesRequest, Rate } from '@shipengine/connect-carrier-api';
+import type { 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/models/native-rating/index.ts

@@ -0,0 +1,7 @@
+export * from './context-results';
+export * from './get-rates';
+export * from './get-variables';
+export * from './get-zone';
+export * from './implementation-type';
+export * from './numeric-currency';
+export * from './rating-context';

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

@@ -0,0 +1,5 @@
+/** 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/models/native-rating/rating-context.ts

@@ -0,0 +1,19 @@
+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;
+}