@orpc/vue-colada 0.36.1 → 0.37.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.
package/dist/index.js CHANGED
@@ -2,62 +2,69 @@
2
2
  import { serializeRPCJson } from "@orpc/server/standard";
3
3
  function buildKey(path, options) {
4
4
  return [
5
- "__ORPC__",
6
5
  ...path,
7
6
  ...options?.input !== void 0 ? [{ input: JSON.stringify(serializeRPCJson(options.input)) }] : []
8
7
  ];
9
8
  }
10
9
 
10
+ // ../shared/src/object.ts
11
+ function isObject(value) {
12
+ if (!value || typeof value !== "object") {
13
+ return false;
14
+ }
15
+ const proto = Object.getPrototypeOf(value);
16
+ return proto === Object.prototype || proto === null;
17
+ }
18
+
11
19
  // src/utils.ts
12
20
  import { isRef } from "vue";
13
- function deepUnref(value) {
21
+ function unrefDeep(value) {
14
22
  if (isRef(value)) {
15
- return deepUnref(value.value);
23
+ return unrefDeep(value.value);
16
24
  }
17
25
  if (Array.isArray(value)) {
18
- return value.map(deepUnref);
26
+ return value.map(unrefDeep);
19
27
  }
20
- if (value && typeof value === "object") {
28
+ if (isObject(value)) {
21
29
  return Object.keys(value).reduce((acc, key) => {
22
- acc[key] = deepUnref(value[key]);
30
+ acc[key] = unrefDeep(value[key]);
23
31
  return acc;
24
32
  }, {});
25
33
  }
26
34
  return value;
27
35
  }
28
36
 
29
- // src/utils-general.ts
37
+ // src/general-utils.ts
30
38
  function createGeneralUtils(path) {
31
39
  return {
32
40
  key(options) {
33
- return buildKey(path, deepUnref(options));
41
+ return buildKey(path, unrefDeep(options));
34
42
  }
35
43
  };
36
44
  }
37
45
 
38
- // src/utils-procedure.ts
46
+ // src/procedure-utils.ts
39
47
  import { computed } from "vue";
40
48
  function createProcedureUtils(client, path) {
41
49
  return {
42
- queryOptions(...[options]) {
43
- const input = options?.input;
50
+ queryOptions(...[{ input, context, ...rest } = {}]) {
44
51
  return {
45
- key: computed(() => buildKey(path, { input: deepUnref(input) })),
46
- query: ({ signal }) => client(deepUnref(input), { signal, context: deepUnref(options?.context) }),
47
- ...options
52
+ key: computed(() => buildKey(path, { input: unrefDeep(input) })),
53
+ query: ({ signal }) => client(unrefDeep(input), { signal, context: unrefDeep(context) }),
54
+ ...rest
48
55
  };
49
56
  },
50
- mutationOptions(...[options]) {
57
+ mutationOptions(...[{ context, ...rest } = {}]) {
51
58
  return {
52
59
  key: (input) => buildKey(path, { input }),
53
- mutation: (input, _) => client(input, { context: deepUnref(options?.context) }),
54
- ...options
60
+ mutation: (input) => client(input, { context: unrefDeep(context) }),
61
+ ...rest
55
62
  };
56
63
  }
57
64
  };
58
65
  }
59
66
 
60
- // src/utils-router.ts
67
+ // src/router-utils.ts
61
68
  function createRouterUtils(client, path = []) {
62
69
  const generalUtils = createGeneralUtils(path);
63
70
  const procedureUtils = createProcedureUtils(client, path);
@@ -1,11 +1,8 @@
1
1
  import type { EntryKey } from '@pinia/colada';
2
2
  import type { BuildKeyOptions } from './key';
3
- import type { MaybeDeepRef } from './types';
4
- /**
5
- * Utils at any level (procedure or router)
6
- */
3
+ import type { MaybeRefDeep } from './types';
7
4
  export interface GeneralUtils<TInput> {
8
- key(options?: MaybeDeepRef<BuildKeyOptions<TInput>>): EntryKey;
5
+ key(options?: MaybeRefDeep<BuildKeyOptions<TInput>>): EntryKey;
9
6
  }
10
7
  export declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
11
- //# sourceMappingURL=utils-general.d.ts.map
8
+ //# sourceMappingURL=general-utils.d.ts.map
@@ -1,8 +1,8 @@
1
- import { createRouterUtils } from './utils-router';
1
+ import { createRouterUtils } from './router-utils';
2
+ export * from './general-utils';
2
3
  export * from './key';
4
+ export * from './procedure-utils';
5
+ export * from './router-utils';
3
6
  export * from './types';
4
- export * from './utils-general';
5
- export * from './utils-procedure';
6
- export * from './utils-router';
7
7
  export declare const createORPCVueColadaUtils: typeof createRouterUtils;
8
8
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,9 @@
1
+ import type { Client } from '@orpc/contract';
2
+ import type { MaybeOptionalOptions } from '@orpc/shared';
3
+ import type { MutationOptions, MutationOptionsIn, QueryOptions, QueryOptionsIn } from './types';
4
+ export interface ProcedureUtils<TClientContext, TInput, TOutput, TError extends Error> {
5
+ queryOptions(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError>>): QueryOptions<TOutput, TError>;
6
+ mutationOptions(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError>>): MutationOptions<TInput, TOutput, TError>;
7
+ }
8
+ export declare function createProcedureUtils<TClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
9
+ //# sourceMappingURL=procedure-utils.d.ts.map
@@ -1,12 +1,12 @@
1
1
  import type { Client, NestedClient } from '@orpc/contract';
2
- import { type GeneralUtils } from './utils-general';
3
- import { type ProcedureUtils } from './utils-procedure';
2
+ import { type GeneralUtils } from './general-utils';
3
+ import { type ProcedureUtils } from './procedure-utils';
4
4
  export type RouterUtils<T extends NestedClient<any>> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ProcedureUtils<UClientContext, UInput, UOutput, UError> & GeneralUtils<UInput> : {
5
5
  [K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
6
6
  } & GeneralUtils<unknown>;
7
7
  /**
8
- * @param client - The client create form `@orpc/client`
9
- * @param path - The base path for query key
8
+ * @param client - Any kind of oRPC clients: `createRouterClient`, `createORPCClient`, ...
9
+ * @param path - The base path for query key, when it it will be prefix to all keys
10
10
  */
11
11
  export declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
12
- //# sourceMappingURL=utils-router.d.ts.map
12
+ //# sourceMappingURL=router-utils.d.ts.map
@@ -1,27 +1,24 @@
1
1
  import type { AnyFunction, SetOptional } from '@orpc/shared';
2
2
  import type { UseMutationOptions, UseQueryOptions } from '@pinia/colada';
3
3
  import type { MaybeRef } from 'vue';
4
- export type MaybeDeepRef<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
5
- [K in keyof T]: MaybeDeepRef<T[K]>;
4
+ export type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
5
+ [K in keyof T]: MaybeRefDeep<T[K]>;
6
6
  } : T>;
7
7
  export type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
8
- export type InferCursor<T> = T extends {
9
- cursor?: any;
10
- } ? T['cursor'] : never;
11
- export type QueryOptionsExtra<TClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
12
- input?: MaybeDeepRef<TInput>;
8
+ export type QueryOptionsIn<TClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
9
+ input?: MaybeRefDeep<TInput>;
13
10
  } : {
14
- input: MaybeDeepRef<TInput>;
11
+ input: MaybeRefDeep<TInput>;
15
12
  }) & (undefined extends TClientContext ? {
16
- context?: MaybeDeepRef<TClientContext>;
13
+ context?: MaybeRefDeep<TClientContext>;
17
14
  } : {
18
- context: MaybeDeepRef<TClientContext>;
15
+ context: MaybeRefDeep<TClientContext>;
19
16
  }) & SetOptional<UseQueryOptions<TOutput, TError>, 'key' | 'query'>;
20
17
  export type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>;
21
- export type MutationOptionsExtra<TClientContext, TInput, TOutput, TError extends Error> = (undefined extends TClientContext ? {
22
- context?: MaybeDeepRef<TClientContext>;
18
+ export type MutationOptionsIn<TClientContext, TInput, TOutput, TError extends Error> = (undefined extends TClientContext ? {
19
+ context?: MaybeRefDeep<TClientContext>;
23
20
  } : {
24
- context: MaybeDeepRef<TClientContext>;
21
+ context: MaybeRefDeep<TClientContext>;
25
22
  }) & SetOptional<UseMutationOptions<TOutput, TInput, TError>, 'mutation'>;
26
23
  export type MutationOptions<TInput, TOutput, TError extends Error> = UseMutationOptions<TOutput, TInput, TError>;
27
24
  //# sourceMappingURL=types.d.ts.map
@@ -1,7 +1,7 @@
1
- import type { AnyFunction } from '@orpc/shared';
2
1
  import type { Ref } from 'vue';
3
- export type DeepUnref<T> = T extends Ref<infer U> ? DeepUnref<U> : T extends AnyFunction ? T : T extends object ? {
4
- [K in keyof T]: DeepUnref<T[K]>;
2
+ import { type AnyFunction } from '@orpc/shared';
3
+ export type UnrefDeep<T> = T extends Ref<infer U> ? UnrefDeep<U> : T extends AnyFunction ? T : T extends object ? {
4
+ [K in keyof T]: UnrefDeep<T[K]>;
5
5
  } : T;
6
- export declare function deepUnref<T>(value: T): DeepUnref<T>;
6
+ export declare function unrefDeep<T>(value: T): UnrefDeep<T>;
7
7
  //# sourceMappingURL=utils.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/vue-colada",
3
3
  "type": "module",
4
- "version": "0.36.1",
4
+ "version": "0.37.0",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -33,17 +33,15 @@
33
33
  "dist"
34
34
  ],
35
35
  "peerDependencies": {
36
- "@pinia/colada": ">=0.13.1",
36
+ "@pinia/colada": "^0.13.5",
37
37
  "vue": ">=3.3.0",
38
- "@orpc/client": "0.36.1",
39
- "@orpc/contract": "0.36.1"
38
+ "@orpc/client": "0.37.0",
39
+ "@orpc/contract": "0.37.0"
40
40
  },
41
41
  "dependencies": {
42
- "@orpc/server": "0.36.1"
42
+ "@orpc/server": "0.37.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@pinia/colada": "^0.13.1",
46
- "@vue/test-utils": "^2.4.6",
47
45
  "pinia": "^2.3.0"
48
46
  },
49
47
  "scripts": {
@@ -1,11 +0,0 @@
1
- import type { Client } from '@orpc/contract';
2
- import type { MutationOptions, MutationOptionsExtra, QueryOptions, QueryOptionsExtra } from './types';
3
- /**
4
- * Utils at procedure level
5
- */
6
- export interface ProcedureUtils<TClientContext, TInput, TOutput, TError extends Error> {
7
- queryOptions<U extends QueryOptionsExtra<TClientContext, TInput, TOutput, TError>>(...opt: [options: U] | (undefined extends TInput & TClientContext ? [] : never)): QueryOptions<TOutput, TError>;
8
- mutationOptions<U extends MutationOptionsExtra<TClientContext, TInput, TOutput, TError>>(...opt: [options: U] | (undefined extends TClientContext ? [] : never)): MutationOptions<TInput, TOutput, TError>;
9
- }
10
- export declare function createProcedureUtils<TClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
11
- //# sourceMappingURL=utils-procedure.d.ts.map