@signalk/server-api 2.23.0 → 2.24.0

package/dist/typebox/resources-schemas.js

@@ -0,0 +1,214 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K Resources API
+ *
+ * Covers routes, waypoints, regions, notes, and charts.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceActionCreatedResponseSchema = exports.ResourceActionOkResponseSchema = exports.ChartSchema = exports.MapServerSourceSchema = exports.TileLayerSourceSchema = exports.NoteSchema = exports.NoteBaseModelSchema = exports.RegionSchema = exports.WaypointSchema = exports.RouteSchema = exports.RoutePointMetaSchema = exports.BaseResponseModelSchema = exports.PositionAttributeSchema = exports.HrefAttributeSchema = exports.SignalKHrefSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const shared_schemas_1 = require("./shared-schemas");
+/**
+ * Signal K resource href — generic pointer to any resource type by UUID.
+ */
+exports.SignalKHrefSchema = typebox_1.Type.String({
+    $id: 'SignalKHref',
+    pattern: `^/resources/(\\w*)/${shared_schemas_1.SignalKUuidPattern}$`,
+    description: 'Reference to a related resource. A pointer to the resource UUID.'
+});
+/** Href attribute — used to link a note to another resource */
+exports.HrefAttributeSchema = typebox_1.Type.Object({
+    href: exports.SignalKHrefSchema
+}, { $id: 'HrefAttribute' });
+/** Position attribute — used to give a note a geographic position */
+exports.PositionAttributeSchema = typebox_1.Type.Object({
+    position: shared_schemas_1.PositionSchema
+}, { $id: 'ResourcePositionAttribute', description: 'Resource location.' });
+exports.BaseResponseModelSchema = typebox_1.Type.Object({
+    timestamp: typebox_1.Type.String({
+        description: 'ISO 8601 timestamp of when the resource was last modified',
+        examples: ['2024-01-15T12:30:00.000Z']
+    }),
+    $source: typebox_1.Type.String({
+        description: 'Dot-separated identifier of the source that provided this resource (e.g. the resource provider plugin)',
+        examples: ['resources-provider']
+    })
+}, {
+    $id: 'BaseResponseModel',
+    description: 'Metadata fields included in resource responses'
+});
+/** Route point metadata */
+exports.RoutePointMetaSchema = typebox_1.Type.Object({
+    name: typebox_1.Type.String({ description: 'Point name / identifier' })
+}, {
+    $id: 'RoutePointMeta',
+    additionalProperties: true
+});
+/** Route resource */
+exports.RouteSchema = typebox_1.Type.Object({
+    name: typebox_1.Type.Optional(typebox_1.Type.String({ description: "Route's common name" })),
+    description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'A description of the route' })),
+    distance: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'Total distance from start to end in meters',
+        units: 'm',
+        minimum: 0
+    })),
+    feature: typebox_1.Type.Object({
+        geometry: shared_schemas_1.GeoJsonLinestringGeometrySchema,
+        properties: typebox_1.Type.Optional(typebox_1.Type.Object({
+            coordinatesMeta: typebox_1.Type.Optional(typebox_1.Type.Array(typebox_1.Type.Union([exports.RoutePointMetaSchema, exports.HrefAttributeSchema]), {
+                description: 'Metadata for each point within the route'
+            }))
+        }, { additionalProperties: true }))
+    })
+}, {
+    $id: 'Route',
+    description: 'A route resource'
+});
+/** Waypoint resource */
+exports.WaypointSchema = typebox_1.Type.Object({
+    name: typebox_1.Type.Optional(typebox_1.Type.String({ description: "Waypoint's common name" })),
+    description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'A description of the waypoint' })),
+    type: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'The type of point (e.g. Waypoint, PoI, Race Mark, etc)'
+    })),
+    feature: typebox_1.Type.Object({
+        geometry: shared_schemas_1.GeoJsonPointGeometrySchema,
+        properties: typebox_1.Type.Optional(typebox_1.Type.Object({}, {
+            additionalProperties: true,
+            description: 'Additional feature properties'
+        }))
+    })
+}, {
+    $id: 'Waypoint',
+    description: 'A waypoint resource'
+});
+/** Region resource */
+exports.RegionSchema = typebox_1.Type.Object({
+    name: typebox_1.Type.Optional(typebox_1.Type.String({ description: "Region's common name" })),
+    description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'A description of the region' })),
+    feature: typebox_1.Type.Object({
+        geometry: typebox_1.Type.Union([
+            shared_schemas_1.GeoJsonPolygonGeometrySchema,
+            shared_schemas_1.GeoJsonMultiPolygonGeometrySchema
+        ]),
+        properties: typebox_1.Type.Optional(typebox_1.Type.Object({}, {
+            additionalProperties: true,
+            description: 'Additional feature properties'
+        }))
+    })
+}, {
+    $id: 'Region',
+    description: 'A region resource'
+});
+/** Note base model */
+exports.NoteBaseModelSchema = typebox_1.Type.Object({
+    title: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Title of note' })),
+    description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Text describing note' })),
+    mimeType: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'MIME type of the note content',
+        examples: ['text/plain', 'text/html', 'application/pdf']
+    })),
+    url: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Location of the note' })),
+    properties: typebox_1.Type.Optional(typebox_1.Type.Object({}, {
+        additionalProperties: true,
+        description: 'Additional user defined note properties'
+    }))
+}, { $id: 'NoteBaseModel' });
+/** Note resource — a note linked to either an href or a position */
+exports.NoteSchema = typebox_1.Type.Intersect([
+    exports.NoteBaseModelSchema,
+    typebox_1.Type.Partial(typebox_1.Type.Object({
+        href: exports.SignalKHrefSchema,
+        position: shared_schemas_1.PositionSchema
+    }))
+], {
+    $id: 'Note',
+    description: 'A note resource — linked to either an href or a position'
+});
+/** Tile layer source */
+exports.TileLayerSourceSchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Literal('tilelayer'),
+    bounds: typebox_1.Type.Optional(typebox_1.Type.Array(typebox_1.Type.Number(), {
+        minItems: 4,
+        maxItems: 4,
+        description: 'Geographic bounding box in [west, south, east, north] order (longitude, latitude, longitude, latitude) in degrees'
+    })),
+    format: typebox_1.Type.Optional(typebox_1.Type.Union([
+        typebox_1.Type.Literal('jpg'),
+        typebox_1.Type.Literal('pbf'),
+        typebox_1.Type.Literal('png'),
+        typebox_1.Type.Literal('webp')
+    ], { description: 'Tile image format' })),
+    maxzoom: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        maximum: 30,
+        default: 0,
+        description: 'Maximum zoom level available'
+    })),
+    minzoom: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 0,
+        maximum: 30,
+        default: 0,
+        description: 'Minimum zoom level available'
+    })),
+    scale: typebox_1.Type.Optional(typebox_1.Type.Number({
+        minimum: 1,
+        default: 250000,
+        description: 'Chart scale denominator (e.g. 250000 for 1:250000)'
+    }))
+}, {
+    $id: 'TileLayerSource',
+    description: 'A tile layer chart source (XYZ/TMS tiles)'
+});
+/** Map server source */
+exports.MapServerSourceSchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Union([
+        typebox_1.Type.Literal('tileJSON'),
+        typebox_1.Type.Literal('WMS'),
+        typebox_1.Type.Literal('WMTS'),
+        typebox_1.Type.Literal('mapstyleJSON'),
+        typebox_1.Type.Literal('S-57')
+    ])
+}, {
+    $id: 'MapServerSource',
+    description: 'A map server chart source (WMS, WMTS, tileJSON, mapstyleJSON, or S-57)'
+});
+/** Chart resource */
+exports.ChartSchema = typebox_1.Type.Intersect([
+    typebox_1.Type.Object({
+        identifier: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Chart identifier / number' })),
+        name: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Chart name' })),
+        description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'A text description of the chart' })),
+        url: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'URL to tile / map source' })),
+        layers: typebox_1.Type.Optional(typebox_1.Type.Array(typebox_1.Type.String(), {
+            description: 'List of chart layer ids'
+        }))
+    }),
+    typebox_1.Type.Union([exports.TileLayerSourceSchema, exports.MapServerSourceSchema])
+], {
+    $id: 'Chart',
+    description: 'A chart resource'
+});
+/**
+ * 200 success response with resource ID.
+ */
+exports.ResourceActionOkResponseSchema = typebox_1.Type.Object({
+    state: typebox_1.Type.Literal('COMPLETED'),
+    statusCode: typebox_1.Type.Literal(200),
+    id: typebox_1.Type.String({
+        pattern: `${shared_schemas_1.SignalKUuidPattern}$`,
+        description: 'Resource UUID'
+    })
+}, { $id: 'ResourceActionOkResponse' });
+/**
+ * 201 created response with resource ID.
+ */
+exports.ResourceActionCreatedResponseSchema = typebox_1.Type.Object({
+    state: typebox_1.Type.Literal('COMPLETED'),
+    statusCode: typebox_1.Type.Literal(201),
+    id: typebox_1.Type.String({
+        pattern: `${shared_schemas_1.SignalKUuidPattern}$`,
+        description: 'Resource UUID'
+    })
+}, { $id: 'ResourceActionCreatedResponse' });

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

