@emeryld/rrroutes-openapi 2.3.6 → 2.3.7

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 (17) hide show
  1. package/dist/index.cjs +9 -15
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.mjs +9 -15
  4. package/dist/index.mjs.map +1 -1
  5. package/dist/public/assets/docs.js +73 -73
  6. package/dist/web/v2/components/endpoints/EndpointDetailPanel.d.ts +5 -1
  7. package/dist/web/v2/components/endpoints/EndpointPlayground.d.ts +13 -3
  8. package/dist/web/v2/components/feeds/FeedPagination.d.ts +1 -2
  9. package/dist/web/v2/pages/PlaygroundPage.d.ts +1 -0
  10. package/dist/web/v2/stores/playgroundStore.d.ts +14 -0
  11. package/dist/web/v2/types/types.base.d.ts +4 -0
  12. package/dist/web/v2/types/types.cacheLog.d.ts +6 -2
  13. package/dist/web/v2/types/types.endpoint.d.ts +6 -2
  14. package/dist/web/v2/types/types.log.d.ts +5 -1
  15. package/dist/web/v2/types/types.preset.d.ts +7 -3
  16. package/dist/web/v2/types/types.requestLog.d.ts +6 -2
  17. package/package.json +3 -3
package/dist/web/v2/components/endpoints/EndpointDetailPanel.d.ts CHANGED
@@ -1,5 +1,9 @@
1
+ import type { PlaygroundInputs } from '../../stores/clientStore.js';
2
+ import type { EndpointType } from '../../types/types.endpoint.js';
1
3
  type EndpointDetailPanelProps = {
2
4
  endpointId?: string | null;
5
+ onOpenStandalone?: (endpoint: EndpointType, inputs: PlaygroundInputs) => void;
6
+ hidePlaygroundTab?: boolean;
3
7
  };
4
- export default function EndpointDetailPanel({ endpointId, }: EndpointDetailPanelProps): import("react/jsx-runtime").JSX.Element;
8
+ export default function EndpointDetailPanel({ endpointId, onOpenStandalone, hidePlaygroundTab, }: EndpointDetailPanelProps): import("react/jsx-runtime").JSX.Element;
5
9
  export {};
package/dist/web/v2/components/endpoints/EndpointPlayground.d.ts CHANGED
@@ -1,6 +1,16 @@
1
- import { EndpointType } from '../../types/types.endpoint.js';
1
+ import { PlaygroundInputs } from '../../stores/clientStore.js';
2
+ import { SerializableSchema } from '../../types/types.endpoint.js';
3
+ import type { MethodType } from '../../types/types.base.js';
2
4
  type EndpointPlaygroundProps = {
3
- endpoint: EndpointType;
5
+ method: MethodType;
6
+ path: string;
7
+ contract?: {
8
+ body?: SerializableSchema;
9
+ query?: SerializableSchema;
10
+ params?: SerializableSchema;
11
+ };
12
+ summary?: string;
13
+ onOpenStandalone?: (inputs: PlaygroundInputs) => void;
4
14
  };
5
- export default function EndpointPlayground({ endpoint, }: EndpointPlaygroundProps): import("react/jsx-runtime").JSX.Element;
15
+ export default function EndpointPlayground({ method, path, contract, summary, onOpenStandalone, }: EndpointPlaygroundProps): import("react/jsx-runtime").JSX.Element;
6
16
  export {};
package/dist/web/v2/components/feeds/FeedPagination.d.ts CHANGED
@@ -7,9 +7,8 @@ type FeedPaginationProps<TItem> = {
7
7
  hasNextPage?: boolean;
8
8
  isFetchingNextPage?: boolean;
9
9
  pageSize?: number;
10
- autoLoadOffset?: string;
11
10
  extractItems?: (page: any) => TItem[];
12
11
  children: (items: TItem[]) => ReactNode;
13
12
  };
