@spinajs/orm 2.0.490 → 2.0.494

package/lib/mjs/schema-providers.d.ts

@@ -1,5 +1,6 @@
 import { Class } from '@spinajs/di';
 import { SchemaProvider } from '@spinajs/validation';
+import { IModelDescriptor } from './interfaces.js';
 /**
  * Resolves an ORM model name to its column schema plus relations. A name → model
  * class map is built once at initialization (see `resolve`) and reused on every
@@ -9,5 +10,38 @@ export declare class ModelSchemaProvider extends SchemaProvider {
     protected Models: Map<string, Class<unknown>>;
     resolve(): void;
     getSchema(typeName: string): Record<string, unknown> | undefined;
+    /**
+     * The same set of columns as `getSchema`, but WITHOUT `required`, without the `@Hidden()`
+     * columns, and with the types this driver really returns (`descriptor.ResponseSchema`).
+     *
+     * A response is partial by nature: `dehydrateWithRelations({ skipUndefined: true })` drops
+     * fields the query did not load, and `include` decides which relations show up at all. The
+     * list of required columns describes an INSERT, not what goes out to the client - published
+     * on a response it breaks validation on the first row that has no password or no relation.
+     *
+     * @param typeName - the model class name
+     */
+    getResponseSchema(typeName: string): Record<string, unknown> | undefined;
+    /**
+     * The model's columns plus its relations as properties. `includeRequired` distinguishes
+     * the write contract (getSchema) from the read one (getResponseSchema).
+     *
+     * @param typeName - the model class name
+     * @param includeRequired - whether to include the list of required columns (write contract)
+     */
+    protected buildSchema(typeName: string, includeRequired: boolean): Record<string, unknown> | undefined;
+    /**
+     * The read schema off the descriptor. `Orm.reloadTableInfo` builds it alongside `Schema`;
+     * when it is absent (the model never got a connection, or the descriptor was assembled by
+     * hand in a test) we fall back to `Schema` and strip from it what a response never carries
+     * anyway - the `@Hidden()` columns. Describing a read with the write contract beats not
+     * describing it at all.
+     *
+     * @param descriptor - the model descriptor
+     */
+    protected responseColumns(descriptor: IModelDescriptor | undefined): {
+        properties?: Record<string, unknown>;
+        required?: string[];
+    } | undefined;
 }
 //# sourceMappingURL=schema-providers.d.ts.map

