@emeryld/rrroutes-openapi 2.3.7 → 2.4.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 (29) hide show
  1. package/README.md +9 -0
  2. package/dist/index.cjs +4 -2
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.mjs +4 -2
  5. package/dist/index.mjs.map +1 -1
  6. package/dist/public/assets/docs.js +91 -89
  7. package/dist/web/v2/components/endpoints/EndpointDetailPanel.d.ts +4 -1
  8. package/dist/web/v2/components/endpoints/EndpointRequestFeed.d.ts +8 -0
  9. package/dist/web/v2/components/history/RequestDetailContent.d.ts +11 -0
  10. package/dist/web/v2/components/history/RequestDetailModal.d.ts +12 -0
  11. package/dist/web/v2/components/history/RequestTable.d.ts +1 -1
  12. package/dist/web/v2/components/history/RequestsOverview.d.ts +7 -0
  13. package/dist/web/v2/components/layout/CardSection.d.ts +2 -1
  14. package/dist/web/v2/components/logs/CacheKeyDetailModal.d.ts +13 -0
  15. package/dist/web/v2/components/logs/CacheSummaryTable.d.ts +2 -1
  16. package/dist/web/v2/components/logs/LogGroupDetailModal.d.ts +13 -0
  17. package/dist/web/v2/components/primitives/DetailModal.d.ts +11 -0
  18. package/dist/web/v2/components/primitives/ExportButton.d.ts +9 -0
  19. package/dist/web/v2/hooks/useEndpointDetail.d.ts +8 -0
  20. package/dist/web/v2/hooks/useEndpointOptions.d.ts +5 -0
  21. package/dist/web/v2/types/types.cacheLog.d.ts +5 -0
  22. package/dist/web/v2/types/types.log.d.ts +3 -3
  23. package/dist/web/v2/types/types.preset.d.ts +11 -0
  24. package/dist/web/v2/types/types.requestLog.d.ts +2 -2
  25. package/dist/web/v2/utils/endpoints.d.ts +32 -0
  26. package/dist/web/v2/utils/exportToCsv.d.ts +3 -0
  27. package/package.json +1 -1
  28. package/dist/web/v2/components/history/RequestDetailDrawer.d.ts +0 -9
  29. package/dist/web/v2/pages/PlaygroundPage.d.ts +0 -1
@@ -1,9 +1,12 @@
1
1
  import type { PlaygroundInputs } from '../../stores/clientStore.js';
2
2
  import type { EndpointType } from '../../types/types.endpoint.js';
3
+ import { type EndpointTabKey } from '../../utils/endpoints.js';
3
4
  type EndpointDetailPanelProps = {
4
5
  endpointId?: string | null;
5
6
  onOpenStandalone?: (endpoint: EndpointType, inputs: PlaygroundInputs) => void;
6
7
  hidePlaygroundTab?: boolean;
8
+ activeTab?: EndpointTabKey;
9
+ onTabChange?: (tab: EndpointTabKey) => void;
7
10
  };
8
- export default function EndpointDetailPanel({ endpointId, onOpenStandalone, hidePlaygroundTab, }: EndpointDetailPanelProps): import("react/jsx-runtime").JSX.Element;
11
+ export default function EndpointDetailPanel({ endpointId, onOpenStandalone, hidePlaygroundTab, activeTab, onTabChange, }: EndpointDetailPanelProps): import("react/jsx-runtime").JSX.Element;
9
12
  export {};
@@ -0,0 +1,8 @@
1
+ import type { RequestLogType } from '../../types/types.requestLog.js';
2
+ type EndpointRequestFeedProps = {
3
+ endpointKey: string;
4
+ onSelectRequest: (request: RequestLogType, index: number) => void;
5
+ onRequestsChange?: (requests: RequestLogType[]) => void;
6
+ };
7
+ export default function EndpointRequestFeed({ endpointKey, onSelectRequest, onRequestsChange, }: EndpointRequestFeedProps): import("react/jsx-runtime").JSX.Element;
8
+ export {};
@@ -0,0 +1,11 @@
1
+ import type { CacheLogType } from '../../types/types.cacheLog.js';
2
+ import type { LogType } from '../../types/types.log.js';
3
+ import type { RequestLogType } from '../../types/types.requestLog.js';
4
+ type RequestDetailContentProps = {
5
+ request: RequestLogType;
6
+ caches?: CacheLogType[];
7
+ logs?: LogType[];
8
+ onReplay?: (request: RequestLogType) => void;
9
+ };
10
+ export default function RequestDetailContent({ request, caches, logs, onReplay, }: RequestDetailContentProps): import("react/jsx-runtime").JSX.Element;
11
+ export {};
@@ -0,0 +1,12 @@
1
+ import type { RequestLogType } from '../../types/types.requestLog.js';
2
+ type RequestDetailModalProps = {
3
+ open: boolean;
4
+ request: RequestLogType | null;
5
+ requestId?: string | null;
6
+ onClose: () => void;
7
+ onReplay?: (request: RequestLogType) => void;
8
+ onPrev?: () => void;
9
+ onNext?: () => void;
10
+ };
11
+ export default function RequestDetailModal({ open, request, requestId, onClose, onReplay, onPrev, onNext, }: RequestDetailModalProps): import("react/jsx-runtime").JSX.Element;
12
+ export {};
@@ -1,7 +1,7 @@
1
1
  import type { RequestLogType } from '../../types/types.requestLog.js';
