@shipengine/connect-carrier-api 2.1.19 → 2.1.23

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

@@ -1,5 +1,5 @@
-import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest } from '../requests';
-import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse } from '../responses';
+import { RegisterRequest, CreateLabelRequest, VoidLabelsRequest, CreateManifestRequest, SchedulePickupRequest, CancelPickupRequest, GetRatesRequest, TrackingRequest, CancelNotificationRequest, CreateNotificationRequest, ValidateInboundDataRequest, NormalizeTrackingDataRequest } from '../requests';
+import { RegisterResponse, CreateLabelResponse, VoidLabelsResponse, CreateManifestResponse, SchedulePickupResponse, CancelPickupResponse, GetRatesResponse, TrackingResponse, CancelNotificationResponse, CreateNotificationResponse, ValidateInboundDataResponse, NormalizeTrackingDataResponse } from '../responses';
 import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
 /**
  * @description This defines a connect carrier app
@@ -56,4 +56,14 @@ export interface CarrierAppDefinition {
      * @param request Data needed by the provider to inform them of the cancellation
      */
     CancelNotification?: (request: CancelNotificationRequest) => CancelNotificationResponse | Promise<CancelNotificationResponse>;
+    /**
+     * @description This endpoint is used to validate inbound data and determine the type of data included in the inbound message
+     * @param request Data received from the provider via an inbound method, such as a webhook
+     */
+    ValidateInboundData?: (request: ValidateInboundDataRequest) => ValidateInboundDataResponse | Promise<ValidateInboundDataRequest>;
+    /**
+     * @description This endpoint is used to normalize inbound tracking data and determine the type of data
+     * @param request Tracking data received from the provider via an inbound method, such as a webhook
+     */
+    NormalizeTrackingData?: (request: NormalizeTrackingDataRequest) => NormalizeTrackingDataResponse | Promise<NormalizeTrackingDataResponse>;
 }

package/lib/app/carrier-app.js

@@ -2,10 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CarrierApp = void 0;
 const internal_1 = require("./internal");
+const constants_1 = require("./constants");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const metadata_1 = require("./internal/metadata");
 const metadata_2 = require("./metadata");
