@warlock.js/core 5.29.0 → 5.31.0

package/esm/tooling/inspect/inspect-report.schema.mjs

@@ -0,0 +1,463 @@
+//#region ../../packages/core/src/tooling/inspect/inspect-report.schema.ts
+/**
+* JSON Schema (draft 2020-12) of the `warlock inspect` report, schema version 1.
+*
+* Shipped twice: as this constant, and as
+* `@warlock.js/core/schemas/inspect-report.schema.json` for tools that are not
+* JavaScript. A test keeps the two identical. Objects allow additional
+* properties on purpose: within schema version 1 fields are only added, and a
+* validator written today must accept tomorrow's reports.
+*/
+const nullableString = { type: ["string", "null"] };
+const stringArray = {
+	type: "array",
+	items: { type: "string" }
+};
+const jsonSchema = { type: "object" };
+const route = {
+	type: "object",
+	required: [
+		"method",
+		"path",
+		"name",
+		"sourceFile",
+		"handler",
+		"description",
+		"isPage",
+		"middleware",
+		"auth",
+		"csrf",
+		"rateLimit",
+		"logging",
+		"request",
+		"responses"
+	],
+	properties: {
+		method: { type: "string" },
+		path: { type: "string" },
+		name: nullableString,
+		sourceFile: nullableString,
+		handler: { type: "string" },
+		description: nullableString,
+		isPage: { type: "boolean" },
+		middleware: stringArray,
+		auth: {
+			type: "object",
+			required: [
+				"required",
+				"sources",
+				"userTypes"
+			],
+			properties: {
+				required: { type: "boolean" },
+				sources: {
+					type: "array",
+					items: { oneOf: [{ const: "header" }, {
+						type: "object",
+						required: ["cookie"],
+						properties: { cookie: { type: "string" } }
+					}] }
+				},
+				userTypes: stringArray
+			}
+		},
+		csrf: { type: "boolean" },
+		rateLimit: {
+			type: "object",
+			required: [
+				"source",
+				"max",
+				"timeWindow"
+			],
+			properties: {
+				source: { enum: [
+					"route",
+					"global",
+					"none"
+				] },
+				max: { oneOf: [
+					{ type: "number" },
+					{ const: "dynamic" },
+					{ type: "null" }
+				] },
+				timeWindow: { type: [
+					"number",
+					"string",
+					"null"
+				] }
+			}
+		},
+		logging: {
+			type: "object",
+			required: [
+				"body",
+				"query",
+				"privateRules"
+			],
+			properties: {
+				body: { type: "boolean" },
+				query: { type: "boolean" },
+				privateRules: { type: "boolean" }
+			}
+		},
+		request: {
+			type: "object",
+			required: [
+				"parameters",
+				"body",
+				"customValidation"
+			],
+			properties: {
+				parameters: {
+					type: "array",
+					items: {
+						type: "object",
+						required: [
+							"name",
+							"in",
+							"required",
+							"schema"
+						],
+						properties: {
+							name: { type: "string" },
+							in: { enum: [
+								"path",
+								"query",
+								"header",
+								"cookie"
+							] },
+							required: { type: "boolean" },
+							schema: jsonSchema
+						}
+					}
+				},
+				body: { type: ["object", "null"] },
+				customValidation: { type: "boolean" }
+			}
+		},
+		responses: {
+			type: "object",
+			additionalProperties: {
+				type: "object",
+				required: ["description", "schema"],
+				properties: {
+					description: { type: "string" },
+					schema: { type: ["object", "null"] }
+				}
+			}
+		}
+	}
+};
+const model = {
+	type: "object",
+	required: [
+		"name",
+		"table",
+		"primaryKey",
+		"dataSource",
+		"sourceFile",
+		"registered",
+		"columns",
+		"relations",
+		"resource",
+		"deleteStrategy",
+		"createdAtColumn",
+		"updatedAtColumn",
+		"deletedAtColumn"
+	],
+	properties: {
+		name: { type: "string" },
+		table: nullableString,
+		primaryKey: nullableString,
+		dataSource: nullableString,
+		sourceFile: nullableString,
+		registered: { type: "boolean" },
+		columns: {
+			type: "array",
+			items: {
+				type: "object",
+				required: [
+					"name",
+					"required",
+					"schema"
+				],
+				properties: {
+					name: { type: "string" },
+					required: { type: "boolean" },
+					schema: jsonSchema
+				}
+			}
+		},
+		relations: {
+			type: "array",
+			items: {
+				type: "object",
+				required: [
+					"name",
+					"type",
+					"model",
+					"foreignKey",
+					"localKey"
+				],
+				properties: {
+					name: { type: "string" },
+					type: { type: "string" },
+					model: nullableString,
+					foreignKey: nullableString,
+					localKey: nullableString
+				}
+			}
+		},
+		resource: nullableString,
+		deleteStrategy: nullableString,
+		createdAtColumn: nullableString,
+		updatedAtColumn: nullableString,
+		deletedAtColumn: nullableString
+	}
+};
+const resource = {
+	type: "object",
+	required: [
+		"name",
+		"schema",
+		"models"
+	],
+	properties: {
+		name: { type: "string" },
+		schema: jsonSchema,
+		models: stringArray
+	}
+};
+const configKey = {
+	type: "object",
+	required: [
+		"key",
+		"type",
+		"file"
+	],
+	properties: {
+		key: { type: "string" },
+		type: { type: "string" },
+		file: nullableString
+	}
+};
+const event = {
+	type: "object",
+	required: ["event", "listeners"],
+	properties: {
+		event: { type: "string" },
+		listeners: {
+			type: "array",
+			items: {
+				type: "object",
+				required: ["name", "sourceFile"],
+				properties: {
+					name: { type: "string" },
+					sourceFile: { type: "string" }
+				}
+			}
+		}
+	}
+};
+const page = {
+	type: "object",
+	required: [
+		"path",
+		"name",
+		"file",
+		"layouts",
+		"loaders",
+		"actions",
+		"guard"
+	],
+	properties: {
+		path: { type: "string" },
+		name: nullableString,
+		file: { type: "string" },
+		layouts: stringArray,
+		loaders: stringArray,
+		actions: stringArray,
+		guard: nullableString
+	}
+};
+const job = {
+	type: "object",
+	required: [
+		"name",
+		"queue",
+		"attempts",
+		"backoff",
+		"removeOnComplete",
+		"removeOnFail"
+	],
+	properties: {
+		name: { type: "string" },
+		queue: { type: "string" },
+		attempts: { type: ["number", "null"] },
+		backoff: { oneOf: [
+			{ type: "number" },
+			{ type: "null" },
+			{
+				type: "object",
+				required: ["type", "delay"],
+				properties: {
+					type: { type: "string" },
+					delay: { type: "number" }
+				}
+			}
+		] },
+		removeOnComplete: { type: [
+			"boolean",
+			"number",
+			"null"
+		] },
+		removeOnFail: { type: [
+			"boolean",
+			"number",
+			"null"
+		] }
+	}
+};
+const schedule = {
+	type: "object",
+	required: [
+		"name",
+		"cron",
+		"intervals",
+		"nextRun"
+	],
+	properties: {
+		name: { type: "string" },
+		cron: nullableString,
+		intervals: { type: "object" },
+		nextRun: nullableString
+	}
+};
+const installedPackage = {
+	type: "object",
+	required: ["name", "version"],
+	properties: {
+		name: { type: "string" },
+		version: { type: "string" }
+	}
+};
+const warning = {
+	type: "object",
+	required: [
+		"code",
+		"message",
+		"source"
+	],
+	properties: {
+		code: { oneOf: [{
+			type: "string",
+			pattern: "^WL[0-9]{4}$"
+		}, { type: "null" }] },
+		message: { type: "string" },
+		source: nullableString
+	}
+};
+/** The report's JSON Schema, draft 2020-12. */
+const INSPECT_REPORT_JSON_SCHEMA = {
+	$schema: "https://json-schema.org/draft/2020-12/schema",
+	title: "Warlock inspect report",
+	description: "Output of `warlock inspect --json`, schema version 1.",
+	type: "object",
+	required: [
+		"schemaVersion",
+		"generatedAt",
+		"app",
+		"sections",
+		"components",
+		"warnings"
+	],
+	properties: {
+		schemaVersion: { const: 1 },
+		generatedAt: { type: "string" },
+		app: {
+			type: "object",
+			required: [
+				"name",
+				"version",
+				"root",
+				"node",
+				"environment",
+				"runtimeStrategy"
+			],
+			properties: {
+				name: nullableString,
+				version: nullableString,
+				root: { type: "string" },
+				node: { type: "string" },
+				environment: { type: "string" },
+				runtimeStrategy: { type: "string" }
+			}
+		},
+		sections: {
+			type: "array",
+			items: { enum: [
+				"routes",
+				"models",
+				"resources",
+				"config",
+				"events",
+				"pages",
+				"jobs",
+				"schedules",
+				"packages"
+			] }
+		},
+		routes: {
+			type: "array",
+			items: route
+		},
+		models: {
+			type: "array",
+			items: model
+		},
+		resources: {
+			type: "array",
+			items: resource
+		},
+		config: {
+			type: "array",
+			items: configKey
+		},
+		events: {
+			type: "array",
+			items: event
+		},
+		pages: {
+			type: "array",
+			items: page
+		},
+		jobs: {
+			type: "array",
+			items: job
+		},
+		schedules: {
+			type: "array",
+			items: schedule
+		},
+		packages: {
+			type: "array",
+			items: installedPackage
+		},
+		components: {
+			type: "object",
+			required: ["schemas"],
+			properties: { schemas: {
+				type: "object",
+				additionalProperties: jsonSchema
+			} }
+		},
+		warnings: {
+			type: "array",
+			items: warning
+		}
+	}
+};
+
+//#endregion
+export { INSPECT_REPORT_JSON_SCHEMA };
+//# sourceMappingURL=inspect-report.schema.mjs.map