2
2
  type RequestTableProps = {
3
3
  requests: RequestLogType[];
4
- onSelect: (request: RequestLogType) => void;
4
+ onSelect: (request: RequestLogType, index: number) => void;
5
5
  };
6
6
  export default function RequestTable({ requests, onSelect, }: RequestTableProps): import("react/jsx-runtime").JSX.Element;
7
7
  export {};
@@ -0,0 +1,7 @@
1
+ import type { RequestLogType } from '../../types/types.requestLog.js';
2
+ type RequestsOverviewProps = {
3
+ requests: RequestLogType[];
4
+ onSelectEndpoint: (endpointId: string) => void;
5
+ };
6
+ export default function RequestsOverview({ requests, onSelectEndpoint, }: RequestsOverviewProps): import("react/jsx-runtime").JSX.Element;
7
+ export {};
@@ -3,6 +3,7 @@ type CardSectionProps = {
3
3
  title?: string;
4
4
  actions?: ReactNode;
5
5
  children: ReactNode;
6
+ flex?: number;
6
7
  };
7
- export default function CardSection({ title, actions, children, }: CardSectionProps): import("react/jsx-runtime").JSX.Element;
8
+ export default function CardSection({ title, actions, children, flex, }: CardSectionProps): import("react/jsx-runtime").JSX.Element;
8
9
  export {};
@@ -0,0 +1,13 @@
1
+ import type { CacheSummaryType } from '../../types/types.cacheLog.js';
2
+ type CacheKeyDetailModalProps = {
3
+ open: boolean;
4
+ cacheKey?: string | null;
5
+ summary?: CacheSummaryType | null;
6
+ baseQuery: Record<string, unknown>;
7
+ onClose: () => void;
8
+ onPrev?: () => void;
9
+ onNext?: () => void;
10
+ onCleared?: (key: string) => void;
11
+ };
12
+ export default function CacheKeyDetailModal({ open, cacheKey, summary, baseQuery, onClose, onPrev, onNext, onCleared, }: CacheKeyDetailModalProps): import("react/jsx-runtime").JSX.Element;
13
+ export {};
@@ -1,6 +1,7 @@
1
1
  import type { CacheSummaryType } from '../../types/types.cacheLog.js';
2
2
  type CacheSummaryTableProps = {
3
3
  items: CacheSummaryType[];
4
+ onSelectKey?: (item: CacheSummaryType, index: number, orderedItems: CacheSummaryType[]) => void;
4
5
  };
5
- export default function CacheSummaryTable({ items }: CacheSummaryTableProps): import("react/jsx-runtime").JSX.Element;
6
+ export default function CacheSummaryTable({ items, onSelectKey, }: CacheSummaryTableProps): import("react/jsx-runtime").JSX.Element;
6
7
  export {};
