@de./types 1.0.0

package/src/aux/customer-rvs.ts

@@ -0,0 +1,421 @@
+import { Type, Static } from '@sinclair/typebox'
+import {
+	CustomerOrderIntentSchema as OrderIntentSchema,
+	CustomerOrderIntentServiceSchema as OrderIntentServiceSchema
+} from './customers'
+import { WaypointSchema } from '../routing'
+import { OrderPackageSchema } from '../order'
+import { AddressSchema } from '../geo'
+import { DProfileReferenceSchema } from '../de.profile'
+import { PassengerSchema, LuggageSchema } from '../lsp/order/ride'
+import { LSPTypeSchema } from '../lsp'
+import {
+	APIResponseBaseSchema,
+	APIResponseDataSchemaFactory,
+	APIHeadersSchema,
+	APIErrorSchema
+} from '../api'
+
+// ─── Intent token header ─────────────────────────────────────────────────
+
+const IntentTokenHeaderSchema = Type.Object({
+	'x-intent-token': Type.String()
+})
+
+// ─── Customer Intents (create, addWaypoints, addPackages, submit, cancel, get) ──
+
+export const CustomerIntentCreateRVS = {
+	headers: APIHeadersSchema,
+	body: Type.Object({
+		clientId: Type.String({ minLength: 1, maxLength: 200 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			intentToken: Type.String(),
+			reference: Type.String(),
+			expiry: Type.Number()
+		})
+	])
+}
+export type CustomerIntentCreateValidation = {
+	body: Static<typeof CustomerIntentCreateRVS.body>
+	response: Static<typeof CustomerIntentCreateRVS.response>
+}
+
+export const CustomerIntentAddWaypointsRVS = {
+	headers: Type.Intersect([
+		IntentTokenHeaderSchema,
+		APIHeadersSchema
+	]),
+	body: Type.Object({
+		waypoints: Type.Array(WaypointSchema, { minItems: 1 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			status: Type.String(),
+			waypoints: Type.Array(WaypointSchema)
+		})
+	])
+}
+export type CustomerIntentAddWaypointsValidation = {
+	body: Static<typeof CustomerIntentAddWaypointsRVS.body>
+	response: Static<typeof CustomerIntentAddWaypointsRVS.response>
+}
+
+export const CustomerIntentAddPackagesRVS = {
+	headers: Type.Intersect([
+		IntentTokenHeaderSchema,
+		APIHeadersSchema
+	]),
+	body: Type.Object({
+		packages: Type.Array(OrderPackageSchema, { minItems: 1 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			status: Type.String(),
+			packages: Type.Array(OrderPackageSchema)
+		})
+	])
+}
+export type CustomerIntentAddPackagesValidation = {
+	body: Static<typeof CustomerIntentAddPackagesRVS.body>
+	response: Static<typeof CustomerIntentAddPackagesRVS.response>
+}
+
+export const CustomerIntentSubmitRVS = {
+	headers: Type.Intersect([
+		IntentTokenHeaderSchema,
+		APIHeadersSchema
+	]),
+	body: Type.Object({
+		service: OrderIntentServiceSchema,
+		dprofile: Type.Optional(Type.Object({
+			id: Type.Optional(Type.String()),
+			reference: Type.Optional(Type.String()),
+			type: Type.Union([
+				Type.Literal('CUSTOMER'),
+				Type.Literal('WAREHOUSE'),
+				Type.Literal('STORE')
+			])
+		}))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		Type.Object({
+			message: Type.String(),
+			data: Type.Object({
+				reference: Type.String(),
+				intentToken: Type.String()
+			})
+		})
+	])
+}
+export type CustomerIntentSubmitValidation = {
+	body: Static<typeof CustomerIntentSubmitRVS.body>
+	response: Static<typeof CustomerIntentSubmitRVS.response>
+}
+
+export const CustomerIntentCancelRVS = {
+	headers: Type.Intersect([
+		IntentTokenHeaderSchema,
+		APIHeadersSchema
+	]),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		Type.Object({ message: Type.String() })
+	])
+}
+export type CustomerIntentCancelValidation = {
+	response: Static<typeof CustomerIntentCancelRVS.response>
+}
+
+export const CustomerIntentGetRVS = {
+	headers: Type.Intersect([
+		IntentTokenHeaderSchema,
+		APIHeadersSchema
+	]),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			intent: OrderIntentSchema
+		})
+	])
+}
+export type CustomerIntentGetValidation = {
+	response: Static<typeof CustomerIntentGetRVS.response>
+}
+
+// ─── Customer Orders (list, get, tracking, cancel, rating) ──────────────
+
+const LSP_TYPE_NAMES = LSPTypeSchema.anyOf.map((t: any) => t.const.toLowerCase()).join(', ')
+
+export const CustomerOrderListRVS = {
+	headers: APIHeadersSchema,
+	querystring: Type.Object({
+		type: Type.Optional(Type.Union([
+			Type.Literal('active'),
+			Type.Literal('history'),
+			Type.Literal('all')
+		])),
+		tracking: Type.Optional(Type.String()),
+		limit: Type.Optional(Type.Number({ minimum: 1, maximum: 100 })),
+		offset: Type.Optional(Type.Number({ minimum: 0 }))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			orders: Type.Array(Type.Any()),
+			total: Type.Number(),
+			limit: Type.Number(),
+			offset: Type.Number()
+		})
+	])
+}
+export type CustomerOrderListValidation = {
+	querystring: Static<typeof CustomerOrderListRVS.querystring>
+	response: Static<typeof CustomerOrderListRVS.response>
+}
+
+export const CustomerOrderGetRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	querystring: Type.Object({
+		include: Type.Optional(Type.String({
+			description: `Comma-separated namespaces to include. Options: csp, ${LSP_TYPE_NAMES}, agent. Use "*" for all. Use "lsp" for all LSP types. Default: all`,
+			examples: ['csp,warehouse,agent', 'csp,carrier', '*', 'warehouse']
+		}))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			order: Type.Object({
+				csp: Type.Optional(Type.Any({ description: 'CSP order data' })),
+				hierarchySummary: Type.Optional(Type.Object({
+					totalDescendants: Type.Number(),
+					descendantsByType: Type.Record(Type.String(), Type.Array(Type.String())),
+					allDescendantReferences: Type.Array(Type.String())
+				}, { description: 'Quick reference summary of order hierarchy' })),
+				agent: Type.Optional(Type.Any({ description: 'First agent found in hierarchy (DFS traversal)' }))
+			},
+			{
+				additionalProperties: Type.Array(Type.Any(), {
+					description: `Dynamic LSP type namespaces (${LSP_TYPE_NAMES}). Each contains array of orders with full descendant hierarchy.`
+				})
+			})
+		})
+	])
+}
+export type CustomerOrderGetValidation = {
+	params: Static<typeof CustomerOrderGetRVS.params>
+	querystring: Static<typeof CustomerOrderGetRVS.querystring>
+	response: Static<typeof CustomerOrderGetRVS.response>
+}
+
+export const CustomerOrderTrackingRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			jrtoken: Type.String(),
+			service: Type.Optional(Type.Any()),
+			agent: Type.Optional(Type.Any())
+		})
+	])
+}
+export type CustomerOrderTrackingValidation = {
+	params: Static<typeof CustomerOrderTrackingRVS.params>
+	response: Static<typeof CustomerOrderTrackingRVS.response>
+}
+
+export const CustomerOrderCancelRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	body: Type.Object({
+		reason: Type.String({ minLength: 1, maxLength: 500 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			orderReference: Type.String()
+		})
+	])
+}
+export type CustomerOrderCancelValidation = {
+	params: Static<typeof CustomerOrderCancelRVS.params>
+	body: Static<typeof CustomerOrderCancelRVS.body>
+	response: Static<typeof CustomerOrderCancelRVS.response>
+}
+
+export const CustomerOrderRatingRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	body: Type.Object({
+		rating: Type.Number({ minimum: 1, maximum: 5 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		Type.Object({ message: Type.String() })
+	])
+}
+export type CustomerOrderRatingValidation = {
+	params: Static<typeof CustomerOrderRatingRVS.params>
+	body: Static<typeof CustomerOrderRatingRVS.body>
+	response: Static<typeof CustomerOrderRatingRVS.response>
+}
+
+// ─── Customer Rides (request, list, get, tracking, cancel, rating) ──────
+
+export const CustomerRideRequestRVS = {
+	headers: APIHeadersSchema,
+	body: Type.Object({
+		pickup: AddressSchema,
+		dropoff: AddressSchema,
+		passengers: Type.Array(PassengerSchema, { minItems: 1 }),
+		luggage: Type.Optional(LuggageSchema),
+		preferences: Type.Optional(Type.Object({
+			ac: Type.Optional(Type.Boolean()),
+			music: Type.Optional(Type.Boolean()),
+			conversation: Type.Optional(Type.Boolean()),
+			temperature: Type.Optional(Type.Number({ minimum: 16, maximum: 30 }))
+		})),
+		instructions: Type.Optional(Type.String({ maxLength: 500 })),
+		paymentMethod: Type.Union([
+			Type.Literal('CASH'),
+			Type.Literal('CARD'),
+			Type.Literal('WALLET'),
+			Type.Literal('CORPORATE'),
+			Type.Literal('OTHER')
+		]),
+		scheduledAt: Type.Optional(Type.Number({ description: 'Unix timestamp for scheduled ride; omit for immediate' }))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			reference: Type.String(),
+			fare: Type.Any(),
+			estimatedPickup: Type.Number(),
+			nearbyDrivers: Type.Number(),
+			fareMetadata: Type.Object({
+				accuracy: Type.Union([
+					Type.Literal('ESTIMATE'),
+					Type.Literal('STANDARD'),
+					Type.Literal('PRECISE')
+				]),
+				confidence: Type.Number(),
+				dataSource: Type.Union([
+					Type.Literal('LSP'),
+					Type.Literal('FALLBACK'),
+					Type.Literal('HYBRID')
+				]),
+				calculatedAt: Type.Number(),
+				disclaimer: Type.String()
+			})
+		})
+	])
+}
+export type CustomerRideRequestValidation = {
+	body: Static<typeof CustomerRideRequestRVS.body>
+	response: Static<typeof CustomerRideRequestRVS.response>
+}
+
+export const CustomerRideListRVS = {
+	headers: APIHeadersSchema,
+	querystring: Type.Object({
+		type: Type.Optional(Type.Union([
+			Type.Literal('active'),
+			Type.Literal('history'),
+			Type.Literal('all')
+		], { default: 'active' })),
+		limit: Type.Optional(Type.Number({ minimum: 1, maximum: 100, default: 20 })),
+		offset: Type.Optional(Type.Number({ minimum: 0, default: 0 }))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			rides: Type.Array(Type.Any()),
+			total: Type.Number(),
+			limit: Type.Number(),
+			offset: Type.Number()
+		})
+	])
+}
+export type CustomerRideListValidation = {
+	querystring: Static<typeof CustomerRideListRVS.querystring>
+	response: Static<typeof CustomerRideListRVS.response>
+}
+
+export const CustomerRideGetRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			ride: Type.Any(),
+			jrtoken: Type.String(),
+			agent: Type.Optional(Type.Any())
+		})
+	])
+}
+export type CustomerRideGetValidation = {
+	params: Static<typeof CustomerRideGetRVS.params>
+	response: Static<typeof CustomerRideGetRVS.response>
+}
+
+export const CustomerRideTrackingRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			jrtoken: Type.String(),
+			agent: Type.Optional(Type.Any()),
+			eta: Type.Optional(Type.Number())
+		})
+	])
+}
+export type CustomerRideTrackingValidation = {
+	params: Static<typeof CustomerRideTrackingRVS.params>
+	response: Static<typeof CustomerRideTrackingRVS.response>
+}
+
+export const CustomerRideCancelRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	body: Type.Object({
+		reason: Type.String({ minLength: 1, maxLength: 500 })
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		APIResponseDataSchemaFactory({
+			reference: Type.String(),
+			cancellationFee: Type.Optional(Type.Number())
+		})
+	])
+}
+export type CustomerRideCancelValidation = {
+	params: Static<typeof CustomerRideCancelRVS.params>
+	body: Static<typeof CustomerRideCancelRVS.body>
+	response: Static<typeof CustomerRideCancelRVS.response>
+}
+
+export const CustomerRideRatingRVS = {
+	headers: APIHeadersSchema,
+	params: Type.Object({ reference: Type.String() }),
+	body: Type.Object({
+		rating: Type.Number({ minimum: 1, maximum: 5 }),
+		feedback: Type.Optional(Type.String({ maxLength: 500 }))
+	}),
+	response: Type.Intersect([
+		APIResponseBaseSchema,
+		Type.Object({ message: Type.String() })
+	])
+}
+export type CustomerRideRatingValidation = {
+	params: Static<typeof CustomerRideRatingRVS.params>
+	body: Static<typeof CustomerRideRatingRVS.body>
+	response: Static<typeof CustomerRideRatingRVS.response>
+}

