@impactor/nest 3.0.0 → 5.0.0

package/src/utils/typeorm-to-swagger.js

@@ -0,0 +1,308 @@
+/**
+ * extract openAPI type and format from TypeORM column type
+ * @example `typeORMToSwaggerType("file")` // { type: 'string', format: 'binary' }
+ */ export function typeORMToSwagger(type) {
+    // the column type as string
+    // it may be a BooleanConstructor | DateConstructor | ....
+    let value = (typeof type === 'string' ? type : type.name).toLowerCase();
+    // numbers
+    if ([
+        'numeric',
+        'number',
+        'int',
+        'int2',
+        'int4',
+        'int8',
+        'int64',
+        'integer',
+        'tinyint',
+        'smallint',
+        'mediumint',
+        'bigint',
+        'unsigned big int',
+        'rowid',
+        'urowid',
+        'float',
+        'float4',
+        'float8',
+        'float64',
+        'money',
+        'smallmoney',
+        'decimal',
+        'smalldecimal',
+        'dec',
+        'double',
+        'double precision',
+        'fixed',
+        'real'
+    ].includes(value)) {
+        // todo: set the best 'format' for each type
+        return {
+            type: 'number'
+        };
+    }
+    // booleans
+    if ([
+        'boolean',
+        'bool',
+        'bit',
+        'bit varying',
+        'varbit'
+    ].includes(value)) {
+        return {
+            type: 'boolean'
+        };
+    }
+    // arrays / collections
+    if ([
+        'array',
+        'simple-array',
+        'set',
+        'cube',
+        'ltree'
+    ].includes(value)) {
+        return {
+            type: 'array'
+        };
+    }
+    // files
+    if ([
+        'blob',
+        'longblob',
+        'mediumblob',
+        'tinyblob',
+        'bytea',
+        'bytes',
+        'image',
+        'rowversion',
+        'raw',
+        'long raw',
+        'bfile',
+        'binary',
+        'varbinary'
+    ].includes(value)) {
+        // todo: openAPI v3 changed 'file' to 'string' with format 'binary' | 'byte'
+        // https://swagger.io/docs/specification/v3_0/data-models/data-types/#files
+        return {
+            type: 'string',
+            format: 'binary'
+        };
+    }
+    // date
+    if ([
+        'date'
+    ].includes(value)) {
+        return {
+            type: 'string',
+            format: 'date'
+        };
+    }
+    if ([
+        'year'
+    ].includes(value)) {
+        return {
+            type: 'integer',
+            format: 'int32',
+            example: new Date().getFullYear()
+        };
+    }
+    // time
+    if ([
+        'time',
+        'timetz'
+    ].includes(value)) {
+        return {
+            type: 'string',
+            format: 'time'
+        };
+    }
+    // date-time
+    if ([
+        'timestamp',
+        'timestamptz',
+        'timestamp without time zone',
+        'timestamp with time zone',
+        'timestamp with local time zone',
+        'datetime',
+        'datetime2',
+        'datetimeoffset',
+        'smalldatetime',
+        'seconddate'
+    ].includes(value)) {
+        return {
+            type: 'string',
+            format: 'date-time'
+        };
+    }
+    // intervals and durations
+    if ([
+        'interval',
+        'interval year to month',
+        'interval day to second'
+    ].includes(value)) {
+        return {
+            type: 'string',
+            format: 'duration',
+            example: 'P1Y2M3DT4H5M6S'
+        };
+    }
+    // strings
+    if ([
+        'text',
+        'tinytext',
+        'shorttext',
+        'mediumtext',
+        'longtext',
+        'ntext',
+        'citext',
+        'string',
+        'character varying',
+        'varying character',
+        'char varying',
+        'varchar2',
+        'nvarchar',
+        'nvarchar2',
+        'national varchar',
+        'character',
+        'native character',
+        'varchar',
+        'char',
+        'nchar',
+        'national char',
+        'alphanum',
+        'jsonpath',
+        'xml',
+        'long',
+        'clob',
+        'nclob',
+        // ranges
+        // this can also represented as object `{start, end}`
+        'int4range',
+        'int8range',
+        'numrange',
+        'tsrange',
+        'tstzrange',
+        'daterange',
+        'int4multirange',
+        'int8multirange',
+        'nummultirange',
+        'tsmultirange',
+        'tstzmultirange',
+        'datemultirange',
+        // enums
+        'enum',
+        'simple-enum',
+        // network
+        'cidr',
+        'inet',
+        'inet4',
+        'inet6',
+        'macaddr',
+        'macaddr8',
+        // full-text search types
+        'tsvector',
+        'tsquery',
+        // identifiers
+        'rowid',
+        'urowid',
+        'hierarchyid',
+        'sql_variant'
+    ].includes(value)) {
+        return {
+            type: 'string'
+        };
+    }
+    if ([
+        'uuid',
+        // most databases generates a 128-bit GUID, the same as a UUID
+        // so, it is safe to represent it in Swagger UI as a UUID string
+        'uniqueidentifier'
+    ].includes(value)) {
+        return {
+            type: 'string',
+            format: 'uuid'
+        };
+    }
+    // vectors
+    if ([
+        'vector',
+        'halfvec',
+        'half_vector',
+        'real_vector'
+    ].includes(value)) {
+        return {
+            type: 'array',
+            items: {
+                type: 'number'
+            }
+        };
+    }
+    // JSON
+    if ([
+        'json',
+        'jsonb',
+        'simple-json',
+        'hstore'
+    ].includes(value)) {
+        return {
+            type: 'object',
+            items: {
+                type: 'number'
+            },
+            // in hstore, keys must ve string
+            additionalProperties: value === 'hstore' ? {
+                type: 'string'
+            } : true
+        };
+    }
+    // geometry types
+    if ([
+        'geometry',
+        'geography',
+        'st_geometry',
+        'st_point',
+        'point',
+        'line',
+        'polygon',
+        'circle',
+        'multipolygon',
+        'linestring',
+        'multilinestring',
+        'multipoint',
+        'geometrycollection',
+        'lseg',
+        'box',
+        'path'
+    ].includes(value)) {
+        return {
+            // they're saved as JSON objects
+            type: 'object',
+            properties: {
+                type: {
+                    type: 'string',
+                    example: 'Point'
+                },
+                coordinates: {
+                    type: 'array',
+                    items: {
+                        type: 'number'
+                    },
+                    example: [
+                        125.6,
+                        10.1
+                    ]
+                }
+            },
+            required: [
+                'type',
+                'coordinates'
+            ],
+            description: 'GeoJSON object representing geometry or geography'
+        };
+    }
+    return {
+        type: 'null'
+    };
+}
+
+//# sourceMappingURL=typeorm-to-swagger.js.map