package/lib/mjs/schema-providers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-providers.d.ts","sourceRoot":"","sources":["../../src/schema-providers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAkB,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAKrD;;;;GAIG;AACH,qBACa,mBAAoB,SAAQ,cAAc;IACrD,SAAS,CAAC,MAAM,8BAAqC;IAE9C,OAAO,IAAI,IAAI;IAMf,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;CAiCxE"}
+{"version":3,"file":"schema-providers.d.ts","sourceRoot":"","sources":["../../src/schema-providers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAkB,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAInD;;;;GAIG;AACH,qBACa,mBAAoB,SAAQ,cAAc;IACrD,SAAS,CAAC,MAAM,8BAAqC;IAE9C,OAAO,IAAI,IAAI;IAMf,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAIvE;;;;;;;;;;OAUG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAI/E;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IA0CtG;;;;;;;;OAQG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,gBAAgB,GAAG,SAAS,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,SAAS;CAmB/I"}

package/lib/mjs/schema-providers.js

@@ -23,6 +23,30 @@ let ModelSchemaProvider = class ModelSchemaProvider extends SchemaProvider {
         }
     }
     getSchema(typeName) {
+        return this.buildSchema(typeName, true);
+    }
+    /**
+     * The same set of columns as `getSchema`, but WITHOUT `required`, without the `@Hidden()`
+     * columns, and with the types this driver really returns (`descriptor.ResponseSchema`).
+     *
+     * A response is partial by nature: `dehydrateWithRelations({ skipUndefined: true })` drops
+     * fields the query did not load, and `include` decides which relations show up at all. The
+     * list of required columns describes an INSERT, not what goes out to the client - published
+     * on a response it breaks validation on the first row that has no password or no relation.
+     *
+     * @param typeName - the model class name
+     */
+    getResponseSchema(typeName) {
+        return this.buildSchema(typeName, false);
+    }
+    /**
+     * The model's columns plus its relations as properties. `includeRequired` distinguishes
+     * the write contract (getSchema) from the read one (getResponseSchema).
+     *
+     * @param typeName - the model class name
+     * @param includeRequired - whether to include the list of required columns (write contract)
+     */
+    buildSchema(typeName, includeRequired) {
         const model = this.Models.get(typeName);
         if (!model) {
             return undefined;
@@ -32,14 +56,21 @@ let ModelSchemaProvider = class ModelSchemaProvider extends SchemaProvider {
          * to get proper descriptor from prototype chain
          */
         const descriptor = model.getModelDescriptor();
-        const columns = descriptor?.Schema;
+        const columns = includeRequired ? descriptor?.Schema : this.responseColumns(descriptor);
         if (!columns || !columns.properties) {
             return undefined;
         }
+        // `@Hidden()` marks properties, not just columns - a hidden relation is dropped by
+        // `dehydrateWithRelations` exactly like a hidden column, so a read schema must not
+        // advertise it either. Columns are already filtered upstream (`buildModelJsonSchema`
+        // for `ResponseSchema`, `responseColumns` for the fallback); relations are added here,
+        // so they have to be filtered here. The write contract keeps them: a client may well
+        // send a relation the API never hands back.
+        const hiddenRelations = includeRequired ? new Set() : new Set(descriptor?.Hidden ?? []);
         const properties = { ...columns.properties };
         descriptor?.Relations?.forEach((relation, relationName) => {
             const target = relation?.TargetModel?.name;
-            if (!target) {
+            if (!target || hiddenRelations.has(relationName)) {
                 return;
             }
             const ref = { type: 'object', description: target };
@@ -47,11 +78,36 @@ let ModelSchemaProvider = class ModelSchemaProvider extends SchemaProvider {
                 relation.Type !== undefined && TO_MANY_RELATION.has(relation.Type) ? { type: 'array', items: ref } : ref;
         });
         const schema = { type: 'object', properties };
-        if (columns.required && columns.required.length > 0) {
+        if (includeRequired && columns.required && columns.required.length > 0) {
             schema.required = columns.required;
         }
         return schema;
     }
+    /**
+     * The read schema off the descriptor. `Orm.reloadTableInfo` builds it alongside `Schema`;
+     * when it is absent (the model never got a connection, or the descriptor was assembled by
+     * hand in a test) we fall back to `Schema` and strip from it what a response never carries
+     * anyway - the `@Hidden()` columns. Describing a read with the write contract beats not
+     * describing it at all.
+     *
+     * @param descriptor - the model descriptor
+     */
+    responseColumns(descriptor) {
+        const response = descriptor?.ResponseSchema;
+        if (response?.properties) {
+            return response;
+        }
+        const write = descriptor?.Schema;
+        if (!write?.properties) {
+            return undefined;
+        }
+        const hidden = new Set(descriptor?.Hidden ?? []);
+        if (hidden.size === 0) {
+            return write;
+        }
+        const properties = Object.fromEntries(Object.entries(write.properties).filter(([name]) => !hidden.has(name)));
+        return { properties };
+    }
 };
 ModelSchemaProvider = __decorate([
     Injectable(SchemaProvider)

package/lib/mjs/schema-providers.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema-providers.js","sourceRoot":"","sources":["../../src/schema-providers.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAS,EAAE,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEjD;;;;GAIG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,cAAc;IAAhD;;QACK,WAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IAyCvD,CAAC;IAvCQ,OAAO;QACZ,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAuB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAEM,SAAS,CAAC,QAAgB;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED;;;WAGG;QACH,MAAM,UAAU,GAAI,KAAa,CAAC,kBAAkB,EAAkC,CAAC;QACvF,MAAM,OAAO,GAAG,UAAU,EAAE,MAAM,CAAC;QACnC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,UAAU,GAA4B,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE;YACxD,MAAM,MAAM,GAAG,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC;YAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;YACpD,UAAU,CAAC,YAAY,CAAC;gBACtB,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC7G,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAA4B,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvE,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAA;AA1CY,mBAAmB;IAD/B,UAAU,CAAC,cAAc,CAAC;GACd,mBAAmB,CA0C/B"}
+{"version":3,"file":"schema-providers.js","sourceRoot":"","sources":["../../src/schema-providers.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAS,EAAE,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEjD;;;;GAIG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAoB,SAAQ,cAAc;IAAhD;;QACK,WAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;IAwGvD,CAAC;IAtGQ,OAAO;QACZ,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAuB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAEM,SAAS,CAAC,QAAgB;QAC/B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IACI,iBAAiB,CAAC,QAAgB;QACvC,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CAAC,QAAgB,EAAE,eAAwB;QAC9D,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED;;;WAGG;QACH,MAAM,UAAU,GAAI,KAAa,CAAC,kBAAkB,EAAkC,CAAC;QACvF,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,mFAAmF;QACnF,mFAAmF;QACnF,qFAAqF;QACrF,uFAAuF;QACvF,qFAAqF;QACrF,4CAA4C;QAC5C,MAAM,eAAe,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,GAAG,EAAU,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QAEhG,MAAM,UAAU,GAA4B,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;QACtE,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE;YACxD,MAAM,MAAM,GAAG,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC;YAC3C,IAAI,CAAC,MAAM,IAAI,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBACjD,OAAO;YACT,CAAC;YACD,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;YACpD,UAAU,CAAC,YAAY,CAAC;gBACtB,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC7G,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAA4B,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvE,IAAI,eAAe,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACO,eAAe,CAAC,UAAwC;QAChE,MAAM,QAAQ,GAAG,UAAU,EAAE,cAAc,CAAC;QAC5C,IAAI,QAAQ,EAAE,UAAU,EAAE,CAAC;YACzB,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,EAAE,MAAM,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC;QACjD,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAqC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzI,OAAO,EAAE,UAAU,EAAE,CAAC;IACxB,CAAC;CACF,CAAA;AAzGY,mBAAmB;IAD/B,UAAU,CAAC,cAAc,CAAC;GACd,mBAAmB,CAyG/B"}

package/lib/mjs/schema.d.ts

@@ -1,7 +1,24 @@
 import { IModelDescriptor } from './interfaces.js';
 /**
- * Builds a JSON schema from a model's columns, stored on `descriptor.Schema` at model load.
- * `Ignore` columns are excluded and relations are omitted.
+ * Which side of the wire a model schema describes. `request` is what a client may SEND
+ * ( the model used as `@Body()` ), `response` is what the API hands BACK.
  */
-export declare function buildModelJsonSchema(descriptor: IModelDescriptor): any;
+export type ModelSchemaKind = 'request' | 'response';
+/**
+ * Builds a JSON schema from a model's columns, stored on `descriptor.Schema` /
+ * `descriptor.ResponseSchema` at model load. `Ignore` columns are excluded and relations
+ * are omitted.
+ *
+ * The two flavours differ in three ways, all of them facts about what a response IS:
+ *   - `descriptor.Hidden` ( the model's `@Hidden()` properties ) is dropped: `dehydrate()` and
+ *     `dehydrateWithRelations()` omit those columns unconditionally, so no response can
+ *     ever carry them - rbac's User hides `Password`,
+ *   - the driver may override a type it returns differently from what it accepts,
+ *   - nothing is `required`: a response is partial by construction ( `skipUndefined`
+ *     drops columns the query did not select ).
+ *
+ * @param descriptor - the model descriptor to describe
+ * @param kind - which contract to build, defaults to the write one
+ */
+export declare function buildModelJsonSchema(descriptor: IModelDescriptor, kind?: ModelSchemaKind): any;
 //# sourceMappingURL=schema.d.ts.map

package/lib/mjs/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAqBtE;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,GAAG,GAAG,CAmBtE"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AACA,OAAO,EAAqB,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AA0CtE;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,UAAU,CAAC;AAErD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,EAAE,IAAI,GAAE,eAA2B,GAAG,GAAG,CAqBzG"}

package/lib/mjs/schema.js

@@ -1,5 +1,24 @@
 import { ColumnType } from './enums.js';
-/** SQL column type → JSON-schema shape; unlisted types fall back to `string`. */
+/**
+ * SQL column type → JSON-schema shape; unlisted types fall back to `string`.
+ *
+ * The keys must be the strings a DRIVER puts in `IColumnDescriptor.Type`. Every driver
+ * stores the column's own `DATA_TYPE` verbatim ( see orm-mysql / orm-mssql `tableInfo` ),
+ * so a `ColumnType` member whose value does not spell the SQL type exactly the way the
+ * database reports it will never match, and the column silently falls back to `string`.
+ * That is why 'datetime' sits here next to `ColumnType.DATE_TIME` ( = 'dateTime' ), which
+ * neither MySQL nor MSSQL ever emits.
+ *
+ * Known remaining mismatches with mysql2's real output, left alone on purpose - correcting
+ * them changes an already-published schema for columns nobody has complained about:
+ *   - `bit` arrives as a Buffer, not a number,
+ *   - `set` arrives as a comma-separated string unless SetValueConverter is attached,
+ *   - `blob` / `binary` / `varbinary` arrive as Buffers and fall through to `string`.
+ *
+ * The values here are what a client may SEND. Where the driver hands something else BACK -
+ * mysql2's stringified DECIMAL - that driver says so through `OrmDriver.ResponseSchemaTypes`
+ * rather than bending this shared map, which every driver reads.
+ */
 const SQL_TYPE_TO_SCHEMA = {
     [ColumnType.TINY_INTEGER]: { type: 'integer' },
     [ColumnType.SMALL_INTEGER]: { type: 'integer' },
@@ -13,39 +32,70 @@ const SQL_TYPE_TO_SCHEMA = {
     [ColumnType.BOOLEAN]: { type: 'boolean' },
     [ColumnType.DATE]: { type: 'string', format: 'date' },
     [ColumnType.DATE_TIME]: { type: 'string', format: 'date-time' },
+    // MySQL and MSSQL both report DATETIME as 'datetime'; ColumnType.DATE_TIME above never matches.
+    datetime: { type: 'string', format: 'date-time' },
     [ColumnType.TIMESTAMP]: { type: 'string', format: 'date-time' },
     [ColumnType.JSON]: { type: 'object' },
     [ColumnType.SET]: { type: 'array', items: { type: 'string' } },
 };
 /**
- * Builds a JSON schema from a model's columns, stored on `descriptor.Schema` at model load.
- * `Ignore` columns are excluded and relations are omitted.
+ * Builds a JSON schema from a model's columns, stored on `descriptor.Schema` /
+ * `descriptor.ResponseSchema` at model load. `Ignore` columns are excluded and relations
+ * are omitted.
+ *
+ * The two flavours differ in three ways, all of them facts about what a response IS:
+ *   - `descriptor.Hidden` ( the model's `@Hidden()` properties ) is dropped: `dehydrate()` and
+ *     `dehydrateWithRelations()` omit those columns unconditionally, so no response can
+ *     ever carry them - rbac's User hides `Password`,
+ *   - the driver may override a type it returns differently from what it accepts,
+ *   - nothing is `required`: a response is partial by construction ( `skipUndefined`
+ *     drops columns the query did not select ).
+ *
+ * @param descriptor - the model descriptor to describe
+ * @param kind - which contract to build, defaults to the write one
  */
-export function buildModelJsonSchema(descriptor) {
+export function buildModelJsonSchema(descriptor, kind = 'request') {
     const properties = {};
     const required = [];
+    const hidden = kind === 'response' ? new Set(descriptor.Hidden ?? []) : new Set();
+    const overrides = kind === 'response' ? driverResponseTypes(descriptor) : {};
     for (const col of descriptor.Columns ?? []) {
-        if (!col || col.Ignore || !col.Name) {
+        if (!col || col.Ignore || !col.Name || hidden.has(col.Name)) {
             continue;
         }
-        properties[col.Name] = columnToSchema(col);
+        properties[col.Name] = columnToSchema(col, overrides);
         if (!col.Nullable && !col.AutoIncrement) {
             required.push(col.Name);
         }
     }
     const schema = { type: 'object', properties };
-    if (required.length > 0) {
+    if (kind === 'request' && required.length > 0) {
         schema.required = required;
     }
     return schema;
 }
+/**
+ * Per-SQL-type response overrides declared by the driver this model is bound to, or an
+ * empty map for a model with no connection yet ( then the shared defaults stand ).
+ *
+ * Read structurally rather than through the OrmDriver type: this module is imported by
+ * the descriptor building path and must not pull the driver module in with it.
+ *
+ * @param descriptor - the model descriptor whose driver is asked
+ */
+function driverResponseTypes(descriptor) {
+    return descriptor.Driver?.ResponseSchemaTypes ?? {};
+}
 /**
  * Maps a column descriptor to a JSON-schema property based on its SQL type.
  * Adds `maxLength`, `description` and `nullable` when the column has them.
+ *
+ * @param col - column to describe
+ * @param overrides - per-type shapes that win over the shared map ( response flavour only )
  */
-function columnToSchema(col) {
+function columnToSchema(col, overrides = {}) {
     const converter = col.Converter?.constructor?.name;
-    const schema = { ...(SQL_TYPE_TO_SCHEMA[col.Type] ?? { type: 'string' }) };
+    const schema = { ...(overrides[col.Type] ?? SQL_TYPE_TO_SCHEMA[col.Type] ?? { type: 'string' }) };
     if (converter === 'BooleanValueConverter') {
         schema.type = 'boolean';
         delete schema.format;

package/lib/mjs/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGxC,iFAAiF;AACjF,MAAM,kBAAkB,GAAwB;IAC9C,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC9C,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC/C,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAChD,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IACzC,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC7C,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACtC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACvC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACpC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IACzC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;IACrD,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;IAC/D,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;IAC/D,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;CAC/D,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAA4B;IAC/D,MAAM,UAAU,GAAwB,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACpC,SAAS;QACX,CAAC;QACD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACnD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CAAC,GAAsB;IAC5C,MAAM,SAAS,GAAI,GAAG,CAAC,SAAoE,EAAE,WAAW,EAAE,IAAI,CAAC;IAE/G,MAAM,MAAM,GAAQ,EAAE,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAEhF,IAAI,SAAS,KAAK,uBAAuB,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,GAAG,SAAS,CAAC;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGxC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,kBAAkB,GAAwB;IAC9C,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC9C,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC/C,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAChD,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IACzC,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IAC7C,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACxC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACtC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACvC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACpC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;IACzC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;IACrD,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;IAC/D,gGAAgG;IAChG,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;IACjD,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;IAC/D,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;IACrC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;CAC/D,CAAC;AAQF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAA4B,EAAE,OAAwB,SAAS;IAClG,MAAM,UAAU,GAAwB,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,EAAU,CAAC;IAC1F,MAAM,SAAS,GAAG,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAE7E,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5D,SAAS;QACX,CAAC;QACD,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IACnD,IAAI,IAAI,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9C,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,mBAAmB,CAAC,UAA4B;IACvD,OAAQ,UAAU,CAAC,MAA2E,EAAE,mBAAmB,IAAI,EAAE,CAAC;AAC5H,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,GAAsB,EAAE,YAAiC,EAAE;IACjF,MAAM,SAAS,GAAI,GAAG,CAAC,SAAoE,EAAE,WAAW,EAAE,IAAI,CAAC;IAE/G,MAAM,MAAM,GAAQ,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAEvG,IAAI,SAAS,KAAK,uBAAuB,EAAE,CAAC;QAC1C,MAAM,CAAC,IAAI,GAAG,SAAS,CAAC;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QACjB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}