@fleetless/contracts 6.0.0 → 6.1.0-next.2

package/artifacts/schema/plan-catalogue-entry.schema.json

@@ -0,0 +1,249 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "enum": [
+        "basic",
+        "plus",
+        "pro",
+        "enterprise"
+      ],
+      "description": "The plan."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The plan's display name: Basic, Plus, Pro or Enterprise."
+    },
+    "limits": {
+      "type": "object",
+      "properties": {
+        "seats": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Developers, owners included, plus pending team invitations."
+        },
+        "robots": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Robots in the org."
+        },
+        "apps": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Apps in the org."
+        },
+        "app_users": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "App users across every app of the org, plus pending app-user invitations."
+        },
+        "live_video_ms_per_month": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Live video watched by app users in one UTC calendar month, in milliseconds, across the org. Console sessions do not count."
+        },
+        "asset_bytes_per_robot": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Asset storage per robot, in bytes (decimal: 1 GB = 1,000,000,000). The org stores up to robots × this value in total."
+        },
+        "history_days": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Days the org's robot history is kept."
+        },
+        "audit_days": {
+          "anyOf": [
+            {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "maximum": 9007199254740991
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "Days the org's audit log is kept."
+        }
+      },
+      "required": [
+        "seats",
+        "robots",
+        "apps",
+        "app_users",
+        "live_video_ms_per_month",
+        "asset_bytes_per_robot",
+        "history_days",
+        "audit_days"
+      ],
+      "additionalProperties": false,
+      "description": "What the plan allows. `null` means by contract."
+    },
+    "features": {
+      "type": "object",
+      "properties": {
+        "app_mcp": {
+          "type": "boolean",
+          "description": "An app's own MCP endpoint, for its app users."
+        },
+        "two_factor": {
+          "type": "boolean",
+          "description": "Two-factor sign-in for developers."
+        },
+        "require_two_factor": {
+          "type": "boolean",
+          "description": "An owner may require two-factor sign-in for every developer of the org."
+        },
+        "app_oidc": {
+          "type": "boolean",
+          "description": "An app may let its users sign in through an OpenID Connect identity provider."
+        },
+        "hosted_logo": {
+          "type": "boolean",
+          "description": "An app's hosted pages show its logo and accent colour, not only its name."
+        },
+        "audit_export": {
+          "type": "boolean",
+          "description": "The audit log can be exported as CSV."
+        },
+        "addons": {
+          "type": "boolean",
+          "description": "Add-ons can be bought on top of the plan."
+        }
+      },
+      "required": [
+        "app_mcp",
+        "two_factor",
+        "require_two_factor",
+        "app_oidc",
+        "hosted_logo",
+        "audit_export",
+        "addons"
+      ],
+      "additionalProperties": false,
+      "description": "What the plan unlocks."
+    },
+    "prices": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "eur_month": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Per month in euro cents, excluding VAT."
+            },
+            "usd_month": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Per month in US dollar cents, excluding VAT: the euro price × 1.15, rounded up to a whole dollar."
+            },
+            "eur_year": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Per year in euro cents, excluding VAT: twelve months less 15 %."
+            },
+            "usd_year": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991,
+              "description": "Per year in US dollar cents, excluding VAT: the yearly euro price × 1.15, rounded up to a whole dollar."
+            }
+          },
+          "required": [
+            "eur_month",
+            "usd_month",
+            "eur_year",
+            "usd_year"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "`null` for Enterprise: sold by contract, on request."
+    },
+    "support": {
+      "type": "string",
+      "enum": [
+        "community",
+        "email",
+        "priority",
+        "named_contact"
+      ],
+      "description": "The support that comes with the plan."
+    }
+  },
+  "required": [
+    "id",
+    "name",
+    "limits",
+    "features",
+    "prices",
+    "support"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/plan-change-keep.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "robots": {
+      "type": "array",
+      "items": {
+        "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 robots that stay, by id. Every other robot is deleted when the change takes effect."
+    },
+    "apps": {
+      "type": "array",
+      "items": {
+        "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 apps that stay, by id. Every other app is deleted when the change takes effect."
+    },
+    "app_users": {
+      "type": "array",
+      "items": {
+        "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 app users that stay, by id, across every app. Every other app user is deleted when the change takes effect."
+    },
+    "developers": {
+      "type": "array",
+      "items": {
+        "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 developers that stay, by user id, owners never among them: every owner stays. Every other developer is removed from the org when the change takes effect."
+    }
+  },
+  "required": [
+    "robots",
+    "apps",
+    "app_users",
+    "developers"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/plan-change-reason.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "downgrade",
+    "cancel",
+    "migration",
+    "lock"
+  ]
+}

package/artifacts/schema/plan-change-request.schema.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "target_plan": {
+      "type": "string",
+      "enum": [
+        "basic",
+        "plus",
+        "pro",
+        "enterprise"
+      ],
+      "description": "The lower plan to move to; `basic` cancels."
+    },
+    "keep": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "robots": {
+              "type": "array",
+              "items": {
+                "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 robots that stay, by id. Every other robot is deleted when the change takes effect."
+            },
+            "apps": {
+              "type": "array",
+              "items": {
+                "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 apps that stay, by id. Every other app is deleted when the change takes effect."
+            },
+            "app_users": {
+              "type": "array",
+              "items": {
+                "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 app users that stay, by id, across every app. Every other app user is deleted when the change takes effect."
+            },
+            "developers": {
+              "type": "array",
+              "items": {
+                "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 developers that stay, by user id, owners never among them: every owner stays. Every other developer is removed from the org when the change takes effect."
+            }
+          },
+          "required": [
+            "robots",
+            "apps",
+            "app_users",
+            "developers"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "What stays. `null` when the org already fits the target plan, so nothing is deleted."
+    }
+  },
+  "required": [
+    "target_plan",
+    "keep"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/plan-currency.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "eur",
+    "usd"
+  ]
+}

package/artifacts/schema/plan-features.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "app_mcp": {
+      "type": "boolean",
+      "description": "An app's own MCP endpoint, for its app users."
+    },
+    "two_factor": {
+      "type": "boolean",
+      "description": "Two-factor sign-in for developers."
+    },
+    "require_two_factor": {
+      "type": "boolean",
+      "description": "An owner may require two-factor sign-in for every developer of the org."
+    },
+    "app_oidc": {
+      "type": "boolean",
+      "description": "An app may let its users sign in through an OpenID Connect identity provider."
+    },
+    "hosted_logo": {
+      "type": "boolean",
+      "description": "An app's hosted pages show its logo and accent colour, not only its name."
+    },
+    "audit_export": {
+      "type": "boolean",
+      "description": "The audit log can be exported as CSV."
+    },
+    "addons": {
+      "type": "boolean",
+      "description": "Add-ons can be bought on top of the plan."
+    }
+  },
+  "required": [
+    "app_mcp",
+    "two_factor",
+    "require_two_factor",
+    "app_oidc",
+    "hosted_logo",
+    "audit_export",
+    "addons"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/plan-id.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "basic",
+    "plus",
+    "pro",
+    "enterprise"
+  ]
+}

package/artifacts/schema/plan-limit-details.schema.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "limit": {
+      "type": "string",
+      "enum": [
+        "seats",
+        "robots",
+        "apps",
+        "app_users",
+        "live_video_ms_per_month",
+        "asset_bytes_per_robot"
+      ],
+      "description": "The limit the action would exceed."
+    },
+    "used": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "How much of the limit the org uses now."
+    },
+    "max": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991,
+      "description": "The limit. For `asset_bytes_per_robot`, the org's whole pool: robots × the plan's bytes per robot."
+    },
+    "plan": {
+      "type": "string",
+      "enum": [
+        "basic",
+        "plus",
+        "pro",
+        "enterprise"
+      ],
+      "description": "The plan whose limit refused: the target plan while a move to a lower plan is pending."
+    },
+    "lifted_by": {
+      "type": "object",
+      "properties": {
+        "plan": {
+          "anyOf": [
+            {
+              "type": "string",
+              "enum": [
+                "basic",
+                "plus",
+                "pro",
+                "enterprise"
+              ]
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The cheapest higher plan that raises this limit, or `null` when none does."
+        },
+        "addon": {
+          "anyOf": [
+            {
+              "type": "string",
+              "enum": [
+                "seats",
+                "robots",
+                "apps",
+                "app_user_packs",
+                "live_video_packs"
+              ]
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "The add-on that raises this limit, when the org's plan can buy add-ons; otherwise `null`."
+        }
+      },
+      "required": [
+        "plan",
+        "addon"
+      ],
+      "additionalProperties": false,
+      "description": "What would lift the limit."
+    }
+  },
+  "required": [
+    "limit",
+    "used",
+    "max",
+    "plan",
+    "lifted_by"
+  ],
+  "additionalProperties": false
+}

package/artifacts/schema/plan-limits.schema.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "seats": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Developers, owners included, plus pending team invitations."
+    },
+    "robots": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Robots in the org."
+    },
+    "apps": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Apps in the org."
+    },
+    "app_users": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "App users across every app of the org, plus pending app-user invitations."
+    },
+    "live_video_ms_per_month": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Live video watched by app users in one UTC calendar month, in milliseconds, across the org. Console sessions do not count."
+    },
+    "asset_bytes_per_robot": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Asset storage per robot, in bytes (decimal: 1 GB = 1,000,000,000). The org stores up to robots × this value in total."
+    },
+    "history_days": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Days the org's robot history is kept."
+    },
+    "audit_days": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Days the org's audit log is kept."
+    }
+  },
+  "required": [
+    "seats",
+    "robots",
+    "apps",
+    "app_users",
+    "live_video_ms_per_month",
+    "asset_bytes_per_robot",
+    "history_days",
+    "audit_days"
+  ],
+  "additionalProperties": false
+}