1068900052

Build Type

push

github

Committed by John Johnson

Commit Message

wip

Run Details

119 of 161 branches covered (73.91%)

Branch coverage included in aggregate %.

4 of 4 new or added lines in 2 files covered. (100.0%)

3 existing lines in 1 file now uncovered.

575 of 614 relevant lines covered (93.65%)

3.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.67

/src/create-label/format-params.ts

import { Request } from "./types/private";

import { CreateLabelRequestTypes } from ".";

export function formatParams(
  params: CreateLabelRequestTypes.Params
): Request.CreateLabelRequestBody {
  return {
    shipment: mapShipment(params.shipment),
    is_return_label: params.isReturnLabel,
    rma_number: params.rmaNumber,
    charge_event: params.chargeEvent,
    outbound_label_id: params.outboundLabelId,
    test_label: params.testLabel,
    validate_address: params.validateAddress,
    label_download_type: params.labelDownloadType,
    label_format: params.labelFormat,
    display_scheme: params.displayScheme,
    label_layout: params.labelLayout,
    label_image_id: params.labelImageId,
  };
}

function mapShipment(
  params?: CreateLabelRequestTypes.Shipment
): Request.Shipment | undefined {
  if (!params) return undefined;
  return {
    external_order_id: params.externalOrderId,
    items: params.items,
    tax_identifiers: mapTaxIdentifiers(params.taxIdentifiers),
    external_shipment_id: params.externalShipmentId,
    ship_to: params.shipTo,
    ship_from: params.shipFrom,
    warehouse_id: params.warehouseId,
    return_to: params.returnTo,
    confirmation: params.confirmation,
    customs: mapCustoms(params.customs),
    advanced_options: mapAdvancedOptions(params.advancedOptions),
    origin_type: params.originType,
    insurance_provider: params.insuranceProvider,
    order_source_code: params.orderSourceCode,
    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
    // @ts-ignore
    packages: mapPackages(params.packages),
  };
}

function mapPackages(params: CreateLabelRequestTypes.Package[]): any[] {
  return params.map((pkg) => ({
    package_code: pkg.packageCode,
    weight: pkg.weight,
    dimensions: pkg.dimensions,
    insured_value: pkg.insuredValue,
    label_messages: pkg.labelMessages,
    external_package_id: pkg.externalPackageId,
  }));
}

function mapTaxIdentifiers(
  params?: CreateLabelRequestTypes.TaxIdentifier[]
): Request.TaxIdentifier[] | undefined {
  if (!params) return undefined;
  return params.map((taxId) => ({
    taxable_entity_type: taxId.taxableEntityType,
    identifier_type: taxId.identifierType,
    issuing_authority: taxId.issuingAuthority,
    value: taxId.value,
  }));
}

function mapCustoms(
  params?: CreateLabelRequestTypes.InternationalShipmentOptions
): Request.InternationalShipmentOptions | undefined {
  if (!params) return undefined;
  let custom_items: Request.CustomsItem[] = [];
  if (params.customsItems) {
    custom_items = params.customsItems.map((customItem) => ({
      quantity: customItem.quantity,
      value: customItem.value,
      harmonized_tariff_code: customItem.harmonizedTariffCode,
      country_of_origin: customItem.countryOfOrigin,
      unit_of_measure: customItem.unitOfMeasure,
      sku: customItem.sku,
      sku_description: customItem.skuDescription,
    }));
  }
  return {
    contents: params.contents,
    non_delivery: params.nonDelivery,
    customs_items: custom_items,
  };
}

function mapAdvancedOptions(
  params?: CreateLabelRequestTypes.AdvancedShipmentOptions
): Request.AdvancedShipmentOptions | undefined {
  if (!params) return undefined;
  return {
    bill_to_account: params.billToAccount,
    bill_to_country_code: params.billToCountryCode,
    bill_to_party: params.billToParty,
    bill_to_postal_code: params.billToPostalCode,
    contains_alcohol: params.containsAlcohol,
    delivered_duty_paid: params.deliveredDutyPaid,
    dry_ice: params.dryIce,
    dry_ice_weight: params.dryIceWeight,
    non_machinable: params.nonMachinable,
    saturday_delivery: params.saturdayDelivery,
    use_ups_ground_freight_pricing: params.useUpsGroundFreightPricing,
    freight_class: params.freightClass,
    custom_field1: params.customField1,
    custom_field2: params.customField2,
    custom_field3: params.customField3,
    origin_type: params.originType,
    shipper_release: params.shipperRelease,
    collect_on_delivery: params.collectOnDelivery,
  };
}