package/src/aux/customers.ts

@@ -0,0 +1,80 @@
+import { Type, Static } from '@sinclair/typebox'
+import { ActionRecordSchema } from '../time'
+import { WaypointSchema } from '../routing'
+import { OrderPackageSchema } from '../order'
+import { DProfileReferenceSchema } from '../de.profile'
+
+export const CustomerOrderIntentStatusSchema = Type.Union([
+	Type.Literal('BUILDING'),
+	Type.Literal('READY'),
+	Type.Literal('SUBMITTED'),
+	Type.Literal('EXPIRED'),
+	Type.Literal('CANCELLED')
+])
+
+export const CustomerOrderIntentLogSchema = Type.Object({
+	action: Type.String(),
+	timestamp: Type.Number(),
+	count: Type.Optional(Type.Number()),
+	details: Type.Optional(Type.Any())
+})
+
+export const CustomerOrderIntentServiceSchema = Type.Object({
+	type: Type.Union([
+		Type.Literal('DELIVERY'),
+		Type.Literal('PICKUP'),
+		Type.Literal('RETURN'),
+		Type.Literal('EXCHANGE'),
+		Type.Literal('RIDE')
+	]),
+	priority: Type.Optional(Type.Union([
+		Type.Literal('NORMAL'),
+		Type.Literal('EXPRESS'),
+		Type.Literal('SAME_DAY'),
+		Type.Literal('SCHEDULED')
+	])),
+	scheduledAt: Type.Optional(Type.Number())
+})
+
+export const CustomerOrderIntentSchema = Type.Object({
+	reference: Type.String(),
+	connectorId: Type.String(),
+	clientId: Type.String(),
+	origin: Type.String({ format: 'uri' }),
+	status: CustomerOrderIntentStatusSchema,
+	waypoints: Type.Array(WaypointSchema),
+	packages: Type.Array(OrderPackageSchema),
+	service: Type.Optional(CustomerOrderIntentServiceSchema),
+	dprofile: Type.Optional(DProfileReferenceSchema),
+	logs: Type.Array(CustomerOrderIntentLogSchema),
+	expiry: Type.Number(),
+	created: ActionRecordSchema,
+	updated: Type.Optional(ActionRecordSchema),
+	submitted: Type.Optional(ActionRecordSchema)
+})
+
+export const CreateCustomerOrderIntentSchema = Type.Object({
+	clientId: Type.String({ minLength: 1, maxLength: 200 })
+})
+
+export const AddWaypointsSchema = Type.Object({
+	waypoints: Type.Array(WaypointSchema, { minItems: 1 })
+})
+
+export const AddPackagesSchema = Type.Object({
+	packages: Type.Array(OrderPackageSchema, { minItems: 1 })
+})
+
+export const SubmitIntentSchema = Type.Object({
+	service: CustomerOrderIntentServiceSchema,
+	dprofile: Type.Optional(DProfileReferenceSchema)
+})
+
+export type CustomerOrderIntentStatus = Static<typeof CustomerOrderIntentStatusSchema>
+export type CustomerOrderIntentLog = Static<typeof CustomerOrderIntentLogSchema>
+export type CustomerOrderIntentService = Static<typeof CustomerOrderIntentServiceSchema>
+export type CustomerOrderIntent = Static<typeof CustomerOrderIntentSchema>
+export type CreateCustomerOrderIntent = Static<typeof CreateCustomerOrderIntentSchema>
+export type AddWaypoints = Static<typeof AddWaypointsSchema>
+export type AddPackages = Static<typeof AddPackagesSchema>
+export type SubmitIntent = Static<typeof SubmitIntentSchema>

package/src/aux/index.ts

@@ -0,0 +1,4 @@
+export * from './agents'
+export * from './customers'
+export * from './agent-rvs'
+export * from './customer-rvs'