@alteriom/mqtt-schema 0.2.0

package/dist/cjs/schema_data.d.ts

@@ -0,0 +1,319 @@
+export declare const envelope_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/envelope.schema.json";
+    readonly title: "Alteriom MQTT Base Envelope v1";
+    readonly type: "object";
+    readonly required: readonly ["schema_version", "device_id", "device_type", "timestamp", "firmware_version"];
+    readonly properties: {
+        readonly schema_version: {
+            readonly type: "integer";
+            readonly const: 1;
+        };
+        readonly device_id: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[A-Za-z0-9_-]+$";
+        };
+        readonly device_type: {
+            readonly type: "string";
+            readonly enum: readonly ["sensor", "gateway"];
+        };
+        readonly timestamp: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+        readonly firmware_version: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 40;
+        };
+        readonly hardware_version: {
+            readonly type: "string";
+            readonly maxLength: 80;
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const sensor_data_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/sensor_data.schema.json";
+    readonly title: "Sensor Data Message v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly required: readonly ["sensors"];
+    readonly properties: {
+        readonly sensors: {
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: {
+                readonly type: "object";
+                readonly required: readonly ["value"];
+                readonly properties: {
+                    readonly value: {
+                        readonly type: readonly ["number", "integer"];
+                    };
+                    readonly unit: {
+                        readonly type: "string";
+                    };
+                    readonly raw_value: {
+                        readonly type: readonly ["number", "integer"];
+                    };
+                    readonly calibrated_value: {
+                        readonly type: readonly ["number", "integer"];
+                    };
+                    readonly quality_score: {
+                        readonly type: "number";
+                        readonly minimum: 0;
+                        readonly maximum: 1;
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                    };
+                    readonly location: {
+                        readonly type: "string";
+                    };
+                    readonly additional_data: {
+                        readonly type: "object";
+                    };
+                };
+                readonly additionalProperties: false;
+            };
+        };
+        readonly battery_level: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly maximum: 100;
+        };
+        readonly signal_strength: {
+            readonly type: "integer";
+            readonly minimum: -200;
+            readonly maximum: 0;
+        };
+        readonly additional: {
+            readonly type: "object";
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const sensor_heartbeat_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/sensor_heartbeat.schema.json";
+    readonly title: "Sensor Heartbeat v1";
+    readonly type: "object";
+    readonly required: readonly ["schema_version", "device_id", "device_type", "timestamp"];
+    readonly properties: {
+        readonly schema_version: {
+            readonly type: "integer";
+            readonly const: 1;
+        };
+        readonly device_id: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+            readonly pattern: "^[A-Za-z0-9_-]+$";
+        };
+        readonly device_type: {
+            readonly type: "string";
+            readonly enum: readonly ["sensor", "gateway"];
+        };
+        readonly timestamp: {
+            readonly type: "string";
+            readonly format: "date-time";
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const sensor_status_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/sensor_status.schema.json";
+    readonly title: "Sensor Status v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly required: readonly ["status"];
+    readonly properties: {
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["online", "offline", "updating", "error"];
+        };
+        readonly battery_level: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly maximum: 100;
+        };
+        readonly signal_strength: {
+            readonly type: "integer";
+            readonly minimum: -200;
+            readonly maximum: 0;
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const gateway_info_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/gateway_info.schema.json";
+    readonly title: "Gateway Info v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly properties: {
+        readonly mac_address: {
+            readonly type: "string";
+            readonly pattern: "^[0-9A-Fa-f:]{17}$";
+        };
+        readonly ip_address: {
+            readonly type: "string";
+            readonly format: "ipv4";
+        };
+        readonly capabilities: {
+            readonly type: "object";
+            readonly properties: {
+                readonly max_nodes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly supports_mesh: {
+                    readonly type: "boolean";
+                };
+                readonly firmware_update: {
+                    readonly type: "boolean";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const gateway_metrics_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/gateway_metrics.schema.json";
+    readonly title: "Gateway Metrics v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly required: readonly ["metrics"];
+    readonly properties: {
+        readonly metrics: {
+            readonly type: "object";
+            readonly required: readonly ["uptime_s"];
+            readonly properties: {
+                readonly uptime_s: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly cpu_usage_pct: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 100;
+                };
+                readonly memory_usage_pct: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 100;
+                };
+                readonly temperature_c: {
+                    readonly type: "number";
+                };
+                readonly connected_devices: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly mesh_nodes: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly packet_loss_pct: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                    readonly maximum: 100;
+                };
+                readonly data_throughput_kbps: {
+                    readonly type: "number";
+                    readonly minimum: 0;
+                };
+            };
+            readonly additionalProperties: true;
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const firmware_status_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/firmware_status.schema.json";
+    readonly title: "Firmware Update Status v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly required: readonly ["status"];
+    readonly properties: {
+        readonly event: {
+            readonly type: "string";
+        };
+        readonly from_version: {
+            readonly type: "string";
+        };
+        readonly to_version: {
+            readonly type: "string";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["pending", "downloading", "flashing", "verifying", "rebooting", "completed", "failed"];
+        };
+        readonly progress_pct: {
+            readonly type: "number";
+            readonly minimum: 0;
+            readonly maximum: 100;
+        };
+        readonly error: {
+            readonly type: readonly ["string", "null"];
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const control_response_schema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://schemas.alteriom.io/mqtt/v1/control_response.schema.json";
+    readonly title: "Control / Command Response v1";
+    readonly allOf: readonly [{
+        readonly $ref: "envelope.schema.json";
+    }];
+    readonly type: "object";
+    readonly required: readonly ["status"];
+    readonly properties: {
+        readonly command: {
+            readonly type: "string";
+        };
+        readonly status: {
+            readonly type: "string";
+            readonly enum: readonly ["ok", "error"];
+        };
+        readonly message: {
+            readonly type: "string";
+        };
+        readonly result: {
+            readonly type: readonly ["object", "array", "string", "number", "boolean", "null"];
+        };
+    };
+    readonly additionalProperties: true;
+};
+export declare const mqtt_v1_bundle_json: {
+    readonly $comment: "Convenience bundle referencing all v1 schema artifact filenames for tooling discovery.";
+    readonly version: 1;
+    readonly schemas: {
+        readonly envelope: "envelope.schema.json";
+        readonly sensor_data: "sensor_data.schema.json";
+        readonly sensor_heartbeat: "sensor_heartbeat.schema.json";
+        readonly sensor_status: "sensor_status.schema.json";
+        readonly gateway_info: "gateway_info.schema.json";
+        readonly gateway_metrics: "gateway_metrics.schema.json";
+        readonly firmware_status: "firmware_status.schema.json";
+        readonly control_response: "control_response.schema.json";
+    };
+};