@shipengine/connect-carrier-api 2.2.3 → 2.3.2

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,18 +66,8 @@ 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,
@@ -95,48 +80,28 @@ export class CarrierApp implements ConnectRuntimeApp {
         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 +112,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/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

@@ -63,9 +63,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';
 
@@ -37,6 +25,7 @@ export interface Carrier {
   CarrierUrl?: string;
   Description?: string;
   Name: string;
+  ApiCode?: string;
   Id: string;
   Images: {
     Logo: string;
@@ -54,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(
@@ -84,6 +64,9 @@ export const CarrierSchema = Joi.object({
   CarrierUrl: Joi.string().optional().uri().max(200),
   Description: Joi.string().optional().max(250),
   Name: Joi.string().required().max(50),
+  ApiCode: Joi.string()
+    .optional()
+    .pattern(/^[a-z][a-z0-9_]*[a-z]$/, 'ApiCode'),
   Id: Joi.string()
     .uuid({ version: ['uuidv4'] })
     .required(),

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/package-type.ts

@@ -9,6 +9,7 @@ export enum RequiredToShipEnum {
 export interface PackageType {
   Id: string;
   Name: string;
+  ApiCode?: string;
   CarrierPackageTypeCode: string;
   Description?: string;
   Abbreviation?: string;
@@ -27,6 +28,9 @@ export const PackageTypeSchema = Joi.object({
     .uuid({ version: ['uuidv4'] })
     .required(),
   Name: Joi.string().required().max(50),
+  ApiCode: Joi.string()
+    .optional()
+    .pattern(/^[a-z][a-z0-9_]*[a-z]$/, 'ApiCode'),
   CarrierPackageTypeCode: Joi.string().required().max(50),
   Description: Joi.string().optional().max(500),
   Abbreviation: Joi.string().optional().max(20),

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));

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

@@ -1,12 +1,6 @@
 import { ConfirmationType, ConfirmationTypeSchema } from './confirmation-type';
-import {
-  CountryAssociation,
-  CountryAssociationSchema,
-} from './country-association';
-import {
-  ServiceAttributesEnum,
-  ServiceAttributesEnumSchema,
-} from './services-attributes';
+import { CountryAssociation, CountryAssociationSchema } from './country-association';
+import { ServiceAttributesEnum, ServiceAttributesEnumSchema } from './services-attributes';
 import { LabelSizesEnum, LabelSizesEnumSchema } from './label-sizes';
 import { ServiceClassEnum, ServiceClassEnumSchema } from './service-class';
 import { ServiceGradeEnum, ServiceGradeEnumSchema } from './service-grade';
@@ -30,27 +24,16 @@ export interface ShippingService {
   Code: string;
   Abbreviation?: string;
   Name: string;
+  ApiCode?: string;
   Id: string;
 }
 
 export const ShippingServiceSchema = Joi.object({
-  ConfirmationTypes: Joi.array()
-    .optional()
-    .items(ConfirmationTypeSchema)
-    .unique('Type'),
+  ConfirmationTypes: Joi.array().optional().items(ConfirmationTypeSchema).unique('Type'),
   ServiceAttributes: Joi.array().items(ServiceAttributesEnumSchema).optional(),
-  SupportedCountries: Joi.array()
-    .optional()
-    .items(CountryAssociationSchema)
-    .unique('FromCountry'),
-  SupportedLabelSizes: Joi.array()
-    .optional()
-    .items(LabelSizesEnumSchema)
-    .unique(),
-  RequiredProperties: Joi.array()
-    .optional()
-    .items(ServiceRequiredPropertiesEnumSchema)
-    .unique(),
+  SupportedCountries: Joi.array().optional().items(CountryAssociationSchema).unique('FromCountry'),
+  SupportedLabelSizes: Joi.array().optional().items(LabelSizesEnumSchema).unique(),
+  RequiredProperties: Joi.array().optional().items(ServiceRequiredPropertiesEnumSchema).unique(),
   Grade: ServiceGradeEnumSchema.optional(),
   Class: ServiceClassEnumSchema.optional(),
   LabelCode: Joi.string().optional().max(50),
@@ -58,6 +41,9 @@ export const ShippingServiceSchema = Joi.object({
   Code: Joi.string().required().max(50),
   Abbreviation: Joi.string().optional().max(20),
   Name: Joi.string().required().max(80),
+  ApiCode: Joi.string()
+    .optional()
+    .pattern(/^[a-z][a-z0-9_]*[a-z]$/, 'ApiCode'),
   Id: Joi.string()
     .uuid({ version: ['uuidv4'] })
     .required(),

package/src/index.ts

@@ -5,3 +5,5 @@ export * as responses from './responses';
 export * from './requests';
 export * from './responses';
 export * from './app';
+export * from './models';
+export * from './spec';

package/src/models/billing/billing-categories.ts

@@ -26,6 +26,4 @@ export enum BillingCategories {
   Tip = 'tip',
 }
 
-export const BillingCategoriesSchema = Joi.string().valid(
-  ...Object.values(BillingCategories),
-);
+export const BillingCategoriesSchema = Joi.string().valid(...Object.values(BillingCategories));

package/src/models/billing/billing-line-item.ts

@@ -1,7 +1,4 @@
-import {
-  BillingCategories,
-  BillingCategoriesSchema,
-} from './billing-categories';
+import { BillingCategories, BillingCategoriesSchema } from './billing-categories';
 import { Currency, CurrencySchema } from '../currency';
 import Joi from 'joi';
 

package/src/models/documents/document-type.ts

@@ -12,6 +12,4 @@ export enum DocumentType {
   BillOfLading = 'bill_of_lading',
 }
 
-export const DocumentTypeSchema = Joi.string().valid(
-  ...Object.values(DocumentType),
-);
+export const DocumentTypeSchema = Joi.string().valid(...Object.values(DocumentType));

package/src/models/documents/document.ts

@@ -1,8 +1,5 @@
 import { DocumentType, DocumentTypeSchema } from './document-type';
-import {
-  DocumentFormat,
-  DocumentFormatSchema,
-} from '../labels/document-formats';
+import { DocumentFormat, DocumentFormatSchema } from '../labels/document-formats';
 import Joi from 'joi';
 
 /** @description Basic structure for a document */

package/src/models/labels/document-formats.ts

@@ -6,6 +6,4 @@ export enum DocumentFormat {
   Zpl = 'ZPL',
   Png = 'PNG',
 }
-export const DocumentFormatSchema = Joi.string().valid(
-  ...Object.values(DocumentFormat),
-);
+export const DocumentFormatSchema = Joi.string().valid(...Object.values(DocumentFormat));

package/src/models/pickup/pickup-confirmation.ts

@@ -1,9 +1,6 @@
 import Joi from 'joi';
 import { Identifier, IdentifierSchema } from '../identifier';
-import {
-  ShipmentIdentifier,
-  ShipmentIdentifierSchema,
-} from './shipment-identifier';
+import { ShipmentIdentifier, ShipmentIdentifierSchema } from './shipment-identifier';
 
 /** @description Basic structure for a pickup confirmation */
 export class PickupConfirmation {

package/src/models/rates/rate.ts

@@ -1,8 +1,5 @@
 import Joi from 'joi';
-import {
-  BillingLineItem,
-  BillingLineItemSchema,
-} from '../billing/billing-line-item';
+import { BillingLineItem, BillingLineItemSchema } from '../billing/billing-line-item';
 import { TimeWindow, TimeWindowSchema } from '../time-window';
 
 /** @description Basic structure for a rate */

package/src/models/tracking/update-method.ts

@@ -8,6 +8,4 @@ export enum UpdateMethods {
   Replace = 'replace',
 }
 
-export const UpdateMethodsSchema = Joi.string().valid(
-  ...Object.values(UpdateMethods),
-);
+export const UpdateMethodsSchema = Joi.string().valid(...Object.values(UpdateMethods));

package/src/responses/normalize-tracking-data-response.ts

@@ -1,10 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  UpdateMethods,
-  TrackingInfo,
-  TrackingInfoSchema,
-  UpdateMethodsSchema,
-} from '../models';
+import { UpdateMethods, TrackingInfo, TrackingInfoSchema, UpdateMethodsSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to normalize inbound tracking data */

package/src/responses/validate-inbound-data-response.ts

@@ -1,8 +1,5 @@
 import { BaseResponse, BaseResponseSchema } from './base-response';
-import {
-  InboundDataContentTypes,
-  InboundDataContentTypesSchema,
-} from '../models';
+import { InboundDataContentTypes, InboundDataContentTypesSchema } from '../models';
 import Joi from 'joi';
 
 /** @description Basic structure for a response to validate inbound data */

package/src/spec.ts

@@ -0,0 +1,5 @@
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+const jsonSpecPath = resolve(__dirname, '../spec.json');
+
+export const OpenApiSpecification = JSON.parse(readFileSync(jsonSpecPath, 'utf-8'));