@orpc/vue-colada 0.0.0-next.fd1db03 → 0.0.0-next.ff5907c
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 +30 -28
- package/dist/src/{utils-general.d.ts → general-utils.d.ts} +2 -6
- package/dist/src/index.d.ts +4 -4
- package/dist/src/procedure-utils.d.ts +10 -0
- package/dist/src/router-utils.d.ts +12 -0
- package/dist/src/types.d.ts +16 -16
- package/dist/src/utils.d.ts +4 -4
- package/package.json +5 -9
- package/dist/src/utils-procedure.d.ts +0 -26
- package/dist/src/utils-router.d.ts +0 -12
package/dist/index.js
CHANGED
@@ -1,63 +1,65 @@
|
|
1
1
|
// src/key.ts
|
2
|
-
import {
|
2
|
+
import { serializeRPCJson } from "@orpc/client/rpc";
|
3
3
|
function buildKey(path, options) {
|
4
4
|
return [
|
5
|
-
"__ORPC__",
|
6
5
|
...path,
|
7
|
-
...options?.input !== void 0 ? [{ input: JSON.stringify(
|
6
|
+
...options?.input !== void 0 ? [{ input: JSON.stringify(serializeRPCJson(options.input)) }] : []
|
8
7
|
];
|
9
8
|
}
|
10
9
|
|
10
|
+
// src/general-utils.ts
|
11
|
+
function createGeneralUtils(path) {
|
12
|
+
return {
|
13
|
+
key(options) {
|
14
|
+
return buildKey(path, options);
|
15
|
+
}
|
16
|
+
};
|
17
|
+
}
|
18
|
+
|
19
|
+
// src/procedure-utils.ts
|
20
|
+
import { computed } from "vue";
|
21
|
+
|
11
22
|
// src/utils.ts
|
23
|
+
import { isObject } from "@orpc/shared";
|
12
24
|
import { isRef } from "vue";
|
13
|
-
function
|
25
|
+
function unrefDeep(value) {
|
14
26
|
if (isRef(value)) {
|
15
|
-
return
|
27
|
+
return unrefDeep(value.value);
|
16
28
|
}
|
17
29
|
if (Array.isArray(value)) {
|
18
|
-
return value.map(
|
30
|
+
return value.map(unrefDeep);
|
19
31
|
}
|
20
|
-
if (value
|
32
|
+
if (isObject(value)) {
|
21
33
|
return Object.keys(value).reduce((acc, key) => {
|
22
|
-
acc[key] =
|
34
|
+
acc[key] = unrefDeep(value[key]);
|
23
35
|
return acc;
|
24
36
|
}, {});
|
25
37
|
}
|
26
38
|
return value;
|
27
39
|
}
|
28
40
|
|
29
|
-
// src/utils
|
30
|
-
function createGeneralUtils(path) {
|
31
|
-
return {
|
32
|
-
key(options) {
|
33
|
-
return buildKey(path, deepUnref(options));
|
34
|
-
}
|
35
|
-
};
|
36
|
-
}
|
37
|
-
|
38
|
-
// src/utils-procedure.ts
|
39
|
-
import { computed } from "vue";
|
41
|
+
// src/procedure-utils.ts
|
40
42
|
function createProcedureUtils(client, path) {
|
41
43
|
return {
|
42
|
-
|
43
|
-
|
44
|
+
call: client,
|
45
|
+
queryOptions(...[{ input, context, ...rest } = {}]) {
|
44
46
|
return {
|
45
|
-
key: computed(() => buildKey(path, { input:
|
46
|
-
query: ({ signal }) => client(
|
47
|
-
...
|
47
|
+
key: computed(() => buildKey(path, { input: unrefDeep(input) })),
|
48
|
+
query: ({ signal }) => client(unrefDeep(input), { signal, context: unrefDeep(context) }),
|
49
|
+
...rest
|
48
50
|
};
|
49
51
|
},
|
50
|
-
mutationOptions(...[
|
52
|
+
mutationOptions(...[{ context, ...rest } = {}]) {
|
51
53
|
return {
|
52
54
|
key: (input) => buildKey(path, { input }),
|
53
|
-
mutation: (input
|
54
|
-
...
|
55
|
+
mutation: (input) => client(input, { context: unrefDeep(context) }),
|
56
|
+
...rest
|
55
57
|
};
|
56
58
|
}
|
57
59
|
};
|
58
60
|
}
|
59
61
|
|
60
|
-
// src/utils
|
62
|
+
// src/router-utils.ts
|
61
63
|
function createRouterUtils(client, path = []) {
|
62
64
|
const generalUtils = createGeneralUtils(path);
|
63
65
|
const procedureUtils = createProcedureUtils(client, path);
|
@@ -1,11 +1,7 @@
|
|
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
|
-
*/
|
7
3
|
export interface GeneralUtils<TInput> {
|
8
|
-
key
|
4
|
+
key(options?: BuildKeyOptions<TInput>): EntryKey;
|
9
5
|
}
|
10
6
|
export declare function createGeneralUtils<TInput>(path: string[]): GeneralUtils<TInput>;
|
11
|
-
//# sourceMappingURL=utils
|
7
|
+
//# sourceMappingURL=general-utils.d.ts.map
|
package/dist/src/index.d.ts
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
import { createRouterUtils } from './utils
|
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,10 @@
|
|
1
|
+
import type { Client, ClientContext } from '@orpc/client';
|
2
|
+
import type { MaybeOptionalOptions } from '@orpc/shared';
|
3
|
+
import type { MutationOptions, MutationOptionsIn, QueryOptions, QueryOptionsIn } from './types';
|
4
|
+
export interface ProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
5
|
+
call: Client<TClientContext, TInput, TOutput, TError>;
|
6
|
+
queryOptions(...rest: MaybeOptionalOptions<QueryOptionsIn<TClientContext, TInput, TOutput, TError>>): QueryOptions<TOutput, TError>;
|
7
|
+
mutationOptions(...rest: MaybeOptionalOptions<MutationOptionsIn<TClientContext, TInput, TOutput, TError>>): MutationOptions<TInput, TOutput, TError>;
|
8
|
+
}
|
9
|
+
export declare function createProcedureUtils<TClientContext extends ClientContext, TInput, TOutput, TError extends Error>(client: Client<TClientContext, TInput, TOutput, TError>, path: string[]): ProcedureUtils<TClientContext, TInput, TOutput, TError>;
|
10
|
+
//# sourceMappingURL=procedure-utils.d.ts.map
|
@@ -0,0 +1,12 @@
|
|
1
|
+
import type { Client, NestedClient } from '@orpc/client';
|
2
|
+
import { type GeneralUtils } from './general-utils';
|
3
|
+
import { type ProcedureUtils } from './procedure-utils';
|
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
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? RouterUtils<T[K]> : never;
|
6
|
+
} & GeneralUtils<unknown>;
|
7
|
+
/**
|
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
|
+
*/
|
11
|
+
export declare function createRouterUtils<T extends NestedClient<any>>(client: T, path?: string[]): RouterUtils<T>;
|
12
|
+
//# sourceMappingURL=router-utils.d.ts.map
|
package/dist/src/types.d.ts
CHANGED
@@ -1,25 +1,25 @@
|
|
1
|
+
import type { ClientContext } from '@orpc/client';
|
1
2
|
import type { AnyFunction, SetOptional } from '@orpc/shared';
|
2
3
|
import type { UseMutationOptions, UseQueryOptions } from '@pinia/colada';
|
3
4
|
import type { MaybeRef } from 'vue';
|
4
|
-
export type
|
5
|
-
[K in keyof T]:
|
5
|
+
export type MaybeRefDeep<T> = MaybeRef<T extends AnyFunction ? T : T extends object ? {
|
6
|
+
[K in keyof T]: MaybeRefDeep<T[K]>;
|
6
7
|
} : T>;
|
7
8
|
export type UseQueryFnContext = Parameters<UseQueryOptions<any>['query']>[0];
|
8
|
-
export type
|
9
|
-
|
10
|
-
} ? T['cursor'] : never;
|
11
|
-
export type QueryOptions<TInput, TOutput, TClientContext> = (undefined extends TInput ? {
|
12
|
-
input?: MaybeDeepRef<TInput>;
|
9
|
+
export type QueryOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (undefined extends TInput ? {
|
10
|
+
input?: MaybeRefDeep<TInput>;
|
13
11
|
} : {
|
14
|
-
input:
|
15
|
-
}) & (
|
16
|
-
context?:
|
12
|
+
input: MaybeRefDeep<TInput>;
|
13
|
+
}) & (Record<never, never> extends TClientContext ? {
|
14
|
+
context?: MaybeRefDeep<TClientContext>;
|
17
15
|
} : {
|
18
|
-
context:
|
19
|
-
}) & SetOptional<UseQueryOptions<TOutput>, 'key' | 'query'>;
|
20
|
-
export type
|
21
|
-
|
16
|
+
context: MaybeRefDeep<TClientContext>;
|
17
|
+
}) & SetOptional<UseQueryOptions<TOutput, TError>, 'key' | 'query'>;
|
18
|
+
export type QueryOptions<TOutput, TError extends Error> = UseQueryOptions<TOutput, TError>;
|
19
|
+
export type MutationOptionsIn<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> = (Record<never, never> extends TClientContext ? {
|
20
|
+
context?: MaybeRefDeep<TClientContext>;
|
22
21
|
} : {
|
23
|
-
context:
|
24
|
-
}) & SetOptional<UseMutationOptions<TOutput, TInput>, 'mutation'>;
|
22
|
+
context: MaybeRefDeep<TClientContext>;
|
23
|
+
}) & SetOptional<UseMutationOptions<TOutput, TInput, TError>, 'mutation'>;
|
24
|
+
export type MutationOptions<TInput, TOutput, TError extends Error> = UseMutationOptions<TOutput, TInput, TError>;
|
25
25
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/src/utils.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
import type { AnyFunction } from '@orpc/shared';
|
2
1
|
import type { Ref } from 'vue';
|
3
|
-
|
4
|
-
|
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
|
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.0.0-next.
|
4
|
+
"version": "0.0.0-next.ff5907c",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,18 +33,14 @@
|
|
33
33
|
"dist"
|
34
34
|
],
|
35
35
|
"peerDependencies": {
|
36
|
-
"@pinia/colada": ">=0.13.
|
37
|
-
"vue": ">=3.3.0"
|
38
|
-
"@orpc/server": "0.0.0-next.fd1db03",
|
39
|
-
"@orpc/contract": "0.0.0-next.fd1db03",
|
40
|
-
"@orpc/client": "0.0.0-next.fd1db03"
|
36
|
+
"@pinia/colada": ">=0.13.5",
|
37
|
+
"vue": ">=3.3.0"
|
41
38
|
},
|
42
39
|
"dependencies": {
|
43
|
-
"@orpc/
|
40
|
+
"@orpc/client": "0.0.0-next.ff5907c",
|
41
|
+
"@orpc/shared": "0.0.0-next.ff5907c"
|
44
42
|
},
|
45
43
|
"devDependencies": {
|
46
|
-
"@pinia/colada": "^0.13.1",
|
47
|
-
"@vue/test-utils": "^2.4.6",
|
48
44
|
"pinia": "^2.3.0"
|
49
45
|
},
|
50
46
|
"scripts": {
|
@@ -1,26 +0,0 @@
|
|
1
|
-
import type { ProcedureClient } from '@orpc/server';
|
2
|
-
import type { IsEqual } from '@orpc/shared';
|
3
|
-
import type { EntryKey } from '@pinia/colada';
|
4
|
-
import type { ComputedRef } from 'vue';
|
5
|
-
import type { MutationOptions, QueryOptions, UseQueryFnContext } from './types';
|
6
|
-
/**
|
7
|
-
* Utils at procedure level
|
8
|
-
*/
|
9
|
-
export interface ProcedureUtils<TInput, TOutput, TClientContext> {
|
10
|
-
queryOptions: <U extends QueryOptions<TInput, TOutput, TClientContext>>(...opt: [options: U] | (undefined extends TInput & TClientContext ? [] : never)) => IsEqual<U, QueryOptions<TInput, TOutput, TClientContext>> extends true ? {
|
11
|
-
key: ComputedRef<EntryKey>;
|
12
|
-
query: (ctx: UseQueryFnContext) => Promise<TOutput>;
|
13
|
-
} : Omit<{
|
14
|
-
key: ComputedRef<EntryKey>;
|
15
|
-
query: (ctx: UseQueryFnContext) => Promise<TOutput>;
|
16
|
-
}, keyof U> & U;
|
17
|
-
mutationOptions: <U extends MutationOptions<TInput, TOutput, TClientContext>>(...opt: [options: U] | (undefined extends TClientContext ? [] : never)) => IsEqual<U, MutationOptions<TInput, TOutput, TClientContext>> extends true ? {
|
18
|
-
key: (input: TInput) => EntryKey;
|
19
|
-
mutation: (input: TInput) => Promise<TOutput>;
|
20
|
-
} : Omit<{
|
21
|
-
key: (input: TInput) => EntryKey;
|
22
|
-
mutation: (input: TInput) => Promise<TOutput>;
|
23
|
-
}, keyof U> & U;
|
24
|
-
}
|
25
|
-
export declare function createProcedureUtils<TInput, TOutput, TClientContext>(client: ProcedureClient<TInput, TOutput, TClientContext>, path: string[]): ProcedureUtils<TInput, TOutput, TClientContext>;
|
26
|
-
//# sourceMappingURL=utils-procedure.d.ts.map
|
@@ -1,12 +0,0 @@
|
|
1
|
-
import type { ProcedureClient, RouterClient } from '@orpc/server';
|
2
|
-
import { type GeneralUtils } from './utils-general';
|
3
|
-
import { type ProcedureUtils } from './utils-procedure';
|
4
|
-
export type RouterUtils<T extends RouterClient<any, any>> = T extends ProcedureClient<infer TInput, infer TOutput, infer TClientContext> ? ProcedureUtils<TInput, TOutput, TClientContext> & GeneralUtils<TInput> : {
|
5
|
-
[K in keyof T]: T[K] extends RouterClient<any, any> ? RouterUtils<T[K]> : never;
|
6
|
-
} & GeneralUtils<unknown>;
|
7
|
-
/**
|
8
|
-
* @param client - The client create form `@orpc/client`
|
9
|
-
* @param path - The base path for query key
|
10
|
-
*/
|
11
|
-
export declare function createRouterUtils<T extends RouterClient<any, any>>(client: T, path?: string[]): RouterUtils<T>;
|
12
|
-
//# sourceMappingURL=utils-router.d.ts.map
|