@@ -0,0 +1,92 @@
+/**
+ * Shared TypeBox Schema Definitions for Signal K
+ *
+ * Domain object schemas and common patterns used across multiple APIs.
+ *
+ * Metadata (descriptions, units, examples) sourced from:
+ *   specification/schemas/definitions.json
+ *   specification/schemas/groups/navigation.json
+ */
+import { type Static } from '@sinclair/typebox';
+/** Signal K UUID v4 pattern (without anchors) */
+export declare const SignalKUuidPattern = "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}";
+/** ISO 8601 date-time pattern */
+export declare const IsoTimePattern = "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:\\.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$";
+/**
+ * ISO 8601 date-time string.
+ * @see specification/schemas/definitions.json#/definitions/timestamp
+ */
+export declare const IsoTimeSchema: import("@sinclair/typebox").TString;
+export type IsoTimeType = Static<typeof IsoTimeSchema>;
+/**
+ * Signal K UUID — Maritime Resource Name.
+ * Format: urn:mrn:signalk:uuid:{uuid-v4}
+ * @see specification/schemas/definitions.json#/definitions/uuid
+ */
+export declare const SignalKUuidSchema: import("@sinclair/typebox").TString;
+/**
+ * MMSI — Maritime Mobile Service Identity (vessel).
+ * @see specification/schemas/definitions.json#/definitions/mmsi
+ */
+export declare const MmsiSchema: import("@sinclair/typebox").TString;
+/**
+ * Geographic position with latitude, longitude, and optional altitude.
+ *
+ * Canonical Position schema — all APIs reference this single definition.
+ * @see specification/schemas/definitions.json#/definitions/position
+ */
+export declare const PositionSchema: import("@sinclair/typebox").TObject<{
+    latitude: import("@sinclair/typebox").TNumber;
+    longitude: import("@sinclair/typebox").TNumber;
+    altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+export type Position = Static<typeof PositionSchema>;
+/**
+ * Relative position origin — a circle defined by radius and center position.
+ * Used for subscription context filtering.
+ */
+export declare const RelativePositionOriginSchema: import("@sinclair/typebox").TObject<{
+    radius: import("@sinclair/typebox").TNumber;
+    position: import("@sinclair/typebox").TObject<{
+        latitude: import("@sinclair/typebox").TNumber;
+        longitude: import("@sinclair/typebox").TNumber;
+        altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>;
+}>;
+export type RelativePositionOrigin = Static<typeof RelativePositionOriginSchema>;
+/** GeoJSON Point geometry object (type + coordinates) */
+export declare const GeoJsonPointGeometrySchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"Point">;
+    coordinates: import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNumber]>;
+}>;
+export type GeoJsonPointGeometry = Static<typeof GeoJsonPointGeometrySchema>;
+/** GeoJSON LineString geometry object (type + coordinates) */
+export declare const GeoJsonLinestringGeometrySchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"LineString">;
+    coordinates: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNumber]>>;
+}>;
+export type GeoJsonLinestringGeometry = Static<typeof GeoJsonLinestringGeometrySchema>;
+/** GeoJSON Polygon geometry object (type + coordinates) */
+export declare const GeoJsonPolygonGeometrySchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"Polygon">;
+    coordinates: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNumber]>>>;
+}>;
+export type GeoJsonPolygonGeometry = Static<typeof GeoJsonPolygonGeometrySchema>;
+/** GeoJSON MultiPolygon geometry object (type + coordinates) */
+export declare const GeoJsonMultiPolygonGeometrySchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"MultiPolygon">;
+    coordinates: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNumber]>>>>;
+}>;
+export type GeoJsonMultiPolygonGeometry = Static<typeof GeoJsonMultiPolygonGeometrySchema>;
+/** Standard success response */
+export declare const OkResponseSchema: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TLiteral<"COMPLETED">;
+    statusCode: import("@sinclair/typebox").TLiteral<200>;
+}>;
+/** Standard error response */
+export declare const ErrorResponseSchema: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TLiteral<"FAILED">;
+    statusCode: import("@sinclair/typebox").TNumber;
+    message: import("@sinclair/typebox").TString;
+}>;
+//# sourceMappingURL=shared-schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/shared-schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAErD,iDAAiD;AACjD,eAAO,MAAM,kBAAkB,yFACyD,CAAA;AAExF,iCAAiC;AACjC,eAAO,MAAM,cAAc,iGACqE,CAAA;AAEhG;;;GAGG;AACH,eAAO,MAAM,aAAa,qCAKxB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,aAAa,CAAC,CAAA;AAEtD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,qCAO5B,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,qCAMrB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;EA4B1B,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAA;AAEpD;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;;EAaxC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEhF,yDAAyD;AACzD,eAAO,MAAM,0BAA0B;;;EAYtC,CAAA;AACD,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE5E,8DAA8D;AAC9D,eAAO,MAAM,+BAA+B;;;EAe3C,CAAA;AACD,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAC5C,OAAO,+BAA+B,CACvC,CAAA;AAED,2DAA2D;AAC3D,eAAO,MAAM,4BAA4B;;;EAiBxC,CAAA;AACD,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEhF,gEAAgE;AAChE,eAAO,MAAM,iCAAiC;;;EAmB7C,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAC9C,OAAO,iCAAiC,CACzC,CAAA;AAED,gCAAgC;AAChC,eAAO,MAAM,gBAAgB;;;EAM5B,CAAA;AAED,8BAA8B;AAC9B,eAAO,MAAM,mBAAmB;;;;EAO/B,CAAA"}

