@signalk/server-api 2.23.0 → 2.24.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"course-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/course-schemas.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EACL,cAAc,EAEd,aAAa,EAEb,gBAAgB,EAChB,mBAAmB,EACpB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,CAAA;AAC/E,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,qDAAqD;AACrD,eAAO,MAAM,sBAAsB,qCAKjC,CAAA;AAEF,wDAAwD;AACxD,eAAO,MAAM,yBAAyB,qCAKpC,CAAA;AAEF,sDAAsD;AACtD,eAAO,MAAM,mBAAmB,qCAK9B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAElE,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAA;AAExD,4BAA4B;AAC5B,eAAO,MAAM,qBAAqB,oMAUjC,CAAA;AAED,oCAAoC;AACpC,eAAO,MAAM,qBAAqB;;EAUjC,CAAA;AACD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEtE,2CAA2C;AAC3C,eAAO,MAAM,yBAAyB;;;;;;EAKrC,CAAA;AACD,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAE9E;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;IAQpC,CAAA;AACD,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE5E,4CAA4C;AAC5C,eAAO,MAAM,sBAAsB;;;;;EAqBlC,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAExE,6CAA6C;AAC7C,eAAO,MAAM,uBAAuB;;EAKnC,CAAA;AACD,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE1E,iDAAiD;AACjD,eAAO,MAAM,2BAA2B;;EAWvC,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAC5C,OAAO,2BAA2B,CACnC,CAAA;AAED,qDAAqD;AACrD,eAAO,MAAM,mBAAmB;;EAU/B,CAAA;AACD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAElE,sDAAsD;AACtD,eAAO,MAAM,oBAAoB;;EAShC,CAAA;AACD,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEpE,mDAAmD;AACnD,eAAO,MAAM,iBAAiB;;EAW7B,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAE9D,0BAA0B;AAC1B,eAAO,MAAM,iBAAiB;;;;;;EAqB7B,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAE9D,2CAA2C;AAC3C,eAAO,MAAM,uBAAuB;;;;;;;;EAanC,CAAA;AACD,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE1E,kCAAkC;AAClC,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmC5B,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE5D;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;EA2IpC,CAAA;AACD,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE5E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwB/B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;EAuB/B,CAAA;AAED,0BAA0B;AAC1B,eAAO,MAAM,kBAAkB;;EAQ9B,CAAA"}

package/dist/typebox/course-schemas.js

