@de./sdk 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,281 @@
+export type HTTPRequestOptions = {
+  url: string
+  method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE'
+  headers?: { [index: string]: string }
+  body?: any
+}
+export type HTTPResponse = {
+  error: boolean
+  message?: string
+}
+
+export type LngLat = [number, number]
+export type Coordinates = {
+  lng: number
+  lat: number
+}
+export type PickedLocation = {
+  point: {
+    x: number,
+    y: number
+  }
+  coordinates: Coordinates
+}
+export type RTLocation = Coordinates & {
+  heading?: number
+}
+export type ActivePosition = {
+  id: string
+  position: RTLocation
+  caption?: Caption
+}
+
+/**
+ * Configuration options for AnimatedPolyline
+ */
+export type AnimatedRouteNativePathType = 'dot' | 'solid'
+export type AnimatedRouteNativeMethods = 'dot:flow'
+                                          | 'dot:fade'
+                                          | 'dot:pulse'
+                                          | 'dot:directional'
+                                          | 'solid:flow'
+                                          | 'solid:fade'
+                                          | 'solid:pulse'
+                                          | 'solid:directional'
+export interface AnimatedRouteRules {
+  styles?: any;
+  speed?: number; // pixels per frame
+  fadeLength?: number; // length of fade effect in pixels
+}
+export interface AnimatedRoute {
+  key: number | null
+  currentOffset: number
+  rules: Required<AnimatedRouteRules>
+  startTime?: number;
+  polyline?: any
+  engine: any
+  path: Coordinates[]
+
+  /**
+   * Create the polyline
+   */
+  create( pathType?: AnimatedRouteNativePathType ): void;
+
+  /**
+   * Animation methods
+   */
+  apply: Record<string, () => void>;
+
+  /**
+   * Stop the current animation
+   */
+  stop(): void;
+
+  /**
+   * Remove the polyline from the map and stop animation
+   */
+  remove(): void;
+}
+export type AnimatedRouteOptions = AnimatedRouteNativeMethods | {
+  handler?: new (engine: Engine, path: Coordinates[], rules?: AnimatedRouteRules) => AnimatedRoute
+  method?: string
+  rules?: AnimatedRouteRules
+}
+
+export type Journey = {
+  routeId: string | number
+  origin?: MapWaypoint
+  destination?: MapWaypoint
+  waypoints?: MapWaypoint[]
+  options?: RouteOptions
+}
+export type ActiveDirection<RouteSpec> = {
+  routeId: string | number
+  profile: string
+  origin?: Coordinates
+  destination?: Coordinates
+  waypoints: Coordinates[]
+  route: RouteSpec | null
+}
+
+export type RouteID = string | number
+export type RoutesFitBoundsOptions = {
+	includes?: RouteID[]
+	margin?: number
+}
+export type RouteOptions = {
+  id?: string | number
+  mode?: 'default' | 'navigation'
+  profile?: 'driving-traffic' | 'driving' | 'cycling' | 'biking' | 'walking' | 'transit'
+  unit?: 'metric' | 'imperial',
+  preference?: 'TRAFFIC_AWARE' | 'TRAFFIC_UNAWARE'
+  pointless?: boolean
+  styles?: any
+  animation?: AnimatedRouteOptions
+}
+
+export type SearchPlace = {
+  name: string
+  location: Coordinates,
+  address: string
+}
+
+export type Waypoint = {
+  no: number
+  type: 'pickup' | 'dropoff'
+  description: string
+  coordinates: Coordinates
+  address?: string
+  contact: {
+    type: string
+    reference: string
+    phone?: string
+    email?: string
+  }
+}
+export type WaypointIndex = 'origin' | 'destination' | number
+export type WaypointOptions = {
+  no?: number
+  type?: 'pickup' | 'dropoff'
+  description?: string
+  coordinates?: Coordinates
+  address?: string
+  'contact.type'?: string
+  'contact.reference'?: string
+  'contact.phone'?: string
+  'contact.email'?: string
+}
+
+export type Package = {
+  waypointNo: number
+  careLevel: number
+  category: string
+  weight: number
+  note?: string
+}
+export type PackageOptions = {
+  waypointNo?: number
+  careLevel?: number
+  category?: string
+  weight?: number
+  note?: string
+}
+
+export type PaymentMode = 'cash' | 'card' | 'momo' | 'wigo'
+export type OrderService = {
+  fees: {
+    total: {
+      amount: number
+      currency: string
+    },
+    tax: number
+    discount: number
+  }
+  payment: {
+    mode: PaymentMode
+    paid: boolean
+  }
+  xpress: string
+}
+export type OrderServiceOptions = {
+  'fees.total.amount'?: number
+  'fees.total.currency'?: string
+  'fees.tax'?: string
+  'fees.discount'?: string
+  'payment.mode'?: PaymentMode
+  'payment.option'?: string
+  'payment.paid'?: boolean
+  xpress?: string
+}
+export type OrderOperator = {}
+export type OrderStage = {
+  current: string
+  status: string
+}
+
+export type Message = {
+  type: 'text' | 'location' | 'media'
+  sender: string
+  content: string
+  timestamp: string
+}
+export type Caption = {
+	duration?: number
+	unit?: string
+	label?: string
+}
+export type Peer = {
+  utype: string
+  id: string
+}
+
+export type MapOptions = {
+  element: string
+  accessToken: string
+  version?: number
+  env?: 'dev' | 'prod'
+}
+export type MapLayerStyle = 'streets' | 'outdoors' | 'light' | 'dark' | 'satellite'
+export type MapWaypoint = {
+  index?: number
+  coords: Coordinates
+  caption?: Caption
+}
+
+export type Entity = {
+  id: string
+  status: 'ACTIVE' | 'BUSY'
+  grade: '1H' | '2H' | '3H'
+  currentLocation: RTLocation
+  static?: boolean
+  type: 'moto' | 'car' | 'bike' | 'truck' | 'plane' | 'ship' | 'restaurant' | 'hotel' | 'store' | 'office' | 'warehouse'
+}
+export type EntitySpecs = {
+  id: string
+  status: 'ACTIVE' | 'BUSY'
+  grade: '1H' | '2H' | '3H'
+  currentLocation: RTLocation
+  static?: boolean
+  type: 'moto' | 'car' | 'bike' | 'truck' | 'plane' | 'ship' | 'restaurant' | 'hotel' | 'store' | 'office' | 'warehouse'
+}
+
+export interface UserLocationOptions {
+  // Base point styling options
+  borderRadius?: number
+  borderColor?: string
+  borderOpacity?: number
+  dotColor?: string
+  showInnerDot?: boolean
+  noRing?: boolean
+  
+  // User location specific options
+  showDirectionArrow?: boolean
+  arrowColor?: string
+  arrowSize?: number
+  pulseAnimation?: boolean
+  accuracyCircle?: boolean
+  accuracyColor?: string
+  accuracyOpacity?: number
+  
+  // Callbacks
+  onLocationUpdate?: ( location: RTLocation ) => void
+  onLocationError?: ( error: GeolocationPositionError ) => void
+}
+export type DragPickOptions = {
+  snapToRoad?: boolean
+  pinPoints?: boolean
+  pointOptions?: CustomPointOptions
+}
+export type DragPickContentType = 'duration' | 'distance' | 'preloader'
+export type DragPickContent = {
+  time?: number
+  unit?: 'min' | 'sec' | 'hr' | 'km' | 'mi' | 'm'
+  distance?: number
+  preloader?: boolean
+}
+export type DragPickEvent = 'dragstart' | 'dragend' | 'zoom_changed' | 'idle'
+export interface DragPickInterface {
+  enable( origin?: Coordinates ): void
+  disable(): void
+  content( type: DragPickContentType, content: DragPickContent ): void
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+import Stream from './stream';
+declare const _default: {
+    Stream: typeof Stream;
+};
+export default _default;

package/dist/utils/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var stream_1 = __importDefault(require("./stream"));
+exports.default = { Stream: stream_1.default };
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;AACA,oDAA6B;AAE7B,kBAAe,EAAE,MAAM,kBAAA,EAAE,CAAA"}

package/dist/utils/stream.d.ts

@@ -0,0 +1,20 @@
+export type StreamDataListener = (data: string) => void;
+export default class Stream {
+    private _STALED;
+    private _CLOSED;
+    private _fns;
+    private _exitFn;
+    private _errorFn;
+    private _downStream?;
+    private _upStream?;
+    private _upstream;
+    private _backpressure;
+    sync(data: any): void;
+    on(_event: 'data', fn: StreamDataListener): this;
+    pipe(stream: Stream): this;
+    error(error: Error | string): this;
+    close(): void;
+    isActive(): boolean;
+    onerror(fn: (error: Error) => void): this;
+    onclose(fn: () => void): this;
+}

package/dist/utils/stream.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Stream = /** @class */ (function () {
+    function Stream() {
+        this._STALED = false;
+        this._CLOSED = false;
+        this._fns = [];
+        this._exitFn = (function () { });
+        this._errorFn = (function (error) { });
+    }
+    Stream.prototype._upstream = function (stream) {
+        this._upStream = stream;
+        return this;
+    };
+    Stream.prototype._backpressure = function (data) {
+        !this._CLOSED && this._fns.map(function (fn) { return fn(data); });
+    };
+    Stream.prototype.sync = function (data) {
+        var _a;
+        !this._CLOSED && ((_a = this._downStream) === null || _a === void 0 ? void 0 : _a._backpressure(data));
+    };
+    Stream.prototype.on = function (_event, fn) {
+        if (this._CLOSED)
+            throw new Error('Stream closed');
+        this._fns.push(fn);
+        return this;
+    };
+    Stream.prototype.pipe = function (stream) {
+        stream._upstream(this);
+        this._downStream = stream;
+        return this;
+    };
+    Stream.prototype.error = function (error) {
+        var _a;
+        // Throw error to self
+        this._errorFn(typeof error == 'string' ? new Error(error) : error);
+        // Throw error to downstream pipe
+        (_a = this._downStream) === null || _a === void 0 ? void 0 : _a.error(error);
+        return this;
+    };
+    Stream.prototype.close = function () {
+        var _a;
+        if (this._CLOSED)
+            return;
+        this._CLOSED = true;
+        this._fns = [];
+        this._exitFn();
+        (_a = this._downStream) === null || _a === void 0 ? void 0 : _a.close(); // Close down streams
+        // this._upStream?.close() // Close up streams: Recursive loop call effect
+    };
+    Stream.prototype.isActive = function () { return !this._CLOSED; };
+    Stream.prototype.onerror = function (fn) {
+        this._errorFn = fn;
+        return this;
+    };
+    Stream.prototype.onclose = function (fn) {
+        this._exitFn = fn;
+        return this;
+    };
+    return Stream;
+}());
+exports.default = Stream;
+//# sourceMappingURL=stream.js.map

package/dist/utils/stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/utils/stream.ts"],"names":[],"mappings":";;AAGA;IAAA;QACU,YAAO,GAAY,KAAK,CAAA;QACxB,YAAO,GAAY,KAAK,CAAA;QACxB,SAAI,GAAyB,EAAE,CAAA;QAC/B,YAAO,GAAG,CAAC,cAAO,CAAC,CAAC,CAAA;QACpB,aAAQ,GAAG,CAAC,UAAE,KAAY,IAAO,CAAC,CAAC,CAAA;IA2D7C,CAAC;IAvDS,0BAAS,GAAjB,UAAmB,MAAc;QAC/B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IACO,8BAAa,GAArB,UAAuB,IAAS;QAC9B,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAE,UAAA,EAAE,IAAI,OAAA,EAAE,CAAE,IAAI,CAAE,EAAV,CAAU,CAAE,CAAA;IACpD,CAAC;IAED,qBAAI,GAAJ,UAAM,IAAS;;QACb,CAAC,IAAI,CAAC,OAAO,KAAI,MAAA,IAAI,CAAC,WAAW,0CAAE,aAAa,CAAE,IAAI,CAAE,CAAA,CAAA;IAC1D,CAAC;IAED,mBAAE,GAAF,UAAI,MAAc,EAAE,EAAsB;QACxC,IAAI,IAAI,CAAC,OAAO;YAAG,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAA;QAEnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAE,EAAE,CAAE,CAAA;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,qBAAI,GAAJ,UAAM,MAAc;QAClB,MAAM,CAAC,SAAS,CAAE,IAAI,CAAE,CAAA;QACxB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,sBAAK,GAAL,UAAO,KAAqB;;QAC1B,sBAAsB;QACtB,IAAI,CAAC,QAAQ,CAAE,OAAO,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAE,KAAK,CAAE,CAAC,CAAC,CAAE,KAAK,CAAE,CAAA;QACvE,iCAAiC;QACjC,MAAA,IAAI,CAAC,WAAW,0CAAE,KAAK,CAAE,KAAK,CAAE,CAAA;QAEhC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,sBAAK,GAAL;;QACE,IAAI,IAAI,CAAC,OAAO;YAAG,OAAM;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QAEnB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,OAAO,EAAE,CAAA;QAEd,MAAA,IAAI,CAAC,WAAW,0CAAE,KAAK,EAAE,CAAA,CAAC,qBAAqB;QAC/C,0EAA0E;IAC5E,CAAC;IAED,yBAAQ,GAAR,cAAY,OAAO,CAAC,IAAI,CAAC,OAAO,CAAA,CAAC,CAAC;IAElC,wBAAO,GAAP,UAAS,EAA4B;QACnC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAA;QAClB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,wBAAO,GAAP,UAAS,EAAc;QACrB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,OAAO,IAAI,CAAA;IACb,CAAC;IACH,aAAC;AAAD,CAAC,AAhED,IAgEC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@de./sdk",
+  "version": "1.0.0",
+  "description": "Complete SDK pack for MSI (Map Service Interface), IoTClient and DClient services",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/",
+    "src/",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./types": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/types/index.d.ts"
+    }
+  },
+  "author": "SCOREX Corporation",
+  "private": false,
+  "scripts": {
+    "build:tsc": "rimraf ./dist && tsc",
+    "build:webpack": "WEBPACK_ENV=build webpack",
+    "build:copy-types": "mkdir -p dist/types && cp -r src/types/* dist/types/",
+    "compile": "yarn build:tsc && yarn build:webpack && yarn build:copy-types",
+    "prepack": "yarn run compile",
+    "test": "Echo 'Error: No test specified' && exit 1",
+    "test:auth": "yarn build:tsc && jest test/auth.test.js",
+    "test:client": "yarn build:tsc && jest test/client.test.js",
+    "test:order": "yarn build:tsc && jest test/order.test.js",
+    "test:event": "yarn build:tsc && jest test/event.test.js"
+  },
+  "dependencies": {
+    "events": "^3.3.0",
+    "iframe.io": "^1.1.0",
+    "node-fetch": "2.6.1",
+    "socket.io-client": "^4.6.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node-fetch": "^2.6.3",
+    "expect.js": "^0.3.1",
+    "jest": "^29.7.0",
+    "rimraf": "^4.4.0",
+    "ts-jest": "^29.0.5",
+    "ts-loader": "^9.4.2",
+    "typescript": "^5.0.2",
+    "webpack": "^5.77.0",
+    "webpack-cli": "^5.0.1"
+  },
+  "directories": {
+    "dist": "dist/",
+    "docs": "docs/",
+    "test": "test/"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/de-dot/de.sdk"
+  },
+  "keywords": []
+}