@@ -0,0 +1,13 @@
1
+ import type { LogType } from '../../types/types.log.js';
2
+ type LogGroupDetailModalProps = {
3
+ open: boolean;
4
+ groupId?: string | null;
5
+ baseQuery: Record<string, unknown>;
6
+ triggerLog?: LogType | null;
7
+ onClose: () => void;
8
+ onPrev?: () => void;
9
+ onNext?: () => void;
10
+ };
11
+ export default function LogGroupDetailModal({ open, groupId, baseQuery, triggerLog, onClose, onPrev, onNext, }: LogGroupDetailModalProps): import("react/jsx-runtime").JSX.Element;
12
+ export declare function renderMessage(log: LogType): string;
13
+ export {};
@@ -0,0 +1,11 @@
1
+ import type { ReactNode } from 'react';
2
+ type DetailModalProps = {
3
+ open: boolean;
4
+ onClose: () => void;
5
+ title: ReactNode;
6
+ children: ReactNode;
7
+ onPrev?: () => void;
8
+ onNext?: () => void;
9
+ };
10
+ export default function DetailModal({ open, onClose, title, children, onPrev, onNext, }: DetailModalProps): import("react/jsx-runtime").JSX.Element;
11
+ export {};
@@ -0,0 +1,9 @@
1
+ import { type ButtonProps } from '@mui/material';
2
+ type Row = Record<string, unknown>;
3
+ type ExportButtonProps = Omit<ButtonProps, 'onClick'> & {
4
+ filename: string;
5
+ rows?: Row[];
6
+ getRows?: () => Row[] | Promise<Row[]>;
7
+ };
8
+ export default function ExportButton({ filename, rows, getRows, children, disabled, startIcon, variant, size, color, ...rest }: ExportButtonProps): import("react/jsx-runtime").JSX.Element;
9
+ export {};
@@ -0,0 +1,8 @@
1
+ import type { EndpointType } from '../types/types.endpoint.js';
2
+ type EndpointDetailState = {
3
+ data?: EndpointType;
4
+ isLoading: boolean;
5
+ error?: Error;
6
+ };
7
+ export declare function useEndpointDetail(displayId?: string | null): EndpointDetailState;
8
+ export {};
@@ -0,0 +1,5 @@
1
+ import { type EndpointOption } from '../utils/endpoints.js';
2
+ export declare function useEndpointOptions(searchTerm: string): {
3
+ options: EndpointOption[];
4
+ isLoading: boolean;
5
+ };
@@ -48,6 +48,7 @@ export declare const cacheLogQuerySchema: z.ZodObject<{
48
48
  miss: "miss";
49
49
  set: "set";
50
50
  }>>>;
51
+ keys: z.ZodOptional<z.ZodArray<z.ZodString>>;
51
52
  }, z.core.$strip>;
