@emulates/easypost 0.0.0-stage → 3.0.0

package/dist/server.js

@@ -0,0 +1,12 @@
+import {
+  DEFAULT_PORT,
+  createServer,
+  serveTarget
+} from "./chunk-X5XEHMAK.js";
+import "./chunk-7GJN6ROH.js";
+export {
+  DEFAULT_PORT,
+  createServer,
+  serveTarget
+};
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/openapi.yaml

@@ -0,0 +1,286 @@
+openapi: 3.1.0
+info:
+  title: EasyPost Trackers API (Emulates subset)
+  description: |
+    Stateful mock subset of the EasyPost v2 API: create (or re-use) a tracker for a tracking
+    code, retrieve it, and list trackers. Trimmed from EasyPost's published reference to what
+    our genomics tracking lookup calls, plus the two reads that make parity walks meaningful.
+  version: "2"
+  x-emulates-upstream:
+    note: >-
+      Shapes from https://docs.easypost.com/docs/trackers; request/response fields our consumer
+      reads come from packages/lib/src/shipment-tracking-status/easypost-client.ts.
+servers:
+  - url: https://api.easypost.com
+security:
+  - basicAuth: []
+paths:
+  /v2/trackers:
+    post:
+      operationId: CreateTracker
+      description: >-
+        Creates a tracker, or answers the existing one when the same tracking code (and
+        carrier) was already tracked. EasyPost's test codes (EZ1000000001 … EZ7000000007)
+        answer their documented fixed statuses.
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      requestBody:
+        required: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: "#/components/schemas/CreateTrackerBody"
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateTrackerBody"
+      responses:
+        "201":
+          description: The tracker (new or re-used)
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Tracker"
+        "401":
+          description: Missing or unknown API key
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "422":
+          description: Missing tracking code or invalid carrier
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    get:
+      operationId: ListTrackers
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      parameters:
+        - name: tracking_code
+          in: query
+          required: false
+          schema:
+            type: string
+            maxLength: 40
+        - name: carrier
+          in: query
+          required: false
+          schema:
+            type: string
+            enum: [USPS, UPS, FedEx, DHLExpress]
+        - name: page_size
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+      responses:
+        "200":
+          description: Newest trackers first
+          content:
+            application/json:
+              schema:
+                type: object
+                required: [trackers, has_more]
+                properties:
+                  trackers:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/Tracker"
+                  has_more:
+                    type: boolean
+        "401":
+          description: Missing or unknown API key
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "422":
+          description: Invalid query parameter
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /v2/trackers/{id}:
+    parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          x-emulates-resource-ref:
+            type: tracker
+            missing: trk_00000000000000000000000000000000
+    get:
+      operationId: RetrieveTracker
+      x-emulates:
+        supported: true
+        parity:
+          enabled: true
+          safe: true
+      responses:
+        "200":
+          description: The tracker
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Tracker"
+        "401":
+          description: Missing or unknown API key
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "404":
+          description: Unknown tracker
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  securitySchemes:
+    basicAuth:
+      type: http
+      scheme: basic
+      description: "The API key as the username, an empty password (`Basic base64(key:)`)."
+  schemas:
+    CreateTrackerBody:
+      type: object
+      required: [tracker]
+      properties:
+        tracker:
+          type: object
+          required: [tracking_code]
+          properties:
+            tracking_code:
+              type: string
+              minLength: 1
+              maxLength: 40
+              examples: [EZ1000000001, EZ4000000004, 1Z999AA10123456784]
+            carrier:
+              type: string
+              enum: [USPS, UPS, FedEx, DHL, DHLExpress]
+    Tracker:
+      type: object
+      required:
+        - id
+        - object
+        - mode
+        - tracking_code
+        - status
+        - status_detail
+        - carrier
+        - tracking_details
+        - public_url
+        - created_at
+        - updated_at
+      properties:
+        id:
+          type: string
+          x-emulates-resource:
+            type: tracker
+            identity: true
+          x-emulates-volatile:
+            kind: id
+        object:
+          type: string
+          enum: [Tracker]
+        mode:
+          type: string
+          enum: [test, production]
+        tracking_code:
+          type: string
+        status:
+          type: string
+          enum:
+            - unknown
+            - pre_transit
+            - in_transit
+            - out_for_delivery
+            - delivered
+            - available_for_pickup
+            - return_to_sender
+            - failure
+            - cancelled
+            - error
+        status_detail:
+          type: string
+        carrier:
+          type: string
+        signed_by:
+          type: ["string", "null"]
+        weight:
+          type: ["number", "null"]
+        est_delivery_date:
+          type: ["string", "null"]
+          x-emulates-volatile:
+            kind: timestamp
+        shipment_id:
+          type: ["string", "null"]
+        tracking_details:
+          type: array
+          items:
+            $ref: "#/components/schemas/TrackingDetail"
+        carrier_detail:
+          type: ["object", "null"]
+        public_url:
+          type: string
+          x-emulates-volatile:
+            kind: url
+        fees:
+          type: array
+          items:
+            type: object
+        created_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+        updated_at:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+    TrackingDetail:
+      type: object
+      required: [object, message, status, status_detail, datetime, source]
+      properties:
+        object:
+          type: string
+          enum: [TrackingDetail]
+        message:
+          type: string
+        status:
+          type: string
+        status_detail:
+          type: string
+        datetime:
+          type: string
+          x-emulates-volatile:
+            kind: timestamp
+        source:
+          type: string
+        tracking_location:
+          type: object
+    Error:
+      type: object
+      required: [error]
+      properties:
+        error:
+          type: object
+          required: [code, message]
+          properties:
+            code:
+              type: string
+            message:
+              type: string
+            errors:
+              type: array
+              items:
+                type: object

