npm - @myrobotaxi/contracts - Versions diffs - 0.1.0 - Mend

@myrobotaxi/contracts 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/CONTRIBUTING.md +67 -0
package/LICENSE +21 -0
package/README.md +94 -0
package/dist/index.cjs +721 -0
package/dist/index.cjs.map +1 -0
package/dist/index.d.cts +615 -0
package/dist/index.d.ts +615 -0
package/dist/index.js +719 -0
package/dist/index.js.map +1 -0
package/dist/types.cjs +4 -0
package/dist/types.cjs.map +1 -0
package/dist/types.d.cts +590 -0
package/dist/types.d.ts +590 -0
package/dist/types.js +3 -0
package/dist/types.js.map +1 -0
package/package.json +77 -0
package/schemas/vehicle-state.schema.json +343 -0
package/schemas/ws-envelope.schema.json +65 -0
package/schemas/ws-messages.schema.json +295 -0

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,615 @@
+export { AuthOkPayload, AuthPayload, ConnectivityPayload, DriveEndedPayload, DriveStartedPayload, ErrorPayload, HeartbeatPayload, MessageType, PingPayload, PongPayload, SubscribePayload, UnsubscribePayload, VehicleState, VehicleUpdatePayload, WebSocketEnvelope, WebSocketMessages } from './types.cjs';
+declare const schemas: {
+    readonly vehicleState: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        properties: {
+            vehicleId: {
+                type: string;
+                description: string;
+                "x-classification": string;
+                examples: string[];
+            };
+            name: {
+                type: string;
+                description: string;
+                "x-classification": string;
+                examples: string[];
+            };
+            model: {
+                type: string;
+                description: string;
+                "x-classification": string;
+                examples: string[];
+            };
+            year: {
+                type: string;
+                description: string;
+                "x-classification": string;
+                examples: number[];
+            };
+            color: {
+                type: string;
+                description: string;
+                "x-classification": string;
+                examples: string[];
+            };
+            status: {
+                type: string;
+                enum: string[];
+                description: string;
+                "x-classification": string;
+                "x-atomic-group": string;
+            };
+            speed: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+            };
+            heading: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            latitude: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            longitude: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            locationName: {
+                type: string;
+                description: string;
+                "x-classification": string;
+            };
+            locationAddress: {
+                type: string;
+                description: string;
+                "x-classification": string;
+            };
+            gearPosition: {
+                type: string[];
+                enum: (string | null)[];
+                description: string;
+                "x-classification": string;
+                "x-atomic-group": string;
+            };
+            chargeLevel: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            chargeState: {
+                type: string[];
+                description: string;
+                enum: (string | null)[];
+                "x-classification": string;
+                "x-atomic-group": string;
+                "x-tesla-proto-field": number;
+            };
+            estimatedRange: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                "x-atomic-group": string;
+            };
+            timeToFull: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                "x-atomic-group": string;
+                "x-tesla-proto-field": number;
+            };
+            interiorTemp: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+            };
+            exteriorTemp: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+            };
+            odometerMiles: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+            };
+            fsdMilesSinceReset: {
+                type: string;
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+            };
+            destinationName: {
+                type: string[];
+                description: string;
+                "x-classification": string;
+                "x-atomic-group": string;
+                examples: string[];
+            };
+            destinationAddress: {
+                type: string[];
+                description: string;
+                "x-classification": string;
+                "x-atomic-group": string;
+            };
+            destinationLatitude: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            destinationLongitude: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            originLatitude: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            originLongitude: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                minimum: number;
+                maximum: number;
+                "x-atomic-group": string;
+            };
+            etaMinutes: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                "x-atomic-group": string;
+            };
+            tripDistanceRemaining: {
+                type: string[];
+                description: string;
+                "x-unit": string;
+                "x-classification": string;
+                minimum: number;
+                "x-atomic-group": string;
+            };
+            navRouteCoordinates: {
+                type: string[];
+                description: string;
+                "x-classification": string;
+                "x-encrypted": boolean;
+                "x-atomic-group": string;
+                items: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    minItems: number;
+                    maxItems: number;
+                    description: string;
+                };
+            };
+            lastUpdated: {
+                type: string;
+                format: string;
+                description: string;
+                "x-classification": string;
+            };
+        };
+        "x-atomic-groups": {
+            navigation: {
+                description: string;
+                fields: string[];
+                "consistency-predicates": string[];
+                nullability: string;
+            };
+            charge: {
+                description: string;
+                fields: string[];
+                "consistency-predicates": string[];
+                nullability: string;
+            };
+            gps: {
+                description: string;
+                fields: string[];
+                "consistency-predicates": string[];
+                nullability: string;
+            };
+            gear: {
+                description: string;
+                fields: string[];
+                "consistency-predicates": string[];
+                nullability: string;
+            };
+        };
+        dependentRequired: {
+            destinationLatitude: string[];
+            destinationLongitude: string[];
+            originLatitude: string[];
+            originLongitude: string[];
+        };
+    };
+    readonly wsMessages: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        $defs: {
+            AuthPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    token: {
+                        type: string;
+                        minLength: number;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            AuthOkPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    userId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    vehicleCount: {
+                        type: string;
+                        minimum: number;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    issuedAt: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            VehicleUpdatePayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    fields: {
+                        type: string;
+                        description: string;
+                        additionalProperties: boolean;
+                        "x-classification": string;
+                    };
+                    timestamp: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            DriveStartedPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    driveId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    startLocation: {
+                        type: string;
+                        description: string;
+                        required: string[];
+                        additionalProperties: boolean;
+                        properties: {
+                            latitude: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                "x-classification": string;
+                                "x-encrypted-at-rest": boolean;
+                            };
+                            longitude: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                                "x-classification": string;
+                                "x-encrypted-at-rest": boolean;
+                            };
+                        };
+                    };
+                    startedAt: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    timestamp: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            DriveEndedPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    driveId: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    distance: {
+                        type: string;
+                        minimum: number;
+                        description: string;
+                        "x-unit": string;
+                        "x-classification": string;
+                    };
+                    durationSeconds: {
+                        type: string;
+                        minimum: number;
+                        description: string;
+                        "x-unit": string;
+                        "x-classification": string;
+                    };
+                    avgSpeed: {
+                        type: string;
+                        minimum: number;
+                        "x-unit": string;
+                        "x-classification": string;
+                    };
+                    maxSpeed: {
+                        type: string;
+                        minimum: number;
+                        "x-unit": string;
+                        "x-classification": string;
+                    };
+                    timestamp: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            ConnectivityPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        "x-classification": string;
+                    };
+                    online: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    timestamp: {
+                        type: string;
+                        format: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            HeartbeatPayload: {
+                type: string;
+                description: string;
+                additionalProperties: boolean;
+                properties: {
+                    timestamp: {
+                        type: string;
+                        format: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            ErrorPayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    code: {
+                        type: string;
+                        description: string;
+                        enum: string[];
+                        "x-classification": string;
+                    };
+                    message: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                    subCode: {
+                        type: string;
+                        description: string;
+                        enum: string[];
+                        "x-classification": string;
+                    };
+                };
+            };
+            SubscribePayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        "x-classification": string;
+                    };
+                    sinceSeq: {
+                        type: string;
+                        minimum: number;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            UnsubscribePayload: {
+                type: string;
+                description: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    vehicleId: {
+                        type: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            PingPayload: {
+                type: string;
+                description: string;
+                additionalProperties: boolean;
+                properties: {
+                    nonce: {
+                        type: string;
+                        description: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+            PongPayload: {
+                type: string;
+                description: string;
+                additionalProperties: boolean;
+                properties: {
+                    nonce: {
+                        type: string;
+                        "x-classification": string;
+                    };
+                };
+            };
+        };
+    };
+    readonly wsEnvelope: {
+        $schema: string;
+        $id: string;
+        title: string;
+        description: string;
+        type: string;
+        required: string[];
+        additionalProperties: boolean;
+        properties: {
+            type: {
+                type: string;
+                description: string;
+                enum: string[];
+                "x-classification": string;
+            };
+            payload: {
+                description: string;
+                "x-classification": string;
+            };
+            seq: {
+                type: string;
+                minimum: number;
+                description: string;
+                "x-classification": string;
+            };
+            ts: {
+                type: string;
+                format: string;
+                description: string;
+                "x-classification": string;
+            };
+        };
+        $defs: {
+            MessageType: {
+                type: string;
+                enum: string[];
+            };
+        };
+    };
+};
+export { schemas };