clarion-shared-types 1.0.92 → 1.0.94

package/dist/cjs/modules/tracking/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./enums/tracking-connection-status.enum"), exports);
 __exportStar(require("./enums/tracking-unit-online-status.enum"), exports);
 // Interfaces / DTOs
 __exportStar(require("./interfaces/tracking-provider-connection.dto"), exports);
+__exportStar(require("./interfaces/tracking-provider-descriptor"), exports);
 __exportStar(require("./interfaces/tracking-device-binding.dto"), exports);
 __exportStar(require("./interfaces/tracking-position.dto"), exports);
 __exportStar(require("./interfaces/tracking-socket-events"), exports);

package/dist/cjs/modules/tracking/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,sEAAoD;AACpD,uEAAqD;AACrD,0EAAwD;AACxD,2EAAyD;AAEzD,oBAAoB;AACpB,gFAA8D;AAC9D,2EAAyD;AACzD,qEAAmD;AACnD,sEAAoD;AACpD,uEAAqD;AACrD,qEAAmD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,QAAQ;AACR,sEAAoD;AACpD,uEAAqD;AACrD,0EAAwD;AACxD,2EAAyD;AAEzD,oBAAoB;AACpB,gFAA8D;AAC9D,4EAA0D;AAC1D,2EAAyD;AACzD,qEAAmD;AACnD,sEAAoD;AACpD,uEAAqD;AACrD,qEAAmD"}

package/dist/cjs/modules/tracking/interfaces/tracking-provider-descriptor.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDefaultTrackingProviderConfiguration = buildDefaultTrackingProviderConfiguration;
+/**
+ * The `configuration` a connection gets when the operator supplies none: every
+ * setting at its default. Stored explicitly on the connection so that readers
+ * which know nothing about adapters (the status evaluator, ingestion guards) see
+ * the provider's thresholds rather than the service-wide fallbacks.
+ */
+function buildDefaultTrackingProviderConfiguration(descriptor) {
+    const configuration = {};
+    for (const setting of descriptor.settings) {
+        configuration[setting.key] = setting.defaultValue;
+    }
+    return configuration;
+}
+//# sourceMappingURL=tracking-provider-descriptor.js.map

package/dist/cjs/modules/tracking/interfaces/tracking-provider-descriptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-provider-descriptor.js","sourceRoot":"","sources":["../../../../../src/modules/tracking/interfaces/tracking-provider-descriptor.ts"],"names":[],"mappings":";;AAwHA,8FAQC;AAdD;;;;;GAKG;AACH,SAAgB,yCAAyC,CACrD,UAAwD;IAExD,MAAM,aAAa,GAA8C,EAAE,CAAC;IACpE,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QACxC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IACtD,CAAC;IACD,OAAO,aAAa,CAAC;AACzB,CAAC"}

package/dist/esm/modules/tracking/index.js

@@ -5,6 +5,7 @@ export * from './enums/tracking-connection-status.enum';
 export * from './enums/tracking-unit-online-status.enum';
 // Interfaces / DTOs
 export * from './interfaces/tracking-provider-connection.dto';
+export * from './interfaces/tracking-provider-descriptor';
 export * from './interfaces/tracking-device-binding.dto';
 export * from './interfaces/tracking-position.dto';
 export * from './interfaces/tracking-socket-events';

package/dist/esm/modules/tracking/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AAEzD,oBAAoB;AACpB,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/modules/tracking/index.ts"],"names":[],"mappings":"AAAA,QAAQ;AACR,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AAEzD,oBAAoB;AACpB,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0CAA0C,CAAC;AACzD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,oCAAoC,CAAC"}

package/dist/esm/modules/tracking/interfaces/tracking-provider-descriptor.js