14
- export default function FeedPagination<TItem>({ data, items: providedItems, fetchNextPage, hasNextPage, isFetchingNextPage, pageSize, autoLoadOffset, extractItems, children, }: FeedPaginationProps<TItem>): import("react/jsx-runtime").JSX.Element;
13
+ export default function FeedPagination<TItem>({ data, items: providedItems, fetchNextPage, hasNextPage, isFetchingNextPage, pageSize, extractItems, children, }: FeedPaginationProps<TItem>): import("react/jsx-runtime").JSX.Element;
15
14
  export {};
package/dist/web/v2/pages/PlaygroundPage.d.ts ADDED
@@ -0,0 +1 @@
1
+ export default function PlaygroundPage(): import("react/jsx-runtime").JSX.Element;
package/dist/web/v2/stores/playgroundStore.d.ts CHANGED
@@ -25,6 +25,20 @@ type PlaygroundRunsContextValue = {
25
25
  method: MethodType;
26
26
  path: string;
27
27
  }) => PlaygroundRunRecord | undefined;
28
+ queuePrefill: (prefill: PlaygroundPrefill) => void;
29
+ consumePrefill: (criteria?: {
30
+ method?: MethodType;
31
+ path?: string;
32
+ leafKey?: string;
33
+ }) => PlaygroundPrefill | null;
34
+ };
35
+ export type PlaygroundPrefill = {
36
+ method?: MethodType;
37
+ path?: string;
38
+ params?: Record<string, unknown>;
39
+ query?: Record<string, unknown>;
40
+ body?: unknown;
41
+ leafKey?: string;
28
42
  };
