@dokebi/cli 0.4.2 → 0.4.26

package/describe.schema.json

@@ -0,0 +1,748 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://dokebi.dev/schemas/cli/describe.schema.json",
+  "title": "dokebi describe --json result",
+  "description": "The result field of the `dokebi describe --json` envelope (D-0077 B), schemaVersion 1. Names only: no value of an option, a secret or an environment variable.",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "app",
+    "routes",
+    "pages",
+    "jobs",
+    "schedules",
+    "errors",
+    "config",
+    "db",
+    "unavailable",
+    "ms"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "schemaVersion": {
+      "const": 1
+    },
+    "app": {
+      "type": "object",
+      "description": "The project: its plugins and every object section plugins gave (apps and domains of dokebi-app, web, session, auth, csrf, redis, nats, ...).",
+      "required": ["name", "core", "plugins"],
+      "properties": {
+        "name": {
+          "type": ["string", "null"]
+        },
+        "core": {
+          "type": "string"
+        },
+        "plugins": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "version", "described"],
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "version": {
+                "type": "string"
+              },
+              "described": {
+                "type": "boolean"
+              },
+              "contributes": {
+                "type": "array",
+                "description": "Contribution points the plugin (or module) contributes to, when it declares any (D-0130)",
+                "items": { "type": "string" }
+              },
+              "collects": {
+                "type": "array",
+                "description": "Contribution points the plugin collects, when it declares any",
+                "items": { "type": "string" }
+              }
+            }
+          }
+        },
+        "apps": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "name",
+              "engine",
+              "views",
+              "templates",
+              "modules",
+              "requires",
+              "namespaces"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "engine": {
+                "enum": ["ejs", "inertia", null]
+              },
+              "views": {
+                "type": ["string", "null"]
+              },
+              "templates": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "modules": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "required": ["prefix", "module"],
+                  "additionalProperties": false,
+                  "properties": {
+                    "prefix": {
+                      "type": "string"
+                    },
+                    "module": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "requires": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "namespaces": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "domains": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["host", "app", "template", "seal"],
+            "additionalProperties": false,
+            "properties": {
+              "host": {
+                "type": "string"
+              },
+              "app": {
+                "type": "string"
+              },
+              "template": {
+                "type": "string"
+              },
+              "seal": {
+                "type": "boolean"
+              }
+            }
+          }
+        },
+        "unknownDomain": {
+          "type": "string"
+        }
+      }
+    },
+    "routes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["method", "url"],
+        "additionalProperties": false,
+        "properties": {
+          "method": {
+            "type": "string",
+            "description": "GET, POST, ... (several joined with commas)"
+          },
+          "url": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string",
+            "description": "The route's config.id"
+          },
+          "app": {
+            "type": "string",
+            "description": "The dokebi-app app the route belongs to"
+          },
+          "host": {
+            "type": "string",
+            "description": "A Fastify host constraint"
+          },
+          "constraints": {
+            "type": "object"
+          },
+          "schema": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "body": {},
+              "querystring": {},
+              "params": {},
+              "headers": {},
+              "response": {}
+            }
+          },
+          "config": {
+            "type": "object",
+            "description": "Route config keys other plugins read: auth, can, roles, csrf, ..."
+          },
+          "auth": {
+            "type": "object",
+            "description": "The effective login rule of dokebi-auth: mode (required, optional, guest, off), realm, via, can, roles",
+            "required": ["mode", "realm"],
+            "properties": {
+              "mode": { "enum": ["required", "optional", "guest", "off"] },
+              "realm": { "type": "string" },
+              "via": { "type": "string" },
+              "can": { "type": "string" },
+              "roles": {
+                "type": "array",
+                "items": { "type": "string" },
+                "description": "config.roles: any one of these roles is needed"
+              }
+            }
+          },
+          "seal": {
+            "enum": [true, false, "function"]
+          },
+          "health": {
+            "const": true
+          },
+          "plugin": {
+            "type": "string",
+            "description": "The plugin that added the route itself (D-0142), for example dokebi-mcp; absent on the app's own routes"
+          }
+        }
+      }
+    },
+    "pages": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["app", "engine", "template", "name", "file"],
+        "additionalProperties": false,
+        "properties": {
+          "app": {
+            "type": "string"
+          },
+          "engine": {
+            "enum": ["ejs", "inertia"]
+          },
+          "template": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "file": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "jobs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["queue", "connection", "stream", "consumer", "subject", "types"],
+        "properties": {
+          "queue": {
+            "type": "string"
+          },
+          "connection": {
+            "type": "string"
+          },
+          "stream": {
+            "type": "string"
+          },
+          "consumer": {
+            "type": "string"
+          },
+          "subject": {
+            "type": "string"
+          },
+          "types": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "schedules": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "queue", "type", "mode"],
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "queue": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          },
+          "cron": {
+            "type": "string"
+          },
+          "timezone": {
+            "type": "string"
+          },
+          "intervalMs": {
+            "type": "integer"
+          },
+          "mode": {
+            "enum": ["local", "distributed"]
+          }
+        }
+      }
+    },
+    "errors": {
+      "type": "array",
+      "description": "The error codes of src/shared/errors.ts (errorCatalog of @dokebi/web over its defineErrors results)",
+      "items": {
+        "type": "object",
+        "required": ["code", "status", "message"],
+        "additionalProperties": false,
+        "properties": {
+          "code": {
+            "type": "string"
+          },
+          "status": {
+            "type": "number"
+          },
+          "message": {
+            "type": "string"
+          },
+          "hint": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "config": {
+      "type": "object",
+      "required": ["keys", "env"],
+      "additionalProperties": false,
+      "properties": {
+        "keys": {
+          "type": "array",
+          "description": "Every option path set in dokebi.yaml (dokebi-web.port), never a value",
+          "items": {
+            "type": "string"
+          }
+        },
+        "env": {
+          "type": "array",
+          "description": "Environment variables the app and its plugins read, by name",
+          "items": {
+            "type": "object",
+            "required": ["name", "plugin"],
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "plugin": {
+                "type": "string"
+              },
+              "purpose": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "db": {
+      "type": "object",
+      "description": "The dokebi-db connections. Without --with-db: names and adapters, and unavailable says the tables were not read (describe mode never connects). With --with-db: each connection with the shape dokebi-migrate schema read (D-0077 F), or its own unavailable reason.",
+      "additionalProperties": false,
+      "properties": {
+        "connections": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/dbConnection"
+          }
+        },
+        "unavailable": {
+          "type": "string"
+        }
+      }
+    },
+    "unavailable": {
+      "type": "array",
+      "description": "Plugins (or one part of a plugin) that could not be described, and why",
+      "items": {
+        "type": "object",
+        "required": ["plugin", "code", "reason"],
+        "additionalProperties": false,
+        "properties": {
+          "plugin": {
+            "type": "string"
+          },
+          "section": {
+            "type": "string"
+          },
+          "code": {
+            "type": "string"
+          },
+          "reason": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["code", "message"],
+        "additionalProperties": false,
+        "properties": {
+          "code": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "ms": {
+      "type": "integer",
+      "minimum": 0
+    }
+  },
+  "$defs": {
+    "dbConnection": {
+      "type": "object",
+      "required": ["name", "adapter"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "adapter": {
+          "type": "string"
+        },
+        "startup": {
+          "description": "D-0127: present (optional) only when dokebi.yaml sets startup: optional; the default required is left out",
+          "enum": ["optional"]
+        },
+        "dialect": {
+          "enum": ["postgres", "mysql", "mariadb", "mongodb"]
+        },
+        "schemas": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "tables": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/table"
+          }
+        },
+        "collections": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/collection"
+          }
+        },
+        "unavailable": {
+          "type": "string",
+          "description": "Why this connection's shape could not be read (not listed in options.dokebi-migrate.connections, @dokebi/migrate missing, the database refused, a timeout); never a URL or password"
+        }
+      }
+    },
+    "table": {
+      "type": "object",
+      "required": ["name", "columns", "primaryKey", "unique", "indexes", "foreignKeys", "checks"],
+      "additionalProperties": false,
+      "properties": {
+        "schema": {
+          "type": "string",
+          "description": "PostgreSQL only"
+        },
+        "name": {
+          "type": "string"
+        },
+        "isMigrationHistory": {
+          "const": true,
+          "description": "The dokebi-migrate history table (dokebi_migrations); never edit it by hand"
+        },
+        "engine": {
+          "type": "string",
+          "description": "MySQL and MariaDB"
+        },
+        "collation": {
+          "type": "string",
+          "description": "MySQL and MariaDB: the table default"
+        },
+        "comment": {
+          "type": "string"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/column"
+          }
+        },
+        "primaryKey": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/key"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "unique": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/key"
+          }
+        },
+        "indexes": {
+          "type": "array",
+          "description": "Indexes that do not back the primary key or a unique constraint",
+          "items": {
+            "$ref": "#/$defs/index"
+          }
+        },
+        "foreignKeys": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/foreignKey"
+          }
+        },
+        "checks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "expression"],
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "expression": {
+                "type": "string",
+                "description": "As the database prints it"
+              }
+            }
+          }
+        }
+      }
+    },
+    "column": {
+      "type": "object",
+      "required": ["name", "type", "nullable"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "description": "As the database prints it, with length or precision (character varying(190), int, decimal(10,2))"
+        },
+        "nullable": {
+          "type": "boolean"
+        },
+        "default": {
+          "type": "string",
+          "description": "The default as an SQL expression ('author', now(), CURRENT_TIMESTAMP); absent when there is none"
+        },
+        "identity": {
+          "enum": ["always", "byDefault"],
+          "description": "PostgreSQL identity"
+        },
+        "autoIncrement": {
+          "const": true,
+          "description": "MySQL and MariaDB"
+        },
+        "generated": {
+          "type": "object",
+          "required": ["expression", "stored"],
+          "additionalProperties": false,
+          "properties": {
+            "expression": {
+              "type": "string"
+            },
+            "stored": {
+              "type": "boolean"
+            }
+          }
+        },
+        "comment": {
+          "type": "string"
+        }
+      }
+    },
+    "key": {
+      "type": "object",
+      "required": ["name", "columns"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "index": {
+      "type": "object",
+      "required": ["name", "columns", "unique", "method"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "columns": {
+          "type": "array",
+          "description": "Column names, or the expression of an expression index",
+          "items": {
+            "type": "string"
+          }
+        },
+        "unique": {
+          "type": "boolean"
+        },
+        "method": {
+          "type": "string",
+          "description": "btree, hash, gin, ... (PostgreSQL); BTREE, FULLTEXT, SPATIAL, HASH (MySQL, MariaDB)"
+        },
+        "where": {
+          "type": "string",
+          "description": "PostgreSQL partial index predicate"
+        }
+      }
+    },
+    "foreignKey": {
+      "type": "object",
+      "required": ["name", "columns", "references", "onDelete", "onUpdate"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "references": {
+          "type": "object",
+          "required": ["table", "columns"],
+          "additionalProperties": false,
+          "properties": {
+            "schema": {
+              "type": "string",
+              "description": "PostgreSQL always; MySQL and MariaDB only for another database"
+            },
+            "table": {
+              "type": "string"
+            },
+            "columns": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "onDelete": {
+          "$ref": "#/$defs/action"
+        },
+        "onUpdate": {
+          "$ref": "#/$defs/action"
+        }
+      }
+    },
+    "action": {
+      "enum": ["NO ACTION", "RESTRICT", "CASCADE", "SET NULL", "SET DEFAULT"]
+    },
+    "collection": {
+      "type": "object",
+      "required": ["name", "indexes"],
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "const": "timeseries"
+        },
+        "isMigrationHistory": {
+          "const": true,
+          "description": "dokebi_migrations and its lock collection dokebi_migrations_lock"
+        },
+        "capped": {
+          "const": true
+        },
+        "jsonSchema": {
+          "type": "object",
+          "description": "The $jsonSchema of the collection validator, when it has one"
+        },
+        "validationLevel": {
+          "type": "string"
+        },
+        "validationAction": {
+          "type": "string"
+        },
+        "indexes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["name", "key", "unique"],
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "key": {
+                "type": "object",
+                "description": "The index key as MongoDB keeps it ({ field: 1 | -1 | 'text' | ... })"
+              },
+              "unique": {
+                "type": "boolean"
+              },
+              "sparse": {
+                "const": true
+              },
+              "expireAfterSeconds": {
+                "type": "number"
+              },
+              "partialFilterExpression": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}