package/dist/typebox/shared-schemas.js

@@ -0,0 +1,149 @@
+"use strict";
+/**
+ * Shared TypeBox Schema Definitions for Signal K
+ *
+ * Domain object schemas and common patterns used across multiple APIs.
+ *
+ * Metadata (descriptions, units, examples) sourced from:
+ *   specification/schemas/definitions.json
+ *   specification/schemas/groups/navigation.json
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResponseSchema = exports.OkResponseSchema = exports.GeoJsonMultiPolygonGeometrySchema = exports.GeoJsonPolygonGeometrySchema = exports.GeoJsonLinestringGeometrySchema = exports.GeoJsonPointGeometrySchema = exports.RelativePositionOriginSchema = exports.PositionSchema = exports.MmsiSchema = exports.SignalKUuidSchema = exports.IsoTimeSchema = exports.IsoTimePattern = exports.SignalKUuidPattern = void 0;
+const typebox_1 = require("@sinclair/typebox");
+/** Signal K UUID v4 pattern (without anchors) */
+exports.SignalKUuidPattern = '[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}';
+/** ISO 8601 date-time pattern */
+exports.IsoTimePattern = '^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:\\.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$';
+/**
+ * ISO 8601 date-time string.
+ * @see specification/schemas/definitions.json#/definitions/timestamp
+ */
+exports.IsoTimeSchema = typebox_1.Type.String({
+    $id: 'IsoTime',
+    pattern: exports.IsoTimePattern,
+    description: 'ISO 8601 date-time string',
+    examples: ['2022-04-22T05:02:56.484Z']
+});
+/**
+ * Signal K UUID — Maritime Resource Name.
+ * Format: urn:mrn:signalk:uuid:{uuid-v4}
+ * @see specification/schemas/definitions.json#/definitions/uuid
+ */
+exports.SignalKUuidSchema = typebox_1.Type.String({
+    $id: 'SignalKUuid',
+    pattern: `^urn:mrn:signalk:uuid:${exports.SignalKUuidPattern}$`,
+    description: 'A unique Signal K flavoured maritime resource identifier (MRN). ' +
+        'Format: urn:mrn:signalk:uuid:{uuid-v4}',
+    examples: ['urn:mrn:signalk:uuid:b7590868-1d62-47d9-989c-32321b349fb9']
+});
+/**
+ * MMSI — Maritime Mobile Service Identity (vessel).
+ * @see specification/schemas/definitions.json#/definitions/mmsi
+ */
+exports.MmsiSchema = typebox_1.Type.String({
+    $id: 'Mmsi',
+    pattern: '^[2-7][0-9]{8}$',
+    description: 'Maritime Mobile Service Identity (MMSI). 9 digits, first digit 2-7.',
+    examples: ['503123456']
+});
+/**
+ * Geographic position with latitude, longitude, and optional altitude.
+ *
+ * Canonical Position schema — all APIs reference this single definition.
+ * @see specification/schemas/definitions.json#/definitions/position
+ */
+exports.PositionSchema = typebox_1.Type.Object({
+    latitude: typebox_1.Type.Number({
+        minimum: -90,
+        maximum: 90,
+        description: 'Latitude',
+        units: 'deg',
+        examples: [52.0987654]
+    }),
+    longitude: typebox_1.Type.Number({
+        minimum: -180,
+        maximum: 180,
+        description: 'Longitude',
+        units: 'deg',
+        examples: [4.98765245]
+    }),
+    altitude: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'Altitude',
+        units: 'm',
+        examples: [12.5]
+    }))
+}, {
+    $id: 'SignalKPosition',
+    description: 'The position in 3 dimensions'
+});
+/**
+ * Relative position origin — a circle defined by radius and center position.
+ * Used for subscription context filtering.
+ */
+exports.RelativePositionOriginSchema = typebox_1.Type.Object({
+    radius: typebox_1.Type.Number({
+        minimum: 0,
+        description: 'Radius in meters',
+        units: 'm'
+    }),
+    position: exports.PositionSchema
+}, {
+    $id: 'RelativePositionOrigin',
+    description: 'A circle defined by radius and center position'
+});
+/** GeoJSON Point geometry object (type + coordinates) */
+exports.GeoJsonPointGeometrySchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Literal('Point'),
+    coordinates: typebox_1.Type.Tuple([
+        typebox_1.Type.Number({ description: 'Longitude' }),
+        typebox_1.Type.Number({ description: 'Latitude' })
+    ])
+}, {
+    $id: 'GeoJsonPointGeometry',
+    description: 'GeoJSON Point geometry — [longitude, latitude]'
+});
+/** GeoJSON LineString geometry object (type + coordinates) */
+exports.GeoJsonLinestringGeometrySchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Literal('LineString'),
+    coordinates: typebox_1.Type.Array(typebox_1.Type.Tuple([
+        typebox_1.Type.Number({ description: 'Longitude' }),
+        typebox_1.Type.Number({ description: 'Latitude' })
+    ]), { minItems: 2 })
+}, {
+    $id: 'GeoJsonLineStringGeometry',
+    description: 'GeoJSON LineString geometry — array of [lon, lat] pairs'
+});
+/** GeoJSON Polygon geometry object (type + coordinates) */
+exports.GeoJsonPolygonGeometrySchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Literal('Polygon'),
+    coordinates: typebox_1.Type.Array(typebox_1.Type.Array(typebox_1.Type.Tuple([
+        typebox_1.Type.Number({ description: 'Longitude' }),
+        typebox_1.Type.Number({ description: 'Latitude' })
+    ]), { minItems: 4 }))
+}, {
+    $id: 'GeoJsonPolygonGeometry',
+    description: 'GeoJSON Polygon geometry — array of linear rings'
+});
+/** GeoJSON MultiPolygon geometry object (type + coordinates) */
+exports.GeoJsonMultiPolygonGeometrySchema = typebox_1.Type.Object({
+    type: typebox_1.Type.Literal('MultiPolygon'),
+    coordinates: typebox_1.Type.Array(typebox_1.Type.Array(typebox_1.Type.Array(typebox_1.Type.Tuple([
+        typebox_1.Type.Number({ description: 'Longitude' }),
+        typebox_1.Type.Number({ description: 'Latitude' })
+    ]), { minItems: 4 })))
+}, {
+    $id: 'GeoJsonMultiPolygonGeometry',
+    description: 'GeoJSON MultiPolygon geometry'
+});
+/** Standard success response */
+exports.OkResponseSchema = typebox_1.Type.Object({
+    state: typebox_1.Type.Literal('COMPLETED'),
+    statusCode: typebox_1.Type.Literal(200)
+}, { $id: 'OkResponse' });
+/** Standard error response */
+exports.ErrorResponseSchema = typebox_1.Type.Object({
+    state: typebox_1.Type.Literal('FAILED'),
+    statusCode: typebox_1.Type.Number(),
+    message: typebox_1.Type.String()
+}, { $id: 'ErrorResponse', description: 'Request error response' });

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