52
53
  export declare const cacheSummarySchema: z.ZodObject<{
53
54
  key: z.ZodString;
@@ -97,6 +98,7 @@ export declare const cacheLeaves: readonly [{
97
98
  cursor?: string | undefined;
98
99
  operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
99
100
  excludeOperations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
101
+ keys?: string[] | undefined;
100
102
  } & {
101
103
  cursor?: string | undefined;
102
104
  pageSize?: number | undefined;
@@ -113,6 +115,7 @@ export declare const cacheLeaves: readonly [{
113
115
  cursor?: string | undefined;
114
116
  operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
115
117
  excludeOperations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
118
+ keys?: string[] | undefined;
116
119
  } & {
117
120
  cursor?: string | undefined;
118
121
  pageSize?: unknown;
@@ -180,6 +183,7 @@ export declare const cacheLeaves: readonly [{
180
183
  cursor?: string | undefined;
181
184
  operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
182
185
  excludeOperations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
186
+ keys?: string[] | undefined;
183
187
  }, {
184
188
  beforeDate?: string | undefined;
185
189
  afterDate?: string | undefined;
@@ -193,6 +197,7 @@ export declare const cacheLeaves: readonly [{
193
197
  cursor?: string | undefined;
194
198
  operations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
195
199
  excludeOperations?: ("delete" | "hit" | "miss" | "set")[] | undefined;
200
+ keys?: string[] | undefined;
196
201
  }>;
197
202
  readonly outputSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
198
203
  out: {
@@ -14,7 +14,7 @@ export declare const logSchema: z.ZodObject<{
14
14
  debug: "debug";
15
15
  trace: "trace";
16
16
  }>;
17
- meta: z.ZodJSONSchema;
17
+ meta: z.ZodOptional<z.ZodAny>;
18
18
  }, z.core.$strip>;
19
19
  export type LogType = z.infer<typeof logSchema>;
20
20
  export declare const logQuerySchema: z.ZodObject<{
@@ -117,10 +117,10 @@ export declare const logLeaves: readonly [{
117
117
  createdAt: number;
118
118
  updatedAt: number;
119
119
  level: "error" | "info" | "warning" | "debug" | "trace";
120
- meta: z.core.util.JSONType;
121
120
  description?: string | undefined;
122
121
  groupId?: string | undefined;
123
122
  tags?: string[] | undefined;
123
+ meta?: any;
124
124
  }[];
125
125
  meta: {
126
126
  totalCount?: number | undefined;
@@ -133,10 +133,10 @@ export declare const logLeaves: readonly [{
133
133
  createdAt: number;
134
134
  updatedAt: number;
135
135
  level: "error" | "info" | "warning" | "debug" | "trace";
136
- meta: z.core.util.JSONType;
137
136
  description?: string | undefined;
138
137
  groupId?: string | undefined;
139
138
  tags?: string[] | undefined;
139
+ meta?: any;
140
140
  }[];
141
141
  meta: {
142
142
  totalCount?: number | undefined;
@@ -9,6 +9,7 @@ declare const presetSchema: z.ZodObject<{
9
9
  updatedAt: z.ZodNumber;
10
10
  operations: z.ZodArray<z.ZodObject<{
11
11
  name: z.ZodString;
12
+ description: z.ZodOptional<z.ZodString>;
12
13
  stepNumber: z.ZodNumber;
13
14
  endpointId: z.ZodOptional<z.ZodString>;
14
15
  method: z.ZodEnum<{
@@ -95,6 +96,7 @@ export declare const presetLeaves: readonly [{
95
96
  stepNumber: number;
96
97
  method: "get" | "post" | "put" | "patch" | "delete";
97
98
  path: string;
99
+ description?: string | undefined;
98
100
  endpointId?: string | undefined;
99
101
  body?: z.core.util.JSONType | undefined;
100
102
  extraHeaders?: Record<string, any> | undefined;
@@ -119,6 +121,7 @@ export declare const presetLeaves: readonly [{
119
121
  stepNumber: number;
120
122
  method: "get" | "post" | "put" | "patch" | "delete";
121
123
  path: string;
124
+ description?: string | undefined;
122
125
  endpointId?: string | undefined;
123
126
  body?: z.core.util.JSONType | undefined;
124
127
  extraHeaders?: Record<string, any> | undefined;
@@ -166,6 +169,7 @@ export declare const presetLeaves: readonly [{
166
169
  stepNumber: number;
167
170
  method: "get" | "post" | "put" | "patch" | "delete";
168
171
  path: string;
172
+ description?: string | undefined;
169
173
  endpointId?: string | undefined;
170
174
  body?: z.core.util.JSONType | undefined;
171
175
  extraHeaders?: Record<string, any> | undefined;
@@ -184,6 +188,7 @@ export declare const presetLeaves: readonly [{
184
188
  stepNumber: number;
185
189
  method: "get" | "post" | "put" | "patch" | "delete";
186
190
  path: string;
191
+ description?: string | undefined;
187
192
  endpointId?: string | undefined;
188
193
  body?: z.core.util.JSONType | undefined;
189
194
  extraHeaders?: Record<string, any> | undefined;
@@ -206,6 +211,7 @@ export declare const presetLeaves: readonly [{
206
211
  stepNumber: number;
207
212
  method: "get" | "post" | "put" | "patch" | "delete";
208
213
  path: string;
214
+ description?: string | undefined;
209
215
  endpointId?: string | undefined;
210
216
  body?: z.core.util.JSONType | undefined;
211
217
  extraHeaders?: Record<string, any> | undefined;
@@ -227,6 +233,7 @@ export declare const presetLeaves: readonly [{
227
233
  stepNumber: number;
228
234
  method: "get" | "post" | "put" | "patch" | "delete";
229
235
  path: string;
236
+ description?: string | undefined;
230
237
  endpointId?: string | undefined;
231
238
  body?: z.core.util.JSONType | undefined;
232
239
  extraHeaders?: Record<string, any> | undefined;
@@ -265,6 +272,7 @@ export declare const presetLeaves: readonly [{
265
272
  stepNumber: number;
266
273
  method: "get" | "post" | "put" | "patch" | "delete";
267
274
  path: string;
275
+ description?: string | undefined;
268
276
  endpointId?: string | undefined;
269
277
  body?: z.core.util.JSONType | undefined;
270
278
  extraHeaders?: Record<string, any> | undefined;
@@ -283,6 +291,7 @@ export declare const presetLeaves: readonly [{
283
291
  stepNumber: number;
284
292
  method: "get" | "post" | "put" | "patch" | "delete";
285
293
  path: string;
294
+ description?: string | undefined;
286
295
  endpointId?: string | undefined;
287
296
  body?: z.core.util.JSONType | undefined;
288
297
  extraHeaders?: Record<string, any> | undefined;
@@ -305,6 +314,7 @@ export declare const presetLeaves: readonly [{
305
314
  stepNumber: number;
306
315
  method: "get" | "post" | "put" | "patch" | "delete";
307
316
  path: string;
317
+ description?: string | undefined;
308
318
  endpointId?: string | undefined;
309
319
  body?: z.core.util.JSONType | undefined;
310
320
  extraHeaders?: Record<string, any> | undefined;
@@ -326,6 +336,7 @@ export declare const presetLeaves: readonly [{
326
336
  stepNumber: number;
327
337
  method: "get" | "post" | "put" | "patch" | "delete";
328
338
  path: string;
339
+ description?: string | undefined;
329
340
  endpointId?: string | undefined;
330
341
  body?: z.core.util.JSONType | undefined;
331
342
  extraHeaders?: Record<string, any> | undefined;
@@ -223,10 +223,10 @@ export declare const requestLogLeaves: readonly [{
223
223
  createdAt: number;
224
224
  updatedAt: number;
225
225
  level: "error" | "info" | "warning" | "debug" | "trace";
226
- meta: z.core.util.JSONType;
227
226
  description?: string | undefined;
228
227
  groupId?: string | undefined;
229
228
  tags?: string[] | undefined;
229
+ meta?: any;
230
230
  }[];
231
231
  caches: {
232
232
  id: string;
@@ -270,10 +270,10 @@ export declare const requestLogLeaves: readonly [{
270
270
  createdAt: number;
271
271
  updatedAt: number;
272
272
  level: "error" | "info" | "warning" | "debug" | "trace";
273
- meta: z.core.util.JSONType;
274
273
  description?: string | undefined;
275
274
  groupId?: string | undefined;
276
275
  tags?: string[] | undefined;
276
+ meta?: any;
277
277
  }[];
278
278
  caches: {
279
279
  id: string;
@@ -0,0 +1,32 @@
1
+ import type { EndpointType } from '../types/types.endpoint.js';
2
+ import { type MethodType } from '../types/types.base.js';
3
+ export type EndpointTabKey = 'request' | 'response' | 'meta' | 'metrics' | 'playground';
4
+ export type EndpointPanelLayout = 'split' | 'details' | 'playground';
5
+ export declare const ENDPOINT_TAB_QUERY_KEY = "tab";
6
+ export declare const ENDPOINT_LAYOUT_QUERY_KEY = "layout";
7
+ export declare const ENDPOINT_TABS: EndpointTabKey[];
8
+ export declare function mapTabQueryParam(value: string | null): EndpointTabKey;
9
+ export declare function tabToQueryParam(tab: EndpointTabKey): string | null;
10
+ export declare function mapLayoutQueryParam(value: string | null): EndpointPanelLayout;
11
+ export declare function layoutToQueryParam(layout: EndpointPanelLayout): string | null;
12
+ type EndpointIdentifiers = {
13
+ displayId: string;
14
+ encodedId: string;
15
+ };
16
+ export declare function getEndpointIdentifiers(method?: string, path?: string): EndpointIdentifiers;
17
+ export type EndpointOption = {
18
+ value: string;
19
+ display: string;
20
+ method: MethodType;
21
+ path: string;
22
+ };
23
+ export declare function buildEndpointOption(endpoint: EndpointType): EndpointOption;
24
+ export declare function parseEndpointDisplay(raw?: string | null): EndpointOption | undefined;
25
+ export declare function encodeEndpointDisplay(displayId?: string | null): string;
26
+ type EndpointDetailUrlOptions = {
27
+ tab?: EndpointTabKey;
28
+ layout?: EndpointPanelLayout;
29
+ extraParams?: Record<string, string | undefined>;
30
+ };
31
+ export declare function buildEndpointDetailUrl(displayId: string, options?: EndpointDetailUrlOptions): string;
32
+ export {};
@@ -0,0 +1,3 @@
1
+ type CsvRow = Record<string, unknown>;
2
+ export declare function exportToCsv(filename: string, rows: CsvRow[]): void;
3
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emeryld/rrroutes-openapi",
3
- "version": "2.3.7",
3
+ "version": "2.4.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -1,9 +0,0 @@
1
- import type { RequestLogType } from '../../types/types.requestLog.js';
2
- type RequestDetailDrawerProps = {
3
- request?: RequestLogType | null;
4
- open: boolean;
5
- onClose: () => void;
6
- onReplay?: (request: RequestLogType) => void;
7
- };
8
- export default function RequestDetailDrawer({ request, open, onClose, onReplay, }: RequestDetailDrawerProps): import("react/jsx-runtime").JSX.Element;
9
- export {};
@@ -1 +0,0 @@
1
- export default function PlaygroundPage(): import("react/jsx-runtime").JSX.Element;