package/esm/tooling/inspect/inspect-report.schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspect-report.schema.mjs","names":[],"sources":["../../../../../../../../../packages/core/src/tooling/inspect/inspect-report.schema.ts"],"sourcesContent":["/**\n * JSON Schema (draft 2020-12) of the `warlock inspect` report, schema version 1.\n *\n * Shipped twice: as this constant, and as\n * `@warlock.js/core/schemas/inspect-report.schema.json` for tools that are not\n * JavaScript. A test keeps the two identical. Objects allow additional\n * properties on purpose: within schema version 1 fields are only added, and a\n * validator written today must accept tomorrow's reports.\n */\n\nconst nullableString = { type: [\"string\", \"null\"] };\nconst stringArray = { type: \"array\", items: { type: \"string\" } };\nconst jsonSchema = { type: \"object\" };\n\nconst authSource = {\n  oneOf: [\n    { const: \"header\" },\n    {\n      type: \"object\",\n      required: [\"cookie\"],\n      properties: { cookie: { type: \"string\" } },\n    },\n  ],\n};\n\nconst route = {\n  type: \"object\",\n  required: [\n    \"method\",\n    \"path\",\n    \"name\",\n    \"sourceFile\",\n    \"handler\",\n    \"description\",\n    \"isPage\",\n    \"middleware\",\n    \"auth\",\n    \"csrf\",\n    \"rateLimit\",\n    \"logging\",\n    \"request\",\n    \"responses\",\n  ],\n  properties: {\n    method: { type: \"string\" },\n    path: { type: \"string\" },\n    name: nullableString,\n    sourceFile: nullableString,\n    handler: { type: \"string\" },\n    description: nullableString,\n    isPage: { type: \"boolean\" },\n    middleware: stringArray,\n    auth: {\n      type: \"object\",\n      required: [\"required\", \"sources\", \"userTypes\"],\n      properties: {\n        required: { type: \"boolean\" },\n        sources: { type: \"array\", items: authSource },\n        userTypes: stringArray,\n      },\n    },\n    csrf: { type: \"boolean\" },\n    rateLimit: {\n      type: \"object\",\n      required: [\"source\", \"max\", \"timeWindow\"],\n      properties: {\n        source: { enum: [\"route\", \"global\", \"none\"] },\n        max: { oneOf: [{ type: \"number\" }, { const: \"dynamic\" }, { type: \"null\" }] },\n        timeWindow: { type: [\"number\", \"string\", \"null\"] },\n      },\n    },\n    logging: {\n      type: \"object\",\n      required: [\"body\", \"query\", \"privateRules\"],\n      properties: {\n        body: { type: \"boolean\" },\n        query: { type: \"boolean\" },\n        privateRules: { type: \"boolean\" },\n      },\n    },\n    request: {\n      type: \"object\",\n      required: [\"parameters\", \"body\", \"customValidation\"],\n      properties: {\n        parameters: {\n          type: \"array\",\n          items: {\n            type: \"object\",\n            required: [\"name\", \"in\", \"required\", \"schema\"],\n            properties: {\n              name: { type: \"string\" },\n              in: { enum: [\"path\", \"query\", \"header\", \"cookie\"] },\n              required: { type: \"boolean\" },\n              schema: jsonSchema,\n            },\n          },\n        },\n        body: { type: [\"object\", \"null\"] },\n        customValidation: { type: \"boolean\" },\n      },\n    },\n    responses: {\n      type: \"object\",\n      additionalProperties: {\n        type: \"object\",\n        required: [\"description\", \"schema\"],\n        properties: {\n          description: { type: \"string\" },\n          schema: { type: [\"object\", \"null\"] },\n        },\n      },\n    },\n  },\n};\n\nconst model = {\n  type: \"object\",\n  required: [\n    \"name\",\n    \"table\",\n    \"primaryKey\",\n    \"dataSource\",\n    \"sourceFile\",\n    \"registered\",\n    \"columns\",\n    \"relations\",\n    \"resource\",\n    \"deleteStrategy\",\n    \"createdAtColumn\",\n    \"updatedAtColumn\",\n    \"deletedAtColumn\",\n  ],\n  properties: {\n    name: { type: \"string\" },\n    table: nullableString,\n    primaryKey: nullableString,\n    dataSource: nullableString,\n    sourceFile: nullableString,\n    registered: { type: \"boolean\" },\n    columns: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        required: [\"name\", \"required\", \"schema\"],\n        properties: {\n          name: { type: \"string\" },\n          required: { type: \"boolean\" },\n          schema: jsonSchema,\n        },\n      },\n    },\n    relations: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        required: [\"name\", \"type\", \"model\", \"foreignKey\", \"localKey\"],\n        properties: {\n          name: { type: \"string\" },\n          type: { type: \"string\" },\n          model: nullableString,\n          foreignKey: nullableString,\n          localKey: nullableString,\n        },\n      },\n    },\n    resource: nullableString,\n    deleteStrategy: nullableString,\n    createdAtColumn: nullableString,\n    updatedAtColumn: nullableString,\n    deletedAtColumn: nullableString,\n  },\n};\n\nconst resource = {\n  type: \"object\",\n  required: [\"name\", \"schema\", \"models\"],\n  properties: {\n    name: { type: \"string\" },\n    schema: jsonSchema,\n    models: stringArray,\n  },\n};\n\nconst configKey = {\n  type: \"object\",\n  required: [\"key\", \"type\", \"file\"],\n  properties: {\n    key: { type: \"string\" },\n    type: { type: \"string\" },\n    file: nullableString,\n  },\n};\n\nconst event = {\n  type: \"object\",\n  required: [\"event\", \"listeners\"],\n  properties: {\n    event: { type: \"string\" },\n    listeners: {\n      type: \"array\",\n      items: {\n        type: \"object\",\n        required: [\"name\", \"sourceFile\"],\n        properties: { name: { type: \"string\" }, sourceFile: { type: \"string\" } },\n      },\n    },\n  },\n};\n\nconst page = {\n  type: \"object\",\n  required: [\"path\", \"name\", \"file\", \"layouts\", \"loaders\", \"actions\", \"guard\"],\n  properties: {\n    path: { type: \"string\" },\n    name: nullableString,\n    file: { type: \"string\" },\n    layouts: stringArray,\n    loaders: stringArray,\n    actions: stringArray,\n    guard: nullableString,\n  },\n};\n\nconst job = {\n  type: \"object\",\n  required: [\"name\", \"queue\", \"attempts\", \"backoff\", \"removeOnComplete\", \"removeOnFail\"],\n  properties: {\n    name: { type: \"string\" },\n    queue: { type: \"string\" },\n    attempts: { type: [\"number\", \"null\"] },\n    backoff: {\n      oneOf: [\n        { type: \"number\" },\n        { type: \"null\" },\n        {\n          type: \"object\",\n          required: [\"type\", \"delay\"],\n          properties: { type: { type: \"string\" }, delay: { type: \"number\" } },\n        },\n      ],\n    },\n    removeOnComplete: { type: [\"boolean\", \"number\", \"null\"] },\n    removeOnFail: { type: [\"boolean\", \"number\", \"null\"] },\n  },\n};\n\nconst schedule = {\n  type: \"object\",\n  required: [\"name\", \"cron\", \"intervals\", \"nextRun\"],\n  properties: {\n    name: { type: \"string\" },\n    cron: nullableString,\n    intervals: { type: \"object\" },\n    nextRun: nullableString,\n  },\n};\n\nconst installedPackage = {\n  type: \"object\",\n  required: [\"name\", \"version\"],\n  properties: { name: { type: \"string\" }, version: { type: \"string\" } },\n};\n\nconst warning = {\n  type: \"object\",\n  required: [\"code\", \"message\", \"source\"],\n  properties: {\n    code: { oneOf: [{ type: \"string\", pattern: \"^WL[0-9]{4}$\" }, { type: \"null\" }] },\n    message: { type: \"string\" },\n    source: nullableString,\n  },\n};\n\n/** The report's JSON Schema, draft 2020-12. */\nexport const INSPECT_REPORT_JSON_SCHEMA: Record<string, unknown> = {\n  $schema: \"https://json-schema.org/draft/2020-12/schema\",\n  title: \"Warlock inspect report\",\n  description: \"Output of `warlock inspect --json`, schema version 1.\",\n  type: \"object\",\n  required: [\"schemaVersion\", \"generatedAt\", \"app\", \"sections\", \"components\", \"warnings\"],\n  properties: {\n    schemaVersion: { const: 1 },\n    generatedAt: { type: \"string\" },\n    app: {\n      type: \"object\",\n      required: [\"name\", \"version\", \"root\", \"node\", \"environment\", \"runtimeStrategy\"],\n      properties: {\n        name: nullableString,\n        version: nullableString,\n        root: { type: \"string\" },\n        node: { type: \"string\" },\n        environment: { type: \"string\" },\n        runtimeStrategy: { type: \"string\" },\n      },\n    },\n    sections: {\n      type: \"array\",\n      items: {\n        enum: [\n          \"routes\",\n          \"models\",\n          \"resources\",\n          \"config\",\n          \"events\",\n          \"pages\",\n          \"jobs\",\n          \"schedules\",\n          \"packages\",\n        ],\n      },\n    },\n    routes: { type: \"array\", items: route },\n    models: { type: \"array\", items: model },\n    resources: { type: \"array\", items: resource },\n    config: { type: \"array\", items: configKey },\n    events: { type: \"array\", items: event },\n    pages: { type: \"array\", items: page },\n    jobs: { type: \"array\", items: job },\n    schedules: { type: \"array\", items: schedule },\n    packages: { type: \"array\", items: installedPackage },\n    components: {\n      type: \"object\",\n      required: [\"schemas\"],\n      properties: {\n        schemas: { type: \"object\", additionalProperties: jsonSchema },\n      },\n    },\n    warnings: { type: \"array\", items: warning },\n  },\n};\n"],"mappings":";;;;;;;;;;AAUA,MAAM,iBAAiB,EAAE,MAAM,CAAC,UAAU,MAAM,EAAE;AAClD,MAAM,cAAc;CAAE,MAAM;CAAS,OAAO,EAAE,MAAM,SAAS;AAAE;AAC/D,MAAM,aAAa,EAAE,MAAM,SAAS;AAapC,MAAM,QAAQ;CACZ,MAAM;CACN,UAAU;EACR;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;CACA,YAAY;EACV,QAAQ,EAAE,MAAM,SAAS;EACzB,MAAM,EAAE,MAAM,SAAS;EACvB,MAAM;EACN,YAAY;EACZ,SAAS,EAAE,MAAM,SAAS;EAC1B,aAAa;EACb,QAAQ,EAAE,MAAM,UAAU;EAC1B,YAAY;EACZ,MAAM;GACJ,MAAM;GACN,UAAU;IAAC;IAAY;IAAW;GAAW;GAC7C,YAAY;IACV,UAAU,EAAE,MAAM,UAAU;IAC5B,SAAS;KAAE,MAAM;KAAS,OAAO,EA1CvC,OAAO,CACL,EAAE,OAAO,SAAS,GAClB;MACE,MAAM;MACN,UAAU,CAAC,QAAQ;MACnB,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,EAAE;KAC3C,CACF,EAmCgD;IAAE;IAC5C,WAAW;GACb;EACF;EACA,MAAM,EAAE,MAAM,UAAU;EACxB,WAAW;GACT,MAAM;GACN,UAAU;IAAC;IAAU;IAAO;GAAY;GACxC,YAAY;IACV,QAAQ,EAAE,MAAM;KAAC;KAAS;KAAU;IAAM,EAAE;IAC5C,KAAK,EAAE,OAAO;KAAC,EAAE,MAAM,SAAS;KAAG,EAAE,OAAO,UAAU;KAAG,EAAE,MAAM,OAAO;IAAC,EAAE;IAC3E,YAAY,EAAE,MAAM;KAAC;KAAU;KAAU;IAAM,EAAE;GACnD;EACF;EACA,SAAS;GACP,MAAM;GACN,UAAU;IAAC;IAAQ;IAAS;GAAc;GAC1C,YAAY;IACV,MAAM,EAAE,MAAM,UAAU;IACxB,OAAO,EAAE,MAAM,UAAU;IACzB,cAAc,EAAE,MAAM,UAAU;GAClC;EACF;EACA,SAAS;GACP,MAAM;GACN,UAAU;IAAC;IAAc;IAAQ;GAAkB;GACnD,YAAY;IACV,YAAY;KACV,MAAM;KACN,OAAO;MACL,MAAM;MACN,UAAU;OAAC;OAAQ;OAAM;OAAY;MAAQ;MAC7C,YAAY;OACV,MAAM,EAAE,MAAM,SAAS;OACvB,IAAI,EAAE,MAAM;QAAC;QAAQ;QAAS;QAAU;OAAQ,EAAE;OAClD,UAAU,EAAE,MAAM,UAAU;OAC5B,QAAQ;MACV;KACF;IACF;IACA,MAAM,EAAE,MAAM,CAAC,UAAU,MAAM,EAAE;IACjC,kBAAkB,EAAE,MAAM,UAAU;GACtC;EACF;EACA,WAAW;GACT,MAAM;GACN,sBAAsB;IACpB,MAAM;IACN,UAAU,CAAC,eAAe,QAAQ;IAClC,YAAY;KACV,aAAa,EAAE,MAAM,SAAS;KAC9B,QAAQ,EAAE,MAAM,CAAC,UAAU,MAAM,EAAE;IACrC;GACF;EACF;CACF;AACF;AAEA,MAAM,QAAQ;CACZ,MAAM;CACN,UAAU;EACR;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;CACA,YAAY;EACV,MAAM,EAAE,MAAM,SAAS;EACvB,OAAO;EACP,YAAY;EACZ,YAAY;EACZ,YAAY;EACZ,YAAY,EAAE,MAAM,UAAU;EAC9B,SAAS;GACP,MAAM;GACN,OAAO;IACL,MAAM;IACN,UAAU;KAAC;KAAQ;KAAY;IAAQ;IACvC,YAAY;KACV,MAAM,EAAE,MAAM,SAAS;KACvB,UAAU,EAAE,MAAM,UAAU;KAC5B,QAAQ;IACV;GACF;EACF;EACA,WAAW;GACT,MAAM;GACN,OAAO;IACL,MAAM;IACN,UAAU;KAAC;KAAQ;KAAQ;KAAS;KAAc;IAAU;IAC5D,YAAY;KACV,MAAM,EAAE,MAAM,SAAS;KACvB,MAAM,EAAE,MAAM,SAAS;KACvB,OAAO;KACP,YAAY;KACZ,UAAU;IACZ;GACF;EACF;EACA,UAAU;EACV,gBAAgB;EAChB,iBAAiB;EACjB,iBAAiB;EACjB,iBAAiB;CACnB;AACF;AAEA,MAAM,WAAW;CACf,MAAM;CACN,UAAU;EAAC;EAAQ;EAAU;CAAQ;CACrC,YAAY;EACV,MAAM,EAAE,MAAM,SAAS;EACvB,QAAQ;EACR,QAAQ;CACV;AACF;AAEA,MAAM,YAAY;CAChB,MAAM;CACN,UAAU;EAAC;EAAO;EAAQ;CAAM;CAChC,YAAY;EACV,KAAK,EAAE,MAAM,SAAS;EACtB,MAAM,EAAE,MAAM,SAAS;EACvB,MAAM;CACR;AACF;AAEA,MAAM,QAAQ;CACZ,MAAM;CACN,UAAU,CAAC,SAAS,WAAW;CAC/B,YAAY;EACV,OAAO,EAAE,MAAM,SAAS;EACxB,WAAW;GACT,MAAM;GACN,OAAO;IACL,MAAM;IACN,UAAU,CAAC,QAAQ,YAAY;IAC/B,YAAY;KAAE,MAAM,EAAE,MAAM,SAAS;KAAG,YAAY,EAAE,MAAM,SAAS;IAAE;GACzE;EACF;CACF;AACF;AAEA,MAAM,OAAO;CACX,MAAM;CACN,UAAU;EAAC;EAAQ;EAAQ;EAAQ;EAAW;EAAW;EAAW;CAAO;CAC3E,YAAY;EACV,MAAM,EAAE,MAAM,SAAS;EACvB,MAAM;EACN,MAAM,EAAE,MAAM,SAAS;EACvB,SAAS;EACT,SAAS;EACT,SAAS;EACT,OAAO;CACT;AACF;AAEA,MAAM,MAAM;CACV,MAAM;CACN,UAAU;EAAC;EAAQ;EAAS;EAAY;EAAW;EAAoB;CAAc;CACrF,YAAY;EACV,MAAM,EAAE,MAAM,SAAS;EACvB,OAAO,EAAE,MAAM,SAAS;EACxB,UAAU,EAAE,MAAM,CAAC,UAAU,MAAM,EAAE;EACrC,SAAS,EACP,OAAO;GACL,EAAE,MAAM,SAAS;GACjB,EAAE,MAAM,OAAO;GACf;IACE,MAAM;IACN,UAAU,CAAC,QAAQ,OAAO;IAC1B,YAAY;KAAE,MAAM,EAAE,MAAM,SAAS;KAAG,OAAO,EAAE,MAAM,SAAS;IAAE;GACpE;EACF,EACF;EACA,kBAAkB,EAAE,MAAM;GAAC;GAAW;GAAU;EAAM,EAAE;EACxD,cAAc,EAAE,MAAM;GAAC;GAAW;GAAU;EAAM,EAAE;CACtD;AACF;AAEA,MAAM,WAAW;CACf,MAAM;CACN,UAAU;EAAC;EAAQ;EAAQ;EAAa;CAAS;CACjD,YAAY;EACV,MAAM,EAAE,MAAM,SAAS;EACvB,MAAM;EACN,WAAW,EAAE,MAAM,SAAS;EAC5B,SAAS;CACX;AACF;AAEA,MAAM,mBAAmB;CACvB,MAAM;CACN,UAAU,CAAC,QAAQ,SAAS;CAC5B,YAAY;EAAE,MAAM,EAAE,MAAM,SAAS;EAAG,SAAS,EAAE,MAAM,SAAS;CAAE;AACtE;AAEA,MAAM,UAAU;CACd,MAAM;CACN,UAAU;EAAC;EAAQ;EAAW;CAAQ;CACtC,YAAY;EACV,MAAM,EAAE,OAAO,CAAC;GAAE,MAAM;GAAU,SAAS;EAAe,GAAG,EAAE,MAAM,OAAO,CAAC,EAAE;EAC/E,SAAS,EAAE,MAAM,SAAS;EAC1B,QAAQ;CACV;AACF;;AAGA,MAAa,6BAAsD;CACjE,SAAS;CACT,OAAO;CACP,aAAa;CACb,MAAM;CACN,UAAU;EAAC;EAAiB;EAAe;EAAO;EAAY;EAAc;CAAU;CACtF,YAAY;EACV,eAAe,EAAE,OAAO,EAAE;EAC1B,aAAa,EAAE,MAAM,SAAS;EAC9B,KAAK;GACH,MAAM;GACN,UAAU;IAAC;IAAQ;IAAW;IAAQ;IAAQ;IAAe;GAAiB;GAC9E,YAAY;IACV,MAAM;IACN,SAAS;IACT,MAAM,EAAE,MAAM,SAAS;IACvB,MAAM,EAAE,MAAM,SAAS;IACvB,aAAa,EAAE,MAAM,SAAS;IAC9B,iBAAiB,EAAE,MAAM,SAAS;GACpC;EACF;EACA,UAAU;GACR,MAAM;GACN,OAAO,EACL,MAAM;IACJ;IACA;IACA;IACA;IACA;IACA;IACA;IACA;IACA;GACF,EACF;EACF;EACA,QAAQ;GAAE,MAAM;GAAS,OAAO;EAAM;EACtC,QAAQ;GAAE,MAAM;GAAS,OAAO;EAAM;EACtC,WAAW;GAAE,MAAM;GAAS,OAAO;EAAS;EAC5C,QAAQ;GAAE,MAAM;GAAS,OAAO;EAAU;EAC1C,QAAQ;GAAE,MAAM;GAAS,OAAO;EAAM;EACtC,OAAO;GAAE,MAAM;GAAS,OAAO;EAAK;EACpC,MAAM;GAAE,MAAM;GAAS,OAAO;EAAI;EAClC,WAAW;GAAE,MAAM;GAAS,OAAO;EAAS;EAC5C,UAAU;GAAE,MAAM;GAAS,OAAO;EAAiB;EACnD,YAAY;GACV,MAAM;GACN,UAAU,CAAC,SAAS;GACpB,YAAY,EACV,SAAS;IAAE,MAAM;IAAU,sBAAsB;GAAW,EAC9D;EACF;EACA,UAAU;GAAE,MAAM;GAAS,OAAO;EAAQ;CAC5C;AACF"}

