@shipengine/connect-carrier-api 2.3.0 → 2.3.5

package/lib/responses/create-manifest-response.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const base_response_1 = require("./base-response");
 const models_1 = require("../models");
 const joi_1 = tslib_1.__importDefault(require("joi"));
+const manifest_status_1 = require("../models/manifest-status");
 /** @description Basic structure for a response to create a manifest */
 class CreateManifestResponse extends base_response_1.BaseResponse {
 }
@@ -12,5 +13,10 @@ exports.CreateManifestResponse = CreateManifestResponse;
 exports.CreateManifestResponseSchema = base_response_1.BaseResponseSchema.keys({
     transaction_id: joi_1.default.string().required(),
     manifests: joi_1.default.array().optional().items(models_1.ManifestSchema),
+    manifest_request_id: joi_1.default.number().optional(),
+    manifest_status: manifest_status_1.ManifestStatusSchema.optional,
+    total_shipments: joi_1.default.number().optional(),
+    total_invalid: joi_1.default.number().optional(),
+    manifest_identifiers: joi_1.default.any().optional(),
 });
 //# sourceMappingURL=create-manifest-response.js.map

package/lib/responses/create-manifest-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAqD;AACrD,sDAAsB;AAEtB,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAGvD;AAHD,wDAGC;AAEY,QAAA,4BAA4B,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAClE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAc,CAAC;CACxD,CAAC,CAAC"}
+{"version":3,"file":"create-manifest-response.js","sourceRoot":"","sources":["../../src/responses/create-manifest-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAqD;AACrD,sDAAsB;AACtB,+DAAiF;AAEjF,uEAAuE;AACvE,MAAa,sBAAuB,SAAQ,4BAAY;CAQvD;AARD,wDAQC;AAEY,QAAA,4BAA4B,GAAG,kCAAkB,CAAC,IAAI,CAAC;IAClE,cAAc,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,uBAAc,CAAC;IACvD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,sCAAoB,CAAC,QAAQ;IAC9C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxC,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,oBAAoB,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC"}

package/lib/responses/normalize-tracking-data-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"normalize-tracking-data-response.js","sourceRoot":"","sources":["../../src/responses/normalize-tracking-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAKmB;AACnB,sDAAsB;AAEtB,qFAAqF;AACrF,MAAa,6BAA8B,SAAQ,4BAAY;CAQ9D;AARD,sEAQC;AAEY,QAAA,mCAAmC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACzE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAC/D,aAAa,EAAE,4BAAmB;CACnC,CAAC,CAAC"}
+{"version":3,"file":"normalize-tracking-data-response.js","sourceRoot":"","sources":["../../src/responses/normalize-tracking-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAiG;AACjG,sDAAsB;AAEtB,qFAAqF;AACrF,MAAa,6BAA8B,SAAQ,4BAAY;CAQ9D;AARD,sEAQC;AAEY,QAAA,mCAAmC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACzE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,2BAAkB,CAAC;IAC/D,aAAa,EAAE,4BAAmB;CACnC,CAAC,CAAC"}

package/lib/responses/validate-inbound-data-response.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate-inbound-data-response.js","sourceRoot":"","sources":["../../src/responses/validate-inbound-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAGmB;AACnB,sDAAsB;AAEtB,2EAA2E;AAC3E,MAAa,2BAA4B,SAAQ,4BAAY;CAG5D;AAHD,kEAGC;AAEY,QAAA,iCAAiC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACvE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAA6B,CAAC;CAC3E,CAAC,CAAC"}
+{"version":3,"file":"validate-inbound-data-response.js","sourceRoot":"","sources":["../../src/responses/validate-inbound-data-response.ts"],"names":[],"mappings":";;;;AAAA,mDAAmE;AACnE,sCAAmF;AACnF,sDAAsB;AAEtB,2EAA2E;AAC3E,MAAa,2BAA4B,SAAQ,4BAAY;CAG5D;AAHD,kEAGC;AAEY,QAAA,iCAAiC,GAAG,kCAAkB,CAAC,IAAI,CAAC;IACvE,aAAa,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,sCAA6B,CAAC;CAC3E,CAAC,CAAC"}

package/lib/spec.d.ts

@@ -0,0 +1,2 @@
+declare const OpenApiSpecification: any;
+export { OpenApiSpecification };

package/lib/spec.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiSpecification = void 0;
+const OpenApiSpecification = require('../spec.json');
+exports.OpenApiSpecification = OpenApiSpecification;
+//# sourceMappingURL=spec.js.map

package/lib/spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.js","sourceRoot":"","sources":["../src/spec.ts"],"names":[],"mappings":";;;AAAA,MAAM,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAC5C,oDAAoB"}

package/lib/spec.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/spec.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const spec_1 = require("./spec");
+describe('when importing the open api specification', () => {
+    it('it should load', () => {
+        expect(spec_1.OpenApiSpecification).toBeDefined();
+    });
+    it('it should have the shape of an openapi document', () => {
+        expect(spec_1.OpenApiSpecification.openapi).toBeDefined();
+    });
+});
+//# sourceMappingURL=spec.test.js.map

package/lib/spec.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec.test.js","sourceRoot":"","sources":["../src/spec.test.ts"],"names":[],"mappings":";;AAAA,iCAA8C;AAC9C,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;IACzD,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,2BAAoB,CAAC,CAAC,WAAW,EAAE,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,2BAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.3.0",
+  "version": "2.3.5",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",
@@ -12,7 +12,7 @@
     "format": "prettier --single-quote --trailing-comma=all --write \"src/**/*.ts\"",
     "lint": "prettier --single-quote --trailing-comma=all --check \"src/**/*.ts\"",
     "release": "yarn version:release",
-    "test": "true",
+    "test": "jest",
     "watch": "yarn build:watch"
   },
   "repository": {
@@ -31,7 +31,11 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
+    "@types/jest": "^27.0.3",
+    "@types/sanitize-html": "^2.6.2",
+    "jest": "^27.4.5",
     "prettier": "^2.4.0",
+    "ts-jest": "^27.1.2",
     "typescript": "^4.3.5"
   },
   "dependencies": {

package/spec.json

@@ -362,6 +362,89 @@
         }
       }
     },