1	import { Request } from "./types/private";
2
3	import { CreateLabelRequestTypes } from ".";
4
5	export function formatParams(	1✔
6	params: CreateLabelRequestTypes.Params
7	): Request.CreateLabelRequestBody {
8	return {	1✔
9	shipment: mapShipment(params.shipment),
10	is_return_label: params.isReturnLabel,
11	rma_number: params.rmaNumber,
12	charge_event: params.chargeEvent,
13	outbound_label_id: params.outboundLabelId,
14	test_label: params.testLabel,
15	validate_address: params.validateAddress,
16	label_download_type: params.labelDownloadType,
17	label_format: params.labelFormat,
18	display_scheme: params.displayScheme,
19	label_layout: params.labelLayout,
20	label_image_id: params.labelImageId,
21	};
22	}
23
24	function mapShipment(
25	params?: CreateLabelRequestTypes.Shipment
26	): Request.Shipment \| undefined {
27	if (!params) return undefined;	1!
28	return {	1✔
29	external_order_id: params.externalOrderId,
30	items: params.items,
31	tax_identifiers: mapTaxIdentifiers(params.taxIdentifiers),
32	external_shipment_id: params.externalShipmentId,
33	ship_to: params.shipTo,
34	ship_from: params.shipFrom,
35	warehouse_id: params.warehouseId,
36	return_to: params.returnTo,
37	confirmation: params.confirmation,
38	customs: mapCustoms(params.customs),
39	advanced_options: mapAdvancedOptions(params.advancedOptions),
40	origin_type: params.originType,
41	insurance_provider: params.insuranceProvider,
42	order_source_code: params.orderSourceCode,
43	// eslint-disable-next-line @typescript-eslint/ban-ts-comment
44	// @ts-ignore
45	packages: mapPackages(params.packages),
46	};
47	}
48
49	function mapPackages(params: CreateLabelRequestTypes.Package[]): any[] {
50	return params.map((pkg) => ({	1✔
51	package_code: pkg.packageCode,
52	weight: pkg.weight,
53	dimensions: pkg.dimensions,
54	insured_value: pkg.insuredValue,
55	label_messages: pkg.labelMessages,
56	external_package_id: pkg.externalPackageId,
57	}));
58	}
59
60	function mapTaxIdentifiers(
61	params?: CreateLabelRequestTypes.TaxIdentifier[]
62	): Request.TaxIdentifier[] \| undefined {
63	if (!params) return undefined;	1!
UNCOV 64	return params.map((taxId) => ({	×
65	taxable_entity_type: taxId.taxableEntityType,
66	identifier_type: taxId.identifierType,
67	issuing_authority: taxId.issuingAuthority,
68	value: taxId.value,
69	}));
70	}
71
72	function mapCustoms(
73	params?: CreateLabelRequestTypes.InternationalShipmentOptions
74	): Request.InternationalShipmentOptions \| undefined {
75	if (!params) return undefined;	1!
76	let custom_items: Request.CustomsItem[] = [];	1✔
77	if (params.customsItems) {	1!
UNCOV 78	custom_items = params.customsItems.map((customItem) => ({	×
79	quantity: customItem.quantity,
80	value: customItem.value,
81	harmonized_tariff_code: customItem.harmonizedTariffCode,
82	country_of_origin: customItem.countryOfOrigin,
83	unit_of_measure: customItem.unitOfMeasure,
84	sku: customItem.sku,
85	sku_description: customItem.skuDescription,
86	}));
87	}
88	return {	1✔
89	contents: params.contents,
90	non_delivery: params.nonDelivery,
91	customs_items: custom_items,
92	};
93	}
94
95	function mapAdvancedOptions(
96	params?: CreateLabelRequestTypes.AdvancedShipmentOptions
97	): Request.AdvancedShipmentOptions \| undefined {
98	if (!params) return undefined;	1!
UNCOV 99	return {	×
100	bill_to_account: params.billToAccount,
101	bill_to_country_code: params.billToCountryCode,
102	bill_to_party: params.billToParty,
103	bill_to_postal_code: params.billToPostalCode,
104	contains_alcohol: params.containsAlcohol,
105	delivered_duty_paid: params.deliveredDutyPaid,
106	dry_ice: params.dryIce,
107	dry_ice_weight: params.dryIceWeight,
108	non_machinable: params.nonMachinable,
109	saturday_delivery: params.saturdayDelivery,
110	use_ups_ground_freight_pricing: params.useUpsGroundFreightPricing,
111	freight_class: params.freightClass,
112	custom_field1: params.customField1,
113	custom_field2: params.customField2,
114	custom_field3: params.customField3,
115	origin_type: params.originType,
116	shipper_release: params.shipperRelease,
117	collect_on_delivery: params.collectOnDelivery,
118	};
119	}

ShipEngine / shipengine-js / 1068900052

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous