@clipboard-health/json-api 0.14.1 → 0.15.1
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 +2 -0
- package/package.json +12 -5
- package/src/lib/query/toClientSearchParams.d.ts +31 -2
- package/src/lib/query/toClientSearchParams.js +31 -2
- package/src/lib/query/toClientSearchParams.js.map +1 -1
- package/src/lib/query/toServerJsonApiQuery.d.ts +29 -2
- package/src/lib/query/toServerJsonApiQuery.js +29 -2
- package/src/lib/query/toServerJsonApiQuery.js.map +1 -1
package/README.md
CHANGED
|
@@ -25,6 +25,7 @@ From the client, call `toClientSearchParams` to convert from `ClientJsonApiQuery
|
|
|
25
25
|
```ts
|
|
26
26
|
// ./examples/toClientSearchParams.ts
|
|
27
27
|
|
|
28
|
+
// packages/json-api/src/lib/query/toClientSearchParams.ts
|
|
28
29
|
import { deepEqual } from "node:assert/strict";
|
|
29
30
|
|
|
30
31
|
import { toClientSearchParams } from "@clipboard-health/json-api";
|
|
@@ -61,6 +62,7 @@ From the server, call `toServerJsonApiQuery` to convert from `URLSearchParams` t
|
|
|
61
62
|
```ts
|
|
62
63
|
// ./examples/toServerJsonApiQuery.ts
|
|
63
64
|
|
|
65
|
+
// packages/json-api/src/lib/query/toServerJsonApiQuery.ts
|
|
64
66
|
import { deepEqual } from "node:assert/strict";
|
|
65
67
|
|
|
66
68
|
import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
|
package/package.json
CHANGED
|
@@ -1,21 +1,28 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clipboard-health/json-api",
|
|
3
3
|
"description": "TypeScript-friendly utilities for adhering to the JSON:API specification.",
|
|
4
|
-
"version": "0.
|
|
5
|
-
"bugs": "https://github.com/
|
|
4
|
+
"version": "0.15.1",
|
|
5
|
+
"bugs": "https://github.com/ClipboardHealth/core-utils/issues",
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"tslib": "2.8.0"
|
|
8
8
|
},
|
|
9
|
-
"keywords": [
|
|
9
|
+
"keywords": [
|
|
10
|
+
"api",
|
|
11
|
+
"json-api",
|
|
12
|
+
"json:api",
|
|
13
|
+
"jsonapi",
|
|
14
|
+
"rest",
|
|
15
|
+
"typescript"
|
|
16
|
+
],
|
|
10
17
|
"license": "MIT",
|
|
11
18
|
"main": "./src/index.js",
|
|
12
19
|
"publishConfig": {
|
|
13
20
|
"access": "public"
|
|
14
21
|
},
|
|
15
22
|
"repository": {
|
|
23
|
+
"directory": "packages/json-api",
|
|
16
24
|
"type": "git",
|
|
17
|
-
"url": "git+https://github.com/
|
|
18
|
-
"directory": "packages/json-api"
|
|
25
|
+
"url": "git+https://github.com/ClipboardHealth/core-utils.git"
|
|
19
26
|
},
|
|
20
27
|
"scripts": {
|
|
21
28
|
"embed": "embedme README.md"
|
|
@@ -2,8 +2,37 @@ 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
|
+
* @example
|
|
6
|
+
* ```ts
|
|
7
|
+
* // packages/json-api/examples/toClientSearchParams.ts
|
|
8
|
+
* import { deepEqual } from "node:assert/strict";
|
|
6
9
|
*
|
|
7
|
-
*
|
|
10
|
+
* import { toClientSearchParams } from "@clipboard-health/json-api";
|
|
11
|
+
*
|
|
12
|
+
* import { type ClientJsonApiQuery } from "../src/lib/types";
|
|
13
|
+
*
|
|
14
|
+
* const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
15
|
+
* const query: ClientJsonApiQuery = {
|
|
16
|
+
* fields: { user: ["age", "dateOfBirth"] },
|
|
17
|
+
* filter: {
|
|
18
|
+
* age: { eq: ["2"] },
|
|
19
|
+
* dateOfBirth: { gt: [date1], lt: [date2] },
|
|
20
|
+
* isActive: { eq: ["true"] },
|
|
21
|
+
* },
|
|
22
|
+
* include: ["article"],
|
|
23
|
+
* page: {
|
|
24
|
+
* size: "10",
|
|
25
|
+
* },
|
|
26
|
+
* sort: ["-age"],
|
|
27
|
+
* };
|
|
28
|
+
*
|
|
29
|
+
* deepEqual(
|
|
30
|
+
* toClientSearchParams(query).toString(),
|
|
31
|
+
* new URLSearchParams(
|
|
32
|
+
* `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
33
|
+
* ).toString(),
|
|
34
|
+
* );
|
|
35
|
+
*
|
|
36
|
+
* ```
|
|
8
37
|
*/
|
|
9
38
|
export declare function toClientSearchParams(query: ClientJsonApiQuery): URLSearchParams;
|
|
@@ -10,9 +10,38 @@ function join(values) {
|
|
|
10
10
|
/**
|
|
11
11
|
* Call this function from clients to convert from {@link ClientJsonApiQuery} to {@link URLSearchParams}.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* // packages/json-api/examples/toClientSearchParams.ts
|
|
16
|
+
* import { deepEqual } from "node:assert/strict";
|
|
14
17
|
*
|
|
15
|
-
*
|
|
18
|
+
* import { toClientSearchParams } from "@clipboard-health/json-api";
|
|
19
|
+
*
|
|
20
|
+
* import { type ClientJsonApiQuery } from "../src/lib/types";
|
|
21
|
+
*
|
|
22
|
+
* const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
23
|
+
* const query: ClientJsonApiQuery = {
|
|
24
|
+
* fields: { user: ["age", "dateOfBirth"] },
|
|
25
|
+
* filter: {
|
|
26
|
+
* age: { eq: ["2"] },
|
|
27
|
+
* dateOfBirth: { gt: [date1], lt: [date2] },
|
|
28
|
+
* isActive: { eq: ["true"] },
|
|
29
|
+
* },
|
|
30
|
+
* include: ["article"],
|
|
31
|
+
* page: {
|
|
32
|
+
* size: "10",
|
|
33
|
+
* },
|
|
34
|
+
* sort: ["-age"],
|
|
35
|
+
* };
|
|
36
|
+
*
|
|
37
|
+
* deepEqual(
|
|
38
|
+
* toClientSearchParams(query).toString(),
|
|
39
|
+
* new URLSearchParams(
|
|
40
|
+
* `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
41
|
+
* ).toString(),
|
|
42
|
+
* );
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
16
45
|
*/
|
|
17
46
|
function toClientSearchParams(query) {
|
|
18
47
|
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":";;AA8CA,oDAoCC;AAhFD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;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,8 +2,35 @@ 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
|
+
* @example
|
|
6
|
+
* ```ts
|
|
7
|
+
* // packages/json-api/examples/toServerJsonApiQuery.ts
|
|
8
|
+
* import { deepEqual } from "node:assert/strict";
|
|
6
9
|
*
|
|
7
|
-
*
|
|
10
|
+
* import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
|
|
11
|
+
*
|
|
12
|
+
* const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
13
|
+
* // The URLSearchParams constructor also supports URL-encoded strings
|
|
14
|
+
* const searchParams = new URLSearchParams(
|
|
15
|
+
* `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
16
|
+
* );
|
|
17
|
+
*
|
|
18
|
+
* const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
|
|
19
|
+
*
|
|
20
|
+
* deepEqual(query, {
|
|
21
|
+
* fields: { user: ["age", "dateOfBirth"] },
|
|
22
|
+
* filter: {
|
|
23
|
+
* age: { eq: ["2"] },
|
|
24
|
+
* dateOfBirth: { gt: [date1], lt: [date2] },
|
|
25
|
+
* isActive: { eq: ["true"] },
|
|
26
|
+
* },
|
|
27
|
+
* include: ["article"],
|
|
28
|
+
* page: {
|
|
29
|
+
* size: "10",
|
|
30
|
+
* },
|
|
31
|
+
* sort: ["-age"],
|
|
32
|
+
* });
|
|
33
|
+
*
|
|
34
|
+
* ```
|
|
8
35
|
*/
|
|
9
36
|
export declare function toServerJsonApiQuery(searchParams: URLSearchParams): ServerJsonApiQuery;
|
|
@@ -12,9 +12,36 @@ const REGEX = {
|
|
|
12
12
|
/**
|
|
13
13
|
* Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
|
|
14
14
|
*
|
|
15
|
-
* @
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* // packages/json-api/examples/toServerJsonApiQuery.ts
|
|
18
|
+
* import { deepEqual } from "node:assert/strict";
|
|
16
19
|
*
|
|
17
|
-
*
|
|
20
|
+
* import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
|
|
21
|
+
*
|
|
22
|
+
* const [date1, date2] = ["2024-01-01", "2024-01-02"];
|
|
23
|
+
* // The URLSearchParams constructor also supports URL-encoded strings
|
|
24
|
+
* const searchParams = new URLSearchParams(
|
|
25
|
+
* `fields[user]=age,dateOfBirth&filter[age]=2&filter[dateOfBirth][gt]=${date1}&filter[dateOfBirth][lt]=${date2}&filter[isActive]=true&include=article&page[size]=10&sort=-age`,
|
|
26
|
+
* );
|
|
27
|
+
*
|
|
28
|
+
* const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
|
|
29
|
+
*
|
|
30
|
+
* deepEqual(query, {
|
|
31
|
+
* fields: { user: ["age", "dateOfBirth"] },
|
|
32
|
+
* filter: {
|
|
33
|
+
* age: { eq: ["2"] },
|
|
34
|
+
* dateOfBirth: { gt: [date1], lt: [date2] },
|
|
35
|
+
* isActive: { eq: ["true"] },
|
|
36
|
+
* },
|
|
37
|
+
* include: ["article"],
|
|
38
|
+
* page: {
|
|
39
|
+
* size: "10",
|
|
40
|
+
* },
|
|
41
|
+
* sort: ["-age"],
|
|
42
|
+
* });
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
18
45
|
*/
|
|
19
46
|
function toServerJsonApiQuery(searchParams) {
|
|
20
47
|
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":";;AA6CA,oDAiDC;AA5FD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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"}
|