@redocly/config 0.20.2 → 0.21.0

package/lib/reunite-config-schema.d.ts

@@ -29,7 +29,7 @@ export declare const reuniteConfigSchema: {
                     };
                     readonly agent: {
                         readonly type: "string";
-                        readonly enum: readonly ["spot"];
+                        readonly enum: readonly ["respect"];
                     };
                     readonly trigger: {
                         readonly type: "object";
@@ -62,6 +62,28 @@ export declare const reuniteConfigSchema: {
                             };
                         };
                     };
+                    readonly severity: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly schemaCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly statusCodeCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly contentTypeCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly successCriteriaCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                        };
+                    };
                 };
                 readonly required: readonly ["path", "trigger", "agent"];
                 readonly additionalProperties: false;

package/lib/reunite-config-schema.js

@@ -15,6 +15,20 @@ const jobServersSchema = {
         },
     },
 };
+const severitySchema = {
+    type: 'string',
+    enum: ['error', 'warn', 'off'],
+};
+const jobSeveritySchema = {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+        schemaCheck: severitySchema,
+        statusCodeCheck: severitySchema,
+        contentTypeCheck: severitySchema,
+        successCriteriaCheck: severitySchema,
+    },
+};
 const jobTriggerSchema = {
     type: 'object',
     additionalProperties: false,
@@ -52,11 +66,12 @@ exports.reuniteConfigSchema = {
                     },
                     agent: {
                         type: 'string',
-                        enum: ['spot'],
+                        enum: ['respect'],
                     },
                     trigger: jobTriggerSchema,
                     inputs: jobInputsSchema,
                     servers: jobServersSchema,
+                    severity: jobSeveritySchema,
                 },
                 required: ['path', 'trigger', 'agent'],
                 additionalProperties: false,

package/lib/root-config-schema.d.ts

@@ -5039,6 +5039,18 @@ export declare const seoConfigSchema: {
     };
     readonly additionalProperties: false;
 };
+export declare const apiFunctionsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly folders: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly additionalProperties: false;
+};
 export declare const rbacScopeItemsSchema: {
     readonly type: "object";
     readonly additionalProperties: {
@@ -5737,6 +5749,18 @@ export declare const redoclyConfigSchema: {
                 };
             };
         };
+        readonly apiFunctions: {
+            readonly type: "object";
+            readonly properties: {
+                readonly folders: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
         readonly requiresLogin: {
             readonly type: "boolean";
         };
@@ -14771,7 +14795,7 @@ export declare const redoclyConfigSchema: {
                             };
                             readonly agent: {
                                 readonly type: "string";
-                                readonly enum: readonly ["spot"];
+                                readonly enum: readonly ["respect"];
                             };
                             readonly trigger: {
                                 readonly type: "object";
@@ -14804,6 +14828,28 @@ export declare const redoclyConfigSchema: {
                                     };
                                 };
                             };
+                            readonly severity: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly properties: {
+                                    readonly schemaCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly statusCodeCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly contentTypeCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly successCriteriaCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                };
+                            };
                         };
                         readonly required: readonly ["path", "trigger", "agent"];
                         readonly additionalProperties: false;
@@ -22402,6 +22448,18 @@ export declare const rootRedoclyConfigSchema: {
                         };
                         type: "object";
                     };
+                    apiFunctions: {
+                        properties: {
+                            folders: {
+                                items: {
+                                    type: "string";
+                                };
+                                type: "array";
+                            };
+                        };
+                        additionalProperties: false;
+                        type: "object";
+                    };
                     requiresLogin: {
                         type: "boolean";
                     };
@@ -26438,7 +26496,7 @@ export declare const rootRedoclyConfigSchema: {
                                             required: "event"[];
                                         };
                                         agent: {
-                                            enum: "spot"[];
+                                            enum: "respect"[];
                                             type: "string";
                                         };
                                         inputs: {
@@ -26457,6 +26515,28 @@ export declare const rootRedoclyConfigSchema: {
                                             additionalProperties: false;
                                             type: "object";
                                         };
+                                        severity: {
+                                            properties: {
+                                                schemaCheck: {
+                                                    enum: ("off" | "error" | "warn")[];
+                                                    type: "string";
+                                                };
+                                                statusCodeCheck: {
+                                                    enum: ("off" | "error" | "warn")[];
+                                                    type: "string";
+                                                };
+                                                contentTypeCheck: {
+                                                    enum: ("off" | "error" | "warn")[];
+                                                    type: "string";
+                                                };
+                                                successCriteriaCheck: {
+                                                    enum: ("off" | "error" | "warn")[];
+                                                    type: "string";
+                                                };
+                                            };
+                                            additionalProperties: false;
+                                            type: "object";
+                                        };
                                     };
                                     additionalProperties: false;
                                     type: "object";
@@ -29638,6 +29718,18 @@ export declare const rootRedoclyConfigSchema: {
                 };
             };
         };
+        readonly apiFunctions: {
+            readonly type: "object";
+            readonly properties: {
+                readonly folders: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+            readonly additionalProperties: false;
+        };
         readonly requiresLogin: {
             readonly type: "boolean";
         };
@@ -38672,7 +38764,7 @@ export declare const rootRedoclyConfigSchema: {
                             };
                             readonly agent: {
                                 readonly type: "string";
-                                readonly enum: readonly ["spot"];
+                                readonly enum: readonly ["respect"];
                             };
                             readonly trigger: {
                                 readonly type: "object";
@@ -38705,6 +38797,28 @@ export declare const rootRedoclyConfigSchema: {
                                     };
                                 };
                             };
