@redocly/config 0.1.0

package/lib/root-config-schema.js

@@ -0,0 +1,344 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.i18ConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.basicAuthProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
+const constants_1 = require("./constants");
+const default_theme_config_schema_1 = require("./default-theme-config-schema");
+exports.oidcIssuerMetadataSchema = {
+    type: 'object',
+    properties: {
+        end_session_endpoint: { type: 'string' },
+        token_endpoint: { type: 'string' },
+        authorization_endpoint: { type: 'string' },
+        jwks_uri: { type: 'string' },
+    },
+    required: ['token_endpoint', 'authorization_endpoint'],
+    additionalProperties: true,
+};
+exports.oidcProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: constants_1.AuthProviderType.OIDC },
+        title: { type: 'string' },
+        pkce: { type: 'boolean', default: false },
+        configurationUrl: { type: 'string', minLength: 1 },
+        configuration: exports.oidcIssuerMetadataSchema,
+        clientId: { type: 'string', minLength: 1 },
+        clientSecret: { type: 'string', minLength: 0 },
+        teamsClaimName: { type: 'string' },
+        teamsClaimMap: { type: 'object', additionalProperties: { type: 'string' } },
+        defaultTeams: { type: 'array', items: { type: 'string' } },
+        scopes: { type: 'array', items: { type: 'string' } },
+        tokenExpirationTime: { type: 'number' },
+        authorizationRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+        tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+        audience: { type: 'array', items: { type: 'string' } },
+    },
+    required: ['type', 'clientId'],
+    oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
+    additionalProperties: false,
+};
+exports.saml2ProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: constants_1.AuthProviderType.SAML2 },
+        title: { type: 'string' },
+        issuerId: { type: 'string' },
+        entityId: { type: 'string' },
+        ssoUrl: { type: 'string' },
+        x509PublicCert: { type: 'string' },
+        teamsAttributeName: { type: 'string', default: constants_1.DEFAULT_TEAM_CLAIM_NAME },
+        teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
+        defaultTeams: { type: 'array', items: { type: 'string' } },
+    },
+    additionalProperties: false,
+    required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
+};
+exports.basicAuthProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: constants_1.AuthProviderType.BASIC },
+        title: { type: 'string' },
+        credentials: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    username: { type: 'string' },
+                    password: { type: 'string' },
+                    passwordHash: { type: 'string' },
+                    teams: { type: 'array', items: { type: 'string' } },
+                },
+                required: ['username'],
+                additionalProperties: false,
+            },
+        },
+    },
+    required: ['type', 'credentials'],
+    additionalProperties: false,
+};
+exports.authProviderConfigSchema = {
+    oneOf: [exports.oidcProviderConfigSchema, exports.saml2ProviderConfigSchema, exports.basicAuthProviderConfigSchema],
+    discriminator: { propertyName: 'type' },
+};
+exports.ssoOnPremConfigSchema = {
+    type: 'object',
+    additionalProperties: exports.authProviderConfigSchema,
+};
+exports.ssoConfigSchema = {
+    oneOf: [
+        {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+            },
+            uniqueItems: true,
+        },
+        {
+            type: 'string',
+            enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+        },
+    ],
+};
+exports.redirectConfigSchema = {
+    type: 'object',
+    properties: {
+        to: { type: 'string' },
+        type: { type: 'number', default: 301 },
+    },
+    additionalProperties: false,
+};
+exports.redirectsConfigSchema = {
+    type: 'object',
+    additionalProperties: exports.redirectConfigSchema,
+    default: {},
+};
+exports.apiConfigSchema = {
+    type: 'object',
+    properties: {
+        root: { type: 'string' },
+        output: { type: 'string', pattern: '(.ya?ml|.json)$' },
+        rbac: { type: 'object', additionalProperties: true },
+        theme: {
+            type: 'object',
+            properties: {
+                openapi: default_theme_config_schema_1.themeConfigSchema.properties.openapi,
+                graphql: default_theme_config_schema_1.themeConfigSchema.properties.graphql,
+            },
+            additionalProperties: false,
+        },
+        title: { type: 'string' },
+        metadata: { type: 'object', additionalProperties: true },
+        rules: { type: 'object', additionalProperties: true },
+        decorators: { type: 'object', additionalProperties: true },
+        preprocessors: { type: 'object', additionalProperties: true },
+    },
+    required: ['root'],
+};
+const metadataConfigSchema = {
+    type: 'object',
+    additionalProperties: true,
+};
+exports.seoConfigSchema = {
+    type: 'object',
+    properties: {
+        title: { type: 'string' },
+        description: { type: 'string' },
+        siteUrl: { type: 'string' },
+        image: { type: 'string' },
+        keywords: {
+            oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
+        },
+        lang: { type: 'string' },
+        jsonLd: { type: 'object' },
+        meta: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                    content: { type: 'string' },
+                },
+                required: ['name', 'content'],
+                additionalProperties: false,
+            },
+        },
+    },
+    additionalProperties: false,
+};
+exports.rbacScopeItemsSchema = {
+    type: 'object',
+    additionalProperties: { type: 'string' },
+};
+exports.rbacConfigSchema = {
+    type: 'object',
+    properties: {
+        cms: exports.rbacScopeItemsSchema,
+        reunite: exports.rbacScopeItemsSchema,
+        content: {
+            type: 'object',
+            properties: {
+                '**': exports.rbacScopeItemsSchema,
+            },
+            additionalProperties: exports.rbacScopeItemsSchema,
+        },
+    },
+    additionalProperties: exports.rbacScopeItemsSchema,
+};
+exports.graviteeAdapterConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: 'GRAVITEE' },
+        apiBaseUrl: { type: 'string' },
+        env: { type: 'string' },
+        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+        stage: { type: 'string', default: 'non-production' },
+        auth: { type: 'object', properties: { static: { type: 'string' } } },
+    },
+    additionalProperties: false,
+    required: ['type', 'apiBaseUrl'],
+};
+exports.apigeeAdapterAuthOauth2Schema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: constants_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
+        tokenEndpoint: { type: 'string' },
+        clientId: { type: 'string' },
+        clientSecret: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
+};
+exports.apigeeAdapterAuthServiceAccountSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: constants_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
+        serviceAccountEmail: { type: 'string' },
+        serviceAccountPrivateKey: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
+};
+exports.apigeeXAdapterConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: 'APIGEE_X' },
+        apiUrl: { type: 'string' },
+        stage: { type: 'string', default: 'non-production' },
+        organizationName: { type: 'string' },
+        ignoreApiProducts: { type: 'array', items: { type: 'string' } },
+        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+        auth: {
+            type: 'object',
+            oneOf: [exports.apigeeAdapterAuthOauth2Schema, exports.apigeeAdapterAuthServiceAccountSchema],
+            discriminator: { propertyName: 'type' },
+        },
+    },
+    additionalProperties: false,
+    required: ['type', 'organizationName', 'auth'],
+};
+exports.apigeeEdgeAdapterConfigSchema = Object.assign(Object.assign({}, exports.apigeeXAdapterConfigSchema), { properties: Object.assign(Object.assign({}, exports.apigeeXAdapterConfigSchema.properties), { type: { type: 'string', const: 'APIGEE_EDGE' } }) });
+exports.devOnboardingAdapterConfigSchema = {
+    type: 'object',
+    oneOf: [exports.apigeeXAdapterConfigSchema, exports.apigeeEdgeAdapterConfigSchema, exports.graviteeAdapterConfigSchema],
+    discriminator: { propertyName: 'type' },
+};
+const devOnboardingConfigSchema = {
+    type: 'object',
+    required: ['adapters'],
+    additionalProperties: false,
+    properties: {
+        adapters: {
+            type: 'array',
+            items: exports.devOnboardingAdapterConfigSchema,
+        },
+    },
+};
+exports.i18ConfigSchema = {
+    type: 'object',
+    properties: {
+        defaultLocale: {
+            type: 'string',
+        },
+        locales: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    code: {
+                        type: 'string',
+                    },
+                    name: {
+                        type: 'string',
+                    },
+                },
+                required: ['code'],
+            },
+        },
+    },
+    additionalProperties: false,
+    required: ['defaultLocale'],
+};
+const responseHeaderSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        value: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['name', 'value'],
+};
+exports.redoclyConfigSchema = {
+    type: 'object',
+    properties: {
+        licenseKey: { type: 'string' },
+        redirects: exports.redirectsConfigSchema,
+        seo: exports.seoConfigSchema,
+        rbac: exports.rbacConfigSchema,
+        responseHeaders: {
+            type: 'object',
+            additionalProperties: {
+                type: 'array',
+                items: responseHeaderSchema,
+            },
+        },
+        mockServer: {
+            type: 'object',
+            properties: {
+                off: { type: 'boolean', default: false },
+                position: { type: 'string', enum: ['first', 'last', 'replace', 'off'], default: 'first' },
+                strictExamples: { type: 'boolean', default: false },
+                errorIfForcedExampleNotFound: { type: 'boolean', default: false },
+                description: { type: 'string' },
+            },
+        },
+        apis: {
+            type: 'object',
+            additionalProperties: exports.apiConfigSchema,
+        },
+        ssoOnPrem: exports.ssoOnPremConfigSchema,
+        sso: exports.ssoConfigSchema,
+        residency: { type: 'string' },
+        developerOnboarding: devOnboardingConfigSchema,
+        i18n: exports.i18ConfigSchema,
+        metadata: metadataConfigSchema,
+        ignore: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        theme: default_theme_config_schema_1.themeConfigSchema,
+    },
+    default: { redirects: {} },
+    additionalProperties: true,
+};
+const environmentSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { additionalProperties: false });
+exports.rootRedoclyConfigSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
+            type: 'array',
+            items: { type: 'string' },
+        } }, exports.redoclyConfigSchema.properties), { env: {
+            type: 'object',
+            additionalProperties: environmentSchema, // TODO: if we want full validation we need to override apis, theme and the root
+        } }), default: {}, additionalProperties: false });
+//# sourceMappingURL=root-config-schema.js.map

