@de./sdk 1.0.4 → 2.0.0

package/src/allend/CSP/orders.ts

@@ -0,0 +1,121 @@
+import type {
+	CSPOrderCreateValidation,
+	CSPOrderRetrieveValidation,
+	CSPOrderListValidation,
+	CSPOrderUpdateValidation,
+	CSPOrderTrackingValidation,
+	CSPOrderCancelValidation,
+	CSPOrderTimelineValidation,
+	CSPOrderReportExceptionValidation,
+	CSPOrderListExceptionsValidation,
+	CSPOrderResolveExceptionValidation,
+	CSPOrderDispatchValidation,
+	CSPOrderSplitValidation,
+	CSPOrderUpdateStatusValidation
+} from '@de./types/csp/order'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── CSP Orders ────────────────────────────────────────────────────────────
+
+export default class CSPOrders {
+	constructor( private http: Http ){}
+
+	async create( body: CSPOrderCreateValidation['body'] ): Promise<CSPOrderCreateValidation['response']> {
+		return await this.http.request<CSPOrderCreateValidation['response']>({
+			url: '/csp/orders',
+			method: 'POST',
+			body
+		})
+	}
+
+	async retrieve( reference: string ): Promise<CSPOrderRetrieveValidation['response']> {
+		return await this.http.request<CSPOrderRetrieveValidation['response']>({
+			url: `/csp/orders/${reference}`,
+			method: 'GET'
+		})
+	}
+
+	async list( querystring?: CSPOrderListValidation['querystring'] ): Promise<CSPOrderListValidation['response']> {
+		return await this.http.request<CSPOrderListValidation['response']>({
+			url: `/csp/orders${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async update( reference: string, body: CSPOrderUpdateValidation['body'] ): Promise<CSPOrderUpdateValidation['response']> {
+		return await this.http.request<CSPOrderUpdateValidation['response']>({
+			url: `/csp/orders/${reference}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async tracking( reference: string ): Promise<CSPOrderTrackingValidation['response']> {
+		return await this.http.request<CSPOrderTrackingValidation['response']>({
+			url: `/csp/orders/${reference}/tracking`,
+			method: 'GET'
+		})
+	}
+
+	async cancel( reference: string, body: CSPOrderCancelValidation['body'] ): Promise<CSPOrderCancelValidation['response']> {
+		return await this.http.request<CSPOrderCancelValidation['response']>({
+			url: `/csp/orders/${reference}/cancel`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async timeline( reference: string ): Promise<CSPOrderTimelineValidation['response']> {
+		return await this.http.request<CSPOrderTimelineValidation['response']>({
+			url: `/csp/orders/${reference}/timeline`,
+			method: 'GET'
+		})
+	}
+
+	async reportException( reference: string, body: CSPOrderReportExceptionValidation['body'] ): Promise<CSPOrderReportExceptionValidation['response']> {
+		return await this.http.request<CSPOrderReportExceptionValidation['response']>({
+			url: `/csp/orders/${reference}/exceptions`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async listExceptions( reference: string ): Promise<CSPOrderListExceptionsValidation['response']> {
+		return await this.http.request<CSPOrderListExceptionsValidation['response']>({
+			url: `/csp/orders/${reference}/exceptions`,
+			method: 'GET'
+		})
+	}
+
+	async resolveException( reference: string, exceptionId: string, body: CSPOrderResolveExceptionValidation['body'] ): Promise<CSPOrderResolveExceptionValidation['response']> {
+		return await this.http.request<CSPOrderResolveExceptionValidation['response']>({
+			url: `/csp/orders/${reference}/exceptions/${exceptionId}/resolve`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async dispatch( reference: string, body: CSPOrderDispatchValidation['body'] ): Promise<CSPOrderDispatchValidation['response']> {
+		return await this.http.request<CSPOrderDispatchValidation['response']>({
+			url: `/csp/orders/${reference}/dispatch`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async split( reference: string, body: CSPOrderSplitValidation['body'] ): Promise<CSPOrderSplitValidation['response']> {
+		return await this.http.request<CSPOrderSplitValidation['response']>({
+			url: `/csp/orders/${reference}/split`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async updateStatus( reference: string, body: CSPOrderUpdateStatusValidation['body'] ): Promise<CSPOrderUpdateStatusValidation['response']> {
+		return await this.http.request<CSPOrderUpdateStatusValidation['response']>({
+			url: `/csp/orders/${reference}/status`,
+			method: 'PATCH',
+			body
+		})
+	}
+}

package/src/allend/CSP/webhooks.ts

@@ -0,0 +1,68 @@
+import type {
+	CSPWebhookCreateValidation,
+	CSPWebhookListValidation,
+	CSPWebhookRetrieveValidation,
+	CSPWebhookUpdateValidation,
+	CSPWebhookRemoveValidation,
+	CSPWebhookLogsValidation,
+	CSPWebhookTestValidation
+} from '@de./types/csp/webhook'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── CSP Webhooks ──────────────────────────────────────────────────────────
+
+export default class CSPWebhooks {
+	constructor( private http: Http ){}
+
+	async create( body: CSPWebhookCreateValidation['body'] ): Promise<CSPWebhookCreateValidation['response']> {
+		return await this.http.request<CSPWebhookCreateValidation['response']>({
+			url: '/csp/webhooks',
+			method: 'POST',
+			body
+		})
+	}
+
+	async list( querystring?: CSPWebhookListValidation['querystring'] ): Promise<CSPWebhookListValidation['response']> {
+		return await this.http.request<CSPWebhookListValidation['response']>({
+			url: `/csp/webhooks${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async retrieve( id: string ): Promise<CSPWebhookRetrieveValidation['response']> {
+		return await this.http.request<CSPWebhookRetrieveValidation['response']>({
+			url: `/csp/webhooks/${id}`,
+			method: 'GET'
+		})
+	}
+
+	async update( id: string, body: CSPWebhookUpdateValidation['body'] ): Promise<CSPWebhookUpdateValidation['response']> {
+		return await this.http.request<CSPWebhookUpdateValidation['response']>({
+			url: `/csp/webhooks/${id}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async remove( id: string ): Promise<CSPWebhookRemoveValidation['response']> {
+		return await this.http.request<CSPWebhookRemoveValidation['response']>({
+			url: `/csp/webhooks/${id}`,
+			method: 'DELETE'
+		})
+	}
+
+	async logs( id: string, querystring?: CSPWebhookLogsValidation['querystring'] ): Promise<CSPWebhookLogsValidation['response']> {
+		return await this.http.request<CSPWebhookLogsValidation['response']>({
+			url: `/csp/webhooks/${id}/logs${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async test( id: string, body?: CSPWebhookTestValidation['body'] ): Promise<CSPWebhookTestValidation['response']> {
+		return await this.http.request<CSPWebhookTestValidation['response']>({
+			url: `/csp/webhooks/${id}/test`,
+			method: 'POST',
+			body
+		})
+	}
+}

package/src/allend/Customer/index.ts

@@ -0,0 +1,56 @@
+import type { AccessOptions, UserSession } from '../../types/access'
+import AccessManager from '../Access'
+import CustomerIntents from './intents'
+import CustomerOrders from './orders'
+import CustomerRides from './rides'
+
+export type CustomerConfig = {
+	context: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+	/** Per-request deadline in ms. See `AccessOptions.timeout`. */
+	timeout?: number
+	/** Explicit service origin, overriding the env table. See `AccessOptions.baseUrl`. */
+	baseUrl?: string
+	/**
+	 * The signed-in customer, when the client acts on their behalf rather
+	 * than as the integration itself.
+	 */
+	session?: UserSession
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// Customer: Customer Operation Interfaces — de.arch AUX/customer routes.
+// Covers intents, orders, and rides.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class Customer extends AccessManager {
+	intents: CustomerIntents
+	orders: CustomerOrders
+	rides: CustomerRides
+
+	constructor( config: CustomerConfig ){
+		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,
+			timeout:      config.timeout,
+			baseUrl:      config.baseUrl,
+			session:      config.session
+		}
+		super( access, 'API' )
+
+		this.intents = new CustomerIntents( this )
+		this.orders  = new CustomerOrders( this )
+		this.rides   = new CustomerRides( this )
+	}
+}

package/src/allend/Customer/intents.ts

@@ -0,0 +1,66 @@
+import type {
+	CustomerIntentCreateValidation,
+	CustomerIntentGetValidation,
+	CustomerIntentAddWaypointsValidation,
+	CustomerIntentAddPackagesValidation,
+	CustomerIntentSubmitValidation,
+	CustomerIntentCancelValidation
+} from '@de./types'
+import { type Http, type Res, type Data } from '../../utils'
+
+// ─── Customer Intents ─────────────────────────────────────────────────────────
+
+export default class CustomerIntents {
+	constructor( private http: Http ){}
+
+	async create( body: CustomerIntentCreateValidation['body'] ): Promise<CustomerIntentCreateValidation['response']> {
+		return await this.http.request<CustomerIntentCreateValidation['response']>({
+			url: '/customer/intents',
+			method: 'POST',
+			body
+		})
+	}
+
+	async get( intentToken: string ): Promise<CustomerIntentGetValidation['response']> {
+		return await this.http.request<CustomerIntentGetValidation['response']>({
+			url: '/customer/intents',
+			method: 'GET',
+			headers: { 'x-intent-token': intentToken }
+		})
+	}
+
+	async addWaypoints( intentToken: string, body: CustomerIntentAddWaypointsValidation['body'] ): Promise<CustomerIntentAddWaypointsValidation['response']> {
+		return await this.http.request<CustomerIntentAddWaypointsValidation['response']>({
+			url: '/customer/intents/waypoints',
+			method: 'POST',
+			headers: { 'x-intent-token': intentToken },
+			body
+		})
+	}
+
+	async addPackages( intentToken: string, body: CustomerIntentAddPackagesValidation['body'] ): Promise<CustomerIntentAddPackagesValidation['response']> {
+		return await this.http.request<CustomerIntentAddPackagesValidation['response']>({
+			url: '/customer/intents/packages',
+			method: 'POST',
+			headers: { 'x-intent-token': intentToken },
+			body
+		})
+	}
+
+	async submit( intentToken: string, body: CustomerIntentSubmitValidation['body'] ): Promise<CustomerIntentSubmitValidation['response']> {
+		return await this.http.request<CustomerIntentSubmitValidation['response']>({
+			url: '/customer/intents/submit',
+			method: 'POST',
+			headers: { 'x-intent-token': intentToken },
+			body
+		})
+	}
+
+	async cancel( intentToken: string ): Promise<CustomerIntentCancelValidation['response']> {
+		return await this.http.request<CustomerIntentCancelValidation['response']>({
+			url: '/customer/intents',
+			method: 'DELETE',
+			headers: { 'x-intent-token': intentToken }
+		})
+	}
+}

package/src/allend/Customer/orders.ts

@@ -0,0 +1,51 @@
+import type {
+	CustomerOrderListValidation,
+	CustomerOrderGetValidation,
+	CustomerOrderTrackingValidation,
+	CustomerOrderCancelValidation,
+	CustomerOrderRatingValidation
+} from '@de./types'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ─── Customer Orders ──────────────────────────────────────────────────────────
+
+export default class CustomerOrders {
+	constructor( private http: Http ){}
+
+	async list( querystring?: CustomerOrderListValidation['querystring'] ): Promise<CustomerOrderListValidation['response']> {
+		return await this.http.request<CustomerOrderListValidation['response']>({
+			url: `/customer/orders${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async get( reference: string, querystring?: CustomerOrderGetValidation['querystring'] ): Promise<CustomerOrderGetValidation['response']> {
+		return await this.http.request<CustomerOrderGetValidation['response']>({
+			url: `/customer/orders/${reference}${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async tracking( reference: string ): Promise<CustomerOrderTrackingValidation['response']> {
+		return await this.http.request<CustomerOrderTrackingValidation['response']>({
+			url: `/customer/orders/${reference}/tracking`,
+			method: 'GET'
+		})
+	}
+
+	async cancel( reference: string, body: CustomerOrderCancelValidation['body'] ): Promise<CustomerOrderCancelValidation['response']> {
+		return await this.http.request<CustomerOrderCancelValidation['response']>({
+			url: `/customer/orders/${reference}/cancel`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async rating( reference: string, body: CustomerOrderRatingValidation['body'] ): Promise<CustomerOrderRatingValidation['response']> {
+		return await this.http.request<CustomerOrderRatingValidation['response']>({
+			url: `/customer/orders/${reference}/rating`,
+			method: 'POST',
+			body
+		})
+	}
+}

package/src/allend/Customer/rides.ts

@@ -0,0 +1,60 @@
+import type {
+	CustomerRideRequestValidation,
+	CustomerRideListValidation,
+	CustomerRideGetValidation,
+	CustomerRideTrackingValidation,
+	CustomerRideCancelValidation,
+	CustomerRideRatingValidation
+} from '@de./types'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ─── Customer Rides ───────────────────────────────────────────────────────────
+
+export default class CustomerRides {
+	constructor( private http: Http ){}
+
+	async request( body: CustomerRideRequestValidation['body'] ): Promise<CustomerRideRequestValidation['response']> {
+		return await this.http.request<CustomerRideRequestValidation['response']>({
+			url: '/customer/rides',
+			method: 'POST',
+			body
+		})
+	}
+
+	async list( querystring?: CustomerRideListValidation['querystring'] ): Promise<CustomerRideListValidation['response']> {
+		return await this.http.request<CustomerRideListValidation['response']>({
+			url: `/customer/rides${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async get( reference: string ): Promise<CustomerRideGetValidation['response']> {
+		return await this.http.request<CustomerRideGetValidation['response']>({
+			url: `/customer/rides/${reference}`,
+			method: 'GET'
+		})
+	}
+
+	async tracking( reference: string ): Promise<CustomerRideTrackingValidation['response']> {
+		return await this.http.request<CustomerRideTrackingValidation['response']>({
+			url: `/customer/rides/${reference}/tracking`,
+			method: 'GET'
+		})
+	}
+
+	async cancel( reference: string, body: CustomerRideCancelValidation['body'] ): Promise<CustomerRideCancelValidation['response']> {
+		return await this.http.request<CustomerRideCancelValidation['response']>({
+			url: `/customer/rides/${reference}/cancel`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async rating( reference: string, body: CustomerRideRatingValidation['body'] ): Promise<CustomerRideRatingValidation['response']> {
+		return await this.http.request<CustomerRideRatingValidation['response']>({
+			url: `/customer/rides/${reference}/rating`,
+			method: 'POST',
+			body
+		})
+	}
+}

package/src/allend/DEV/developers.ts

@@ -0,0 +1,42 @@
+import type { APIResponseBase } from '@de./types'
+import type {
+	DEVDeveloperRetrieveValidation,
+	DEVDeveloperFetchValidation,
+	DEVDeveloperUpdateValidation
+} from '@de./types/dev/developer'
+import { type Http, type Res, type Data } from '../../utils'
+
+// ── DEV Developers ──────────────────────────────────────────────────────────────
+
+export default class DEVDevelopers {
+	constructor( private http: Http ){}
+
+	async list(): Promise<DEVDeveloperFetchValidation['response']> {
+		return await this.http.request<DEVDeveloperFetchValidation['response']>({
+			url: '/dev/developers',
+			method: 'GET'
+		})
+	}
+
+	async retrieve( id: string ): Promise<DEVDeveloperRetrieveValidation['response']> {
+		return await this.http.request<DEVDeveloperRetrieveValidation['response']>({
+			url: `/dev/developers/${id}`,
+			method: 'GET'
+		})
+	}
+
+	async update( id: string, body: DEVDeveloperUpdateValidation['body'] ): Promise<DEVDeveloperUpdateValidation['response']> {
+		return await this.http.request<DEVDeveloperUpdateValidation['response']>({
+			url: `/dev/developers/${id}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async remove( id: string ): Promise<APIResponseBase> {
+		return await this.http.request<APIResponseBase>({
+			url: `/dev/developers/${id}`,
+			method: 'DELETE'
+		})
+	}
+}

package/src/allend/DEV/index.ts

@@ -0,0 +1,48 @@
+import type { AccessOptions } from '../../types/access'
+import SharedContextClient from '../Shared/context'
+import SharedOperators from '../Shared/operators'
+import DEVDevelopers from './developers'
+
+export type DEVConfig = {
+	context: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	platform?: 'web' | 'mobile' | 'server' | 'proxy'
+	remoteOrigin?: string
+	/** Per-request deadline in ms. See `AccessOptions.timeout`. */
+	timeout?: number
+	/** Explicit service origin, overriding the env table. See `AccessOptions.baseUrl`. */
+	baseUrl?: string
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// DEV: Developer Service Provider API — de.arch /v1/dev routes.
+// Covers developers, plus shared faqs/users/account/invitation (SharedContextClient)
+// and operators.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class DEV extends SharedContextClient<'DEV'> {
+	readonly operators:  SharedOperators<'DEV'>
+	readonly developers: DEVDevelopers
+
+	constructor( config: DEVConfig ){
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/dev')
+		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,
+			timeout:      config.timeout,
+			baseUrl:      config.baseUrl
+		}
+		super( access, 'DEV' )
+
+		this.operators  = new SharedOperators( this, 'DEV' )
+		this.developers = new DEVDevelopers( this )
+	}
+}

package/src/allend/IoTSP/backend.ts

@@ -0,0 +1,103 @@
+import { io, type Socket } from 'socket.io-client'
+import { baseURL as resolveBaseURL } from '../../baseUrl'
+
+// ─── Config ───────────────────────────────────────────────────────────────────
+
+export type IoTBackendConfig = {
+	channel: string
+	accessToken: string
+	env?: 'dev' | 'staging' | 'prod'
+	/** Host to substitute for `localhost` in `dev` (Eg. a native emulator) */
+	devHostname?: string
+}
+
+// ─── Record API ───────────────────────────────────────────────────────────────
+//
+// Thin wrapper around the socket-based IoT record operations.
+// All methods return promises that resolve with the broker's ack payload.
+
+export class Records {
+	constructor( private socket: Socket ){}
+
+	get( id: string ): Promise<any> {
+		return new Promise(( resolve, reject ) => {
+			if( !this.socket.connected ) 
+				return reject( new Error('Socket disconnected') )
+
+			this.socket.emit('@record:get', id, ( error: string, response: any ) =>
+				error ? reject( new Error( error ) ) : resolve( response )
+			)
+		})
+	}
+
+	fetch( params: { limit?: number, page?: number } = {} ): Promise<any> {
+		return new Promise(( resolve, reject ) => {
+			if( !this.socket.connected ) 
+				return reject( new Error('Socket disconnected') )
+
+			this.socket.emit('@record:fetch', params, ( error: string, response: any ) =>
+				error ? reject( new Error( error ) ) : resolve( response )
+			)
+		})
+	}
+
+	find( query: string ): Promise<any> {
+		return new Promise(( resolve, reject ) => {
+			if( !this.socket.connected ) 
+				return reject( new Error('Socket disconnected') )
+
+			this.socket.emit('@record:find', query, ( error: string, response: any ) =>
+				error ? reject( new Error( error ) ) : resolve( response )
+			)
+		})
+	}
+
+	delete( id: string ): Promise<any> {
+		return new Promise(( resolve, reject ) => {
+			if( !this.socket.connected ) 
+				return reject( new Error('Socket disconnected') )
+
+			this.socket.emit('@record:del', id, ( error: string, response: any ) =>
+				error ? reject( new Error( error ) ) : resolve( response )
+			)
+		})
+	}
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// IoT: realtime socket client for de.iotb channels.
+//
+//   const iot = new IoT({ channel: 'fleet-1', accessToken: token })
+//   const { socket, records } = iot.connect()
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class IoTBackend {
+	private config: IoTBackendConfig
+	private socket?: Socket
+
+	constructor( config: IoTBackendConfig ){
+		if( !config.channel )     throw new Error('Undefined channel. See https://doc.dedot.io/sdk/iot')
+		if( !config.accessToken ) throw new Error('Undefined accessToken. See https://doc.dedot.io/sdk/auth')
+
+		this.config = config
+	}
+
+	connect(): { socket: Socket, records: Records } {
+		const
+		host   = resolveBaseURL('IOT', this.config.env || 'dev', this.config.devHostname ),
+		socket = io(`${host}/${this.config.channel}`, {
+			auth: { accessToken: this.config.accessToken }
+		})
+
+		return {
+			socket,
+			records: new Records( socket )
+		}
+	}
+
+	disconnect(){
+		this.socket?.disconnect() 
+	}
+}