@de./sdk 1.0.3 → 1.0.5

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@de./sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Complete SDK pack for MSI (Map Service Interface), IoTClient and DClient services",
   "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/de.sdk/src/index.d.ts",
   "files": [
     "dist/",
     "src/",
@@ -13,7 +13,7 @@
     ".": {
       "import": "./dist/index.js",
       "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "types": "./dist/de.sdk/src/index.d.ts"
     },
     "./types": {
       "types": "./dist/types/index.d.ts",
@@ -35,6 +35,7 @@
     "test:event": "yarn build:tsc && jest test/event.test.js"
   },
   "dependencies": {
+    "@de./types": "^1.0.0",
     "events": "^3.3.0",
     "iframe.io": "^1.1.0",
     "node-fetch": "2.6.1",

package/src/allend/Agent/consolidation.ts

@@ -0,0 +1,31 @@
+import type {
+	AgentConsolidationRespondValidation,
+	AgentConsolidationHandoffValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Agent Consolidation ──────────────────────────────────────────────────────
+
+export default class AgentConsolidation {
+	constructor( private http: Http ){}
+
+	async respond( body: AgentConsolidationRespondValidation['body'] ): Promise<AgentConsolidationRespondValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentConsolidationRespondValidation['response']>>({
+			url: '/agent/consolidation/respond',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async handoffConfirm( body: AgentConsolidationHandoffValidation['body'] ): Promise<AgentConsolidationHandoffValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentConsolidationHandoffValidation['response']>>({
+			url: '/agent/consolidation/handoff/confirm',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/delivery.ts

@@ -0,0 +1,61 @@
+import type {
+	AgentDeliveryListValidation,
+	AgentDeliveryGetValidation,
+	AgentDeliveryAcceptValidation,
+	AgentDeliveryUpdateStatusValidation,
+	AgentDeliveryReportIssueValidation
+} from '@de./types'
+import { qs, type Http, type Res } from '../../utils'
+
+// ─── Agent Delivery Orders ────────────────────────────────────────────────────
+
+export default class AgentDelivery {
+	constructor( private http: Http ){}
+
+	async list( querystring?: AgentDeliveryListValidation['querystring'] ): Promise<AgentDeliveryListValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDeliveryListValidation['response']>>({
+			url: `/agent/delivery/orders${qs( querystring )}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async get( reference: string ): Promise<AgentDeliveryGetValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDeliveryGetValidation['response']>>({
+			url: `/agent/delivery/orders/${reference}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async accept( reference: string ): Promise<AgentDeliveryAcceptValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDeliveryAcceptValidation['response']>>({
+			url: `/agent/delivery/orders/${reference}/accept`,
+			method: 'POST'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async updateStatus( reference: string, body: AgentDeliveryUpdateStatusValidation['body'] ): Promise<AgentDeliveryUpdateStatusValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDeliveryUpdateStatusValidation['response']>>({
+			url: `/agent/delivery/orders/${reference}/status`,
+			method: 'PATCH',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async reportIssue( reference: string, body: AgentDeliveryReportIssueValidation['body'] ): Promise<AgentDeliveryReportIssueValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDeliveryReportIssueValidation['response']>>({
+			url: `/agent/delivery/orders/${reference}/issue`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/dispatch.ts

@@ -0,0 +1,31 @@
+import type {
+	AgentDispatchRespondValidation,
+	AgentDispatchRateValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Agent Dispatch ───────────────────────────────────────────────────────────
+
+export default class AgentDispatch {
+	constructor( private http: Http ){}
+
+	async respond( body: AgentDispatchRespondValidation['body'] ): Promise<AgentDispatchRespondValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDispatchRespondValidation['response']>>({
+			url: '/agent/dispatch/respond',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async rate( body: AgentDispatchRateValidation['body'] ): Promise<AgentDispatchRateValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentDispatchRateValidation['response']>>({
+			url: '/agent/dispatch/rate',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/index.ts

@@ -0,0 +1,96 @@
+import type { AccessOptions } from '../../types/access'
+import type {
+	AgentInfoValidation,
+	AgentAvailabilityValidation,
+	AgentUpdateValidation
+} from '@de./types'
+import AccessManager from '../Access'
+import { type Res } from '../../utils'
+import AgentRides from './rides'
+import AgentDelivery from './delivery'
+import AgentShipping from './shipping'
+import AgentNavigation from './navigation'
+import AgentConsolidation from './consolidation'
+import AgentReallocation from './reallocation'
+import AgentDispatch from './dispatch'
+import AgentOrigin from './origin'
+
+export type AgentConfig = {
+	context: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// Agent: Agent Operation Interfaces — de.arch AUX/agent routes.
+// Covers profile, availability, orders (ride/delivery/shipping),
+// navigation, consolidation, reallocation, dispatch, and origin.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Agent extends AccessManager {
+	readonly rides:         AgentRides
+	readonly delivery:      AgentDelivery
+	readonly shipping:      AgentShipping
+	readonly navigation:    AgentNavigation
+	readonly consolidation: AgentConsolidation
+	readonly reallocation:  AgentReallocation
+	readonly dispatch:      AgentDispatch
+	readonly origin:        AgentOrigin
+
+	constructor( config: AgentConfig ){
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/aux')
+		if( !config.accessToken ) throw new Error('Undefined accessToken. See https://doc.dedot.io/sdk/auth')
+
+		const access: AccessOptions = {
+			context:      config.context,
+			accessToken:  config.accessToken,
+			env:          config.env      || 'dev',
+			platform:     config.platform || 'proxy',
+			remoteOrigin: config.remoteOrigin
+		}
+		super( access, 'API' )
+
+		this.rides         = new AgentRides( this )
+		this.delivery      = new AgentDelivery( this )
+		this.shipping      = new AgentShipping( this )
+		this.navigation    = new AgentNavigation( this )
+		this.consolidation = new AgentConsolidation( this )
+		this.reallocation  = new AgentReallocation( this )
+		this.dispatch      = new AgentDispatch( this )
+		this.origin        = new AgentOrigin( this )
+	}
+
+	// ── Agent profile ─────────────────────────────────────────────────────────
+
+	async info(): Promise<AgentInfoValidation['response']> {
+		const { error, message, data } = await this.request<Res<AgentInfoValidation['response']>>({
+			url: '/agent',
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async update( body: AgentUpdateValidation['body'] ): Promise<AgentUpdateValidation['response']> {
+		const { error, message, data } = await this.request<Res<AgentUpdateValidation['response']>>({
+			url: '/agent',
+			method: 'PATCH',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async availability( status: AgentAvailabilityValidation['params']['availability'] ): Promise<AgentAvailabilityValidation['response']> {
+		const { error, message, data } = await this.request<Res<AgentAvailabilityValidation['response']>>({
+			url: `/agent/${status}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/navigation.ts

@@ -0,0 +1,31 @@
+import type {
+	AgentLocationValidation,
+	AgentNearbyValidation
+} from '@de./types'
+import { qs, type Http, type Res } from '../../utils'
+
+// ─── Agent Navigation ─────────────────────────────────────────────────────────
+
+export default class AgentNavigation {
+	constructor( private http: Http ){}
+
+	async location( body: AgentLocationValidation['body'] ): Promise<AgentLocationValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentLocationValidation['response']>>({
+			url: '/agent/navigation/location',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async nearby( body: AgentNearbyValidation['body'], querystring?: AgentNearbyValidation['querystring'] ): Promise<AgentNearbyValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentNearbyValidation['response']>>({
+			url: `/agent/navigation/nearby${qs( querystring )}`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/origin.ts

@@ -0,0 +1,42 @@
+import type {
+	AgentOriginStatusReportValidation,
+	AgentRegisterPoiValidation,
+	AgentAddPoiNoteValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Agent Origin ─────────────────────────────────────────────────────────────
+
+export default class AgentOrigin {
+	constructor( private http: Http ){}
+
+	async statusReport( body: AgentOriginStatusReportValidation['body'] ): Promise<AgentOriginStatusReportValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentOriginStatusReportValidation['response']>>({
+			url: '/agent/origin/status',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async registerPoi( body: AgentRegisterPoiValidation['body'] ): Promise<AgentRegisterPoiValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRegisterPoiValidation['response']>>({
+			url: '/agent/origin/poi/register',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async addPoiNote( body: AgentAddPoiNoteValidation['body'] ): Promise<AgentAddPoiNoteValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentAddPoiNoteValidation['response']>>({
+			url: '/agent/origin/poi/note',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/reallocation.ts

@@ -0,0 +1,18 @@
+import type { AgentReallocationRespondValidation } from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Agent Reallocation ───────────────────────────────────────────────────────
+
+export default class AgentReallocation {
+	constructor( private http: Http ){}
+
+	async respond( body: AgentReallocationRespondValidation['body'] ): Promise<AgentReallocationRespondValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentReallocationRespondValidation['response']>>({
+			url: '/agent/reallocation/respond',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/rides.ts

@@ -0,0 +1,73 @@
+import type {
+	AgentRideListValidation,
+	AgentRideGetValidation,
+	AgentRideAcceptValidation,
+	AgentRideStartValidation,
+	AgentRideCompleteValidation,
+	AgentRideCancelValidation
+} from '@de./types'
+import { qs, type Http, type Res } from '../../utils'
+
+// ─── Agent Ride Orders ────────────────────────────────────────────────────────
+
+export default class AgentRides {
+	constructor( private http: Http ){}
+
+	async list( querystring?: AgentRideListValidation['querystring'] ): Promise<AgentRideListValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideListValidation['response']>>({
+			url: `/agent/ride/orders${qs( querystring )}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async get( reference: string ): Promise<AgentRideGetValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideGetValidation['response']>>({
+			url: `/agent/ride/orders/${reference}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async accept( reference: string, body: AgentRideAcceptValidation['body'] ): Promise<AgentRideAcceptValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideAcceptValidation['response']>>({
+			url: `/agent/ride/orders/${reference}/accept`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async start( reference: string, body: AgentRideStartValidation['body'] ): Promise<AgentRideStartValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideStartValidation['response']>>({
+			url: `/agent/ride/orders/${reference}/start`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async complete( reference: string, body: AgentRideCompleteValidation['body'] ): Promise<AgentRideCompleteValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideCompleteValidation['response']>>({
+			url: `/agent/ride/orders/${reference}/complete`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async cancel( reference: string, body: AgentRideCancelValidation['body'] ): Promise<AgentRideCancelValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentRideCancelValidation['response']>>({
+			url: `/agent/ride/orders/${reference}/cancel`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Agent/shipping.ts

@@ -0,0 +1,61 @@
+import type {
+	AgentShippingListValidation,
+	AgentShippingGetValidation,
+	AgentShippingAcceptValidation,
+	AgentShippingUpdateStatusValidation,
+	AgentShippingReportIssueValidation
+} from '@de./types'
+import { qs, type Http, type Res } from '../../utils'
+
+// ─── Agent Shipping Orders ────────────────────────────────────────────────────
+
+export default class AgentShipping {
+	constructor( private http: Http ){}
+
+	async list( querystring?: AgentShippingListValidation['querystring'] ): Promise<AgentShippingListValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentShippingListValidation['response']>>({
+			url: `/agent/shipping/orders${qs( querystring )}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async get( reference: string ): Promise<AgentShippingGetValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentShippingGetValidation['response']>>({
+			url: `/agent/shipping/orders/${reference}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async accept( reference: string ): Promise<AgentShippingAcceptValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentShippingAcceptValidation['response']>>({
+			url: `/agent/shipping/orders/${reference}/accept`,
+			method: 'POST'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async updateStatus( reference: string, body: AgentShippingUpdateStatusValidation['body'] ): Promise<AgentShippingUpdateStatusValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentShippingUpdateStatusValidation['response']>>({
+			url: `/agent/shipping/orders/${reference}/status`,
+			method: 'PATCH',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async reportIssue( reference: string, body: AgentShippingReportIssueValidation['body'] ): Promise<AgentShippingReportIssueValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<AgentShippingReportIssueValidation['response']>>({
+			url: `/agent/shipping/orders/${reference}/issue`,
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/CSP/analytics.ts

@@ -0,0 +1,73 @@
+import type {
+	CSPAnalyticsOrdersValidation,
+	CSPAnalyticsFulfillmentValidation,
+	CSPAnalyticsProvidersValidation,
+	CSPAnalyticsGenerateReportValidation,
+	CSPAnalyticsGetReportValidation,
+	CSPAnalyticsListReportsValidation
+} from '@de./types/csp/analytics'
+import { qs, type Http, type Res } from '../../utils'
+
+// ── CSP Analytics ─────────────────────────────────────────────────────────
+
+export default class CSPAnalytics {
+	constructor( private http: Http ){}
+
+	async orders( body: CSPAnalyticsOrdersValidation['body'] ): Promise<CSPAnalyticsOrdersValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsOrdersValidation['response']>>({
+			url: '/csp/analytics/orders',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async fulfillment( body: CSPAnalyticsFulfillmentValidation['body'] ): Promise<CSPAnalyticsFulfillmentValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsFulfillmentValidation['response']>>({
+			url: '/csp/analytics/fulfillment',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async providers( body: CSPAnalyticsProvidersValidation['body'] ): Promise<CSPAnalyticsProvidersValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsProvidersValidation['response']>>({
+			url: '/csp/analytics/providers',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async generateReport( body: CSPAnalyticsGenerateReportValidation['body'] ): Promise<CSPAnalyticsGenerateReportValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsGenerateReportValidation['response']>>({
+			url: '/csp/analytics/reports',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async getReport( id: string ): Promise<CSPAnalyticsGetReportValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsGetReportValidation['response']>>({
+			url: `/csp/analytics/reports/${id}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async listReports( querystring?: CSPAnalyticsListReportsValidation['querystring'] ): Promise<CSPAnalyticsListReportsValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<CSPAnalyticsListReportsValidation['response']>>({
+			url: `/csp/analytics/reports${qs( querystring )}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/CSP/index.ts

@@ -0,0 +1,51 @@
+import type { AccessOptions } from '../../types/access'
+import SharedContextClient from '../Shared/context'
+import SharedOperators from '../Shared/operators'
+import CSPOrders from './orders'
+import CSPWebhooks from './webhooks'
+import CSPAnalytics from './analytics'
+import CSPInventory from './inventory'
+
+export type CSPConfig = {
+	context: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// CSP: Commerce Service Provider API — de.arch /csp routes.
+// Covers orders, inventory, webhooks, analytics, plus shared faqs/users/account/
+// invitation (SharedContextClient) and operators.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class CSP extends SharedContextClient<'CSP'> {
+	readonly operators: SharedOperators<'CSP'>
+	readonly orders:    CSPOrders
+	readonly webhooks:  CSPWebhooks
+	readonly analytics: CSPAnalytics
+	readonly inventory: CSPInventory
+
+	constructor( config: CSPConfig ){
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/csp')
+		if( !config.accessToken ) throw new Error('Undefined accessToken. See https://doc.dedot.io/sdk/auth')
+
+		const access: AccessOptions = {
+			context:      config.context,
+			accessToken:  config.accessToken,
+			env:          config.env      || 'dev',
+			platform:     config.platform || 'proxy',
+			remoteOrigin: config.remoteOrigin
+		}
+		super( access, 'CSP' )
+
+		this.operators = new SharedOperators( this, 'CSP' )
+		this.orders    = new CSPOrders( this )
+		this.webhooks  = new CSPWebhooks( this )
+		this.analytics = new CSPAnalytics( this )
+		this.inventory = new CSPInventory( this )
+	}
+}