@shipengine/connect-carrier-api 2.9.1 → 2.11.0-beta

package/lib/app/metadata/shipping-service.js

@@ -10,6 +10,7 @@ const service_class_1 = require("./service-class");
 const service_grade_1 = require("./service-grade");
 const service_required_properties_1 = require("./service-required-properties");
 const joi_1 = tslib_1.__importDefault(require("joi"));
+const connect_runtime_1 = require("@shipengine/connect-runtime");
 exports.ShippingServiceSchema = joi_1.default.object({
     ConfirmationTypes: joi_1.default.array().optional().items(confirmation_type_1.ConfirmationTypeSchema).unique('Type'),
     ServiceAttributes: joi_1.default.array().items(services_attributes_1.ServiceAttributesEnumSchema).optional(),
@@ -23,9 +24,7 @@ exports.ShippingServiceSchema = joi_1.default.object({
     Code: joi_1.default.string().required().max(50),
     Abbreviation: joi_1.default.string().required().max(20),
     Name: joi_1.default.string().required().max(80),
-    ApiCode: joi_1.default.string()
-        .optional()
-        .pattern(/^[a-z][a-z0-9_]*[a-z]$/, 'ApiCode'),
+    ApiCode: joi_1.default.string().optional().pattern(connect_runtime_1.ApiCodeRegex, connect_runtime_1.ApiCodeValidationMessage),
     Id: joi_1.default.string().uuid().required(),
 });
 //# sourceMappingURL=shipping-service.js.map

package/lib/app/metadata/shipping-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-service.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-service.ts"],"names":[],"mappings":";;;;AAAA,2DAA+E;AAC/E,+DAAqF;AACrF,+DAA2F;AAC3F,+CAAqE;AACrE,mDAA2E;AAC3E,mDAA2E;AAC3E,+EAGuC;AACvC,sDAAsB;AAkCT,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0CAAsB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IACtF,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,iDAA2B,CAAC,CAAC,QAAQ,EAAE;IAC5E,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8CAAwB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;IAChG,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAChF,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iEAAmC,CAAC,CAAC,MAAM,EAAE;IAC9F,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1C,aAAa,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,aAAG,CAAC,MAAM,EAAE;SAClB,QAAQ,EAAE;SACV,OAAO,CAAC,wBAAwB,EAAE,SAAS,CAAC;IAC/C,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC"}
+{"version":3,"file":"shipping-service.js","sourceRoot":"","sources":["../../../src/app/metadata/shipping-service.ts"],"names":[],"mappings":";;;;AAAA,2DAA+E;AAC/E,+DAAqF;AACrF,+DAA2F;AAC3F,+CAAqE;AACrE,mDAA2E;AAC3E,mDAA2E;AAC3E,+EAGuC;AACvC,sDAAsB;AAEtB,iEAAqF;AAkCxE,QAAA,qBAAqB,GAAG,aAAG,CAAC,MAAM,CAAC;IAC9C,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,0CAAsB,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IACtF,iBAAiB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,iDAA2B,CAAC,CAAC,QAAQ,EAAE;IAC5E,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,8CAAwB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;IAChG,mBAAmB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,kCAAoB,CAAC,CAAC,MAAM,EAAE;IAChF,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,iEAAmC,CAAC,CAAC,MAAM,EAAE;IAC9F,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,sCAAsB,CAAC,QAAQ,EAAE;IACxC,SAAS,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1C,aAAa,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChD,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,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;CACnC,CAAC,CAAC"}

package/lib/app/native-rating/base-rate-context.d.ts

@@ -0,0 +1,3 @@
+import { RatingContext } from './rating-context';
+import { RateCard } from '../metadata/rate-card';
+export declare const createContextBuilder: (basePath: string) => (rateCard: RateCard) => RatingContext;

package/lib/app/native-rating/base-rate-context.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createContextBuilder = void 0;
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const winston_1 = tslib_1.__importStar(require("winston"));
+/** Predicate that returns true if the value is defined, false if not */
+const valueIsUndefined = ([key, value]) => {
+    const isIncluded = value !== undefined;
+    console.log(`${isIncluded ? '✔️' : '❌'} ${key}`);
+    return isIncluded;
+};
+/** Build a lookup function to find values for a list of keys */
+const buildLookup = (name, items, mapper) => (keys) => {
+    console.log(`Getting ${name} keys (${keys.length} total):`);
+    console.group();
+    try {
+        const things = keys.map((key) => {
+            var _a;
+            const foundValue = (_a = items.find((item) => key === item.key)) === null || _a === void 0 ? void 0 : _a.value;
+            const mappedValue = foundValue && mapper ? mapper(foundValue) : foundValue;
+            return [key, mappedValue];
+        });
+        const values = Object.fromEntries(things.filter(valueIsUndefined));
+        return Promise.resolve(values);
+    }
+    finally {
+        console.groupEnd();
+    }
+};
+const loadData = (basePath) => (dataType) => {
+    try {
+        const data = fs_1.readFileSync(path_1.resolve(basePath, `${dataType}.json`));
+        const json = JSON.parse(data.toString());
+        return [dataType, (json === null || json === void 0 ? void 0 : json[dataType]) || []];
+    }
+    catch (err) {
+        return [dataType, []];
+    }
+};
+const createContextBuilder = (basePath) => {
+    let zoneLookup;
+    const getZoneLookup = () => {
+        if (!zoneLookup) {
+            const zones = loadData(basePath)('zones')[1];
+            zoneLookup = buildLookup('zone', zones);
+        }
+        return zoneLookup;
+    };
+    const log = winston_1.default.createLogger({
+        format: winston_1.format.combine(winston_1.format.colorize(), winston_1.format.timestamp(), winston_1.format.metadata()),
+        transports: [new winston_1.transports.Console({ level: 'debug' })],
+    });
+    return (rateCard) => {
+        let dataLookup;
+        const getDataLookup = () => {
+            if (!dataLookup) {
+                const loadedData = Object.fromEntries(['rates', 'variables'].map(loadData(path_1.resolve(basePath, rateCard.Id))));
+                dataLookup = {
+                    rates: buildLookup('rate', loadedData.rates, (x) => ({
+                        amount: +x,
+                        currency: rateCard.Currency,
+                    })),
+                    variables: buildLookup('variables', loadedData.variables),
+                };
+            }
+            return dataLookup;
+        };
+        return {
+            getRates: (keys) => getDataLookup().rates(keys),
+            getVariables: (keys) => getDataLookup().variables(keys),
+            getZone: (keys) => getZoneLookup()(keys),
+            log,
+        };
+    };
+};
+exports.createContextBuilder = createContextBuilder;
+//# sourceMappingURL=base-rate-context.js.map

package/lib/app/native-rating/base-rate-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-rate-context.js","sourceRoot":"","sources":["../../../src/app/native-rating/base-rate-context.ts"],"names":[],"mappings":";;;;AAAA,+BAA+B;AAC/B,2BAAkC;AAClC,2DAAsD;AAYtD,wEAAwE;AACxE,MAAM,gBAAgB,GAAG,CAAI,CAAC,GAAG,EAAE,KAAK,CAA0B,EAAW,EAAE;IAC7E,MAAM,UAAU,GAAG,KAAK,KAAK,SAAS,CAAC;IAEvC,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,CAAC;IAEjD,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,gEAAgE;AAChE,MAAM,WAAW,GACf,CAAY,IAAY,EAAE,KAAoC,EAAE,MAA4B,EAAE,EAAE,CAChG,CAAC,IAAc,EAAwC,EAAE;IACvD,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,UAAU,IAAI,CAAC,MAAM,UAAU,CAAC,CAAC;IAC5D,OAAO,CAAC,KAAK,EAAE,CAAC;IAChB,IAAI;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;;YAC9B,MAAM,UAAU,GAAG,MAAA,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,0CAAE,KAAK,CAAC;YACjE,MAAM,WAAW,GAAG,UAAU,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAC3E,OAAO,CAAC,GAAG,EAAE,WAAW,CAA+B,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAEhE,CAAC;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;KAChC;YAAS;QACR,OAAO,CAAC,QAAQ,EAAE,CAAC;KACpB;AACH,CAAC,CAAC;AAEJ,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC,QAAgB,EAAE,EAAE;IAC1D,IAAI;QACF,MAAM,IAAI,GAAG,iBAAY,CAAC,cAAO,CAAC,QAAQ,EAAE,GAAG,QAAQ,OAAO,CAAC,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,OAAO,CAAC,QAAQ,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAG,QAAQ,CAAC,KAAI,EAAE,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KACvB;AACH,CAAC,CAAC;AAEK,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvD,IAAI,UAAsB,CAAC;IAC3B,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,UAAU,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAEF,MAAM,GAAG,GAAG,iBAAO,CAAC,YAAY,CAAC;QAC/B,MAAM,EAAE,gBAAM,CAAC,OAAO,CAAC,gBAAM,CAAC,QAAQ,EAAE,EAAE,gBAAM,CAAC,SAAS,EAAE,EAAE,gBAAM,CAAC,QAAQ,EAAE,CAAC;QAChF,UAAU,EAAE,CAAC,IAAI,oBAAU,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;KACzD,CAAC,CAAC;IAEH,OAAO,CAAC,QAAkB,EAAiB,EAAE;QAC3C,IAAI,UAAsB,CAAC;QAC3B,MAAM,aAAa,GAAG,GAAG,EAAE;YACzB,IAAI,CAAC,UAAU,EAAE;gBACf,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CACnC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CACrE,CAAC;gBAEF,UAAU,GAAG;oBACX,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;wBACxD,MAAM,EAAE,CAAC,CAAC;wBACV,QAAQ,EAAE,QAAQ,CAAC,QAAQ;qBAC5B,CAAC,CAAC;oBACH,SAAS,EAAE,WAAW,CAAC,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC;iBAC1D,CAAC;aACH;YACD,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;QAEF,OAAO;YACL,QAAQ,EAAE,CAAC,IAAc,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;YACzD,YAAY,EAAE,CAAC,IAAc,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;YACjE,OAAO,EAAE,CAAC,IAAc,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC;YAClD,GAAG;SACJ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAzCW,QAAA,oBAAoB,wBAyC/B"}

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

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

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

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

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

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

package/lib/app/native-rating/create-dynamic-carrier.d.ts

@@ -0,0 +1,7 @@
+import { RatingCarrier } from './implementation-type';
+/** Create a dynamic carrier
+ * @param code Code that should be used for the carrier
+ * @returns Carrier with code ready to be executed
+ */
+declare const createDynamicCarrier: (code: string) => RatingCarrier;
+export default createDynamicCarrier;

package/lib/app/native-rating/create-dynamic-carrier.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vm2_1 = require("vm2");
+/** Ensure that the carrier module has the correct shape
+ * @param module Object into which code should be exported
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const validateCode = (module) => {
+    var _a;
+    if (((_a = module === null || module === void 0 ? void 0 : module.exports) === null || _a === void 0 ? void 0 : _a.default) === undefined) {
+        return {
+            errors: ['Code must have a default export'],
+            hasGetZonesFunction: false,
+        };
+    }
+    const errors = [];
+    const { rateShipments, getZones } = module.exports.default;
+    const hasGetZonesFunction = getZones !== undefined;
+    if (typeof rateShipments !== 'function') {
+        errors.push("Code must contain a function named 'rateShipments'");
+    }
+    else if (rateShipments.length !== 2) {
+        errors.push("'rateShipments' function must have two parameters");
+    }
+    return {
+        errors,
+        hasGetZonesFunction,
+    };
+};
+/** Create a dynamic carrier
+ * @param code Code that should be used for the carrier
+ * @returns Carrier with code ready to be executed
+ */
+const createDynamicCarrier = (code) => {
+    var _a;
+    // This is to make sure that the code we need to run doesn't get excluded because of dangling comments, etc.
+    const resetCode = code + ';\n /* */ \n';
+    const validationResults = new vm2_1.VM({
+        sandbox: { module: {}, validateCode },
+    }).run(`${resetCode}; validateCode(module);`);
+    if (((_a = validationResults.errors) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+        throw new Error(validationResults.errors.join('; '));
+    }
+    const rateShipmentsScript = new vm2_1.VMScript(`${resetCode} module.exports.default.rateShipments(context, shipment);`);
+    const executionVM = new vm2_1.VM({
+        sandbox: {
+            module: {},
+            context: {},
+            shipment: {},
+            zoneContext: {},
+            origin: {},
+            destination: {},
+        },
+    });
+    const carrier = {
+        rateShipments: (context, shipment) => {
+            return executionVM.setGlobals({ context, shipment }).run(rateShipmentsScript);
+        },
+    };
+    return carrier;
+};
+exports.default = createDynamicCarrier;
+//# sourceMappingURL=create-dynamic-carrier.js.map

package/lib/app/native-rating/create-dynamic-carrier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-dynamic-carrier.js","sourceRoot":"","sources":["../../../src/app/native-rating/create-dynamic-carrier.ts"],"names":[],"mappings":";;AAAA,6BAAmC;AAWnC;;GAEG;AACH,8DAA8D;AAC9D,MAAM,YAAY,GAAG,CAAC,MAAY,EAAyB,EAAE;;IAC3D,IAAI,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,0CAAE,OAAO,MAAK,SAAS,EAAE;QAC1C,OAAO;YACL,MAAM,EAAE,CAAC,iCAAiC,CAAC;YAC3C,mBAAmB,EAAE,KAAK;SAC3B,CAAC;KACH;IAED,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAC3D,MAAM,mBAAmB,GAAG,QAAQ,KAAK,SAAS,CAAC;IAEnD,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;QACvC,MAAM,CAAC,IAAI,CAAC,oDAAoD,CAAC,CAAC;KACnE;SAAM,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAC;KAClE;IAED,OAAO;QACL,MAAM;QACN,mBAAmB;KACpB,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAiB,EAAE;;IAC3D,4GAA4G;IAC5G,MAAM,SAAS,GAAG,IAAI,GAAG,cAAc,CAAC;IAExC,MAAM,iBAAiB,GAAG,IAAI,QAAE,CAAC;QAC/B,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE;KACtC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,yBAAyB,CAAC,CAAC;IAC9C,IAAI,CAAA,MAAA,iBAAiB,CAAC,MAAM,0CAAE,MAAM,IAAG,CAAC,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;KACtD;IAED,MAAM,mBAAmB,GAAG,IAAI,cAAQ,CACtC,GAAG,SAAS,2DAA2D,CACxE,CAAC;IAEF,MAAM,WAAW,GAAG,IAAI,QAAE,CAAC;QACzB,OAAO,EAAE;YACP,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,EAAE;YACf,MAAM,EAAE,EAAE;YACV,WAAW,EAAE,EAAE;SAChB;KACF,CAAC,CAAC;IAEH,MAAM,OAAO,GAAkB;QAC7B,aAAa,EAAE,CACb,OAAsB,EACtB,QAAyB,EACI,EAAE;YAC/B,OAAO,WAAW,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAChF,CAAC;KACF,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,kBAAe,oBAAoB,CAAC"}

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

@@ -0,0 +1,7 @@
+import { ContextResults } from './context-results';
+import { NumericCurrency } from './numeric-currency';
+export declare type GetRatesResults = ContextResults<NumericCurrency>;
+/** Function to get rates from the context */
+export interface GetRates {
+    (dataKeys: string[]): Promise<GetRatesResults>;
+}

package/lib/app/native-rating/get-rates.js

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

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

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

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

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

package/lib/app/native-rating/get-variables.js

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,31 @@
+import { Rate } from '../../models/rates';
+import { GetRatesRequest } from '../../requests/get-rates-request';
+import { RatingContext } from './rating-context';
+/** A rate request shipment with its corresponding id */
+export interface ShipmentAndId {
+    /** rate_request_identifier for the rate request */
+    id: string;
+    /** Shipment for the rate request */
+    shipment: GetRatesRequest;
+}
+/** Rate results with its corresponding rate request id */
+export interface RateResultsAndId {
+    /** rate_request_identifier for the corresponding rate request */
+    id: string;
+    /** Error, if any */
+    error?: unknown;
+    /** Rates for a given rate request */
+    rates: Rate[];
+}
+/** Implementation of a carrier */
+export interface RatingCarrier {
+    /** Rate shipments
+     * @param context Native Rating context that can be used by the implementation to interact with the underlying service
+     * @param shipment Shipments that should be rated
+     * @returns List of rates for the given shipments
+     */
+    rateShipments: (context: RatingContext, shipment: ShipmentAndId[]) => Promise<RateResultsAndId[]>;
+}
+/** Signify a validation error from the carrier */
+export declare class CarrierValidationError extends Error {
+}

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

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

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

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

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

@@ -0,0 +1,2 @@
+export * from './rating-context';
+export * from './implementation-type';

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/app/native-rating/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,gEAAsC"}

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

@@ -0,0 +1,5 @@
+/** NumericCurrency so that we don't have to convert from the string Currency all over the place */
+export interface NumericCurrency {
+    currency: string;
+    amount: number | undefined;
+}

package/lib/app/native-rating/numeric-currency.js

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

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

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

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

@@ -0,0 +1,15 @@
+import { Logger } from 'winston';
+import { GetVariables } from './get-variables';
+import { GetRates } from './get-rates';
+import { GetZone } from './get-zone';
+/** Rates request context */
+export interface RatingContext {
+    /** Function to get rates for given keys */
+    getRates: GetRates;
+    /** Function to get variables for given keys */
+    getVariables: GetVariables;
+    /** Function to get zone for given keys */
+    getZone: GetZone;
+    /** Logger that implementers can use */
+    log: Logger;
+}

package/lib/app/native-rating/rating-context.js

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

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

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

package/lib/models/rates/rate.d.ts

@@ -25,7 +25,9 @@ export declare class Rate {
     carrier_rate_id?: string;
     /** @description DateTime after which the rate will no longer be accepted. ISO 8601 format, with local offset. Example: 2021-08-20T14:38:36.859237-05:00 */
     expiration_datetime?: string;
-    /** @description Estimated delivery text. It could be any text, a number, a date, etc. */
-    estimated_delivery_text?: string;
+    /** @description The Package type of this rate */
+    package_type?: string;
+    /** @description The zone this rate is for */
+    zone?: string;
 }
 export declare const RateSchema: Joi.ObjectSchema<any>;

package/lib/models/rates/rate.js

@@ -21,6 +21,7 @@ exports.RateSchema = joi_1.default.object({
     delivery_window: time_window_1.TimeWindowSchema.optional(),
     carrier_rate_id: joi_1.default.string().optional().empty(),
     expiration_datetime: joi_1.default.string().optional().empty().isoDate(),
-    estimated_delivery_text: joi_1.default.string().optional().empty(),
+    package_type: joi_1.default.string().optional().empty(),
+    zone: joi_1.default.string().optional().empty(),
 });
 //# sourceMappingURL=rate.js.map

package/lib/models/rates/rate.js.map

@@ -1 +1 @@
-{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oEAAsF;AACtF,gDAA8D;AAE9D,8CAA8C;AAC9C,MAAa,IAAI;CAyBhB;AAzBD,oBAyBC;AAEY,QAAA,UAAU,GAAG,aAAG,CAAC,MAAM,CAAC;IACnC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACxD,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAqB,CAAC;IACvE,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC1D,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC5D,eAAe,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACzC,qBAAqB,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC9D,uBAAuB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACzD,CAAC,CAAC"}
+{"version":3,"file":"rate.js","sourceRoot":"","sources":["../../../src/models/rates/rate.ts"],"names":[],"mappings":";;;;AAAA,sDAAsB;AACtB,oEAAsF;AACtF,gDAA8D;AAE9D,8CAA8C;AAC9C,MAAa,IAAI;CA2BhB;AA3BD,oBA2BC;AAEY,QAAA,UAAU,GAAG,aAAG,CAAC,MAAM,CAAC;IACnC,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,aAAa,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACxD,2BAA2B,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IACtE,kBAAkB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,yCAAqB,CAAC;IACvE,cAAc,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC1D,gBAAgB,EAAE,aAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC;IAC5D,eAAe,EAAE,aAAG,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACzC,qBAAqB,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,8BAAgB,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAChD,mBAAmB,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE;IAC9D,YAAY,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;IAC7C,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE;CACtC,CAAC,CAAC"}

package/lib/models/shipment-item.d.ts

@@ -0,0 +1,7 @@
+/** And item that is part of a shipment */
+export interface ShipmentItem {
+    /** Sku of the item */
+    sku?: string;
+    /** Quantity of the item */
+    quantity?: number;
+}

package/lib/models/shipment-item.js

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

package/lib/models/shipment-item.js.map

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

package/lib/requests/get-rates-request.d.ts

@@ -1,5 +1,6 @@
 import { BaseRequest } from './base-request';
 import { ConfirmationTypes, AdvancedOptions, InsuranceProviders, Package, Customs, ShipFrom, ShipTo, PudoLocation, FulfillmentPlanDetails, TimeWindow } from '../models';
+import { ShipmentItem } from '../models/shipment-item';
 /** @description Basic structure for a request to get rates */
 export declare class GetRatesRequest extends BaseRequest {
     service_code?: string;
@@ -18,4 +19,6 @@ export declare class GetRatesRequest extends BaseRequest {
     fulfillment_plan_details?: FulfillmentPlanDetails;
     /** @description The carrier pickup window is the time designated when the carrier will pickup your package from the initial location */
     carrier_pickup_window?: TimeWindow;
+    /** Items included in the shipment */
+    items?: ShipmentItem[];
 }

package/lib/requests/get-rates-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAc7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAiB/C;AAjBD,0CAiBC"}
+{"version":3,"file":"get-rates-request.js","sourceRoot":"","sources":["../../src/requests/get-rates-request.ts"],"names":[],"mappings":";;;AAAA,iDAA6C;AAe7C,8DAA8D;AAC9D,MAAa,eAAgB,SAAQ,0BAAW;CAmB/C;AAnBD,0CAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/connect-carrier-api",
-  "version": "2.9.1",
+  "version": "2.11.0-beta",
   "description": "This is the typescript/javascript definitions for carrier api",
   "homepage": "https://github.com/ShipEngine/connect",
   "main": "./lib/index.js",
@@ -36,8 +36,14 @@
     "typescript": "^4.3.5",
     "vitest": "^0.23.4"
   },
+  "optionalDependencies": {
+    "vm2": "^3.9.5"
+  },
   "dependencies": {
     "joi": "^17.4.2",
     "tslib": "^2.3.1"
+  },
+  "peerDependencies": {
+    "@shipengine/connect-runtime": "^1.3.0-beta"
   }
 }

package/spec.json

@@ -956,7 +956,6 @@
           },
           "tip": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -1072,7 +1071,6 @@
           },
           "amount": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -1677,7 +1675,6 @@
           },
           "buyer_shipping_amount_paid": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -1693,7 +1690,6 @@
           },
           "duties_paid": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -1739,7 +1735,6 @@
           },
           "value": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -2528,7 +2523,6 @@
           },
           "insured_value": {
             "required": ["currency", "amount"],
-            "type": "object",
             "properties": {
               "amount": {
                 "type": "string",
@@ -2783,12 +2777,6 @@
             "description": "DateTime after which the rate will no longer be accepted. (ISO 8601 format, with local offset)",
             "format": "date-time",
             "example": "2021-08-20T14:38:36.859237-05:00"
-          },
-          "estimated_delivery_text": {
-            "type": "string",
-            "description": "Estimated delivery text. It could be any text, a number, a date, etc.",
-            "example": "Monday by 11:00 PM",
-            "nullable": true
           }
         },
         "additionalProperties": false,

package/src/app/build-native-rating-routes.ts

@@ -0,0 +1,117 @@
+import { resolve } from 'path';
+import { stat } from 'fs/promises';
+import { Request } from 'express';
+import { Method, Route } from './internal/route';
+import { CarrierAppMetadata } from './metadata/carrier-app-metadata';
+import { rateLogicName } from './create-get-rates-handler';
+import { RateCard } from './metadata/rate-card';
+
+const buildFilePath = async (path: string, fileName: string, error: string) => {
+  const filePath = resolve(path, fileName);
+
+  try {
+    await stat(filePath);
+    return filePath;
+  } catch {
+    throw new Error(error);
+  }
+};
+
+export const buildNativeRatingRoutes = (metadata: CarrierAppMetadata): Route[] => {
+  const getCarrierDetails = async (
+    req: Request,
+  ): Promise<{ path: string; rateCards: RateCard[] }> => {
+    const carrierId = req.params.carrier_id;
+    const carrier = metadata.Carriers.find((x) => x.Id === carrierId);
+    if (!carrier) {
+      throw new Error(`Could not find carrier with id ${carrierId}`);
+    }
+
+    if (!carrier.NativeRating) {
+      throw new Error(`Carrier ${carrierId} does not have a NativeRating property`);
+    }
+
+    if (!carrier.NativeRating.Path) {
+      throw new Error(`Carrier ${carrierId} does not have NativeRating path set`);
+    }
+
+    try {
+      await stat(carrier.NativeRating.Path);
+    } catch {
+      throw new Error(`Carrier ${carrierId} does not have NativeRating data`);
+    }
+
+    return {
+      path: carrier.NativeRating.Path,
+      rateCards: carrier.NativeRating.RateCards || [],
+    };
+  };
+
+  const getRateCardPath = async (req: Request): Promise<string> => {
+    const rateCardId = req.params.id;
+    const { path, rateCards } = await getCarrierDetails(req);
+
+    if (!rateCards.find((x) => x.Id === rateCardId)) {
+      throw new Error(`Could not find a rate card with id ${rateCardId}`);
+    }
+
+    const rateCardPath = resolve(path, rateCardId);
+
+    try {
+      await stat(rateCardPath);
+    } catch {
+      throw new Error(`Rate card does not have any data`);
+    }
+
+    return rateCardPath;
+  };
+
+  return [
+    {
+      path: '/NativeRating/:carrier_id/RateCards',
+      method: Method.GET,
+      handler: async (req: Request) => {
+        const { rateCards } = await getCarrierDetails(req);
+        return rateCards.map((x) => ({ Id: x.Id, Currency: x.Currency }));
+      },
+    },
+    {
+      path: '/NativeRating/:carrier_id/RateCards/:id/Implementation',
+      method: Method.GET,
+      handler: async (req: any) => {
+        const path = await getRateCardPath(req);
+        const code = await buildFilePath(path, rateLogicName, `Could not find rating logic`);
+        return { code };
+      },
+    },
+    ...['Rates', 'Variables'].map((x) => ({
+      path: `/NativeRating/:carrier_id/RateCards/:id/${x}`,
+      method: Method.GET,
+      file: async (req: any) => {
+        const path = await getRateCardPath(req);
+        return await buildFilePath(
+          path,
+          `${x.toLowerCase()}.json`,
+          `Could not find ${x.toLowerCase()}`,
+        );
+      },
+    })),
+    {
+      path: '/NativeRating/:carrier_id/Implementation',
+      method: Method.GET,
+      handler: async (req: any) => {
+        const { path } = await getCarrierDetails(req);
+        const code = await buildFilePath(path, rateLogicName, `Could not find rating logic`);
+        return { code };
+      },
+    },
+    {
+      path: '/NativeRating/:carrier_id/Zones',
+      method: Method.GET,
+      file: async (req: any) => {
+        const { path } = await getCarrierDetails(req);
+        return await buildFilePath(path, 'zones.json', `Could not find zones`);
+      },
+    },
+  ];
+};