@@ -0,0 +1,317 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K Course API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourseConfigSchema = exports.CourseDeltaV1Schema = exports.CourseDeltaV2Schema = exports.CourseCalculationsSchema = exports.CourseInfoSchema = exports.NextPreviousPointSchema = exports.ActiveRouteSchema = exports.ReverseBodySchema = exports.PointIndexBodySchema = exports.NextPointBodySchema = exports.TargetArrivalTimeBodySchema = exports.ArrivalCircleBodySchema = exports.RouteDestinationSchema = exports.SetDestinationBodySchema = exports.PositionDestinationSchema = exports.HrefDestinationSchema = exports.CoursePointTypeSchema = exports.ArrivalCircleSchema = exports.SignalKHrefWaypointSchema = exports.SignalKHrefRouteSchema = exports.ErrorResponseSchema = exports.OkResponseSchema = exports.PositionSchema = exports.IsoTimeSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const shared_schemas_1 = require("./shared-schemas");
+Object.defineProperty(exports, "PositionSchema", { enumerable: true, get: function () { return shared_schemas_1.PositionSchema; } });
+Object.defineProperty(exports, "IsoTimeSchema", { enumerable: true, get: function () { return shared_schemas_1.IsoTimeSchema; } });
+Object.defineProperty(exports, "OkResponseSchema", { enumerable: true, get: function () { return shared_schemas_1.OkResponseSchema; } });
+Object.defineProperty(exports, "ErrorResponseSchema", { enumerable: true, get: function () { return shared_schemas_1.ErrorResponseSchema; } });
+/** Signal K route resource href (UUID v4 format). */
+exports.SignalKHrefRouteSchema = typebox_1.Type.String({
+    $id: 'SignalKHrefRoute',
+    pattern: `^/resources/routes/${shared_schemas_1.SignalKUuidPattern}$`,
+    description: 'Pointer to route resource.',
+    examples: ['/resources/routes/ac3a3b2d-07e8-4f25-92bc-98e7c92f7f1a']
+});
+/** Signal K waypoint resource href (UUID v4 format). */
+exports.SignalKHrefWaypointSchema = typebox_1.Type.String({
+    $id: 'SignalKHrefWaypoint',
+    pattern: `^/resources/waypoints/${shared_schemas_1.SignalKUuidPattern}$`,
+    description: 'Pointer to waypoint resource.',
+    examples: ['/resources/waypoints/ac3a3b2d-07e8-4f25-92bc-98e7c92f7f1a']
+});
+/** Arrival circle radius in meters (non-negative). */
+exports.ArrivalCircleSchema = typebox_1.Type.Number({
+    $id: 'ArrivalCircle',
+    minimum: 0,
+    description: 'Radius of arrival zone in meters',
+    examples: [500]
+});
+/** Type of course point. */
+exports.CoursePointTypeSchema = typebox_1.Type.Union([
+    typebox_1.Type.Literal('VesselPosition'),
+    typebox_1.Type.Literal('RoutePoint'),
+    typebox_1.Type.Literal('Location')
+], {
+    $id: 'CoursePointType',
+    description: 'Type of course point'
+});
+/** Destination by waypoint href. */
+exports.HrefDestinationSchema = typebox_1.Type.Object({
+    href: typebox_1.Type.String({
+        pattern: `^/resources/waypoints/${shared_schemas_1.SignalKUuidPattern}$`,
+        description: 'Reference to a related waypoint resource. A pointer to the resource UUID.',
+        examples: ['/resources/waypoints/ac3a3b2d-07e8-4f25-92bc-98e7c92f7f1a']
+    })
+}, { $id: 'HrefDestination' });
+/** Destination by position coordinates. */
+exports.PositionDestinationSchema = typebox_1.Type.Object({
+    position: shared_schemas_1.PositionSchema
+}, { $id: 'PositionDestination', description: 'Location coordinates.' });
+/**
+ * PUT /course/destination request body.
+ * Either a waypoint href or a position, optionally with an arrival circle.
+ */
+exports.SetDestinationBodySchema = typebox_1.Type.Intersect([
+    typebox_1.Type.Union([exports.HrefDestinationSchema, exports.PositionDestinationSchema]),
+    typebox_1.Type.Object({
+        arrivalCircle: typebox_1.Type.Optional(exports.ArrivalCircleSchema)
+    })
+], { $id: 'SetDestinationBody' });
+/** PUT /course/activeRoute request body. */
+exports.RouteDestinationSchema = typebox_1.Type.Object({
+    href: exports.SignalKHrefRouteSchema,
+    pointIndex: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        default: 0,
+        description: '0 based index of the point in the route to set as the destination'
+    })),
+    reverse: typebox_1.Type.Optional(typebox_1.Type.Boolean({
+        default: false,
+        description: 'Set to true to navigate the route points in reverse order.'
+    })),
+    arrivalCircle: typebox_1.Type.Optional(exports.ArrivalCircleSchema)
+}, { $id: 'RouteDestination' });
+/** PUT /course/arrivalCircle request body */
+exports.ArrivalCircleBodySchema = typebox_1.Type.Object({
+    value: exports.ArrivalCircleSchema
+}, { $id: 'ArrivalCircleBody' });
+/** PUT /course/targetArrivalTime request body */
+exports.TargetArrivalTimeBodySchema = typebox_1.Type.Object({
+    value: typebox_1.Type.Union([
+        typebox_1.Type.String({
+            pattern: shared_schemas_1.IsoTimePattern,
+            description: 'ISO 8601 date-time string'
+        }),
+        typebox_1.Type.Null()
+    ])
+}, { $id: 'TargetArrivalTimeBody' });
+/** PUT /course/activeRoute/nextPoint request body */
+exports.NextPointBodySchema = typebox_1.Type.Object({
+    value: typebox_1.Type.Optional(typebox_1.Type.Number({
+        default: 1,
+        description: 'Index offset of point in route (-ve = previous)'
+    }))
+}, { $id: 'NextPointBody' });
+/** PUT /course/activeRoute/pointIndex request body */
+exports.PointIndexBodySchema = typebox_1.Type.Object({
+    value: typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Index of point in route to set as destination.',
+        examples: [2]
+    })
+}, { $id: 'PointIndexBody' });
+/** PUT /course/activeRoute/reverse request body */
+exports.ReverseBodySchema = typebox_1.Type.Object({
+    pointIndex: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Index of point in route to set as destination.',
+        examples: [2]
+    }))
+}, { $id: 'ReverseBody' });
+/** Active route state. */
+exports.ActiveRouteSchema = typebox_1.Type.Object({
+    href: exports.SignalKHrefRouteSchema,
+    name: typebox_1.Type.String({
+        description: 'Name of route.',
+        examples: ['Here to eternity.']
+    }),
+    pointIndex: typebox_1.Type.Number({
+        minimum: 0,
+        description: '0 based index of the point in the route that is the current destination'
+    }),
+    pointTotal: typebox_1.Type.Number({
+        description: 'Total number of points in the route'
+    }),
+    reverse: typebox_1.Type.Boolean({
+        description: 'When true indicates the route points are being navigated in reverse order.'
+    })
+}, { $id: 'ActiveRoute' });
+/** Navigation point (next or previous). */
+exports.NextPreviousPointSchema = typebox_1.Type.Object({
+    href: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Reference to a waypoint resource.' })),
+    type: typebox_1.Type.String({
+        description: "Type of point. Known values: VesselPosition (vessel's current location), RoutePoint (a point on the active route), Location (an arbitrary geographic position).",
+        examples: ['RoutePoint', 'Location', 'VesselPosition']
+    }),
+    position: shared_schemas_1.PositionSchema
+}, { $id: 'NextPreviousPoint' });
+/** Full course state response. */
+exports.CourseInfoSchema = typebox_1.Type.Object({
+    startTime: typebox_1.Type.Union([typebox_1.Type.String({ pattern: shared_schemas_1.IsoTimePattern }), typebox_1.Type.Null()], {
+        description: 'ISO 8601 timestamp when the course was set, or null when no course is active'
+    }),
+    targetArrivalTime: typebox_1.Type.Union([typebox_1.Type.String({ pattern: shared_schemas_1.IsoTimePattern }), typebox_1.Type.Null()], {
+        description: 'ISO 8601 target arrival time, or null when not set'
+    }),
+    arrivalCircle: typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Radius of arrival zone in meters',
+        units: 'm'
+    }),
+    activeRoute: typebox_1.Type.Union([exports.ActiveRouteSchema, typebox_1.Type.Null()], {
+        description: 'The active route, or null when navigating to a point'
+    }),
+    nextPoint: typebox_1.Type.Union([exports.NextPreviousPointSchema, typebox_1.Type.Null()], {
+        description: 'The next navigation point, or null when no course is set'
+    }),
+    previousPoint: typebox_1.Type.Union([exports.NextPreviousPointSchema, typebox_1.Type.Null()], {
+        description: 'The previous navigation point (departure point or last waypoint passed), or null when no course is set'
+    })
+}, {
+    $id: 'CourseInfo',
+    description: 'Course state including active route and navigation points.'
+});
+/**
+ * Calculated course values derived from vessel position and destination.
+ */
+exports.CourseCalculationsSchema = typebox_1.Type.Object({
+    calcMethod: typebox_1.Type.Union([typebox_1.Type.Literal('GreatCircle'), typebox_1.Type.Literal('Rhumbline')], {
+        description: 'Calculation method by which values are derived.',
+        default: 'GreatCircle',
+        examples: ['Rhumbline']
+    }),
+    crossTrackError: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: "The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).",
+        units: 'm',
+        examples: [458.784]
+    })),
+    bearingTrackTrue: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to true north',
+        units: 'rad',
+        examples: [4.58491]
+    })),
+    bearingTrackMagnetic: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to magnetic north',
+        units: 'rad',
+        examples: [4.51234]
+    })),
+    estimatedTimeOfArrival: typebox_1.Type.Optional(typebox_1.Type.String({
+        pattern: shared_schemas_1.IsoTimePattern,
+        description: 'The estimated time of arrival at nextPoint position.'
+    })),
+    distance: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: "The distance between the vessel's present position and the nextPoint",
+        units: 'm',
+        examples: [10157]
+    })),
+    bearingTrue: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: "The bearing of a line between the vessel's current position and nextPoint, relative to true north",
+        units: 'rad',
+        examples: [4.58491]
+    })),
+    bearingMagnetic: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: "The bearing of a line between the vessel's current position and nextPoint, relative to magnetic north",
+        units: 'rad',
+        examples: [4.51234]
+    })),
+    velocityMadeGood: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'The velocity component of the vessel towards the nextPoint',
+        units: 'm/s',
+        examples: [7.2653]
+    })),
+    timeToGo: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        description: "Time to reach nextPoint's perpendicular with current speed and direction",
+        units: 's',
+        examples: [8491]
+    })),
+    targetSpeed: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'The average velocity required to reach the destination at the targetArrivalTime',
+        units: 'm/s',
+        examples: [2.2653]
+    })),
+    previousPoint: typebox_1.Type.Optional(typebox_1.Type.Object({
+        distance: typebox_1.Type.Optional(typebox_1.Type.Number({
+            minimum: 0,
+            description: "The distance between the vessel's present position and the start point",
+            units: 'm',
+            examples: [10157]
+        }))
+    })),
+    route: typebox_1.Type.Optional(typebox_1.Type.Object({
+        distance: typebox_1.Type.Optional(typebox_1.Type.Number({
+            minimum: 0,
+            description: 'The distance along the route to the last point',
+            units: 'm',
+            examples: [15936]
+        })),
+        timeToGo: typebox_1.Type.Optional(typebox_1.Type.Number({
+            minimum: 0,
+            description: 'Time to reach perpendicular of last point in route with current speed and direction',
+            units: 's',
+            examples: [10452]
+        })),
+        estimatedTimeOfArrival: typebox_1.Type.Optional(typebox_1.Type.String({
+            pattern: shared_schemas_1.IsoTimePattern,
+            description: 'The estimated time of arrival at last point in route.'
+        }))
+    }))
+}, {
+    $id: 'CourseCalculations',
+    description: 'Calculated course data values.'
+});
+/**
+ * v2 course delta paths emitted on navigation.course.*
+ * Emitted via handleMessage() with SKVersion.v2
+ */
+exports.CourseDeltaV2Schema = typebox_1.Type.Object({
+    startTime: typebox_1.Type.Union([
+        typebox_1.Type.String({ pattern: shared_schemas_1.IsoTimePattern }),
+        typebox_1.Type.Null()
+    ]),
+    targetArrivalTime: typebox_1.Type.Union([
+        typebox_1.Type.String({ pattern: shared_schemas_1.IsoTimePattern }),
+        typebox_1.Type.Null()
+    ]),
+    activeRoute: typebox_1.Type.Union([exports.ActiveRouteSchema, typebox_1.Type.Null()]),
+    arrivalCircle: typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Radius of arrival zone in meters',
+        units: 'm'
+    }),
+    previousPoint: typebox_1.Type.Union([exports.NextPreviousPointSchema, typebox_1.Type.Null()]),
+    nextPoint: typebox_1.Type.Union([exports.NextPreviousPointSchema, typebox_1.Type.Null()])
+}, {
+    $id: 'CourseDeltaV2',
+    description: 'Course delta values emitted under navigation.course.* (Signal K v2)'
+});
+/**
+ * v1 course delta paths emitted on courseGreatCircle.* / courseRhumbline.*
+ * Emitted via handleMessage() with SKVersion.v1
+ */
+exports.CourseDeltaV1Schema = typebox_1.Type.Object({
+    'activeRoute.href': typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()]),
+    'activeRoute.startTime': typebox_1.Type.Union([
+        typebox_1.Type.String({ pattern: shared_schemas_1.IsoTimePattern }),
+        typebox_1.Type.Null()
+    ]),
+    'nextPoint.value.href': typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()]),
+    'nextPoint.value.type': typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()]),
+    'nextPoint.position': typebox_1.Type.Union([shared_schemas_1.PositionSchema, typebox_1.Type.Null()]),
+    'nextPoint.arrivalCircle': typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Radius of arrival zone in meters',
+        units: 'm'
+    }),
+    'previousPoint.position': typebox_1.Type.Union([shared_schemas_1.PositionSchema, typebox_1.Type.Null()]),
+    'previousPoint.value.type': typebox_1.Type.Union([typebox_1.Type.String(), typebox_1.Type.Null()])
+}, {
+    $id: 'CourseDeltaV1',
+    description: 'Course delta values emitted under navigation.courseGreatCircle.* and navigation.courseRhumbline.* (Signal K v1)'
+});
+/** API config response */
+exports.CourseConfigSchema = typebox_1.Type.Object({
+    apiOnly: typebox_1.Type.Boolean({
+        description: 'When true, course data is only available via the API and not emitted as v1 deltas'
+    })
+}, { $id: 'CourseConfig', description: 'Course API configuration' });

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

