@merkaly/nuxt 0.1.11 → 0.1.12

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.
package/dist/module.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "compatibility": {
5
5
  "nuxt": ">=3.0.0"
6
6
  },
7
- "version": "0.1.11",
7
+ "version": "0.1.12",
8
8
  "builder": {
9
9
  "@nuxt/module-builder": "1.0.2",
10
10
  "unbuild": "3.6.1"
@@ -26,7 +26,8 @@ function useApi(callback) {
26
26
  default: currentOptions.default,
27
27
  error,
28
28
  loading,
29
- meta
29
+ meta,
30
+ params
30
31
  });
31
32
  };
32
33
  if (initialOptions.immediate) {
@@ -9,10 +9,11 @@ type OnResponseArgs = {
9
9
  response: FetchResponse<unknown>;
10
10
  request: RequestInfo;
11
11
  };
12
- type OnSuccessArgs<TData = unknown, TMeta = Record<string, unknown>> = {
12
+ type OnSuccessArgs<TData = unknown, TMeta = Record<string, unknown>, TParams = object> = {
13
13
  data: TData;
14
14
  meta: TMeta;
15
15
  headers: FetchOptions['headers'];
16
+ params: TParams;
16
17
  };
17
18
  type OnCompleteArgs = {
18
19
  response?: FetchResponse<unknown>;
@@ -24,13 +25,13 @@ export interface RefOptions {
24
25
  loading?: Ref<boolean>;
25
26
  meta?: Ref<Record<string, unknown>>;
26
27
  }
27
- export interface HooksOptions<TData = unknown, TMeta = Record<string, unknown>> {
28
+ export interface HooksOptions<TData = unknown, TMeta = Record<string, unknown>, TParams = object> {
28
29
  onBeforeSend?(args: OnBeforeSendArgs): Promise<unknown> | unknown;
29
30
  onComplete?(args: OnCompleteArgs): Promise<unknown> | unknown;
30
31
  onError?(reason: Error): Promise<unknown> | unknown;
31
32
  onFatal?(reason: Error): Promise<unknown> | unknown;
32
33
  onResponse?(args: OnResponseArgs): Promise<unknown> | unknown;
33
- onSuccess?(args: OnSuccessArgs<TData, TMeta>): Promise<unknown> | unknown;
34
+ onSuccess?(args: OnSuccessArgs<TData, TMeta, TParams>): Promise<unknown> | unknown;
34
35
  }
35
36
  export interface ParamsOptions {
36
37
  body?: FetchOptions['body'];
@@ -42,6 +43,8 @@ export interface ParamsOptions {
42
43
  query?: FetchOptions['query'];
43
44
  timeout?: FetchOptions['timeout'];
44
45
  }
45
- export type ApiOptions<TData = unknown, TMeta = Record<string, unknown>> = ParamsOptions & HooksOptions<TData, TMeta> & RefOptions;
46
+ export type ApiOptions<TData = unknown, TMeta = Record<string, unknown>, TParams = object> = ParamsOptions & HooksOptions<TData, TMeta, TParams> & RefOptions & {
47
+ params?: TParams;
48
+ };
46
49
  declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
47
50
  export default _default;
@@ -34,7 +34,7 @@ export default defineNuxtPlugin(({ provide }) => provide("api", async (url, opti
34
34
  const { data, meta } = _data || {};
35
35
  await options?.onResponse?.({ response, request });
36
36
  if (status >= 400) return;
37
- await options?.onSuccess?.({ data, meta, headers });
37
+ await options?.onSuccess?.({ data, meta, headers, params: options.params });
38
38
  if (options.data) options.data.value = data;
39
39
  if (options.meta) options.meta.value = meta;
40
40
  await options?.onComplete?.({ response, request });
@@ -5,7 +5,7 @@ export interface AdapterOptions {
5
5
  meta: Record<string, unknown>;
6
6
  params: object;
7
7
  }
8
- export interface AdapterArgs<TData, TMeta, TParams> extends HooksOptions<TData, TMeta> {
8
+ export interface AdapterArgs<TData, TMeta, TParams> extends HooksOptions<TData, TMeta, TParams> {
9
9
  params?: Partial<TParams>;
10
10
  }
11
11
  type AdapterCallback<T extends AdapterOptions> = (args: T['params']) => AdapterArgs<T['data'], T['meta'], T['params']>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@merkaly/nuxt",
3
- "version": "0.1.11",
3
+ "version": "0.1.12",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/merkaly-io/nuxt.git"
@@ -27,6 +27,20 @@
27
27
  "files": [
28
28
  "dist"
29
29
  ],
30
+ "scripts": {
31
+ "build": "nuxt-module-build build",
32
+ "build:stub": "nuxt-module-build build --stub",
33
+ "dev": "pnpm dev:prepare && cd playground && pnpm storybook",
34
+ "dev:build": "nuxi build playground",
35
+ "dev:prepare": "pnpm build:stub && nuxi prepare playground",
36
+ "lint": "eslint .",
37
+ "prepack": "pnpm build",
38
+ "prepare": "nuxt-module-build prepare",
39
+ "release": "pnpm lint && pnpm test && pnpm build && changelogen --release && npm publish --access public && git push --follow-tags",
40
+ "test": "vitest run",
41
+ "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
42
+ "test:watch": "vitest watch"
43
+ },
30
44
  "dependencies": {
31
45
  "@auth0/auth0-spa-js": "^2.11.0",
32
46
  "@bootstrap-vue-next/nuxt": "^0.42.0",
@@ -66,17 +80,5 @@
66
80
  },
67
81
  "engines": {
68
82
  "node": ">=20.0.0"
69
- },
70
- "scripts": {
71
- "build": "nuxt-module-build build",
72
- "build:stub": "nuxt-module-build build --stub",
73
- "dev": "pnpm dev:prepare && cd playground && pnpm storybook",
74
- "dev:build": "nuxi build playground",
75
- "dev:prepare": "pnpm build:stub && nuxi prepare playground",
76
- "lint": "eslint .",
77
- "release": "pnpm lint && pnpm test && pnpm build && changelogen --release && npm publish --access public && git push --follow-tags",
78
- "test": "vitest run",
79
- "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
80
- "test:watch": "vitest watch"
81
83
  }
82
- }
84
+ }