package/esm/tooling/inspect/inspect-report.types.d.mts

@@ -0,0 +1,196 @@
+import { WarlockErrorCode } from "../../errors/error-codes.mjs";
+
+//#region ../../packages/core/src/tooling/inspect/inspect-report.types.d.ts
+/**
+ * @fileoverview The `warlock inspect` report, schema version 1.
+ *
+ * STABILITY: within `schemaVersion: 1` fields are only ever ADDED. No field is
+ * removed, renamed or retyped, so a consumer written against this file keeps
+ * working on every later 5.x release. Consumers must ignore keys they do not
+ * know. A change that breaks that promise ships as `schemaVersion: 2` and is
+ * listed under BREAKING in the changelog. Free text (warning messages,
+ * descriptions) is not part of the contract.
+ *
+ * The same shape is published as JSON Schema (draft 2020-12) in
+ * `@warlock.js/core/schemas/inspect-report.schema.json` and as the
+ * `INSPECT_REPORT_JSON_SCHEMA` constant.
+ */
+/** The version of the report shape. Bumped only for a breaking change. */
+declare const INSPECT_SCHEMA_VERSION = 1;
+/** Every section the report can contain, in output order. */
+declare const INSPECT_SECTIONS: readonly ["routes", "models", "resources", "config", "events", "pages", "jobs", "schedules", "packages"];
+/** One section name. */
+type InspectSection = (typeof INSPECT_SECTIONS)[number];
+/** A JSON Schema (draft 2020-12) fragment. */
+type JsonSchema = Record<string, unknown>;
+/** Who guards a route, from the descriptor `authMiddleware()` attaches. */
+type InspectRouteAuth = {
+  /** Whether an auth guard runs on the route. */required: boolean; /** Where the token is read: `"header"` (bearer) or `{ cookie }`. */
+  sources: ("header" | {
+    cookie: string;
+  })[]; /** User types the guard accepts; empty means any. */
+  userTypes: string[];
+};
+/** The rate limit a route runs under. */
+type InspectRouteRateLimit = {
+  /** `route` = the route's own option, `global` = `http.rateLimit`, `none` = no limiter. */source: "route" | "global" | "none"; /** Max requests per window; `"dynamic"` when configured as a function. */
+  max: number | "dynamic" | null; /** Window in milliseconds, or the configured string (`"1 minute"`); `"dynamic"` for a function. */
+  timeWindow: number | string | null;
+};
+/** What the route's request log entries keep. */
+type InspectRouteLogging = {
+  /** Whether the request body is logged. */body: boolean; /** Whether the query string is logged. */
+  query: boolean; /** Whether `http.logging.private` rules exist that may remove more for some URLs. */
+  privateRules: boolean;
+};
+/** One request parameter (path, query or header). */
+type InspectParameter = {
+  name: string;
+  in: "path" | "query" | "header" | "cookie";
+  required: boolean;
+  schema: JsonSchema;
+};
+/** One registered HTTP route. */
+type InspectRoute = {
+  /** Uppercase method, `ALL` for `router.all`. */method: string;
+  path: string;
+  name: string | null; /** Project-relative file that registered the route. */
+  sourceFile: string | null; /** Handler function name, `"anonymous"` when it has none. */
+  handler: string;
+  description: string | null; /** Whether a page (SSR) route registered it. */
+  isPage: boolean; /** Middleware function names in run order. */
+  middleware: string[];
+  auth: InspectRouteAuth; /** `false` when the route opted out of the CSRF origin guard (`csrf: false`). */
+  csrf: boolean;
+  rateLimit: InspectRouteRateLimit;
+  logging: InspectRouteLogging;
+  request: {
+    parameters: InspectParameter[]; /** JSON Schema of the request body, or `null`. */
+    body: JsonSchema | null; /** Whether `validation.validate` (custom middleware, not described) is set. */
+    customValidation: boolean;
+  }; /** Declared responses keyed by status code. */
+  responses: Record<string, {
+    description: string;
+    schema: JsonSchema | null;
+  }>;
+};
+/** One model column, from the model's Seal `schema`. */
+type InspectModelColumn = {
+  name: string;
+  required: boolean;
+  schema: JsonSchema;
+};
+/** One model relation. */
+type InspectModelRelation = {
+  name: string;
+  type: string; /** Target model name, or `null` when it could not be resolved. */
+  model: string | null;
+  foreignKey: string | null;
+  localKey: string | null;
+};
+/** One model class. */
+type InspectModel = {
+  name: string;
+  table: string | null;
+  primaryKey: string | null; /** Data source name, when configured by name. */
+  dataSource: string | null;
+  sourceFile: string | null; /** Whether `@RegisterModel()` put it in the registry. */
+  registered: boolean;
+  columns: InspectModelColumn[];
+  relations: InspectModelRelation[]; /** Name of the model's `static resource`, a key of `components.schemas`. */
+  resource: string | null;
+  deleteStrategy: string | null;
+  createdAtColumn: string | null;
+  updatedAtColumn: string | null;
+  deletedAtColumn: string | null;
+};
+/** One resource class reached from a route or a model. */
+type InspectResource = {
+  name: string; /** Its output shape (JSON Schema; nested resources are `$ref`s into `components.schemas`). */
+  schema: JsonSchema; /** Models whose `static resource` is this resource. */
+  models: string[];
+};
+/** One config key: its path and value type. Values are never printed. */
+type InspectConfigKey = {
+  key: string; /** `string`, `number`, `boolean`, `null`, `array`, `object`, `function`, `regexp`, `date`, or a class name. */
+  type: string; /** The `src/config/*` file the top-level key comes from, when it exists. */
+  file: string | null;
+};
+/** One event and the listeners app modules registered for it. */
+type InspectEvent = {
+  event: string;
+  listeners: {
+    name: string;
+    sourceFile: string;
+  }[];
+};
+/** One page installed by `@warlock.js/web`. */
+type InspectPage = {
+  path: string;
+  name: string | null;
+  file: string; /** Layout files from the outermost to the page's own directory. */
+  layouts: string[]; /** Files on the chain (layouts, then the page) that export a `loader`. */
+  loaders: string[]; /** Action names the page exports (`"default"` for `action`). */
+  actions: string[]; /** `"user"` when the page or a layout statically requires a user. */
+  guard: string | null;
+};
+/** One queue job defined with `defineJob()`. */
+type InspectJob = {
+  name: string;
+  queue: string;
+  attempts: number | null;
+  backoff: number | {
+    type: string;
+    delay: number;
+  } | null;
+  removeOnComplete: boolean | number | null;
+  removeOnFail: boolean | number | null;
+};
+/** One scheduled task on the `@warlock.js/scheduler` scheduler. */
+type InspectSchedule = {
+  name: string;
+  cron: string | null;
+  intervals: Record<string, unknown>;
+  nextRun: string | null;
+};
+/** One installed `@warlock.js/*` package. */
+type InspectPackage = {
+  name: string;
+  version: string;
+};
+/** Something inspect could not read, with its code when one applies. */
+type InspectWarning = {
+  code: WarlockErrorCode | null;
+  message: string; /** The section or file it concerns. */
+  source: string | null;
+};
+/** The whole report. Sections not requested are absent. */
+type InspectReport = {
+  schemaVersion: typeof INSPECT_SCHEMA_VERSION;
+  generatedAt: string;
+  app: {
+    name: string | null;
+    version: string | null; /** Absolute project root. */
+    root: string;
+    node: string;
+    environment: string;
+    runtimeStrategy: string;
+  }; /** The sections this report contains. */
+  sections: InspectSection[];
+  routes?: InspectRoute[];
+  models?: InspectModel[];
+  resources?: InspectResource[];
+  config?: InspectConfigKey[];
+  events?: InspectEvent[];
+  pages?: InspectPage[];
+  jobs?: InspectJob[];
+  schedules?: InspectSchedule[];
+  packages?: InspectPackage[]; /** Shared schemas that `$ref`s point at (`#/components/schemas/<name>`). */
+  components: {
+    schemas: Record<string, JsonSchema>;
+  };
+  warnings: InspectWarning[];
+};
+//#endregion
+export { INSPECT_SCHEMA_VERSION, INSPECT_SECTIONS, InspectConfigKey, InspectEvent, InspectJob, InspectModel, InspectModelColumn, InspectModelRelation, InspectPackage, InspectPage, InspectParameter, InspectReport, InspectResource, InspectRoute, InspectRouteAuth, InspectRouteLogging, InspectRouteRateLimit, InspectSchedule, InspectSection, InspectWarning, JsonSchema };
+//# sourceMappingURL=inspect-report.types.d.mts.map

