zibri 2.4.1 → 2.5.0

package/src/plugin/payment/providers/pay-pal/pay-pal-client.ts

@@ -77,7 +77,7 @@ class PayPalLink {
      * The method of the link.
      */
     @Property.string({ required: false })
-    method?: string;
+    method?: string | null;
 }
 
 /**
@@ -93,12 +93,12 @@ class CreateOrderResp {
      * The status of the order.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
     /**
      * The links of the order.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } })
-    links?: PayPalLink[];
+    links?: PayPalLink[] | null;
 }
 
 /**
@@ -147,7 +147,7 @@ export class PayPalCapture {
      * The status of the capture.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
 }
 
 /**
@@ -158,7 +158,7 @@ class PayPalPayments {
      * The payment captures.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalCapture } })
-    captures?: PayPalCapture[];
+    captures?: PayPalCapture[] | null;
 }
 
 /**
@@ -169,7 +169,7 @@ class PayPalPurchaseUnit {
      * Any payments that belong to this purchase unit.
      */
     @Property.object({ required: false, cls: () => PayPalPayments })
-    payments?: PayPalPayments;
+    payments?: PayPalPayments | null;
 }
 
 /**
@@ -186,13 +186,13 @@ export class CaptureOrderResp {
      * The status of the capture.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
 
     /**
      * The purchase units of the capture.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalPurchaseUnit } })
-    purchase_units?: PayPalPurchaseUnit[];
+    purchase_units?: PayPalPurchaseUnit[] | null;
 }
 
 /**
@@ -209,13 +209,13 @@ class PayPalAuthorization {
      * The status of the authorization.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
 
     /**
      * The amount that has been authorized.
      */
     @Property.object({ required: false, cls: () => PaymentAmount })
-    amount?: PaymentAmount;
+    amount?: PaymentAmount | null;
 }
 
 /**
@@ -226,7 +226,7 @@ class PayPalPaymentsWithAuth {
      * The authorizations for the payments.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalAuthorization } })
-    authorizations?: PayPalAuthorization[];
+    authorizations?: PayPalAuthorization[] | null;
 }
 
 /**
@@ -237,7 +237,7 @@ class PayPalPurchaseUnitWithAuth {
      * The payments including the authorizations.
      */
     @Property.object({ required: false, cls: () => PayPalPaymentsWithAuth })
-    payments?: PayPalPaymentsWithAuth;
+    payments?: PayPalPaymentsWithAuth | null;
 }
 
 /**
@@ -260,7 +260,7 @@ export class GetOrderResp {
      * The purchase units of this order.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalPurchaseUnitWithAuth } })
-    purchase_units?: PayPalPurchaseUnitWithAuth[];
+    purchase_units?: PayPalPurchaseUnitWithAuth[] | null;
 }
 
 /**
@@ -277,13 +277,13 @@ export class AuthorizationCaptureResp {
      * The status of the authorization.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
 
     /**
      * Any links that belong to this authorization.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } })
-    links?: PayPalLink[];
+    links?: PayPalLink[] | null;
 }
 
 /**
@@ -300,13 +300,13 @@ export class RefundCaptureResp {
      * The status of the refund.
      */
     @Property.string({ required: false })
-    status?: string;
+    status?: string | null;
 
     /**
      * Any links that belong to this refund.
      */
     @Property.array({ required: false, items: { type: 'object', cls: () => PayPalLink } })
