@shipengine/connect-carrier-api 4.1.8 → 4.3.0

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

@@ -3,7 +3,7 @@ import type { Request } from 'express';
 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';
+import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
 /**
  * @description This defines a connect carrier app
  */
@@ -101,4 +101,11 @@ export interface CarrierAppDefinition {
     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>;
+    /**
+     * @description A collection of additional routes that can be used to extend the functionality of the app.
+     * Extension methods are not automatically called by the ShipEngine platform, and require working with Auctane developers to implement.
+     * The request and response shapes of each method will be defined by Auctane, but will not be documented as part of Connect unless
+     * they are made public and the functionality is taken out of extensions and into a named method.
+     */
+    Extensions?: Record<string, Handler>;
 }

package/lib/app/create-endpoint-mapping.d.ts

@@ -1,4 +1,3 @@
-import { Method } from '@shipengine/connect-runtime';
-import { ApiEndpoints } from './constants';
+import { Method, Handler } from '@shipengine/connect-runtime';
 import { CarrierAppDefinition } from './carrier-app-definition';
-export declare const createEndpointMapping: (definition: CarrierAppDefinition) => [Method, ApiEndpoints, ((req: any) => any | Promise<any>) | undefined][];
+export declare const createEndpointMapping: (definition: CarrierAppDefinition) => [Method, string, Handler | undefined][];

package/lib/app/create-endpoint-mapping.js

@@ -23,6 +23,7 @@ const createEndpointMapping = (definition) => [
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetServicePoints, definition.GetServicePoints],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.GetServicePoint, definition.GetServicePoint],
     [connect_runtime_1.Method.POST, constants_1.ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
+    ...(0, connect_runtime_1.mapExtensions)(definition.Extensions),
 ];
 exports.createEndpointMapping = createEndpointMapping;
 //# sourceMappingURL=create-endpoint-mapping.js.map

package/lib/app/create-endpoint-mapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAAqD;AACrD,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EAC0C,EAAE,CAAC;IAC7E,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;CAClF,CAAC;AAtBW,QAAA,qBAAqB,yBAsBhC"}
+{"version":3,"file":"create-endpoint-mapping.js","sourceRoot":"","sources":["../../src/app/create-endpoint-mapping.ts"],"names":[],"mappings":";;;AAAA,iEAA6E;AAC7E,2CAA2C;AAGpC,MAAM,qBAAqB,GAAG,CACnC,UAAgC,EACS,EAAE,CAAC;IAC5C,iFAAiF;IACjF,yFAAyF;IACzF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC,YAAY,CAAC;IACjE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC;IAC/D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAC7E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,CAAC;IACnF,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,CAAC;IACzD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;IACnD,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,mBAAmB,EAAE,UAAU,CAAC,mBAAmB,CAAC;IAC/E,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAC7D,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,cAAc,EAAE,UAAU,CAAC,cAAc,CAAC;IACrE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,gBAAgB,EAAE,UAAU,CAAC,gBAAgB,CAAC;IACzE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,eAAe,EAAE,UAAU,CAAC,eAAe,CAAC;IACvE,CAAC,wBAAM,CAAC,IAAI,EAAE,wBAAY,CAAC,oBAAoB,EAAE,UAAU,CAAC,oBAAoB,CAAC;IACjF,GAAG,IAAA,+BAAa,EAAC,UAAU,CAAC,UAAU,CAAC;CACxC,CAAC;AAvBW,QAAA,qBAAqB,yBAuBhC"}

package/lib/app/metadata/carrier.d.ts

@@ -10,6 +10,7 @@ import { ConfirmationDictionary } from './confirmation-type';
 import Joi from 'joi';
 import { NativeRatingConfiguration } from './native-rating-configuration';
 import { Zone } from './zone';
