@fleetless/contracts 5.3.0-next.1 → 6.0.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fleetless/contracts",
-  "version": "5.3.0-next.1",
+  "version": "6.0.0-next.1",
   "description": "Fleetless wire contracts: the bridge-cloud protocol, the REST API schemas and the error codes, as zod schemas with generated JSON Schema and OpenAPI artifacts.",
   "license": "Apache-2.0",
   "author": "Dehne Robotik GmbH",

package/artifacts/schema/developer-login-request.schema.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "email": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
-    },
-    "password": {
-      "type": "string",
-      "minLength": 1
-    }
-  },
-  "required": [
-    "email",
-    "password"
-  ]
-}

package/artifacts/schema/feedback-request.schema.json

@@ -1,34 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "kind": {
-      "type": "string",
-      "enum": [
-        "idea",
-        "problem",
-        "question",
-        "other"
-      ],
-      "description": "What the message is: an `idea`, a `problem`, a `question` or `other`. It only sorts the inbox; it changes nothing about how the message is handled."
-    },
-    "message": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 5000,
-      "description": "What the developer wrote, trimmed. At most 5000 characters; a message that is only whitespace is refused."
-    },
-    "page": {
-      "type": "string",
-      "maxLength": 512,
-      "pattern": "^\\/.*",
-      "description": "The console path the message was sent from, e.g. `/robots/:id/jobs` with its real id. A path, never a full URL, so no host and no query string reach the inbox by accident."
-    }
-  },
-  "required": [
-    "kind",
-    "message",
-    "page"
-  ],
-  "additionalProperties": false
-}

package/artifacts/schema/feedback-response.schema.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "string",
-      "format": "uuid",
-      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
-      "description": "The stored message. It exists whatever `mail` says."
-    },
-    "mail": {
-      "type": "string",
-      "enum": [
-        "sent",
-        "not_requested",
-        "not_configured",
-        "failed"
-      ],
-      "description": "What happened to the notification mail: `sent`, `failed`, or `not_configured` when this cloud has no feedback address. The message is stored in every case, so a client shows success for all three."
-    }
-  },
-  "required": [
-    "id",
-    "mail"
-  ],
-  "additionalProperties": false
-}

package/artifacts/schema/password-reset-confirm.schema.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "token": {
-      "type": "string",
-      "minLength": 1
-    },
-    "new_password": {
-      "type": "string",
-      "minLength": 12,
-      "maxLength": 256
-    }
-  },
-  "required": [
-    "token",
-    "new_password"
-  ]
-}

package/artifacts/schema/password-reset-request.schema.json

@@ -1,14 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "email": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
-    }
-  },
-  "required": [
-    "email"
-  ]
-}

package/artifacts/schema/role-delete-query.schema.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "move_to": {
-      "description": "Another role of the same app that takes over the deleted role's app users, pending invitations and, when it applies, the app's default. The role itself or a role of another app answers `400 validation_error`.",
-      "type": "string",
-      "format": "uuid",
-      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
-    }
-  },
-  "additionalProperties": false
-}

package/artifacts/schema/role-in-use-details.schema.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "users": {
-      "type": "integer",
-      "minimum": 0,
-      "maximum": 9007199254740991,
-      "description": "App users whose role this is."
-    },
-    "invitations": {
-      "type": "integer",
-      "minimum": 0,
-      "maximum": 9007199254740991,
-      "description": "Pending invitations that would grant this role when accepted."
-    },
-    "is_default": {
-      "type": "boolean",
-      "description": "`true` when this is the app's `default_role_id`; the default then moves with the users to `move_to`."
-    }
-  },
-  "required": [
-    "users",
-    "invitations",
-    "is_default"
-  ],
-  "additionalProperties": false
-}

package/artifacts/schema/sign-up-request.schema.json

@@ -1,26 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "org_name": {
-      "type": "string",
-      "minLength": 1,
-      "maxLength": 120
-    },
-    "email": {
-      "type": "string",
-      "format": "email",
-      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
-    },
-    "password": {
-      "type": "string",
-      "minLength": 12,
-      "maxLength": 256
-    }
-  },
-  "required": [
-    "org_name",
-    "email",
-    "password"
-  ]
-}

package/artifacts/schema/sign-up-response.schema.json