@@ -0,0 +1,14 @@
+/**
+ * The `configuration` a connection gets when the operator supplies none: every
+ * setting at its default. Stored explicitly on the connection so that readers
+ * which know nothing about adapters (the status evaluator, ingestion guards) see
+ * the provider's thresholds rather than the service-wide fallbacks.
+ */
+export function buildDefaultTrackingProviderConfiguration(descriptor) {
+    const configuration = {};
+    for (const setting of descriptor.settings) {
+        configuration[setting.key] = setting.defaultValue;
+    }
+    return configuration;
+}
+//# sourceMappingURL=tracking-provider-descriptor.js.map

package/dist/esm/modules/tracking/interfaces/tracking-provider-descriptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-provider-descriptor.js","sourceRoot":"","sources":["../../../../../src/modules/tracking/interfaces/tracking-provider-descriptor.ts"],"names":[],"mappings":"AAkHA;;;;;GAKG;AACH,MAAM,UAAU,yCAAyC,CACrD,UAAwD;IAExD,MAAM,aAAa,GAA8C,EAAE,CAAC;IACpE,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QACxC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IACtD,CAAC;IACD,OAAO,aAAa,CAAC;AACzB,CAAC"}

package/dist/types/modules/tracking/index.d.ts

@@ -3,6 +3,7 @@ export * from './enums/tracking-transport-type.enum';
 export * from './enums/tracking-connection-status.enum';
 export * from './enums/tracking-unit-online-status.enum';
 export * from './interfaces/tracking-provider-connection.dto';
+export * from './interfaces/tracking-provider-descriptor';
 export * from './interfaces/tracking-device-binding.dto';
 export * from './interfaces/tracking-position.dto';
 export * from './interfaces/tracking-socket-events';

package/dist/types/modules/tracking/interfaces/tracking-position.dto.d.ts

