zibri 2.4.0 → 2.5.0

package/src/index.ts

@@ -120,6 +120,7 @@ export * from './routing/decorators/get.decorator';
 export * from './routing/decorators/post.decorator';
 export * from './routing/decorators/delete.decorator';
 export * from './routing/decorators/patch.decorator';
+export * from './routing/decorators/http-decorator-option-input.model';
 export * from './routing/decorators/param.decorator';
 export * from './routing/decorators/body.decorator';
 
@@ -134,10 +135,13 @@ export * from './routing/models/crud-controller.model';
 // context
 export * from './context/als.utilities';
 export * from './context/base-context';
+
 export * from './context/request/http-request.context';
 export * from './context/request/websocket-request.context';
 export * from './context/request/request-context-token.model';
 
+export * from './context/cache/cache.context';
+
 // error handling
 export * from './error-handling/error-handler';
 export * from './error-handling/error-handler.model';
@@ -201,6 +205,7 @@ export * from './entity/partial-class.model';
 export * from './entity/pick-class.model';
 export * from './entity/any-object.model';
 export * from './entity/base-entity.model';
+export * from './entity/entity-metadata-missing.error';
 
 export * from './entity/decorators/entity.decorator';
 export * from './entity/decorators/property.decorator';
@@ -213,7 +218,8 @@ export * from './entity/models/date-property-metadata.model';
 export * from './entity/models/boolean-property-metadata.model';
 export * from './entity/models/many-to-one-property-metadata.model';
 export * from './entity/models/one-to-many-property-metadata.model';
-export * from './entity/models/one-to-one-property-metadata.model';
+export * from './entity/models/belongs-to-one-property-metadata.model';
+export * from './entity/models/has-one-property-metadata.model';
 export * from './entity/models/many-to-many-property-metadata.model';
 export * from './entity/models/relation.enum';
 export * from './entity/models/unknown-property-metadata.model';
@@ -264,7 +270,13 @@ export * from './data-source/query-failed.error';
 export * from './data-source/decorators/data-source.decorator';
 
 export * from './data-source/data-sources/data-source.interface';
-export * from './data-source/data-sources/postgres-data-source.model';
+export * from './data-source/data-sources/postgres-typeorm-data-source.model';
+export * from './data-source/data-sources/typeorm-base-data-source.model';
+export * from './data-source/data-sources/data-source-initialization.error';
+export * from './data-source/data-sources/sql-data-source.interface';
+
+export * from './data-source/data-sources/where-converter/typeorm-where-filter.converter';
+export * from './data-source/data-sources/where-converter/postgres-typeorm-where-filter.converter';
 
 export * from './data-source/transaction/transaction.model';
 
@@ -284,13 +296,14 @@ export * from './data-source/models/options/update-all-options.model';
 export * from './data-source/models/options/update-by-id-options.model';
 export * from './data-source/models/options/count-options.model';
 
-export * from './data-source/models/where/where-filter.model';
 export * from './data-source/models/where/array-where-filter.model';
 export * from './data-source/models/where/boolean-where-filter.model';
 export * from './data-source/models/where/date-where-filter.model';
 export * from './data-source/models/where/number-where-filter.model';
 export * from './data-source/models/where/object-where-filter.model';
 export * from './data-source/models/where/string-where-filter.model';
+export * from './data-source/models/where/where-filter-keys.model';
+export * from './data-source/models/where/where-filter.model';
 
 export * from './data-source/migration/migration.model';
 export * from './data-source/migration/migration-entity.model';
@@ -529,6 +542,13 @@ export * from './caching/store/cache-store.interface';
 export * from './caching/store/cached-value.model';
 export * from './caching/store/in-memory.cache-store';
 
+// versioning
+export * from './versioning/route-with-version-data.model';
+export * from './versioning/supported-versions-options.model';
+export * from './versioning/version.model';
+export * from './versioning/versioning-service.interface';
+export * from './versioning/versioning.service';
+
 // types
 export * from './types/any-enum.type';
 export * from './types/deep-partial.type';
