zibri 2.4.1 → 2.5.0

package/src/email/models/email.model.ts

@@ -20,7 +20,7 @@ export class Email extends BaseEntity {
      * Optional id of a userId to which this email belongs.
      */
     @Property.string({ format: 'uuid', required: false })
-    userId?: string;
+    userId?: string | null;
 
     /**
      * Whether or not the email should be stored in the db, even after it has been sent.
@@ -56,19 +56,19 @@ export class Email extends BaseEntity {
      * The recipients that should receive the email as cc.
      */
     @Property.array({ items: { type: 'string', format: 'email' }, required: false })
-    cc?: string[];
+    cc?: string[] | null;
 
     /**
      * The recipients that should receive the email as bcc.
      */
     @Property.array({ items: { type: 'string', format: 'email' }, required: false })
-    bcc?: string[];
+    bcc?: string[] | null;
 
     /**
      * The attachments of the email.
      */
     @Property.array({ items: { type: 'object', cls: () => EmailAttachment }, required: false })
-    attachments?: EmailAttachment[];
+    attachments?: EmailAttachment[] | null;
 
     /**
      * The emails status, like QUEUED, SENT or FAILED etc.

package/src/entity/generation/generate-entity-file.function.ts

@@ -176,7 +176,7 @@ function mapSchemaToDecoratorLines(
                 }
                 return ['    @Property.date({ required: false })'];
             }
-            // TODO
+            // TODO handle enums in entity generation
             // if (schema.enum) {
             //     return { type: schema.enum.map(v => JsonUtilities.stringify(v)).join(' | '), isRef: false };
             // }

package/src/event/event-subscriber-run.model.ts

@@ -33,7 +33,7 @@ export class EventSubscriberRun<T> extends BaseEntity {
      * The error property if the run failed.
      */
     @Property.unknown({ required: false })
-    error?: Error;
+    error?: Error | null;
 }
 
 /**

package/src/global/global-registry.ts

@@ -7,7 +7,7 @@ import { DiProvider } from '../di/models/di-provider.model';
 import { BaseEntity } from '../entity/base-entity.model';
 import { BodyParserInterface } from '../parsing/body-parser.interface';
 import { Newable } from '../types/newable.type';
-import { Version } from '../types/version.type';
+import { SemVerVersion } from '../utilities/sem-ver.utilities';
 
 /**
  * The data of the app.
@@ -28,7 +28,7 @@ export type AppData = {
     /**
      * The current version of the app.
      */
-    version?: Version
+    version?: SemVerVersion
 };
 
 /**

package/src/http/http-request.model.ts

@@ -1,7 +1,7 @@
 import { Request } from 'express';
 
+import { Header } from './header.type';
 import { HttpMethod } from './http-method.enum';
-import { KnownHeader } from './known-header.enum';
 import { OmitStrict } from '../types/omit-strict.type';
 
 /**
@@ -11,7 +11,7 @@ export type HttpRequest<
     T = unknown,
     PathParamsObject extends Record<string, unknown> = Record<string, string | undefined>,
     QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>,
-    HeaderParamsObject extends Record<string, unknown> = Partial<Record<KnownHeader, string | undefined>>
+    HeaderParamsObject extends Record<string, unknown> = Partial<Record<Header, string | undefined>>
 // eslint-disable-next-line typescript/no-explicit-any
 > = OmitStrict<Request<Record<string, string>, any, T>, 'query' | 'headers' | 'params' | 'method'> & {
     /**

package/src/http/known-header.enum.ts

@@ -26,6 +26,7 @@ export enum KnownHeader {
     X_FORWARDED_HOST = 'x-forwarded-host',
     X_FORWARDED_PROTO = 'x-forwarded-proto',
     X_REAL_IP = 'x-real-ip',
+    X_VERSION = 'x-version',
     IF_NONE_MATCH = 'if-none-match',
     IIF_MODIFIED_SINCE = 'if-modified-since',
     CONNECTION = 'connection',

package/src/http-client/http-client.ts

@@ -1,4 +1,3 @@
-
 import axios, { AxiosInstance, AxiosResponse, isAxiosError, RawAxiosRequestConfig, ResponseType } from 'axios';
 
 import { HttpClientResponse, HttpClientResponseForBodyType } from './http-client-response.model';

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';
 
@@ -541,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';
@@ -548,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

@@ -40,12 +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;
+    durationInMs?: number | null;
 }
 
 /**
@@ -61,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: () => CacheContext }, required: false })
-    cache?: CacheContext[];
+    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>
 }