@signalk/server-api 2.22.0 → 2.24.0

package/dist/typebox/discovery-schemas.js

@@ -0,0 +1,73 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K Discovery API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeaturesModelSchema = exports.PluginMetaDataSchema = exports.DiscoveryDataSchema = exports.V1EndpointSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+/**
+ * v1 endpoint descriptor — protocol addresses for a specific API version.
+ */
+exports.V1EndpointSchema = typebox_1.Type.Object({
+    version: typebox_1.Type.String({
+        description: 'Version of the Signal K API',
+        examples: ['1.1.0']
+    }),
+    'signalk-http': typebox_1.Type.Optional(typebox_1.Type.String({
+        description: "Address of the server's http API.",
+        examples: ['http://192.168.1.88:3000/signalk/v1/api/']
+    })),
+    'signalk-ws': typebox_1.Type.Optional(typebox_1.Type.String({
+        description: "Address of the server's WebSocket API.",
+        examples: ['ws://192.168.1.88:3000/signalk/v1/stream']
+    })),
+    'signalk-tcp': typebox_1.Type.Optional(typebox_1.Type.String({
+        description: "Address of the server's Signal K over TCP API.",
+        examples: ['tcp://192.168.1.88:8375']
+    }))
+}, { $id: 'V1Endpoint' });
+/**
+ * Discovery response — server version and service endpoints.
+ */
+exports.DiscoveryDataSchema = typebox_1.Type.Object({
+    endpoints: typebox_1.Type.Object({
+        v1: typebox_1.Type.Optional(exports.V1EndpointSchema)
+    }),
+    server: typebox_1.Type.Object({
+        id: typebox_1.Type.String({
+            description: 'Id of the server implementation',
+            examples: ['signalk-server-node']
+        }),
+        version: typebox_1.Type.String({
+            description: 'Server software version'
+        })
+    })
+}, {
+    $id: 'DiscoveryData',
+    description: 'Server version and service endpoint discovery data'
+});
+/**
+ * Plugin metadata for feature discovery.
+ */
+exports.PluginMetaDataSchema = typebox_1.Type.Object({
+    id: typebox_1.Type.String({ description: 'Plugin ID.' }),
+    name: typebox_1.Type.String({ description: 'Plugin name.' }),
+    version: typebox_1.Type.String({ description: 'Plugin version.' })
+}, {
+    $id: 'PluginMetaData',
+    description: 'Plugin metadata.'
+});
+/**
+ * Server features response — available APIs and installed plugins.
+ */
+exports.FeaturesModelSchema = typebox_1.Type.Object({
+    apis: typebox_1.Type.Array(typebox_1.Type.String(), {
+        description: 'Implemented APIs.'
+    }),
+    plugins: typebox_1.Type.Array(exports.PluginMetaDataSchema, {
+        description: 'Installed Plugins.'
+    })
+}, {
+    $id: 'FeaturesModel',
+    description: 'Features response'
+});

package/dist/typebox/history-schemas.d.ts

@@ -0,0 +1,34 @@
+/**
+ * TypeBox Schema Definitions for the Signal K History API
+ */
+import { type Static } from '@sinclair/typebox';
+export declare const AggregateMethodSchema: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"average">, import("@sinclair/typebox").TLiteral<"min">, import("@sinclair/typebox").TLiteral<"max">, import("@sinclair/typebox").TLiteral<"first">, import("@sinclair/typebox").TLiteral<"last">, import("@sinclair/typebox").TLiteral<"mid">, import("@sinclair/typebox").TLiteral<"middle_index">, import("@sinclair/typebox").TLiteral<"sma">, import("@sinclair/typebox").TLiteral<"ema">]>;
+export type AggregateMethodSchemaType = Static<typeof AggregateMethodSchema>;
+export declare const ValuesResponseSchema: import("@sinclair/typebox").TObject<{
+    context: import("@sinclair/typebox").TString;
+    range: import("@sinclair/typebox").TObject<{
+        from: import("@sinclair/typebox").TString;
+        to: import("@sinclair/typebox").TString;
+    }>;
+    values: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        path: import("@sinclair/typebox").TString;
+        method: import("@sinclair/typebox").TString;
+    }>>;
+    data: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>]>>>;
+}>;
+export type ValuesResponseSchemaType = Static<typeof ValuesResponseSchema>;
+export declare const PathSpecSchema: import("@sinclair/typebox").TObject<{
+    path: import("@sinclair/typebox").TString;
+    aggregate: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"average">, import("@sinclair/typebox").TLiteral<"min">, import("@sinclair/typebox").TLiteral<"max">, import("@sinclair/typebox").TLiteral<"first">, import("@sinclair/typebox").TLiteral<"last">, import("@sinclair/typebox").TLiteral<"mid">, import("@sinclair/typebox").TLiteral<"middle_index">, import("@sinclair/typebox").TLiteral<"sma">, import("@sinclair/typebox").TLiteral<"ema">]>;
+    parameter: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+}>;
+export type PathSpecSchemaType = Static<typeof PathSpecSchema>;
+export declare const HistoryProviderInfoSchema: import("@sinclair/typebox").TObject<{
+    isDefault: import("@sinclair/typebox").TBoolean;
+}>;
+export type HistoryProviderInfoSchemaType = Static<typeof HistoryProviderInfoSchema>;
+export declare const HistoryProvidersResponseSchema: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+    isDefault: import("@sinclair/typebox").TBoolean;
+}>>;
+export type HistoryProvidersResponseSchemaType = Static<typeof HistoryProvidersResponseSchema>;
+//# sourceMappingURL=history-schemas.d.ts.map

