@signalk/server-api 2.22.0 → 2.24.0

package/dist/typebox/protocol-schemas.js

@@ -0,0 +1,352 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for Signal K Protocol Types
+ *
+ * Core protocol schemas: Delta, Update, Source, Notification, Meta, Zone.
+ *
+ * Metadata sourced from:
+ *   specification/schemas/definitions.json
+ *   specification/schemas/groups/notifications.json
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeltaSchema = exports.UpdateSchema = exports.PathValueSchema = exports.NotificationSchema = exports.SourceSchema = exports.MetaSchema = exports.MetaValueSchema = exports.EnhancedDisplayUnitsSchema = exports.DisplayUnitsMetadataSchema = exports.AlarmStatusSchema = exports.ZoneSchema = exports.AlarmMethodSchema = exports.AlarmStateSchema = exports.ALARM_METHOD = exports.ALARM_STATE = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const shared_schemas_1 = require("./shared-schemas");
+// Keep as TypeScript enums alongside TypeBox enum schemas — enums are values
+// used at runtime (switch statements, comparisons), not just types.
+/**
+ * Alarm state enum.
+ * @see specification/schemas/definitions.json#/definitions/alarmState
+ * @category Server API
+ */
+var ALARM_STATE;
+(function (ALARM_STATE) {
+    ALARM_STATE["nominal"] = "nominal";
+    ALARM_STATE["normal"] = "normal";
+    ALARM_STATE["alert"] = "alert";
+    ALARM_STATE["warn"] = "warn";
+    ALARM_STATE["alarm"] = "alarm";
+    ALARM_STATE["emergency"] = "emergency";
+})(ALARM_STATE || (exports.ALARM_STATE = ALARM_STATE = {}));
+/**
+ * Alarm method enum.
+ * @see specification/schemas/definitions.json#/definitions/alarmMethodEnum
+ * @category Server API
+ */
+var ALARM_METHOD;
+(function (ALARM_METHOD) {
+    ALARM_METHOD["visual"] = "visual";
+    ALARM_METHOD["sound"] = "sound";
+})(ALARM_METHOD || (exports.ALARM_METHOD = ALARM_METHOD = {}));
+/**
+ * TypeBox schema for alarm state values.
+ * Mirrors the ALARM_STATE enum for runtime validation and documentation.
+ */
+exports.AlarmStateSchema = typebox_1.Type.Union([
+    typebox_1.Type.Literal('nominal'),
+    typebox_1.Type.Literal('normal'),
+    typebox_1.Type.Literal('alert'),
+    typebox_1.Type.Literal('warn'),
+    typebox_1.Type.Literal('alarm'),
+    typebox_1.Type.Literal('emergency')
+], {
+    $id: 'AlarmState',
+    description: 'The alarm state when the value is in this zone.',
+    default: 'normal'
+});
+/**
+ * TypeBox schema for alarm method values.
+ * Mirrors the ALARM_METHOD enum for runtime validation and documentation.
+ */
+exports.AlarmMethodSchema = typebox_1.Type.Union([typebox_1.Type.Literal('visual'), typebox_1.Type.Literal('sound')], {
+    $id: 'AlarmMethod',
+    description: 'Method to use to raise notifications.'
+});
+/**
+ * A zone defining display and alarm state for a value range.
+ * @see specification/schemas/definitions.json zones definition
+ */
+exports.ZoneSchema = typebox_1.Type.Object({
+    lower: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'The lowest number in this zone',
+        examples: [3500]
+    })),
+    upper: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'The highest value in this zone',
+        examples: [4000]
+    })),
+    state: exports.AlarmStateSchema,
+    message: typebox_1.Type.String({
+        description: 'The message to display for the alarm.',
+        default: 'Warning'
+    })
+}, {
+    $id: 'Zone',
+    description: 'A zone used to define the display and alarm state when the value is in between lower and upper.'
+});
+/**
+ * Alarm status flags (silenced, acknowledged, etc.).
+ */
+exports.AlarmStatusSchema = typebox_1.Type.Object({
+    silenced: typebox_1.Type.Boolean({
+        description: 'Whether the alarm has been silenced'
+    }),
+    acknowledged: typebox_1.Type.Boolean({
+        description: 'Whether the alarm has been acknowledged'
+    }),
+    canSilence: typebox_1.Type.Boolean({
+        description: 'Whether the alarm can be silenced'
+    }),
+    canAcknowledge: typebox_1.Type.Boolean({
+        description: 'Whether the alarm can be acknowledged'
+    }),
+    canClear: typebox_1.Type.Boolean({
+        description: 'Whether the alarm can be cleared'
+    })
+}, {
+    $id: 'AlarmStatus',
+    description: 'Status flags for an active alarm/notification'
+});
+/**
+ * Stored display-units metadata — the minimal form persisted in path metadata.
+ * The server resolves this into EnhancedDisplayUnits before sending to clients.
+ */
+exports.DisplayUnitsMetadataSchema = typebox_1.Type.Object({
+    category: typebox_1.Type.String({
+        description: 'Unit category (e.g. "speed", "temperature", "distance")'
+    }),
+    targetUnit: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Per-path target unit override (e.g. "kn", "°C")'
+    })),
+    displayFormat: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Display format string (e.g. "0.0", "0.00")'
+    }))
+}, {
+    $id: 'DisplayUnitsMetadata',
+    description: 'Stored display-units metadata for a Signal K path'
+});
+/**
+ * Enhanced display-units metadata — the resolved form returned to clients,
+ * containing the Math.js conversion formulas needed to convert from SI.
+ */
+exports.EnhancedDisplayUnitsSchema = typebox_1.Type.Object({
+    category: typebox_1.Type.String({
+        description: 'Unit category (e.g. "speed", "temperature")'
+    }),
+    targetUnit: typebox_1.Type.String({
+        description: 'Target display unit (e.g. "kn", "°C")'
+    }),
+    formula: typebox_1.Type.String({
+        description: 'Math.js formula to convert from SI to target unit (e.g. "value * 1.94384")'
+    }),
+    inverseFormula: typebox_1.Type.String({
+        description: 'Math.js formula to convert from target unit back to SI (e.g. "value * 0.514444")'
+    }),
+    symbol: typebox_1.Type.String({
+        description: 'Unit symbol for display (e.g. "kn", "°C")'
+    }),
+    displayFormat: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Display format string (e.g. "0.0")'
+    }))
+}, {
+    $id: 'EnhancedDisplayUnits',
+    description: 'Resolved display-units metadata with conversion formulas, as returned to clients'
+});
+/**
+ * Metadata payload for a Signal K path.
+ * Contains display hints, units, timeout, and alarm zones.
+ */
+exports.MetaValueSchema = typebox_1.Type.Object({
+    description: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Description of the Signal K path' })),
+    units: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Allowed units of physical quantities. Units should be (derived) SI units where possible.'
+    })),
+    example: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'An example value for this path' })),
+    timeout: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'The timeout in seconds after which the value should be considered stale',
+        minimum: 0
+    })),
+    displayName: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'A human-readable display name for this path'
+    })),
+    displayScale: typebox_1.Type.Optional(typebox_1.Type.Object({
+        lower: typebox_1.Type.Number({ description: 'Lower bound of display scale' }),
+        upper: typebox_1.Type.Number({ description: 'Upper bound of display scale' })
+    })),
+    zones: typebox_1.Type.Optional(typebox_1.Type.Array(exports.ZoneSchema, {
+        description: 'The zones defining the range of values for this Signal K value.'
+    })),
+    supportsPut: typebox_1.Type.Optional(typebox_1.Type.Boolean({
+        description: 'Whether this path supports PUT operations'
+    })),
+    displayUnits: typebox_1.Type.Optional(typebox_1.Type.Union([exports.DisplayUnitsMetadataSchema, exports.EnhancedDisplayUnitsSchema], {
+        description: 'Display unit preferences — either stored metadata or resolved with conversion formulas'
+    }))
+}, {
+    $id: 'MetaValue',
+    description: 'Metadata about a Signal K path'
+});
+/**
+ * Meta message — a path paired with its metadata.
+ */
+exports.MetaSchema = typebox_1.Type.Object({
+    path: typebox_1.Type.String({ description: 'Signal K path' }),
+    value: exports.MetaValueSchema
+}, {
+    $id: 'Meta',
+    description: 'A path with its metadata value'
+});
+/**
+ * Source of data in delta format — a record of where the data was received from.
+ *
+ * Properties cover NMEA 0183 (talker, sentence), NMEA 2000 (src, pgn, canName,
+ * instance), and AIS (aisType 1-27) sources.
+ *
+ * @see specification/schemas/definitions.json#/definitions/source
+ */
+exports.SourceSchema = typebox_1.Type.Object({
+    label: typebox_1.Type.String({
+        description: 'A label to identify the source bus, e.g. serial-COM1, eth-local, etc.',
+        examples: ['N2K-1']
+    }),
+    type: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'A human name to identify the type. NMEA0183, NMEA2000, signalk',
+        default: 'NMEA2000',
+        examples: ['NMEA2000']
+    })),
+    // NMEA 2000 fields
+    src: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'NMEA2000 src value or any similar value for encapsulating the original source of the data',
+        examples: ['36']
+    })),
+    canName: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'NMEA2000 CAN name of the source device',
+        examples: ['13877444229283709432']
+    })),
+    pgn: typebox_1.Type.Optional(typebox_1.Type.Number({
+        description: 'NMEA2000 PGN of the source message',
+        examples: [130312]
+    })),
+    instance: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'NMEA2000 instance value of the source message'
+    })),
+    // NMEA 0183 fields
+    sentence: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Sentence type of the source NMEA0183 sentence, e.g. RMC from $GPRMC,...',
+        examples: ['RMC']
+    })),
+    talker: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'Talker id of the source NMEA0183 sentence, e.g. GP from $GPRMC,...',
+        examples: ['GP']
+    })),
+    // AIS fields
+    aisType: typebox_1.Type.Optional(typebox_1.Type.Integer({
+        minimum: 1,
+        maximum: 27,
+        description: 'AIS Message Type',
+        examples: [15]
+    }))
+}, {
+    $id: 'Source',
+    description: 'Source of data in delta format, a record of where the data was received from.'
+});
+/**
+ * Notification payload — state, method, message, and optional position/status.
+ */
+exports.NotificationSchema = typebox_1.Type.Object({
+    state: exports.AlarmStateSchema,
+    method: typebox_1.Type.Array(exports.AlarmMethodSchema, {
+        description: 'Methods to use to raise this notification'
+    }),
+    message: typebox_1.Type.String({
+        description: 'Message to display or speak'
+    }),
+    status: typebox_1.Type.Optional(exports.AlarmStatusSchema),
+    position: typebox_1.Type.Optional(typebox_1.Type.Ref(shared_schemas_1.PositionSchema, {
+        description: 'Geographic position associated with the notification, when relevant (e.g. MOB, anchor alarm, waypoint arrival)'
+    })),
+    createdAt: typebox_1.Type.Optional(typebox_1.Type.String({
+        pattern: shared_schemas_1.IsoTimePattern,
+        description: 'ISO 8601 timestamp when the notification was created'
+    })),
+    id: typebox_1.Type.Optional(typebox_1.Type.String({
+        pattern: shared_schemas_1.SignalKUuidPattern,
+        description: 'Unique notification identifier (UUID)',
+        examples: ['ac3a3b2d-07e8-4f25-92bc-98e7c92f7f1a']
+    }))
+}, {
+    $id: 'Notification',
+    description: 'A Signal K notification with alarm state and message'
+});
+/**
+ * A path-value pair in an update delta.
+ */
+exports.PathValueSchema = typebox_1.Type.Object({
+    path: typebox_1.Type.String({ description: 'Signal K path' }),
+    value: typebox_1.Type.Unknown({ description: 'The value for this path' })
+}, {
+    $id: 'PathValue',
+    description: 'A Signal K path and its value'
+});
+/**
+ * An update within a delta message.
+ * Must contain values[] or meta[] (or both), plus optional timestamp and source.
+ *
+ * Uses a Union to match the Signal K specification's oneOf constraint:
+ * an update with neither values nor meta is invalid.
+ * @see specification delta.json oneOf constraint
+ */
+const UpdateBase = typebox_1.Type.Object({
+    timestamp: typebox_1.Type.Optional(typebox_1.Type.String({
+        pattern: shared_schemas_1.IsoTimePattern,
+        description: 'RFC 3339 (UTC only without local offset) string representing date and time.'
+    })),
+    source: typebox_1.Type.Optional(exports.SourceSchema),
+    $source: typebox_1.Type.Optional(typebox_1.Type.String({
+        pattern: '^[A-Za-z0-9-_.]*$',
+        description: 'Reference to the source under /sources. A dot separated path to the data, e.g. [type].[bus].[device]',
+        examples: ['NMEA0183.COM1.GP']
+    })),
+    notificationId: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Notification identifier' }))
+});
+const ValuesFields = typebox_1.Type.Object({
+    values: typebox_1.Type.Array(exports.PathValueSchema, {
+        description: 'Array of path-value pairs'
+    }),
+    meta: typebox_1.Type.Optional(typebox_1.Type.Array(exports.MetaSchema, {
+        description: 'Array of path-metadata pairs'
+    }))
+});
+const MetaFields = typebox_1.Type.Object({
+    meta: typebox_1.Type.Array(exports.MetaSchema, {
+        description: 'Array of path-metadata pairs'
+    }),
+    values: typebox_1.Type.Optional(typebox_1.Type.Array(exports.PathValueSchema, {
+        description: 'Array of path-value pairs'
+    }))
+});
+exports.UpdateSchema = typebox_1.Type.Union([
+    typebox_1.Type.Intersect([UpdateBase, ValuesFields]),
+    typebox_1.Type.Intersect([UpdateBase, MetaFields])
+], {
+    $id: 'Update',
+    description: 'A Signal K update containing path-value and/or path-meta pairs with timestamp and source'
+});
+/**
+ * A Signal K delta message — the fundamental unit of data exchange.
+ * Contains a context (vessel/aircraft/etc.) and one or more updates.
+ */
+exports.DeltaSchema = typebox_1.Type.Object({
+    context: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'The context path, usually a vessel URN (e.g. vessels.urn:mrn:signalk:uuid:...)',
+        examples: [
+            'vessels.urn:mrn:signalk:uuid:b7590868-1d62-47d9-989c-32321b349fb9'
+        ]
+    })),
+    updates: typebox_1.Type.Array(exports.UpdateSchema, {
+        description: 'One or more updates in this delta'
+    })
+}, {
+    $id: 'Delta',
+    description: 'A Signal K delta message — the fundamental unit of data exchange'
+});

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