package/lib/root-config-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-config-schema.js","sourceRoot":"","sources":["../src/root-config-schema.ts"],"names":[],"mappings":";;;AAAA,2CAIqB;AACrB,+EAAkE;AAErD,QAAA,wBAAwB,GAAG;IACtC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxC,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClC,sBAAsB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1C,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC7B;IACD,QAAQ,EAAE,CAAC,gBAAgB,EAAE,wBAAwB,CAAC;IACtD,oBAAoB,EAAE,IAAI;CAClB,CAAC;AAEE,QAAA,wBAAwB,GAAG;IACtC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,4BAAgB,CAAC,IAAI,EAAE;QACtD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;QACzC,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;QAClD,aAAa,EAAE,gCAAwB;QACvC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;QAC1C,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;QAC9C,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClC,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC3E,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC1D,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QACpD,mBAAmB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvC,gCAAgC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC9F,wBAAwB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QACtF,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;KACvD;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;IAC5E,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEE,QAAA,yBAAyB,GAAG;IACvC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,4BAAgB,CAAC,KAAK,EAAE;QACvD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAClC,kBAAkB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,mCAAuB,EAAE;QACxE,iBAAiB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC/E,YAAY,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;KAC3D;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,gBAAgB,CAAC;CAClD,CAAC;AAEE,QAAA,6BAA6B,GAAG;IAC3C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,4BAAgB,CAAC,KAAK,EAAE;QACvD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,WAAW,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC5B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC5B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAChC,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;iBACpD;gBACD,QAAQ,EAAE,CAAC,UAAU,CAAC;gBACtB,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC;IACjC,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEE,QAAA,wBAAwB,GAAG;IACtC,KAAK,EAAE,CAAC,gCAAwB,EAAE,iCAAyB,EAAE,qCAA6B,CAAC;IAC3F,aAAa,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;CAC/B,CAAC;AAEE,QAAA,qBAAqB,GAAG;IACnC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,gCAAwB;CACtC,CAAC;AAEE,QAAA,eAAe,GAAG;IAC7B,KAAK,EAAE;QACL;YACE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC;aACxC;YACD,WAAW,EAAE,IAAI;SAClB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC;SACxC;KACF;CACO,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACtB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KACvC;IACD,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEE,QAAA,qBAAqB,GAAG;IACnC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,4BAAoB;IAC1C,OAAO,EAAE,EAAE;CACH,CAAC;AAEE,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,iBAAiB,EAAE;QACtD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;QACpD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,OAAO,EAAE,+CAAiB,CAAC,UAAU,CAAC,OAAO;gBAC7C,OAAO,EAAE,+CAAiB,CAAC,UAAU,CAAC,OAAO;aAC9C;YACD,oBAAoB,EAAE,KAAK;SAC5B;QACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;QACxD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;QACrD,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;QAC1D,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;KAC9D;IACD,QAAQ,EAAE,CAAC,MAAM,CAAC;CACV,CAAC;AAEX,MAAM,oBAAoB,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;CAClB,CAAC;AAEE,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACzB,QAAQ,EAAE;YACR,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SAC1E;QACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,IAAI,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC5B;gBACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;gBAC7B,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEE,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;CAChC,CAAC;AAEE,QAAA,gBAAgB,GAAG;IAC9B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,GAAG,EAAE,4BAAoB;QACzB,OAAO,EAAE,4BAAoB;QAC7B,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE,4BAAoB;aAC3B;YACD,oBAAoB,EAAE,4BAAoB;SAC3C;KACF;IACD,oBAAoB,EAAE,4BAAoB;CAClC,CAAC;AAEE,QAAA,2BAA2B,GAAG;IACzC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE;QAC3C,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvB,8BAA8B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;QACnE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE;QAEpD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;KACrE;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAEE,QAAA,6BAA6B,GAAG;IAC3C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,kDAAsC,CAAC,MAAM,EAAE;QAC9E,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACjC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KACjC;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,CAAC;CACvD,CAAC;AAEE,QAAA,qCAAqC,GAAG;IACnD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,kDAAsC,CAAC,eAAe,EAAE;QACvF,mBAAmB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACvC,wBAAwB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC7C;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,qBAAqB,EAAE,0BAA0B,CAAC;CAC7D,CAAC;AAEE,QAAA,0BAA0B,GAAG;IACxC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE;QAC3C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE;QACpD,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACpC,iBAAiB,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC/D,8BAA8B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;QACnE,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,CAAC,qCAA6B,EAAE,6CAAqC,CAAC;YAC7E,aAAa,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;SACxC;KACF;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC;CACtC,CAAC;AAEE,QAAA,6BAA6B,GAAG,gCACxC,kCAA0B,KAC7B,UAAU,kCACL,kCAA0B,CAAC,UAAU,KACxC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,EAAE,MAExC,CAAC;AAEE,QAAA,gCAAgC,GAAG;IAC9C,IAAI,EAAE,QAAQ;IACd,KAAK,EAAE,CAAC,kCAA0B,EAAE,qCAA6B,EAAE,mCAA2B,CAAC;IAC/F,aAAa,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE;CAC/B,CAAC;AAEX,MAAM,yBAAyB,GAAG;IAChC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,wCAAgC;SACxC;KACF;CACO,CAAC;AAEE,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;SACf;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;qBACf;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;qBACf;iBACF;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;aACnB;SACF;KACF;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,eAAe,CAAC;CACnB,CAAC;AAEX,MAAM,oBAAoB,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;KAC1B;IACD,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC;AAEE,QAAA,mBAAmB,GAAG;IACjC,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,SAAS,EAAE,6BAAqB;QAChC,GAAG,EAAE,uBAAe;QACpB,IAAI,EAAE,wBAAgB;QACtB,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE;gBACpB,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,oBAAoB;aAC5B;SACF;QACD,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACxC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;gBACzF,cAAc,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACnD,4BAA4B,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACjE,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAChC;SACF;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,uBAAe;SACtC;QACD,SAAS,EAAE,6BAAqB;QAChC,GAAG,EAAE,uBAAe;QACpB,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,mBAAmB,EAAE,yBAAyB;QAC9C,IAAI,EAAE,uBAAe;QACrB,QAAQ,EAAE,oBAAoB;QAC9B,MAAM,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,KAAK,EAAE,+CAAiB;KACzB;IACD,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC1B,oBAAoB,EAAE,IAAI;CAClB,CAAC;AAEX,MAAM,iBAAiB,GAAG,gCACrB,2BAAmB,KACtB,oBAAoB,EAAE,KAAK,GACnB,CAAC;AAEE,QAAA,uBAAuB,GAAG,gCAClC,2BAAmB,KACtB,UAAU,gCACR,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B,IACE,2BAAmB,CAAC,UAAU,KACjC,GAAG,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,iBAAiB,EAAE,gFAAgF;SAC1H,KAEH,OAAO,EAAE,EAAE,EACX,oBAAoB,EAAE,KAAK,GACnB,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,42 @@
+import type { FromSchema } from 'json-schema-to-ts';
+import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, themeConfigSchema } from './default-theme-config-schema';
+import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, basicAuthProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
+/**
+ * Theme
+ */
+export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type ProductConfig = FromSchema<typeof productConfigSchema>;
+export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
+export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;
+export type AmplitudeAnalyticsConfig = FromSchema<typeof amplitudeAnalyticsConfigSchema>;
+export type RudderstackAnalyticsConfig = FromSchema<typeof rudderstackAnalyticsConfigSchema>;
+export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSchema>;
+export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
+export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
+export type CatalogConfig = FromSchema<typeof catalogSchema>;
+export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
+export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
+/**
+ * Root
+ */
+export type RedoclyConfig<T = ThemeConfig> = FromSchema<typeof rootRedoclyConfigSchema> & {
+    theme?: T;
+};
+export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
+export type RedirectsConfig = FromSchema<typeof redirectsConfigSchema>;
+export type AuthProviderConfig = FromSchema<typeof authProviderConfigSchema>;
+export type BasicAuthProviderConfig = FromSchema<typeof basicAuthProviderConfigSchema>;
+export type OidcProviderConfig = FromSchema<typeof oidcProviderConfigSchema>;
+export type Saml2ProviderConfig = FromSchema<typeof saml2ProviderConfigSchema>;
+export type SeoConfig = FromSchema<typeof seoConfigSchema>;
+export type RbacConfig = FromSchema<typeof rbacConfigSchema>;
+export type RbacScopeItems = FromSchema<typeof rbacScopeItemsSchema>;
+export type OidcIssuerMetadata = FromSchema<typeof oidcIssuerMetadataSchema>;
+export type DevOnboardingAdapterConfig = FromSchema<typeof devOnboardingAdapterConfigSchema>;
+export type GraviteeAdapterConfig = FromSchema<typeof graviteeAdapterConfigSchema>;
+export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema | typeof apigeeEdgeAdapterConfigSchema>;
+export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
+export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
+export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
+export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
+export type ApiConfig = FromSchema<typeof apiConfigSchema>;

package/lib/types.js

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

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@redocly/config",
+  "version": "0.1.0",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib/index.d.ts",
+  "dependencies": {},
+  "devDependencies": {
+    "rimraf": "5.0.5",
+    "json-schema-to-ts": "2.7.2",
+    "@markdoc/markdoc": "0.4.0",
+    "typescript": "5.2.2"
+  },
+  "scripts": {
+    "clean": "rimraf lib",
+    "compile": "tsc -p tsconfig.build.json",
+    "build": "npm run clean && npm run compile"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,17 @@
+export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
+export enum AuthProviderType {
+  OIDC = 'OIDC',
+  SAML2 = 'SAML2',
+  BASIC = 'BASIC',
+}
+export enum ApigeeDevOnboardingIntegrationAuthType {
+  SERVICE_ACCOUNT = 'SERVICE_ACCOUNT',
+  OAUTH2 = 'OAUTH2',
+}
+
+export const REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+
+export enum LayoutVariant {
+  STACKED = 'stacked',
+  THREE_PANEL = 'three-panel',
+}