@zuplo/runtime 6.40.33 → 6.40.34

package/out/types/index.d.ts

@@ -451,6 +451,107 @@ export declare interface Auth0JwtInboundPolicyOptions {
     audience?: string;
 }
 
+/**
+ * Authorize requests using an AuthZEN compatible PDP
+ *
+ * @title AuthZEN Authorization
+ * @beta
+ * @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 AuthZenInboundPolicy extends InboundPolicy<AuthZenInboundPolicyOptions> {
+    #private;
+    constructor(options: AuthZenInboundPolicyOptions, policyName: string);
+    /**
+     * The handler that is called each time this policy is invoked
+     *
+     * @param request - The incoming Request
+     * @param context - The current context of the Request
+     * @returns A Response or Request object
+     */
+    handler(request: ZuploRequest, context: ZuploContext): Promise<ZuploRequest | Response>;
+    /**
+     * Set the authorization payload for the current request.
+     *
+     * @param context - The ZuploContext for the current request
+     * @param payload - The AuthZEN payload to send to the PDP service
+     */
+    static setAuthorizationPayload(context: ZuploContext, payload: Partial<AuthZenPayload>): void;
+    /**
+     * Get the authorization payload for the current request.
+     *
+     * @param context - The ZuploContext for the current request
+     * @returns The AuthZEN payload to send to the PDP service
+     */
+    static getAuthorizationPayload(context: ZuploContext): Partial<AuthZenPayload> | undefined;
+}
+
+/**
+ * The options for this policy.
+ */
+export declare interface AuthZenInboundPolicyOptions {
+    /**
+     * The hostname of the AuthZen PDP service.
+     */
+    authorizerHostname: string;
+    /**
+     * The authorization header to use when communicating with the AuthZen PDP service.
+     */
+    authorizerAuthorizationHeader?: string;
+    /**
+     * The subject of the request.
+     */
+    subject: {
+        /**
+         * The type of the resource.
+         */
+        type: string;
+        /**
+         * The id of the resource. Note you can use the `$authzen-prop()` syntax to reference the resource id.
+         */
+        id: string;
+        [k: string]: unknown;
+    };
+    /**
+     * The resource of the request. Note you can use the `$authzen-prop()` syntax to reference the resource id.
+     */
+    resource: {
+        /**
+         * The type of the resource.
+         */
+        type: string;
+        /**
+         * The id of the resource. Note you can use the `$authzen-prop()` syntax to reference the resource id.
+         */
+        id: string;
+        [k: string]: unknown;
+    };
+    /**
+     * The action of the request. Note you can use the `$authzen-prop()` syntax to reference the action.
+     */
+    action: string;
+    /**
+     * If explicitly set to false, the policy will not throw an error if there is any problem communicating with the AuthZen PDP service and allow calls through. By default throwOnError is assumed to be on/true.
+     */
+    throwOnError?: boolean;
+}
+
+/* Excluded from this release type: AuthZenPayload */
+
+export declare interface AuthZenPayloadSettings {
+    subject?: AuthZenTypeIdPair;
+    resource?: AuthZenTypeIdPair;
+    action?: string;
+}
+
+export declare interface AuthZenTypeIdPair {
+    type: string;
+    id: string;
+}
+
 declare interface AwsLambdaEventV1 {
     [key: string]: string | null | undefined | number | boolean | object;
     version: "1.0";
@@ -798,8 +899,7 @@ export declare interface BasicAuthInboundPolicyOptions {
     allowUnauthenticatedRequests?: boolean;
 }
 
-declare interface BasicDictionary {
-    [key: string]: string | number | boolean | null | undefined;
+declare interface BasicDictionary extends Record<string, string | number | boolean | null | undefined> {
 }
 
 /* Excluded from this release type: BatchDispatch */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zuplo/runtime",
   "type": "module",
-  "version": "6.40.33",
+  "version": "6.40.34",
   "repository": "https://github.com/zuplo/zuplo",
   "author": "Zuplo, Inc.",
   "exports": {