shipflow 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * ShipFlow - Unified Shipping SDK for MENA Region
+ *
+ * @example
+ * ```typescript
+ * import { ShipFlow } from 'shipflow';
+ * import { AymakanAdapter, AymakanService } from 'shipflow/carriers/aymakan';
+ *
+ * const client = new ShipFlow({
+ *   adapters: [
+ *     new AymakanAdapter({
+ *       mode: 'sandbox',
+ *       credentials: { apiKey: 'your-api-key' }
+ *     })
+ *   ]
+ * });
+ *
+ * const shipment = await client.carrier('aymakan').createShipment({...});
+ * ```
+ */
+export { ShipFlow, createShipFlow, type ShipFlowOptions } from "./client.js";
+export type { Address, CODDetails, CarrierConfig, CarrierCredentials, City, CreateShipmentInput, CustomerAddress, DeclaredValue, Dimensions, InternationalMetadata, Location, NationalAddress, Parcel, Pickup, PickupRequest, Rate, Shipment, ShipmentOptions, ShipmentStatus, TimeSlot, TrackingEvent, TrackingResult, WebhookConfig, WebhookEvent, WebhookEventType, Weight, } from "./core/types.js";
+export { APIError, AuthenticationError, NetworkError, ShipFlowError, UnsupportedOperationError, ValidationError, WebhookVerificationError, } from "./core/errors.js";
+export { AddressSchema, CODDetailsSchema, CreateShipmentInputSchema, DeclaredValueSchema, DimensionsSchema, ParcelSchema, PickupRequestSchema, WebhookConfigSchema, WeightSchema, validateCreateShipmentInput, validatePickupRequest, } from "./core/schemas.js";
+export { BaseCarrierAdapter, type CarrierAdapter } from "./carriers/base.js";
+export { HttpClient, type HttpClientConfig, type RequestOptions, } from "./core/http.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,UAAU,CAAC;AAG1E,YAAY,EACV,OAAO,EACP,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,IAAI,EACJ,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,UAAU,EACV,qBAAqB,EACrB,QAAQ,EACR,eAAe,EACf,MAAM,EACN,MAAM,EACN,aAAa,EACb,IAAI,EACJ,QAAQ,EACR,eAAe,EACf,cAAc,EACd,QAAQ,EACR,aAAa,EACb,cAAc,EACd,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,MAAM,GACP,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,yBAAyB,EACzB,eAAe,EACf,wBAAwB,GACzB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAG1E,OAAO,EACL,UAAU,EACV,KAAK,gBAAgB,EACrB,KAAK,cAAc,GACpB,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,109 @@
+import {
+  APIError,
+  AddressSchema,
+  AuthenticationError,
+  BaseCarrierAdapter,
+  CODDetailsSchema,
+  CreateShipmentInputSchema,
+  DeclaredValueSchema,
+  DimensionsSchema,
+  HttpClient,
+  NetworkError,
+  ParcelSchema,
+  PickupRequestSchema,
+  ShipFlowError,
+  UnsupportedOperationError,
+  ValidationError,
+  WebhookConfigSchema,
+  WebhookVerificationError,
+  WeightSchema,
+  validateCreateShipmentInput,
+  validatePickupRequest
+} from "./index-x8sk1kw9.js";
+
+// src/client.ts
+class ShipFlow {
+  adapters;
+  constructor(options) {
+    this.adapters = new Map;
+    for (const adapter of options.adapters) {
+      this.adapters.set(adapter.name, adapter);
+    }
+  }
+  carrier(name) {
+    const adapter = this.adapters.get(name.toLowerCase());
+    if (!adapter) {
+      throw new ShipFlowError(`Carrier "${name}" is not configured`, {
+        carrier: name
+      });
+    }
+    return adapter;
+  }
+  get carriers() {
+    return [...this.adapters.keys()];
+  }
+  hasCarrier(name) {
+    return this.adapters.has(name.toLowerCase());
+  }
+  async getRatesFromAll(input) {
+    const results = new Map;
+    const promises = [...this.adapters.entries()].map(async ([name, adapter]) => {
+      if (!adapter.getRates) {
+        return;
+      }
+      try {
+        const rates = await adapter.getRates(input);
+        results.set(name, rates);
+      } catch (error) {
+        results.set(name, error instanceof Error ? error : new Error(String(error)));
+      }
+    });
+    await Promise.allSettled(promises);
+    return results;
+  }
+  async trackAcrossCarriers(trackingNumber) {
+    const promises = [...this.adapters.values()].map(async (adapter) => {
+      const result = await adapter.track(trackingNumber);
+      if (result && result.status !== "unknown") {
+        return result;
+      }
+      return null;
+    });
+    const results = await Promise.allSettled(promises);
+    for (const result of results) {
+      if (result.status === "fulfilled" && result.value) {
+        return result.value;
+      }
+    }
+    return null;
+  }
+}
+function createShipFlow(options) {
+  return new ShipFlow(options);
+}
+export {
+  validatePickupRequest,
+  validateCreateShipmentInput,
+  createShipFlow,
+  WeightSchema,
+  WebhookVerificationError,
+  WebhookConfigSchema,
+  ValidationError,
+  UnsupportedOperationError,
+  ShipFlowError,
+  ShipFlow,
+  PickupRequestSchema,
+  ParcelSchema,
+  NetworkError,
+  HttpClient,
+  DimensionsSchema,
+  DeclaredValueSchema,
+  CreateShipmentInputSchema,
+  CODDetailsSchema,
+  BaseCarrierAdapter,
+  AuthenticationError,
+  AddressSchema,
+  APIError
+};
+
+//# debugId=E4C256CEB9CCC97764756E2164756E21

