@de./sdk 1.0.4 → 1.0.5

package/src/allend/Tracking/index.ts

@@ -0,0 +1,44 @@
+import type { AccessOptions } from '../../types/access'
+import type { SharedTrackingSessionValidation } from '@de./types/shared/tracking'
+import AccessManager from '../Access'
+import { qs, type Res } from '../../utils'
+
+export type TrackingConfig = {
+	accessToken: string
+	context: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// Tracking: shared tracking API — de.arch /tracking routes.
+// Issues join-room tokens for Socket.IO real-time order tracking.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Tracking extends AccessManager {
+	constructor( config: TrackingConfig ){
+		if( !config.accessToken ) throw new Error('Undefined accessToken. See https://doc.dedot.io/sdk/auth')
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/tracking')
+
+		const access: AccessOptions = {
+			context:      config.context,
+			accessToken:  config.accessToken,
+			env:          config.env      || 'dev',
+			platform:     config.platform || 'proxy',
+			remoteOrigin: config.remoteOrigin
+		}
+		super( access, 'API' )
+	}
+
+	async getSession( reference: string, role: SharedTrackingSessionValidation['querystring']['role'] ): Promise<SharedTrackingSessionValidation['response']> {
+		const { error, message, data } = await this.request<Res<SharedTrackingSessionValidation['response']>>({
+			url: `/tracking/${reference}${qs({ role })}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Utilities/common.ts

@@ -0,0 +1,75 @@
+import type {
+	UtilDistanceValidation,
+	UtilBatchDistanceMatrixValidation,
+	UtilSavingsMatrixValidation,
+	UtilAssignZoneValidation,
+	UtilETAValidation,
+	UtilBatchGeocodeValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Common Utilities ─────────────────────────────────────────────────────────
+
+export class UtilitiesCommon {
+	constructor( private http: Http ){}
+
+	async distance( body: UtilDistanceValidation['body'] ): Promise<UtilDistanceValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilDistanceValidation['response']>>({
+			url: '/utilities/distance',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async distanceMatrix( body: UtilBatchDistanceMatrixValidation['body'] ): Promise<UtilBatchDistanceMatrixValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilBatchDistanceMatrixValidation['response']>>({
+			url: '/utilities/distance/matrix',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async savingsMatrix( body: UtilSavingsMatrixValidation['body'] ): Promise<UtilSavingsMatrixValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilSavingsMatrixValidation['response']>>({
+			url: '/utilities/distance/savings',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async assignZone( body: UtilAssignZoneValidation['body'] ): Promise<UtilAssignZoneValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilAssignZoneValidation['response']>>({
+			url: '/utilities/zone',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async eta( body: UtilETAValidation['body'] ): Promise<UtilETAValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilETAValidation['response']>>({
+			url: '/utilities/eta',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async batchGeocode( body: UtilBatchGeocodeValidation['body'] ): Promise<UtilBatchGeocodeValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilBatchGeocodeValidation['response']>>({
+			url: '/utilities/geocode/batch',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Utilities/fares.ts

@@ -0,0 +1,53 @@
+import type {
+	UtilDeliveryFeesValidation,
+	UtilTransportFareValidation,
+	UtilRideFareValidation,
+	UtilCrossBorderFareValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Fares ────────────────────────────────────────────────────────────────────
+
+export class UtilitiesFares {
+	constructor( private http: Http ){}
+
+	async deliveryFees( body: UtilDeliveryFeesValidation['body'] ): Promise<UtilDeliveryFeesValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilDeliveryFeesValidation['response']>>({
+			url: '/utilities/fares/delivery',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async transportFare( body: UtilTransportFareValidation['body'] ): Promise<UtilTransportFareValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilTransportFareValidation['response']>>({
+			url: '/utilities/fares/transport',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async rideFare( body: UtilRideFareValidation['body'] ): Promise<UtilRideFareValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilRideFareValidation['response']>>({
+			url: '/utilities/fares/ride',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async crossBorderFare( body: UtilCrossBorderFareValidation['body'] ): Promise<UtilCrossBorderFareValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilCrossBorderFareValidation['response']>>({
+			url: '/utilities/fares/crossborder',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/Utilities/index.ts

@@ -0,0 +1,46 @@
+import type { Env, Platform } from '../../types'
+import type { AccessOptions } from '../../types/access'
+import AccessManager from '../Access'
+import { UtilitiesCommon } from './common'
+import { UtilitiesFares } from './fares'
+import { UtilitiesNearby } from './nearby'
+
+// ─── Config ───────────────────────────────────────────────────────────────────
+
+export type UtilitiesConfig = {
+	context: string
+	accessToken: string
+	env?: Env
+	platform?: Platform
+	remoteOrigin?: string
+	version?: number
+}
+
+// ─── Utilities ────────────────────────────────────────────────────────────────
+
+export default class Utilities extends AccessManager {
+	readonly common: UtilitiesCommon
+	readonly fares:  UtilitiesFares
+	readonly nearby: UtilitiesNearby
+
+	constructor( config: UtilitiesConfig ){
+		if( !config )             throw new Error('Undefined config')
+		if( !config.context )     throw new Error('Undefined context')
+		if( !config.accessToken ) throw new Error('Undefined accessToken')
+
+		const access: AccessOptions = {
+			context:      config.context,
+			accessToken:  config.accessToken,
+			env:          config.env      || 'dev',
+			platform:     config.platform || 'proxy',
+			remoteOrigin: config.remoteOrigin,
+			version:      config.version
+		}
+
+		super( access, 'API' )
+
+		this.common = new UtilitiesCommon( this )
+		this.fares  = new UtilitiesFares( this )
+		this.nearby = new UtilitiesNearby( this )
+	}
+}

package/src/allend/Utilities/nearby.ts

@@ -0,0 +1,42 @@
+import type {
+	UtilSearchNearbyValidation,
+	UtilSearchInBoundsValidation,
+	UtilFindNearestValidation
+} from '@de./types'
+import { type Http, type Res } from '../../utils'
+
+// ─── Nearby ───────────────────────────────────────────────────────────────────
+
+export class UtilitiesNearby {
+	constructor( private http: Http ){}
+
+	async search( body: UtilSearchNearbyValidation['body'] ): Promise<UtilSearchNearbyValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilSearchNearbyValidation['response']>>({
+			url: '/utilities/nearby/search',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async searchInBounds( body: UtilSearchInBoundsValidation['body'] ): Promise<UtilSearchInBoundsValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilSearchInBoundsValidation['response']>>({
+			url: '/utilities/nearby/bounds',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	async findNearest( body: UtilFindNearestValidation['body'] ): Promise<UtilFindNearestValidation['response']> {
+		const { error, message, data } = await this.http.request<Res<UtilFindNearestValidation['response']>>({
+			url: '/utilities/nearby/nearest',
+			method: 'POST',
+			body
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+}

package/src/allend/{DClient → Workflows}/Client.ts

@@ -1,13 +1,9 @@
 import type { AccessOptions } from '../../types/access'
-import type { HTTPRequestOptions, RTLocation, OrderService, HTTPResponse, Entity  } from '../../types'
+import type { HTTPRequestOptions, RTLocation, MSIEntity, HTTPResponse } from '../../types'
 import AccessManager from '../Access'
 
-type OrderServiceResponse = HTTPResponse & {
-  orders: OrderService[]
-}
-type NearbyResponse = HTTPResponse & {
-  nearby: Entity[]
-}
+type OrderServiceResponse = HTTPResponse<{ orders: any[] }>
+type NearbyResponse = HTTPResponse<{ nearby: MSIEntity[] }>
 
 export default class Client extends AccessManager {
   private clientId: string
@@ -31,10 +27,10 @@ export default class Client extends AccessManager {
       url: `/client/${this.clientId}/orders/actives`,
       method: 'GET'
     },
-    { error, message, orders } = await this.request<OrderServiceResponse>( options )
+    { error, message, data } = await this.request<OrderServiceResponse>( options )
     if( error ) throw new Error( message )
     
-    return orders
+    return data.orders
   }
 
   async fetchOrderHistory(){
@@ -46,10 +42,10 @@ export default class Client extends AccessManager {
       url: `/client/${this.clientId}/orders/history`,
       method: 'GET'
     },
-    { error, message, orders } = await this.request<OrderServiceResponse>( options )
+    { error, message, data } = await this.request<OrderServiceResponse>( options )
     if( error ) throw new Error( message )
     
-    return orders
+    return data.orders
   }
 
   async nearby( location: RTLocation ){
@@ -68,9 +64,9 @@ export default class Client extends AccessManager {
       method: 'POST',
       body: location
     },
-    { error, message, nearby } = await this.request<NearbyResponse>( options )
+    { error, message, data } = await this.request<NearbyResponse>( options )
     if( error ) throw new Error( message )
     
-    return nearby
+    return data.nearby
   }
 }

package/src/allend/Workflows/Delivery.ts

@@ -0,0 +1,94 @@
+import type LSP from '../LSP'
+import type { Coordinates } from '../../types'
+
+// ─── Input types ──────────────────────────────────────────────────────────────
+
+export type DeliveryContact = {
+	type?: string
+	reference: string
+	phone?: string
+	email?: string
+}
+
+export type DeliveryLocation = {
+	address: string
+	coordinates: Coordinates
+	contact?: DeliveryContact
+	description?: string
+}
+
+export type DeliveryPackage = {
+	waypointNo?: number
+	careLevel?: number
+	category?: string
+	weight?: number
+	note?: string
+}
+
+export type DeliveryPickupInput = {
+	clientId: string
+	from: DeliveryLocation
+	to: DeliveryLocation
+	packages?: DeliveryPackage[]
+	service?: Record<string, any>
+}
+
+export type DeliveryResult = {
+	intentToken: string
+	jrtoken: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// LAYER 2 — Delivery workflow.
+// Composes Lsp.orders calls into a single "get this from A to B" operation:
+//   intent → addWaypoint → addPackage? → initiate
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Delivery {
+	constructor( private lsp: LSP ){}
+
+	// async pickup({ clientId, from, to, packages, service = {} }: DeliveryPickupInput ): Promise<DeliveryResult> {
+	// 	if( !clientId ) throw new Error('<clientId> required for delivery pickup')
+	// 	if( !from )     throw new Error('<from> location required')
+	// 	if( !to )       throw new Error('<to> location required')
+
+	// 	// 1 — Create intent session
+	// 	const intentToken = await this.lsp.orders.intent( clientId )
+
+	// 	// 2 — Register pickup + dropoff waypoints
+	// 	await this.lsp.orders.addWaypoint([
+	// 		{
+	// 			no: 1,
+	// 			type: 'pickup',
+	// 			description: from.description || from.address,
+	// 			coordinates: from.coordinates,
+	// 			address: from.address,
+	// 			contact: from.contact || { type: 'sender', reference: clientId }
+	// 		},
+	// 		{
+	// 			no: 2,
+	// 			type: 'dropoff',
+	// 			description: to.description || to.address,
+	// 			coordinates: to.coordinates,
+	// 			address: to.address,
+	// 			contact: to.contact || { type: 'receiver', reference: '' }
+	// 		}
+	// 	], intentToken )
+
+	// 	// 3 — Attach packages when provided
+	// 	if( packages?.length ){
+	// 		const stamped = packages.map(( pkg, i ) => ({
+	// 			...pkg,
+	// 			waypointNo: pkg.waypointNo ?? 2 // defaults to dropoff
+	// 		}))
+	// 		await this.lsp.orders.addPackage( stamped, intentToken )
+	// 	}
+
+	// 	// 4 — Initiate the order and get the job-reference token
+	// 	const jrtoken = await this.lsp.orders.initiate( service, intentToken )
+
+	// 	return { intentToken, jrtoken }
+	// }
+}

package/src/allend/Workflows/index.ts

@@ -0,0 +1,31 @@
+import type LSP from '../LSP'
+import type MSI from '../MSI'
+import Delivery from './Delivery'
+
+// ─── Config ───────────────────────────────────────────────────────────────────
+
+export type WorkflowsConfig = {
+	lsp: LSP
+	msi?: MSI
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// LAYER 2 — Workflows: use-case composition, many API calls in one.
+// Sits explicitly on top of Core — the consumer passes core to it,
+// making the dependency chain visible and testable.
+//
+//   const wf = new Workflows({ core })
+//   const { jrtoken } = await wf.delivery.pickup({ clientId, from, to, packages })
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Workflows {
+	readonly delivery: Delivery
+
+	constructor({ lsp }: WorkflowsConfig ){
+		if( !lsp ) throw new Error('<core> instance required. Pass a Core instance to Workflows.')
+
+		this.delivery = new Delivery( lsp )
+	}
+}

package/src/allend/Workspace/index.ts

@@ -0,0 +1,113 @@
+import type { AccessOptions } from '../../types/access'
+import type { HTTPResponse } from '../../types'
+import AccessManager from '../Access'
+
+export type WorkspaceConfig = {
+	context: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// Workspace: workspace management API — de.arch /workspace routes.
+// Covers admins, connectors, billings, and provider registrations
+// (LSPs, CSPs, IoTSPs, developers).
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Workspace extends AccessManager {
+	constructor( config: WorkspaceConfig ){
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/workspace')
+		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' )
+	}
+
+	// ── Index ─────────────────────────────────────────────────────────────────
+
+	async get(): Promise<any> {
+		const { error, message, data } = await this.request<HTTPResponse<any>>({
+			url: '/workspace',
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	// ── Admins ────────────────────────────────────────────────────────────────
+
+	async listAdmins( params?: Record<string, any> ): Promise<any[]> {
+		const qs = params ? '?' + new URLSearchParams( params ).toString() : ''
+		const { error, message, data } = await this.request<HTTPResponse<{ admins: any[] }>>({
+			url: `/workspace/admins${qs}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data.admins
+	}
+
+	// ── Connectors ────────────────────────────────────────────────────────────
+
+	async listConnectors( params?: Record<string, any> ): Promise<any[]> {
+		const qs = params ? '?' + new URLSearchParams( params ).toString() : ''
+		const { error, message, data } = await this.request<HTTPResponse<{ connectors: any[] }>>({
+			url: `/workspace/connectors${qs}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data.connectors
+	}
+
+	async getConnector( connectorId: string ): Promise<any> {
+		const { error, message, data } = await this.request<HTTPResponse<{ connector: any }>>({
+			url: `/workspace/connectors/${connectorId}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data.connector
+	}
+
+	// ── Billings ──────────────────────────────────────────────────────────────
+
+	async getBillings( params?: Record<string, any> ): Promise<any> {
+		const qs = params ? '?' + new URLSearchParams( params ).toString() : ''
+		const { error, message, data } = await this.request<HTTPResponse<any>>({
+			url: `/workspace/billings${qs}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data
+	}
+
+	// ── Providers ─────────────────────────────────────────────────────────────
+
+	async listLSPs( params?: Record<string, any> ): Promise<any[]> {
+		const qs = params ? '?' + new URLSearchParams( params ).toString() : ''
+		const { error, message, data } = await this.request<HTTPResponse<{ lsps: any[] }>>({
+			url: `/workspace/providers/lsps${qs}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data.lsps
+	}
+
+	async listCSPs( params?: Record<string, any> ): Promise<any[]> {
+		const qs = params ? '?' + new URLSearchParams( params ).toString() : ''
+		const { error, message, data } = await this.request<HTTPResponse<{ csps: any[] }>>({
+			url: `/workspace/providers/csps${qs}`,
+			method: 'GET'
+		})
+		if( error ) throw new Error( message )
+		return data.csps
+	}
+}

package/src/allend/index.ts

@@ -2,17 +2,28 @@ import MSI, { type MSIInterface } from './MSI'
 import Utils from '../utils'
 
 import IoTClient, { type IoTClientOptions } from './IoTClient'
-import Order from './DClient/Order'
-import Event from './DClient/Event'
-import Client from './DClient/Client'
+import Event from './Realtime'
+import Client from './Workflows/Client'
+import Customer, { type CustomerConfig } from './Customer'
+import Agent, { type AgentConfig } from './Agent'
+import Queries, { type QueriesConfig } from './Queries'
+import Utilities, { type UtilitiesConfig } from './Utilities'
 
-const DClient = { Client, Order, Event }
+const DClient = { Client, Event }
 
 export {
-  type MSIInterface,
-  MSI,
-  Utils,
-  DClient,
-  IoTClient,
-  type IoTClientOptions
+	type MSIInterface,
+	MSI,
+	Utils,
+	DClient,
+	IoTClient,
+	type IoTClientOptions,
+	Customer,
+	type CustomerConfig,
+	Agent,
+	type AgentConfig,
+	Queries,
+	type QueriesConfig,
+	Utilities,
+	type UtilitiesConfig
 }