package/src/allend/Access.ts

@@ -0,0 +1,78 @@
+import type { AccessOptions } from '../types/access'
+import type { HTTPRequestOptions } from '../types'
+import { API_SERVER_BASEURL, ASI_SERVER_BASEURL } from '../baseUrl'
+
+type AccessType = 'API' | 'ASI'
+
+const USER_ACCOUNT_SERVICE = 'De.API'
+
+export default class AccessManager {
+  private atype: AccessType
+  private version: number
+  private platform: AccessOptions['platform']
+  private baseURL: string
+  protected accessToken?: string
+  protected remoteOrigin?: string
+
+  constructor( options: AccessOptions, atype: AccessType ){
+    if( !options ) throw new Error('Undefined Access Configuration')
+    if( !options.context ) throw new Error('Undefined Context Reference. Check https://doc.dedot.io/sdk/auth')
+    if( !options.accessToken ) throw new Error('Undefined Access Token. Check https://doc.dedot.io/sdk/auth')
+    
+    this.atype = atype
+    this.version = options.version || 1
+    this.platform = options.platform || 'proxy'
+    this.accessToken = options.accessToken
+    this.remoteOrigin = options.remoteOrigin
+    this.baseURL = this.atype === 'ASI'
+              ? ASI_SERVER_BASEURL[ options.env || 'dev' ] 
+              : API_SERVER_BASEURL[ options.env || 'dev' ]
+  }
+
+  async request<Response>({ url, ...options }: HTTPRequestOptions ): Promise<Response> {
+    const rawOptions: any = {
+      method: 'GET',
+      headers: {
+        /**
+         * Default User agent for SDK request calls
+         * 
+         * NOTE: Later replace by latest SDK version
+         */
+        origin: this.remoteOrigin,
+        'de-user-agent': `De.${this.platform}/${this.version}.0`
+      }
+    }
+
+    if( this.atype === 'ASI' )
+      rawOptions.headers['de-auth-service'] = USER_ACCOUNT_SERVICE
+
+    if( this.accessToken )
+      rawOptions.headers.authorization = `Bearer ${this.accessToken}`
+
+    if( options.body ){
+      rawOptions.headers['content-type'] = 'application/json'
+      if( typeof options.body === 'object' )
+        options.body = JSON.stringify( options.body )
+    }
+
+    if( typeof options.headers == 'object' )
+      options.headers = {
+        ...options.headers,
+        ...rawOptions.headers
+      }
+
+    options = { ...rawOptions, ...options }
+
+    url = `${this.baseURL}/v${this.version}/${url.replace(/^\//, '')}`
+
+    // Support fetch for in both node & browser environment
+    let fetch = globalThis?.window && globalThis?.fetch
+    if( !fetch )
+      fetch = ( await import('node-fetch') ).default as any
+
+    // console.log( options )
+    return await ( await fetch( url, options ) ).json() as Response
+  }
+
+  setToken( token: string ): void { this.accessToken = token }
+}

