@zuplo/runtime 5.1586.0 → 5.1587.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +94 -94
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -109,11 +109,11 @@ declare interface AmberfloMeteringProperties extends Omit<AmberfloMeteringIngest
|
|
|
109
109
|
export declare const ApiAuthKeyInboundPolicy: typeof ApiKeyInboundPolicy;
|
|
110
110
|
|
|
111
111
|
/**
|
|
112
|
-
* The options for this policy
|
|
112
|
+
* The options for this policy.
|
|
113
113
|
*/
|
|
114
114
|
export declare interface ApiAuthKeyInboundPolicyOptions {
|
|
115
115
|
/**
|
|
116
|
-
* If 'true' allows the request to continue even if authenticated. When 'false' (the default) any unauthenticated request is automatically rejected with a 401
|
|
116
|
+
* If 'true' allows the request to continue even if authenticated. When 'false' (the default) any unauthenticated request is automatically rejected with a 401.
|
|
117
117
|
*/
|
|
118
118
|
allowUnauthenticatedRequests?: boolean;
|
|
119
119
|
}
|
|
@@ -144,7 +144,7 @@ export declare interface ApiAuthKeyInboundPolicyOptions {
|
|
|
144
144
|
export declare function ApiKeyInboundPolicy(request: ZuploRequest, context: ZuploContext, unparsedOptions: ApiKeyInboundPolicyOptions, policyName: string): Promise<ZuploRequest<any, Record<string, string>, Record<string, string>> | Response>;
|
|
145
145
|
|
|
146
146
|
/**
|
|
147
|
-
* The options for this policy
|
|
147
|
+
* The options for this policy.
|
|
148
148
|
*/
|
|
149
149
|
export declare interface ApiKeyInboundPolicyOptions {
|
|
150
150
|
/**
|
|
@@ -259,7 +259,7 @@ declare interface AuditLogRequestFilter {
|
|
|
259
259
|
export declare const Auth0JwtInboundPolicy: InboundPolicyHandler<Auth0JwtInboundPolicyOptions>;
|
|
260
260
|
|
|
261
261
|
/**
|
|
262
|
-
* The options for this policy
|
|
262
|
+
* The options for this policy.
|
|
263
263
|
*/
|
|
264
264
|
export declare interface Auth0JwtInboundPolicyOptions {
|
|
265
265
|
/**
|
|
@@ -267,11 +267,11 @@ export declare interface Auth0JwtInboundPolicyOptions {
|
|
|
267
267
|
*/
|
|
268
268
|
allowUnauthenticatedRequests?: boolean;
|
|
269
269
|
/**
|
|
270
|
-
* Your Auth0 domain. For example, my-company.auth0.com
|
|
270
|
+
* Your Auth0 domain. For example, `my-company.auth0.com`.
|
|
271
271
|
*/
|
|
272
272
|
auth0Domain: string;
|
|
273
273
|
/**
|
|
274
|
-
* The Auth0 audience of your API, for example https://api.example.com
|
|
274
|
+
* The Auth0 audience of your API, for example `https://api.example.com/`.
|
|
275
275
|
*/
|
|
276
276
|
audience?: string;
|
|
277
277
|
}
|
|
@@ -429,7 +429,7 @@ declare abstract class BaseKeyValueStore {
|
|
|
429
429
|
}
|
|
430
430
|
|
|
431
431
|
/**
|
|
432
|
-
* An account object
|
|
432
|
+
* An account object.
|
|
433
433
|
*/
|
|
434
434
|
declare interface BasicAuthAccount {
|
|
435
435
|
/**
|
|
@@ -437,11 +437,11 @@ declare interface BasicAuthAccount {
|
|
|
437
437
|
*/
|
|
438
438
|
username: string;
|
|
439
439
|
/**
|
|
440
|
-
* The password for the account - note we recommend storing this in environment variables
|
|
440
|
+
* The password for the account - note we recommend storing this in environment variables.
|
|
441
441
|
*/
|
|
442
442
|
password: string;
|
|
443
443
|
/**
|
|
444
|
-
* The data payload you want associated with this account (this will be the `data` property on `request.user`)
|
|
444
|
+
* The data payload you want associated with this account (this will be the `data` property on `request.user`).
|
|
445
445
|
*/
|
|
446
446
|
data?: {
|
|
447
447
|
[k: string]: unknown;
|
|
@@ -473,15 +473,15 @@ declare interface BasicAuthAccount {
|
|
|
473
473
|
export declare const BasicAuthInboundPolicy: InboundPolicyHandler<BasicAuthInboundPolicyOptions>;
|
|
474
474
|
|
|
475
475
|
/**
|
|
476
|
-
* The options for this policy
|
|
476
|
+
* The options for this policy.
|
|
477
477
|
*/
|
|
478
478
|
export declare interface BasicAuthInboundPolicyOptions {
|
|
479
479
|
/**
|
|
480
|
-
* An array of account objects (username, password and data properties)
|
|
480
|
+
* An array of account objects (username, password and data properties).
|
|
481
481
|
*/
|
|
482
482
|
accounts: BasicAuthAccount[];
|
|
483
483
|
/**
|
|
484
|
-
* If 'true' allows the request to continue even if authenticated. When 'false' (the default) any unauthenticated request is automatically rejected with a 401
|
|
484
|
+
* If 'true' allows the request to continue even if authenticated. When 'false' (the default) any unauthenticated request is automatically rejected with a 401.
|
|
485
485
|
*/
|
|
486
486
|
allowUnauthenticatedRequests?: boolean;
|
|
487
487
|
}
|
|
@@ -542,7 +542,7 @@ declare interface CacheOptions {
|
|
|
542
542
|
export declare function CachingInboundPolicy(request: ZuploRequest, context: ZuploContext, options: CachingInboundPolicyOptions, policyName: string): Promise<ZuploRequest<any, Record<string, string>, Record<string, string>> | Response>;
|
|
543
543
|
|
|
544
544
|
/**
|
|
545
|
-
* The options for this policy
|
|
545
|
+
* The options for this policy.
|
|
546
546
|
*/
|
|
547
547
|
export declare interface CachingInboundPolicyOptions {
|
|
548
548
|
/**
|
|
@@ -550,11 +550,11 @@ export declare interface CachingInboundPolicyOptions {
|
|
|
550
550
|
*/
|
|
551
551
|
cacheId?: string;
|
|
552
552
|
/**
|
|
553
|
-
* By default, the Authorization header is always considered in the caching policy. You can disable by setting this to true
|
|
553
|
+
* By default, the Authorization header is always considered in the caching policy. You can disable by setting this to `true`.
|
|
554
554
|
*/
|
|
555
555
|
dangerouslyIgnoreAuthorizationHeader?: boolean;
|
|
556
556
|
/**
|
|
557
|
-
* The headers to be considered when caching
|
|
557
|
+
* The headers to be considered when caching.
|
|
558
558
|
*/
|
|
559
559
|
headers?: string[];
|
|
560
560
|
/**
|
|
@@ -562,7 +562,7 @@ export declare interface CachingInboundPolicyOptions {
|
|
|
562
562
|
*/
|
|
563
563
|
cacheHttpMethods?: ("GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD")[];
|
|
564
564
|
/**
|
|
565
|
-
* The timeout of the cache in seconds
|
|
565
|
+
* The timeout of the cache in seconds.
|
|
566
566
|
*/
|
|
567
567
|
expirationSecondsTtl?: number;
|
|
568
568
|
/**
|
|
@@ -585,11 +585,11 @@ export declare interface CachingInboundPolicyOptions {
|
|
|
585
585
|
export declare const ChangeMethodInboundPolicy: InboundPolicyHandler<ChangeMethodInboundPolicyOptions>;
|
|
586
586
|
|
|
587
587
|
/**
|
|
588
|
-
* The options for this policy
|
|
588
|
+
* The options for this policy.
|
|
589
589
|
*/
|
|
590
590
|
export declare interface ChangeMethodInboundPolicyOptions {
|
|
591
591
|
/**
|
|
592
|
-
* The HTTP Method to be used, e.g. POST, GET, PUT, PATCH, etc
|
|
592
|
+
* The HTTP Method to be used, e.g. POST, GET, PUT, PATCH, etc.
|
|
593
593
|
*/
|
|
594
594
|
method: string;
|
|
595
595
|
}
|
|
@@ -608,11 +608,11 @@ export declare interface ChangeMethodInboundPolicyOptions {
|
|
|
608
608
|
export declare const ClearHeadersInboundPolicy: InboundPolicyHandler<ClearHeadersInboundPolicyOptions>;
|
|
609
609
|
|
|
610
610
|
/**
|
|
611
|
-
* The options for this policy
|
|
611
|
+
* The options for this policy.
|
|
612
612
|
*/
|
|
613
613
|
export declare interface ClearHeadersInboundPolicyOptions {
|
|
614
614
|
/**
|
|
615
|
-
* The headers that should not be removed
|
|
615
|
+
* The headers that should not be removed.
|
|
616
616
|
*/
|
|
617
617
|
exclude?: string[];
|
|
618
618
|
}
|
|
@@ -631,11 +631,11 @@ export declare interface ClearHeadersInboundPolicyOptions {
|
|
|
631
631
|
export declare const ClearHeadersOutboundPolicy: OutboundPolicyHandler<ClearHeadersOutboundPolicyOptions>;
|
|
632
632
|
|
|
633
633
|
/**
|
|
634
|
-
* The options for this policy
|
|
634
|
+
* The options for this policy.
|
|
635
635
|
*/
|
|
636
636
|
export declare interface ClearHeadersOutboundPolicyOptions {
|
|
637
637
|
/**
|
|
638
|
-
* The headers that should not be removed
|
|
638
|
+
* The headers that should not be removed.
|
|
639
639
|
*/
|
|
640
640
|
exclude?: string[];
|
|
641
641
|
}
|
|
@@ -659,7 +659,7 @@ export declare interface ClearHeadersOutboundPolicyOptions {
|
|
|
659
659
|
export declare const ClerkJwtInboundPolicy: InboundPolicyHandler<ClerkJwtInboundPolicyOptions>;
|
|
660
660
|
|
|
661
661
|
/**
|
|
662
|
-
* The options for this policy
|
|
662
|
+
* The options for this policy.
|
|
663
663
|
*/
|
|
664
664
|
export declare interface ClerkJwtInboundPolicyOptions {
|
|
665
665
|
/**
|
|
@@ -667,7 +667,7 @@ export declare interface ClerkJwtInboundPolicyOptions {
|
|
|
667
667
|
*/
|
|
668
668
|
allowUnauthenticatedRequests?: boolean;
|
|
669
669
|
/**
|
|
670
|
-
* Your Clerk frontend api url, i.e.
|
|
670
|
+
* Your Clerk frontend api url, i.e. `https://sensible-skunk-49.clerk.accounts.dev`. Can be found in the Clerk portal: https://dashboard.clerk.com/last-active?path=api-keys.
|
|
671
671
|
*/
|
|
672
672
|
frontendApiUrl: string;
|
|
673
673
|
}
|
|
@@ -694,7 +694,7 @@ export declare interface ClerkJwtInboundPolicyOptions {
|
|
|
694
694
|
export declare const CognitoJwtInboundPolicy: InboundPolicyHandler<CognitoJwtInboundPolicyOptions>;
|
|
695
695
|
|
|
696
696
|
/**
|
|
697
|
-
* The options for this policy
|
|
697
|
+
* The options for this policy.
|
|
698
698
|
*/
|
|
699
699
|
export declare interface CognitoJwtInboundPolicyOptions {
|
|
700
700
|
/**
|
|
@@ -702,11 +702,11 @@ export declare interface CognitoJwtInboundPolicyOptions {
|
|
|
702
702
|
*/
|
|
703
703
|
allowUnauthenticatedRequests?: boolean;
|
|
704
704
|
/**
|
|
705
|
-
* The AWS region where your Cognito instance is deployed
|
|
705
|
+
* The AWS region where your Cognito instance is deployed.
|
|
706
706
|
*/
|
|
707
707
|
region: string;
|
|
708
708
|
/**
|
|
709
|
-
* The user pool identifier
|
|
709
|
+
* The user pool identifier.
|
|
710
710
|
*/
|
|
711
711
|
userPoolId: string;
|
|
712
712
|
}
|
|
@@ -737,11 +737,11 @@ export declare type CompatibilityDate = "2023-03-14";
|
|
|
737
737
|
export declare const CompositeInboundPolicy: InboundPolicyHandler<CompositeInboundPolicyOptions>;
|
|
738
738
|
|
|
739
739
|
/**
|
|
740
|
-
* The options for this policy
|
|
740
|
+
* The options for this policy.
|
|
741
741
|
*/
|
|
742
742
|
export declare interface CompositeInboundPolicyOptions {
|
|
743
743
|
/**
|
|
744
|
-
* The list of policy references (beware circular references)
|
|
744
|
+
* The list of policy references (beware circular references).
|
|
745
745
|
*/
|
|
746
746
|
policies?: string[];
|
|
747
747
|
}
|
|
@@ -929,7 +929,7 @@ export declare interface ErrorHandler {
|
|
|
929
929
|
export declare const FirebaseJwtInboundPolicy: InboundPolicyHandler<FirebaseJwtInboundPolicyOptions>;
|
|
930
930
|
|
|
931
931
|
/**
|
|
932
|
-
* The options for this policy
|
|
932
|
+
* The options for this policy.
|
|
933
933
|
*/
|
|
934
934
|
export declare interface FirebaseJwtInboundPolicyOptions {
|
|
935
935
|
/**
|
|
@@ -937,7 +937,7 @@ export declare interface FirebaseJwtInboundPolicyOptions {
|
|
|
937
937
|
*/
|
|
938
938
|
allowUnauthenticatedRequests?: boolean;
|
|
939
939
|
/**
|
|
940
|
-
* Your Firebase Project ID
|
|
940
|
+
* Your Firebase Project ID.
|
|
941
941
|
*/
|
|
942
942
|
projectId: string;
|
|
943
943
|
}
|
|
@@ -956,11 +956,11 @@ export declare interface FirebaseJwtInboundPolicyOptions {
|
|
|
956
956
|
export declare const FormDataToJsonInboundPolicy: InboundPolicyHandler<FormDataToJsonInboundPolicyOptions>;
|
|
957
957
|
|
|
958
958
|
/**
|
|
959
|
-
* The options for this policy
|
|
959
|
+
* The options for this policy.
|
|
960
960
|
*/
|
|
961
961
|
export declare interface FormDataToJsonInboundPolicyOptions {
|
|
962
962
|
/**
|
|
963
|
-
* Should the policy return an error if the request is not of the type form data
|
|
963
|
+
* Should the policy return an error if the request is not of the type form data.
|
|
964
964
|
*/
|
|
965
965
|
badRequestIfNotFormData?: boolean;
|
|
966
966
|
/**
|
|
@@ -985,7 +985,7 @@ export declare interface FormDataToJsonInboundPolicyOptions {
|
|
|
985
985
|
export declare const GeoFilterInboundPolicy: InboundPolicyHandler<GeoFilterInboundPolicyOptions>;
|
|
986
986
|
|
|
987
987
|
/**
|
|
988
|
-
* The options for this policy
|
|
988
|
+
* The options for this policy.
|
|
989
989
|
*/
|
|
990
990
|
export declare interface GeoFilterInboundPolicyOptions {
|
|
991
991
|
block?: GeoSpec;
|
|
@@ -998,15 +998,15 @@ export declare interface GeoFilterInboundPolicyOptions {
|
|
|
998
998
|
|
|
999
999
|
declare interface GeoSpec {
|
|
1000
1000
|
/**
|
|
1001
|
-
* comma separated string of country codes to allow (e.g. "US, CA")
|
|
1001
|
+
* comma separated string of country codes to allow (e.g. "US, CA").
|
|
1002
1002
|
*/
|
|
1003
1003
|
countries?: string;
|
|
1004
1004
|
/**
|
|
1005
|
-
* comma separated string of region codes to allow (e.g. "TX, WA")
|
|
1005
|
+
* comma separated string of region codes to allow (e.g. "TX, WA").
|
|
1006
1006
|
*/
|
|
1007
1007
|
regionCodes?: string;
|
|
1008
1008
|
/**
|
|
1009
|
-
* comma separated string of ASNs to allow (e.g. "395747, 28304")
|
|
1009
|
+
* comma separated string of ASNs to allow (e.g. "395747, 28304").
|
|
1010
1010
|
*/
|
|
1011
1011
|
asns?: string;
|
|
1012
1012
|
}
|
|
@@ -2205,11 +2205,11 @@ export declare function isZuploReadableEnvVariableName(name: string): boolean;
|
|
|
2205
2205
|
export declare const JWTScopeValidationInboundPolicy: InboundPolicyHandler<JWTScopeValidationInboundPolicyOptions>;
|
|
2206
2206
|
|
|
2207
2207
|
/**
|
|
2208
|
-
* The options for this policy
|
|
2208
|
+
* The options for this policy.
|
|
2209
2209
|
*/
|
|
2210
2210
|
export declare interface JWTScopeValidationInboundPolicyOptions {
|
|
2211
2211
|
/**
|
|
2212
|
-
* An array of of JWT scopes
|
|
2212
|
+
* An array of of JWT scopes.
|
|
2213
2213
|
*/
|
|
2214
2214
|
scopes: string[];
|
|
2215
2215
|
}
|
|
@@ -2346,7 +2346,7 @@ declare interface MetricsType {
|
|
|
2346
2346
|
}
|
|
2347
2347
|
|
|
2348
2348
|
/**
|
|
2349
|
-
* The options for this policy
|
|
2349
|
+
* The options for this policy.
|
|
2350
2350
|
*/
|
|
2351
2351
|
export declare interface MockApiInboundOptions {
|
|
2352
2352
|
/**
|
|
@@ -2455,7 +2455,7 @@ declare interface NotFoundOptions {
|
|
|
2455
2455
|
export declare const OktaJwtInboundPolicy: InboundPolicyHandler<OktaJwtInboundPolicyOptions>;
|
|
2456
2456
|
|
|
2457
2457
|
/**
|
|
2458
|
-
* The options for this policy
|
|
2458
|
+
* The options for this policy.
|
|
2459
2459
|
*/
|
|
2460
2460
|
export declare interface OktaJwtInboundPolicyOptions {
|
|
2461
2461
|
/**
|
|
@@ -2463,11 +2463,11 @@ export declare interface OktaJwtInboundPolicyOptions {
|
|
|
2463
2463
|
*/
|
|
2464
2464
|
allowUnauthenticatedRequests?: boolean;
|
|
2465
2465
|
/**
|
|
2466
|
-
* Your Okta authorization server's issuer URL. For example, https://dev-12345.okta.com/oauth2/abc
|
|
2466
|
+
* Your Okta authorization server's issuer URL. For example, `https://dev-12345.okta.com/oauth2/abc`.
|
|
2467
2467
|
*/
|
|
2468
2468
|
issuerUrl: string;
|
|
2469
2469
|
/**
|
|
2470
|
-
* The Okta audience of your API, for example api://my-api
|
|
2470
|
+
* The Okta audience of your API, for example `api://my-api`.
|
|
2471
2471
|
*/
|
|
2472
2472
|
audience?: string;
|
|
2473
2473
|
}
|
|
@@ -2538,7 +2538,7 @@ declare interface OpenIdJwtInboundPolicyInternalOptions extends Omit<OpenIdJwtIn
|
|
|
2538
2538
|
}
|
|
2539
2539
|
|
|
2540
2540
|
/**
|
|
2541
|
-
* The options for this policy
|
|
2541
|
+
* The options for this policy.
|
|
2542
2542
|
*/
|
|
2543
2543
|
export declare interface OpenIdJwtInboundPolicyOptions {
|
|
2544
2544
|
/**
|
|
@@ -2554,7 +2554,7 @@ export declare interface OpenIdJwtInboundPolicyOptions {
|
|
|
2554
2554
|
*/
|
|
2555
2555
|
jwkUrl?: string;
|
|
2556
2556
|
/**
|
|
2557
|
-
* The key used to verify the signature of the JWT token (either this or `jwkUrl` must be set)
|
|
2557
|
+
* The key used to verify the signature of the JWT token (either this or `jwkUrl` must be set).
|
|
2558
2558
|
*/
|
|
2559
2559
|
secret?: string;
|
|
2560
2560
|
/**
|
|
@@ -2747,7 +2747,7 @@ export declare class ProblemResponseFormatter {
|
|
|
2747
2747
|
export declare const PropelAuthJwtInboundPolicy: InboundPolicyHandler<PropelAuthJwtInboundPolicyOptions>;
|
|
2748
2748
|
|
|
2749
2749
|
/**
|
|
2750
|
-
* The options for this policy
|
|
2750
|
+
* The options for this policy.
|
|
2751
2751
|
*/
|
|
2752
2752
|
export declare interface PropelAuthJwtInboundPolicyOptions {
|
|
2753
2753
|
/**
|
|
@@ -2755,7 +2755,7 @@ export declare interface PropelAuthJwtInboundPolicyOptions {
|
|
|
2755
2755
|
*/
|
|
2756
2756
|
allowUnauthenticatedRequests?: boolean;
|
|
2757
2757
|
/**
|
|
2758
|
-
* Your PropelAuth authUrl. For example, https://6587563.propelauthtest.com
|
|
2758
|
+
* Your PropelAuth authUrl. For example, `https://6587563.propelauthtest.com`.
|
|
2759
2759
|
*/
|
|
2760
2760
|
authUrl: string;
|
|
2761
2761
|
/**
|
|
@@ -2767,12 +2767,12 @@ export declare interface PropelAuthJwtInboundPolicyOptions {
|
|
|
2767
2767
|
/* Excluded from this release type: purgeGatewayCache */
|
|
2768
2768
|
|
|
2769
2769
|
/**
|
|
2770
|
-
* The identifying element of the request that enforces distinct rate limits. For example, you can limit by `user`, `ip`, `function` or `all` - function allows you to specify a simple function to create a string identifier to create a rate-limit group
|
|
2770
|
+
* The identifying element of the request that enforces distinct rate limits. For example, you can limit by `user`, `ip`, `function` or `all` - function allows you to specify a simple function to create a string identifier to create a rate-limit group.
|
|
2771
2771
|
*/
|
|
2772
2772
|
declare type RateLimitByType = "user" | "ip" | "function" | "all";
|
|
2773
2773
|
|
|
2774
2774
|
/**
|
|
2775
|
-
* Adds the retry-after header
|
|
2775
|
+
* Adds the retry-after header.
|
|
2776
2776
|
*/
|
|
2777
2777
|
declare type RateLimitHeaderMode = "none" | "retry-after";
|
|
2778
2778
|
|
|
@@ -2806,20 +2806,20 @@ export { RateLimitInboundPolicy as BasicRateLimitInboundPolicy }
|
|
|
2806
2806
|
export { RateLimitInboundPolicy }
|
|
2807
2807
|
|
|
2808
2808
|
/**
|
|
2809
|
-
* The options for this policy
|
|
2809
|
+
* The options for this policy.
|
|
2810
2810
|
*/
|
|
2811
2811
|
declare interface RateLimitInboundPolicyOptions {
|
|
2812
2812
|
rateLimitBy: RateLimitByType;
|
|
2813
2813
|
/**
|
|
2814
|
-
* The max number of requests allowed in the given time window
|
|
2814
|
+
* The max number of requests allowed in the given time window.
|
|
2815
2815
|
*/
|
|
2816
2816
|
requestsAllowed: number;
|
|
2817
2817
|
/**
|
|
2818
|
-
* The time window in which the requests are rate-limited. The count restarts after each window expires
|
|
2818
|
+
* The time window in which the requests are rate-limited. The count restarts after each window expires.
|
|
2819
2819
|
*/
|
|
2820
2820
|
timeWindowMinutes: number;
|
|
2821
2821
|
/**
|
|
2822
|
-
* The function that returns dynamic configuration data. Used only with `rateLimitBy=function
|
|
2822
|
+
* The function that returns dynamic configuration data. Used only with `rateLimitBy=function`.
|
|
2823
2823
|
*/
|
|
2824
2824
|
identifier?: {
|
|
2825
2825
|
/**
|
|
@@ -2827,13 +2827,13 @@ declare interface RateLimitInboundPolicyOptions {
|
|
|
2827
2827
|
*/
|
|
2828
2828
|
export: string;
|
|
2829
2829
|
/**
|
|
2830
|
-
* Specifies the module to load your custom bucket function, in the format `$import(./modules/my-module)
|
|
2830
|
+
* Specifies the module to load your custom bucket function, in the format `$import(./modules/my-module)`.
|
|
2831
2831
|
*/
|
|
2832
2832
|
module: string;
|
|
2833
2833
|
};
|
|
2834
2834
|
headerMode?: RateLimitHeaderMode;
|
|
2835
2835
|
/**
|
|
2836
|
-
* If true, the policy will throw an error in the event there is a problem connecting to the rate limit service
|
|
2836
|
+
* If true, the policy will throw an error in the event there is a problem connecting to the rate limit service.
|
|
2837
2837
|
*/
|
|
2838
2838
|
throwOnFailure?: boolean;
|
|
2839
2839
|
mode?: RateLimitMode;
|
|
@@ -2851,7 +2851,7 @@ declare type RateLimitMode = "strict" | "async";
|
|
|
2851
2851
|
*/
|
|
2852
2852
|
declare interface ReadmeMeteringInboundPolicyOptions {
|
|
2853
2853
|
/**
|
|
2854
|
-
* The API key to use when sending metrics calls to Readme
|
|
2854
|
+
* The API key to use when sending metrics calls to Readme.
|
|
2855
2855
|
*/
|
|
2856
2856
|
apiKey: string;
|
|
2857
2857
|
/**
|
|
@@ -2916,7 +2916,7 @@ export declare function redirectHandler(request: ZuploRequest, context: ZuploCon
|
|
|
2916
2916
|
export declare const RemoveHeadersInboundPolicy: InboundPolicyHandler<RemoveHeadersInboundPolicyOptions>;
|
|
2917
2917
|
|
|
2918
2918
|
/**
|
|
2919
|
-
* The options for this policy
|
|
2919
|
+
* The options for this policy.
|
|
2920
2920
|
*/
|
|
2921
2921
|
export declare interface RemoveHeadersInboundPolicyOptions {
|
|
2922
2922
|
/**
|
|
@@ -2939,7 +2939,7 @@ export declare interface RemoveHeadersInboundPolicyOptions {
|
|
|
2939
2939
|
export declare const RemoveHeadersOutboundPolicy: OutboundPolicyHandler<RemoveHeadersOutboundPolicyOptions>;
|
|
2940
2940
|
|
|
2941
2941
|
/**
|
|
2942
|
-
* The options for this policy
|
|
2942
|
+
* The options for this policy.
|
|
2943
2943
|
*/
|
|
2944
2944
|
export declare interface RemoveHeadersOutboundPolicyOptions {
|
|
2945
2945
|
/**
|
|
@@ -2962,7 +2962,7 @@ export declare interface RemoveHeadersOutboundPolicyOptions {
|
|
|
2962
2962
|
export declare const RemoveQueryParamsInboundPolicy: InboundPolicyHandler<RemoveQueryParamsInboundPolicyOptions>;
|
|
2963
2963
|
|
|
2964
2964
|
/**
|
|
2965
|
-
* The options for this policy
|
|
2965
|
+
* The options for this policy.
|
|
2966
2966
|
*/
|
|
2967
2967
|
export declare interface RemoveQueryParamsInboundPolicyOptions {
|
|
2968
2968
|
/**
|
|
@@ -2985,19 +2985,19 @@ export declare interface RemoveQueryParamsInboundPolicyOptions {
|
|
|
2985
2985
|
export declare const ReplaceStringOutboundPolicy: OutboundPolicyHandler<ReplaceStringOutboundPolicyOptions>;
|
|
2986
2986
|
|
|
2987
2987
|
/**
|
|
2988
|
-
* The options for this policy
|
|
2988
|
+
* The options for this policy.
|
|
2989
2989
|
*/
|
|
2990
2990
|
export declare interface ReplaceStringOutboundPolicyOptions {
|
|
2991
2991
|
/**
|
|
2992
|
-
* The type of string replacement to perform
|
|
2992
|
+
* The type of string replacement to perform.
|
|
2993
2993
|
*/
|
|
2994
2994
|
mode: "regexp" | "string";
|
|
2995
2995
|
/**
|
|
2996
|
-
* The pattern to match
|
|
2996
|
+
* The pattern to match.
|
|
2997
2997
|
*/
|
|
2998
2998
|
match: string;
|
|
2999
2999
|
/**
|
|
3000
|
-
* The value to each match is replaced with
|
|
3000
|
+
* The value to each match is replaced with.
|
|
3001
3001
|
*/
|
|
3002
3002
|
replaceWith: string;
|
|
3003
3003
|
}
|
|
@@ -3016,11 +3016,11 @@ export declare interface ReplaceStringOutboundPolicyOptions {
|
|
|
3016
3016
|
export declare const RequestSizeLimitInboundPolicy: InboundPolicyHandler<RequestSizeLimitInboundPolicyOptions>;
|
|
3017
3017
|
|
|
3018
3018
|
/**
|
|
3019
|
-
* The options for this policy
|
|
3019
|
+
* The options for this policy.
|
|
3020
3020
|
*/
|
|
3021
3021
|
export declare interface RequestSizeLimitInboundPolicyOptions {
|
|
3022
3022
|
/**
|
|
3023
|
-
* The maximum size of the request in bytes
|
|
3023
|
+
* The maximum size of the request in bytes.
|
|
3024
3024
|
*/
|
|
3025
3025
|
maxSizeInBytes: number;
|
|
3026
3026
|
/**
|
|
@@ -3059,7 +3059,7 @@ export declare interface RequestUser<TUserData = any> {
|
|
|
3059
3059
|
export declare const RequestValidationInboundPolicy: InboundPolicyHandler<RequestValidationInboundPolicyOptions>;
|
|
3060
3060
|
|
|
3061
3061
|
/**
|
|
3062
|
-
* The options for this policy
|
|
3062
|
+
* The options for this policy.
|
|
3063
3063
|
*/
|
|
3064
3064
|
export declare interface RequestValidationInboundPolicyOptions {
|
|
3065
3065
|
/**
|
|
@@ -3104,15 +3104,15 @@ export declare interface RequestValidationInboundPolicyOptions {
|
|
|
3104
3104
|
export declare const RequireOriginInboundPolicy: InboundPolicyHandler<RequireOriginInboundPolicyOptions>;
|
|
3105
3105
|
|
|
3106
3106
|
/**
|
|
3107
|
-
* The options for this policy
|
|
3107
|
+
* The options for this policy.
|
|
3108
3108
|
*/
|
|
3109
3109
|
export declare interface RequireOriginInboundPolicyOptions {
|
|
3110
3110
|
/**
|
|
3111
|
-
* A comma separated string containing valid origins
|
|
3111
|
+
* A comma separated string containing valid origins.
|
|
3112
3112
|
*/
|
|
3113
3113
|
origins: string;
|
|
3114
3114
|
/**
|
|
3115
|
-
* The `detail` of the HTTP Problem response, if the origin is missing or disallowed
|
|
3115
|
+
* The `detail` of the HTTP Problem response, if the origin is missing or disallowed.
|
|
3116
3116
|
*/
|
|
3117
3117
|
failureDetail?: string;
|
|
3118
3118
|
}
|
|
@@ -3287,11 +3287,11 @@ export declare interface ServiceProvider {
|
|
|
3287
3287
|
export declare const SetBodyInboundPolicy: InboundPolicyHandler<SetBodyInboundPolicyOptions>;
|
|
3288
3288
|
|
|
3289
3289
|
/**
|
|
3290
|
-
* The options for this policy
|
|
3290
|
+
* The options for this policy.
|
|
3291
3291
|
*/
|
|
3292
3292
|
export declare interface SetBodyInboundPolicyOptions {
|
|
3293
3293
|
/**
|
|
3294
|
-
* The value to set for the body
|
|
3294
|
+
* The value to set for the body.
|
|
3295
3295
|
*/
|
|
3296
3296
|
body: string;
|
|
3297
3297
|
}
|
|
@@ -3314,7 +3314,7 @@ export declare interface SetBodyInboundPolicyOptions {
|
|
|
3314
3314
|
export declare const SetHeadersInboundPolicy: InboundPolicyHandler<SetHeadersInboundPolicyOptions>;
|
|
3315
3315
|
|
|
3316
3316
|
/**
|
|
3317
|
-
* The options for this policy
|
|
3317
|
+
* The options for this policy.
|
|
3318
3318
|
*/
|
|
3319
3319
|
export declare interface SetHeadersInboundPolicyOptions {
|
|
3320
3320
|
/**
|
|
@@ -3322,15 +3322,15 @@ export declare interface SetHeadersInboundPolicyOptions {
|
|
|
3322
3322
|
*/
|
|
3323
3323
|
headers: {
|
|
3324
3324
|
/**
|
|
3325
|
-
* The name of the header
|
|
3325
|
+
* The name of the header.
|
|
3326
3326
|
*/
|
|
3327
3327
|
name: string;
|
|
3328
3328
|
/**
|
|
3329
|
-
* The value of the header
|
|
3329
|
+
* The value of the header.
|
|
3330
3330
|
*/
|
|
3331
3331
|
value: string;
|
|
3332
3332
|
/**
|
|
3333
|
-
* Overwrite the value if the header is already present in the request
|
|
3333
|
+
* Overwrite the value if the header is already present in the request.
|
|
3334
3334
|
*/
|
|
3335
3335
|
overwrite?: boolean;
|
|
3336
3336
|
}[];
|
|
@@ -3350,7 +3350,7 @@ export declare interface SetHeadersInboundPolicyOptions {
|
|
|
3350
3350
|
export declare const SetHeadersOutboundPolicy: OutboundPolicyHandler<SetHeadersOutboundPolicyOptions>;
|
|
3351
3351
|
|
|
3352
3352
|
/**
|
|
3353
|
-
* The options for this policy
|
|
3353
|
+
* The options for this policy.
|
|
3354
3354
|
*/
|
|
3355
3355
|
export declare interface SetHeadersOutboundPolicyOptions {
|
|
3356
3356
|
/**
|
|
@@ -3388,7 +3388,7 @@ export declare function setMoesifContext(context: ZuploContext, moesifContext: M
|
|
|
3388
3388
|
export declare const SetQueryParamsInboundPolicy: InboundPolicyHandler<SetQueryParamsInboundPolicyOptions>;
|
|
3389
3389
|
|
|
3390
3390
|
/**
|
|
3391
|
-
* The options for this policy
|
|
3391
|
+
* The options for this policy.
|
|
3392
3392
|
*/
|
|
3393
3393
|
export declare interface SetQueryParamsInboundPolicyOptions {
|
|
3394
3394
|
/**
|
|
@@ -3396,11 +3396,11 @@ export declare interface SetQueryParamsInboundPolicyOptions {
|
|
|
3396
3396
|
*/
|
|
3397
3397
|
params: {
|
|
3398
3398
|
/**
|
|
3399
|
-
* The name of the param
|
|
3399
|
+
* The name of the param.
|
|
3400
3400
|
*/
|
|
3401
3401
|
name: string;
|
|
3402
3402
|
/**
|
|
3403
|
-
* The value of the param
|
|
3403
|
+
* The value of the param.
|
|
3404
3404
|
*/
|
|
3405
3405
|
value: string;
|
|
3406
3406
|
/**
|
|
@@ -3424,11 +3424,11 @@ export declare interface SetQueryParamsInboundPolicyOptions {
|
|
|
3424
3424
|
export declare const SetStatusOutboundPolicy: OutboundPolicyHandler<SetStatusOutboundPolicyOptions>;
|
|
3425
3425
|
|
|
3426
3426
|
/**
|
|
3427
|
-
* The options for this policy
|
|
3427
|
+
* The options for this policy.
|
|
3428
3428
|
*/
|
|
3429
3429
|
export declare interface SetStatusOutboundPolicyOptions {
|
|
3430
3430
|
/**
|
|
3431
|
-
* The status code to be used in the response
|
|
3431
|
+
* The status code to be used in the response.
|
|
3432
3432
|
*/
|
|
3433
3433
|
status?: number;
|
|
3434
3434
|
/**
|
|
@@ -3451,11 +3451,11 @@ export declare interface SetStatusOutboundPolicyOptions {
|
|
|
3451
3451
|
export declare const SleepInboundPolicy: InboundPolicyHandler<SleepInboundPolicyOptions>;
|
|
3452
3452
|
|
|
3453
3453
|
/**
|
|
3454
|
-
* The options for this policy
|
|
3454
|
+
* The options for this policy.
|
|
3455
3455
|
*/
|
|
3456
3456
|
export declare interface SleepInboundPolicyOptions {
|
|
3457
3457
|
/**
|
|
3458
|
-
* The number of milliseconds to delay the request
|
|
3458
|
+
* The number of milliseconds to delay the request.
|
|
3459
3459
|
*/
|
|
3460
3460
|
sleepInMs: number;
|
|
3461
3461
|
}
|
|
@@ -3502,11 +3502,11 @@ export declare class SumoLogicLoggingPlugin extends LogPlugin {
|
|
|
3502
3502
|
export declare const SupabaseJwtInboundPolicy: InboundPolicyHandler<SupabaseJwtInboundPolicyOptions>;
|
|
3503
3503
|
|
|
3504
3504
|
/**
|
|
3505
|
-
* The options for this policy
|
|
3505
|
+
* The options for this policy.
|
|
3506
3506
|
*/
|
|
3507
3507
|
export declare interface SupabaseJwtInboundPolicyOptions {
|
|
3508
3508
|
/**
|
|
3509
|
-
* The key used to verify the signature of the JWT token
|
|
3509
|
+
* The key used to verify the signature of the JWT token.
|
|
3510
3510
|
*/
|
|
3511
3511
|
secret: string;
|
|
3512
3512
|
/**
|
|
@@ -3552,7 +3552,7 @@ export declare interface SupabaseJwtInboundPolicyOptions {
|
|
|
3552
3552
|
export declare const UpstreamAzureAdServiceAuthInboundPolicy: InboundPolicyHandler<UpstreamAzureAdServiceAuthInboundPolicyOptions>;
|
|
3553
3553
|
|
|
3554
3554
|
/**
|
|
3555
|
-
* The options for this policy
|
|
3555
|
+
* The options for this policy.
|
|
3556
3556
|
*/
|
|
3557
3557
|
export declare interface UpstreamAzureAdServiceAuthInboundPolicyOptions {
|
|
3558
3558
|
/**
|
|
@@ -3603,7 +3603,7 @@ export declare interface UpstreamAzureAdServiceAuthInboundPolicyOptions {
|
|
|
3603
3603
|
export declare const UpstreamFirebaseAdminAuthInboundPolicy: InboundPolicyHandler<UpstreamFirebaseAdminAuthInboundPolicyOptions>;
|
|
3604
3604
|
|
|
3605
3605
|
/**
|
|
3606
|
-
* The options for this policy
|
|
3606
|
+
* The options for this policy.
|
|
3607
3607
|
*/
|
|
3608
3608
|
export declare interface UpstreamFirebaseAdminAuthInboundPolicyOptions {
|
|
3609
3609
|
/**
|
|
@@ -3646,7 +3646,7 @@ export declare interface UpstreamFirebaseAdminAuthInboundPolicyOptions {
|
|
|
3646
3646
|
export declare const UpstreamFirebaseUserAuthInboundPolicy: InboundPolicyHandler<UpstreamFirebaseUserAuthInboundPolicyOptions>;
|
|
3647
3647
|
|
|
3648
3648
|
/**
|
|
3649
|
-
* The options for this policy
|
|
3649
|
+
* The options for this policy.
|
|
3650
3650
|
*/
|
|
3651
3651
|
export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
|
|
3652
3652
|
/**
|
|
@@ -3658,7 +3658,7 @@ export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
|
|
|
3658
3658
|
*/
|
|
3659
3659
|
userId?: string;
|
|
3660
3660
|
/**
|
|
3661
|
-
* The property on the incoming request.user object to retrieve the value of the userId
|
|
3661
|
+
* The property on the incoming request.user object to retrieve the value of the userId.
|
|
3662
3662
|
*/
|
|
3663
3663
|
userIdPropertyPath?: string;
|
|
3664
3664
|
/**
|
|
@@ -3704,7 +3704,7 @@ export declare interface UpstreamFirebaseUserAuthInboundPolicyOptions {
|
|
|
3704
3704
|
export declare const UpstreamGcpJwtInboundPolicy: InboundPolicyHandler<UpstreamGcpJwtInboundPolicyOptions>;
|
|
3705
3705
|
|
|
3706
3706
|
/**
|
|
3707
|
-
* The options for this policy
|
|
3707
|
+
* The options for this policy.
|
|
3708
3708
|
*/
|
|
3709
3709
|
export declare interface UpstreamGcpJwtInboundPolicyOptions {
|
|
3710
3710
|
/**
|
|
@@ -3748,16 +3748,16 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
|
|
|
3748
3748
|
export declare const UpstreamGcpServiceAuthInboundPolicy: InboundPolicyHandler<UpstreamGcpServiceAuthInboundPolicyOptions>;
|
|
3749
3749
|
|
|
3750
3750
|
/**
|
|
3751
|
-
* The options for this policy
|
|
3751
|
+
* The options for this policy.
|
|
3752
3752
|
*/
|
|
3753
3753
|
export declare interface UpstreamGcpServiceAuthInboundPolicyOptions {
|
|
3754
3754
|
/**
|
|
3755
|
-
* The audience for the service to be called. This is typically the URL of your service endpoint like 'https://my-service-a2ev-uc.a.run.app'
|
|
3755
|
+
* The audience for the service to be called. This is typically the URL of your service endpoint like 'https://my-service-a2ev-uc.a.run.app'.
|
|
3756
3756
|
*/
|
|
3757
3757
|
audience: string;
|
|
3758
3758
|
/**
|
|
3759
3759
|
* The Google Service Account key in JSON format. Note you can load this from environment variables using the `$env(ENV_VAR)` syntax.
|
|
3760
|
-
* @see {@link https://developers.google.com/workspace/guides/create-credentials|Create access credentials}
|
|
3760
|
+
* @see {@link https://developers.google.com/workspace/guides/create-credentials|Create access credentials}.
|
|
3761
3761
|
*/
|
|
3762
3762
|
serviceAccountJson: string;
|
|
3763
3763
|
/**
|
|
@@ -3827,7 +3827,7 @@ declare interface ValidateJsonSchemaInboundInternalOptions extends Omit<Validate
|
|
|
3827
3827
|
}
|
|
3828
3828
|
|
|
3829
3829
|
/**
|
|
3830
|
-
* The options for this policy
|
|
3830
|
+
* The options for this policy.
|
|
3831
3831
|
*/
|
|
3832
3832
|
export declare interface ValidateJsonSchemaInboundOptions {
|
|
3833
3833
|
/**
|