@redocly/theme 0.67.0-next.1 → 0.67.0-next.2

package/lib/ext/configure-helpers.d.ts

@@ -0,0 +1,35 @@
+export type SecurityDetails = {
+    password?: string;
+    username?: string;
+    token?: {
+        token_type?: string;
+        access_token: string;
+    };
+    client_id?: string;
+    client_secret?: string;
+    scopes?: string[];
+};
+export type ConfigureInputHintAction = {
+    label: string;
+    action: () => void;
+};
+export type ConfigureInputHint = {
+    title: string;
+    text: string;
+    actions?: ConfigureInputHintAction[];
+};
+export type ConfigureRequestValues = {
+    headers?: Record<string, string>;
+    body?: Record<string, any>;
+    query?: Record<string, string>;
+    path?: Record<string, string>;
+    cookie?: Record<string, string>;
+    security?: Record<string, SecurityDetails>;
+    envVariables?: Record<string, string>;
+    serverVariables?: Record<string, string>;
+    inputHints?: Record<string, ConfigureInputHint>;
+};
+export type ConfigureServerRequestValues = {
+    [serverUrl: string]: ConfigureRequestValues;
+};
+export type ConfigureReplayConfig = ConfigureRequestValues | ConfigureServerRequestValues | null | undefined;

package/lib/ext/configure-helpers.js

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

package/lib/ext/configure.d.ts

@@ -1,28 +1,7 @@
 import type { UserClaims, OpenAPIServer } from '../core/types';
-export type SecurityDetails = {
-    password?: string;
-    username?: string;
-    token?: {
-        token_type?: string;
-        access_token: string;
-    };
-    client_id?: string;
-    client_secret?: string;
-    scopes?: string[];
-};
-export type ConfigureRequestValues = {
-    headers?: Record<string, string>;
-    body?: Record<string, any>;
-    query?: Record<string, string>;
-    path?: Record<string, string>;
-    cookie?: Record<string, string>;
-    security?: Record<string, SecurityDetails>;
-    envVariables?: Record<string, string>;
-    serverVariables?: Record<string, string>;
-};
-export type ConfigureServerRequestValues = {
-    [serverUrl: string]: ConfigureRequestValues;
-};
+export * from '../ext/configure-helpers';
+export * from '../ext/helpers/is-direct-configure-request-values';
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '../ext/configure-helpers';
 type Configure = {
     requestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
 };
@@ -38,4 +17,3 @@ type ContextProps = {
     servers: OpenAPIServer[];
 };
 export declare function configure(_context: ContextProps): Configure;
-export {};

package/lib/ext/configure.js

@@ -1,6 +1,22 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
 exports.configure = configure;
