@de./sdk 1.0.4 → 2.0.0

package/src/allend/IoTSP/devices.ts

@@ -0,0 +1,74 @@
+import type {
+	IoTDeviceAddValidation,
+	IoTDeviceFindValidation,
+	IoTDeviceListValidation,
+	IoTDeviceRemoveValidation,
+	IoTDeviceRetrieveValidation,
+	IoTDeviceStatusValidation,
+	IoTDeviceUpdateValidation
+} from '@de./types/iotsp/device'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── Devices ───────────────────────────────────────────────────────────────
+
+export default class IoTDevices {
+	constructor( private http: Http ){}
+
+	async add( body: IoTDeviceAddValidation['body'] ): Promise<IoTDeviceAddValidation['response']> {
+		return await this.http.request<IoTDeviceAddValidation['response']>({
+			url: `/iotsp/devices/add`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async update( id: string, body: IoTDeviceUpdateValidation['body'] ): Promise<IoTDeviceUpdateValidation['response']> {
+		return await this.http.request<IoTDeviceUpdateValidation['response']>({
+			url: `/iotsp/devices/${id}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async list( querystring?: IoTDeviceListValidation['querystring'] ): Promise<IoTDeviceListValidation['response']> {
+		return await this.http.request<IoTDeviceListValidation['response']>({
+			url: `/iotsp/devices${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async find( querystring: IoTDeviceFindValidation['querystring'] ): Promise<IoTDeviceFindValidation['response']> {
+		return await this.http.request<IoTDeviceFindValidation['response']>({
+			url: `/iotsp/devices/find${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async get( id: string ): Promise<IoTDeviceRetrieveValidation['response']> {
+		return await this.http.request<IoTDeviceRetrieveValidation['response']>({
+			url: `/iotsp/devices/${id}`,
+			method: 'GET'
+		})
+	}
+
+	async enable( id: string ): Promise<IoTDeviceStatusValidation['response']> {
+		return await this.http.request<IoTDeviceStatusValidation['response']>({
+			url: `/iotsp/devices/${id}/enable`,
+			method: 'PATCH'
+		})
+	}
+ 
+	async disable( id: string ): Promise<IoTDeviceStatusValidation['response']> {
+		return await this.http.request<IoTDeviceStatusValidation['response']>({
+			url: `/iotsp/devices/${id}/disable`,
+			method: 'PATCH'
+		})
+	}
+
+	async delete( id: string ): Promise<IoTDeviceRemoveValidation['response']> {
+		return await this.http.request<IoTDeviceRemoveValidation['response']>({
+			url: `/iotsp/devices/${id}`,
+			method: 'DELETE'
+		})
+	}
+}

package/src/allend/IoTSP/index.ts

@@ -0,0 +1,69 @@
+import type { AccessOptions } from '../../types/access'
+import SharedContextClient from '../Shared/context'
+import SharedOperators from '../Shared/operators'
+import IoTBackend, { type IoTBackendConfig, Records } from './backend'
+import IoTDevices from './devices'
+import IoTTopics from './topics'
+import IoTRules from './rules'
+
+export { Records }
+
+export type IoTSPConfig = {
+	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
+	backend?: IoTBackendConfig
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+//
+// IoTSP: IoT Service Provider API — de.arch /iotsp routes.
+// Covers device management, topics, rules, plus shared faqs/users/account/
+// invitation (SharedContextClient) and operators.
+//
+// ─────────────────────────────────────────────────────────────────────────────
+
+export default class IoTSP extends SharedContextClient<'IoTSP'> {
+	private readonly BackendInstance?: IoTBackend
+	readonly operators: SharedOperators<'IoTSP'>
+	readonly devices:   IoTDevices
+	readonly topics:    IoTTopics
+	readonly rules:     IoTRules
+
+	constructor( config: IoTSPConfig ){
+		if( !config.context )     throw new Error('Undefined context. See https://doc.dedot.io/sdk/iotsp')
+		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, 'IoTSP' )
+
+		if( config.backend )
+			this.BackendInstance = new IoTBackend( config.backend )
+
+		this.operators = new SharedOperators( this, 'IoTSP' )
+		this.devices   = new IoTDevices( this )
+		this.topics    = new IoTTopics( this )
+		this.rules     = new IoTRules( this )
+	}
+
+	get backend(){
+		if( !this.BackendInstance )
+			throw new Error('No backend instance available. Expect <backend> config')
+
+		return this.BackendInstance
+	}
+}

package/src/allend/IoTSP/rules.ts

@@ -0,0 +1,99 @@
+import type {
+	IoTRuleAddValidation,
+	IoTRuleFindValidation,
+	IoTRuleListValidation,
+	IoTRuleRemoveValidation,
+	IoTRuleRetrieveValidation,
+	IoTRuleStatusValidation,
+	IoTRuleUpdateValidation,
+	IoTRuleConnectorsValidation,
+	IoTRuleXssignConnectorValidation
+} from '@de./types/iotsp/rule'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── Rules ─────────────────────────────────────────────────────────────────
+
+export default class IoTRules {
+	constructor( private http: Http ) {}
+
+	async add( body: IoTRuleAddValidation['body'] ): Promise<IoTRuleAddValidation['response']> {
+		return await this.http.request<IoTRuleAddValidation['response']>({
+			url: '/iotsp/rules/add',
+			method: 'POST',
+			body
+		})
+	}
+
+	async update( reference: string, body: IoTRuleUpdateValidation['body'] ): Promise<IoTRuleUpdateValidation['response']> {
+		return await this.http.request<IoTRuleUpdateValidation['response']>({
+			url: `/iotsp/rules/${reference}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async list( querystring?: IoTRuleListValidation['querystring'] ): Promise<IoTRuleListValidation['response']> {
+		return await this.http.request<IoTRuleListValidation['response']>({
+			url: `/iotsp/rules${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async find( querystring: IoTRuleFindValidation['querystring'] ): Promise<IoTRuleFindValidation['response']> {
+		return await this.http.request<IoTRuleFindValidation['response']>({
+			url: `/iotsp/rules/find${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async get( reference: string ): Promise<IoTRuleRetrieveValidation['response']> {
+		return await this.http.request<IoTRuleRetrieveValidation['response']>({
+			url: `/iotsp/rules/${reference}`,
+			method: 'GET'
+		})
+	}
+
+	async enable( reference: string ): Promise<IoTRuleStatusValidation['response']> {
+		return await this.http.request<IoTRuleStatusValidation['response']>({
+			url: `/iotsp/rules/${reference}/enable`,
+			method: 'PATCH'
+		})
+	}
+
+	async disable( reference: string ): Promise<IoTRuleStatusValidation['response']> {
+		return await this.http.request<IoTRuleStatusValidation['response']>({
+			url: `/iotsp/rules/${reference}/disable`,
+			method: 'PATCH'
+		})
+	}
+
+	async delete( reference: string ): Promise<IoTRuleRemoveValidation['response']> {
+		return await this.http.request<IoTRuleRemoveValidation['response']>({
+			url: `/iotsp/rules/${reference}`,
+			method: 'DELETE'
+		})
+	}
+
+	async getConnectors( reference: string ): Promise<IoTRuleConnectorsValidation['response']> {
+		return await this.http.request<IoTRuleConnectorsValidation['response']>({
+			url: `/iotsp/rules/${reference}/connectors`,
+			method: 'GET'
+		})
+	}
+
+	async assignConnector( reference: string, body: IoTRuleXssignConnectorValidation['body'] ): Promise<IoTRuleXssignConnectorValidation['response']> {
+		return await this.http.request<IoTRuleXssignConnectorValidation['response']>({
+			url: `/iotsp/rules/${reference}/connector/assign`,
+			method: 'PUT',
+			body
+		})
+	}
+
+	async unassignConnector( reference: string, body: IoTRuleXssignConnectorValidation['body'] ): Promise<IoTRuleXssignConnectorValidation['response']> {
+		return await this.http.request<IoTRuleXssignConnectorValidation['response']>({
+			url: `/iotsp/rules/${reference}/connector/unassign`,
+			method: 'PATCH',
+			body
+		})
+	}
+}

package/src/allend/IoTSP/topics.ts

@@ -0,0 +1,99 @@
+import type {
+	IoTTopicRegisterValidation,
+	IoTTopicFindValidation,
+	IoTTopicListValidation,
+	IoTTopicUnregisterValidation,
+	IoTTopicRetrieveValidation,
+	IoTTopicStatusValidation,
+	IoTTopicUpdateValidation,
+	IoTTopicConnectorsValidation,
+	IoTTopicXssignConnectorValidation
+} from '@de./types/iotsp/topic'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── Topics ───────────────────────────────────────────────────────────────
+
+export default class IoTTopics {
+	constructor( private http: Http ){}
+
+	async add( body: IoTTopicRegisterValidation['body'] ): Promise<IoTTopicRegisterValidation['response']> {
+		return await this.http.request<IoTTopicRegisterValidation['response']>({
+			url: `/iotsp/topics/register`,
+			method: 'POST',
+			body
+		})
+	}
+
+	async update( reference: string, body: IoTTopicUpdateValidation['body'] ): Promise<IoTTopicUpdateValidation['response']> {
+		return await this.http.request<IoTTopicUpdateValidation['response']>({
+			url: `/iotsp/topics/${reference}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async list( querystring?: IoTTopicListValidation['querystring'] ): Promise<IoTTopicListValidation['response']> {
+		return await this.http.request<IoTTopicListValidation['response']>({
+			url: `/iotsp/topics${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async find( querystring: IoTTopicFindValidation['querystring'] ): Promise<IoTTopicFindValidation['response']> {
+		return await this.http.request<IoTTopicFindValidation['response']>({
+			url: `/iotsp/topics/find${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async get( reference: string ): Promise<IoTTopicRetrieveValidation['response']> {
+		return await this.http.request<IoTTopicRetrieveValidation['response']>({
+			url: `/iotsp/topics/${reference}`,
+			method: 'GET'
+		})
+	}
+
+	async enable( reference: string ): Promise<IoTTopicStatusValidation['response']> {
+		return await this.http.request<IoTTopicStatusValidation['response']>({
+			url: `/iotsp/topics/${reference}/enable`,
+			method: 'PATCH'
+		})
+	}
+ 
+	async disable( reference: string ): Promise<IoTTopicStatusValidation['response']> {
+		return await this.http.request<IoTTopicStatusValidation['response']>({
+			url: `/iotsp/topics/${reference}/disable`,
+			method: 'PATCH'
+		})
+	}
+
+	async delete( reference: string ): Promise<IoTTopicUnregisterValidation['response']> {
+		return await this.http.request<IoTTopicUnregisterValidation['response']>({
+			url: `/iotsp/topics/${reference}`,
+			method: 'DELETE'
+		})
+	}
+
+	async getConnectors( reference: string ): Promise<IoTTopicConnectorsValidation['response']> {
+		return await this.http.request<IoTTopicConnectorsValidation['response']>({
+			url: `/iotsp/topics/${reference}/connectors`,
+			method: 'GET'
+		})
+	}
+
+	async assignConnector( reference: string, body: IoTTopicXssignConnectorValidation['body'] ): Promise<IoTTopicXssignConnectorValidation['response']> {
+		return await this.http.request<IoTTopicXssignConnectorValidation['response']>({
+			url: `/iotsp/topics/${reference}/connector/assign`,
+			method: 'PUT',
+			body
+		})
+	}
+
+	async unassignConnector( reference: string, body: IoTTopicXssignConnectorValidation['body'] ): Promise<IoTTopicXssignConnectorValidation['response']> {
+		return await this.http.request<IoTTopicXssignConnectorValidation['response']>({
+			url: `/iotsp/topics/${reference}/connector/unassign`,
+			method: 'PATCH',
+			body
+		})
+	}
+}

package/src/allend/LSP/agents.ts

@@ -0,0 +1,115 @@
+import type { APIResponseBase } from '@de./types'
+import type {
+	LSPAgentRetrieveValidation,
+	LSPAgentListValidation,
+	LSPAgentUpdateValidation,
+	LSPAgentAssignVehicleValidation,
+	LSPAgentUnassignVehicleValidation,
+	LSPAgentRemoveValidation
+} from '@de./types/aux/agents'
+import type {
+	LSPConsolidationScheduleValidation,
+	LSPConsolidationFetchValidation,
+	LSPConsolidationGetValidation,
+	LSPConsolidationUpdateStateValidation,
+	LSPConsolidationCreatePointValidation,
+	LSPConsolidationFetchPointsValidation
+} from '@de./types/lsp/consolidation'
+import { qs, type Http, type Res, type Data } from '../../utils'
+
+// ── LSP Agents ────────────────────────────────────────────────────────────────
+
+export default class LSPAgents {
+	constructor( private http: Http ){}
+
+	async list( querystring?: LSPAgentListValidation['querystring'] ): Promise<LSPAgentListValidation['response']> {
+		return await this.http.request<LSPAgentListValidation['response']>({
+			url: `/lsp/agents${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async retrieve( id: string, querystring?: LSPAgentRetrieveValidation['querystring'] ): Promise<LSPAgentRetrieveValidation['response']> {
+		return await this.http.request<LSPAgentRetrieveValidation['response']>({
+			url: `/lsp/agents/${id}${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async update( id: string, body: LSPAgentUpdateValidation['body'] ): Promise<LSPAgentUpdateValidation['response']> {
+		return await this.http.request<LSPAgentUpdateValidation['response']>({
+			url: `/lsp/agents/${id}`,
+			method: 'PATCH',
+			body
+		})
+	}
+
+	async assignVehicle( id: string, body: LSPAgentAssignVehicleValidation['body'] ): Promise<LSPAgentAssignVehicleValidation['response']> {
+		return await this.http.request<LSPAgentAssignVehicleValidation['response']>({
+			url: `/lsp/agents/${id}/vehicle/assign`,
+			method: 'PUT',
+			body
+		})
+	}
+
+	async unassignVehicle( id: string ): Promise<LSPAgentUnassignVehicleValidation['response']> {
+		return await this.http.request<LSPAgentUnassignVehicleValidation['response']>({
+			url: `/lsp/agents/${id}/vehicle/unassign`,
+			method: 'PATCH'
+		})
+	}
+
+	async remove( id: string ): Promise<APIResponseBase> {
+		return await this.http.request<APIResponseBase>({
+			url: `/lsp/agents/${id}`,
+			method: 'DELETE'
+		})
+	}
+
+	// ── Consolidation ──────────────────────────────────────────────────────────
+
+	async scheduleConsolidation( body: LSPConsolidationScheduleValidation['body'] ): Promise<LSPConsolidationScheduleValidation['response']> {
+		return await this.http.request<LSPConsolidationScheduleValidation['response']>({
+			url: '/lsp/agents/consolidation/schedule',
+			method: 'POST',
+			body
+		})
+	}
+
+	async listConsolidations( querystring?: LSPConsolidationFetchValidation['querystring'] ): Promise<LSPConsolidationFetchValidation['response']> {
+		return await this.http.request<LSPConsolidationFetchValidation['response']>({
+			url: `/lsp/agents/consolidation${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+
+	async getConsolidation( consolidationId: string ): Promise<LSPConsolidationGetValidation['response']> {
+		return await this.http.request<LSPConsolidationGetValidation['response']>({
+			url: `/lsp/agents/consolidation/${consolidationId}`,
+			method: 'GET'
+		})
+	}
+
+	async updateConsolidationState( consolidationId: string, body: LSPConsolidationUpdateStateValidation['body'] ): Promise<LSPConsolidationUpdateStateValidation['response']> {
+		return await this.http.request<LSPConsolidationUpdateStateValidation['response']>({
+			url: `/lsp/agents/consolidation/${consolidationId}/state`,
+			method: 'PUT',
+			body
+		})
+	}
+
+	async createConsolidationPoint( body: LSPConsolidationCreatePointValidation['body'] ): Promise<LSPConsolidationCreatePointValidation['response']> {
+		return await this.http.request<LSPConsolidationCreatePointValidation['response']>({
+			url: '/lsp/agents/consolidation/points',
+			method: 'POST',
+			body
+		})
+	}
+
+	async listConsolidationPoints( querystring?: LSPConsolidationFetchPointsValidation['querystring'] ): Promise<LSPConsolidationFetchPointsValidation['response']> {
+		return await this.http.request<LSPConsolidationFetchPointsValidation['response']>({
+			url: `/lsp/agents/consolidation/points${qs( querystring )}`,
+			method: 'GET'
+		})
+	}
+}