@@ -0,0 +1,50 @@
+/**
+ * TypeBox Schema Definitions for the Signal K Radar API
+ */
+import { type Static } from '@sinclair/typebox';
+export declare const RadarStatusSchema: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"off">, import("@sinclair/typebox").TLiteral<"standby">, import("@sinclair/typebox").TLiteral<"transmit">, import("@sinclair/typebox").TLiteral<"warming">]>;
+export type RadarStatusSchemaType = Static<typeof RadarStatusSchema>;
+export declare const RadarControlValueSchema: import("@sinclair/typebox").TObject<{
+    auto: import("@sinclair/typebox").TBoolean;
+    value: import("@sinclair/typebox").TNumber;
+}>;
+export type RadarControlValueSchemaType = Static<typeof RadarControlValueSchema>;
+export declare const RadarControlsSchema: import("@sinclair/typebox").TObject<{
+    gain: import("@sinclair/typebox").TRefUnsafe<import("@sinclair/typebox").TObject<{
+        auto: import("@sinclair/typebox").TBoolean;
+        value: import("@sinclair/typebox").TNumber;
+    }>>;
+    sea: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRefUnsafe<import("@sinclair/typebox").TObject<{
+        auto: import("@sinclair/typebox").TBoolean;
+        value: import("@sinclair/typebox").TNumber;
+    }>>>;
+    rain: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        value: import("@sinclair/typebox").TNumber;
+    }>>;
+}>;
+export type RadarControlsSchemaType = Static<typeof RadarControlsSchema>;
+export declare const RadarInfoSchema: import("@sinclair/typebox").TObject<{
+    id: import("@sinclair/typebox").TString;
+    name: import("@sinclair/typebox").TString;
+    brand: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    status: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"off">, import("@sinclair/typebox").TLiteral<"standby">, import("@sinclair/typebox").TLiteral<"transmit">, import("@sinclair/typebox").TLiteral<"warming">]>;
+    spokesPerRevolution: import("@sinclair/typebox").TInteger;
+    maxSpokeLen: import("@sinclair/typebox").TInteger;
+    range: import("@sinclair/typebox").TNumber;
+    controls: import("@sinclair/typebox").TObject<{
+        gain: import("@sinclair/typebox").TRefUnsafe<import("@sinclair/typebox").TObject<{
+            auto: import("@sinclair/typebox").TBoolean;
+            value: import("@sinclair/typebox").TNumber;
+        }>>;
+        sea: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRefUnsafe<import("@sinclair/typebox").TObject<{
+            auto: import("@sinclair/typebox").TBoolean;
+            value: import("@sinclair/typebox").TNumber;
+        }>>>;
+        rain: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            value: import("@sinclair/typebox").TNumber;
+        }>>;
+    }>;
+    streamUrl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export type RadarInfoSchemaType = Static<typeof RadarInfoSchema>;
+//# sourceMappingURL=radar-schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"radar-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/radar-schemas.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAErD,eAAO,MAAM,iBAAiB,uOAW7B,CAAA;AACD,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEpE,eAAO,MAAM,uBAAuB;;;EAcnC,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAEhF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;EA+B/B,CAAA;AACD,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAExE,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;EA8B3B,CAAA;AACD,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAA"}