-    links?: PayPalLink[];
+    links?: PayPalLink[] | null;
 }
 
 /**

package/src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.test.ts

@@ -40,7 +40,7 @@ async function getSandboxToken(clientId: string, clientSecret: string): Promise<
     return access_token;
 }
 
-// TODO: this currently doesn't work.
+// TODO: this currently doesn't work
 async function simulateBuyerApproval(merchantToken: string, orderId: string, returnUrl: string, cancelUrl: string): Promise<void> {
     const res: Response = await fetch(
         `https://api-m.sandbox.paypal.com/v2/checkout/orders/${orderId}/confirm-payment-source`,

package/src/plugin/payment/providers/pay-pal/pay-pal.payment-provider.ts

@@ -356,7 +356,7 @@ export class PayPalPaymentProvider implements PaymentProviderInterface<
             const resp: CaptureOrderResp = await this.client.captureOrder(payment.data.orderId);
             // TODO: handle payments with multiple parts
             const capture: PayPalCapture | undefined = resp.purchase_units?.[0]?.payments?.captures?.[0];
-            const captureStatus: string | undefined = capture?.status ?? resp.status;
+            const captureStatus: string | undefined = capture?.status ?? resp.status ?? undefined;
 
             if (capture?.id && captureStatus === 'COMPLETED') {
                 payment.status = PaymentStatus.PAID;

package/src/preact/preact.utilities.ts

@@ -236,7 +236,7 @@ export abstract class PreactUtilities {
                 .replaceAll('</script>', '\\u003c/script>');
 
             const context: HttpRequestContext | WebsocketRequestContext | undefined = inject(ZIBRI_DI_TOKENS.CURRENT_REQUEST_CONTEXT);
-            const nonce: string | undefined = await context?.get(ZIBRI_REQUEST_CONTEXT_TOKENS.NONCE);
+            const nonce: string | undefined = context?.get(ZIBRI_REQUEST_CONTEXT_TOKENS.NONCE);
             const nonceAttr: string = nonce ? ` nonce="${nonce}"` : '';
             if (html.includes('</body>')) {
                 html = html.replace(

package/src/preact/validate-email-templates.function.ts

@@ -1,4 +1,4 @@
-// TODO
+// TODO implement validate email templates function
 
 /**
  * Validates that all email templates have a valid structure.

package/src/rate-limiting/rate-limiter.ts

@@ -1,3 +1,4 @@
+import { warn } from '../logging/logger.helpers';
 import { Ms } from '../utilities/ms';
 
 /**
@@ -10,56 +11,66 @@ export class RateLimiter {
 
     private constructor(
         private readonly max: number,
-        private readonly intervalInMs: number
+        private readonly intervalInMs: number,
+        initialTokens: number
     ) {
-        this.tokens = max;
+        if (initialTokens > max) {
+            warn('initialTokens are bigger than max, replacing initialTokens with the value of max');
+            initialTokens = max;
+        }
+        this.tokens = initialTokens;
         this.lastRefill = Date.now();
     }
 
     /**
      * Creates a rate limiter with the provided maximum available per day.
      * @param max - The maximum available per day.
+     * @param initialTokens - The amount of initial tokens to fill. Defaults to the value of max.
      * @returns The RateLimiter.
      */
