npm - @redocly/config - Versions diffs - 0.49.1 → 0.50.0 - Mend

@redocly/config 0.49.1 → 0.50.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.

Files changed (11) hide show

package/lib/constants/identity-provider-slug.d.ts +8 -0
package/lib/index.d.ts +1 -0
package/lib/index.js +1 -1
package/lib/root-config-schema.d.ts +195 -12
package/lib/types/config-types.d.ts +5 -1
package/lib-esm/constants/identity-provider-slug.d.ts +8 -0
package/lib-esm/index.d.ts +1 -0
package/lib-esm/index.js +1 -1
package/lib-esm/root-config-schema.d.ts +195 -12
package/lib-esm/types/config-types.d.ts +5 -1
package/package.json +1 -1

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

@@ -457,12 +457,31 @@ export declare const ssoConfigSchema: {
         readonly type: 'array';
         readonly items: {
             readonly type: 'string';
-            readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+            readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
         };
         readonly uniqueItems: true;
     }, {
         readonly type: 'string';
-        readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+        readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+    }];
+};
+export declare const idpsConfigSchema: {
+    readonly oneOf: readonly [{
+        readonly type: 'array';
+        readonly items: {
+            readonly type: 'string';
+            readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+            readonly not: {
+                readonly enum: readonly ["redocly", "corporate", "guest"];
+            };
+        };
+        readonly uniqueItems: true;
+    }, {
+        readonly type: 'string';
+        readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+        readonly not: {
+            readonly enum: readonly ["redocly", "corporate", "guest"];
+        };
     }];
 };
 export declare const redirectConfigSchema: {
@@ -6537,12 +6556,31 @@ export declare const accessConfigSchema: {
                 readonly type: 'array';
                 readonly items: {
                     readonly type: 'string';
-                    readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                    readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
                 };
                 readonly uniqueItems: true;
             }, {
                 readonly type: 'string';
-                readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+            }];
+        };
+        readonly idps: {
+            readonly oneOf: readonly [{
+                readonly type: 'array';
+                readonly items: {
+                    readonly type: 'string';
+                    readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                    readonly not: {
+                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                    };
+                };
+                readonly uniqueItems: true;
+            }, {
+                readonly type: 'string';
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly not: {
+                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                };
             }];
         };
         readonly rbac: {
@@ -6773,6 +6811,10 @@ export declare const accessConfigSchema: {
         };
     };
     readonly additionalProperties: false;
