@zuplo/runtime 5.2083.0 → 5.2084.0

package/package.json

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

package/types-beta.d.ts

@@ -170,6 +170,37 @@ export declare interface ApiKeyInboundPolicyOptions {
     disableAutomaticallyAddingKeyHeaderToOpenApi?: boolean;
 }
 
+/**
+ * A list of attributes that will be included in the authorization request.
+ */
+declare type Attribute = ({
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * A JSON path expression that selects the value of the attribute from incoming request.
+     */
+    valueSelector: string;
+} | {
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * The value of the attribute.
+     */
+    value: string;
+})[];
+
+declare interface Attribute_2 {
+    AttributeId: string;
+    Value: string | boolean | number | string[] | boolean[] | number[];
+    Issuer?: string;
+    DataType?: string;
+    IncludeInResult?: boolean;
+}
+
 export declare interface AuditLogDataStaxInit {
     url: string;
     xCassandraToken: string;
@@ -399,6 +430,45 @@ export declare class AWSLoggingPlugin extends LogPlugin {
     /* Excluded from this release type: getTransport */
 }
 
+/* Excluded from this release type: AxiomaticsAuthZInboundPolicy */
+
+/**
+ * The options for this policy.
+ */
+export declare interface AxiomaticsAuthZInboundPolicyOptions {
+    /**
+     * Indicates whether the request should continue if authorization fails. Default is `false` which means unauthorized users will automatically receive a 403 response.
+     */
+    allowUnauthorizedRequests?: boolean;
+    /**
+     * The URL to which the plugin will make a JSON POST request before proxying the original request.
+     */
+    pdpUrl: string;
+    /**
+     * The username to use when authenticating with the PDP.
+     */
+    pdpUsername: string;
+    /**
+     * The password to use when authenticating with the PDP.
+     */
+    pdpPassword: string;
+    /**
+     * Indicates whether the plugin should include default resource attributes in the authorization request.
+     */
+    includeDefaultResourceAttributes?: boolean;
+    /**
+     * Indicates whether the plugin should include default subject attributes in the authorization request.
+     */
+    includeDefaultSubjectAttributes?: boolean;
+    /**
+     * The name of the header that carries the JWT.
+     */
+    tokenHeaderName?: string;
+    accessSubjectAttributes?: Attribute;
+    resourceAttributes?: Attribute;
+    actionAttributes?: Attribute;
+}
+
 export declare class BackgroundDispatcher<TPayload> {
     #private;
     constructor(dispatcher: DispatchFunction<TPayload>, options: BatchDispatcherOptions);
@@ -498,6 +568,10 @@ declare interface BatchDispatcherOptions {
     name?: string;
 }
 
+declare interface BuildAuthorizationRequestHook {
+    (request: ZuploRequest, context: ZuploContext, currentXacmlRequest: XacmlRequest): Promise<XacmlRequest>;
+}
+
 /* Excluded from this release type: BuildEnvironment */
 
 declare interface BuildRouteConfiguration {
@@ -583,6 +657,13 @@ export declare interface CachingInboundPolicyOptions {
     statusCodes?: number[];
 }
 
+declare interface Category {
+    Id?: string;
+    CategoryId?: string;
+    Content?: string;
+    Attribute: Attribute_2[];
+}
+
 /**
  * Changes the HTTP method of the incoming request.
  *
@@ -2715,6 +2796,10 @@ export declare interface MonetizationSubscription extends MeteringSubscription {
     nextBillingCycle: string;
 }
 
+declare interface MultiRequests {
+    RequestReference: RequestReference;
+}
+
 declare interface NotFoundOptions {
     routesMatchedByPathOnly: RouteConfiguration[];
 }
@@ -3812,6 +3897,10 @@ declare type RequestParamsDefault = Record<string, string>;
 
 declare type RequestQueryDefault = Record<string, string>;
 
+declare interface RequestReference {
+    ReferenceId: string[];
+}
+
 /**
  * Enforces a maximum size in bytes of the incoming request.
  *
@@ -4861,6 +4950,29 @@ export declare function webSocketHandler(request: ZuploRequest, context: ZuploCo
  */
 export declare function webSocketPipelineHandler(request: ZuploRequest, context: ZuploContext): Promise<Response>;
 
+/**
+ * The request to the PDP
+ */
+declare interface XacmlRequest {
+    Request: {
+        ReturnPolicyIdList?: boolean;
+        CombinedDecision?: boolean;
+        XPathVersion?: string;
+        Category?: Omit<Category, "CategoryId"> & {
+            CategoryId: string;
+        }[];
+        Resource?: Category[];
+        Action?: Category[];
+        Environment?: Category[];
+        AccessSubject?: Category[];
+        RecipientSubject?: Category[];
+        IntermediarySubject?: Category[];
+        RequestingMachine?: Category[];
+        CodeBase?: Category[];
+        MultiRequests?: MultiRequests;
+    };
+}
+
 /**
  * Parses XML and converts it to JSON. This policy is useful for converting
  * legacy XML or SOAP APIs into modern REST APIs. It can be useful to add a

package/types-public.d.ts

@@ -170,6 +170,37 @@ export declare interface ApiKeyInboundPolicyOptions {
     disableAutomaticallyAddingKeyHeaderToOpenApi?: boolean;
 }
 
+/**
+ * A list of attributes that will be included in the authorization request.
+ */
+declare type Attribute = ({
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * A JSON path expression that selects the value of the attribute from incoming request.
+     */
+    valueSelector: string;
+} | {
+    /**
+     * The attribute ID that will be used in the PDP request.
+     */
+    attributeId: string;
+    /**
+     * The value of the attribute.
+     */
+    value: string;
+})[];
+
+declare interface Attribute_2 {
+    AttributeId: string;
+    Value: string | boolean | number | string[] | boolean[] | number[];
+    Issuer?: string;
+    DataType?: string;
+    IncludeInResult?: boolean;
+}
+
 export declare interface AuditLogDataStaxInit {
     url: string;
     xCassandraToken: string;
@@ -392,6 +423,45 @@ export declare class AWSLoggingPlugin extends LogPlugin {
     /* Excluded from this release type: getTransport */
 }
 
+/* Excluded from this release type: AxiomaticsAuthZInboundPolicy */
+
+/**
+ * The options for this policy.
+ */
+export declare interface AxiomaticsAuthZInboundPolicyOptions {
+    /**
+     * Indicates whether the request should continue if authorization fails. Default is `false` which means unauthorized users will automatically receive a 403 response.
+     */
+    allowUnauthorizedRequests?: boolean;
+    /**
+     * The URL to which the plugin will make a JSON POST request before proxying the original request.
+     */
+    pdpUrl: string;
+    /**
+     * The username to use when authenticating with the PDP.
+     */
+    pdpUsername: string;
+    /**
+     * The password to use when authenticating with the PDP.
+     */
+    pdpPassword: string;
+    /**
+     * Indicates whether the plugin should include default resource attributes in the authorization request.
+     */
+    includeDefaultResourceAttributes?: boolean;
+    /**
+     * Indicates whether the plugin should include default subject attributes in the authorization request.
+     */
+    includeDefaultSubjectAttributes?: boolean;
+    /**
+     * The name of the header that carries the JWT.
+     */
+    tokenHeaderName?: string;
+    accessSubjectAttributes?: Attribute;
+    resourceAttributes?: Attribute;
+    actionAttributes?: Attribute;
+}
+
 export declare class BackgroundDispatcher<TPayload> {
     #private;
     constructor(dispatcher: DispatchFunction<TPayload>, options: BatchDispatcherOptions);
@@ -477,6 +547,10 @@ declare interface BatchDispatcherOptions {
     name?: string;
 }
 
+declare interface BuildAuthorizationRequestHook {
+    (request: ZuploRequest, context: ZuploContext, currentXacmlRequest: XacmlRequest): Promise<XacmlRequest>;
+}
+
 /* Excluded from this release type: BuildEnvironment */
 
 declare interface BuildRouteConfiguration {
@@ -562,6 +636,13 @@ export declare interface CachingInboundPolicyOptions {
     statusCodes?: number[];
 }
 
+declare interface Category {
+    Id?: string;
+    CategoryId?: string;
+    Content?: string;
+    Attribute: Attribute_2[];
+}
+
 /**
  * Changes the HTTP method of the incoming request.
  *
@@ -1499,6 +1580,10 @@ declare type MonetizationPolicyMeters = {
 
 /* Excluded from this release type: MonetizationSubscription */
 
+declare interface MultiRequests {
+    RequestReference: RequestReference;
+}
+
 declare interface NotFoundOptions {
     routesMatchedByPathOnly: RouteConfiguration[];
 }
@@ -2461,6 +2546,10 @@ declare type RequestParamsDefault = Record<string, string>;
 
 declare type RequestQueryDefault = Record<string, string>;
 
+declare interface RequestReference {
+    ReferenceId: string[];
+}
+
 /**
  * Enforces a maximum size in bytes of the incoming request.
  *
@@ -3381,6 +3470,29 @@ declare interface WaitUntilFunc {
 
 /* Excluded from this release type: webSocketPipelineHandler */
 
+/**
+ * The request to the PDP
+ */
+declare interface XacmlRequest {
+    Request: {
+        ReturnPolicyIdList?: boolean;
+        CombinedDecision?: boolean;
+        XPathVersion?: string;
+        Category?: Omit<Category, "CategoryId"> & {
+            CategoryId: string;
+        }[];
+        Resource?: Category[];
+        Action?: Category[];
+        Environment?: Category[];
+        AccessSubject?: Category[];
+        RecipientSubject?: Category[];
+        IntermediarySubject?: Category[];
+        RequestingMachine?: Category[];
+        CodeBase?: Category[];
+        MultiRequests?: MultiRequests;
+    };
+}
+
 /**
  * Parses XML and converts it to JSON. This policy is useful for converting
  * legacy XML or SOAP APIs into modern REST APIs. It can be useful to add a