+                            readonly severity: {
+                                readonly type: "object";
+                                readonly additionalProperties: false;
+                                readonly properties: {
+                                    readonly schemaCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly statusCodeCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly contentTypeCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                    readonly successCriteriaCheck: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["error", "warn", "off"];
+                                    };
+                                };
+                            };
                         };
                         readonly required: readonly ["path", "trigger", "agent"];
                         readonly additionalProperties: false;

package/lib/root-config-schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
+exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
 const constants_1 = require("./constants");
 const default_theme_config_schema_1 = require("./default-theme-config-schema");
 const feedback_config_schema_1 = require("./feedback-config-schema");
@@ -166,6 +166,13 @@ exports.seoConfigSchema = {
     },
     additionalProperties: false,
 };
+exports.apiFunctionsConfigSchema = {
+    type: 'object',
+    properties: {
+        folders: { type: 'array', items: { type: 'string' } },
+    },
+    additionalProperties: false,
+};
 exports.rbacScopeItemsSchema = {
     type: 'object',
     additionalProperties: { type: 'string' },
@@ -326,6 +333,7 @@ exports.redoclyConfigSchema = {
         redirects: exports.redirectsConfigSchema,
         seo: exports.seoConfigSchema,
         rbac: exports.rbacConfigSchema,
+        apiFunctions: exports.apiFunctionsConfigSchema,
         requiresLogin: { type: 'boolean' },
         responseHeaders: {
             type: 'object',

package/lib/types/api-functions-types.d.ts

@@ -0,0 +1,41 @@
+import type { RedoclyConfig } from './config-types';
+export type ApiFunctionsRequest = {
+    raw: Request;
+    headers: Record<string, any>;
+    params: Record<string, any>;
+    query: Record<string, any>;
+    cookies: Record<string, any>;
+    body: ReadableStream<Uint8Array> | null;
+};
+export type ApiFunctionsResponse = {
+    raw: Response;
+    status: (code: number) => ApiFunctionsResponse;
+    json: (data: object) => Response;
+    text: (data: string, code?: number) => Response;
+    send: (data: string | Buffer | object) => Response;
+    redirect: (url: string, code?: number) => Response;
+    cookie: (name: string, value: string, options?: CookieOptions) => ApiFunctionsResponse;
+    clearCookie: (name: string) => ApiFunctionsResponse;
+};
+export type ApiFunctionsContext = {
+    user: {
+        teams: string[];
+        claims: Record<string, any>;
+        email: string | undefined;
+        idpAccessToken: string | undefined;
+        idpId: string | undefined;
+    };
+    config: RedoclyConfig;
+};
+export interface CookieOptions {
+    domain?: string;
+    expires?: Date;
+    httpOnly?: boolean;
+    maxAge?: number;
+    path?: string;
+    secure?: boolean;
+    signed?: boolean;
+    sameSite?: 'Strict' | 'Lax' | 'None';
+}
+export type ServerPropsContext = ApiFunctionsContext;
+export type ServerPropsRequest = ApiFunctionsRequest;

package/lib/types/api-functions-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-functions-types.js.map

package/lib/types/index.d.ts

@@ -1,2 +1,3 @@
+export * from './api-functions-types';
 export * from './config-types';
 export * from './portal-shared-types';

package/lib/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-functions-types"), exports);
 __exportStar(require("./config-types"), exports);
 __exportStar(require("./portal-shared-types"), exports);
 //# sourceMappingURL=index.js.map

package/lib-esm/reunite-config-schema.d.ts

@@ -29,7 +29,7 @@ export declare const reuniteConfigSchema: {
                     };
                     readonly agent: {
                         readonly type: "string";
-                        readonly enum: readonly ["spot"];
+                        readonly enum: readonly ["respect"];
                     };
                     readonly trigger: {
                         readonly type: "object";
@@ -62,6 +62,28 @@ export declare const reuniteConfigSchema: {
                             };
                         };
                     };
+                    readonly severity: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly schemaCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly statusCodeCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly contentTypeCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                            readonly successCriteriaCheck: {
+                                readonly type: "string";
+                                readonly enum: readonly ["error", "warn", "off"];
+                            };
+                        };
+                    };
                 };
                 readonly required: readonly ["path", "trigger", "agent"];
                 readonly additionalProperties: false;

package/lib-esm/reunite-config-schema.js

@@ -12,6 +12,20 @@ const jobServersSchema = {
         },
     },
 };
+const severitySchema = {
+    type: 'string',
+    enum: ['error', 'warn', 'off'],
+};
+const jobSeveritySchema = {
+    type: 'object',
+    additionalProperties: false,
+    properties: {
+        schemaCheck: severitySchema,
+        statusCodeCheck: severitySchema,
+        contentTypeCheck: severitySchema,
+        successCriteriaCheck: severitySchema,
+    },
+};
 const jobTriggerSchema = {
     type: 'object',
     additionalProperties: false,
@@ -49,11 +63,12 @@ export const reuniteConfigSchema = {
                     },
                     agent: {
                         type: 'string',
-                        enum: ['spot'],
+                        enum: ['respect'],
                     },
                     trigger: jobTriggerSchema,
                     inputs: jobInputsSchema,
                     servers: jobServersSchema,
+                    severity: jobSeveritySchema,
                 },
                 required: ['path', 'trigger', 'agent'],
                 additionalProperties: false,