package/dist/typebox/history-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/history-schemas.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,qBAAqB,2cAiBjC,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAE5E,eAAO,MAAM,oBAAoB;;;;;;;;;;;EA8ChC,CAAA;AACD,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAE1E,eAAO,MAAM,cAAc;;;;EAc1B,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAA;AAE9D,eAAO,MAAM,yBAAyB;;EAOrC,CAAA;AACD,MAAM,MAAM,6BAA6B,GAAG,MAAM,CAChD,OAAO,yBAAyB,CACjC,CAAA;AAED,eAAO,MAAM,8BAA8B;;GAO1C,CAAA;AACD,MAAM,MAAM,kCAAkC,GAAG,MAAM,CACrD,OAAO,8BAA8B,CACtC,CAAA"}

package/dist/typebox/history-schemas.js

@@ -0,0 +1,75 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K History API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HistoryProvidersResponseSchema = exports.HistoryProviderInfoSchema = exports.PathSpecSchema = exports.ValuesResponseSchema = exports.AggregateMethodSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+exports.AggregateMethodSchema = typebox_1.Type.Union([
+    typebox_1.Type.Literal('average'),
+    typebox_1.Type.Literal('min'),
+    typebox_1.Type.Literal('max'),
+    typebox_1.Type.Literal('first'),
+    typebox_1.Type.Literal('last'),
+    typebox_1.Type.Literal('mid'),
+    typebox_1.Type.Literal('middle_index'),
+    typebox_1.Type.Literal('sma'),
+    typebox_1.Type.Literal('ema')
+], {
+    $id: 'AggregateMethod',
+    description: "Aggregation method for historical data. The 'sma' (Simple Moving Average) and 'ema' (Exponential Moving Average) methods accept an optional numeric parameter separated by colon: for sma it is the number of samples, for ema it is the alpha value (0-1)."
+});
+exports.ValuesResponseSchema = typebox_1.Type.Object({
+    context: typebox_1.Type.String({
+        description: 'Signal K context that the data is about',
+        examples: ['vessels.urn:mrn:imo:mmsi:123456789']
+    }),
+    range: typebox_1.Type.Object({
+        from: typebox_1.Type.String({
+            format: 'date-time',
+            description: 'Start of the time range, inclusive, as UTC timestamp',
+            examples: ['2018-03-20T09:12:28Z']
+        }),
+        to: typebox_1.Type.String({
+            format: 'date-time',
+            description: 'End of the time range, inclusive, as UTC timestamp',
+            examples: ['2018-03-20T09:13:28Z']
+        })
+    }),
+    values: typebox_1.Type.Array(typebox_1.Type.Object({
+        path: typebox_1.Type.String({ description: 'Signal K path' }),
+        method: typebox_1.Type.String({ description: 'Aggregation method' })
+    })),
+    data: typebox_1.Type.Array(typebox_1.Type.Array(typebox_1.Type.Union([
+        typebox_1.Type.String(),
+        typebox_1.Type.Number(),
+        typebox_1.Type.Null(),
+        typebox_1.Type.Array(typebox_1.Type.Number())
+    ]), {
+        description: 'Data for a point in time. The first array element is the timestamp in ISO 8601 format. Missing data for a path is returned as null'
+    }), {
+        examples: [[['2023-11-09T02:45:38.160Z', 13.2, null, [-120.5, 59.2]]]]
+    })
+}, {
+    $id: 'HistoryValuesResponse',
+    description: 'Historical data series with header and data rows'
+});
+exports.PathSpecSchema = typebox_1.Type.Object({
+    path: typebox_1.Type.String({ description: 'Signal K path' }),
+    aggregate: exports.AggregateMethodSchema,
+    parameter: typebox_1.Type.Array(typebox_1.Type.String(), {
+        description: 'Additional parameters for the aggregation method (e.g., sample count for sma, alpha for ema)'
+    })
+}, {
+    $id: 'PathSpec',
+    description: 'Specification for a path to query, including the aggregation method and optional parameters'
+});
+exports.HistoryProviderInfoSchema = typebox_1.Type.Object({
+    isDefault: typebox_1.Type.Boolean({
+        description: '`true` if this provider is set as the default.'
+    })
+}, { $id: 'HistoryProviderInfo' });
+exports.HistoryProvidersResponseSchema = typebox_1.Type.Record(typebox_1.Type.String({ description: 'Plugin id of the history provider' }), exports.HistoryProviderInfoSchema, {
+    $id: 'HistoryProvidersResponse',
+    description: 'Map of registered history providers keyed by plugin id'
+});