+import { PackageRatingGroup } from './package-rating-group';
 /** @description Basic structure for each carrier */
 export interface Carrier {
     /** @description Defines UI Modals for connecting and updating settings */
@@ -55,5 +56,7 @@ export interface Carrier {
     DocumentTemplate?: string;
     /** @description List of possible zones used by the carrier. */
     Zones?: Zone[];
+    /** @description List of package rating groups for the carrier */
+    PackageRatingGroups?: PackageRatingGroup[];
 }
 export declare const CarrierSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/carrier.js

@@ -16,6 +16,7 @@ const native_rating_configuration_1 = require("./native-rating-configuration");
 const file_exists_1 = require("./custom-validators/file-exists");
 const zone_1 = require("./zone");
 const connect_runtime_1 = require("@shipengine/connect-runtime");
+const package_rating_group_1 = require("./package-rating-group");
 exports.CarrierSchema = joi_1.default.object({
     AccountModals: account_modals_1.AccountModalsSchema.required(),
     PackageTypes: joi_1.default.array().optional().items(package_type_1.PackageTypeSchema).unique('Id'),
@@ -58,5 +59,6 @@ exports.CarrierSchema = joi_1.default.object({
         .pattern(new RegExp('^.*.carrier$'))
         .message('Template file must have .carrier extension.'),
     Zones: joi_1.default.array().optional().items(zone_1.ZoneSchema).unique('ApiCode'),
+    PackageRatingGroups: joi_1.default.array().optional().items(package_rating_group_1.PackageRatingGroupSchema).unique('Id'),
 }).with('DocumentTemplate', 'ApiCode');
 //# sourceMappingURL=carrier.js.map

package/lib/app/metadata/carrier.js.map

@@ -1 +1 @@
-{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AAiDxE,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;SACrC,OAAO,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;SACnC,OAAO,CAAC,6CAA6C,CAAC;IACzD,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;CAClE,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}
+{"version":3,"file":"carrier.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier.ts"],"names":[],"mappings":";;;;AAAA,qDAAsE;AACtE,iDAAgE;AAChE,yDAA4E;AAC5E,uDAA6F;AAC7F,+DAAqF;AACrF,6DAAwF;AACxF,mDAA2E;AAC3E,+CAAqE;AACrE,2DAA2F;AAC3F,sDAAsB;AACtB,+EAGuC;AACvC,iEAA6D;AAC7D,iCAA0C;AAE1C,iEAAqF;AACrF,iEAAsF;AAmDzE,QAAA,aAAa,GAAG,aAAG,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,oCAAmB,CAAC,QAAQ,EAAE;IAC7C,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gCAAiB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1E,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,wCAAqB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,eAAe,EAAE,gDAA8B,CAAC,QAAQ,EAAE;IAC1D,yBAAyB,EAAE,aAAG,CAAC,KAAK,EAAE;SACnC,QAAQ,EAAE;SACV,KAAK,CAAC,8CAAwB,CAAC;SAC/B,MAAM,CAAC,aAAa,CAAC;IACxB,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAC9E,YAAY,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAAsB,CAAC,CAAC,MAAM,EAAE;IAC3E,wBAAwB,EAAE,gDAA4B,CAAC,QAAQ,EAAE;IACjE,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAA0B,CAAC,CAAC,MAAM,EAAE;IACpF,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE;SACtB,QAAQ,EAAE;SACV,OAAO,CACN,IAAI,MAAM,CACR,iGAAiG,CAClG,CACF;SACA,OAAO,CAAC,qBAAqB,CAAC;SAC9B,GAAG,CAAC,GAAG,CAAC;IACX,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAClD,WAAW,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,8BAAY,EAAE,0CAAwB,CAAC;IAChF,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,aAAG,CAAC,MAAM,CAAC;QACjB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;QAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;aACf,QAAQ,EAAE;aACV,MAAM,CAAC,wBAAU,EAAE,aAAa,CAAC;aACjC,OAAO,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;aACjC,OAAO,CAAC,iCAAiC,CAAC;KAC9C,CAAC,CAAC,QAAQ,EAAE;IACb,YAAY,EAAE,6DAA+B,CAAC,QAAQ,EAAE;IACxD,gBAAgB,EAAE,aAAG,CAAC,MAAM,EAAE;SAC3B,QAAQ,EAAE;SACV,MAAM,CAAC,wBAAU,EAAE,iBAAiB,CAAC;SACrC,OAAO,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;SACnC,OAAO,CAAC,6CAA6C,CAAC;IACzD,KAAK,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iBAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;IACjE,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,+CAAwB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;CACzF,CAAC,CAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC"}

package/lib/app/metadata/package-rating-group-dimensions.d.ts

@@ -0,0 +1,22 @@
+import Joi from 'joi';
+import { DimensionUnit } from '../../models';
+/** @description Dimensions specific to a package rate class */
+export interface PackageRatingGroupDimensions {
+    /** @description Unit of the dimensions */
+    Unit: DimensionUnit;
+    /** @description Length of the package */
+    Length?: number;
+    /** @description Width of the package */
+    Width?: number;
+    /** @description Height of the package */
+    Height?: number;
+    /** @description Girth of the package as defined by the carrier */
+    Girth?: number;
+    /** @description No two sides exceed this amount */
+    NoTwoSides?: number;
+    /** @description Length plus girth should not exceed this amount */
+    LengthPlusGirth?: number;
+    /** @description Volume of the package */
+    Volume?: number;
+}
+export declare const PackageRatingGroupDimensionsSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/package-rating-group-dimensions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageRatingGroupDimensionsSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const dimension_unit_schema_1 = require("../../models/units/dimension-unit-schema");
+exports.PackageRatingGroupDimensionsSchema = joi_1.default.object({
+    Unit: dimension_unit_schema_1.DimensionUnitSchema.required(),
+    Length: joi_1.default.number().min(0).optional(),
+    Width: joi_1.default.number().min(0).optional(),
+    Height: joi_1.default.number().min(0).optional(),
+    NoTwoSides: joi_1.default.number().min(0).optional(),
+    LengthPlusGirth: joi_1.default.number().min(0).optional(),
+    Girth: joi_1.default.number().min(0).optional(),
+    Volume: joi_1.default.number().min(0).optional(),
+});
+//# sourceMappingURL=package-rating-group-dimensions.js.map

package/lib/app/metadata/package-rating-group-dimensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-rating-group-dimensions.js","sourceRoot":"","sources":["../../../src/app/metadata/package-rating-group-dimensions.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,oFAA+E;AAsBlE,QAAA,kCAAkC,GAAG,aAAG,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,2CAAmB,CAAC,QAAQ,EAAE;IACpC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/C,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrC,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC"}

package/lib/app/metadata/package-rating-group-weight.d.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+import { WeightUnit } from '../../models';
+/** @description Weight of a package rating group */
+export interface PackageRatingGroupWeight {
+    /** @description Unit of the weight */
+    Unit: WeightUnit;
+    /** @description Actual weight value */
+    Value: number;
+}
+export declare const PackageRatingGroupWeightSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/package-rating-group-weight.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageRatingGroupWeightSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const weight_unit_schema_1 = require("../../models/units/weight-unit-schema");
+exports.PackageRatingGroupWeightSchema = joi_1.default.object({
+    Unit: weight_unit_schema_1.WeightUnitSchema.required(),
+    Value: joi_1.default.number().min(0),
+});
+//# sourceMappingURL=package-rating-group-weight.js.map

package/lib/app/metadata/package-rating-group-weight.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-rating-group-weight.js","sourceRoot":"","sources":["../../../src/app/metadata/package-rating-group-weight.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,8EAAyE;AAU5D,QAAA,8BAA8B,GAAG,aAAG,CAAC,MAAM,CAAC;IACvD,IAAI,EAAE,qCAAgB,CAAC,QAAQ,EAAE;IACjC,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC"}

package/lib/app/metadata/package-rating-group.d.ts

@@ -0,0 +1,19 @@
+import Joi from 'joi';
+import { PackageRatingGroupDimensions } from './package-rating-group-dimensions';
+import { PackageRatingGroupWeight } from './package-rating-group-weight';
+/** @description Details about how packages are related to rates */
+export interface PackageRatingGroup {
+    /** @description Id of the rating group */
+    Id: string;
+    /** @description Id of the package type to which this rating group corresponds */
+    PackageTypeId: string;
+    /** @description Name of the package rating group */
+    Name: string;
+    /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+    CarrierPackageTypeCode: string;
+    /** @description Maximum allowable dimensions of packages for the rating group */
+    DimensionLimits: PackageRatingGroupDimensions;
+    /** @description Maximum allowable weight of packages for the rating group */
+    MaxWeight: PackageRatingGroupWeight;
+}
+export declare const PackageRatingGroupSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/package-rating-group.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageRatingGroupSchema = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+const package_rating_group_dimensions_1 = require("./package-rating-group-dimensions");
+const package_rating_group_weight_1 = require("./package-rating-group-weight");
+exports.PackageRatingGroupSchema = joi_1.default.object({
+    Id: joi_1.default.string().uuid().required(),
+    PackageTypeId: joi_1.default.string().uuid().required(),
+    Name: joi_1.default.string().required().max(50),
+    CarrierPackageTypeCode: joi_1.default.string().required().max(50),
+    DimensionLimits: package_rating_group_dimensions_1.PackageRatingGroupDimensionsSchema.optional(),
+    MaxWeight: package_rating_group_weight_1.PackageRatingGroupWeightSchema.optional(),
+});
+//# sourceMappingURL=package-rating-group.js.map

package/lib/app/metadata/package-rating-group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-rating-group.js","sourceRoot":"","sources":["../../../src/app/metadata/package-rating-group.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uFAG2C;AAC3C,+EAGuC;AAkB1B,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAClC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,sBAAsB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACvD,eAAe,EAAE,oEAAkC,CAAC,QAAQ,EAAE;IAC9D,SAAS,EAAE,4DAA8B,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "4.1.8",
+  "version": "4.3.0",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://connect.shipengine.com",
   "main": "./lib/index.js",
@@ -45,7 +45,7 @@
     "tslib": "^2.5.0"
   },
   "peerDependencies": {
-    "@shipengine/connect-runtime": "^4.1.0",
+    "@shipengine/connect-runtime": "^4.2.0",
     "express": "^4.18.2",
     "winston": "^3.8.2"
   }

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

@@ -40,7 +40,7 @@ import {
 
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 
-import { RequestResponseInfo } from '@shipengine/connect-runtime';
+import { RequestResponseInfo, Handler } from '@shipengine/connect-runtime';
 
 /**
  * @description This defines a connect carrier app
@@ -167,4 +167,11 @@ export interface CarrierAppDefinition {
   ) => 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>;
+  /**
+   * @description A collection of additional routes that can be used to extend the functionality of the app.
+   * Extension methods are not automatically called by the ShipEngine platform, and require working with Auctane developers to implement.
+   * The request and response shapes of each method will be defined by Auctane, but will not be documented as part of Connect unless
+   * they are made public and the functionality is taken out of extensions and into a named method.
+   */
+  Extensions?: Record<string, Handler>;
 }

package/src/app/create-endpoint-mapping.ts

@@ -1,10 +1,10 @@
-import { Method } from '@shipengine/connect-runtime';
+import { Method, Handler, mapExtensions } from '@shipengine/connect-runtime';
 import { ApiEndpoints } from './constants';
 import { CarrierAppDefinition } from './carrier-app-definition';
 
 export const createEndpointMapping = (
   definition: CarrierAppDefinition,
-): [Method, ApiEndpoints, ((req: any) => any | Promise<any>) | undefined][] => [
+): [Method, string, Handler | undefined][] => [
   //TODO: Remove `Method.POST` from this and all other maps since they are ALL post
   //TODO: Remove JOI validation from all endpoints and replace them with OpenAPI validation
   [Method.POST, ApiEndpoints.CancelNotification, definition.CancelNotification],
@@ -24,4 +24,5 @@ export const createEndpointMapping = (
   [Method.POST, ApiEndpoints.GetServicePoints, definition.GetServicePoints],
   [Method.POST, ApiEndpoints.GetServicePoint, definition.GetServicePoint],
   [Method.POST, ApiEndpoints.ImportTrackingEvents, definition.ImportTrackingEvents],
+  ...mapExtensions(definition.Extensions),
 ];

package/src/app/metadata/carrier.ts

@@ -16,6 +16,7 @@ import { fileExists } from './custom-validators/file-exists';
 import { Zone, ZoneSchema } from './zone';
 
 import { ApiCodeRegex, ApiCodeValidationMessage } from '@shipengine/connect-runtime';
+import { PackageRatingGroup, PackageRatingGroupSchema } from './package-rating-group';
 
 /** @description Basic structure for each carrier */
 export interface Carrier {
@@ -62,6 +63,8 @@ export interface Carrier {
   DocumentTemplate?: string;
   /** @description List of possible zones used by the carrier. */
   Zones?: Zone[];
+  /** @description List of package rating groups for the carrier */
+  PackageRatingGroups?: PackageRatingGroup[];
 }
 
 export const CarrierSchema = Joi.object({
@@ -110,4 +113,5 @@ export const CarrierSchema = Joi.object({
     .pattern(new RegExp('^.*.carrier$'))
     .message('Template file must have .carrier extension.'),
   Zones: Joi.array().optional().items(ZoneSchema).unique('ApiCode'),
+  PackageRatingGroups: Joi.array().optional().items(PackageRatingGroupSchema).unique('Id'),
 }).with('DocumentTemplate', 'ApiCode');

package/src/app/metadata/package-rating-group-dimensions.ts

@@ -0,0 +1,34 @@
+import Joi from 'joi';
+import { DimensionUnit } from '../../models';
+import { DimensionUnitSchema } from '../../models/units/dimension-unit-schema';
+
+/** @description Dimensions specific to a package rate class */
+export interface PackageRatingGroupDimensions {
+  /** @description Unit of the dimensions */
+  Unit: DimensionUnit;
+  /** @description Length of the package */
+  Length?: number;
+  /** @description Width of the package */
+  Width?: number;
+  /** @description Height of the package */
+  Height?: number;
+  /** @description Girth of the package as defined by the carrier */
+  Girth?: number;
+  /** @description No two sides exceed this amount */
+  NoTwoSides?: number;
+  /** @description Length plus girth should not exceed this amount */
+  LengthPlusGirth?: number;
+  /** @description Volume of the package */
+  Volume?: number;
+}
+
+export const PackageRatingGroupDimensionsSchema = Joi.object({
+  Unit: DimensionUnitSchema.required(),
+  Length: Joi.number().min(0).optional(),
+  Width: Joi.number().min(0).optional(),
+  Height: Joi.number().min(0).optional(),
+  NoTwoSides: Joi.number().min(0).optional(),
+  LengthPlusGirth: Joi.number().min(0).optional(),
+  Girth: Joi.number().min(0).optional(),
+  Volume: Joi.number().min(0).optional(),
+});

package/src/app/metadata/package-rating-group-weight.ts

@@ -0,0 +1,16 @@
+import Joi from 'joi';
+import { WeightUnit } from '../../models';
+import { WeightUnitSchema } from '../../models/units/weight-unit-schema';
+
+/** @description Weight of a package rating group */
+export interface PackageRatingGroupWeight {
+  /** @description Unit of the weight */
+  Unit: WeightUnit;
+  /** @description Actual weight value */
+  Value: number;
+}
+
+export const PackageRatingGroupWeightSchema = Joi.object({
+  Unit: WeightUnitSchema.required(),
+  Value: Joi.number().min(0),
+});

package/src/app/metadata/package-rating-group.ts

@@ -0,0 +1,34 @@
+import Joi from 'joi';
+import {
+  PackageRatingGroupDimensions,
+  PackageRatingGroupDimensionsSchema,
+} from './package-rating-group-dimensions';
+import {
+  PackageRatingGroupWeight,
+  PackageRatingGroupWeightSchema,
+} from './package-rating-group-weight';
+
+/** @description Details about how packages are related to rates */
+export interface PackageRatingGroup {
+  /** @description Id of the rating group */
+  Id: string;
+  /** @description Id of the package type to which this rating group corresponds */
+  PackageTypeId: string;
+  /** @description Name of the package rating group */
+  Name: string;
+  /** @description This is the code that will be sent to requests, this should be the same code the carrier's api would expect */
+  CarrierPackageTypeCode: string;
+  /** @description Maximum allowable dimensions of packages for the rating group */
+  DimensionLimits: PackageRatingGroupDimensions;
+  /** @description Maximum allowable weight of packages for the rating group */
+  MaxWeight: PackageRatingGroupWeight;
+}
+
+export const PackageRatingGroupSchema = Joi.object({
+  Id: Joi.string().uuid().required(),
+  PackageTypeId: Joi.string().uuid().required(),
+  Name: Joi.string().required().max(50),
+  CarrierPackageTypeCode: Joi.string().required().max(50), // Copied from package type validation
+  DimensionLimits: PackageRatingGroupDimensionsSchema.optional(),
+  MaxWeight: PackageRatingGroupWeightSchema.optional(),
+});