@zuplo/runtime 5.2098.0 → 5.2099.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/runtime",
-  "version": "5.2098.0",
+  "version": "5.2099.0",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {

package/types-beta.d.ts

@@ -452,6 +452,10 @@ export declare interface AxiomaticsAuthZInboundPolicyOptions {
      * The password to use when authenticating with the PDP.
      */
     pdpPassword: string;
+    /**
+     * Indicates whether the plugin should include default action attributes in the authorization request.
+     */
+    includeDefaultActionAttributes?: boolean;
     /**
      * Indicates whether the plugin should include default resource attributes in the authorization request.
      */
@@ -568,8 +572,67 @@ declare interface BatchDispatcherOptions {
     name?: string;
 }
 
-declare interface BuildAuthorizationRequestHook {
-    (request: ZuploRequest, context: ZuploContext, currentXacmlRequest: XacmlRequest): Promise<XacmlRequest>;
+/**
+ * Authenticate requests based on the mTLS protocol.
+ *
+ * @remarks
+ * The brownout policy allows performing scheduled downtime on your API. This can
+ * be useful for helping notify clients of an impending deprecation or for
+ * scheduling maintenance.
+ *
+ * This policy uses {@link https://crontab.guru|cron schedules} to check if a request
+ * should experience a brownout or not. When a request falls into a scheduled
+ * brownout an error response will be return. The error response can be customized
+ * by setting the `problem` properties.
+ *
+ * For more information using brownouts to alert clients on impending API
+ * changes/deprecations see our blog post
+ * {@link https://zuplo.com/blog/2022/05/17/how-to-version-an-api|How to version an API}
+ *
+ * @title Brown Out
+ * @public
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class BrownoutInboundPolicy extends InboundPolicy<BrownoutInboundPolicyOptions> {
+    crons: Cron[];
+    constructor(options: BrownoutInboundPolicyOptions, policyName: string);
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface BrownoutInboundPolicyOptions {
+    /**
+     * The cron schedule for when this policy is enabled. This can be a single cron string or an array of multiple cron strings.
+     */
+    cronSchedule: string | string[];
+    /**
+     * The problem that is returned in the response body when this policy is enabled.
+     */
+    problem?: {
+        /**
+         * The type of problem.
+         */
+        type?: string;
+        /**
+         * The title of problem.
+         */
+        title?: string;
+        /**
+         * The detail of problem.
+         */
+        detail?: string;
+        /**
+         * Http status code of the problem.
+         */
+        status?: number;
+        [k: string]: unknown;
+    };
 }
 
 /* Excluded from this release type: BuildEnvironment */
@@ -935,6 +998,82 @@ export declare interface CorsPolicyConfiguration {
     exposeHeaders?: string[] | string;
 }
 
+declare class Cron {
+    readonly seconds: ReadonlyArray<number>;
+    readonly minutes: ReadonlyArray<number>;
+    readonly hours: ReadonlyArray<number>;
+    readonly days: ReadonlyArray<number>;
+    readonly months: ReadonlyArray<number>;
+    readonly weekdays: ReadonlyArray<number>;
+    readonly reversed: {
+        seconds: ReadonlyArray<number>;
+        minutes: ReadonlyArray<number>;
+        hours: ReadonlyArray<number>;
+        days: ReadonlyArray<number>;
+        months: ReadonlyArray<number>;
+        weekdays: ReadonlyArray<number>;
+    };
+    constructor({ seconds, minutes, hours, days, months, weekdays, }: CronDefinition);
+    /**
+     * Find the next or previous hour, starting from the given start hour that matches the hour constraint.
+     * startHour itself might also be allowed.
+     */
+    private findAllowedHour;
+    /**
+     * Find the next or previous minute, starting from the given start minute that matches the minute constraint.
+     * startMinute itself might also be allowed.
+     */
+    private findAllowedMinute;
+    /**
+     * Find the next or previous second, starting from the given start second that matches the second constraint.
+     * startSecond itself IS NOT allowed.
+     */
+    private findAllowedSecond;
+    /**
+     * Find the next or previous time, starting from the given start time that matches the hour, minute
+     * and second constraints. startTime itself might also be allowed.
+     */
+    private findAllowedTime;
+    /**
+     * Find the next or previous day in the given month, starting from the given startDay
+     * that matches either the day or the weekday constraint. startDay itself might also be allowed.
+     */
+    private findAllowedDayInMonth;
+    /** Gets the next date starting from the given start date or now. */
+    getNextDate(startDate?: Date): Date;
+    /** Gets the specified amount of future dates starting from the given start date or now. */
+    getNextDates(amount: number, startDate?: Date): Date[];
+    /**
+     * Get an ES6 compatible iterator which iterates over the next dates starting from startDate or now.
+     * The iterator runs until the optional endDate is reached or forever.
+     */
+    getNextDatesIterator(startDate?: Date, endDate?: Date): Generator<Date, undefined, undefined>;
+    /** Gets the previous date starting from the given start date or now. */
+    getPrevDate(startDate?: Date): Date;
+    /** Gets the specified amount of previous dates starting from the given start date or now. */
+    getPrevDates(amount: number, startDate?: Date): Date[];
+    /**
+     * Get an ES6 compatible iterator which iterates over the previous dates starting from startDate or now.
+     * The iterator runs until the optional endDate is reached or forever.
+     */
+    getPrevDatesIterator(startDate?: Date, endDate?: Date): Generator<Date, undefined, undefined>;
+    /** Returns true when there is a cron date at the given date. */
+    matchDate(date: Date): boolean;
+}
+
+/**
+ * An object with contains for each element of a date, which values are allowed.
+ * Everything starting at 0, except for days.
+ */
+declare interface CronDefinition {
+    readonly seconds: Set<number>;
+    readonly minutes: Set<number>;
+    readonly hours: Set<number>;
+    readonly days: Set<number>;
+    readonly months: Set<number>;
+    readonly weekdays: Set<number>;
+}
+
 /**
  * @beta
  */

package/types-public.d.ts

@@ -445,6 +445,10 @@ export declare interface AxiomaticsAuthZInboundPolicyOptions {
      * The password to use when authenticating with the PDP.
      */
     pdpPassword: string;
+    /**
+     * Indicates whether the plugin should include default action attributes in the authorization request.
+     */
+    includeDefaultActionAttributes?: boolean;
     /**
      * Indicates whether the plugin should include default resource attributes in the authorization request.
      */
@@ -547,8 +551,67 @@ declare interface BatchDispatcherOptions {
     name?: string;
 }
 
-declare interface BuildAuthorizationRequestHook {
-    (request: ZuploRequest, context: ZuploContext, currentXacmlRequest: XacmlRequest): Promise<XacmlRequest>;
+/**
+ * Authenticate requests based on the mTLS protocol.
+ *
+ * @remarks
+ * The brownout policy allows performing scheduled downtime on your API. This can
+ * be useful for helping notify clients of an impending deprecation or for
+ * scheduling maintenance.
+ *
+ * This policy uses {@link https://crontab.guru|cron schedules} to check if a request
+ * should experience a brownout or not. When a request falls into a scheduled
+ * brownout an error response will be return. The error response can be customized
+ * by setting the `problem` properties.
+ *
+ * For more information using brownouts to alert clients on impending API
+ * changes/deprecations see our blog post
+ * {@link https://zuplo.com/blog/2022/05/17/how-to-version-an-api|How to version an API}
+ *
+ * @title Brown Out
+ * @public
+ * @param request - The ZuploRequest
+ * @param context - The ZuploContext
+ * @param options - The policy options set in policies.json
+ * @param policyName - The name of the policy as set in policies.json
+ * @returns A Request or a Response
+ */
+export declare class BrownoutInboundPolicy extends InboundPolicy<BrownoutInboundPolicyOptions> {
+    crons: Cron[];
+    constructor(options: BrownoutInboundPolicyOptions, policyName: string);
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface BrownoutInboundPolicyOptions {
+    /**
+     * The cron schedule for when this policy is enabled. This can be a single cron string or an array of multiple cron strings.
+     */
+    cronSchedule: string | string[];
+    /**
+     * The problem that is returned in the response body when this policy is enabled.
+     */
+    problem?: {
+        /**
+         * The type of problem.
+         */
+        type?: string;
+        /**
+         * The title of problem.
+         */
+        title?: string;
+        /**
+         * The detail of problem.
+         */
+        detail?: string;
+        /**
+         * Http status code of the problem.
+         */
+        status?: number;
+        [k: string]: unknown;
+    };
 }
 
 /* Excluded from this release type: BuildEnvironment */
@@ -914,6 +977,82 @@ export declare interface CorsPolicyConfiguration {
     exposeHeaders?: string[] | string;
 }
 
+declare class Cron {
+    readonly seconds: ReadonlyArray<number>;
+    readonly minutes: ReadonlyArray<number>;
+    readonly hours: ReadonlyArray<number>;
+    readonly days: ReadonlyArray<number>;
+    readonly months: ReadonlyArray<number>;
+    readonly weekdays: ReadonlyArray<number>;
+    readonly reversed: {
+        seconds: ReadonlyArray<number>;
+        minutes: ReadonlyArray<number>;
+        hours: ReadonlyArray<number>;
+        days: ReadonlyArray<number>;
+        months: ReadonlyArray<number>;
+        weekdays: ReadonlyArray<number>;
+    };
+    constructor({ seconds, minutes, hours, days, months, weekdays, }: CronDefinition);
+    /**
+     * Find the next or previous hour, starting from the given start hour that matches the hour constraint.
+     * startHour itself might also be allowed.
+     */
+    private findAllowedHour;
+    /**
+     * Find the next or previous minute, starting from the given start minute that matches the minute constraint.
+     * startMinute itself might also be allowed.
+     */
+    private findAllowedMinute;
+    /**
+     * Find the next or previous second, starting from the given start second that matches the second constraint.
+     * startSecond itself IS NOT allowed.
+     */
+    private findAllowedSecond;
+    /**
+     * Find the next or previous time, starting from the given start time that matches the hour, minute
+     * and second constraints. startTime itself might also be allowed.
+     */
+    private findAllowedTime;
+    /**
+     * Find the next or previous day in the given month, starting from the given startDay
+     * that matches either the day or the weekday constraint. startDay itself might also be allowed.
+     */
+    private findAllowedDayInMonth;
+    /** Gets the next date starting from the given start date or now. */
+    getNextDate(startDate?: Date): Date;
+    /** Gets the specified amount of future dates starting from the given start date or now. */
+    getNextDates(amount: number, startDate?: Date): Date[];
+    /**
+     * Get an ES6 compatible iterator which iterates over the next dates starting from startDate or now.
+     * The iterator runs until the optional endDate is reached or forever.
+     */
+    getNextDatesIterator(startDate?: Date, endDate?: Date): Generator<Date, undefined, undefined>;
+    /** Gets the previous date starting from the given start date or now. */
+    getPrevDate(startDate?: Date): Date;
+    /** Gets the specified amount of previous dates starting from the given start date or now. */
+    getPrevDates(amount: number, startDate?: Date): Date[];
+    /**
+     * Get an ES6 compatible iterator which iterates over the previous dates starting from startDate or now.
+     * The iterator runs until the optional endDate is reached or forever.
+     */
+    getPrevDatesIterator(startDate?: Date, endDate?: Date): Generator<Date, undefined, undefined>;
+    /** Returns true when there is a cron date at the given date. */
+    matchDate(date: Date): boolean;
+}
+
+/**
+ * An object with contains for each element of a date, which values are allowed.
+ * Everything starting at 0, except for days.
+ */
+declare interface CronDefinition {
+    readonly seconds: Set<number>;
+    readonly minutes: Set<number>;
+    readonly hours: Set<number>;
+    readonly days: Set<number>;
+    readonly months: Set<number>;
+    readonly weekdays: Set<number>;
+}
+
 /* Excluded from this release type: CryptoBeta */
 
 /**