+const responses_1 = require("../responses");
 const handleRequest = (implementation) => {
     if (implementation) {
         return (request) => {
@@ -13,62 +15,9 @@ const handleRequest = (implementation) => {
         };
     }
 };
-const registerRoutes = (routes, definition) => {
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/Register',
-        handler: handleRequest(definition.Register),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/CreateLabel',
-        handler: handleRequest(definition.CreateLabel),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/VoidLabels',
-        handler: handleRequest(definition.VoidLabels),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/GetRates',
-        handler: handleRequest(definition.GetRates),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/CreateManifest',
-        handler: handleRequest(definition.CreateManifest),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/SchedulePickup',
-        handler: handleRequest(definition.SchedulePickup),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/CancelPickup',
-        handler: handleRequest(definition.CancelPickup),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/Track',
-        handler: handleRequest(definition.Track),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/CreateNotification',
-        handler: handleRequest(definition.CreateNotification),
-    });
-    routes.push({
-        method: internal_1.Method.POST,
-        path: '/CancelNotification',
-        handler: handleRequest(definition.CancelNotification),
-    });
-};
 class CarrierApp {
     constructor(definition) {
         this.routes = [];
-        registerRoutes(this.routes, definition);
         this.validate = () => {
             const results = metadata_2.CarrierAppMetadataSchema.validate(definition.Metadata, {
                 allowUnknown: true,
@@ -78,6 +27,83 @@ class CarrierApp {
                 return results.error.details.map((detail) => `${detail.message}`);
             }
         };
+        new Array([
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.CancelNotification,
+            definition.CancelNotification,
+            responses_1.CancelNotificationResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.CancelPickup,
+            definition.CancelPickup,
+            responses_1.CancelPickupResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.CreateLabel,
+            definition.CreateLabel,
+            responses_1.CreateLabelResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.CreateManifest,
+            definition.CreateManifest,
+            responses_1.CreateManifestResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.CreateNotification,
+            definition.CreateNotification,
+            responses_1.CreateNotificationResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.GetRates,
+            definition.GetRates,
+            responses_1.GetRatesResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.NormalizeTrackingData,
+            definition.NormalizeTrackingData,
+            responses_1.NormalizeTrackingDataResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.Register,
+            definition.Register,
+            responses_1.RegisterResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.SchedulePickup,
+            definition.SchedulePickup,
+            responses_1.SchedulePickupResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.Track,
+            definition.Track,
+            responses_1.TrackingResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.ValidateInboundData,
+            definition.ValidateInboundData,
+            responses_1.ValidateInboundDataResponseSchema,
+        ], [
+            internal_1.Method.POST,
+            constants_1.ApiEndpoints.VoidLabels,
+            definition.VoidLabels,
+            responses_1.VoidLabelsResponseSchema,
+        ]).forEach(([method, path, implementation, schema]) => {
+            if (implementation) {
+                this.routes.push({
+                    method,
+                    path,
+                    handler: handleRequest(implementation),
+                    validateResponse: (result) => {
+                        var _a, _b;
+                        const validationResults = schema.validate(result, {
+                            abortEarly: false,
+                        });
+                        const errors = (_b = (_a = validationResults === null || validationResults === void 0 ? void 0 : validationResults.error) === null || _a === void 0 ? void 0 : _a.details) === null || _b === void 0 ? void 0 : _b.map((detail) => detail.message);
+                        return errors;
+                    },
+                });
+            }
+        });
         this.data = new metadata_1.Metadata(definition);
         const jsonSpecPath = path_1.resolve(__dirname, '../../spec.json');
         const yamlSpecPath = path_1.resolve(__dirname, '../../spec.yaml');

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

@@ -1 +1 @@
-{"version":3,"file":"carrier-app.js","sourceRoot":"","sources":["../../src/app/carrier-app.ts"],"names":[],"mappings":";;;AACA,yCAA6E;AAE7E,+BAA+B;AAC/B,2BAA8C;AAE9C,kDAA+C;AAE/C,yCAAsD;AAEtD,MAAM,aAAa,GAAG,CAAC,cAAyB,EAAO,EAAE;IACvD,IAAI,cAAc,EAAE;QAClB,OAAO,CAAC,OAAY,EAAE,EAAE;YACtB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;KACH;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAe,EAAE,UAAgC,EAAE,EAAE;IAC3E,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC;KAC5C,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC;KAC/C,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC;KAC9C,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC;KAC5C,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,cAAc,CAAC;KAClD,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,cAAc,CAAC;KAClD,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC;KAChD,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC;KACzC,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,kBAAkB,CAAC;KACtD,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC;QACV,MAAM,EAAE,iBAAM,CAAC,IAAI;QACnB,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,kBAAkB,CAAC;KACtD,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAa,UAAU;IAKrB,YAAY,UAAgC;QAJ5C,WAAM,GAAY,EAAE,CAAC;QAKnB,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE;YACnB,MAAM,OAAO,GAAG,mCAAwB,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACrE,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;YACH,IAAI,OAAO,CAAC,KAAK,EAAE;gBACjB,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;aACnE;QACH,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,mBAAQ,CAAC,UAAU,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,cAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,cAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC3D,IAAI,eAAU,CAAC,YAAY,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,GAAG,iBAAY,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;SACpD;aAAM,IAAI,eAAU,CAAC,YAAY,CAAC,EAAE;YACnC,IAAI,CAAC,KAAK,GAAG,iBAAY,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;SACpD;IACH,CAAC;IACD,SAAS;QACP,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAiB,EAAE;YACxE,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;gBAC5B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;aAC7B,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAClD,CAAC;CACF;AApCD,gCAoCC"}
+{"version":3,"file":"carrier-app.js","sourceRoot":"","sources":["../../src/app/carrier-app.ts"],"names":[],"mappings":";;;AACA,yCAA6E;AAC7E,2CAA2C;AAC3C,+BAA+B;AAC/B,2BAA8C;AAE9C,kDAA+C;AAE/C,yCAAsD;AACtD,4CAasB;AAGtB,MAAM,aAAa,GAAG,CAAC,cAAyB,EAAO,EAAE;IACvD,IAAI,cAAc,EAAE;QAClB,OAAO,CAAC,OAAY,EAAE,EAAE;YACtB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC;KACH;AACH,CAAC,CAAC;AAEF,MAAa,UAAU;IAKrB,YAAY,UAAgC;QAJ5C,WAAM,GAAY,EAAE,CAAC;QAKnB,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE;YACnB,MAAM,OAAO,GAAG,mCAAwB,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE;gBACrE,YAAY,EAAE,IAAI;gBAClB,UAAU,EAAE,KAAK;aAClB,CAAC,CAAC;YACH,IAAI,OAAO,CAAC,KAAK,EAAE;gBACjB,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;aACnE;QACH,CAAC,CAAC;QACF,IAAI,KAAK,CACP;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,kBAAkB;YAC/B,UAAU,CAAC,kBAAkB;YAC7B,4CAAgC;SACjC,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,YAAY;YACzB,UAAU,CAAC,YAAY;YACvB,sCAA0B;SAC3B,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,WAAW;YACxB,UAAU,CAAC,WAAW;YACtB,qCAAyB;SAC1B,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,cAAc;YAC3B,UAAU,CAAC,cAAc;YACzB,wCAA4B;SAC7B,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,kBAAkB;YAC/B,UAAU,CAAC,kBAAkB;YAC7B,4CAAgC;SACjC,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,QAAQ;YACrB,UAAU,CAAC,QAAQ;YACnB,kCAAsB;SACvB,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,qBAAqB;YAClC,UAAU,CAAC,qBAAqB;YAChC,+CAAmC;SACpC,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,QAAQ;YACrB,UAAU,CAAC,QAAQ;YACnB,kCAAsB;SACvB,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,cAAc;YAC3B,UAAU,CAAC,cAAc;YACzB,wCAA4B;SAC7B,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,KAAK;YAClB,UAAU,CAAC,KAAK;YAChB,kCAAsB;SACvB,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,mBAAmB;YAChC,UAAU,CAAC,mBAAmB;YAC9B,6CAAiC;SAClC,EACD;YACE,iBAAM,CAAC,IAAI;YACX,wBAAY,CAAC,UAAU;YACvB,UAAU,CAAC,UAAU;YACrB,oCAAwB;SACzB,CACF,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,EAAE;YACnD,IAAI,cAAc,EAAE;gBAClB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;oBACf,MAAM;oBACN,IAAI;oBACJ,OAAO,EAAE,aAAa,CAAC,cAA0B,CAAC;oBAClD,gBAAgB,EAAE,CAAC,MAAW,EAAwB,EAAE;;wBACtD,MAAM,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE;4BAChD,UAAU,EAAE,KAAK;yBAClB,CAAC,CAAC;wBACH,MAAM,MAAM,GAAG,MAAA,MAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,KAAK,0CAAE,OAAO,0CAAE,GAAG,CACnD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAC3B,CAAC;wBACF,OAAO,MAAM,CAAC;oBAChB,CAAC;iBACF,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,mBAAQ,CAAC,UAAU,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,cAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,cAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QAC3D,IAAI,eAAU,CAAC,YAAY,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,GAAG,iBAAY,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;SACpD;aAAM,IAAI,eAAU,CAAC,YAAY,CAAC,EAAE;YACnC,IAAI,CAAC,KAAK,GAAG,iBAAY,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;SACpD;IACH,CAAC;IACD,SAAS;QACP,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAiB,EAAE;YACxE,OAAO;gBACL,EAAE,EAAE,OAAO,CAAC,EAAE;gBACd,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;gBAC5B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO;aAC7B,CAAC;QACJ,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAClD,CAAC;CACF;AA9HD,gCA8HC"}

package/lib/app/constants.d.ts

@@ -0,0 +1,14 @@
+export declare enum ApiEndpoints {
+    Register = "/Register",
+    CreateLabel = "/CreateLabel",
+    VoidLabels = "/VoidLabels",
+    GetRates = "/GetRates",
+    CreateManifest = "/CreateManifest",
+    SchedulePickup = "/SchedulePickup",
+    CancelPickup = "/CancelPickup",
+    Track = "/Track",
+    CreateNotification = "/CreateNotification",
+    CancelNotification = "/CancelNotification",
+    ValidateInboundData = "/ValidateInboundData",
+    NormalizeTrackingData = "/NormalizeTrackingData"
+}

package/lib/app/constants.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiEndpoints = void 0;
+var ApiEndpoints;
+(function (ApiEndpoints) {
+    ApiEndpoints["Register"] = "/Register";
+    ApiEndpoints["CreateLabel"] = "/CreateLabel";
+    ApiEndpoints["VoidLabels"] = "/VoidLabels";
+    ApiEndpoints["GetRates"] = "/GetRates";
+    ApiEndpoints["CreateManifest"] = "/CreateManifest";
+    ApiEndpoints["SchedulePickup"] = "/SchedulePickup";
+    ApiEndpoints["CancelPickup"] = "/CancelPickup";
+    ApiEndpoints["Track"] = "/Track";
+    ApiEndpoints["CreateNotification"] = "/CreateNotification";
+    ApiEndpoints["CancelNotification"] = "/CancelNotification";
+    ApiEndpoints["ValidateInboundData"] = "/ValidateInboundData";
+    ApiEndpoints["NormalizeTrackingData"] = "/NormalizeTrackingData";
+})(ApiEndpoints = exports.ApiEndpoints || (exports.ApiEndpoints = {}));
+//# sourceMappingURL=constants.js.map

package/lib/app/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/app/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,sCAAsB,CAAA;IACtB,4CAA4B,CAAA;IAC5B,0CAA0B,CAAA;IAC1B,sCAAsB,CAAA;IACtB,kDAAkC,CAAA;IAClC,kDAAkC,CAAA;IAClC,8CAA8B,CAAA;IAC9B,gCAAgB,CAAA;IAChB,0DAA0C,CAAA;IAC1C,0DAA0C,CAAA;IAC1C,4DAA4C,CAAA;IAC5C,gEAAgD,CAAA;AAClD,CAAC,EAbW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAavB"}

package/lib/app/internal/{carrier-app-specificaion.d.ts → carrier-app-specification.d.ts}

@@ -1,5 +1,6 @@
+import { AuthSpecification } from '../metadata/auth-specification';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierSpecification } from './carrier-specification';
 /** @description This represents a single integration which may contain multiple carrier sources */
 export interface CarrierAppSpecification {
     /** @description The id for this integration */
@@ -8,6 +9,8 @@ export interface CarrierAppSpecification {
     Name: string;
     /** @description Information about the connector */
     Connector: ShippingProviderConnector;
+    /** @description The specification for authorizing with this carrier */
+    AuthProcess?: AuthSpecification;
     /** @description A list of carrier sources associated with this integration */
     Carriers: CarrierSpecification[];
 }

package/lib/app/internal/{carrier-app-specificaion.js → carrier-app-specification.js}

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

package/lib/app/internal/carrier-app-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-app-specification.js","sourceRoot":"","sources":["../../../src/app/internal/carrier-app-specification.ts"],"names":[],"mappings":""}

package/lib/app/internal/{carrier-specificaion.js → carrier-specification.js}

@@ -59,4 +59,4 @@ class CarrierSpecification {
     }
 }
 exports.CarrierSpecification = CarrierSpecification;
-//# sourceMappingURL=carrier-specificaion.js.map
+//# sourceMappingURL=carrier-specification.js.map

package/lib/app/internal/carrier-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrier-specification.js","sourceRoot":"","sources":["../../../src/app/internal/carrier-specification.ts"],"names":[],"mappings":";;;AAoBO,MAAM,kBAAkB,GAAG,CAChC,OAAkC,EACJ,EAAE;IAChC,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAqB,EAAE,CAAC;IACjC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;QAC3C,MAAM,IAAI,GAAG,GAAyB,CAAC;QACvC,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,IAAI,CAA8B,CAAC;QACzE,GAAG,CAAC,IAAI,CAAC;YACP,IAAI;YACJ,WAAW;YACX,IAAI;SACL,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B;AAEK,MAAM,oBAAoB,GAAG,CAClC,KAA8B,EACV,EAAE;IACtB,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,EAAE,CAAC;KACX;IACD,MAAM,GAAG,GAAuB,EAAE,CAAC;IACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;QACtC,MAAM,aAAa,GAAG,KAA+B,CAAC;QACtD,MAAM,IAAI,GAAG,GAA2B,CAAC;QACzC,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAW,CAAC;QAC3C,GAAG,CAAC,IAAI,CAAC;YACP,IAAI;YACJ,IAAI;SACL,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAjBW,QAAA,oBAAoB,wBAiB/B;AAEF,gEAAgE;AAChE,MAAa,oBAAoB;IAoB/B,YAAY,UAAmB;QAC7B,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI;YAC/B,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI;SAChC,CAAC;QACF,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,0BAAkB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QACtE,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC,yBAAyB,CAAC;QACtE,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,wBAAwB,GAAG,4BAAoB,CAClD,UAAU,CAAC,wBAAwB,CACpC,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAC5C,CAAC;CACF;AA1CD,oDA0CC"}

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

@@ -1,11 +1,13 @@
 import { CarrierAppDefinition } from '../carrier-app-definition';
 import { ShippingProviderConnector } from '../metadata/shipping-provider-connector';
-import { CarrierAppSpecification } from './carrier-app-specificaion';
-import { CarrierSpecification } from './carrier-specificaion';
+import { CarrierAppSpecification } from './carrier-app-specification';
+import { CarrierSpecification } from './carrier-specification';
+import { AuthSpecification } from '../metadata/auth-specification';
 export declare class Metadata implements CarrierAppSpecification {
     Id: string;
     Name: string;
     Connector: ShippingProviderConnector;
+    AuthProcess?: AuthSpecification;
     Carriers: CarrierSpecification[];
     constructor(app: CarrierAppDefinition);
 }

package/lib/app/internal/metadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Metadata = void 0;
-const carrier_specificaion_1 = require("./carrier-specificaion");
+const carrier_specification_1 = require("./carrier-specification");
 const fn = (name) => ({
     Name: name,
     IsSandboxed: false,
@@ -38,7 +38,11 @@ class Metadata {
     constructor(app) {
         this.Id = app.Metadata.Id;
         this.Name = app.Metadata.Name;
-        this.Carriers = app.Metadata.Carriers.map((c) => new carrier_specificaion_1.CarrierSpecification(c));
+        this.AuthProcess = app.Metadata.AuthProcess;
+        if (this.AuthProcess) {
+            this.AuthProcess.Identifier.Version = '2.0';
+        }
+        this.Carriers = app.Metadata.Carriers.map((c) => new carrier_specification_1.CarrierSpecification(c));
         this.Connector = {
             DiagnosticRoutes: {
                 Liveness: '/diagnostics/liveness',

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

@@ -1 +1 @@
-{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAKA,iEAA8D;AAE9D,MAAM,EAAE,GAAG,CAAC,IAAY,EAAyB,EAAE,CAAC,CAAC;IACnD,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,KAAK;CACnB,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,GAAyB,EAA2B,EAAE;IAC1E,MAAM,GAAG,GAA4B,EAAE,CAAC;IAExC,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,CAAC,UAAU,EAAE;QAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;KAC5B;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;KAC9B;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;KACvB;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAa,QAAQ;IAMnB,YAAY,GAAyB;QACnC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,2CAAoB,CAAC,CAAC,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF;AAvBD,4BAuBC"}
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/app/internal/metadata.ts"],"names":[],"mappings":";;;AAKA,mEAA+D;AAG/D,MAAM,EAAE,GAAG,CAAC,IAAY,EAAyB,EAAE,CAAC,CAAC;IACnD,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,KAAK;CACnB,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,GAAyB,EAA2B,EAAE;IAC1E,MAAM,GAAG,GAA4B,EAAE,CAAC;IAExC,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,WAAW,EAAE;QACnB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;KAC7B;IAED,IAAI,GAAG,CAAC,UAAU,EAAE;QAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;KAC5B;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,cAAc,EAAE;QACtB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;KAChC;IAED,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;KAC9B;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;KAC1B;IAED,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;KACvB;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAa,QAAQ;IAOnB,YAAY,GAAyB;QACnC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC5C,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;SAC7C;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CACvC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,4CAAoB,CAAC,CAAC,CAAC,CACnC,CAAC;QAEF,IAAI,CAAC,SAAS,GAAG;YACf,gBAAgB,EAAE;gBAChB,QAAQ,EAAE,uBAAuB;gBACjC,SAAS,EAAE,wBAAwB;gBACnC,OAAO,EAAE,sBAAsB;aAChC;YACD,UAAU,EAAE,OAAO;YACnB,SAAS,EAAE,YAAY,CAAC,GAAG,CAAC;SAC7B,CAAC;IACJ,CAAC;CACF;AA5BD,4BA4BC"}

package/lib/app/internal/route.d.ts

@@ -9,4 +9,5 @@ export interface Route {
     path: string;
     method: Method;
     handler?: (req: any) => any | Promise<any>;
+    validateResponse?: (response: any) => string[] | undefined;
 }

package/lib/app/metadata/auth-identifier.d.ts

@@ -0,0 +1,10 @@
+import Joi from 'joi';
+export declare enum AuthenticationType {
+    OAuth = "oauth"
+}
+export declare class AuthIdentifier {
+    AuthenticationType: AuthenticationType;
+    Version?: string;
+    IsSandbox?: boolean;
+}
+export declare const AuthIdentifierSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/auth-identifier.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthIdentifierSchema = exports.AuthIdentifier = exports.AuthenticationType = void 0;
+const tslib_1 = require("tslib");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+var AuthenticationType;
+(function (AuthenticationType) {
+    AuthenticationType["OAuth"] = "oauth";
+})(AuthenticationType = exports.AuthenticationType || (exports.AuthenticationType = {}));
+class AuthIdentifier {
+}
+exports.AuthIdentifier = AuthIdentifier;
+exports.AuthIdentifierSchema = joi_1.default.object({
+    AuthenticationType: joi_1.default.string().required().valid('oauth'),
+    Version: joi_1.default.string().optional(),
+    IsSandbox: joi_1.default.bool().optional(),
+});
+//# sourceMappingURL=auth-identifier.js.map

package/lib/app/metadata/auth-identifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-identifier.js","sourceRoot":"","sources":["../../../src/app/metadata/auth-identifier.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AAEtB,IAAY,kBAEX;AAFD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;AACjB,CAAC,EAFW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAE7B;AAED,MAAa,cAAc;CAI1B;AAJD,wCAIC;AAEY,QAAA,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC7C,kBAAkB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;IAC1D,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,aAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC"}

package/lib/app/metadata/auth-specification.d.ts

@@ -0,0 +1,19 @@
+import { AuthIdentifier } from './auth-identifier';
+import { AccessToken, AuthorizationConfiguration, Parameter, RefreshTokenConfiguration, RequestTokenConfiguration } from './monoauth';
+import Joi from 'joi';
+/** @description Used to specify information about an integrations authentication */
+export declare class AuthSpecification {
+    /** @description Identify the type of Auth being used by the integration */
+    Identifier: AuthIdentifier;
+    /** @description Added to allow oauth 1.0 to work. */
+    access_token?: AccessToken;
+    /** @description Authorization: the beginning of an OAuth2.0 flow that ensures the user is logged in and approves access to the Resource. */
+    authorization?: AuthorizationConfiguration;
+    /** @description Request Token: server-server code for token exchange */
+    request_token?: RequestTokenConfiguration;
+    /** @description Refresh Token: server-server refresh token exchange for access token **NOTE: sometimes a new RT is also created** */
+    refresh_token?: RefreshTokenConfiguration;
+    /** @description Advanced configurations used for oauth 1.0 */
+    advanced_configuration?: Parameter[];
+}
+export declare const AuthSpecificationSchema: Joi.ObjectSchema<any>;

package/lib/app/metadata/auth-specification.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthSpecificationSchema = exports.AuthSpecification = void 0;
+const tslib_1 = require("tslib");
+const auth_identifier_1 = require("./auth-identifier");
+const monoauth_1 = require("./monoauth");
+const joi_1 = tslib_1.__importDefault(require("joi"));
+/** @description Used to specify information about an integrations authentication */
+class AuthSpecification {
+}
+exports.AuthSpecification = AuthSpecification;
+exports.AuthSpecificationSchema = joi_1.default.object({
+    Identifier: auth_identifier_1.AuthIdentifierSchema,
+    access_token: monoauth_1.AccessTokenSchema.optional(),
+    authorization: monoauth_1.AuthorizationConfigurationSchema.optional(),
+    request_token: monoauth_1.RequestTokenConfigurationSchema.optional(),
+    refresh_token: monoauth_1.RefreshTokenConfigurationSchema.optional(),
+    advanced_configuration: joi_1.default.array().optional().items(monoauth_1.ParameterSchema),
+});
+//# sourceMappingURL=auth-specification.js.map

package/lib/app/metadata/auth-specification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-specification.js","sourceRoot":"","sources":["../../../src/app/metadata/auth-specification.ts"],"names":[],"mappings":";;;;AAAA,uDAAyE;AACzE,yCAWoB;AACpB,sDAAsB;AAEtB,oFAAoF;AACpF,MAAa,iBAAiB;CAa7B;AAbD,8CAaC;AAEY,QAAA,uBAAuB,GAAG,aAAG,CAAC,MAAM,CAAC;IAChD,UAAU,EAAE,sCAAoB;IAChC,YAAY,EAAE,4BAAiB,CAAC,QAAQ,EAAE;IAC1C,aAAa,EAAE,2CAAgC,CAAC,QAAQ,EAAE;IAC1D,aAAa,EAAE,0CAA+B,CAAC,QAAQ,EAAE;IACzD,aAAa,EAAE,0CAA+B,CAAC,QAAQ,EAAE;IACzD,sBAAsB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0BAAe,CAAC;CACtE,CAAC,CAAC"}

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

@@ -1,10 +1,12 @@
 import Joi from 'joi';
-import { Carrier } from './carrier';
+import { AuthSpecification, Carrier } from '.';
 export interface CarrierAppMetadata {
     /** @description Id of the carrier app */
     Id: string;
     /** @description Name of the carrier */
     Name: string;
+    /** @description The specification for authorizing with this order source */
+    AuthProcess?: AuthSpecification;
     /** @description List of carriers for the app */
     Carriers: Carrier[];
 }

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

@@ -3,17 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CarrierAppMetadataSchema = void 0;
 const tslib_1 = require("tslib");
 const joi_1 = tslib_1.__importDefault(require("joi"));
-const carrier_1 = require("./carrier");
+const _1 = require(".");
 exports.CarrierAppMetadataSchema = joi_1.default.object({
     Id: joi_1.default.string()
         .uuid({ version: ['uuidv4'] })
         .required(),
     Name: joi_1.default.string().required(),
+    AuthProcess: _1.AuthSpecificationSchema.optional(),
     Carriers: joi_1.default.array()
         .unique('Id')
         .required()
         .min(1)
         .message('There must be at least 1 Carrier defined')
-        .items(carrier_1.CarrierSchema),
+        .items(_1.CarrierSchema),
 });
 //# sourceMappingURL=carrier-app-metadata.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,uCAAmD;AAWtC,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE;SACb,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;SAC7B,QAAQ,EAAE;IACb,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,uBAAa,CAAC;CACxB,CAAC,CAAC"}
+{"version":3,"file":"carrier-app-metadata.js","sourceRoot":"","sources":["../../../src/app/metadata/carrier-app-metadata.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,wBAKW;AAaE,QAAA,wBAAwB,GAAG,aAAG,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE;SACb,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC;SAC7B,QAAQ,EAAE;IACb,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,0BAAuB,CAAC,QAAQ,EAAE;IAC/C,QAAQ,EAAE,aAAG,CAAC,KAAK,EAAE;SAClB,MAAM,CAAC,IAAI,CAAC;SACZ,QAAQ,EAAE;SACV,GAAG,CAAC,CAAC,CAAC;SACN,OAAO,CAAC,0CAA0C,CAAC;SACnD,KAAK,CAAC,gBAAa,CAAC;CACxB,CAAC,CAAC"}

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

@@ -1,7 +1,9 @@
 export * from './account-modals';
+export * from './auth-identifier';
+export * from './auth-specification';
+export * from './carrier';
 export * from './carrier-app-metadata';
 export * from './carrier-attributes';
-export * from './carrier';
 export * from './confirmation-type';
 export * from './country-association';
 export * from './diagnostic-routes';
@@ -9,6 +11,7 @@ export * from './enums';
 export * from './function';
 export * from './label-formats';
 export * from './label-sizes';
+export * from './monoauth';
 export * from './package-type';
 export * from './service-class';
 export * from './service-grade';

package/lib/app/metadata/index.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./account-modals"), exports);
+tslib_1.__exportStar(require("./auth-identifier"), exports);
+tslib_1.__exportStar(require("./auth-specification"), exports);
+tslib_1.__exportStar(require("./carrier"), exports);
 tslib_1.__exportStar(require("./carrier-app-metadata"), exports);
 tslib_1.__exportStar(require("./carrier-attributes"), exports);
-tslib_1.__exportStar(require("./carrier"), exports);
 tslib_1.__exportStar(require("./confirmation-type"), exports);
 tslib_1.__exportStar(require("./country-association"), exports);
 tslib_1.__exportStar(require("./diagnostic-routes"), exports);
@@ -12,6 +14,7 @@ tslib_1.__exportStar(require("./enums"), exports);
 tslib_1.__exportStar(require("./function"), exports);
 tslib_1.__exportStar(require("./label-formats"), exports);
 tslib_1.__exportStar(require("./label-sizes"), exports);
+tslib_1.__exportStar(require("./monoauth"), exports);
 tslib_1.__exportStar(require("./package-type"), exports);
 tslib_1.__exportStar(require("./service-class"), exports);
 tslib_1.__exportStar(require("./service-grade"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,iEAAuC;AACvC,+DAAqC;AACrC,oDAA0B;AAC1B,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/metadata/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,4DAAkC;AAClC,+DAAqC;AACrC,oDAA0B;AAC1B,iEAAuC;AACvC,+DAAqC;AACrC,8DAAoC;AACpC,gEAAsC;AACtC,8DAAoC;AACpC,kDAAwB;AACxB,qDAA2B;AAC3B,0DAAgC;AAChC,wDAA8B;AAC9B,qDAA2B;AAC3B,yDAA+B;AAC/B,0DAAgC;AAChC,0DAAgC;AAChC,wEAA8C;AAC9C,gEAAsC;AACtC,4DAAkC;AAClC,wEAA8C;AAC9C,6DAAmC"}

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

@@ -0,0 +1,102 @@
+import Joi from 'joi';
+export declare class Parameter {
+    /** @description The name of the parameter */
+    name: string;
+    /** @description The value associated with the parameter */
+    value: string;
+}
+export declare const MethodSchema: Joi.StringSchema;
+export declare const ParameterSchema: Joi.ObjectSchema<any>;
+export declare class DateTimeConfiguration {
+    /** @description JSONPath to the JSON element containing the date-time */
+    path: string;
+    /** @description DateTime format string compliant with
+     * https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings */
+    date_time_format: string;
+}
+export declare const DateTimeConfigurationSchema: Joi.ObjectSchema<any>;
+export declare type MapOfStrings = {
+    [key: string]: string;
+};
+/** @description Optional configuration to take full control of parsing and extracting fields
+ * from the integration's JSON response body.
+ * Note for JSONPath: strings not starting with $ are interpreted as string literals
+ */
+export declare class ResponseTransformationConfiguration {
+    /** @description JSONPath to the JSON element for access_token. */
+    access_token: string;
+    /** @description JSONPath to the JSON element for token_type */
+    token_type: string;
+    /** @description JSONPath to the JSON element for refresh_token */
+    refresh_token?: string;
+    /** @description JSONPath to the JSON element for expires_in. Mutually exclusive with expires_at */
+    expires_in?: string;
+    /** @description Configuration for parsing a date-time, when the integration is lacking expires_in.
+     * Mutually exclusive with expires_in.
+     */
+    expires_at?: DateTimeConfiguration;
+    /** @description Optional collection of properties to include in the connection_context sent back with the auth flow result.
+     *  Property value may be JSONPath or a string literal.
+     *  E.g.
+     *  "connection_context": {
+     *    "account_number": "$.data.account_number"
+     *  }
+     */
+    connection_context?: MapOfStrings;
+}
+export declare const MapOfStringsSchema: Joi.ObjectSchema<any>;
+export declare const ResponseTransformationConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class AccessToken {
+    /** @description OAuth1 only. The url to obtain the temporary Access (aka Request) Token to start a flow **/
+    url_template: string;
+}
+export declare const AccessTokenSchema: Joi.ObjectSchema<any>;
+export declare class RequestTokenConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/request", "http://store.com/oauth/request" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration when exchanging the code for the token. These are built using ContentType */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when requesting a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare const RequestTokenConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class RefreshTokenConfiguration {
+    /** @description The url to refresh the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/refresh", "http://store.com/oauth/refresh" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server refresh token request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when refreshing a token */
+    headers?: Parameter[];
+    /** @description Response payload parsing */
+    response?: ResponseTransformationConfiguration;
+}
+export declare const RefreshTokenConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class NonceConfiguration {
+    name: string;
+}
+export declare const NonceConfigurationSchema: Joi.ObjectSchema<any>;
+export declare class AuthorizationConfiguration {
+    /** @description The url to obtain the access token using the authorization code on the backend @example "http://{auth_state:store_name}.store.com/admin/oauth/authorize", "http://store.com/oauth/authorize" */
+    url_template: string;
+    /** @description A list of query parameters that will be attached to the url */
+    query_parameters?: Parameter[];
+    /** @description Method to use when making the server-server code for token request @example "GET", "POST" */
+    method?: string;
+    /** @description List of parameters that are sent to the integration during the server-server authorization request. These are built using the content type specified in the headers array. */
+    body?: Parameter[];
+    /** @description List of headers that are sent to the integration when authorizing a token */
+    headers?: Parameter[];
+    /** @description A nonce query parameter included on the accept request, then returned and validated on the redirect request */
+    nonce?: NonceConfiguration;
+}
+export declare const AuthorizationConfigurationSchema: Joi.ObjectSchema<any>;