package/dist/index.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/client.ts"],
+  "sourcesContent": [
+    "// file: src/client.ts\n/**\n * ShipFlow Client\n * Tree-shakeable factory that accepts carrier adapters via dependency injection.\n * Only the carriers you inject will be bundled in your final application.\n */\n\nimport type { CarrierAdapter } from \"./carriers/base\";\nimport { ShipFlowError } from \"./core/errors\";\nimport type { CreateShipmentInput, Rate, TrackingResult } from \"./core/types\";\n\nexport interface ShipFlowOptions {\n  adapters: CarrierAdapter[];\n}\n\nexport class ShipFlow {\n  private adapters: Map<string, CarrierAdapter>;\n\n  constructor(options: ShipFlowOptions) {\n    this.adapters = new Map();\n\n    for (const adapter of options.adapters) {\n      this.adapters.set(adapter.name, adapter);\n    }\n  }\n\n  /**\n   * Get a specific carrier adapter by name.\n   * @throws ShipFlowError if carrier is not configured\n   */\n  carrier(name: string): CarrierAdapter {\n    const adapter = this.adapters.get(name.toLowerCase());\n    if (!adapter) {\n      throw new ShipFlowError(`Carrier \"${name}\" is not configured`, {\n        carrier: name,\n      });\n    }\n    return adapter;\n  }\n\n  /**\n   * Get all configured carrier names.\n   */\n  get carriers(): string[] {\n    return [...this.adapters.keys()];\n  }\n\n  /**\n   * Check if a carrier is configured.\n   */\n  hasCarrier(name: string): boolean {\n    return this.adapters.has(name.toLowerCase());\n  }\n\n  /**\n   * Get rates from all configured carriers that support rate calculation.\n   * Returns a map of carrier name to rates (or error).\n   */\n  async getRatesFromAll(\n    input: CreateShipmentInput,\n  ): Promise<Map<string, Rate[] | Error>> {\n    const results = new Map<string, Rate[] | Error>();\n\n    const promises = [...this.adapters.entries()].map(\n      async ([name, adapter]) => {\n        if (!adapter.getRates) {\n          return; // Skip carriers that don't support rates\n        }\n\n        try {\n          const rates = await adapter.getRates(input);\n          results.set(name, rates);\n        } catch (error) {\n          results.set(\n            name,\n            error instanceof Error ? error : new Error(String(error)),\n          );\n        }\n      },\n    );\n\n    await Promise.allSettled(promises);\n    return results;\n  }\n\n  /**\n   * Try to track a shipment across all configured carriers in parallel.\n   * Useful when you don't know which carrier handles a tracking number.\n   * Returns the first successful result with a known status.\n   */\n  async trackAcrossCarriers(\n    trackingNumber: string,\n  ): Promise<TrackingResult | null> {\n    const promises = [...this.adapters.values()].map(async (adapter) => {\n      const result = await adapter.track(trackingNumber);\n      if (result && result.status !== \"unknown\") {\n        return result;\n      }\n      return null;\n    });\n\n    const results = await Promise.allSettled(promises);\n    for (const result of results) {\n      if (result.status === \"fulfilled\" && result.value) {\n        return result.value;\n      }\n    }\n    return null;\n  }\n}\n\n/**\n * Factory function for creating ShipFlow client.\n * This is the recommended way to instantiate the client.\n */\nexport function createShipFlow(options: ShipFlowOptions): ShipFlow {\n  return new ShipFlow(options);\n}\n"
+  ],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;AAeO,MAAM,SAAS;AAAA,EACZ;AAAA,EAER,WAAW,CAAC,SAA0B;AAAA,IACpC,KAAK,WAAW,IAAI;AAAA,IAEpB,WAAW,WAAW,QAAQ,UAAU;AAAA,MACtC,KAAK,SAAS,IAAI,QAAQ,MAAM,OAAO;AAAA,IACzC;AAAA;AAAA,EAOF,OAAO,CAAC,MAA8B;AAAA,IACpC,MAAM,UAAU,KAAK,SAAS,IAAI,KAAK,YAAY,CAAC;AAAA,IACpD,IAAI,CAAC,SAAS;AAAA,MACZ,MAAM,IAAI,cAAc,YAAY,2BAA2B;AAAA,QAC7D,SAAS;AAAA,MACX,CAAC;AAAA,IACH;AAAA,IACA,OAAO;AAAA;AAAA,MAML,QAAQ,GAAa;AAAA,IACvB,OAAO,CAAC,GAAG,KAAK,SAAS,KAAK,CAAC;AAAA;AAAA,EAMjC,UAAU,CAAC,MAAuB;AAAA,IAChC,OAAO,KAAK,SAAS,IAAI,KAAK,YAAY,CAAC;AAAA;AAAA,OAOvC,gBAAe,CACnB,OACsC;AAAA,IACtC,MAAM,UAAU,IAAI;AAAA,IAEpB,MAAM,WAAW,CAAC,GAAG,KAAK,SAAS,QAAQ,CAAC,EAAE,IAC5C,QAAQ,MAAM,aAAa;AAAA,MACzB,IAAI,CAAC,QAAQ,UAAU;AAAA,QACrB;AAAA,MACF;AAAA,MAEA,IAAI;AAAA,QACF,MAAM,QAAQ,MAAM,QAAQ,SAAS,KAAK;AAAA,QAC1C,QAAQ,IAAI,MAAM,KAAK;AAAA,QACvB,OAAO,OAAO;AAAA,QACd,QAAQ,IACN,MACA,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC,CAC1D;AAAA;AAAA,KAGN;AAAA,IAEA,MAAM,QAAQ,WAAW,QAAQ;AAAA,IACjC,OAAO;AAAA;AAAA,OAQH,oBAAmB,CACvB,gBACgC;AAAA,IAChC,MAAM,WAAW,CAAC,GAAG,KAAK,SAAS,OAAO,CAAC,EAAE,IAAI,OAAO,YAAY;AAAA,MAClE,MAAM,SAAS,MAAM,QAAQ,MAAM,cAAc;AAAA,MACjD,IAAI,UAAU,OAAO,WAAW,WAAW;AAAA,QACzC,OAAO;AAAA,MACT;AAAA,MACA,OAAO;AAAA,KACR;AAAA,IAED,MAAM,UAAU,MAAM,QAAQ,WAAW,QAAQ;AAAA,IACjD,WAAW,UAAU,SAAS;AAAA,MAC5B,IAAI,OAAO,WAAW,eAAe,OAAO,OAAO;AAAA,QACjD,OAAO,OAAO;AAAA,MAChB;AAAA,IACF;AAAA,IACA,OAAO;AAAA;AAEX;AAMO,SAAS,cAAc,CAAC,SAAoC;AAAA,EACjE,OAAO,IAAI,SAAS,OAAO;AAAA;",
+  "debugId": "E4C256CEB9CCC97764756E2164756E21",
+  "names": []
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "shipflow",
+  "version": "0.1.0",
+  "description": "Unified Shipping SDK for MENA Region — Aymakan, SMSA Express, and more",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./carriers/aymakan": {
+      "types": "./dist/carriers/aymakan/index.d.ts",
+      "import": "./dist/carriers/aymakan/index.js"
+    },
+    "./carriers/smsaexpress": {
+      "types": "./dist/carriers/smsaexpress/index.d.ts",
+      "import": "./dist/carriers/smsaexpress/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && bun build src/index.ts src/carriers/aymakan/index.ts src/carriers/smsaexpress/index.ts --outdir dist --splitting --target node --format esm --sourcemap=external && bun run build:fix-dts",
+    "build:fix-dts": "find dist -name '*.d.ts' -exec sed -i -E \"s/from '(\\.\\.?\\/[^']+)'/from '\\1.js'/g; s/from \\\"(\\.\\.?\\/[^\\\"]+)\\\"/from \\\"\\1.js\\\"/g\" {} +",
+    "prepublishOnly": "bun run build",
+    "test": "bun test",
+    "test:watch": "bun test --watch"
+  },
+  "dependencies": {
+    "p-retry": "^8.0.0",
+    "zod": "^3.24"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.5 || ^6"
+  },
+  "keywords": [
+    "shipping",
+    "aymakan",
+    "smsa",
+    "smsaexpress",
+    "saudi-arabia",
+    "mena",
+    "logistics",
+    "cod",
+    "ecommerce",
+    "tracking"
+  ],
+  "repository": {
+    "url": "https://github.com/aashahin/shipflow"
+  },
+  "author": "Abdelrahman Shaheen",
+  "license": "MIT"
+}