@@ -536,13 +556,11 @@ export * from './types/exclude-strict.type';
 export * from './types/newable.type';
 export * from './types/omit-strict.type';
 export * from './types/percentage.type';
-export * from './types/version.type';
 
 // utilities
 export * from './utilities/bytes';
 export * from './utilities/doubly-linked-list';
-export * from './utilities/compare-versions.function';
-export * from './utilities/is-version.function';
+export * from './utilities/sem-ver.utilities';
 export * from './utilities/now-in-ns.function';
 export * from './utilities/promise.utilities';
 export * from './utilities/ms';

package/src/localization/formatting/format-price.function.ts

@@ -4,7 +4,6 @@ import { inject } from '../../di/inject.function';
 import { BigNumber } from '../../utilities/number.utilities';
 import { CurrencyCode } from '../models/currency-code.model';
 import { LanguageCode } from '../models/language-code.model';
-import { LocalizeOptions } from '../models/localize-options.model';
 
 /**
  * Default implementation for formatting prices.
@@ -14,8 +13,8 @@ import { LocalizeOptions } from '../models/localize-options.model';
  */
 export const formatPrice: FormatPriceFn = (
     price: number | BigNumber,
-    currency: CurrencyCode = inject<LocalizeOptions>(ZIBRI_DI_TOKENS.LOCALIZE_OPTIONS).currency,
-    language: LanguageCode = inject<LocalizeOptions>(ZIBRI_DI_TOKENS.LOCALIZE_OPTIONS).language
+    currency: CurrencyCode = inject(ZIBRI_DI_TOKENS.LOCALIZE_OPTIONS).currency,
+    language: LanguageCode = inject(ZIBRI_DI_TOKENS.LOCALIZE_OPTIONS).language
 ) => {
     const v: number = typeof price === 'number' ? price : price.toNumber();
     return v.toLocaleString(language, { style: 'currency', currency });

package/src/logging/log-context.model.ts

@@ -1,5 +1,5 @@
 import { LoggedError } from './logged-error.model';
-import { CacheOperation } from '../caching/cache/cache-operation.enum';
+import { CacheContext } from '../context/cache/cache.context';
 import { Property } from '../entity/decorators/property.decorator';
 import { HttpMethod } from '../http/http-method.enum';
 import { HttpStatus } from '../http/http-status.enum';
@@ -40,43 +40,12 @@ export class LogRequestContext {
      * The http status of the response, if the request already finished.
      */
     @Property.number({ enum: HttpStatus, required: false })
-    status?: HttpStatus;
+    status?: HttpStatus | null;
     /**
      * The duration that the request took in ms, if it already finished.
      */
     @Property.number({ required: false })
-    durationInMs?: number;
-}
-
-/**
- * Context information about a cache that triggered a log.
- */
-export class LogCacheContext {
-    /**
-     * The name of the cache.
-     */
-    @Property.string()
-    cache!: string;
-    /**
-     * The cache operation currently running.
-     */
-    @Property.string({ enum: CacheOperation })
-    operation!: CacheOperation;
-    /**
-     * The key of the value in the cache.
-     */
-    @Property.unknown({ required: false })
-    key?: unknown;
-    /**
-     * Whether or not the cache has been hit.
-     */
-    @Property.boolean({ required: false })
-    hit?: boolean;
-    /**
-     * The duration that the original function took.
-     */
-    @Property.number({ required: false })
-    durationInMs?: number;
+    durationInMs?: number | null;
 }
 
 /**
@@ -92,22 +61,22 @@ export class LogContext {
      * Any custom additional metadata for the log context.
      */
     @Property.object({ cls: () => LogContextMetadata, required: false, allowAdditionalProperties: true })
-    metadata?: LogContextMetadata;
+    metadata?: LogContextMetadata | null;
     /**
      * Context information about the request that triggered the log.
      */
     @Property.object({ cls: () => LogRequestContext, required: false })
-    request?: LogRequestContext;
+    request?: LogRequestContext | null;
     /**
      * Context information about the cache that triggered the log.
      */
-    @Property.array({ items: { type: 'object', cls: () => LogCacheContext }, required: false })
-    cache?: LogCacheContext[];
+    @Property.array({ items: { type: 'object', cls: () => CacheContext }, required: false })
+    cache?: CacheContext[] | null;
     /**
      * An error associated to this log.
      */
     @Property.object({ cls: () => LoggedError, required: false })
-    error?: LoggedError;
+    error?: LoggedError | null;
 }
 
 /**

package/src/logging/logger.ts

@@ -82,7 +82,7 @@ export class Logger implements LoggerInterface, OnAppInit {
         if (requestContext?.type === 'http-request') {
             request = {
                 status: requestContext.request.res?.statusCode,
-                // TODO
+                // TODO: track duration on requests
                 // durationInMs: currentRequest.res?.app,
                 method: requestContext.request.method,
                 url: requestContext.request.originalUrl,

package/src/multithreading/models/thread-job-entity.model.ts

@@ -33,11 +33,11 @@ export class ThreadJobEntity<WorkerData extends BaseThreadJobWorkerData, ResultT
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.number({ required: false })
-    startedAtMs?: number;
+    startedAtMs?: number | null;
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.number({ required: false })
-    stoppedAtMs?: number;
+    stoppedAtMs?: number | null;
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.string({ enum: ThreadJobStatus })
@@ -45,7 +45,7 @@ export class ThreadJobEntity<WorkerData extends BaseThreadJobWorkerData, ResultT
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.number({ required: false })
-    threadId?: number;
+    threadId?: number | null;
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.number()
@@ -61,7 +61,7 @@ export class ThreadJobEntity<WorkerData extends BaseThreadJobWorkerData, ResultT
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.unknown({ required: false })
-    error?: Error;
+    error?: Error | null;
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.unknown()
@@ -69,5 +69,5 @@ export class ThreadJobEntity<WorkerData extends BaseThreadJobWorkerData, ResultT
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.unknown({ required: false })
-    result?: ResultType;
+    result?: ResultType | null;
 }

package/src/multithreading/services/thread-job.ts

@@ -21,11 +21,11 @@ export class ThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType> i
     /**
      * Timestamp of when the job was started in milliseconds.
      */