package/dist/typebox/radar-schemas.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * TypeBox Schema Definitions for the Signal K Radar API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RadarInfoSchema = exports.RadarControlsSchema = exports.RadarControlValueSchema = exports.RadarStatusSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+exports.RadarStatusSchema = typebox_1.Type.Union([
+    typebox_1.Type.Literal('off'),
+    typebox_1.Type.Literal('standby'),
+    typebox_1.Type.Literal('transmit'),
+    typebox_1.Type.Literal('warming')
+], {
+    $id: 'RadarStatus',
+    description: 'Current operational status of the radar'
+});
+exports.RadarControlValueSchema = typebox_1.Type.Object({
+    auto: typebox_1.Type.Boolean({
+        description: 'Whether automatic adjustment is enabled'
+    }),
+    value: typebox_1.Type.Number({
+        description: 'Current control value. The valid range depends on the radar hardware — see the capability manifest at GET /radars/{id}/capabilities for min/max/step per control.'
+    })
+}, {
+    $id: 'RadarControlValue',
+    description: 'A radar control with auto mode and a numeric value'
+});
+exports.RadarControlsSchema = typebox_1.Type.Object({
+    gain: typebox_1.Type.Ref(exports.RadarControlValueSchema, {
+        description: 'Receiver gain control'
+    }),
+    sea: typebox_1.Type.Optional(typebox_1.Type.Ref(exports.RadarControlValueSchema, {
+        description: 'Sea clutter rejection control. Present when supported by the radar.'
+    })),
+    rain: typebox_1.Type.Optional(typebox_1.Type.Object({
+        value: typebox_1.Type.Number({
+            description: 'Rain clutter rejection level. Valid range is hardware-dependent — see capability manifest.'
+        })
+    }, {
+        description: 'Rain clutter rejection control (no auto mode). Present when supported by the radar.'
+    }))
+}, {
+    $id: 'RadarControlsModel',
+    description: 'Current control settings for a radar. Additional radar-specific controls beyond gain/sea/rain may be present.'
+});
+exports.RadarInfoSchema = typebox_1.Type.Object({
+    id: typebox_1.Type.String({ description: 'Unique radar identifier' }),
+    name: typebox_1.Type.String({ description: 'Display name' }),
+    brand: typebox_1.Type.Optional(typebox_1.Type.String({ description: 'Manufacturer/brand' })),
+    status: exports.RadarStatusSchema,
+    spokesPerRevolution: typebox_1.Type.Integer({
+        description: 'Number of spokes per full rotation (e.g. 512, 1024, 2048)',
+        examples: [2048]
+    }),
+    maxSpokeLen: typebox_1.Type.Integer({
+        description: 'Maximum spoke length in samples (e.g. 512, 1024)',
+        examples: [1024]
+    }),
+    range: typebox_1.Type.Number({
+        description: 'Current range in meters',
+        units: 'm'
+    }),
+    controls: exports.RadarControlsSchema,
+    streamUrl: typebox_1.Type.Optional(typebox_1.Type.String({
+        description: 'WebSocket URL for spoke stream. If absent, use /radars/{id}/stream'
+    }))
+}, {
+    $id: 'RadarInfoModel',
+    description: 'Information about a radar device'
+});

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

