metal-orm 1.1.10 → 1.1.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +758 -769
- package/dist/index.cjs +106 -43
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +5 -5
- package/dist/index.d.ts +5 -5
- package/dist/index.js +106 -43
- package/dist/index.js.map +1 -1
- package/package.json +100 -96
- package/scripts/generate-entities/render.mjs +21 -12
- package/scripts/generate-entities/schema.mjs +209 -195
- package/scripts/generate-entities/tree-detection.mjs +159 -153
- package/scripts/inflection/pt-br.mjs +468 -468
- package/scripts/run-eslint.mjs +33 -34
- package/scripts/show-sql-seed.sql +102 -0
- package/scripts/show-sql.mjs +321 -325
- package/src/bulk/bulk-delete-executor.ts +3 -5
- package/src/bulk/bulk-insert-executor.ts +7 -7
- package/src/bulk/bulk-update-executor.ts +2 -2
- package/src/bulk/bulk-upsert-executor.ts +5 -7
- package/src/codegen/naming-strategy.ts +54 -54
- package/src/codegen/typescript.ts +482 -482
- package/src/core/ast/adapters.ts +1 -1
- package/src/core/ast/builders.ts +123 -123
- package/src/core/ast/expression-builders.ts +745 -745
- package/src/core/ast/expression-nodes.ts +304 -304
- package/src/core/ast/expression-visitor.ts +212 -212
- package/src/core/ast/expression.ts +20 -20
- package/src/core/ast/helpers.ts +14 -14
- package/src/core/ast/join.ts +18 -18
- package/src/core/ast/query.ts +200 -200
- package/src/core/ddl/dialects/base-schema-dialect.ts +1 -1
- package/src/core/ddl/dialects/mssql-schema-dialect.ts +1 -1
- package/src/core/ddl/dialects/mysql-schema-dialect.ts +1 -1
- package/src/core/ddl/dialects/postgres-schema-dialect.ts +1 -1
- package/src/core/ddl/dialects/render-reference.test.ts +70 -70
- package/src/core/ddl/dialects/sqlite-schema-dialect.ts +1 -1
- package/src/core/ddl/introspect/catalogs/index.ts +5 -5
- package/src/core/ddl/introspect/catalogs/postgres.ts +146 -146
- package/src/core/ddl/introspect/context.ts +15 -15
- package/src/core/ddl/introspect/functions/postgres.ts +35 -35
- package/src/core/ddl/introspect/mysql.ts +113 -36
- package/src/core/ddl/introspect/registry.ts +40 -40
- package/src/core/ddl/introspect/run-select.ts +35 -35
- package/src/core/ddl/introspect/utils.ts +56 -56
- package/src/core/ddl/naming-strategy.ts +16 -16
- package/src/core/ddl/schema-dialect.ts +56 -56
- package/src/core/ddl/schema-diff.ts +234 -234
- package/src/core/ddl/schema-generator.ts +1 -1
- package/src/core/ddl/schema-introspect.ts +25 -25
- package/src/core/ddl/sql-writing.ts +171 -171
- package/src/core/dialect/abstract.ts +541 -541
- package/src/core/dialect/base/cte-compiler.ts +33 -33
- package/src/core/dialect/base/function-table-formatter.ts +103 -103
- package/src/core/dialect/base/groupby-compiler.ts +21 -21
- package/src/core/dialect/base/join-compiler.ts +25 -25
- package/src/core/dialect/base/orderby-compiler.ts +35 -35
- package/src/core/dialect/base/pagination-strategy.ts +32 -32
- package/src/core/dialect/base/returning-strategy.ts +57 -57
- package/src/core/dialect/base/sql-dialect.ts +294 -294
- package/src/core/dialect/dialect-factory.ts +91 -91
- package/src/core/dialect/mssql/functions.ts +120 -120
- package/src/core/dialect/mssql/index.ts +317 -317
- package/src/core/dialect/mysql/functions.ts +103 -103
- package/src/core/dialect/mysql/index.ts +105 -105
- package/src/core/dialect/postgres/functions.ts +108 -108
- package/src/core/dialect/postgres/index.ts +91 -91
- package/src/core/dialect/sqlite/functions.ts +129 -129
- package/src/core/dialect/sqlite/index.ts +67 -67
- package/src/core/driver/database-driver.ts +19 -19
- package/src/core/driver/mssql-driver.ts +23 -23
- package/src/core/driver/mysql-driver.ts +23 -23
- package/src/core/driver/postgres-driver.ts +23 -23
- package/src/core/driver/sqlite-driver.ts +23 -23
- package/src/core/execution/db-executor.ts +92 -92
- package/src/core/execution/executors/better-sqlite3-executor.ts +94 -94
- package/src/core/execution/executors/mssql-executor.ts +184 -184
- package/src/core/execution/executors/mysql-executor.ts +88 -88
- package/src/core/execution/executors/postgres-executor.ts +26 -26
- package/src/core/execution/executors/sqlite-executor.ts +42 -42
- package/src/core/execution/pooling/pool-types.ts +30 -30
- package/src/core/execution/pooling/pool.ts +275 -275
- package/src/core/functions/array.ts +35 -35
- package/src/core/functions/control-flow.ts +79 -79
- package/src/core/functions/datetime.ts +237 -237
- package/src/core/functions/json.ts +70 -70
- package/src/core/functions/numeric.ts +297 -297
- package/src/core/functions/text.ts +334 -334
- package/src/core/functions/types.ts +33 -33
- package/src/core/hydration/types.ts +51 -51
- package/src/core/sql/sql-operator-config.ts +39 -39
- package/src/core/sql/sql.ts +152 -152
- package/src/decorators/column-decorator.ts +87 -87
- package/src/decorators/decorator-metadata.ts +143 -143
- package/src/decorators/entity.ts +93 -93
- package/src/decorators/index.ts +39 -39
- package/src/decorators/relations.ts +231 -231
- package/src/decorators/transformers/built-in/string-transformers.ts +231 -231
- package/src/decorators/transformers/transformer-decorators.ts +134 -134
- package/src/decorators/transformers/transformer-executor.ts +171 -171
- package/src/decorators/transformers/transformer-metadata.ts +73 -73
- package/src/decorators/validators/built-in/br-cep-validator.ts +55 -55
- package/src/decorators/validators/built-in/br-cnpj-validator.ts +105 -105
- package/src/decorators/validators/built-in/br-cpf-validator.ts +103 -103
- package/src/decorators/validators/country-validator-registry.ts +64 -64
- package/src/decorators/validators/country-validators-decorators.ts +203 -203
- package/src/decorators/validators/country-validators.ts +105 -105
- package/src/decorators/validators/validator-metadata.ts +59 -59
- package/src/dto/dto-types.ts +226 -226
- package/src/dto/filter-types.ts +141 -141
- package/src/dto/index.ts +95 -95
- package/src/dto/openapi/generators/base.ts +29 -29
- package/src/dto/openapi/generators/column.ts +37 -37
- package/src/dto/openapi/generators/dto.ts +91 -91
- package/src/dto/openapi/generators/filter.ts +75 -75
- package/src/dto/openapi/generators/nested-dto.ts +618 -618
- package/src/dto/openapi/generators/pagination.ts +111 -111
- package/src/dto/openapi/generators/relation-filter.ts +228 -228
- package/src/dto/openapi/index.ts +12 -12
- package/src/dto/openapi/types.ts +101 -101
- package/src/dto/openapi/utilities.ts +95 -95
- package/src/dto/pagination-utils.ts +150 -150
- package/src/dto/transform.ts +197 -197
- package/src/index.ts +86 -86
- package/src/orm/als.ts +58 -58
- package/src/orm/domain-event-bus.ts +119 -119
- package/src/orm/entity-context.ts +86 -86
- package/src/orm/entity-materializer.ts +159 -159
- package/src/orm/entity-meta.ts +97 -97
- package/src/orm/entity-registry.ts +39 -39
- package/src/orm/entity-relation-cache.ts +39 -39
- package/src/orm/execute.ts +194 -194
- package/src/orm/execution-context.ts +18 -18
- package/src/orm/hydration-context.ts +26 -26
- package/src/orm/hydration.ts +112 -112
- package/src/orm/identity-map.ts +61 -61
- package/src/orm/interceptor-pipeline.ts +16 -16
- package/src/orm/lazy-batch/belongs-to-many.ts +119 -119
- package/src/orm/lazy-batch/belongs-to.ts +108 -108
- package/src/orm/lazy-batch/has-many.ts +69 -69
- package/src/orm/lazy-batch/has-one.ts +68 -68
- package/src/orm/lazy-batch/shared.ts +125 -125
- package/src/orm/orm-session.ts +620 -620
- package/src/orm/orm.ts +34 -34
- package/src/orm/pooled-executor-factory.ts +121 -121
- package/src/orm/query-logger.ts +40 -40
- package/src/orm/relation-change-processor.ts +420 -420
- package/src/orm/relations/belongs-to.ts +143 -143
- package/src/orm/relations/has-many.ts +204 -204
- package/src/orm/relations/has-one.ts +174 -174
- package/src/orm/relations/many-to-many.ts +288 -288
- package/src/orm/relations/morph-many.ts +156 -156
- package/src/orm/relations/morph-one.ts +151 -151
- package/src/orm/relations/morph-to.ts +162 -162
- package/src/orm/runtime-types.ts +92 -92
- package/src/orm/save-graph.ts +561 -561
- package/src/orm/transaction-runner.ts +24 -24
- package/src/orm/unit-of-work.ts +426 -426
- package/src/query/index.ts +69 -69
- package/src/query/target.ts +46 -46
- package/src/query-builder/column-selector.ts +81 -81
- package/src/query-builder/delete.ts +141 -141
- package/src/query-builder/insert-query-state.ts +149 -149
- package/src/query-builder/insert.ts +117 -117
- package/src/query-builder/query-ast-service.ts +287 -287
- package/src/query-builder/query-resolution.ts +78 -78
- package/src/query-builder/raw-column-parser.ts +38 -38
- package/src/query-builder/relation-filter-utils.ts +153 -153
- package/src/query-builder/relation-join-planner.ts +10 -10
- package/src/query-builder/relation-manager.ts +87 -87
- package/src/query-builder/relation-projection-helper.ts +102 -102
- package/src/query-builder/relation-types.ts +9 -9
- package/src/query-builder/relation-utils.ts +15 -15
- package/src/query-builder/select/cte-facet.ts +40 -40
- package/src/query-builder/select/from-facet.ts +80 -80
- package/src/query-builder/select/join-facet.ts +62 -62
- package/src/query-builder/select/predicate-facet.ts +104 -104
- package/src/query-builder/select/projection-facet.ts +70 -70
- package/src/query-builder/select/relation-facet.ts +81 -81
- package/src/query-builder/select/setop-facet.ts +36 -36
- package/src/query-builder/select-helpers.ts +1 -1
- package/src/query-builder/select-query-builder-deps.ts +130 -130
- package/src/query-builder/select-query-state.ts +207 -207
- package/src/query-builder/update.ts +151 -151
- package/src/schema/column-types.ts +322 -322
- package/src/schema/table-guards.ts +37 -37
- package/src/schema/table.ts +281 -281
- package/src/tree/index.ts +13 -13
- package/src/tree/nested-set-strategy.ts +545 -545
- package/src/tree/tree-decorator.ts +397 -397
- package/src/tree/tree-manager.ts +754 -754
- package/src/tree/tree-query.ts +427 -427
- package/src/tree/tree-types.ts +299 -299
package/src/dto/openapi/index.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
export * from './types.js';
|
|
2
|
-
export * from './type-mappings.js';
|
|
3
|
-
export * from './utilities.js';
|
|
4
|
-
export * from './generators/base.js';
|
|
5
|
-
export * from './generators/column.js';
|
|
6
|
-
export * from './generators/dto.js';
|
|
7
|
-
export * from './generators/filter.js';
|
|
1
|
+
export * from './types.js';
|
|
2
|
+
export * from './type-mappings.js';
|
|
3
|
+
export * from './utilities.js';
|
|
4
|
+
export * from './generators/base.js';
|
|
5
|
+
export * from './generators/column.js';
|
|
6
|
+
export * from './generators/dto.js';
|
|
7
|
+
export * from './generators/filter.js';
|
|
8
8
|
export * from './generators/relation-filter.js';
|
|
9
9
|
export * from './generators/nested-dto.js';
|
|
10
10
|
export * from './generators/tree.js';
|
|
11
11
|
export type {
|
|
12
12
|
PaginationParams,
|
|
13
13
|
} from './generators/pagination.js';
|
|
14
|
-
export {
|
|
15
|
-
paginationParamsSchema,
|
|
16
|
-
toPaginationParams,
|
|
17
|
-
pagedResponseToOpenApiSchema
|
|
18
|
-
} from './generators/pagination.js';
|
|
14
|
+
export {
|
|
15
|
+
paginationParamsSchema,
|
|
16
|
+
toPaginationParams,
|
|
17
|
+
pagedResponseToOpenApiSchema
|
|
18
|
+
} from './generators/pagination.js';
|
package/src/dto/openapi/types.ts
CHANGED
|
@@ -1,101 +1,101 @@
|
|
|
1
|
-
export type OpenApiType =
|
|
2
|
-
| 'string'
|
|
3
|
-
| 'number'
|
|
4
|
-
| 'integer'
|
|
5
|
-
| 'boolean'
|
|
6
|
-
| 'array'
|
|
7
|
-
| 'object'
|
|
8
|
-
| 'null';
|
|
9
|
-
|
|
10
|
-
export interface OpenApiSchema {
|
|
11
|
-
type?: OpenApiType | OpenApiType[];
|
|
12
|
-
properties?: Record<string, OpenApiSchema>;
|
|
13
|
-
items?: OpenApiSchema;
|
|
14
|
-
required?: string[];
|
|
15
|
-
enum?: unknown[];
|
|
16
|
-
format?: string;
|
|
17
|
-
description?: string;
|
|
18
|
-
example?: unknown;
|
|
19
|
-
nullable?: boolean;
|
|
20
|
-
minimum?: number;
|
|
21
|
-
maximum?: number;
|
|
22
|
-
default?: unknown;
|
|
23
|
-
$ref?: string;
|
|
24
|
-
allOf?: OpenApiSchema[];
|
|
25
|
-
oneOf?: OpenApiSchema[];
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export interface OpenApiParameterObject {
|
|
29
|
-
name: string;
|
|
30
|
-
in: 'query' | 'path' | 'header' | 'cookie';
|
|
31
|
-
required?: boolean;
|
|
32
|
-
schema?: OpenApiSchema;
|
|
33
|
-
description?: string;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
export interface OpenApiResponseObject {
|
|
37
|
-
description: string;
|
|
38
|
-
content?: {
|
|
39
|
-
'application/json': {
|
|
40
|
-
schema: OpenApiSchema;
|
|
41
|
-
};
|
|
42
|
-
};
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export interface OpenApiOperation {
|
|
46
|
-
summary?: string;
|
|
47
|
-
description?: string;
|
|
48
|
-
parameters?: OpenApiParameterObject[];
|
|
49
|
-
requestBody?: {
|
|
50
|
-
description?: string;
|
|
51
|
-
required?: boolean;
|
|
52
|
-
content: {
|
|
53
|
-
'application/json': {
|
|
54
|
-
schema: OpenApiSchema;
|
|
55
|
-
};
|
|
56
|
-
};
|
|
57
|
-
};
|
|
58
|
-
responses?: Record<string, OpenApiResponseObject>;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export interface OpenApiDocumentInfo {
|
|
62
|
-
title: string;
|
|
63
|
-
version: string;
|
|
64
|
-
description?: string;
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
export interface ApiRouteDefinition {
|
|
68
|
-
path: string;
|
|
69
|
-
method: 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
70
|
-
operation: OpenApiOperation;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
export interface PaginationParams {
|
|
74
|
-
page?: number;
|
|
75
|
-
pageSize?: number;
|
|
76
|
-
sortBy?: string;
|
|
77
|
-
sortOrder?: 'asc' | 'desc';
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
export interface OpenApiComponent {
|
|
81
|
-
schemas?: Record<string, OpenApiSchema>;
|
|
82
|
-
parameters?: Record<string, OpenApiParameterObject>;
|
|
83
|
-
responses?: Record<string, OpenApiResponseObject>;
|
|
84
|
-
securitySchemes?: Record<string, unknown>;
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
export interface OpenApiDocument {
|
|
88
|
-
openapi: string;
|
|
89
|
-
info: OpenApiDocumentInfo;
|
|
90
|
-
paths: Record<string, Record<string, OpenApiOperation>>;
|
|
91
|
-
components?: OpenApiComponent;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
export type OpenApiDialect = 'openapi-3.0' | 'openapi-3.1';
|
|
95
|
-
|
|
96
|
-
export interface OpenApiDocumentOptions {
|
|
97
|
-
dialect?: OpenApiDialect;
|
|
98
|
-
allowScalarEquals?: boolean;
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
export type OpenApiParameter = OpenApiParameterObject;
|
|
1
|
+
export type OpenApiType =
|
|
2
|
+
| 'string'
|
|
3
|
+
| 'number'
|
|
4
|
+
| 'integer'
|
|
5
|
+
| 'boolean'
|
|
6
|
+
| 'array'
|
|
7
|
+
| 'object'
|
|
8
|
+
| 'null';
|
|
9
|
+
|
|
10
|
+
export interface OpenApiSchema {
|
|
11
|
+
type?: OpenApiType | OpenApiType[];
|
|
12
|
+
properties?: Record<string, OpenApiSchema>;
|
|
13
|
+
items?: OpenApiSchema;
|
|
14
|
+
required?: string[];
|
|
15
|
+
enum?: unknown[];
|
|
16
|
+
format?: string;
|
|
17
|
+
description?: string;
|
|
18
|
+
example?: unknown;
|
|
19
|
+
nullable?: boolean;
|
|
20
|
+
minimum?: number;
|
|
21
|
+
maximum?: number;
|
|
22
|
+
default?: unknown;
|
|
23
|
+
$ref?: string;
|
|
24
|
+
allOf?: OpenApiSchema[];
|
|
25
|
+
oneOf?: OpenApiSchema[];
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface OpenApiParameterObject {
|
|
29
|
+
name: string;
|
|
30
|
+
in: 'query' | 'path' | 'header' | 'cookie';
|
|
31
|
+
required?: boolean;
|
|
32
|
+
schema?: OpenApiSchema;
|
|
33
|
+
description?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface OpenApiResponseObject {
|
|
37
|
+
description: string;
|
|
38
|
+
content?: {
|
|
39
|
+
'application/json': {
|
|
40
|
+
schema: OpenApiSchema;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export interface OpenApiOperation {
|
|
46
|
+
summary?: string;
|
|
47
|
+
description?: string;
|
|
48
|
+
parameters?: OpenApiParameterObject[];
|
|
49
|
+
requestBody?: {
|
|
50
|
+
description?: string;
|
|
51
|
+
required?: boolean;
|
|
52
|
+
content: {
|
|
53
|
+
'application/json': {
|
|
54
|
+
schema: OpenApiSchema;
|
|
55
|
+
};
|
|
56
|
+
};
|
|
57
|
+
};
|
|
58
|
+
responses?: Record<string, OpenApiResponseObject>;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface OpenApiDocumentInfo {
|
|
62
|
+
title: string;
|
|
63
|
+
version: string;
|
|
64
|
+
description?: string;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface ApiRouteDefinition {
|
|
68
|
+
path: string;
|
|
69
|
+
method: 'get' | 'post' | 'put' | 'patch' | 'delete';
|
|
70
|
+
operation: OpenApiOperation;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface PaginationParams {
|
|
74
|
+
page?: number;
|
|
75
|
+
pageSize?: number;
|
|
76
|
+
sortBy?: string;
|
|
77
|
+
sortOrder?: 'asc' | 'desc';
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export interface OpenApiComponent {
|
|
81
|
+
schemas?: Record<string, OpenApiSchema>;
|
|
82
|
+
parameters?: Record<string, OpenApiParameterObject>;
|
|
83
|
+
responses?: Record<string, OpenApiResponseObject>;
|
|
84
|
+
securitySchemes?: Record<string, unknown>;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface OpenApiDocument {
|
|
88
|
+
openapi: string;
|
|
89
|
+
info: OpenApiDocumentInfo;
|
|
90
|
+
paths: Record<string, Record<string, OpenApiOperation>>;
|
|
91
|
+
components?: OpenApiComponent;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export type OpenApiDialect = 'openapi-3.0' | 'openapi-3.1';
|
|
95
|
+
|
|
96
|
+
export interface OpenApiDocumentOptions {
|
|
97
|
+
dialect?: OpenApiDialect;
|
|
98
|
+
allowScalarEquals?: boolean;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export type OpenApiParameter = OpenApiParameterObject;
|
|
@@ -1,95 +1,95 @@
|
|
|
1
|
-
import type { OpenApiSchema, OpenApiOperation, OpenApiDocumentInfo, ApiRouteDefinition, OpenApiDocument, OpenApiDialect, OpenApiType } from './types.js';
|
|
2
|
-
|
|
3
|
-
export function schemaToJson(schema: OpenApiSchema): string {
|
|
4
|
-
return JSON.stringify(schema, null, 2);
|
|
5
|
-
}
|
|
6
|
-
|
|
7
|
-
export function deepCloneSchema(schema: OpenApiSchema): OpenApiSchema {
|
|
8
|
-
return JSON.parse(JSON.stringify(schema));
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
export function mergeSchemas(base: OpenApiSchema, override: Partial<OpenApiSchema>): OpenApiSchema {
|
|
12
|
-
return {
|
|
13
|
-
...base,
|
|
14
|
-
...override,
|
|
15
|
-
properties: {
|
|
16
|
-
...base.properties,
|
|
17
|
-
...(override.properties || {}),
|
|
18
|
-
},
|
|
19
|
-
required: override.required ?? base.required,
|
|
20
|
-
};
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export function applyNullability(
|
|
24
|
-
schema: OpenApiSchema,
|
|
25
|
-
isNullable: boolean,
|
|
26
|
-
dialect: OpenApiDialect
|
|
27
|
-
): OpenApiSchema {
|
|
28
|
-
if (!isNullable) {
|
|
29
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
30
|
-
const { nullable: _, ...clean } = schema;
|
|
31
|
-
return clean;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
if (dialect === 'openapi-3.0') {
|
|
35
|
-
return { ...schema, nullable: true };
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
const type = schema.type;
|
|
39
|
-
if (Array.isArray(type)) {
|
|
40
|
-
if (!type.includes('null')) {
|
|
41
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
42
|
-
const { nullable: _, ...clean } = schema;
|
|
43
|
-
return { ...clean, type: [...type, 'null'] as OpenApiType[] };
|
|
44
|
-
}
|
|
45
|
-
} else if (type) {
|
|
46
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
47
|
-
const { nullable: _, ...clean } = schema;
|
|
48
|
-
return { ...clean, type: [type, 'null'] as OpenApiType[] };
|
|
49
|
-
} else {
|
|
50
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
51
|
-
const { nullable: _, ...clean } = schema;
|
|
52
|
-
return { ...clean, type: ['null'] as OpenApiType[] };
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
56
|
-
const { nullable: _, ...clean } = schema;
|
|
57
|
-
return clean;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
export function isNullableColumn(col: { notNull?: boolean }): boolean {
|
|
61
|
-
return !col.notNull;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export function getOpenApiVersionForDialect(dialect: OpenApiDialect): string {
|
|
65
|
-
return dialect === 'openapi-3.0' ? '3.0.3' : '3.1.0';
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
export function generateOpenApiDocument(
|
|
69
|
-
info: OpenApiDocumentInfo,
|
|
70
|
-
routes: ApiRouteDefinition[],
|
|
71
|
-
options?: {
|
|
72
|
-
dialect?: OpenApiDialect;
|
|
73
|
-
allowScalarEquals?: boolean;
|
|
74
|
-
}
|
|
75
|
-
): OpenApiDocument {
|
|
76
|
-
const dialect: OpenApiDialect = options?.dialect ?? 'openapi-3.1';
|
|
77
|
-
const paths: Record<string, Record<string, OpenApiOperation>> = {};
|
|
78
|
-
|
|
79
|
-
for (const route of routes) {
|
|
80
|
-
if (!paths[route.path]) {
|
|
81
|
-
paths[route.path] = {};
|
|
82
|
-
}
|
|
83
|
-
paths[route.path][route.method] = route.operation;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
return {
|
|
87
|
-
openapi: getOpenApiVersionForDialect(dialect),
|
|
88
|
-
info: {
|
|
89
|
-
title: info.title,
|
|
90
|
-
version: info.version,
|
|
91
|
-
description: info.description,
|
|
92
|
-
},
|
|
93
|
-
paths,
|
|
94
|
-
};
|
|
95
|
-
}
|
|
1
|
+
import type { OpenApiSchema, OpenApiOperation, OpenApiDocumentInfo, ApiRouteDefinition, OpenApiDocument, OpenApiDialect, OpenApiType } from './types.js';
|
|
2
|
+
|
|
3
|
+
export function schemaToJson(schema: OpenApiSchema): string {
|
|
4
|
+
return JSON.stringify(schema, null, 2);
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
export function deepCloneSchema(schema: OpenApiSchema): OpenApiSchema {
|
|
8
|
+
return JSON.parse(JSON.stringify(schema));
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export function mergeSchemas(base: OpenApiSchema, override: Partial<OpenApiSchema>): OpenApiSchema {
|
|
12
|
+
return {
|
|
13
|
+
...base,
|
|
14
|
+
...override,
|
|
15
|
+
properties: {
|
|
16
|
+
...base.properties,
|
|
17
|
+
...(override.properties || {}),
|
|
18
|
+
},
|
|
19
|
+
required: override.required ?? base.required,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export function applyNullability(
|
|
24
|
+
schema: OpenApiSchema,
|
|
25
|
+
isNullable: boolean,
|
|
26
|
+
dialect: OpenApiDialect
|
|
27
|
+
): OpenApiSchema {
|
|
28
|
+
if (!isNullable) {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
30
|
+
const { nullable: _, ...clean } = schema;
|
|
31
|
+
return clean;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
if (dialect === 'openapi-3.0') {
|
|
35
|
+
return { ...schema, nullable: true };
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
const type = schema.type;
|
|
39
|
+
if (Array.isArray(type)) {
|
|
40
|
+
if (!type.includes('null')) {
|
|
41
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
42
|
+
const { nullable: _, ...clean } = schema;
|
|
43
|
+
return { ...clean, type: [...type, 'null'] as OpenApiType[] };
|
|
44
|
+
}
|
|
45
|
+
} else if (type) {
|
|
46
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
47
|
+
const { nullable: _, ...clean } = schema;
|
|
48
|
+
return { ...clean, type: [type, 'null'] as OpenApiType[] };
|
|
49
|
+
} else {
|
|
50
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
51
|
+
const { nullable: _, ...clean } = schema;
|
|
52
|
+
return { ...clean, type: ['null'] as OpenApiType[] };
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
56
|
+
const { nullable: _, ...clean } = schema;
|
|
57
|
+
return clean;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function isNullableColumn(col: { notNull?: boolean }): boolean {
|
|
61
|
+
return !col.notNull;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function getOpenApiVersionForDialect(dialect: OpenApiDialect): string {
|
|
65
|
+
return dialect === 'openapi-3.0' ? '3.0.3' : '3.1.0';
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function generateOpenApiDocument(
|
|
69
|
+
info: OpenApiDocumentInfo,
|
|
70
|
+
routes: ApiRouteDefinition[],
|
|
71
|
+
options?: {
|
|
72
|
+
dialect?: OpenApiDialect;
|
|
73
|
+
allowScalarEquals?: boolean;
|
|
74
|
+
}
|
|
75
|
+
): OpenApiDocument {
|
|
76
|
+
const dialect: OpenApiDialect = options?.dialect ?? 'openapi-3.1';
|
|
77
|
+
const paths: Record<string, Record<string, OpenApiOperation>> = {};
|
|
78
|
+
|
|
79
|
+
for (const route of routes) {
|
|
80
|
+
if (!paths[route.path]) {
|
|
81
|
+
paths[route.path] = {};
|
|
82
|
+
}
|
|
83
|
+
paths[route.path][route.method] = route.operation;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
return {
|
|
87
|
+
openapi: getOpenApiVersionForDialect(dialect),
|
|
88
|
+
info: {
|
|
89
|
+
title: info.title,
|
|
90
|
+
version: info.version,
|
|
91
|
+
description: info.description,
|
|
92
|
+
},
|
|
93
|
+
paths,
|
|
94
|
+
};
|
|
95
|
+
}
|