@@ -0,0 +1,53 @@
+/**
+ * TypeBox Schema Definitions for the Signal K Discovery API
+ */
+import { type Static } from '@sinclair/typebox';
+/**
+ * v1 endpoint descriptor — protocol addresses for a specific API version.
+ */
+export declare const V1EndpointSchema: import("@sinclair/typebox").TObject<{
+    version: import("@sinclair/typebox").TString;
+    'signalk-http': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    'signalk-ws': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    'signalk-tcp': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+/**
+ * Discovery response — server version and service endpoints.
+ */
+export declare const DiscoveryDataSchema: import("@sinclair/typebox").TObject<{
+    endpoints: import("@sinclair/typebox").TObject<{
+        v1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            version: import("@sinclair/typebox").TString;
+            'signalk-http': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            'signalk-ws': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            'signalk-tcp': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        }>>;
+    }>;
+    server: import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        version: import("@sinclair/typebox").TString;
+    }>;
+}>;
+export type DiscoveryData = Static<typeof DiscoveryDataSchema>;
+/**
+ * Plugin metadata for feature discovery.
+ */
+export declare const PluginMetaDataSchema: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    name: import("@sinclair/typebox").TString;
+    version: import("@sinclair/typebox").TString;
+}>;
+export type PluginMetaData = Static<typeof PluginMetaDataSchema>;
+/**
+ * Server features response — available APIs and installed plugins.
+ */
+export declare const FeaturesModelSchema: import("@sinclair/typebox").TObject<{
+    apis: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    plugins: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        id: import("@sinclair/typebox").TString;
+        name: import("@sinclair/typebox").TString;
+        version: import("@sinclair/typebox").TString;
+    }>>;
+}>;
+export type FeaturesModel = Static<typeof FeaturesModelSchema>;
+//# sourceMappingURL=discovery-schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"discovery-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/discovery-schemas.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAErD;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;EA0B5B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;EAmB/B,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;EAUhC,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;EAa/B,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

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);