-    static perDay(max: number): RateLimiter {
-        return new this(max, Ms.DAY);
+    static perDay(max: number, initialTokens: number = max): RateLimiter {
+        return new this(max, Ms.DAY, initialTokens);
     }
 
     /**
      * Creates a rate limiter with the provided maximum available per hour.
      * @param max - The maximum available per hour.
+     * @param initialTokens - The amount of initial tokens to fill. Defaults to the value of max.
      * @returns The RateLimiter.
      */
-    static perHour(max: number): RateLimiter {
-        return new this(max, Ms.HOUR);
+    static perHour(max: number, initialTokens: number = max): RateLimiter {
+        return new this(max, Ms.HOUR, initialTokens);
     }
 
     /**
      * Creates a rate limiter with the provided maximum available per minute.
      * @param max - The maximum available per minute.
+     * @param initialTokens - The amount of initial tokens to fill. Defaults to the value of max.
      * @returns The RateLimiter.
      */
-    static perMinute(max: number): RateLimiter {
-        return new this(max, Ms.MINUTE);
+    static perMinute(max: number, initialTokens: number = max): RateLimiter {
+        return new this(max, Ms.MINUTE, initialTokens);
     }
 
     /**
      * Creates a rate limiter with the provided maximum available per second.
      * @param max - The maximum available per seconds.
+     * @param initialTokens - The amount of initial tokens to fill. Defaults to the value of max.
      * @returns The RateLimiter.
      */
-    static perSecond(max: number): RateLimiter {
-        return new this(max, Ms.SECOND);
+    static perSecond(max: number, initialTokens: number = max): RateLimiter {
+        return new this(max, Ms.SECOND, initialTokens);
     }
 
     /**
      * Creates a rate limiter with a custom interval.
      * @param max - The maximum available per the given interval.
      * @param intervalInMs - The interval in ms.
+     * @param initialTokens - The amount of initial tokens to fill. Defaults to the value of max.
      * @returns The RateLimiter.
      */
-    static custom(max: number, intervalInMs: number): RateLimiter {
-        return new this(max, intervalInMs);
+    static custom(max: number, intervalInMs: number, initialTokens: number = max): RateLimiter {
+        return new this(max, intervalInMs, initialTokens);
     }
 
     private refill(): void {

package/src/routing/controller-route-configuration.model.ts

@@ -1,4 +1,5 @@
 import { HttpMethod } from '../http/http-method.enum';
+import { SupportedVersionsOptions } from '../versioning/supported-versions-options.model';
 
 /**
  * Definition for a route used eg. By controllers.
@@ -21,5 +22,9 @@ export type ControllerRouteConfiguration = {
     /**
      * The name of the method on the controller that is responsible for handling requests to the endpoint.
      */
-    controllerMethod: string
+    controllerMethod: string,
+    /**
+     * Configuration on what versions are supported. Defaults to '^latest'.
+     */
+    versions: SupportedVersionsOptions | undefined
 };

package/src/routing/decorators/controller.decorator.ts

@@ -2,6 +2,7 @@ import { GlobalRegistry } from '../../global/global-registry';
 import { Newable } from '../../types/newable.type';
 import { OmitStrict } from '../../types/omit-strict.type';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
+import { SupportedVersionsOptions } from '../../versioning/supported-versions-options.model';
 import { Route } from '../controller-route-configuration.model';
 
 /**
@@ -12,6 +13,10 @@ export type ControllerData = {
      * The base route of the controller. Any endpoints inside this class will be prefixed with this.
      */
     baseRoute: Route,
+    /**
+     * The versions that should be supported by this controller's routes. Can be overridden per route.
+     */
+    versions: SupportedVersionsOptions,
     /**
      * Whether or not this controller is allowed to exist without being registered in the application.
      */
@@ -24,14 +29,15 @@ export type ControllerData = {
  * @param options - Additional options for the controller.
  */
 export function Controller(baseRoute: Route, options: Partial<OmitStrict<ControllerData, 'baseRoute'>> = {}): ClassDecorator {
-    const { allowOrphan = false } = options;
+    const { allowOrphan = false, versions = ['^latest'] } = options;
     return target => {
         // eslint-disable-next-line unicorn/error-message
         const stack: string = new Error().stack ?? '';
         MetadataUtilities.setFilePath(target, stack);
         MetadataUtilities.setControllerData(target, {
             baseRoute,
-            allowOrphan
+            allowOrphan,
+            versions
         });
         GlobalRegistry.injectables.push({
             token: target as unknown as Newable<unknown>,

package/src/routing/decorators/create-http-decorator.function.ts

@@ -1,16 +1,17 @@
 import { HttpMethod } from '../../http/http-method.enum';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
+import { SupportedVersionsOptions } from '../../versioning/supported-versions-options.model';
 import { Route, ControllerRouteConfiguration } from '../controller-route-configuration.model';
 
 // eslint-disable-next-line jsdoc/require-jsdoc
-export function createHttpDecorator(method: HttpMethod, path: Route): MethodDecorator {
+export function createHttpDecorator(method: HttpMethod, path: Route, versions: SupportedVersionsOptions | undefined): MethodDecorator {
     return (target, propertyKey) => {
         const ctor: Function = target.constructor;
         // eslint-disable-next-line unicorn/error-message
         const stack: string = new Error().stack ?? '';
         MetadataUtilities.setFilePath(ctor, stack);
         const routes: ControllerRouteConfiguration[] = MetadataUtilities.getControllerRoutes(ctor);
-        routes.push({ httpMethod: method, route: path, controllerMethod: propertyKey.toString() });
+        routes.push({ httpMethod: method, route: path, controllerMethod: propertyKey.toString(), versions });
         MetadataUtilities.setControllerRoutes(ctor, routes);
     };
 }

package/src/routing/decorators/delete.decorator.ts

@@ -1,11 +1,13 @@
 import { HttpMethod } from '../../http/http-method.enum';
 import { Route } from '../controller-route-configuration.model';
 import { createHttpDecorator } from './create-http-decorator.function';
+import { BaseHttpDecoratorInput } from './http-decorator-option-input.model';
 
 /**
  * Http DELETE endpoint.
  * @param path - The path of the endpoint, defaults to '/'.
+ * @param options - Additional options, like eg. The supported versions.
  */
-export function Delete(path: Route = '/'): MethodDecorator {
-    return createHttpDecorator(HttpMethod.DELETE, path);
+export function Delete(path: Route = '/', options: BaseHttpDecoratorInput = {}): MethodDecorator {
+    return createHttpDecorator(HttpMethod.DELETE, path, options.versions);
 }

package/src/routing/decorators/get.decorator.ts

@@ -1,11 +1,13 @@
 import { HttpMethod } from '../../http/http-method.enum';
 import { Route } from '../controller-route-configuration.model';
 import { createHttpDecorator } from './create-http-decorator.function';
+import { BaseHttpDecoratorInput } from './http-decorator-option-input.model';
 
 /**
  * Http GET endpoint.
  * @param path - The path of the endpoint, defaults to '/'.
+ * @param options - Additional options, like eg. The supported versions.
  */
-export function Get(path: Route = '/'): MethodDecorator {
-    return createHttpDecorator(HttpMethod.GET, path);
+export function Get(path: Route = '/', options: BaseHttpDecoratorInput = {}): MethodDecorator {
+    return createHttpDecorator(HttpMethod.GET, path, options.versions);
 }

package/src/routing/decorators/http-decorator-option-input.model.ts

@@ -0,0 +1,11 @@
+import { SupportedVersionsOptions } from '../../versioning/supported-versions-options.model';
+
+/**
+ * Base options shared by all http decorators.
+ */
+export type BaseHttpDecoratorInput = {
+    /**
+     * Configuration on what versions are supported.
+     */
+    versions?: SupportedVersionsOptions
+};

package/src/routing/decorators/patch.decorator.ts

@@ -1,11 +1,13 @@
 import { HttpMethod } from '../../http/http-method.enum';
 import { Route } from '../controller-route-configuration.model';
 import { createHttpDecorator } from './create-http-decorator.function';
+import { BaseHttpDecoratorInput } from './http-decorator-option-input.model';
 
 /**
  * Http PATCH endpoint.
  * @param path - The path of the endpoint, defaults to '/'.
+ * @param options - Additional options, like eg. The supported versions.
  */
-export function Patch(path: Route = '/'): MethodDecorator {
-    return createHttpDecorator(HttpMethod.PATCH, path);
+export function Patch(path: Route = '/', options: BaseHttpDecoratorInput = {}): MethodDecorator {
+    return createHttpDecorator(HttpMethod.PATCH, path, options.versions);
 }

package/src/routing/decorators/post.decorator.ts

@@ -1,11 +1,13 @@
 import { HttpMethod } from '../../http/http-method.enum';
 import { Route } from '../controller-route-configuration.model';
 import { createHttpDecorator } from './create-http-decorator.function';
+import { BaseHttpDecoratorInput } from './http-decorator-option-input.model';
 
 /**
  * Http POST endpoint.
  * @param path - The path of the endpoint, defaults to '/'.
+ * @param options - Additional options, like eg. The supported versions.
  */
-export function Post(path: Route = '/'): MethodDecorator {
-    return createHttpDecorator(HttpMethod.POST, path);
+export function Post(path: Route = '/', options: BaseHttpDecoratorInput = {}): MethodDecorator {
+    return createHttpDecorator(HttpMethod.POST, path, options.versions);
 }

package/src/routing/resolve-route-params.function.ts

@@ -87,6 +87,7 @@ async function parseRouteParams(
     const headerParams: Record<string, HeaderParamMetadata> = MetadataUtilities.getRouteHeaderParams(controllerClass, controllerMethod);
     for (const [indexStr, metadata] of ObjectUtilities.entries(headerParams)) {
         const idx: number = Number(indexStr);
+        context.request.headers ??= {};
         context.request.headers[metadata.name as KnownHeader] = parser.parseHeaderParam(context.request, metadata) as string | undefined;
         params[idx] = context.request.headers[metadata.name as KnownHeader];
     }

package/src/routing/route-configuration.model.ts

@@ -16,6 +16,7 @@ import { DateParamMetadataInput, DateParamMetadata } from './models/date-param-m
 import { NumberParamMetadataInput, NumberParamMetadata } from './models/number-param-metadata.model';
 import { ObjectParamMetadataInput, ObjectParamMetadata } from './models/object-param-metadata.model';
 import { StringParamMetadataInput, StringParamMetadata } from './models/string-param-metadata.model';
+import { SupportedVersionsOptions } from '../versioning/supported-versions-options.model';
 
 // eslint-disable-next-line jsdoc/require-jsdoc
 type PathMetaObjectToParamsObject<PathMetaObject extends Record<string, PathParamMetadata>> = {
@@ -207,7 +208,11 @@ export type RouteConfiguration<
     /**
      * Configuration on how to handle open api.
      */
-    openApi: OpenApiRouteConfiguration
+    openApi: OpenApiRouteConfiguration,
+    /**
+     * Configuration on what versions are supported.
+     */
+    versions: SupportedVersionsOptions
 };
 
 /**
@@ -226,7 +231,7 @@ export type RouteConfigurationInput<
         QueryMetaInputObjectToMetaObject<QueryMetaInputObject>,
         HeaderMetaInputObjectToMetaObject<HeaderMetaInputObject>
     >,
-    'bodyMetadata' | 'pathParams' | 'queryParams' | 'headerParams' | 'openApi'
+    'bodyMetadata' | 'pathParams' | 'queryParams' | 'headerParams' | 'openApi' | 'versions'
 > & {
     /**
      * The input metadata for the request body.
@@ -247,5 +252,10 @@ export type RouteConfigurationInput<
     /**
      * Configuration on how to handle open api.
      */
-    openApi?: Partial<OpenApiRouteConfiguration> & Pick<OpenApiRouteConfiguration, 'useInOpenApi'>
+    openApi?: Partial<OpenApiRouteConfiguration> & Pick<OpenApiRouteConfiguration, 'useInOpenApi'>,
+    /**
+     * Configuration on what versions are supported.
+     * Defaults to '^latest'.
+     */
+    versions?: SupportedVersionsOptions
 };