@jazzdev/dpd-local-sdk 1.0.3 → 1.0.5

package/dist/index.d.mts

@@ -50,7 +50,7 @@ interface PricingConfig {
     };
 }
 interface LabelConfig {
-    format: 'thermal' | 'a4';
+    format: 'zpl' | 'clp' | 'html';
     printer: {
         model: string;
         dpi: number;
@@ -263,7 +263,7 @@ interface CreateShipmentResult {
 }
 interface GenerateLabelParams {
     shipmentId: string | number;
-    format: 'thermal' | 'html';
+    labelFormat: 'zpl' | 'clp' | 'html';
 }
 interface GenerateLabelResult {
     success: boolean;
@@ -356,7 +356,7 @@ interface CreateDPDConfigOptions {
         default?: DPDServiceCode;
     };
     labels?: {
-        format?: 'thermal' | 'a4';
+        format?: 'zpl' | 'clp' | 'html';
         printer?: {
             model: string;
             dpi: number;
@@ -420,7 +420,7 @@ declare function generateConsignmentRef(orderId: string): string;
 declare function createCompleteShipment(orderId: string, params: Omit<CreateShipmentParams, 'orderId'>, config: DPDModuleConfig, dbAdapter: DatabaseAdapter, storageAdapter: StorageAdapter): Promise<CreateShipmentResult & {
     labelUrl?: string;
 }>;
-declare function generateAndUploadLabel(shipmentId: string | number, consignmentNumber: string, format: "thermal" | "html" | undefined, credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
+declare function generateAndUploadLabel(shipmentId: string | number, consignmentNumber: string, labelFormat: 'zpl' | 'clp' | 'html', credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
 declare function validateDeliveryAddress(params: ValidateAddressParams, credentials: DPDCredentials): Promise<ValidateAddressResult>;
 declare function saveAddress(userId: string, address: Omit<SavedAddress, 'id' | 'userId' | 'createdAt' | 'updatedAt'>, credentials: DPDCredentials, dbAdapter: DatabaseAdapter): Promise<string>;
 declare function getSavedAddresses(userId: string, dbAdapter: DatabaseAdapter): Promise<SavedAddress[]>;
@@ -428,7 +428,7 @@ declare function getSavedAddress(addressId: string, dbAdapter: DatabaseAdapter):
 declare function updateSavedAddress(addressId: string, data: Partial<SavedAddress>, dbAdapter: DatabaseAdapter): Promise<void>;
 declare function deleteSavedAddress(addressId: string, dbAdapter: DatabaseAdapter): Promise<void>;
 declare function getLabelUrl(consignmentNumber: string, storageAdapter: StorageAdapter): Promise<string | null>;
-declare function regenerateLabel(shipmentId: string | number, consignmentNumber: string, format: "thermal" | "html" | undefined, credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
+declare function regenerateLabel(shipmentId: string | number, consignmentNumber: string, labelFormat: 'zpl' | 'clp' | 'html', credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
 declare function testDPDConnection(credentials: DPDCredentials): Promise<{
     success: boolean;
     message: string;

package/dist/index.d.ts

@@ -50,7 +50,7 @@ interface PricingConfig {
     };
 }
 interface LabelConfig {
-    format: 'thermal' | 'a4';
+    format: 'zpl' | 'clp' | 'html';
     printer: {
         model: string;
         dpi: number;
@@ -263,7 +263,7 @@ interface CreateShipmentResult {
 }
 interface GenerateLabelParams {
     shipmentId: string | number;
-    format: 'thermal' | 'html';
+    labelFormat: 'zpl' | 'clp' | 'html';
 }
 interface GenerateLabelResult {
     success: boolean;
@@ -356,7 +356,7 @@ interface CreateDPDConfigOptions {
         default?: DPDServiceCode;
     };
     labels?: {
-        format?: 'thermal' | 'a4';
+        format?: 'zpl' | 'clp' | 'html';
         printer?: {
             model: string;
             dpi: number;
@@ -420,7 +420,7 @@ declare function generateConsignmentRef(orderId: string): string;
 declare function createCompleteShipment(orderId: string, params: Omit<CreateShipmentParams, 'orderId'>, config: DPDModuleConfig, dbAdapter: DatabaseAdapter, storageAdapter: StorageAdapter): Promise<CreateShipmentResult & {
     labelUrl?: string;
 }>;
-declare function generateAndUploadLabel(shipmentId: string | number, consignmentNumber: string, format: "thermal" | "html" | undefined, credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
+declare function generateAndUploadLabel(shipmentId: string | number, consignmentNumber: string, labelFormat: 'zpl' | 'clp' | 'html', credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
 declare function validateDeliveryAddress(params: ValidateAddressParams, credentials: DPDCredentials): Promise<ValidateAddressResult>;
 declare function saveAddress(userId: string, address: Omit<SavedAddress, 'id' | 'userId' | 'createdAt' | 'updatedAt'>, credentials: DPDCredentials, dbAdapter: DatabaseAdapter): Promise<string>;
 declare function getSavedAddresses(userId: string, dbAdapter: DatabaseAdapter): Promise<SavedAddress[]>;
@@ -428,7 +428,7 @@ declare function getSavedAddress(addressId: string, dbAdapter: DatabaseAdapter):
 declare function updateSavedAddress(addressId: string, data: Partial<SavedAddress>, dbAdapter: DatabaseAdapter): Promise<void>;
 declare function deleteSavedAddress(addressId: string, dbAdapter: DatabaseAdapter): Promise<void>;
 declare function getLabelUrl(consignmentNumber: string, storageAdapter: StorageAdapter): Promise<string | null>;
-declare function regenerateLabel(shipmentId: string | number, consignmentNumber: string, format: "thermal" | "html" | undefined, credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
+declare function regenerateLabel(shipmentId: string | number, consignmentNumber: string, labelFormat: 'zpl' | 'clp' | 'html', credentials: DPDCredentials, storageAdapter: StorageAdapter): Promise<GenerateLabelResult>;
 declare function testDPDConnection(credentials: DPDCredentials): Promise<{
     success: boolean;
     message: string;

package/dist/index.js

@@ -139,7 +139,7 @@ function createDPDConfig(options) {
     default: "12"
   };
   const defaultLabels = {
-    format: "thermal",
+    format: "zpl",
     printer: {
       model: "TSC-DA210",
       dpi: 203,
@@ -406,16 +406,16 @@ async function testConnection(credentials) {
 }
 
 // src/utils/getAcceptHeader.ts
-function getAcceptHeader(format, thermalLanguage) {
-  if (format === "html") {
-    return "text/html";
-  }
-  switch (thermalLanguage) {
-    case "zebra-zpl":
+function getAcceptHeader(format) {
+  switch (format) {
+    case "html":
+      return "text/html";
+    case "zpl":
       return "text/vnd.zebra-zpl";
-    case "citizen-clp":
-    default:
+    case "clp":
       return "text/vnd.citizen-clp";
+    default:
+      return "text/vnd.zebra-zpl";
   }
 }
 
@@ -530,16 +530,21 @@ async function createShipment(credentials, params, businessConfig) {
 }
 async function generateLabel(credentials, params) {
   try {
-    const { shipmentId, format } = params;
+    const { shipmentId, labelFormat } = params;
     const endpoint = `${DPD_API.ENDPOINTS.LABEL}/${shipmentId}/label/`;
     const response = await authenticatedRequest(credentials, {
       method: "GET",
       endpoint,
       headers: {
-        Accept: getAcceptHeader(format)
+        Accept: getAcceptHeader(labelFormat)
       }
     });
-    console.log({ endpoint, format, header: getAcceptHeader(format), response });
+    console.log({
+      endpoint,
+      labelFormat,
+      header: getAcceptHeader(labelFormat),
+      response
+    });
     if (!response || typeof response === "object" && !response.data) {
       return {
         success: false,
@@ -696,7 +701,7 @@ async function createCompleteShipment(orderId, params, config2, dbAdapter, stora
     const labelResult = await generateAndUploadLabel(
       shipmentResult.shipmentId,
       shipmentResult.consignmentNumber,
-      "thermal",
+      "zpl",
       config2.credentials,
       storageAdapter
     );
@@ -782,17 +787,17 @@ async function createCompleteShipment(orderId, params, config2, dbAdapter, stora
     };
   }
 }
-async function generateAndUploadLabel(shipmentId, consignmentNumber, format = "thermal", credentials, storageAdapter) {
+async function generateAndUploadLabel(shipmentId, consignmentNumber, labelFormat, credentials, storageAdapter) {
   try {
     const labelResult = await generateLabel(credentials, {
       shipmentId,
-      format
+      labelFormat
     });
     if (!labelResult.success || !labelResult.labelData) {
       return labelResult;
     }
     const timestamp = Date.now();
-    const extension = format === "thermal" ? "txt" : "html";
+    const extension = labelFormat === "html" ? "html" : "txt";
     const fileName = `${consignmentNumber}-${timestamp}.${extension}`;
     const labelUrl = await storageAdapter.uploadLabel(
       labelResult.labelData,
@@ -850,11 +855,11 @@ async function getLabelUrl(consignmentNumber, storageAdapter) {
     return null;
   }
 }
-async function regenerateLabel(shipmentId, consignmentNumber, format = "thermal", credentials, storageAdapter) {
+async function regenerateLabel(shipmentId, consignmentNumber, labelFormat, credentials, storageAdapter) {
   return await generateAndUploadLabel(
     shipmentId,
     consignmentNumber,
-    format,
+    labelFormat,
     credentials,
     storageAdapter
   );

package/dist/index.mjs

@@ -51,7 +51,7 @@ function createDPDConfig(options) {
     default: "12"
   };
   const defaultLabels = {
-    format: "thermal",
+    format: "zpl",
     printer: {
       model: "TSC-DA210",
       dpi: 203,
@@ -318,16 +318,16 @@ async function testConnection(credentials) {
 }
 
 // src/utils/getAcceptHeader.ts
-function getAcceptHeader(format, thermalLanguage) {
-  if (format === "html") {
-    return "text/html";
-  }
-  switch (thermalLanguage) {
-    case "zebra-zpl":
+function getAcceptHeader(format) {
+  switch (format) {
+    case "html":
+      return "text/html";
+    case "zpl":
       return "text/vnd.zebra-zpl";
-    case "citizen-clp":
-    default:
+    case "clp":
       return "text/vnd.citizen-clp";
+    default:
+      return "text/vnd.zebra-zpl";
   }
 }
 
@@ -442,16 +442,21 @@ async function createShipment(credentials, params, businessConfig) {
 }
 async function generateLabel(credentials, params) {
   try {
-    const { shipmentId, format } = params;
+    const { shipmentId, labelFormat } = params;
     const endpoint = `${DPD_API.ENDPOINTS.LABEL}/${shipmentId}/label/`;
     const response = await authenticatedRequest(credentials, {
       method: "GET",
       endpoint,
       headers: {
-        Accept: getAcceptHeader(format)
+        Accept: getAcceptHeader(labelFormat)
       }
     });
-    console.log({ endpoint, format, header: getAcceptHeader(format), response });
+    console.log({
+      endpoint,
+      labelFormat,
+      header: getAcceptHeader(labelFormat),
+      response
+    });
     if (!response || typeof response === "object" && !response.data) {
       return {
         success: false,
@@ -608,7 +613,7 @@ async function createCompleteShipment(orderId, params, config2, dbAdapter, stora
     const labelResult = await generateAndUploadLabel(
       shipmentResult.shipmentId,
       shipmentResult.consignmentNumber,
-      "thermal",
+      "zpl",
       config2.credentials,
       storageAdapter
     );
@@ -694,17 +699,17 @@ async function createCompleteShipment(orderId, params, config2, dbAdapter, stora
     };
   }
 }
-async function generateAndUploadLabel(shipmentId, consignmentNumber, format = "thermal", credentials, storageAdapter) {
+async function generateAndUploadLabel(shipmentId, consignmentNumber, labelFormat, credentials, storageAdapter) {
   try {
     const labelResult = await generateLabel(credentials, {
       shipmentId,
-      format
+      labelFormat
     });
     if (!labelResult.success || !labelResult.labelData) {
       return labelResult;
     }
     const timestamp = Date.now();
-    const extension = format === "thermal" ? "txt" : "html";
+    const extension = labelFormat === "html" ? "html" : "txt";
     const fileName = `${consignmentNumber}-${timestamp}.${extension}`;
     const labelUrl = await storageAdapter.uploadLabel(
       labelResult.labelData,
@@ -762,11 +767,11 @@ async function getLabelUrl(consignmentNumber, storageAdapter) {
     return null;
   }
 }
-async function regenerateLabel(shipmentId, consignmentNumber, format = "thermal", credentials, storageAdapter) {
+async function regenerateLabel(shipmentId, consignmentNumber, labelFormat, credentials, storageAdapter) {
   return await generateAndUploadLabel(
     shipmentId,
     consignmentNumber,
-    format,
+    labelFormat,
     credentials,
     storageAdapter
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jazzdev/dpd-local-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript SDK for DPD Local shipping API integration - database-agnostic and framework-independent",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",