@spotto/contract 1.0.23 → 1.0.25

package/dist/assets/[id]/get.d.ts

@@ -1,13 +1,16 @@
 import { IEmbeddedLabel } from '../../labels';
+import { LocationType } from '../../locations/constants';
 import { IEntityMeta, IEmbeddedEntity } from '../../shared';
 import { IAssetTelemetry } from '../../telemetry';
 export interface ILastLocation extends IEmbeddedEntity {
+    type: LocationType;
     firstSeen: number;
     lastSeen: number;
     distance: number;
     organisation?: IEmbeddedEntity;
 }
 export interface ICandidateLocation extends IEmbeddedEntity {
+    type: LocationType;
     distance: number;
     organisation?: IEmbeddedEntity;
 }

package/dist/events/constants.d.ts

@@ -1,4 +1,8 @@
 export declare type EventCountBreakdown = 'year' | 'week' | 'month' | 'day' | 'hour';
 export declare const EVENT_COUNT_BREAKDOWN: EventCountBreakdown[];
-export declare type EventType = 'ReaderArrived' | 'ReaderExited' | 'Arrived' | 'Moved' | 'ExplicitArrived' | 'Exited' | 'ReaderOnline' | 'ReaderOffline' | 'AssetCreated' | 'AssetUpdated' | 'AssetDeleted' | 'LocationCreated' | 'LocationUpdated' | 'LocationDeleted' | 'ReaderCreated' | 'ReaderUpdated' | 'ReaderDeleted' | 'UserSearch';
+export declare type AssetCrudEventType = 'AssetCreated' | 'AssetUpdated' | 'AssetDeleted';
+export declare type LocationCrudEventType = 'LocationCreated' | 'LocationUpdated' | 'LocationDeleted';
+export declare type ReaderCrudEventType = 'ReaderCreated' | 'ReaderUpdated' | 'ReaderDeleted';
+export declare type SlateEventType = 'ReaderArrived' | 'ReaderExited' | 'Arrived' | 'Moved' | 'ExplicitArrived' | 'Exited' | 'ReaderOnline' | 'ReaderOffline';
+export declare type EventType = SlateEventType | AssetCrudEventType | LocationCrudEventType | ReaderCrudEventType | 'UserSearch';
 export declare const EVENT_TYPES: EventType[];

package/dist/events/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/events/constants.ts"],"names":[],"mappings":";;;AACa,QAAA,qBAAqB,GAA0B;IAC1D,MAAM;IACN,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;CACP,CAAC;AAsBW,QAAA,WAAW,GAAgB;IACtC,eAAe;IACf,cAAc;IACd,SAAS;IACT,OAAO;IACP,iBAAiB;IACjB,QAAQ;IACR,cAAc;IACd,eAAe;IACf,cAAc;IACd,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,iBAAiB;IACjB,eAAe;IACf,eAAe;IACf,eAAe;IACf,YAAY;CACb,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/events/constants.ts"],"names":[],"mappings":";;;AACa,QAAA,qBAAqB,GAA0B;IAC1D,MAAM;IACN,MAAM;IACN,OAAO;IACP,KAAK;IACL,MAAM;CACP,CAAC;AAkCW,QAAA,WAAW,GAAgB;IACtC,eAAe;IACf,cAAc;IACd,SAAS;IACT,OAAO;IACP,iBAAiB;IACjB,QAAQ;IACR,cAAc;IACd,eAAe;IACf,cAAc;IACd,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,iBAAiB;IACjB,iBAAiB;IACjB,eAAe;IACf,eAAe;IACf,eAAe;IACf,YAAY;CACb,CAAC"}

package/dist/events/get/response.d.ts

@@ -1,33 +1,103 @@
 import { IEmbeddedEntity } from '../../shared';
-import { EventType } from '../constants';
+import { AssetCrudEventType, EventType, LocationCrudEventType, ReaderCrudEventType } from '../constants';
 import { GetEventsQuery } from './query';
 import { DeviceType, ReaderType } from '../../readers/constants';
+import { LocationType } from '../../locations/constants';
 export interface EventLocation extends IEmbeddedEntity {
+    type: LocationType;
     organisation?: IEmbeddedEntity;
 }
