@clipboard-health/json-api 0.3.0 → 0.4.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/README.md +10 -10
- package/package.json +1 -1
- package/src/lib/query/toClientSearchParams.d.ts +3 -1
- package/src/lib/query/toClientSearchParams.js +3 -1
- package/src/lib/query/toClientSearchParams.js.map +1 -1
- package/src/lib/query/toServerJsonApiQuery.d.ts +3 -1
- package/src/lib/query/toServerJsonApiQuery.js +3 -1
- package/src/lib/query/toServerJsonApiQuery.js.map +1 -1
- package/src/lib/types.d.ts +12 -13
package/README.md
CHANGED
|
@@ -33,13 +33,13 @@ import { type ClientJsonApiQuery } from "../src/lib/types";
|
|
|
33
33
|
|
|
34
34
|
const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
35
35
|
const query: ClientJsonApiQuery = {
|
|
36
|
-
fields: {
|
|
36
|
+
fields: { user: ["age", "name"] },
|
|
37
37
|
filter: {
|
|
38
38
|
age: { eq: ["2"] },
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
dateOfBirth: { gt: [date1], lt: [date2] },
|
|
40
|
+
isActive: { eq: ["true"] },
|
|
41
41
|
},
|
|
42
|
-
include: ["
|
|
42
|
+
include: ["article"],
|
|
43
43
|
page: {
|
|
44
44
|
size: "10",
|
|
45
45
|
},
|
|
@@ -49,7 +49,7 @@ const query: ClientJsonApiQuery = {
|
|
|
49
49
|
deepEqual(
|
|
50
50
|
toClientSearchParams(query).toString(),
|
|
51
51
|
new URLSearchParams(
|
|
52
|
-
`fields[
|
|
52
|
+
`fields[user]=age,name&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
53
53
|
).toString(),
|
|
54
54
|
);
|
|
55
55
|
|
|
@@ -68,19 +68,19 @@ import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health
|
|
|
68
68
|
const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
69
69
|
// The URLSearchParams constructor also supports URL-encoded strings
|
|
70
70
|
const searchParams = new URLSearchParams(
|
|
71
|
-
`fields[
|
|
71
|
+
`fields[user]=age,name&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
72
72
|
);
|
|
73
73
|
|
|
74
74
|
const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
|
|
75
75
|
|
|
76
76
|
deepEqual(query, {
|
|
77
|
-
fields: {
|
|
77
|
+
fields: { user: ["age", "name"] },
|
|
78
78
|
filter: {
|
|
79
79
|
age: { eq: ["2"] },
|
|
80
|
-
|
|
81
|
-
|
|
80
|
+
dateOfBirth: { gt: [date1], lt: [date2] },
|
|
81
|
+
isActive: { eq: ["true"] },
|
|
82
82
|
},
|
|
83
|
-
include: ["
|
|
83
|
+
include: ["article"],
|
|
84
84
|
page: {
|
|
85
85
|
size: "10",
|
|
86
86
|
},
|
package/package.json
CHANGED
|
@@ -2,6 +2,8 @@ import { type ClientJsonApiQuery } from "../types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Call this function from clients to convert from {@link ClientJsonApiQuery} to {@link URLSearchParams}.
|
|
4
4
|
*
|
|
5
|
-
* @
|
|
5
|
+
* @includeExample ./packages/json-api/examples/toClientSearchParams.ts
|
|
6
|
+
*
|
|
7
|
+
* @see [Usage example](../../../examples/toClientSearchParams.ts)
|
|
6
8
|
*/
|
|
7
9
|
export declare function toClientSearchParams(query: ClientJsonApiQuery): URLSearchParams;
|
|
@@ -10,7 +10,9 @@ function join(values) {
|
|
|
10
10
|
/**
|
|
11
11
|
* Call this function from clients to convert from {@link ClientJsonApiQuery} to {@link URLSearchParams}.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @includeExample ./packages/json-api/examples/toClientSearchParams.ts
|
|
14
|
+
*
|
|
15
|
+
* @see [Usage example](../../../examples/toClientSearchParams.ts)
|
|
14
16
|
*/
|
|
15
17
|
function toClientSearchParams(query) {
|
|
16
18
|
const searchParams = new URLSearchParams();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toClientSearchParams.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toClientSearchParams.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"toClientSearchParams.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toClientSearchParams.ts"],"names":[],"mappings":";;AAiBA,oDAoCC;AAnDD,SAAS,iBAAiB,CAAC,KAAyC;IAClE,OAAO,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACrE,CAAC;AAED,SAAS,IAAI,CAAC,MAAgB;IAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,KAAyB;IAC5D,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAC;IAE3C,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE;YACtD,YAAY,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE;YACvD,MAAM,WAAW,GAAG,UAAU,KAAK,GAAG,CAAC;YACvC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;gBACpD,YAAY,CAAC,MAAM,CACjB,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,SAAS,GAAG,EACjE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CACrD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAClD,YAAY,CAAC,MAAM,CAAC,QAAQ,GAAG,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC"}
|
|
@@ -2,6 +2,8 @@ import { type ServerJsonApiQuery } from "../types";
|
|
|
2
2
|
/**
|
|
3
3
|
* Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
|
|
4
4
|
*
|
|
5
|
-
* @
|
|
5
|
+
* @includeExample packages/json-api/examples/toServerJsonApiQuery.ts
|
|
6
|
+
*
|
|
7
|
+
* @see [Usage example](../../../examples/toServerJsonApiQuery.ts)
|
|
6
8
|
*/
|
|
7
9
|
export declare function toServerJsonApiQuery(searchParams: URLSearchParams): ServerJsonApiQuery;
|
|
@@ -12,7 +12,9 @@ const REGEX = {
|
|
|
12
12
|
/**
|
|
13
13
|
* Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
|
|
14
14
|
*
|
|
15
|
-
* @
|
|
15
|
+
* @includeExample packages/json-api/examples/toServerJsonApiQuery.ts
|
|
16
|
+
*
|
|
17
|
+
* @see [Usage example](../../../examples/toServerJsonApiQuery.ts)
|
|
16
18
|
*/
|
|
17
19
|
function toServerJsonApiQuery(searchParams) {
|
|
18
20
|
return [...searchParams].reduce((accumulator, [key, value]) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toServerJsonApiQuery.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toServerJsonApiQuery.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"toServerJsonApiQuery.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toServerJsonApiQuery.ts"],"names":[],"mappings":";;AAkBA,oDAiDC;AAjED,MAAM,KAAK,GAAG;IACZ,MAAM,EAAE,mBAAmB;IAC3B,MAAM,EAAE,uBAAuB;IAC/B,UAAU,EAAE,2BAA2B;IACvC,OAAO,EAAE,YAAY;IACrB,IAAI,EAAE,iBAAiB;IACvB,IAAI,EAAE,SAAS;CACP,CAAC;AAEX;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,YAA6B;IAChE,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC,MAAM,CAAqB,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAChF,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,KAAqC,CAAC;QAC5D,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,IAAI,KAAK,QAAQ,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,OAAO;gBACL,GAAG,WAAW;gBACd,MAAM,EAAE;oBACN,GAAG,WAAW,CAAC,MAAM;oBACrB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;iBAC9B;aACF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,YAAY,CAAC,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;YACnE,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC;YAClC,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO;oBACL,GAAG,WAAW;oBACd,MAAM,EAAE;wBACN,GAAG,WAAW,CAAC,MAAM;wBACrB,CAAC,KAAK,CAAC,EAAE;4BACP,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC;4BAC9B,CAAC,SAAS,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;yBACtC;qBACF;iBACF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1C,OAAO,EAAE,GAAG,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACtD,CAAC;QAED,IAAI,IAAI,KAAK,MAAM,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnC,OAAO;gBACL,GAAG,WAAW;gBACd,IAAI,EAAE,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE;aAClD,CAAC;QACJ,CAAC;QAED,0BAA0B;QAC1B,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC"}
|
package/src/lib/types.d.ts
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
* - gte: Greater than or equal to.
|
|
7
7
|
* - lt: Less than.
|
|
8
8
|
* - lte: Less than or equal to.
|
|
9
|
-
* - not: Not.
|
|
10
9
|
*/
|
|
11
|
-
type FilterType = "eq" | "ne" | "gt" | "gte" | "lt" | "lte"
|
|
10
|
+
type FilterType = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
|
|
12
11
|
type PageKey = "cursor" | "limit" | "number" | "offset" | "size";
|
|
13
|
-
|
|
12
|
+
export { type URLSearchParams } from "node:url";
|
|
13
|
+
export interface JsonApiQueryTypes {
|
|
14
14
|
filterValue: unknown;
|
|
15
15
|
pageValue: unknown;
|
|
16
16
|
}
|
|
@@ -18,25 +18,25 @@ export interface ClientTypes {
|
|
|
18
18
|
filterValue: Array<Date | number | string | boolean>;
|
|
19
19
|
pageValue: number | string;
|
|
20
20
|
}
|
|
21
|
-
interface ServerTypes {
|
|
21
|
+
export interface ServerTypes {
|
|
22
22
|
filterValue: string[];
|
|
23
23
|
pageValue: string;
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* A JSON:API URL query string.
|
|
27
27
|
*/
|
|
28
|
-
interface JsonApiQuery<T extends JsonApiQueryTypes> {
|
|
28
|
+
export interface JsonApiQuery<T extends JsonApiQueryTypes> {
|
|
29
29
|
/**
|
|
30
30
|
* Fields to include in the response.
|
|
31
31
|
*
|
|
32
|
-
* @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets
|
|
32
|
+
* @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
|
|
33
33
|
*/
|
|
34
34
|
fields?: Record<string, string[]>;
|
|
35
35
|
/**
|
|
36
36
|
* Filters to apply to the query.
|
|
37
37
|
*
|
|
38
|
-
* @see {@link https://jsonapi.org/recommendations/#filtering
|
|
39
|
-
* @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257
|
|
38
|
+
* @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
|
|
39
|
+
* @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}
|
|
40
40
|
*/
|
|
41
41
|
filter?: Record<string, {
|
|
42
42
|
[K in FilterType]?: T["filterValue"];
|
|
@@ -44,14 +44,14 @@ interface JsonApiQuery<T extends JsonApiQueryTypes> {
|
|
|
44
44
|
/**
|
|
45
45
|
* Relationships to include in the response.
|
|
46
46
|
*
|
|
47
|
-
* @see {@link https://jsonapi.org/format/#fetching-includes
|
|
47
|
+
* @see {@link https://jsonapi.org/format/#fetching-includes JSON:API fetching includes}
|
|
48
48
|
*/
|
|
49
49
|
include?: string[];
|
|
50
50
|
/**
|
|
51
51
|
* Pagination data.
|
|
52
52
|
*
|
|
53
|
-
* @see {@link https://jsonapi.org/format/#fetching-pagination
|
|
54
|
-
* @see {@link https://jsonapi.org/examples/#pagination
|
|
53
|
+
* @see {@link https://jsonapi.org/format/#fetching-pagination JSON:API pagination}
|
|
54
|
+
* @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}
|
|
55
55
|
*/
|
|
56
56
|
page?: {
|
|
57
57
|
[K in PageKey]?: T["pageValue"];
|
|
@@ -59,10 +59,9 @@ interface JsonApiQuery<T extends JsonApiQueryTypes> {
|
|
|
59
59
|
/**
|
|
60
60
|
* Sorting data. Include the "-" prefix for descending order.
|
|
61
61
|
*
|
|
62
|
-
* @see {@link https://jsonapi.org/format/#fetching-sorting
|
|
62
|
+
* @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
|
|
63
63
|
*/
|
|
64
64
|
sort?: string[];
|
|
65
65
|
}
|
|
66
66
|
export type ClientJsonApiQuery = JsonApiQuery<ClientTypes>;
|
|
67
67
|
export type ServerJsonApiQuery = JsonApiQuery<ServerTypes>;
|
|
68
|
-
export {};
|