@@ -0,0 +1,152 @@
+/**
+ * TypeBox Schema Definitions for the Signal K Resources API
+ *
+ * Covers routes, waypoints, regions, notes, and charts.
+ */
+import { type Static } from '@sinclair/typebox';
+/**
+ * Signal K resource href — generic pointer to any resource type by UUID.
+ */
+export declare const SignalKHrefSchema: import("@sinclair/typebox").TString;
+/** Href attribute — used to link a note to another resource */
+export declare const HrefAttributeSchema: import("@sinclair/typebox").TObject<{
+    href: import("@sinclair/typebox").TString;
+}>;
+/** Position attribute — used to give a note a geographic position */
+export declare const PositionAttributeSchema: import("@sinclair/typebox").TObject<{
+    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 declare const BaseResponseModelSchema: import("@sinclair/typebox").TObject<{
+    timestamp: import("@sinclair/typebox").TString;
+    $source: import("@sinclair/typebox").TString;
+}>;
+/** Route point metadata */
+export declare const RoutePointMetaSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+}>;
+/** Route resource */
+export declare const RouteSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    distance: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    feature: import("@sinclair/typebox").TObject<{
+        geometry: 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]>>;
+        }>;
+        properties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            coordinatesMeta: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+                name: import("@sinclair/typebox").TString;
+            }>, import("@sinclair/typebox").TObject<{
+                href: import("@sinclair/typebox").TString;
+            }>]>>>;
+        }>>;
+    }>;
+}>;
+export type RouteResource = Static<typeof RouteSchema>;
+/** Waypoint resource */
+export declare const WaypointSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    feature: import("@sinclair/typebox").TObject<{
+        geometry: import("@sinclair/typebox").TObject<{
+            type: import("@sinclair/typebox").TLiteral<"Point">;
+            coordinates: import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNumber]>;
+        }>;
+        properties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+    }>;
+}>;
+export type WaypointResource = Static<typeof WaypointSchema>;
+/** Region resource */
+export declare const RegionSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    feature: import("@sinclair/typebox").TObject<{
+        geometry: import("@sinclair/typebox").TUnion<[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]>>>;
+        }>, 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]>>>>;
+        }>]>;
+        properties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+    }>;
+}>;
+export type RegionResource = Static<typeof RegionSchema>;
+/** Note base model */
+export declare const NoteBaseModelSchema: import("@sinclair/typebox").TObject<{
+    title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    mimeType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    url: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    properties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+}>;
+/** Note resource — a note linked to either an href or a position */
+export declare const NoteSchema: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TObject<{
+    title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    mimeType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    url: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    properties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{}>>;
+}>, import("@sinclair/typebox").TObject<{
+    href: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    position: import("@sinclair/typebox").TOptional<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 NoteResource = Static<typeof NoteSchema>;
+/** Tile layer source */
+export declare const TileLayerSourceSchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"tilelayer">;
+    bounds: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>>;
+    format: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"jpg">, import("@sinclair/typebox").TLiteral<"pbf">, import("@sinclair/typebox").TLiteral<"png">, import("@sinclair/typebox").TLiteral<"webp">]>>;
+    maxzoom: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    minzoom: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    scale: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+/** Map server source */
+export declare const MapServerSourceSchema: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"tileJSON">, import("@sinclair/typebox").TLiteral<"WMS">, import("@sinclair/typebox").TLiteral<"WMTS">, import("@sinclair/typebox").TLiteral<"mapstyleJSON">, import("@sinclair/typebox").TLiteral<"S-57">]>;
+}>;
+/** Chart resource */
+export declare const ChartSchema: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TObject<{
+    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    url: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    layers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>, import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TLiteral<"tilelayer">;
+    bounds: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>>;
+    format: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"jpg">, import("@sinclair/typebox").TLiteral<"pbf">, import("@sinclair/typebox").TLiteral<"png">, import("@sinclair/typebox").TLiteral<"webp">]>>;
+    maxzoom: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    minzoom: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    scale: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>, import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"tileJSON">, import("@sinclair/typebox").TLiteral<"WMS">, import("@sinclair/typebox").TLiteral<"WMTS">, import("@sinclair/typebox").TLiteral<"mapstyleJSON">, import("@sinclair/typebox").TLiteral<"S-57">]>;
+}>]>]>;
+export type ChartResource = Static<typeof ChartSchema>;
+/**
+ * 200 success response with resource ID.
+ */
+export declare const ResourceActionOkResponseSchema: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TLiteral<"COMPLETED">;
+    statusCode: import("@sinclair/typebox").TLiteral<200>;
+    id: import("@sinclair/typebox").TString;
+}>;
+/**
+ * 201 created response with resource ID.
+ */
+export declare const ResourceActionCreatedResponseSchema: import("@sinclair/typebox").TObject<{
+    state: import("@sinclair/typebox").TLiteral<"COMPLETED">;
+    statusCode: import("@sinclair/typebox").TLiteral<201>;
+    id: import("@sinclair/typebox").TString;
+}>;
+//# sourceMappingURL=resources-schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resources-schemas.d.ts","sourceRoot":"","sources":["../../src/typebox/resources-schemas.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAQ,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAUrD;;GAEG;AACH,eAAO,MAAM,iBAAiB,qCAK5B,CAAA;AAEF,+DAA+D;AAC/D,eAAO,MAAM,mBAAmB;;EAK/B,CAAA;AAED,qEAAqE;AACrE,eAAO,MAAM,uBAAuB;;;;;;EAKnC,CAAA;AAED,eAAO,MAAM,uBAAuB;;;EAgBnC,CAAA;AAED,2BAA2B;AAC3B,eAAO,MAAM,oBAAoB;;EAQhC,CAAA;AAED,qBAAqB;AACrB,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;EAoCvB,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,WAAW,CAAC,CAAA;AAEtD,wBAAwB;AACxB,eAAO,MAAM,cAAc;;;;;;;;;;;EA4B1B,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAA;AAE5D,sBAAsB;AACtB,eAAO,MAAM,YAAY;;;;;;;;;;;;;EA0BxB,CAAA;AACD,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,YAAY,CAAC,CAAA;AAExD,sBAAsB;AACtB,eAAO,MAAM,mBAAmB;;;;;;EAwB/B,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,UAAU;;;;;;;;;;;;;IActB,CAAA;AACD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAA;AAEpD,wBAAwB;AACxB,eAAO,MAAM,qBAAqB;;;;;;;EAkDjC,CAAA;AAED,wBAAwB;AACxB,eAAO,MAAM,qBAAqB;;EAejC,CAAA;AAED,qBAAqB;AACrB,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;MAyBvB,CAAA;AACD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,WAAW,CAAC,CAAA;AAEtD;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;EAU1C,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mCAAmC;;;;EAU/C,CAAA"}