@@ -1,127 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "org": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string",
-          "format": "uuid",
-          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
-          "description": "The organisation. Every developer route is scoped to the caller's org already, so a client rarely has to send this anywhere."
-        },
-        "name": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 120,
-          "description": "The organisation's display name. Free text, changed through `PATCH /api/org`."
-        },
-        "created_at": {
-          "type": "string",
-          "format": "date-time",
-          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
-          "description": "When the organisation was created, as an ISO 8601 timestamp."
-        }
-      },
-      "required": [
-        "id",
-        "name",
-        "created_at"
-      ],
-      "additionalProperties": false
-    },
-    "user": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "type": "string",
-          "format": "uuid",
-          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
-          "description": "The Fleetless user in the API, assigned by the cloud and stable for the life of the account."
-        },
-        "org_id": {
-          "type": "string",
-          "format": "uuid",
-          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
-          "description": "The organisation this person belongs to. Every developer route is already scoped to the caller's org, so this confirms what a client is looking at, not a filter it applies."
-        },
-        "email": {
-          "type": "string",
-          "format": "email",
-          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
-          "description": "The address the account is identified by, **globally unique** across every organisation. Immutable after creation: it is what every invitation, reset link and audit line names."
-        },
-        "display_name": {
-          "anyOf": [
-            {
-              "type": "string",
-              "minLength": 1,
-              "maxLength": 120
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "description": "Optional human name, shown by the console instead of the address where present. Self-service through `PATCH /api/auth/me`; never used for authentication. `null` when the person never supplied one."
-        },
-        "tier": {
-          "type": "string",
-          "enum": [
-            "owner",
-            "developer"
-          ],
-          "description": "The console powers this person holds. **Required** — every Fleetless user has a tier; it was optional only while the org also held people with no console powers to grade, and that pool is gone."
-        },
-        "created_at": {
-          "type": "string",
-          "format": "date-time",
-          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
-          "description": "When the account was created, as an ISO 8601 timestamp."
-        }
-      },
-      "required": [
-        "id",
-        "org_id",
-        "email",
-        "display_name",
-        "tier",
-        "created_at"
-      ],
-      "additionalProperties": false
-    },
-    "tokens": {
-      "type": "object",
-      "properties": {
-        "access_token": {
-          "type": "string",
-          "minLength": 1,
-          "description": "The token to send as `Authorization: Bearer <token>` on every call. Short-lived: read `expires_in` rather than assuming a lifetime."
-        },
-        "refresh_token": {
-          "type": "string",
-          "minLength": 1,
-          "description": "The token that buys the next access token. It rotates on every use, so a value presented twice is detectable theft and ends the whole family."
-        },
-        "expires_in": {
-          "type": "integer",
-          "exclusiveMinimum": 0,
-          "maximum": 9007199254740991,
-          "description": "How long the access token stays valid, in **seconds** from now. Not a timestamp, and not milliseconds."
-        }
-      },
-      "required": [
-        "access_token",
-        "refresh_token",
-        "expires_in"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "required": [
-    "org",
-    "user",
-    "tokens"
-  ],
-  "additionalProperties": false
-}

package/dist/feedback.d.ts

@@ -1,42 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-import { z } from 'zod';
-/**
- * **Feedback: a message from a developer to the people who build Fleetless.**
- *
- * The console's feedback modal sends it; the cloud stores it first and mails
- * it afterwards, so a message is never lost to a mail failure. Who sent it and
- * from which org is the caller's session, never the body: the body carries
- * only what the developer chose to say and the page they said it on.
- */
-/** The four kinds the console's modal offers. */
-export declare const FEEDBACK_KINDS: readonly ["idea", "problem", "question", "other"];
-export declare const feedbackKind: z.ZodEnum<{
-    idea: "idea";
-    problem: "problem";
-    question: "question";
-    other: "other";
-}>;
-/** Longest message the cloud stores; the console's counter starts at 4 500. */
-export declare const FEEDBACK_MESSAGE_MAX = 5000;
-export declare const feedbackRequest: z.ZodObject<{
-    kind: z.ZodEnum<{
-        idea: "idea";
-        problem: "problem";
-        question: "question";
-        other: "other";
-    }>;
-    message: z.ZodString;
-    page: z.ZodString;
-}, z.core.$strict>;
-export declare const feedbackResponse: z.ZodObject<{
-    id: z.ZodUUID;
-    mail: z.ZodEnum<{
-        sent: "sent";
-        not_requested: "not_requested";
-        not_configured: "not_configured";
-        failed: "failed";
-    }>;
-}, z.core.$strict>;
-export type FeedbackKind = z.infer<typeof feedbackKind>;
-export type FeedbackRequest = z.infer<typeof feedbackRequest>;
-export type FeedbackResponse = z.infer<typeof feedbackResponse>;

package/dist/feedback.js

@@ -1,35 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-import { z } from 'zod';
-import { mailStatus } from './identity.js';
-/**
- * **Feedback: a message from a developer to the people who build Fleetless.**
- *
- * The console's feedback modal sends it; the cloud stores it first and mails
- * it afterwards, so a message is never lost to a mail failure. Who sent it and
- * from which org is the caller's session, never the body: the body carries
- * only what the developer chose to say and the page they said it on.
- */
-/** The four kinds the console's modal offers. */
-export const FEEDBACK_KINDS = ['idea', 'problem', 'question', 'other'];
-export const feedbackKind = z.enum(FEEDBACK_KINDS);
-/** Longest message the cloud stores; the console's counter starts at 4 500. */
-export const FEEDBACK_MESSAGE_MAX = 5000;
-export const feedbackRequest = z.object({
-    kind: feedbackKind.meta({
-        description: 'What the message is: an `idea`, a `problem`, a `question` or `other`. It only sorts the inbox; it changes nothing about how the message is handled.',
-    }),
-    message: z.string().trim().min(1).max(FEEDBACK_MESSAGE_MAX).meta({
-        description: 'What the developer wrote, trimmed. At most 5000 characters; a message that is only whitespace is refused.',
-    }),
-    page: z.string().startsWith('/').max(512).meta({
-        description: 'The console path the message was sent from, e.g. `/robots/:id/jobs` with its real id. A path, never a full URL, so no host and no query string reach the inbox by accident.',
-    }),
-}).strict();
-export const feedbackResponse = z.object({
-    id: z.uuid().meta({
-        description: 'The stored message. It exists whatever `mail` says.',
-    }),
-    mail: mailStatus.meta({
-        description: 'What happened to the notification mail: `sent`, `failed`, or `not_configured` when this cloud has no feedback address. The message is stored in every case, so a client shows success for all three.',
-    }),
-}).strict();