package/src/utils/typeorm-to-swagger.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/utils/typeorm-to-swagger.ts"],"sourcesContent":["import { ApiPropertyOptions } from '@nestjs/swagger';\nimport { ColumnType } from 'typeorm';\n\n/**\n * extract openAPI type and format from TypeORM column type\n * @example `typeORMToSwaggerType(\"file\")` // { type: 'string', format: 'binary' }\n */\nexport function typeORMToSwagger(type: ColumnType): ApiPropertyOptions {\n  // the column type as string\n  // it may be a BooleanConstructor | DateConstructor | ....\n  let value = (typeof type === 'string' ? type : type.name).toLowerCase();\n\n  // numbers\n  if (\n    [\n      'numeric',\n      'number',\n      'int',\n      'int2',\n      'int4',\n      'int8',\n      'int64',\n      'integer',\n      'tinyint',\n      'smallint',\n      'mediumint',\n      'bigint',\n      'unsigned big int',\n      'rowid',\n      'urowid',\n      'float',\n      'float4',\n      'float8',\n      'float64',\n      'money',\n      'smallmoney',\n      'decimal',\n      'smalldecimal',\n      'dec',\n      'double',\n      'double precision',\n      'fixed',\n      'real',\n    ].includes(value)\n  ) {\n    // todo: set the best 'format' for each type\n    return { type: 'number' };\n  }\n\n  // booleans\n  if (['boolean', 'bool', 'bit', 'bit varying', 'varbit'].includes(value)) {\n    return { type: 'boolean' };\n  }\n\n  // arrays / collections\n  if (['array', 'simple-array', 'set', 'cube', 'ltree'].includes(value)) {\n    return { type: 'array' };\n  }\n\n  // files\n  if (\n    [\n      'blob',\n      'longblob',\n      'mediumblob',\n      'tinyblob',\n      'bytea',\n      'bytes',\n      'image',\n      'rowversion',\n      'raw',\n      'long raw',\n      'bfile',\n      'binary',\n      'varbinary',\n    ].includes(value)\n  ) {\n    // todo: openAPI v3 changed 'file' to 'string' with format 'binary' | 'byte'\n    // https://swagger.io/docs/specification/v3_0/data-models/data-types/#files\n    return { type: 'string', format: 'binary' };\n  }\n\n  // date\n  if (['date'].includes(value)) {\n    return { type: 'string', format: 'date' };\n  }\n\n  if (['year'].includes(value)) {\n    return {\n      type: 'integer',\n      format: 'int32',\n      example: new Date().getFullYear(),\n    };\n  }\n\n  // time\n  if (['time', 'timetz'].includes(value)) {\n    return { type: 'string', format: 'time' };\n  }\n\n  // date-time\n  if (\n    [\n      'timestamp',\n      'timestamptz',\n      'timestamp without time zone',\n      'timestamp with time zone',\n      'timestamp with local time zone',\n      'datetime',\n      'datetime2',\n      'datetimeoffset',\n      'smalldatetime',\n      'seconddate',\n    ].includes(value)\n  ) {\n    return { type: 'string', format: 'date-time' };\n  }\n\n  // intervals and durations\n  if (\n    ['interval', 'interval year to month', 'interval day to second'].includes(\n      value,\n    )\n  ) {\n    return { type: 'string', format: 'duration', example: 'P1Y2M3DT4H5M6S' };\n  }\n\n  // strings\n  if (\n    [\n      'text',\n      'tinytext',\n      'shorttext',\n      'mediumtext',\n      'longtext',\n      'ntext',\n      'citext',\n      'string',\n      'character varying',\n      'varying character',\n      'char varying',\n      'varchar2',\n      'nvarchar',\n      'nvarchar2',\n      'national varchar',\n      'character',\n      'native character',\n      'varchar',\n      'char',\n      'nchar',\n      'national char',\n      'alphanum',\n      'jsonpath',\n      'xml',\n      'long',\n      'clob',\n      'nclob',\n      // ranges\n      // this can also represented as object `{start, end}`\n      'int4range',\n      'int8range',\n      'numrange',\n      'tsrange',\n      'tstzrange',\n      'daterange',\n      'int4multirange',\n      'int8multirange',\n      'nummultirange',\n      'tsmultirange',\n      'tstzmultirange',\n      'datemultirange',\n\n      // enums\n      'enum',\n      'simple-enum',\n      // network\n      'cidr',\n      'inet',\n      'inet4',\n      'inet6',\n      'macaddr',\n      'macaddr8',\n      // full-text search types\n      'tsvector',\n      'tsquery',\n      // identifiers\n      'rowid',\n      'urowid',\n      'hierarchyid',\n      'sql_variant',\n    ].includes(value)\n  ) {\n    return { type: 'string' };\n  }\n\n  if (\n    [\n      'uuid',\n      // most databases generates a 128-bit GUID, the same as a UUID\n      // so, it is safe to represent it in Swagger UI as a UUID string\n      'uniqueidentifier',\n    ].includes(value)\n  ) {\n    return { type: 'string', format: 'uuid' };\n  }\n\n  // vectors\n  if (['vector', 'halfvec', 'half_vector', 'real_vector'].includes(value)) {\n    return {\n      type: 'array',\n      items: { type: 'number' },\n    };\n  }\n\n  // JSON\n  if (['json', 'jsonb', 'simple-json', 'hstore'].includes(value)) {\n    return {\n      type: 'object',\n      items: { type: 'number' },\n      // in hstore, keys must ve string\n      additionalProperties: value === 'hstore' ? { type: 'string' } : true,\n    };\n  }\n\n  // geometry types\n  if (\n    [\n      'geometry',\n      'geography',\n      'st_geometry',\n      'st_point',\n      'point',\n      'line',\n      'polygon',\n      'circle',\n      'multipolygon',\n      'linestring',\n      'multilinestring',\n      'multipoint',\n      'geometrycollection',\n      'lseg',\n      'box',\n      'path',\n    ].includes(value)\n  ) {\n    return {\n      // they're saved as JSON objects\n      type: 'object',\n      properties: {\n        type: { type: 'string', example: 'Point' },\n        coordinates: {\n          type: 'array',\n          items: { type: 'number' },\n          example: [125.6, 10.1],\n        },\n      },\n      required: ['type', 'coordinates'],\n      description: 'GeoJSON object representing geometry or geography',\n    };\n  }\n\n  return { type: 'null' };\n}\n"],"names":["typeORMToSwagger","type","value","name","toLowerCase","includes","format","example","Date","getFullYear","items","additionalProperties","properties","coordinates","required","description"],"mappings":"AAGA;;;CAGC,GACD,OAAO,SAASA,iBAAiBC,IAAgB;IAC/C,4BAA4B;IAC5B,0DAA0D;IAC1D,IAAIC,QAAQ,AAAC,CAAA,OAAOD,SAAS,WAAWA,OAAOA,KAAKE,IAAI,AAAD,EAAGC,WAAW;IAErE,UAAU;IACV,IACE;QACE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;KACD,CAACC,QAAQ,CAACH,QACX;QACA,4CAA4C;QAC5C,OAAO;YAAED,MAAM;QAAS;IAC1B;IAEA,WAAW;IACX,IAAI;QAAC;QAAW;QAAQ;QAAO;QAAe;KAAS,CAACI,QAAQ,CAACH,QAAQ;QACvE,OAAO;YAAED,MAAM;QAAU;IAC3B;IAEA,uBAAuB;IACvB,IAAI;QAAC;QAAS;QAAgB;QAAO;QAAQ;KAAQ,CAACI,QAAQ,CAACH,QAAQ;QACrE,OAAO;YAAED,MAAM;QAAQ;IACzB;IAEA,QAAQ;IACR,IACE;QACE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;KACD,CAACI,QAAQ,CAACH,QACX;QACA,4EAA4E;QAC5E,2EAA2E;QAC3E,OAAO;YAAED,MAAM;YAAUK,QAAQ;QAAS;IAC5C;IAEA,OAAO;IACP,IAAI;QAAC;KAAO,CAACD,QAAQ,CAACH,QAAQ;QAC5B,OAAO;YAAED,MAAM;YAAUK,QAAQ;QAAO;IAC1C;IAEA,IAAI;QAAC;KAAO,CAACD,QAAQ,CAACH,QAAQ;QAC5B,OAAO;YACLD,MAAM;YACNK,QAAQ;YACRC,SAAS,IAAIC,OAAOC,WAAW;QACjC;IACF;IAEA,OAAO;IACP,IAAI;QAAC;QAAQ;KAAS,CAACJ,QAAQ,CAACH,QAAQ;QACtC,OAAO;YAAED,MAAM;YAAUK,QAAQ;QAAO;IAC1C;IAEA,YAAY;IACZ,IACE;QACE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;KACD,CAACD,QAAQ,CAACH,QACX;QACA,OAAO;YAAED,MAAM;YAAUK,QAAQ;QAAY;IAC/C;IAEA,0BAA0B;IAC1B,IACE;QAAC;QAAY;QAA0B;KAAyB,CAACD,QAAQ,CACvEH,QAEF;QACA,OAAO;YAAED,MAAM;YAAUK,QAAQ;YAAYC,SAAS;QAAiB;IACzE;IAEA,UAAU;IACV,IACE;QACE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA,SAAS;QACT,qDAAqD;QACrD;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QAEA,QAAQ;QACR;QACA;QACA,UAAU;QACV;QACA;QACA;QACA;QACA;QACA;QACA,yBAAyB;QACzB;QACA;QACA,cAAc;QACd;QACA;QACA;QACA;KACD,CAACF,QAAQ,CAACH,QACX;QACA,OAAO;YAAED,MAAM;QAAS;IAC1B;IAEA,IACE;QACE;QACA,8DAA8D;QAC9D,gEAAgE;QAChE;KACD,CAACI,QAAQ,CAACH,QACX;QACA,OAAO;YAAED,MAAM;YAAUK,QAAQ;QAAO;IAC1C;IAEA,UAAU;IACV,IAAI;QAAC;QAAU;QAAW;QAAe;KAAc,CAACD,QAAQ,CAACH,QAAQ;QACvE,OAAO;YACLD,MAAM;YACNS,OAAO;gBAAET,MAAM;YAAS;QAC1B;IACF;IAEA,OAAO;IACP,IAAI;QAAC;QAAQ;QAAS;QAAe;KAAS,CAACI,QAAQ,CAACH,QAAQ;QAC9D,OAAO;YACLD,MAAM;YACNS,OAAO;gBAAET,MAAM;YAAS;YACxB,iCAAiC;YACjCU,sBAAsBT,UAAU,WAAW;gBAAED,MAAM;YAAS,IAAI;QAClE;IACF;IAEA,iBAAiB;IACjB,IACE;QACE;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;QACA;KACD,CAACI,QAAQ,CAACH,QACX;QACA,OAAO;YACL,gCAAgC;YAChCD,MAAM;YACNW,YAAY;gBACVX,MAAM;oBAAEA,MAAM;oBAAUM,SAAS;gBAAQ;gBACzCM,aAAa;oBACXZ,MAAM;oBACNS,OAAO;wBAAET,MAAM;oBAAS;oBACxBM,SAAS;wBAAC;wBAAO;qBAAK;gBACxB;YACF;YACAO,UAAU;gBAAC;gBAAQ;aAAc;YACjCC,aAAa;QACf;IACF;IAEA,OAAO;QAAEd,MAAM;IAAO;AACxB"}

package/nx.json

@@ -1,190 +0,0 @@
-{
-  "$schema": "./node_modules/nx/schemas/nx-schema.json",
-  "targetDefaults": {
-    "build": {
-      "executor": "@impactor/nx-manager:universal-builder",
-      "dependsOn": ["typecheck", "prebuild", "^build"],
-      "cache": true,
-      "inputs": ["default", "^default"],
-      "outputs": ["{projectRoot}/dist"],
-      "options": {
-        "forceRnDefaultPostBuild": true
-      }
-    },
-    "serve": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build", "preserve"],
-      "continuous": true,
-      "options": {
-        "cwd": "{projectRoot}",
-        "command": "NODE_ENV=development pnpm tsx --env-file-if-exists=.env --env-file-if-exists=.env.local dist/main.js"
-      },
-      "configurations": {
-        "production": {
-          "command": "NODE_ENV=production pnpm tsx --env-file-if-exists=.env --env-file-if-exists=.env.local --env-file-if-exists=.env.production --env-file-if-exists=.env.production.local dist/main.js"
-        }
-      }
-    },
-    "nx-release-publish": {
-      "options": {
-        "packageRoot": "{projectRoot}/dist"
-      }
-    },
-    "semantic-release": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build", "prerelease"],
-      "options": {
-        "cwd": "{projectRoot}",
-        "command": "pnpm tsx node_modules/semantic-release/bin/semantic-release.js"
-      },
-      "configurations": {
-        "local": {
-          "command": "DOTENV_CONFIG_PATH=../../.env pnpm run release --no-ci"
-        },
-        "dry": {
-          "command": "DOTENV_CONFIG_PATH=../../.env pnpm run release --no-ci --dry-run"
-        }
-      }
-    },
-    "test": {
-      "inputs": ["test"],
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "dependsOn": ["^build", "pretest"],
-      "configurations": {
-        "unit": {
-          "args": [
-            "--testPathIgnorePatterns '.*\\.e2e\\.spec\\.ts$'",
-            "--testPathIgnorePatterns '/.*-e2e/'",
-            "--testPathIgnorePatterns '/.*-e2e/'"
-          ]
-        },
-        "e2e": {
-          "args": [
-            "--testMatch '**/*-e2e/**/*.{spec,test}.[mc]?[jt]s?(x)'",
-            "--testMatch '**/e2e/**/*.{spec,test}.[mc]?[jt]s?(x)'",
-            "--testMatch  '**/*.e2e.(spec|test).?([mc])[jt]s?(x)'"
-          ]
-        }
-      }
-    },
-    "@angular/build:application": {
-      "cache": true,
-      "dependsOn": ["prebuild", "^build"],
-      "inputs": ["default", "^default"]
-    },
-    "@nx/angular:package": {
-      "cache": true,
-      "dependsOn": ["^build"],
-      "inputs": ["default", "^default"],
-      "outputs": ["{projectRoot}/dist"],
-      "options": {
-        "project": "{projectRoot}/ng-package.json",
-        "tsConfig": "{projectRoot}/tsconfig.lib.json"
-      }
-    },
-    "@nx/js:tsc": {
-      "cache": true,
-      "dependsOn": ["^build"],
-      "inputs": ["default", "^default"]
-    }
-  },
-  "namedInputs": {
-    "default": [
-      "{projectRoot}/src/**/*",
-      "!{projectRoot}/**/*.(spec|test)(.e2e)?.[tj]sx?",
-      "!{projectRoot}/**/e2e/**/*",
-      "{projectRoot}/.env(.*)?",
-      "{workspaceRoot}/tasks/(post-)?build.ts",
-      "{projectRoot}/(project|package|tsconfig)(.+)?.json",
-      "{workspaceRoot}/tsconfig.base.json",
-      {
-        "runtime": "node --version"
-      },
-      {
-        "env": "NODE_ENV"
-      }
-    ],
-    "test": [
-      "default",
-      "{projectRoot}/tsconfig.spec.json",
-      "{projectRoot}/jest.config.[jt]s",
-      "{workspaceRoot}/jest.config.[jt]s",
-      "{projectRoot}/**/*.(spec|test)(.e2e)?.[jt]sx?",
-      "{projectRoot}/**/e2e/**/*.[jt]sx?",
-      {
-        "externalDependencies": ["jest"]
-      }
-    ]
-  },
-  "plugins": [
-    {
-      "plugin": "@nx/js/typescript",
-      "options": {
-        "typecheck": {
-          "targetName": "typecheck"
-        },
-        "build": false
-      }
-    },
-    {
-      "plugin": "@nx/jest/plugin",
-      "options": {
-        "targetName": "test",
-        "ciTargetName": "test-ci"
-      }
-    }
-  ],
-  "tasksRunnerOptions": {
-    "default": {
-      "options": {
-        "useDaemonProcess": false
-      }
-    }
-  },
-  "generators": {
-    "@nx/angular:library": {
-      "linter": "eslint",
-      "unitTestRunner": "jest"
-    },
-    "@nx/angular:component": {
-      "style": "scss"
-    }
-  },
-  "release": {
-    "groups": {
-      "libs": {
-        "projects": ["libs/*"]
-      },
-      "apps": {
-        "projects": ["apps/*"],
-        "changelog": {
-          "projectChangelogs": {
-            "createRelease": "github"
-          }
-        }
-      }
-    },
-    "projectsRelationship": "independent",
-    "version": {
-      "conventionalCommits": true,
-      "updateDependents": "always",
-      "preVersionCommand": "pnpm nx run-many -t build",
-      "manifestRootsToUpdate": [
-        "{projectRoot}",
-        {
-          "path": "{projectRoot}/dist",
-          "preserveLocalDependencyProtocols": false
-        }
-      ]
-    },
-    "releaseTag": {
-      "pattern": "{projectName}@{version}"
-    },
-    "changelog": {
-      "projectChangelogs": true
-    }
-  },
-  "sync": {
-    "applyChanges": false
-  }
-}