@@ -60,6 +60,12 @@ export interface TrackingBoundingBox {
     west: number;
 }
 export interface TrackingCurrentPositionQuery {
+    /**
+     * Tenant to read. REQUIRED for a Super-Admin, who has no tenant of their own
+     * (the service answers 403 without it); ignored for everyone else, whose scope
+     * always comes from their own access context and cannot be widened from here.
+     */
+    organizationId?: number;
     controlCentreId?: number;
     status?: TrackingUnitOnlineStatus;
     north?: number;

package/dist/types/modules/tracking/interfaces/tracking-provider-descriptor.d.ts

@@ -0,0 +1,111 @@
+import { TrackingProviderCode } from '../enums/tracking-provider-code.enum';
+import { TrackingTransportType } from '../enums/tracking-transport-type.enum';
+/**
+ * Self-description of a tracking provider, published by clarion-response-tracking
+ * (`GET /tracking/providers`) and rendered by the admin client.
+ *
+ * Why it exists: every provider needs different things from an operator. Telox
+ * wants a WebSocket URL, a username, a domain and a password; Wialon wants an
+ * HTTPS host and an API token and has no domain at all; and each scales its raw
+ * telemetry differently. Encoding that in the client meant a form that only fit
+ * one provider and defaults that had to be kept in step with the service by hand.
+ * With a descriptor the service that owns the adapter is the single source of
+ * truth: adding a provider changes no client code, and a default can never drift.
+ *
+ * Only providers with a registered adapter are described, so the catalog also
+ * answers "which providers can I actually connect?" — the enum alone cannot,
+ * because it reserves codes for adapters that do not exist yet.
+ *
+ * Mirrors `grm-shared-library`'s TrackingProviderDescriptor (the backend copy also
+ * carries the validator the service enforces these bounds with).
+ *
+ * SECURITY: a descriptor is static metadata. It never carries a secret, a secret
+ * reference, or anything tenant-specific.
+ */
+export type TrackingProviderSettingType = 'number' | 'boolean' | 'select' | 'text';
+export interface TrackingProviderSettingOption {
+    value: string;
+    label: string;
+}
+/** One key of a provider connection's `configuration` blob. */
+export interface TrackingProviderSettingDescriptor {
+    /** The `configuration` key this setting is stored under. */
+    key: string;
+    label: string;
+    type: TrackingProviderSettingType;
+    /** Key of the {@link TrackingProviderSettingGroupDescriptor} it is shown under. */
+    group: string;
+    /** Applied by the service when the key is absent, and pre-filled by the client. */
+    defaultValue: number | boolean | string;
+    description?: string;
+    /** Display unit, e.g. `s`, `m`, `km/h`. */
+    unit?: string;
+    /** `number` settings only. Bounds are inclusive and enforced by the service. */
+    min?: number;
+    max?: number;
+    step?: number;
+    /** `number` settings only: reject fractional values. */
+    integer?: boolean;
+    /** `text` settings only. */
+    maxLength?: number;
+    /** `select` settings only: the closed set of accepted values. */
+    options?: TrackingProviderSettingOption[];
+}
+export interface TrackingProviderSettingGroupDescriptor {
+    key: string;
+    label: string;
+    description?: string;
+}
+/** An optional connection field whose meaning (or existence) depends on the provider. */
+export interface TrackingProviderFieldDescriptor {
+    /** false ⇒ the provider has no such concept: hide the field and send nothing. */
+    used: boolean;
+    required: boolean;
+    label: string;
+    placeholder?: string;
+    description?: string;
+}
+export interface TrackingProviderEndpointDescriptor {
+    label: string;
+    placeholder: string;
+    description?: string;
+    /** Pre-filled for providers with one well-known public endpoint. */
+    defaultValue?: string;
+    /** Accepted URL schemes, with the trailing colon: `wss:`, `https:`… */
+    protocols: string[];
+}
+/** What the referenced secret must contain. Describes the secret; never holds it. */
+export interface TrackingProviderSecretDescriptor {
+    label: string;
+    description: string;
+    placeholder?: string;
+}
+/** How the provider identifies a unit — what an operator binds to a response unit. */
+export interface TrackingProviderExternalUnitDescriptor {
+    label: string;
+    description: string;
+    placeholder?: string;
+}
+export interface TrackingProviderDescriptor {
+    providerCode: TrackingProviderCode;
+    displayName: string;
+    description: string;
+    /** Supported transports; the first is the default. */
+    transportTypes: TrackingTransportType[];
+    endpoint: TrackingProviderEndpointDescriptor;
+    externalUsername: TrackingProviderFieldDescriptor;
+    externalDomain: TrackingProviderFieldDescriptor;
+    secret: TrackingProviderSecretDescriptor;
+    externalUnitId: TrackingProviderExternalUnitDescriptor;
+    /** Display order of the setting groups. */
+    settingGroups: TrackingProviderSettingGroupDescriptor[];
+    settings: TrackingProviderSettingDescriptor[];
+    documentationUrl?: string;
+}
+/**
+ * The `configuration` a connection gets when the operator supplies none: every
+ * setting at its default. Stored explicitly on the connection so that readers
+ * which know nothing about adapters (the status evaluator, ingestion guards) see
+ * the provider's thresholds rather than the service-wide fallbacks.
+ */
+export declare function buildDefaultTrackingProviderConfiguration(descriptor: Pick<TrackingProviderDescriptor, 'settings'>): Record<string, number | boolean | string>;

package/dist/types/modules/tracking/interfaces/tracking-socket-events.d.ts

@@ -15,7 +15,12 @@ export interface TrackingPositionSocketEvent {
     longitude: number;
     accuracyMetres?: number;
     speedKph?: number;
-    /** Degrees clockwise from north, [0,360). Omitted/undefined ⇒ do not rotate. */
+    /**
+     * Heading in degrees clockwise from north, [0,360). Resolved by the server:
+     * the provider's course while moving, else the direction actually travelled,
+     * else the last known heading. Omitted ONLY when it is genuinely unknown —
+     * keep whatever heading is already shown; do not reset the unit to north.
+     */
     courseDegrees?: number;
     moving?: boolean;
     ignitionOn?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarion-shared-types",
-  "version": "1.0.92",
+  "version": "1.0.94",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",