package/src/allend/DAuth/index.ts

@@ -0,0 +1,39 @@
+import type { HTTPRequestOptions, HTTPResponse } from '../../types'
+import type { AccessOptions } from '../../types/access'
+import AccessManager from '../Access'
+
+type SigninBody = {
+  type?: 'CUSTOMER' | 'VENDOR' | 'ADMIN',
+  phone: string,
+  device?: string, // JSON string
+  country?: string // ISO 3166-1 alpha-2
+}
+type SigninResponse = HTTPResponse & {
+  token: string
+}
+
+export default class DAuth extends AccessManager {
+  constructor( access: AccessOptions ){
+    super( access, 'ASI' )
+  }
+
+  /**
+   * Signin
+   */
+  async signin( body: SigninBody ): Promise<SigninResponse> {
+    if( !body.phone )
+      throw new Error('<phone> argument required')
+    
+    const
+    options: HTTPRequestOptions = {
+      url: '/auth/signin',
+      method: 'POST',
+      body
+    },
+    response = await this.request<SigninResponse>( options )
+    if( response.error ) throw new Error( response.message )
+    
+    return response
+  }
+
+}

package/src/allend/DClient/Client.ts

@@ -0,0 +1,76 @@
+import type { AccessOptions } from '../../types/access'
+import type { HTTPRequestOptions, RTLocation, OrderService, HTTPResponse, Entity  } from '../../types'
+import AccessManager from '../Access'
+
+type OrderServiceResponse = HTTPResponse & {
+  orders: OrderService[]
+}
+type NearbyResponse = HTTPResponse & {
+  nearby: Entity[]
+}
+
+export default class Client extends AccessManager {
+  private clientId: string
+
+  constructor( clientId: string, access: AccessOptions ){
+    if( !clientId ) 
+      throw new Error('Undefined <clientId>')
+
+    // Instanciate access
+    super( access, 'API' )
+    // ID/reference of the client on this session
+    this.clientId = clientId
+  }
+
+  async fetchActiveOrders(){
+    if( !this.accessToken )
+      throw new Error('Authentication required')
+      
+    const
+    options: HTTPRequestOptions = {
+      url: `/client/${this.clientId}/orders/actives`,
+      method: 'GET'
+    },
+    { error, message, orders } = await this.request<OrderServiceResponse>( options )
+    if( error ) throw new Error( message )
+    
+    return orders
+  }
+
+  async fetchOrderHistory(){
+    if( !this.accessToken )
+      throw new Error('Authentication required')
+    
+    const
+    options: HTTPRequestOptions = {
+      url: `/client/${this.clientId}/orders/history`,
+      method: 'GET'
+    },
+    { error, message, orders } = await this.request<OrderServiceResponse>( options )
+    if( error ) throw new Error( message )
+    
+    return orders
+  }
+
+  async nearby( location: RTLocation ){
+    if( !this.accessToken )
+      throw new Error('Authentication required')
+
+    if( !location )
+      throw new Error('Undefined epicenter location')
+
+    if( !location.lng || !location.lat )
+      throw new Error('Invalid location coordinates')
+
+    const
+    options: HTTPRequestOptions = {
+      url: `/client/${this.clientId}/nearby`,
+      method: 'POST',
+      body: location
+    },
+    { error, message, nearby } = await this.request<NearbyResponse>( options )
+    if( error ) throw new Error( message )
+    
+    return nearby
+  }
+}