@klerick/json-api-nestjs 10.0.0-beta.9 → 10.1.0

package/src/lib/types/entity-param.type.d.ts

@@ -1,5 +1,5 @@
 import { Union, Object } from 'ts-toolbelt';
-import { PropertyKeys, RelationKeys, IsIterator, Constructor } from '@klerick/json-api-nestjs-shared';
+import { AttrKeys, RelationKeys, IsIterator, Constructor } from '@klerick/json-api-nestjs-shared';
 import { CastIteratorType, UnionToTuple, IsArray, CastArrayType } from './utils-type';
 type ExtractBaseType<T> = T extends Date ? Date : T extends boolean ? boolean : T extends number ? number : T extends string ? string : T extends null ? null : T extends undefined ? undefined : T extends (infer U)[] ? U[] : object;
 export declare enum TypeField {
@@ -14,15 +14,28 @@ export declare enum TypeField {
 export type TypeForId = Extract<TypeField, TypeField.number | TypeField.string>;
 type TypeProps<T> = T extends Date ? TypeField.date : T extends any[] ? TypeField.array : T extends object ? TypeField.object : T extends boolean ? TypeField.boolean : T extends number ? TypeField.number : T extends string ? TypeField.string : T extends undefined ? never : TypeField.object;
 export type PropertyWithType<E extends object, IdKey extends string = 'id'> = {
-    [K in PropertyKeys<E, IdKey>]: Exclude<E[K], null | undefined> extends never ? TypeField.null : TypeProps<ExtractBaseType<Exclude<E[K], null | undefined>>>;
+    [K in AttrKeys<E, IdKey>]: Exclude<E[K], null | undefined> extends never ? TypeField.null : TypeProps<ExtractBaseType<Exclude<E[K], null | undefined>>>;
 };
 export type ArrayProperty<E extends object, IdKey extends string = 'id'> = {
-    [K in PropertyKeys<E, IdKey>]: Exclude<E[K], null | undefined> extends never ? never : IsArray<Exclude<E[K], null | undefined>> extends 1 ? K : never;
-}[PropertyKeys<E, IdKey>];
+    [K in AttrKeys<E, IdKey>]: Exclude<E[K], null | undefined> extends never ? never : IsArray<Exclude<E[K], null | undefined>> extends 1 ? K : never;
+}[AttrKeys<E, IdKey>];
 export type ArrayPropertyType<E extends object, IdKey extends string = 'id'> = {
     [K in ArrayProperty<E, IdKey>]: TypeProps<CastArrayType<Exclude<E[K], null | undefined>>>;
 };
-export type NullableProperty<E extends object, IdKey extends string = 'id'> = Union.Intersect<Object.NullableKeys<E>, PropertyKeys<E, IdKey>>;
+export type DateProperty<E extends object, IdKey extends string = 'id'> = {
+    [K in AttrKeys<E, IdKey>]: Exclude<E[K], null | undefined> extends Date ? K : never;
+}[AttrKeys<E, IdKey>];
+/**
+ * Whether a date column carries a timezone, keyed by property. True for types
+ * like `timestamptz`, false for `timestamp without time zone`.
+ *
+ * Only the runtime metadata knows this -- both column kinds surface as `Date`
+ * in TypeScript -- so a property is absent whenever the adapter could not read
+ * a column type. Absent is read as "carries a timezone", the stricter of the
+ * two, which keeps a zone mandatory for anything not positively identified.
+ */
+export type DatePropertyTimezone<E extends object, IdKey extends string = 'id'> = Partial<Record<DateProperty<E, IdKey>, boolean>>;
+export type NullableProperty<E extends object, IdKey extends string = 'id'> = Union.Intersect<Object.NullableKeys<E>, AttrKeys<E, IdKey>>;
 export type RelationProperty<E extends object, IdKey extends string = 'id'> = {
     [K in RelationKeys<E, IdKey>]: {
         entityClass: Constructor<CastIteratorType<E[K]>>;
@@ -32,9 +45,10 @@ export type RelationProperty<E extends object, IdKey extends string = 'id'> = {
 };
 type PrimaryType<E extends object, IdKey extends string = 'id'> = IdKey extends keyof E ? TypeProps<E[IdKey]> extends TypeField ? TypeProps<E[IdKey]> : TypeField.string : TypeField.string;
 export type EntityParam<E extends object, IdKey extends string = 'id'> = {
-    props: UnionToTuple<PropertyKeys<E, IdKey>>;
+    props: UnionToTuple<AttrKeys<E, IdKey>>;
     propsType: PropertyWithType<E, IdKey>;
     propsArrayType: ArrayPropertyType<E, IdKey>;
+    propsDateTimezone?: DatePropertyTimezone<E, IdKey>;
     propsNullable: UnionToTuple<NullableProperty<E, IdKey>>;
     primaryColumnName: IdKey;
     primaryColumnType: PrimaryType<E, IdKey>;
@@ -46,6 +60,6 @@ export type EntityParam<E extends object, IdKey extends string = 'id'> = {
 };
 type RelationType<E extends object, IdKey extends string, K extends keyof EntityParam<E, IdKey>['relationProperty']> = EntityParam<E, IdKey>['relationProperty'][K]['entityClass'] extends Constructor<infer T> ? Exclude<T, null> : never;
 export type EntityRelationProps<E extends object, IdKey extends string = 'id'> = {
-    [K in keyof EntityParam<E, IdKey>['relationProperty']]: UnionToTuple<PropertyKeys<RelationType<E, IdKey, K>>>;
+    [K in keyof EntityParam<E, IdKey>['relationProperty']]: UnionToTuple<AttrKeys<RelationType<E, IdKey, K>>>;
 };
 export {};

package/src/lib/types/module-options.types.d.ts

@@ -5,6 +5,7 @@ import { NestController, NestImport, NestProvider, PipeMixin } from './common-ty
 import { ExtractNestType, IfEquals } from './utils-type';
 type ModuleCommonParams = {
     entities: NonEmptyArray<EntityClass<AnyEntity>>;
+    excludeControllers?: EntityClass<AnyEntity>[];
     connectionName?: string;
     controllers?: NestController;
     providers?: NestProvider;

package/src/lib/utils/column-type.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Whether a database column type stores a timezone alongside the value.
+ *
+ * The adapters read the column type from their own metadata and hand the raw
+ * string here, so the dialect spellings live in one place: Postgres reports
+ * `timestamp with time zone` or the `timestamptz` shorthand, MikroORM adds the
+ * precision inside the phrase (`timestamp(0) with time zone`), and MySQL and
+ * SQL Server have no timezone-aware type at all.
+ *
+ * `without time zone` has to be ruled out before `with time zone` is looked
+ * for, since the former contains the latter as a substring.
+ */
+export declare function isTimezoneAwareColumnType(columnType: unknown): boolean;

package/src/lib/utils/column-type.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTimezoneAwareColumnType = isTimezoneAwareColumnType;
+/**
+ * Whether a database column type stores a timezone alongside the value.
+ *
+ * The adapters read the column type from their own metadata and hand the raw
+ * string here, so the dialect spellings live in one place: Postgres reports
+ * `timestamp with time zone` or the `timestamptz` shorthand, MikroORM adds the
+ * precision inside the phrase (`timestamp(0) with time zone`), and MySQL and
+ * SQL Server have no timezone-aware type at all.
+ *
+ * `without time zone` has to be ruled out before `with time zone` is looked
+ * for, since the former contains the latter as a substring.
+ */
+function isTimezoneAwareColumnType(columnType) {
+    if (typeof columnType !== 'string') {
+        return false;
+    }
+    const normalized = columnType.toLowerCase();
+    if (normalized.includes('without time zone')) {
+        return false;
+    }
+    return (normalized.includes('with time zone') ||
+        /\b(timestamptz|timetz)\b/.test(normalized));
+}
+//# sourceMappingURL=column-type.js.map

package/src/lib/utils/column-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"column-type.js","sourceRoot":"","sources":["../../../../../../../libs/json-api/json-api-nestjs/src/lib/utils/column-type.ts"],"names":[],"mappings":";;AAYA,8DAeC;AA3BD;;;;;;;;;;;GAWG;AACH,SAAgB,yBAAyB,CAAC,UAAmB;IAC3D,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;IAE5C,IAAI,UAAU,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC7C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CACL,UAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC;QACrC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAC5C,CAAC;AACJ,CAAC"}

package/src/lib/utils/index.d.ts

@@ -1 +1,2 @@
 export * from './module-helper';
+export * from './column-type';

package/src/lib/utils/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./module-helper"), exports);
+tslib_1.__exportStar(require("./column-type"), exports);
 //# sourceMappingURL=index.js.map

package/src/lib/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/json-api/json-api-nestjs/src/lib/utils/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../libs/json-api/json-api-nestjs/src/lib/utils/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,wDAA8B"}

package/src/lib/utils/module-helper.js

@@ -12,6 +12,7 @@ function prepareConfig(moduleParams) {
         providers: moduleParams['providers'] || [],
         controllers: moduleParams['controllers'] || [],
         entities: moduleParams['entities'],
+        excludeControllers: moduleParams['excludeControllers'] || [],
         options: {
             ...options,
             operationUrl: options['operationUrl'] || undefined,

package/src/lib/utils/module-helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"module-helper.js","sourceRoot":"","sources":["../../../../../../../libs/json-api/json-api-nestjs/src/lib/utils/module-helper.ts"],"names":[],"mappings":";;AAcA,sCAuBC;AAED,sCAQC;AA/CD,2CAA8C;AAS9C,4CAGsB;AAEtB,SAAgB,aAAa,CAC3B,YAA+B;IAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,IAAK,EAAgC,CAAC;IAE7E,OAAO;QACL,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,IAAI,mCAAuB;QACzE,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE;QACtC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1C,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE;QAC9C,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,OAAO,EAAE;YACP,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,SAAS;YAClD,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;YACrD,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YACzB,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,qBAAY;YAC/C,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;SACpC;QACD,KAAK,EAAE;YACL,qBAAqB,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;SACjH;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAC3B,MAA8B,EAC9B,WAA2B;IAE3B,OAAO,WAAW,CAAC,IAAI,CACrB,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,qCAAyB,EAAE,IAAI,CAAC,KAAK,MAAM,CAC1E,CAAC;AACJ,CAAC"}
+{"version":3,"file":"module-helper.js","sourceRoot":"","sources":["../../../../../../../libs/json-api/json-api-nestjs/src/lib/utils/module-helper.ts"],"names":[],"mappings":";;AAcA,sCAwBC;AAED,sCAQC;AAhDD,2CAA8C;AAS9C,4CAGsB;AAEtB,SAAgB,aAAa,CAC3B,YAA+B;IAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,IAAK,EAAgC,CAAC;IAE7E,OAAO;QACL,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,IAAI,mCAAuB;QACzE,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,IAAI,EAAE;QACtC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1C,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,IAAI,EAAE;QAC9C,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,IAAI,EAAE;QAC5D,OAAO,EAAE;YACP,GAAG,OAAO;YACV,YAAY,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,SAAS;YAClD,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;YACrD,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YACzB,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,IAAI,qBAAY;YAC/C,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;SACpC;QACD,KAAK,EAAE;YACL,qBAAqB,EAAE,YAAY,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;SACjH;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAC3B,MAA8B,EAC9B,WAA2B;IAE3B,OAAO,WAAW,CAAC,IAAI,CACrB,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,qCAAyB,EAAE,IAAI,CAAC,KAAK,MAAM,CAC1E,CAAC;AACJ,CAAC"}