swaggie 2.2.1 → 2.2.2

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.
@@ -48,10 +48,7 @@ const MOCK_FILE_HEADER = `\
48
48
  const template = options.template;
49
49
 
50
50
  if (template === 'ng1') {
51
- throw new Error(
52
- 'Mock generation is not supported for the "ng1" template. ' +
53
- 'Use "ng2", "axios", "fetch", "xior", "swr", or "tsq" instead.'
54
- );
51
+ throw new Error('Mock generation is not supported for the "ng1" template');
55
52
  }
56
53
 
57
54
  const isNg2 = template === 'ng2';
@@ -254,28 +251,34 @@ interface MockSWRReturn {
254
251
  data: unknown;
255
252
  /** Whether to return a loading state (default: false) */
256
253
  isLoading?: boolean;
254
+ /** Whether to return a validating state (default: false) */
255
+ isValidating?: boolean;
257
256
  /** Whether to return an error (default: undefined) */
258
257
  error?: Error | undefined | null;
258
+ /** The mutate function to return (default: empty mock) */
259
+ mutate?: KeyedMutator<any>;
259
260
  }
260
261
 
261
262
  interface MockSWRMutationReturn {
262
263
  /** The data to return from the mock */
263
- data: unknown;
264
+ data?: unknown;
264
265
  /** Whether to return a mutating state (default: false) */
265
266
  isMutating?: boolean;
266
267
  /** Whether to return an error (default: undefined) */
267
268
  error?: Error | undefined | null;
269
+ /** The trigger function to return (default: empty mock) */
270
+ trigger?: (...args: unknown[]) => Promise<unknown>;
271
+ /** The reset function to return (default: empty mock) */
272
+ reset?: () => void;
268
273
  }
269
274
 
270
275
  /** Augments a spy with a \`mockSWR\` shorthand for useSWR query hooks. */
271
276
  function withMockSWR<Fn extends (...args: never[]) => unknown>(spy: ${ref}.SpiedFunction<Fn>) {
272
277
  return Object.assign(spy, {
273
- mockSWR({ data, isLoading, error }: MockSWRReturn) {
278
+ mockSWR({ ...rest }: MockSWRReturn) {
274
279
  spy.mockReturnValue({
275
280
  ...defaultSWRReturn,
276
- data,
277
- isLoading: isLoading ?? false,
278
- error: error ?? undefined,
281
+ ...rest,
279
282
  } as ReturnType<Fn>);
280
283
  },
281
284
  });
@@ -286,15 +289,13 @@ function withMockSWRMutation<Fn extends (...args: never[]) => unknown>(spy: ${re
286
289
  return Object.assign(spy, {
287
290
  mockSWRMutation({
288
291
  data,
289
- isMutating,
290
- error,
292
+ ...rest
291
293
  }: MockSWRMutationReturn) {
292
294
  spy.mockReturnValue({
293
295
  ...defaultSWRMutationReturn,
294
296
  trigger: ${ref}.fn(() => Promise.resolve(undefined)),
295
- isMutating: isMutating ?? false,
296
- error: error ?? undefined,
297
297
  data,
298
+ ...rest,
298
299
  } as ReturnType<Fn>);
299
300
  },
300
301
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swaggie",
3
- "version": "2.2.1",
3
+ "version": "2.2.2",
4
4
  "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
5
5
  "author": {
6
6
  "name": "Piotr Dabrowski",