package/dist/typebox/index.d.ts

@@ -0,0 +1,11 @@
+export * from './shared-schemas';
+export * from './protocol-schemas';
+export * from './autopilot-schemas';
+export * from './course-schemas';
+export * from './discovery-schemas';
+export * from './history-schemas';
+export * from './notifications-schemas';
+export * from './radar-schemas';
+export * from './resources-schemas';
+export * from './weather-schemas';
+//# sourceMappingURL=index.d.ts.map

package/dist/typebox/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/typebox/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA"}

package/dist/typebox/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shared-schemas"), exports);
+__exportStar(require("./protocol-schemas"), exports);
+__exportStar(require("./autopilot-schemas"), exports);
+__exportStar(require("./course-schemas"), exports);
+__exportStar(require("./discovery-schemas"), exports);
+__exportStar(require("./history-schemas"), exports);
+__exportStar(require("./notifications-schemas"), exports);
+__exportStar(require("./radar-schemas"), exports);
+__exportStar(require("./resources-schemas"), exports);
+__exportStar(require("./weather-schemas"), exports);

package/dist/typebox/notifications-schemas.d.ts

@@ -0,0 +1,50 @@
+/**
+ * TypeBox Schema Definitions for the Signal K Notifications API
+ */
+import { type Static } from '@sinclair/typebox';
+import { AlarmStateSchema, AlarmMethodSchema, AlarmStatusSchema, NotificationSchema } from './protocol-schemas';
+export { AlarmStateSchema, AlarmMethodSchema, AlarmStatusSchema, NotificationSchema };
+/**
+ * Alarm method array — wraps the AlarmMethod enum for OpenAPI.
+ */
+export declare const AlarmMethodArraySchema: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"visual">, import("@sinclair/typebox").TLiteral<"sound">]>>;
+/**
+ * Alarm object — state, method, message, and optional status.
+ * Used as the `value` field in a notification response.
+ */
+export declare const AlarmSchema: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"nominal">, import("@sinclair/typebox").TLiteral<"normal">, import("@sinclair/typebox").TLiteral<"alert">, import("@sinclair/typebox").TLiteral<"warn">, import("@sinclair/typebox").TLiteral<"alarm">, import("@sinclair/typebox").TLiteral<"emergency">]>;
+    method: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"visual">, import("@sinclair/typebox").TLiteral<"sound">]>>;
+    message: import("@sinclair/typebox").TString;
+    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        silenced: import("@sinclair/typebox").TBoolean;
+        acknowledged: import("@sinclair/typebox").TBoolean;
+        canSilence: import("@sinclair/typebox").TBoolean;
+        canAcknowledge: import("@sinclair/typebox").TBoolean;
+        canClear: import("@sinclair/typebox").TBoolean;
+    }>>;
+}>;
+export type Alarm = Static<typeof AlarmSchema>;
+/**
+ * Notification response wrapper — value containing an alarm.
+ */
+export declare const NotificationResponseSchema: import("@sinclair/typebox").TObject<{
+    value: import("@sinclair/typebox").TObject<{
+        state: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"nominal">, import("@sinclair/typebox").TLiteral<"normal">, import("@sinclair/typebox").TLiteral<"alert">, import("@sinclair/typebox").TLiteral<"warn">, import("@sinclair/typebox").TLiteral<"alarm">, import("@sinclair/typebox").TLiteral<"emergency">]>;
+        method: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"visual">, import("@sinclair/typebox").TLiteral<"sound">]>>;
+        message: import("@sinclair/typebox").TString;
+        status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            silenced: import("@sinclair/typebox").TBoolean;
+            acknowledged: import("@sinclair/typebox").TBoolean;
+            canSilence: import("@sinclair/typebox").TBoolean;
+            canAcknowledge: import("@sinclair/typebox").TBoolean;
+            canClear: import("@sinclair/typebox").TBoolean;
+        }>>;
+    }>;
+}>;
+export type NotificationResponse = Static<typeof NotificationResponseSchema>;
+/**
+ * Notification ID parameter — UUID v4 format.
+ */
+export declare const NotificationIdParamSchema: import("@sinclair/typebox").TString;
+//# sourceMappingURL=notifications-schemas.d.ts.map