+__exportStar(require("../ext/configure-helpers"), exports);
+__exportStar(require("../ext/helpers/is-direct-configure-request-values"), exports);
 function configure(_context) {
     // const exampleDefaultRequestValues: ConfigureRequestValues = {
     //   body: {

package/lib/ext/helpers/is-direct-configure-request-values.d.ts

@@ -0,0 +1,15 @@
+import type { ConfigureRequestValues, ConfigureServerRequestValues } from '../../ext/configure-helpers';
+/**
+ * Type guard that distinguishes a direct {@link ConfigureRequestValues} payload (request
+ * values that apply to every server) from a {@link ConfigureServerRequestValues} payload
+ * (request values keyed by server URL).
+ *
+ * A payload is treated as server-keyed when at least one top-level key is *not* a known
+ * request-value key (e.g. `headers`, `security`, `inputHints`) and its value looks like a
+ * nested {@link ConfigureRequestValues}. This keeps mixed shapes — e.g. server-keyed values
+ * alongside a top-level `inputHints` sibling — classified as server-keyed.
+ *
+ * @param value - The configure payload returned from `getReplayConfiguration`.
+ * @returns `true` when `value` is a direct {@link ConfigureRequestValues}, narrowing the type.
+ */
+export declare function isDirectConfigureRequestValues(value: ConfigureRequestValues | ConfigureServerRequestValues): value is ConfigureRequestValues;

package/lib/ext/helpers/is-direct-configure-request-values.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDirectConfigureRequestValues = isDirectConfigureRequestValues;
+const CONFIGURE_REQUEST_VALUE_KEYS = [
+    'headers',
+    'body',
+    'query',
+    'path',
+    'cookie',
+    'security',
+    'envVariables',
+    'serverVariables',
+    'inputHints',
+];
+const CONFIGURE_REQUEST_VALUE_KEY_SET = new Set(CONFIGURE_REQUEST_VALUE_KEYS);
+function hasConfigureRequestValueKeys(value) {
+    return CONFIGURE_REQUEST_VALUE_KEYS.some((key) => key in value);
+}
+/**
+ * Type guard that distinguishes a direct {@link ConfigureRequestValues} payload (request
+ * values that apply to every server) from a {@link ConfigureServerRequestValues} payload
+ * (request values keyed by server URL).
+ *
+ * A payload is treated as server-keyed when at least one top-level key is *not* a known
+ * request-value key (e.g. `headers`, `security`, `inputHints`) and its value looks like a
+ * nested {@link ConfigureRequestValues}. This keeps mixed shapes — e.g. server-keyed values
+ * alongside a top-level `inputHints` sibling — classified as server-keyed.
+ *
+ * @param value - The configure payload returned from `getReplayConfiguration`.
+ * @returns `true` when `value` is a direct {@link ConfigureRequestValues}, narrowing the type.
+ */
+function isDirectConfigureRequestValues(value) {
+    const hasServerKeyedValues = Object.entries(value).some(([key, entry]) => !CONFIGURE_REQUEST_VALUE_KEY_SET.has(key) &&
+        entry != null &&
+        typeof entry === 'object' &&
+        hasConfigureRequestValueKeys(entry));
+    if (hasServerKeyedValues) {
+        return false;
+    }
+    return hasConfigureRequestValueKeys(value);
+}
+//# sourceMappingURL=is-direct-configure-request-values.js.map

package/lib/ext/use-configure-replay.d.ts

@@ -1,4 +1,4 @@
-import type { ConfigureRequestValues, ConfigureServerRequestValues } from '../ext/configure';
+import { type ConfigureRequestValues, type ConfigureServerRequestValues } from '../ext/configure';
 import type { UserClaims, OpenAPIServer, OpenAPIInfo } from '../core/types';
 type ContextProps = {
     operation: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/theme",
-  "version": "0.67.0-next.1",
+  "version": "0.67.0-next.2",
   "description": "Shared UI components lib",
   "keywords": [
     "theme",
@@ -63,7 +63,7 @@
     "vitest": "4.1.8",
     "vitest-when": "0.6.2",
     "webpack": "5.105.2",
-    "@redocly/realm-asyncapi-sdk": "0.13.0-next.0"
+    "@redocly/realm-asyncapi-sdk": "0.13.0-next.1"
   },
   "dependencies": {
     "@tanstack/react-query": "5.62.3",

package/src/ext/configure-helpers.ts

@@ -0,0 +1,45 @@
+export type SecurityDetails = {
+  password?: string;
+  username?: string;
+  token?: {
+    token_type?: string;
+    access_token: string;
+  };
+  client_id?: string;
+  client_secret?: string;
+  scopes?: string[];
+};
+
+export type ConfigureInputHintAction = {
+  label: string;
+  action: () => void;
+};
+
+export type ConfigureInputHint = {
+  title: string;
+  text: string;
+  actions?: ConfigureInputHintAction[];
+};
+
+export type ConfigureRequestValues = {
+  headers?: Record<string, string>;
+  /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+  body?: Record<string, any>;
+  query?: Record<string, string>;
+  path?: Record<string, string>;
+  cookie?: Record<string, string>;
+  security?: Record<string, SecurityDetails>;
+  envVariables?: Record<string, string>;
+  serverVariables?: Record<string, string>;
+  inputHints?: Record<string, ConfigureInputHint>;
+};
+
+export type ConfigureServerRequestValues = {
+  [serverUrl: string]: ConfigureRequestValues;
+};
+
+export type ConfigureReplayConfig =
+  | ConfigureRequestValues
+  | ConfigureServerRequestValues
+  | null
+  | undefined;

package/src/ext/configure.ts

@@ -1,32 +1,12 @@
 import type { UserClaims, OpenAPIServer } from '@redocly/theme/core/types';
 
-export type SecurityDetails = {
-  password?: string;
-  username?: string;
-  token?: {
-    token_type?: string;
-    access_token: string;
-  };
-  client_id?: string;
-  client_secret?: string;
-  scopes?: string[];
-};
+export * from '@redocly/theme/ext/configure-helpers';
+export * from '@redocly/theme/ext/helpers/is-direct-configure-request-values';
 
-export type ConfigureRequestValues = {
-  headers?: Record<string, string>;
-  /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
-  body?: Record<string, any>;
-  query?: Record<string, string>;
-  path?: Record<string, string>;
-  cookie?: Record<string, string>;
-  security?: Record<string, SecurityDetails>;
-  envVariables?: Record<string, string>;
-  serverVariables?: Record<string, string>;
-};
-
-export type ConfigureServerRequestValues = {
-  [serverUrl: string]: ConfigureRequestValues;
-};
+import type {
+  ConfigureRequestValues,
+  ConfigureServerRequestValues,
+} from '@redocly/theme/ext/configure-helpers';
 
 type Configure = {
   requestValues?: ConfigureRequestValues | ConfigureServerRequestValues;

package/src/ext/helpers/is-direct-configure-request-values.ts

@@ -0,0 +1,53 @@
+import type {
+  ConfigureRequestValues,
+  ConfigureServerRequestValues,
+} from '@redocly/theme/ext/configure-helpers';
+
+const CONFIGURE_REQUEST_VALUE_KEYS = [
+  'headers',
+  'body',
+  'query',
+  'path',
+  'cookie',
+  'security',
+  'envVariables',
+  'serverVariables',
+  'inputHints',
+] as const;
+
+const CONFIGURE_REQUEST_VALUE_KEY_SET = new Set<string>(CONFIGURE_REQUEST_VALUE_KEYS);
+
+function hasConfigureRequestValueKeys(value: object): boolean {
+  return CONFIGURE_REQUEST_VALUE_KEYS.some((key) => key in value);
+}
+
+/**
+ * Type guard that distinguishes a direct {@link ConfigureRequestValues} payload (request
+ * values that apply to every server) from a {@link ConfigureServerRequestValues} payload
+ * (request values keyed by server URL).
+ *
+ * A payload is treated as server-keyed when at least one top-level key is *not* a known
+ * request-value key (e.g. `headers`, `security`, `inputHints`) and its value looks like a
+ * nested {@link ConfigureRequestValues}. This keeps mixed shapes — e.g. server-keyed values
+ * alongside a top-level `inputHints` sibling — classified as server-keyed.
+ *
+ * @param value - The configure payload returned from `getReplayConfiguration`.
+ * @returns `true` when `value` is a direct {@link ConfigureRequestValues}, narrowing the type.
+ */
+export function isDirectConfigureRequestValues(
+  value: ConfigureRequestValues | ConfigureServerRequestValues,
+): value is ConfigureRequestValues {
+  const hasServerKeyedValues = Object.entries(value).some(
+    ([key, entry]) =>
+      !CONFIGURE_REQUEST_VALUE_KEY_SET.has(key) &&
+      entry != null &&
+      typeof entry === 'object' &&
+      hasConfigureRequestValueKeys(entry),
+  );
+
+  if (hasServerKeyedValues) {
+    return false;
+  }
+
+  return hasConfigureRequestValueKeys(value);
+}

package/src/ext/use-configure-replay.ts

@@ -1,8 +1,8 @@
 import { useEffect, useState, useCallback } from 'react';
 
-import type {
-  ConfigureRequestValues,
-  ConfigureServerRequestValues,
+import {
+  type ConfigureRequestValues,
+  type ConfigureServerRequestValues,
 } from '@redocly/theme/ext/configure';
 import type { UserClaims, OpenAPIServer, OpenAPIInfo } from '@redocly/theme/core/types';