+    "/GetManifest": {
+      "post": {
+        "tags": ["Manifesting"],
+        "description": "This method retrieves an end-of-day manifest and should be implemented by carrier apps that support retrieving end-of-day manifesting following create.",
+        "operationId": "Get Manifest",
+        "parameters": [
+          {
+            "name": "ShipStation-TransactionID",
+            "in": "header",
+            "description": "The transaction ID uniquely represents this request.",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "An object containing information required to retrieve a manifest.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GetManifestRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "400": {
+            "description": "Can be an internal or external error indicating an issue with the request that must be corrected.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BadRequestResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Use this to indicate an authentication or authorization error.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/UnauthorizedResponse"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "An unexpected error occurred in the carrier app.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/InternalServerErrorResponse"
+                }
+              }
+            }
+          },
+          "520": {
+            "description": "Use this when an error is the result of calling an external service, such as an API. This indicates that the error came from a downstream service rather than directly in your app.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ExternalServerErrorResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Use this when the behavior is not supported or the behavior is not available for the user."
+          },
+          "200": {
+            "description": "This object model represents the response from a successful get manifest request. It is the same as the response from create manifest",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CreateManifestResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/ValidateInboundData": {
       "post": {
         "tags": ["Normalize Inbound Data"],
@@ -1900,6 +1983,30 @@
         "additionalProperties": false,
         "description": "This model represents the response from a successful create label request."
       },
+      "GetManifestRequest": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BaseRequest"
+          }
+        ],
+        "properties": {
+          "manifest_request_id":{
+            "type": "integer"
+          },
+          "manifest_identifiers": {
+          "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Identifier"
+            }
+        },
+        "return_immediately": {
+          "type": "boolean"
+        }
+        },
+        "additionalProperties": false,
+        "description": "This model represents the request payload needed to retrieve a previously created manifest."
+      },
       "CreateManifestRequest": {
         "type": "object",
         "allOf": [

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

@@ -3,6 +3,7 @@ import {
   CreateLabelRequest,
   VoidLabelsRequest,
   CreateManifestRequest,
+  GetManifestRequest,
   SchedulePickupRequest,
   CancelPickupRequest,
   GetRatesRequest,
@@ -39,23 +40,17 @@ export interface CarrierAppDefinition {
    * @description This method is used to register an account
    * @param request The information needed to register or initialize a connection with the shipping provider
    */
-  Register?: (
-    request: RegisterRequest,
-  ) => RegisterResponse | Promise<RegisterResponse>;
+  Register?: (request: RegisterRequest) => RegisterResponse | Promise<RegisterResponse>;
   /**
    * @description This method is used to create a label
    * @param request Data needed by the provider to create a label
    */
-  CreateLabel?: (
-    request: CreateLabelRequest,
-  ) => CreateLabelResponse | Promise<CreateLabelResponse>;
+  CreateLabel?: (request: CreateLabelRequest) => CreateLabelResponse | Promise<CreateLabelResponse>;
   /**
    * @description This method is used to void multiple labels
    * @param request Data needed by the provider to void multiple labels
    */
-  VoidLabels?: (
-    request: VoidLabelsRequest,
-  ) => VoidLabelsResponse | Promise<VoidLabelsResponse>;
+  VoidLabels?: (request: VoidLabelsRequest) => VoidLabelsResponse | Promise<VoidLabelsResponse>;
   /**
    * @description This method is used to create a manifest with a carrier
    * @param request Data needed by the provider to create a manifest
@@ -63,6 +58,13 @@ export interface CarrierAppDefinition {
   CreateManifest?: (
     request: CreateManifestRequest,
   ) => CreateManifestResponse | Promise<CreateManifestResponse>;
+  /**
+   * @description This method is used to retrieve a manifest with a carrier
+   * @param request Data needed by the provider to retrieve a previousely created manifest
+   */
+  GetManifest?: (
+    request: GetManifestRequest,
+  ) => CreateManifestResponse | Promise<CreateManifestResponse>;
   /**
    * @description This endpoint is used to schedule an adhoc pickup with the shipping provider
    * @param request Data needed by the provider to schedule adhoc pickups
@@ -81,16 +83,12 @@ export interface CarrierAppDefinition {
    * @description This endpoint is used to get rates for a particular shipment
    * @param request Data needed by the provider to get a rate estimate
    */
-  GetRates?: (
-    request: GetRatesRequest,
-  ) => GetRatesResponse | Promise<GetRatesResponse>;
+  GetRates?: (request: GetRatesRequest) => GetRatesResponse | Promise<GetRatesResponse>;
   /**
    * @description This endpoint is used to get tracking information about a shipment
    * @param request Data needed by the provider to track a shipment
    */
-  Track?: (
-    request: TrackingRequest,
-  ) => TrackingResponse | Promise<TrackingResponse>;
+  Track?: (request: TrackingRequest) => TrackingResponse | Promise<TrackingResponse>;
   /**
    * @description This endpoint is used to submit notification of the creation of a shipment
    * @param request Data needed by the provider to inform them of a shipment

package/src/app/carrier-app.ts

@@ -1,8 +1,7 @@
 import { CarrierAppDefinition } from '.';
 import { ConnectRuntimeApp, Method, Route, BrandedImages } from './internal';
 import { ApiEndpoints } from './constants';
-import { resolve } from 'path';
-import { readFileSync, existsSync } from 'fs';
+import { OpenApiSpecification } from '../spec';
 
 import { Metadata } from './internal/metadata';
 import { CarrierSpecification } from './internal/carrier-specification';
@@ -44,15 +43,11 @@ export class CarrierApp implements ConnectRuntimeApp {
         c.DefaultSupportedCountries?.flatMap((sc) => sc.FromCountry),
       );
       const serviceCountries = definition.Metadata.Carriers.flatMap((c) =>
-        c.ShippingServices?.flatMap((s) => s.SupportedCountries).flatMap(
-          (sc) => sc?.FromCountry,
-        ),
+        c.ShippingServices?.flatMap((s) => s.SupportedCountries).flatMap((sc) => sc?.FromCountry),
       );
       countries.push(...rootCountries);
       countries.push(...serviceCountries);
-      const uniqueCountries = [...new Set(countries)].filter(
-        (c) => c !== undefined,
-      ) as string[];
+      const uniqueCountries = [...new Set(countries)].filter((c) => c !== undefined) as string[];
       return uniqueCountries;
     };
     this.validate = () => {
@@ -71,72 +66,43 @@ export class CarrierApp implements ConnectRuntimeApp {
         definition.CancelNotification,
         CancelNotificationResponseSchema,
       ],
-      [
-        Method.POST,
-        ApiEndpoints.CancelPickup,
-        definition.CancelPickup,
-        CancelPickupResponseSchema,
-      ],
-      [
-        Method.POST,
-        ApiEndpoints.CreateLabel,
-        definition.CreateLabel,
-        CreateLabelResponseSchema,
-      ],
+      [Method.POST, ApiEndpoints.CancelPickup, definition.CancelPickup, CancelPickupResponseSchema],
+      [Method.POST, ApiEndpoints.CreateLabel, definition.CreateLabel, CreateLabelResponseSchema],
       [
         Method.POST,
         ApiEndpoints.CreateManifest,
         definition.CreateManifest,
         CreateManifestResponseSchema,
       ],
+      [Method.POST, ApiEndpoints.GetManifest, definition.GetManifest, CreateManifestResponseSchema],
       [
         Method.POST,
         ApiEndpoints.CreateNotification,
         definition.CreateNotification,
         CreateNotificationResponseSchema,
       ],
-      [
-        Method.POST,
-        ApiEndpoints.GetRates,
-        definition.GetRates,
-        GetRatesResponseSchema,
-      ],
+      [Method.POST, ApiEndpoints.GetRates, definition.GetRates, GetRatesResponseSchema],
       [
         Method.POST,
         ApiEndpoints.NormalizeTrackingData,
         definition.NormalizeTrackingData,
         NormalizeTrackingDataResponseSchema,
       ],
-      [
-        Method.POST,
-        ApiEndpoints.Register,
-        definition.Register,
-        RegisterResponseSchema,
-      ],
+      [Method.POST, ApiEndpoints.Register, definition.Register, RegisterResponseSchema],
       [
         Method.POST,
         ApiEndpoints.SchedulePickup,
         definition.SchedulePickup,
         SchedulePickupResponseSchema,
       ],
-      [
-        Method.POST,
-        ApiEndpoints.Track,
-        definition.Track,
-        TrackingResponseSchema,
-      ],
+      [Method.POST, ApiEndpoints.Track, definition.Track, TrackingResponseSchema],
       [
         Method.POST,
         ApiEndpoints.ValidateInboundData,
         definition.ValidateInboundData,
         ValidateInboundDataResponseSchema,
       ],
-      [
-        Method.POST,
-        ApiEndpoints.VoidLabels,
-        definition.VoidLabels,
-        VoidLabelsResponseSchema,
-      ],
+      [Method.POST, ApiEndpoints.VoidLabels, definition.VoidLabels, VoidLabelsResponseSchema],
     ).forEach(([method, path, implementation, schema]) => {
       if (implementation) {
         this.routes.push({
@@ -147,23 +113,14 @@ export class CarrierApp implements ConnectRuntimeApp {
             const validationResults = schema.validate(result, {
               abortEarly: false,
             });
-            const errors = validationResults?.error?.details?.map(
-              (detail) => detail.message,
-            );
+            const errors = validationResults?.error?.details?.map((detail) => detail.message);
             return errors;
           },
         });
       }
     });
     this.data = new Metadata(definition);
-
-    const jsonSpecPath = resolve(__dirname, '../../spec.json');
-    const yamlSpecPath = resolve(__dirname, '../../spec.yaml');
-    if (existsSync(jsonSpecPath)) {
-      this.redoc = readFileSync(jsonSpecPath).toString();
-    } else if (existsSync(yamlSpecPath)) {
-      this.redoc = readFileSync(yamlSpecPath).toString();
-    }
+    this.redoc = JSON.stringify(OpenApiSpecification);
   }
   getImages(): BrandedImages[] {
     const mapBrandedImages = (carrier: CarrierSpecification): BrandedImages => {

package/src/app/constants.ts

@@ -4,6 +4,7 @@ export enum ApiEndpoints {
   VoidLabels = '/VoidLabels',
   GetRates = '/GetRates',
   CreateManifest = '/CreateManifest',
+  GetManifest = '/GetManifest',
   SchedulePickup = '/SchedulePickup',
   CancelPickup = '/CancelPickup',
   Track = '/Track',

package/src/app/internal/carrier-specification.ts

@@ -37,9 +37,7 @@ export const mapShippingOptions = (
   return ret;
 };
 
-export const mapConfirmationTypes = (
-  types?: ConfirmationDictionary,
-): ConfirmationType[] => {
+export const mapConfirmationTypes = (types?: ConfirmationDictionary): ConfirmationType[] => {
   if (!types) {
     return [];
   }
@@ -56,6 +54,23 @@ export const mapConfirmationTypes = (
   return ret;
 };
 
+const mapAccountModal = (modal: AccountModals): AccountModals => {
+  return {
+    RegistrationFormSchema: {
+      JsonSchema:
+        modal.RegistrationFormSchema.JsonSchema ??
+        modal.RegistrationFormSchema.formSchema?.jsonSchema,
+      UiSchema:
+        modal.RegistrationFormSchema.UiSchema ?? modal.RegistrationFormSchema.formSchema?.uiSchema,
+    },
+    SettingsFormSchema: {
+      JsonSchema:
+        modal.SettingsFormSchema.JsonSchema ?? modal.SettingsFormSchema.formSchema?.jsonSchema,
+      UiSchema: modal.SettingsFormSchema.UiSchema ?? modal.SettingsFormSchema.formSchema?.uiSchema,
+    },
+  };
+};
+
 /** @description This represents what we send to data manager */
 export class CarrierSpecification {
   Id: string;
@@ -84,16 +99,14 @@ export class CarrierSpecification {
     };
     this.Id = definition.Id;
     this.Name = definition.Name;
-    this.AccountModals = definition.AccountModals;
+    this.AccountModals = mapAccountModal(definition.AccountModals);
     this.PackageTypes = definition.PackageTypes;
     this.ShippingServices = definition.ShippingServices;
     this.ShippingOptions = mapShippingOptions(definition.ShippingOptions);
     this.DefaultSupportedCountries = definition.DefaultSupportedCountries;
     this.DefaultLabelSizes = definition.DefaultLabelSizes;
     this.LabelFormats = definition.LabelFormats;
-    this.DefaultConfirmationTypes = mapConfirmationTypes(
-      definition.DefaultConfirmationTypes,
-    );
+    this.DefaultConfirmationTypes = mapConfirmationTypes(definition.DefaultConfirmationTypes);
     this.CarrierAttributes = definition.CarrierAttributes;
     this.TrackingUrl = definition.TrackingUrl;
     this.CarrierUrl = definition.CarrierUrl;

package/src/app/internal/metadata.ts

@@ -30,6 +30,10 @@ const mapFunctions = (app: CarrierAppDefinition): FunctionSpecification[] => {
     fns.push(fn('CreateManifest'));
   }
 
+  if (app.GetManifest) {
+    fns.push(fn('GetManifest'));
+  }
+
   if (app.SchedulePickup) {
     fns.push(fn('SchedulePickup'));
   }
@@ -63,9 +67,7 @@ export class Metadata implements CarrierAppSpecification {
     if (this.AuthProcess) {
       this.AuthProcess.Identifier.Version = '2.0';
     }
-    this.Carriers = app.Metadata.Carriers.map(
-      (c) => new CarrierSpecification(c),
-    );
+    this.Carriers = app.Metadata.Carriers.map((c) => new CarrierSpecification(c));
 
     this.Connector = {
       DiagnosticRoutes: {

package/src/app/metadata/account-modals.ts

@@ -3,17 +3,23 @@ import Joi from 'joi';
 export interface AccountModals {
   /** @description Schema for the form to register with the carrier */
   RegistrationFormSchema: {
-    formSchema: {
+    /** @deprecated Please use JsonSchema & UiSchema */
+    formSchema?: {
       jsonSchema: object;
       uiSchema: object;
     };
+    JsonSchema?: object;
+    UiSchema?: object;
   };
   /** @description  Schema for the form to update carrier settings */
   SettingsFormSchema: {
-    formSchema: {
+    /** @deprecated Please use JsonSchema & UiSchema */
+    formSchema?: {
       jsonSchema: object;
       uiSchema: object;
     };
+    JsonSchema?: object;
+    UiSchema?: object;
   };
 }
 

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

@@ -1,10 +1,5 @@
 import Joi from 'joi';
-import {
-  AuthSpecification,
-  AuthSpecificationSchema,
-  Carrier,
-  CarrierSchema,
-} from '.';
+import { AuthSpecification, AuthSpecificationSchema, Carrier, CarrierSchema } from '.';
 
 export interface CarrierAppMetadata {
   /** @description Id of the carrier app */

package/src/app/metadata/carrier.ts

@@ -1,24 +1,12 @@
 import { AccountModals, AccountModalsSchema } from './account-modals';
 import { PackageType, PackageTypeSchema } from './package-type';
 import { ShippingService, ShippingServiceSchema } from './shipping-service';
-import {
-  ShippingOptionDictionary,
-  ShippingOptionDictionarySchema,
-} from './shipping-option';
-import {
-  CountryAssociation,
-  CountryAssociationSchema,
-} from './country-association';
-import {
-  CarrierAttributeEnum,
-  CarrierAttributeEnumSchema,
-} from './carrier-attributes';
+import { ShippingOptionDictionary, ShippingOptionDictionarySchema } from './shipping-option';
+import { CountryAssociation, CountryAssociationSchema } from './country-association';
+import { CarrierAttributeEnum, CarrierAttributeEnumSchema } from './carrier-attributes';
 import { LabelFormatsEnum, LabelFormatsEnumSchema } from './label-formats';
 import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
-import {
-  ConfirmationDictionary,
-  ConfirmationDictionarySchema,
-} from './confirmation-type';
+import { ConfirmationDictionary, ConfirmationDictionarySchema } from './confirmation-type';
 import { existsSync } from 'fs';
 import Joi from 'joi';
 
@@ -55,25 +43,16 @@ const fileExists = (value: string, helpers: any) => {
 export const CarrierSchema = Joi.object({
   AccountModals: AccountModalsSchema.required(),
   PackageTypes: Joi.array().optional().items(PackageTypeSchema).unique('Id'),
-  ShippingServices: Joi.array()
-    .optional()
-    .items(ShippingServiceSchema)
-    .unique('Id'),
+  ShippingServices: Joi.array().optional().items(ShippingServiceSchema).unique('Id'),
   ShippingOptions: ShippingOptionDictionarySchema.optional(),
   DefaultSupportedCountries: Joi.array()
     .optional()
     .items(CountryAssociationSchema)
     .unique('FromCountry'),
-  DefaultLabelSizes: Joi.array()
-    .optional()
-    .items(LabelSizesEnumSchema)
-    .unique(),
+  DefaultLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
   LabelFormats: Joi.array().optional().items(LabelFormatsEnumSchema).unique(),
   DefaultConfirmationTypes: ConfirmationDictionarySchema.optional(),
-  CarrierAttributes: Joi.array()
-    .optional()
-    .items(CarrierAttributeEnumSchema)
-    .unique(),
+  CarrierAttributes: Joi.array().optional().items(CarrierAttributeEnumSchema).unique(),
   TrackingUrl: Joi.string()
     .optional()
     .pattern(

package/src/app/metadata/label-formats.ts

@@ -6,6 +6,4 @@ export enum LabelFormatsEnum {
   PNG = 'PNG',
 }
 
-export const LabelFormatsEnumSchema = Joi.string().valid(
-  ...Object.values(LabelFormatsEnum),
-);
+export const LabelFormatsEnumSchema = Joi.string().valid(...Object.values(LabelFormatsEnum));

package/src/app/metadata/label-sizes.ts

@@ -5,6 +5,4 @@ export enum LabelSizesEnum {
   Inches4x8 = 'Inches4x8',
 }
 
-export const LabelSizesEnumSchema = Joi.string().valid(
-  ...Object.values(LabelSizesEnum),
-);
+export const LabelSizesEnumSchema = Joi.string().valid(...Object.values(LabelSizesEnum));

package/src/app/metadata/monoauth.ts

@@ -67,10 +67,7 @@ export class ResponseTransformationConfiguration {
   connection_context?: MapOfStrings;
 }
 
-export const MapOfStringsSchema = Joi.object().pattern(
-  Joi.string(),
-  Joi.string(),
-);
+export const MapOfStringsSchema = Joi.object().pattern(Joi.string(), Joi.string());
 
 export const ResponseTransformationConfigurationSchema = Joi.object({
   access_token: Joi.string().required(),

package/src/app/metadata/service-class.ts

@@ -12,6 +12,4 @@ export enum ServiceClassEnum {
   ThreeDay = 'ThreeDay',
 }
 
-export const ServiceClassEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceClassEnum),
-);
+export const ServiceClassEnumSchema = Joi.string().valid(...Object.values(ServiceClassEnum));

package/src/app/metadata/service-grade.ts

@@ -9,6 +9,4 @@ export enum ServiceGradeEnum {
   Standard = 'Standard',
 }
 
-export const ServiceGradeEnumSchema = Joi.string().valid(
-  ...Object.values(ServiceGradeEnum),
-);
+export const ServiceGradeEnumSchema = Joi.string().valid(...Object.values(ServiceGradeEnum));