package/package.json

@@ -1,6 +1,117 @@
 {
   "name": "@emulates/easypost",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "3.0.0",
+  "description": "Stateful emulator of the EasyPost trackers API: create/re-use trackers, EasyPost's test tracking codes, admin status transitions and EasyPost's error envelope.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "DISCOVERY.md",
+    "SUPPORT.md",
+    "openapi.yaml"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    }
+  },
+  "bin": {
+    "emulates-easypost": "./dist/cli.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/crvouga/emulates.git",
+    "directory": "packages/service/easypost"
+  },
+  "homepage": "https://github.com/crvouga/emulates/tree/main/packages/service/easypost#readme",
+  "keywords": [
+    "emulates",
+    "service",
+    "easypost",
+    "shipping",
+    "tracking"
+  ],
+  "emulates": {
+    "runtime": "portable",
+    "entries": {
+      "server": "node",
+      "cli": "node"
+    },
+    "layer": "service",
+    "category": "logistics",
+    "displayName": "EasyPost",
+    "vendor": {
+      "website": "https://www.easypost.com",
+      "docs": "https://docs.easypost.com/docs/trackers"
+    },
+    "parity": "Trackers",
+    "parityTier": "cold",
+    "discovery": {
+      "guide": "DISCOVERY.md",
+      "behavior": "README.md",
+      "capabilities": "SUPPORT.md",
+      "contract": "openapi.yaml",
+      "types": "dist/index.d.ts",
+      "oracle": {
+        "kind": "Live vendor API or sandbox",
+        "command": "bun run parity:service -- easypost",
+        "note": "Run from an Emulates checkout; credentials come only from .env.local or GitHub Actions secrets. Missing credentials exit 2."
+      },
+      "introspection": [
+        "GET /__admin/health",
+        "GET /__admin",
+        "GET /__admin/state",
+        "GET /__admin/requests",
+        "GET /__admin/metrics",
+        "GET /__admin/faults/presets",
+        "GET /__admin/ui"
+      ],
+      "reporting": "https://github.com/crvouga/emulates/blob/main/docs/REPORTING_ISSUES.md"
+    }
+  },
+  "scripts": {
+    "generate": "bun ../../openapi/codegen/dist/cli.js",
+    "generate:check": "bun ../../openapi/codegen/dist/cli.js --check",
+    "openapi:check": "bun ../../openapi/codegen/dist/cli.js --validate",
+    "build": "bun ../../../scripts/bundle-service.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "biome check .",
+    "test": "bun test",
+    "parity": "bun scripts/parity.ts",
+    "portability": "bun ../../../scripts/portability.ts",
+    "pack:check": "bun ../../../scripts/pack-check.ts"
+  },
+  "dependencies": {
+    "@emulates/sqlite": "3.0.0",
+    "hono": "4.11.9"
+  },
+  "devDependencies": {
+    "fast-check": "4.9.0",
+    "@emulates/testing": "0.1.0",
+    "@emulates/sqlite": "0.0.0-development",
+    "@emulates/parity": "0.0.0-development",
+    "@emulates/credentials": "0.0.0-development",
+    "@emulates/openapi-codegen": "0.1.0",
+    "@emulates/openapi-metadata": "0.0.0-development",
+    "@emulates/core": "0.0.0-development",
+    "@emulates/sqlite-client": "0.0.0-development",
+    "@emulates/openapi": "0.0.0-development",
+    "@emulates/service": "0.0.0-development",
+    "@emulates/http-codec": "0.0.0-development",
+    "@emulates/adapter-node": "0.0.0-development"
+  }
+}