@@ -0,0 +1,82 @@
+/**
+ * TypeBox Schema Definitions for the Signal K Weather API
+ *
+ * Units follow SI conventions: K (temperature), Pa (pressure), m/s (speed),
+ * rad (direction), m (distance/visibility), ratio (humidity/cloud).
+ */
+import { type Static } from '@sinclair/typebox';
+/** Weather data type */
+export declare const WeatherDataTypeSchema: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"daily">, import("@sinclair/typebox").TLiteral<"point">, import("@sinclair/typebox").TLiteral<"observation">]>;
+/** Pressure tendency */
+export declare const PressureTendencySchema: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"steady">, import("@sinclair/typebox").TLiteral<"decreasing">, import("@sinclair/typebox").TLiteral<"increasing">]>;
+/** Precipitation type */
+export declare const PrecipitationTypeSchema: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"rain">, import("@sinclair/typebox").TLiteral<"thunderstorm">, import("@sinclair/typebox").TLiteral<"snow">, import("@sinclair/typebox").TLiteral<"freezing rain">, import("@sinclair/typebox").TLiteral<"mixed/ice">]>;
+/**
+ * Weather data model — observation, daily forecast, or point forecast.
+ */
+export declare const WeatherDataModelSchema: import("@sinclair/typebox").TObject<{
+    date: import("@sinclair/typebox").TString;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    type: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"daily">, import("@sinclair/typebox").TLiteral<"point">, import("@sinclair/typebox").TLiteral<"observation">]>;
+    sun: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        sunrise: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        sunset: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+    outside: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        uvIndex: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        cloudCover: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        horizontalVisibility: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        horizontalVisibilityOverRange: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+        temperature: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        feelsLikeTemperature: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        dewPointTemperature: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        pressure: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        pressureTendency: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"steady">, import("@sinclair/typebox").TLiteral<"decreasing">, import("@sinclair/typebox").TLiteral<"increasing">]>>;
+        absoluteHumidity: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        relativeHumidity: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        precipitationType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"rain">, import("@sinclair/typebox").TLiteral<"thunderstorm">, import("@sinclair/typebox").TLiteral<"snow">, import("@sinclair/typebox").TLiteral<"freezing rain">, import("@sinclair/typebox").TLiteral<"mixed/ice">]>>;
+        precipitationVolume: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    wind: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        averageSpeed: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        speedTrue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        directionTrue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        gust: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        gustDirectionTrue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    water: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        temperature: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        level: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        levelTendency: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"steady">, import("@sinclair/typebox").TLiteral<"decreasing">, import("@sinclair/typebox").TLiteral<"increasing">]>>;
+        waves: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            significantHeight: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+            directionTrue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+            period: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        }>>;
+        swell: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            height: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+            directionTrue: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+            period: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        }>>;
+        seaState: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        salinity: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        ice: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    }>>;
+    current: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        drift: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        set: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+}>;
+export type WeatherDataModel = Static<typeof WeatherDataModelSchema>;
+/**
+ * Weather warning — time-bound severe weather advisory.
+ */
+export declare const WeatherWarningModelSchema: import("@sinclair/typebox").TObject<{
+    startTime: import("@sinclair/typebox").TString;
+    endTime: import("@sinclair/typebox").TString;
+    source: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export type WeatherWarningModel = Static<typeof WeatherWarningModelSchema>;
+//# sourceMappingURL=weather-schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"weather-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/weather-schemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAGrD,wBAAwB;AACxB,eAAO,MAAM,qBAAqB,yLAGjC,CAAA;AAED,wBAAwB;AACxB,eAAO,MAAM,sBAAsB,8LAOlC,CAAA;AAED,yBAAyB;AACzB,eAAO,MAAM,uBAAuB,kSASnC,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmPlC,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAEpE;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;EAwBrC,CAAA;AACD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,yBAAyB,CAAC,CAAA"}