29
43
  export declare function PlaygroundRunsProvider({ children, }: {
30
44
  children: ReactNode;
package/dist/web/v2/types/types.base.d.ts CHANGED
@@ -41,3 +41,7 @@ export declare const paginationSchema: z.ZodObject<{
41
41
  cursor: z.ZodOptional<z.ZodString>;
42
42
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
43
43
  }, z.core.$strip>;
44
+ export declare const feedMeta: z.ZodObject<{
45
+ totalCount: z.ZodOptional<z.ZodNumber>;
46
+ nextCursor: z.ZodOptional<z.ZodString>;
47
+ }, z.core.$strip>;
package/dist/web/v2/types/types.cacheLog.d.ts CHANGED
@@ -65,7 +65,6 @@ export declare const cacheLeaves: readonly [{
65
65
  readonly cfg: Readonly<{
66
66
  description?: string | undefined;
67
67
  tags?: string[] | undefined;
68
- deprecated?: boolean | undefined;
69
68
  queryExtensionSchema: z.ZodObject<{
70
69
  cursor: z.ZodOptional<z.ZodString>;
71
70
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -80,6 +79,7 @@ export declare const cacheLeaves: readonly [{
80
79
  feed: true;
81
80
  summary?: string | undefined;
82
81
  docsGroup?: string | undefined;
82
+ deprecated?: boolean | undefined;
83
83
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
84
84
  docsHidden?: boolean | undefined;
85
85
  docsMeta?: Record<string, unknown> | undefined;
@@ -133,6 +133,7 @@ export declare const cacheLeaves: readonly [{
133
133
  }[];
134
134
  meta: {
135
135
  totalCount?: number | undefined;
136
+ nextCursor?: string | undefined;
136
137
  };
137
138
  }, {
138
139
  out: {
@@ -149,18 +150,20 @@ export declare const cacheLeaves: readonly [{
149
150
  }[];
150
151
  meta: {
151
152
  totalCount?: number | undefined;
153
+ nextCursor?: string | undefined;
152
154
  };
153
155
  }>;
154
156
  outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
155
157
  totalCount?: number | undefined;
158
+ nextCursor?: string | undefined;
156
159
  }, {
157
160
  totalCount?: number | undefined;
161
+ nextCursor?: string | undefined;
158
162
  }>;
159
163
  }>;
160
164
  }, import("@emeryld/rrroutes-contract").LeafLowProfile<"post", "cache/clear", {
161
165
  readonly description?: string | undefined;
162
166
  readonly tags?: string[] | undefined;
163
- readonly deprecated?: boolean | undefined;
164
167
  readonly queryExtensionSchema: undefined;
165
168
  readonly outputMetaSchema: undefined;
166
169
  readonly bodySchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown> | undefined;
@@ -206,6 +209,7 @@ export declare const cacheLeaves: readonly [{
206
209
  readonly feed?: boolean | undefined;
207
210
  readonly summary?: string | undefined;
208
211
  readonly docsGroup?: string | undefined;
212
+ readonly deprecated?: boolean | undefined;
209
213
  readonly stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
210
214
  readonly docsHidden?: boolean | undefined;
211
215
  readonly docsMeta?: Record<string, unknown> | undefined;
package/dist/web/v2/types/types.endpoint.d.ts CHANGED
@@ -105,7 +105,6 @@ export declare const endpointLeaves: readonly [{
105
105
  readonly cfg: Readonly<{
106
106
  description?: string | undefined;
107
107
  tags?: string[] | undefined;
108
- deprecated?: boolean | undefined;
109
108
  queryExtensionSchema: z.ZodObject<{
110
109
  cursor: z.ZodOptional<z.ZodString>;
111
110
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -120,6 +119,7 @@ export declare const endpointLeaves: readonly [{
120
119
  feed: true;
121
120
  summary?: string | undefined;
122
121
  docsGroup?: string | undefined;
122
+ deprecated?: boolean | undefined;
123
123
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
124
124
  docsHidden?: boolean | undefined;
125
125
  docsMeta?: Record<string, unknown> | undefined;
@@ -194,6 +194,7 @@ export declare const endpointLeaves: readonly [{
194
194
  }[];
195
195
  meta: {
196
196
  totalCount?: number | undefined;
197
+ nextCursor?: string | undefined;
197
198
  };
198
199
  }, {
199
200
  out: {
@@ -225,18 +226,20 @@ export declare const endpointLeaves: readonly [{
225
226
  }[];
226
227
  meta: {
227
228
  totalCount?: number | undefined;
229
+ nextCursor?: string | undefined;
228
230
  };
229
231
  }>;
230
232
  outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
231
233
  totalCount?: number | undefined;
234
+ nextCursor?: string | undefined;
232
235
  }, {
233
236
  totalCount?: number | undefined;
237
+ nextCursor?: string | undefined;
234
238
  }>;
235
239
  }>;
236
240
  }, import("@emeryld/rrroutes-contract").LeafLowProfile<"get", "endpoints/:endpointId", {
237
241
  readonly description?: string | undefined;
238
242
  readonly tags?: string[] | undefined;
239
- readonly deprecated?: boolean | undefined;
240
243
  readonly queryExtensionSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>> & import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown>;
241
244
  readonly outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown>;
242
245
  readonly bodySchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown> | undefined;
@@ -362,6 +365,7 @@ export declare const endpointLeaves: readonly [{
362
365
  readonly feed?: boolean | undefined;
363
366
  readonly summary?: string | undefined;
364
367
  readonly docsGroup?: string | undefined;
368
+ readonly deprecated?: boolean | undefined;
365
369
  readonly stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
366
370
  readonly docsHidden?: boolean | undefined;
367
371
  readonly docsMeta?: Record<string, unknown> | undefined;
package/dist/web/v2/types/types.log.d.ts CHANGED
@@ -57,7 +57,6 @@ export declare const logLeaves: readonly [{
57
57
  readonly cfg: Readonly<{
58
58
  description?: string | undefined;
59
59
  tags?: string[] | undefined;
60
- deprecated?: boolean | undefined;
61
60
  queryExtensionSchema: z.ZodObject<{
62
61
  cursor: z.ZodOptional<z.ZodString>;
63
62
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -72,6 +71,7 @@ export declare const logLeaves: readonly [{
72
71
  feed: true;
73
72
  summary?: string | undefined;
74
73
  docsGroup?: string | undefined;
74
+ deprecated?: boolean | undefined;
75
75
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
76
76
  docsHidden?: boolean | undefined;
77
77
  docsMeta?: Record<string, unknown> | undefined;
@@ -124,6 +124,7 @@ export declare const logLeaves: readonly [{
124
124
  }[];
125
125
  meta: {
126
126
  totalCount?: number | undefined;
127
+ nextCursor?: string | undefined;
127
128
  };
128
129
  }, {
129
130
  out: {
@@ -139,12 +140,15 @@ export declare const logLeaves: readonly [{
139
140
  }[];
140
141
  meta: {
141
142
  totalCount?: number | undefined;
143
+ nextCursor?: string | undefined;
142
144
  };
143
145
  }>;
144
146
  outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
145
147
  totalCount?: number | undefined;
148
+ nextCursor?: string | undefined;
146
149
  }, {
147
150
  totalCount?: number | undefined;
151
+ nextCursor?: string | undefined;
148
152
  }>;
149
153
  }>;
150
154
  }];
package/dist/web/v2/types/types.preset.d.ts CHANGED
@@ -31,7 +31,6 @@ export declare const presetLeaves: readonly [{
31
31
  readonly cfg: Readonly<{
32
32
  description?: string | undefined;
33
33
  tags?: string[] | undefined;
34
- deprecated?: boolean | undefined;
35
34
  queryExtensionSchema: z.ZodObject<{
36
35
  cursor: z.ZodOptional<z.ZodString>;
37
36
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -46,6 +45,7 @@ export declare const presetLeaves: readonly [{
46
45
  feed: true;
47
46
  summary?: string | undefined;
48
47
  docsGroup?: string | undefined;
48
+ deprecated?: boolean | undefined;
49
49
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
50
50
  docsHidden?: boolean | undefined;
51
51
  docsMeta?: Record<string, unknown> | undefined;
@@ -106,6 +106,7 @@ export declare const presetLeaves: readonly [{
106
106
  }[];
107
107
  meta: {
108
108
  totalCount?: number | undefined;
109
+ nextCursor?: string | undefined;
109
110
  };
110
111
  }, {
111
112
  out: {
@@ -129,12 +130,15 @@ export declare const presetLeaves: readonly [{
129
130
  }[];
130
131
  meta: {
131
132
  totalCount?: number | undefined;
133
+ nextCursor?: string | undefined;
132
134
  };
133
135
  }>;
134
136
  outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
135
137
  totalCount?: number | undefined;
138
+ nextCursor?: string | undefined;
136
139
  }, {
137
140
  totalCount?: number | undefined;
141
+ nextCursor?: string | undefined;
138
142
  }>;
139
143
  }>;
140
144
  }, {
@@ -143,12 +147,12 @@ export declare const presetLeaves: readonly [{
143
147
  readonly cfg: Readonly<{
144
148
  description?: string | undefined;
145
149
  tags?: string[] | undefined;
146
- deprecated?: boolean | undefined;
147
150
  queryExtensionSchema: undefined;
148
151
  bodyFiles?: import("@emeryld/rrroutes-contract").FileField[] | undefined;
149
152
  feed?: boolean | undefined;
150
153
  summary?: string | undefined;
151
154
  docsGroup?: string | undefined;
155
+ deprecated?: boolean | undefined;
152
156
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
153
157
  docsHidden?: boolean | undefined;
154
158
  docsMeta?: Record<string, unknown> | undefined;
@@ -242,12 +246,12 @@ export declare const presetLeaves: readonly [{
242
246
  readonly cfg: Readonly<{
243
247
  description?: string | undefined;
244
248
  tags?: string[] | undefined;
245
- deprecated?: boolean | undefined;
246
249
  queryExtensionSchema: undefined;
247
250
  bodyFiles?: import("@emeryld/rrroutes-contract").FileField[] | undefined;
248
251
  feed?: boolean | undefined;
249
252
  summary?: string | undefined;
250
253
  docsGroup?: string | undefined;
254
+ deprecated?: boolean | undefined;
251
255
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
252
256
  docsHidden?: boolean | undefined;
253
257
  docsMeta?: Record<string, unknown> | undefined;
package/dist/web/v2/types/types.requestLog.d.ts CHANGED
@@ -73,7 +73,6 @@ export declare const requestLogLeaves: readonly [{
73
73
  readonly cfg: Readonly<{
74
74
  description?: string | undefined;
75
75
  tags?: string[] | undefined;
76
- deprecated?: boolean | undefined;
77
76
  queryExtensionSchema: z.ZodObject<{
78
77
  cursor: z.ZodOptional<z.ZodString>;
79
78
  pageSize: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
@@ -88,6 +87,7 @@ export declare const requestLogLeaves: readonly [{
88
87
  feed: true;
89
88
  summary?: string | undefined;
90
89
  docsGroup?: string | undefined;
90
+ deprecated?: boolean | undefined;
91
91
  stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
92
92
  docsHidden?: boolean | undefined;
93
93
  docsMeta?: Record<string, unknown> | undefined;
@@ -161,6 +161,7 @@ export declare const requestLogLeaves: readonly [{
161
161
  }[];
162
162
  meta: {
163
163
  totalCount?: number | undefined;
164
+ nextCursor?: string | undefined;
164
165
  };
165
166
  }, {
166
167
  out: {
@@ -187,18 +188,20 @@ export declare const requestLogLeaves: readonly [{
187
188
  }[];
188
189
  meta: {
189
190
  totalCount?: number | undefined;
191
+ nextCursor?: string | undefined;
190
192
  };
191
193
  }>;
192
194
  outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<{
193
195
  totalCount?: number | undefined;
196
+ nextCursor?: string | undefined;
194
197
  }, {
195
198
  totalCount?: number | undefined;
199
+ nextCursor?: string | undefined;
196
200
  }>;
197
201
  }>;
198
202
  }, import("@emeryld/rrroutes-contract").LeafLowProfile<"get", "requests/:requestId", {
199
203
  readonly description?: string | undefined;
200
204
  readonly tags?: string[] | undefined;
201
- readonly deprecated?: boolean | undefined;
202
205
  readonly queryExtensionSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>> & import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown>;
203
206
  readonly outputMetaSchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown>;
204
207
  readonly bodySchema: import("@emeryld/rrroutes-contract").RouteSchema<unknown, unknown> | undefined;
@@ -302,6 +305,7 @@ export declare const requestLogLeaves: readonly [{
302
305
  readonly feed?: boolean | undefined;
303
306
  readonly summary?: string | undefined;
304
307
  readonly docsGroup?: string | undefined;
308
+ readonly deprecated?: boolean | undefined;
305
309
  readonly stability?: "experimental" | "beta" | "stable" | "deprecated" | undefined;
306
310
  readonly docsHidden?: boolean | undefined;
307
311
  readonly docsMeta?: Record<string, unknown> | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emeryld/rrroutes-openapi",
3
- "version": "2.3.6",
3
+ "version": "2.3.7",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -17,8 +17,8 @@
17
17
  "dist"
18
18
  ],
19
19
  "dependencies": {
20
- "@emeryld/rrroutes-client": "^2.3.11",
21
- "@emeryld/rrroutes-contract": "^2.4.17",
20
+ "@emeryld/rrroutes-client": "^2.3.12",
21
+ "@emeryld/rrroutes-contract": "^2.4.18",
22
22
  "@emotion/cache": "^11.14.0",
23
23
  "@emotion/react": "^11.14.0",
24
24
  "@emotion/styled": "^11.14.1",