package/esm/tooling/inspect/inspect-report.types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspect-report.types.d.mts","names":[],"sources":["../../../../../../../../../packages/core/src/tooling/inspect/inspect-report.types.ts"],"mappings":";;;;;AAkBA;;;;AAAmC;AAGnC;;;;AAUU;AAGV;;;cAhBa,sBAAA;AAgBwC;AAAA,cAbxC,gBAAA;;KAaD,cAAA,WAAyB,gBAAgB;;KAGzC,UAAA,GAAa,MAAM;AAG/B;AAAA,KAAY,gBAAA;iDAEV,QAAA;EAEA,OAAA;IAAuB,MAAA;EAAA,MAEd;EAAT,SAAA;AAAA;;KAIU,qBAAA;EAAqB,0FAE/B,MAAA,+BAEA;EAAA,GAAA,6BAEU;EAAV,UAAA;AAAA;;KAIU,mBAAA;EAAmB,0CAE7B,IAAA,WAEA;EAAA,KAAA,WAEY;EAAZ,YAAA;AAAA;;KAIU,gBAAA;EACV,IAAA;EACA,EAAA;EACA,QAAA;EACA,MAAA,EAAQ,UAAU;AAAA;;KAIR,YAAA;EAJQ,gDAMlB,MAAA;EACA,IAAA;EACA,IAAA,iBAUM;EARN,UAAA,iBAYS;EAVT,OAAA;EACA,WAAA,iBAkByD;EAhBzD,MAAA,WAgBiB;EAdjB,UAAA;EACA,IAAA,EAAM,gBAAA,EAXN;EAaA,IAAA;EACA,SAAA,EAAW,qBAAA;EACX,OAAA,EAAS,mBAAA;EACT,OAAA;IACE,UAAA,EAAY,gBAAA,IAPd;IASE,IAAA,EAAM,UAAA,SARF;IAUJ,gBAAA;EAAA,GAPS;EAUX,SAAA,EAAW,MAAA;IAAiB,WAAA;IAAqB,MAAA,EAAQ,UAAA;EAAA;AAAA;;KAI/C,kBAAA;EACV,IAAA;EACA,QAAA;EACA,MAAA,EAAQ,UAAU;AAAA;;KAIR,oBAAA;EACV,IAAA;EACA,IAAA,UATU;EAWV,KAAA;EACA,UAAA;EACA,QAAA;AAAA;;KAIU,YAAA;EACV,IAAA;EACA,KAAA;EACA,UAAA,iBAbU;EAeV,UAAA;EACA,UAAA,iBAhB8B;EAkB9B,UAAA;EACA,OAAA,EAAS,kBAAA;EACT,SAAA,EAAW,oBAAoB,IAf/B;EAiBA,QAAA;EACA,cAAA;EACA,eAAA;EACA,eAAA;EACA,eAAA;AAAA;;KAIU,eAAA;EACV,IAAA,UAlBA;EAoBA,MAAA,EAAQ,UAAU,EAjBlB;EAmBA,MAAA;AAAA;;KAIU,gBAAA;EACV,GAAA,UAlBA;EAoBA,IAAA,UAlBA;EAoBA,IAAA;AAAA;;KAIU,YAAA;EACV,KAAA;EACA,SAAA;IAAa,IAAA;IAAc,UAAA;EAAA;AAAA;;KAIjB,WAAA;EACV,IAAA;EACA,IAAA;EACA,IAAA,UAlB0B;EAoB1B,OAAA,YApB0B;EAsB1B,OAAA,YAnBA;EAqBA,OAAA,YAnBI;EAqBJ,KAAA;AAAA;;KAIU,UAAA;EACV,IAAA;EACA,KAAA;EACA,QAAA;EACA,OAAA;IAAoB,IAAA;IAAc,KAAA;EAAA;EAClC,gBAAA;EACA,YAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EACA,IAAA;EACA,SAAA,EAAW,MAAM;EACjB,OAAA;AAAA;;KAIU,cAAA;EACV,IAAA;EACA,OAAO;AAAA;;KAIG,cAAA;EACV,IAAA,EAAM,gBAAgB;EACtB,OAAA,UAvBA;EAyBA,MAAA;AAAA;;KAIU,aAAA;EACV,aAAA,SAAsB,sBAAA;EACtB,WAAA;EACA,GAAA;IACE,IAAA;IACA,OAAA,iBAxBS;IA0BT,IAAA;IACA,IAAA;IACA,WAAA;IACA,eAAA;EAAA,GA5BF;EA+BA,QAAA,EAAU,cAAA;EACV,MAAA,GAAS,YAAA;EACT,MAAA,GAAS,YAAA;EACT,SAAA,GAAY,eAAA;EACZ,MAAA,GAAS,gBAAA;EACT,MAAA,GAAS,YAAA;EACT,KAAA,GAAQ,WAAA;EACR,IAAA,GAAO,UAAA;EACP,SAAA,GAAY,eAAA;EACZ,QAAA,GAAW,cAAA,IA7BW;EA+BtB,UAAA;IAAc,OAAA,EAAS,MAAA,SAAe,UAAA;EAAA;EACtC,QAAA,EAAU,cAAA;AAAA"}