+    readonly not: {
+        readonly required: readonly ['sso', 'idps'];
+    };
+    readonly description: 'Use either `access.sso` (filter by category) or `access.idps` (filter by slug), not both.';
 };
 export declare const redoclyConfigSchema: {
     readonly type: 'object';
@@ -12328,12 +12370,34 @@ export declare const redoclyConfigSchema: {
                 readonly type: 'array';
                 readonly items: {
                     readonly type: 'string';
-                    readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                    readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                };
+                readonly uniqueItems: true;
+            }, {
+                readonly type: 'string';
+                readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+            }];
+        };
+        /**
+         * @deprecated Should use `access.idps` instead
+         */
+        readonly idps: {
+            readonly oneOf: readonly [{
+                readonly type: 'array';
+                readonly items: {
+                    readonly type: 'string';
+                    readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                    readonly not: {
+                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                    };
                 };
                 readonly uniqueItems: true;
             }, {
                 readonly type: 'string';
-                readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly not: {
+                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                };
             }];
         };
         /**
@@ -12369,12 +12433,31 @@ export declare const redoclyConfigSchema: {
                         readonly type: 'array';
                         readonly items: {
                             readonly type: 'string';
-                            readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                            readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
                         };
                         readonly uniqueItems: true;
                     }, {
                         readonly type: 'string';
-                        readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                        readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                    }];
+                };
+                readonly idps: {
+                    readonly oneOf: readonly [{
+                        readonly type: 'array';
+                        readonly items: {
+                            readonly type: 'string';
+                            readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                            readonly not: {
+                                readonly enum: readonly ["redocly", "corporate", "guest"];
+                            };
+                        };
+                        readonly uniqueItems: true;
+                    }, {
+                        readonly type: 'string';
+                        readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                        readonly not: {
+                            readonly enum: readonly ["redocly", "corporate", "guest"];
+                        };
                     }];
                 };
                 readonly rbac: {
@@ -12605,6 +12688,10 @@ export declare const redoclyConfigSchema: {
                 };
             };
             readonly additionalProperties: false;
+            readonly not: {
+                readonly required: readonly ['sso', 'idps'];
+            };
+            readonly description: 'Use either `access.sso` (filter by category) or `access.idps` (filter by slug), not both.';
         };
         readonly developerOnboarding: {
             readonly type: 'object';
@@ -26970,6 +27057,9 @@ export declare const redoclyConfigSchema: {
             readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
         };
     };
+    readonly not: {
+        readonly required: readonly ['sso', 'idps'];
+    };
     readonly default: {
         readonly redirects: {};
         readonly seo: {
@@ -26990,6 +27080,9 @@ export declare const redoclyConfigSchema: {
 };
 export declare const rootRedoclyConfigSchema: {
     readonly type: 'object';
+    readonly not: {
+        readonly required: readonly ['sso', 'idps'];
+    };
     readonly $id: 'root-redocly-config';
     readonly properties: {
         readonly extends: {
@@ -32543,12 +32636,34 @@ export declare const rootRedoclyConfigSchema: {
                 readonly type: 'array';
                 readonly items: {
                     readonly type: 'string';
-                    readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                    readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
                 };
                 readonly uniqueItems: true;
             }, {
                 readonly type: 'string';
-                readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+            }];
+        };
+        /**
+         * @deprecated Should use `access.idps` instead
+         */
+        readonly idps: {
+            readonly oneOf: readonly [{
+                readonly type: 'array';
+                readonly items: {
+                    readonly type: 'string';
+                    readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                    readonly not: {
+                        readonly enum: readonly ["redocly", "corporate", "guest"];
+                    };
+                };
+                readonly uniqueItems: true;
+            }, {
+                readonly type: 'string';
+                readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                readonly not: {
+                    readonly enum: readonly ["redocly", "corporate", "guest"];
+                };
             }];
         };
         /**
@@ -32584,12 +32699,31 @@ export declare const rootRedoclyConfigSchema: {
                         readonly type: 'array';
                         readonly items: {
                             readonly type: 'string';
-                            readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                            readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
                         };
                         readonly uniqueItems: true;
                     }, {
                         readonly type: 'string';
-                        readonly enum: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];
+                        readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
+                    }];
+                };
+                readonly idps: {
+                    readonly oneOf: readonly [{
+                        readonly type: 'array';
+                        readonly items: {
+                            readonly type: 'string';
+                            readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                            readonly not: {
+                                readonly enum: readonly ["redocly", "corporate", "guest"];
+                            };
+                        };
+                        readonly uniqueItems: true;
+                    }, {
+                        readonly type: 'string';
+                        readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                        readonly not: {
+                            readonly enum: readonly ["redocly", "corporate", "guest"];
+                        };
                     }];
                 };
                 readonly rbac: {
@@ -32820,6 +32954,10 @@ export declare const rootRedoclyConfigSchema: {
                 };
             };
             readonly additionalProperties: false;
+            readonly not: {
+                readonly required: readonly ['sso', 'idps'];
+            };
+            readonly description: 'Use either `access.sso` (filter by category) or `access.idps` (filter by slug), not both.';
         };
         readonly developerOnboarding: {
             readonly type: 'object';
@@ -46941,10 +47079,36 @@ export declare const rootRedoclyConfigSchema: {
             readonly type: 'object';
             readonly additionalProperties: {
                 readonly additionalProperties: false;
+                readonly not: {
+                    required: ("idps" | "sso")[];
+                };
                 readonly properties: {
                     access: {
                         additionalProperties: false;
+                        description: "Use either `access.sso` (filter by category) or `access.idps` (filter by slug), not both.";
+                        not: {
+                            required: ("idps" | "sso")[];
+                        };
                         properties: {
+                            idps: {
+                                oneOf: ({
+                                    not: {
+                                        enum: ("corporate" | "guest" | "redocly")[];
+                                    };
+                                    pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                                    type: "string";
+                                } | {
+                                    items: {
+                                        not: {
+                                            enum: ("corporate" | "guest" | "redocly")[];
+                                        };
+                                        pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                                        type: "string";
+                                    };
+                                    type: "array";
+                                    uniqueItems: true;
+                                })[];
+                            };
                             logoutReturnUrl: {
                                 pattern: "^https?://.*";
                                 type: "string";
@@ -52431,6 +52595,25 @@ export declare const rootRedoclyConfigSchema: {
                         required: "defaultLocale"[];
                         type: "object";
                     };
+                    idps: {
+                        oneOf: ({
+                            not: {
+                                enum: ("corporate" | "guest" | "redocly")[];
+                            };
+                            pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                            type: "string";
+                        } | {
+                            items: {
+                                not: {
+                                    enum: ("corporate" | "guest" | "redocly")[];
+                                };
+                                pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+                                type: "string";
+                            };
+                            type: "array";
+                            uniqueItems: true;
+                        })[];
+                    };
                     ignore: {
                         items: {
                             type: "string";

package/lib/types/config-types.d.ts CHANGED Viewed

@@ -33,7 +33,7 @@ export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
 export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
 type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
-export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
+export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'idps' | 'residency' | 'logoutReturnUrl'> & {
     /**
      * @deprecated Should use `access.rbac` instead
      */
@@ -46,6 +46,10 @@ export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' |
      * @deprecated Should use `access.sso` instead
      */
     sso?: RootRedoclyConfig['sso'];
+    /**
+     * @deprecated Should use `access.idps` instead
+     */
+    idps?: RootRedoclyConfig['idps'];
     /**
      * @deprecated Should use `access.residency` instead
      */

package/lib-esm/constants/identity-provider-slug.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+export declare const IDENTITY_PROVIDER_SLUG_PATTERN = "^[a-z0-9]+(?:-[a-z0-9]+)*$";
+export declare const IDENTITY_PROVIDER_SLUG_REGEX: RegExp;
+export declare const IDENTITY_PROVIDER_SLUG_MESSAGE = "Unique ID must be lowercase letters, numbers, and hyphens only";
+export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH = 63;
+export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE = "Unique ID cannot exceed 63 characters";
+export declare const IDENTITY_PROVIDER_RESERVED_SLUGS: readonly ['redocly', 'corporate', 'guest'];
+export declare const IDENTITY_PROVIDER_RESERVED_MESSAGE: string;
+export declare const SSO_LOGIN_TYPES: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];

package/lib-esm/index.d.ts CHANGED Viewed

@@ -6,4 +6,5 @@ export * from './common.js';
 export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants/shared.js';
 export { CONFIG_NODE_TYPE_NAMES } from './constants/config.js';
 export { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities.js';
+export { IDENTITY_PROVIDER_RESERVED_MESSAGE, IDENTITY_PROVIDER_RESERVED_SLUGS, IDENTITY_PROVIDER_SLUG_MAX_LENGTH, IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE, IDENTITY_PROVIDER_SLUG_MESSAGE, IDENTITY_PROVIDER_SLUG_PATTERN, IDENTITY_PROVIDER_SLUG_REGEX, } from './constants/identity-provider-slug.js';
 export * from './entities-catalog-entity-file-schema.js';