package/dist/typebox/notifications-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/notifications-schemas.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,oBAAoB,CAAA;AAG3B,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EACnB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,yKAKjC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;EAWvB,CAAA;AACD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,WAAW,CAAC,CAAA;AAE9C;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;EAQtC,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE5E;;GAEG;AACH,eAAO,MAAM,yBAAyB,qCAKpC,CAAA"}

package/dist/typebox/notifications-schemas.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K Notifications API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationIdParamSchema = exports.NotificationResponseSchema = exports.AlarmSchema = exports.AlarmMethodArraySchema = exports.NotificationSchema = exports.AlarmStatusSchema = exports.AlarmMethodSchema = exports.AlarmStateSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const protocol_schemas_1 = require("./protocol-schemas");
+Object.defineProperty(exports, "AlarmStateSchema", { enumerable: true, get: function () { return protocol_schemas_1.AlarmStateSchema; } });
+Object.defineProperty(exports, "AlarmMethodSchema", { enumerable: true, get: function () { return protocol_schemas_1.AlarmMethodSchema; } });
+Object.defineProperty(exports, "AlarmStatusSchema", { enumerable: true, get: function () { return protocol_schemas_1.AlarmStatusSchema; } });
+Object.defineProperty(exports, "NotificationSchema", { enumerable: true, get: function () { return protocol_schemas_1.NotificationSchema; } });
+const shared_schemas_1 = require("./shared-schemas");
+/**
+ * Alarm method array — wraps the AlarmMethod enum for OpenAPI.
+ */
+exports.AlarmMethodArraySchema = typebox_1.Type.Array(protocol_schemas_1.AlarmMethodSchema, {
+    $id: 'AlarmMethodArray',
+    description: 'Methods to use to raise the alarm.',
+    uniqueItems: true,
+    examples: [['sound']]
+});
+/**
+ * Alarm object — state, method, message, and optional status.
+ * Used as the `value` field in a notification response.
+ */
+exports.AlarmSchema = typebox_1.Type.Object({
+    state: protocol_schemas_1.AlarmStateSchema,
+    method: exports.AlarmMethodArraySchema,
+    message: typebox_1.Type.String({ description: 'Message to display or speak' }),
+    status: typebox_1.Type.Optional(protocol_schemas_1.AlarmStatusSchema)
+}, {
+    $id: 'Alarm',
+    description: 'Alarm notification value'
+});
+/**
+ * Notification response wrapper — value containing an alarm.
+ */
+exports.NotificationResponseSchema = typebox_1.Type.Object({
+    value: exports.AlarmSchema
+}, {
+    $id: 'NotificationResponse',
+    description: 'Notification with alarm value'
+});
+/**
+ * Notification ID parameter — UUID v4 format.
+ */
+exports.NotificationIdParamSchema = typebox_1.Type.String({
+    $id: 'NotificationIdParam',
+    pattern: `${shared_schemas_1.SignalKUuidPattern}$`,
+    description: 'Notification identifier',
+    examples: ['ac3a3b2d-07e8-4f25-92bc-98e7c92f7f1a']
+});