-export interface GetEventResponse {
+export interface IBaseEvent {
     id: string;
     timestamp: number;
     type: EventType;
-    asset?: IEmbeddedEntity;
-    location?: EventLocation;
-    reader?: IEmbeddedEntity;
-    user?: IEmbeddedEntity;
-    entity?: string;
-    term?: string;
-    payload?: {
-        name?: string;
-        tagIds?: string[];
-        type?: ReaderType;
-        deviceType?: DeviceType;
-        network?: string;
-        deviceId?: string;
-        location?: IEmbeddedEntity;
-        typeId?: string;
-        nameSuffix?: string;
-        manifestId?: string;
-    };
 }
+export interface IAssetEventPayload {
+    name?: string;
+    nameSuffix?: string;
+    tagIds?: string[];
+    typeId?: string;
+}
+export interface ILocationEventPayload {
+    name?: string;
+    tagIds?: string[];
+    type?: LocationType;
+    manifestId?: string;
+}
+export interface IReaderEventPayload {
+    name?: string;
+    type?: ReaderType;
+    deviceType?: DeviceType;
+    network?: string;
+    deviceId?: string;
+    location?: IEmbeddedEntity;
+}
+export interface IAssetCrudEvent extends IBaseEvent {
+    type: AssetCrudEventType;
+    asset: IEmbeddedEntity;
+    user: IEmbeddedEntity;
+    payload: IAssetEventPayload;
+}
+export interface ILocationCrudEvent extends IBaseEvent {
+    type: LocationCrudEventType;
+    location: EventLocation;
+    user: IEmbeddedEntity;
+    payload: ILocationEventPayload;
+}
+export interface IReaderCrudEvent extends IBaseEvent {
+    type: ReaderCrudEventType;
+    reader: IEmbeddedEntity;
+    user: IEmbeddedEntity;
+    payload: IReaderEventPayload;
+}
+export interface IUserSearchEvent extends IBaseEvent {
+    type: 'UserSearch';
+    entity: string;
+    term: string;
+    user: IEmbeddedEntity;
+}
+export interface IArrivedEvent extends IBaseEvent {
+    type: 'Arrived';
+    asset: IEmbeddedEntity;
+    location: EventLocation;
+    reader: IEmbeddedEntity;
+}
+export interface IExitedEvent extends IBaseEvent {
+    type: 'Exited';
+    asset: IEmbeddedEntity;
+    location: EventLocation;
+    reader: IEmbeddedEntity;
+}
+export interface IReaderArrivedEvent extends IBaseEvent {
+    type: 'ReaderArrived';
+    location: EventLocation;
+    reader: IEmbeddedEntity;
+}
+export interface IReaderExitedEvent extends IBaseEvent {
+    type: 'ReaderExited';
+    location: EventLocation;
+    reader: IEmbeddedEntity;
+}
+export interface IMovedEvent extends IBaseEvent {
+    type: 'Moved';
+    asset: IEmbeddedEntity;
+    location: EventLocation;
+    reader: IEmbeddedEntity;
+}
+export interface IExplicitArrivedEvent extends IBaseEvent {
+    type: 'ExplicitArrived';
+    asset: IEmbeddedEntity;
+    location: EventLocation;
+}
+export interface IReaderOnlineEvent extends IBaseEvent {
+    type: 'ReaderOnline';
+    reader: IEmbeddedEntity;
+}
+export interface IReaderOfflineEvent extends IBaseEvent {
+    type: 'ReaderOffline';
+    reader: IEmbeddedEntity;
+}
+export declare type GetEventResponse = IAssetCrudEvent | ILocationCrudEvent | IReaderCrudEvent | IUserSearchEvent | IReaderArrivedEvent | IReaderExitedEvent | IArrivedEvent | IMovedEvent | IExplicitArrivedEvent | IExitedEvent | IReaderOnlineEvent | IReaderOfflineEvent;
 export interface GetEventsResponse {
     query: GetEventsQuery | null;
     items: GetEventResponse[];

package/dist/locations/[id]/get.d.ts

@@ -1,6 +1,7 @@
 import { type Polygon, type Point } from 'geojson';
 import { IEntityMeta, IEmbeddedEntity } from '../../shared';
 import { IAssetTelemetry } from '../../telemetry';
+import { LocationType } from '../constants';
 export interface IEmbeddedReader extends IEmbeddedEntity {
     displayName: string;
 }
@@ -15,8 +16,6 @@ export interface ILocationStatusLocation {
 export interface ILocationStatus {
     location?: ILocationStatusLocation;
 }
-export declare type LocationType = 'MOVING' | 'FIXED';
-export declare const LOCATION_TYPES: LocationType[];
 export interface GetLocationResponse {
     id: string;
     name: string;

package/dist/locations/[id]/get.js

@@ -1,5 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOCATION_TYPES = void 0;
-exports.LOCATION_TYPES = ['MOVING', 'FIXED'];
 //# sourceMappingURL=get.js.map

package/dist/locations/[id]/get.js.map

@@ -1 +1 @@
-{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/locations/[id]/get.ts"],"names":[],"mappings":";;;AAsBa,QAAA,cAAc,GAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC"}
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../../src/locations/[id]/get.ts"],"names":[],"mappings":""}

package/dist/locations/[id]/patch/request.d.ts

@@ -1,5 +1,5 @@
 import { type Point, type Polygon } from 'geojson';
-import { LocationType } from '../get';
+import { LocationType } from '../../constants';
 export interface UpdateLocationRequest {
     name?: string;
     tagIds?: string[];

package/dist/locations/constants.d.ts

@@ -0,0 +1,2 @@
+export declare type LocationType = 'MOVING' | 'FIXED';
+export declare const LOCATION_TYPES: LocationType[];

package/dist/locations/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOCATION_TYPES = void 0;
+exports.LOCATION_TYPES = ['MOVING', 'FIXED'];
+//# sourceMappingURL=constants.js.map

package/dist/locations/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/locations/constants.ts"],"names":[],"mappings":";;;AACa,QAAA,cAAc,GAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC"}

package/dist/locations/get/query.d.ts

@@ -1,5 +1,5 @@
 import { SearchableSortFields, SortOrders } from '../../shared';
-import { LocationType } from '../[id]/get';
+import { LocationType } from '../constants';
 export declare type LocationSearchField = 'name';
 export declare type LocationEmbedField = 'meta' | 'tagIds' | 'readers' | 'telemetry' | 'status';
 export interface LocationFilters {

package/dist/locations/index.d.ts

@@ -5,3 +5,4 @@ export * from './get';
 export * from './post';
 export * from './suggestions';
 export * from './errors';
+export * from './constants';

package/dist/locations/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./get"), exports);
 __exportStar(require("./post"), exports);
 __exportStar(require("./suggestions"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./constants"), exports);
 //# sourceMappingURL=index.js.map

package/dist/locations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,6CAA2B;AAC3B,wCAAsB;AACtB,yCAAuB;AACvB,gDAA8B;AAC9B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,6CAA2B;AAC3B,wCAAsB;AACtB,yCAAuB;AACvB,gDAA8B;AAC9B,2CAAyB;AACzB,8CAA4B"}

package/dist/locations/post/request.d.ts

@@ -1,5 +1,5 @@
 import { type Point, type Polygon } from 'geojson';
-import { LocationType } from '../[id]/get';
+import { LocationType } from '../constants';
 export interface PostLocationRequest {
     name: string;
     tagIds?: string[];

package/dist/locations/suggestions/query.d.ts

@@ -1,4 +1,4 @@
-import { LocationType } from '../[id]/get';
+import { LocationType } from '../constants';
 export interface GetLocationSuggestionsQuery {
     search: string;
     maxSuggestions?: number;

package/dist/readers/constants/types.js

@@ -5,20 +5,20 @@ exports.READER_TYPES = ['FIXED', 'ROVING', 'MOVING'];
 exports.READER_TYPE_DETAILS = [
     {
         id: 'FIXED',
-        name: 'Zone',
-        description: 'Readers will be plugged-in with a zone assigned to them.',
+        name: 'Fixed',
+        description: 'Plugged in with a Spotto location assigned. These readers are fixed in place and do not move unless the Spotto location is manually reassigned.',
         visible: true,
     },
     {
         id: 'ROVING',
-        name: 'Mobile',
-        description: 'Readers will be portable without a zone assigned and detect RFID location tags.',
+        name: 'Handheld',
+        description: 'Typically RFID handheld scanners or a BLE phone applications. These readers detect location tags or use GPS to locate assets instead of being linked to a Spotto location',
         visible: true,
     },
     {
         id: 'MOVING',
-        name: 'Moving',
-        description: 'Readers will be a vehicle/boat/aircraft',
+        name: 'Vehicle',
+        description: 'GPS enabled readers attached to a vehicle will detect the location and any assets that are travelling with it',
         visible: true,
     },
 ];

package/dist/readers/constants/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/readers/constants/types.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAU3D,QAAA,mBAAmB,GAAwB;IACtD;QACE,EAAE,EAAE,OAAO;QACX,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE,IAAI;KACd;IACD;QACE,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,iFAAiF;QACnF,OAAO,EAAE,IAAI;KACd;IACD;QACE,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,yCAAyC;QACtD,OAAO,EAAE,IAAI;KACd;CACF,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/readers/constants/types.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAU3D,QAAA,mBAAmB,GAAwB;IACtD;QACE,EAAE,EAAE,OAAO;QACX,IAAI,EAAE,OAAO;QACb,WAAW,EACT,iJAAiJ;QACnJ,OAAO,EAAE,IAAI;KACd;IACD;QACE,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,UAAU;QAChB,WAAW,EACT,2KAA2K;QAC7K,OAAO,EAAE,IAAI;KACd;IACD;QACE,EAAE,EAAE,QAAQ;QACZ,IAAI,EAAE,SAAS;QACf,WAAW,EACT,+GAA+G;QACjH,OAAO,EAAE,IAAI;KACd;CACF,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spotto/contract",
   "license": "ISC",
-  "version": "1.0.23",
+  "version": "1.0.25",
   "description": "Spotto's API Contract type definitions",
   "main": "./dist/index.js",
   "files": [
@@ -14,5 +14,5 @@
   "devDependencies": {
     "@types/geojson": "^7946.0.11"
   },
-  "gitHead": "de179d102ba3cb70ab5d36cdd7de171f524ad0aa"
+  "gitHead": "a0c0e3b90526d2fa45eb08221fcf8d7530a21bbf"
 }