@redocly/config 0.41.0 → 0.41.2

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

@@ -83,6 +83,9 @@ export const ssoConfigSchema = {
         },
     ],
 };
+const requiresLoginSchema = { type: 'boolean' };
+const logoutReturnUrlSchema = { type: 'string', pattern: '^https?://.*' };
+const residencySchema = { type: 'string', pattern: '^https?://.*' };
 export const redirectConfigSchema = {
     type: 'object',
     properties: {
@@ -425,6 +428,17 @@ const mcpConfigSchema = {
         },
     },
 };
+export const accessConfigSchema = {
+    type: 'object',
+    properties: {
+        requiresLogin: requiresLoginSchema,
+        logoutReturnUrl: logoutReturnUrlSchema,
+        residency: residencySchema,
+        sso: ssoConfigSchema,
+        rbac: rbacConfigSchema,
+    },
+    additionalProperties: false,
+};
 export const redoclyConfigSchema = {
     type: 'object',
     properties: Object.assign(Object.assign(Object.assign(Object.assign({ 
@@ -434,7 +448,7 @@ export const redoclyConfigSchema = {
         imports: {
             type: 'array',
             items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: { type: 'boolean' }, responseHeaders: {
+        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, requiresLogin: requiresLoginSchema, responseHeaders: {
             type: 'object',
             additionalProperties: {
                 type: 'array',
@@ -452,7 +466,7 @@ export const redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: apiConfigSchema,
-        }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: { type: 'string', pattern: '^https?://.*' }, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */

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

@@ -41,12 +41,11 @@ export type ApiFunctionsContext = {
     };
 } & ApiFunctionsContextMethods;
 export type KvService = {
-    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<KvReadSchema<T> | null>;
-    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvReadSchema<T> | null)[]>;
+    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<T | null>;
+    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvListEntry<T> | null)[]>;
     list: <T extends KvValue = KvValue>(selector: KvListSelector, options?: KvListOptions) => Promise<KvListResponse<T>>;
-    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<string | null>;
-    delete: (key: KvKey) => Promise<boolean>;
-    clearExpired: () => Promise<void>;
+    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<KvListEntry<T> | null>;
+    delete: (key: KvKey) => Promise<void>;
     transaction: <T>(operation: (tx: KvTransaction) => Promise<T>) => Promise<T>;
 };
 export type KvValue = Record<string, unknown> | unknown[] | unknown;
@@ -55,7 +54,7 @@ export type KvKey = KvKeyPart[];
 export type KvSetOptions = {
     ttlInSeconds?: number;
 };
-export type KvReadSchema<T extends KvValue = KvValue> = {
+export type KvListEntry<T extends KvValue = KvValue> = {
     key: KvKey;
     value: T | null;
 };
@@ -77,15 +76,15 @@ export type KvListOptions = {
     cursor?: string;
 };
 export type KvListResponse<T extends KvValue = KvValue> = {
-    items: KvReadSchema<T>[];
+    items: KvListEntry<T>[];
     total: number;
     cursor: string | null;
 };
 export type KvTransaction = {
-    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<KvReadSchema<T> | null>;
-    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvReadSchema<T> | null)[]>;
-    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<string | null>;
-    delete: (key: KvKey) => Promise<boolean>;
+    get: <T extends KvValue = KvValue>(key: KvKey) => Promise<T | null>;
+    getMany: <T extends KvValue = KvValue>(keys: KvKey[]) => Promise<(KvListEntry<T> | null)[]>;
+    set: <T extends KvValue = KvValue>(key: KvKey, value: T, options?: KvSetOptions) => Promise<KvListEntry<T> | null>;
+    delete: (key: KvKey) => Promise<void>;
 };
 export type ApiRoutesHandler = (request: Request, context: ApiFunctionsContext, 
 /**

package/lib-esm/types/catalog-entity-types.d.ts

@@ -54,7 +54,7 @@ export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
 export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
 export type EntityBaseFileSchema = {
     version?: string | null;
-    revision?: string | null;
+    revision?: string;
     key: string;
     title: string;
     summary?: string | null;

package/lib-esm/types/portal-shared-types.d.ts

@@ -151,7 +151,8 @@ export type ResolvedSidebar = {
     items: ResolvedNavItem[];
     catalogEntity?: {
         key: string;
-        catalogConfig: CatalogEntityConfig;
+        version?: string;
+        catalogConfig?: CatalogEntityConfig;
     };
 };
 export type CompilationError = {

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "@redocly/config",
-  "version": "0.41.0",
+  "version": "0.41.2",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
   "types": "./lib/index.d.ts",
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
+    "@redocly/openapi-core": "2.14.3",
     "@types/node": "22.18.13",
     "@types/react": "^19.2.7",
+    "@vitest/coverage-v8": "4.0.10",
     "react-router-dom": "^6.21.1",
     "rimraf": "5.0.7",
-    "typescript": "5.9.3"
+    "typescript": "5.9.3",
+    "vitest": "4.0.10"
   },
   "dependencies": {
     "json-schema-to-ts": "2.7.2"
@@ -19,6 +22,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "compile": "tsc -p tsconfig.build.json && tsc -p tsconfig.lib-esm.json",
-    "build": "npm run clean && npm run compile"
+    "build": "npm run clean && npm run compile",
+    "test": "vitest run src"
   }
 }