-    startedAtMs?: number;
+    startedAtMs?: number | null;
     /**
      * Timestamp of when the job was stopped in milliseconds.
      */
-    stoppedAtMs?: number;
+    stoppedAtMs?: number | null;
     /**
      * A unique identifier of the job.
      * **This differs from the threadId, which is created by the os and set when the thread actually starts.**.
@@ -39,7 +39,7 @@ export class ThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType> i
      * The id of the thread that the job is running in.
      * Set by the os.
      */
-    threadId?: number;
+    threadId?: number | null;
     /**
      * The progress of the job in a percentage.
      */
@@ -47,7 +47,7 @@ export class ThreadJob<WorkerData extends BaseThreadJobWorkerData, ResultType> i
     /**
      * The error that the job failed with.
      */
-    error?: Error;
+    error?: Error | null;
     /**
      * The result that the job finished with.
      */

package/src/open-api/open-api-service.interface.ts

@@ -2,6 +2,7 @@
 import { ZibriApplication } from '../application';
 import { OpenApiDefinition } from './open-api.model';
 import { Route } from '../routing/controller-route-configuration.model';
+import { Version } from '../versioning/version.model';
 
 /**
  * Interface for an open api service.
@@ -14,5 +15,5 @@ export interface OpenApiServiceInterface {
     /**
      * Creates the open api definition.
      */
-    createOpenApiDefinition: (app: ZibriApplication) => OpenApiDefinition | Promise<OpenApiDefinition>
+    createOpenApiDefinition: (app: ZibriApplication, version: Version) => OpenApiDefinition | Promise<OpenApiDefinition>
 }