@clipboard-health/json-api 0.17.3 → 0.18.0

package/README.md

@@ -19,14 +19,14 @@ npm install @clipboard-health/json-api
 
 ### Query helpers
 
-From the client, call `toClientSearchParams` to convert from `ClientJsonApiQuery` to `URLSearchParams`:
+From the client, call `stringifyQuery` to convert from `JsonApiQuery` to `URLSearchParams`:
 
-<embedex source="packages/json-api/examples/toClientSearchParams.ts">
+<embedex source="packages/json-api/examples/stringifyQuery.ts">
 
 ```ts
 import { deepEqual } from "node:assert/strict";
 
-import { toClientSearchParams } from "@clipboard-health/json-api";
+import { stringifyQuery } from "@clipboard-health/json-api";
 
 import { type ClientJsonApiQuery } from "../src/lib/types";
 
@@ -34,19 +34,22 @@ const [date1, date2] = ["2024-01-01", "2024-01-02"];
 const query: ClientJsonApiQuery = {
   fields: { user: ["age", "dateOfBirth"] },
   filter: {
-    age: { eq: ["2"] },
-    dateOfBirth: { gt: [date1], lt: [date2] },
-    isActive: { eq: ["true"] },
+    age: 2,
+    dateOfBirth: {
+      gt: date1,
+      lt: date2,
+    },
+    isActive: true,
   },
-  include: ["article"],
+  include: "article",
   page: {
-    size: "10",
+    size: 10,
   },
-  sort: ["-age"],
+  sort: "-age",
 };
 
 deepEqual(
-  toClientSearchParams(query).toString(),
+  stringifyQuery(query),
   new URLSearchParams(
     `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`,
   ).toString(),
@@ -54,14 +57,17 @@ deepEqual(
 ```
 
 </embedex>
-From the server, call `toServerJsonApiQuery` to convert from `URLSearchParams` to `ServerJsonApiQuery`:
 
-<embedex source="packages/json-api/examples/toServerJsonApiQuery.ts">
+From the server, call `parseQuery` to convert from `URLSearchParams` to `ServerJsonApiQuery`:
+
+<embedex source="packages/json-api/examples/parseQuery.ts">
 
 ```ts
 import { deepEqual } from "node:assert/strict";
 
-import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
+import { parseQuery } from "@clipboard-health/json-api";
+
+import { type ServerJsonApiQuery } from "../src/lib/types";
 
 const [date1, date2] = ["2024-01-01", "2024-01-02"];
 // The URLSearchParams constructor also supports URL-encoded strings
@@ -69,20 +75,20 @@ const searchParams = new URLSearchParams(
   `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`,
 );
 
-const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
+const query: ServerJsonApiQuery = parseQuery(searchParams.toString());
 
 deepEqual(query, {
   fields: { user: ["age", "dateOfBirth"] },
   filter: {
-    age: { eq: ["2"] },
-    dateOfBirth: { gt: [date1], lt: [date2] },
-    isActive: { eq: ["true"] },
+    age: "2",
+    dateOfBirth: { gt: date1, lt: date2 },
+    isActive: "true",
   },
-  include: ["article"],
+  include: "article",
   page: {
     size: "10",
   },
-  sort: ["-age"],
+  sort: "-age",
 });
 ```
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@clipboard-health/json-api",
   "description": "TypeScript-friendly utilities for adhering to the JSON:API specification.",
-  "version": "0.17.3",
+  "version": "0.18.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
+    "qs": "6.14.0",
     "tslib": "2.8.0"
   },
   "keywords": [

package/src/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./lib/query/toClientSearchParams";
-export * from "./lib/query/toServerJsonApiQuery";
+export * from "./lib/query/parseQuery";
+export * from "./lib/query/stringifyQuery";
 export * from "./lib/types";

package/src/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./lib/query/toClientSearchParams"), exports);
-tslib_1.__exportStar(require("./lib/query/toServerJsonApiQuery"), exports);
+tslib_1.__exportStar(require("./lib/query/parseQuery"), exports);
+tslib_1.__exportStar(require("./lib/query/stringifyQuery"), exports);
 tslib_1.__exportStar(require("./lib/types"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/json-api/src/index.ts"],"names":[],"mappings":";;;AAAA,2EAAiD;AACjD,2EAAiD;AACjD,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/json-api/src/index.ts"],"names":[],"mappings":";;;AAAA,iEAAuC;AACvC,qEAA2C;AAC3C,sDAA4B"}

package/src/lib/query/{toServerJsonApiQuery.d.ts → parseQuery.d.ts}

@@ -3,12 +3,14 @@ import { type ServerJsonApiQuery } from "../types";
  * Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
  *
  * @example
- * <embedex source="packages/json-api/examples/toServerJsonApiQuery.ts">
+ * <embedex source="packages/json-api/examples/parseQuery.ts">
  *
  * ```ts
  * import { deepEqual } from "node:assert/strict";
  *
- * import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
+ * import { parseQuery } from "@clipboard-health/json-api";
+ *
+ * import { type ServerJsonApiQuery } from "../src/lib/types";
  *
  * const [date1, date2] = ["2024-01-01", "2024-01-02"];
  * // The URLSearchParams constructor also supports URL-encoded strings
@@ -16,23 +18,23 @@ import { type ServerJsonApiQuery } from "../types";
  *   `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`,
  * );
  *
- * const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
+ * const query: ServerJsonApiQuery = parseQuery(searchParams.toString());
  *
  * deepEqual(query, {
  *   fields: { user: ["age", "dateOfBirth"] },
  *   filter: {
- *     age: { eq: ["2"] },
- *     dateOfBirth: { gt: [date1], lt: [date2] },
- *     isActive: { eq: ["true"] },
+ *     age: "2",
+ *     dateOfBirth: { gt: date1, lt: date2 },
+ *     isActive: "true",
  *   },
- *   include: ["article"],
+ *   include: "article",
  *   page: {
  *     size: "10",
  *   },
- *   sort: ["-age"],
+ *   sort: "-age",
  * });
  * ```
  *
  * </embedex>
  */
-export declare function toServerJsonApiQuery(searchParams: URLSearchParams): ServerJsonApiQuery;
+export declare function parseQuery(query: string): ServerJsonApiQuery;

package/src/lib/query/parseQuery.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseQuery = parseQuery;
+const qs_1 = require("qs");
+/**
+ * Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
+ *
+ * @example
+ * <embedex source="packages/json-api/examples/parseQuery.ts">
+ *
+ * ```ts
+ * import { deepEqual } from "node:assert/strict";
+ *
+ * import { parseQuery } from "@clipboard-health/json-api";
+ *
+ * import { type ServerJsonApiQuery } from "../src/lib/types";
+ *
+ * const [date1, date2] = ["2024-01-01", "2024-01-02"];
+ * // The URLSearchParams constructor also supports URL-encoded strings
+ * const searchParams = new URLSearchParams(
+ *   `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`,
+ * );
+ *
+ * const query: ServerJsonApiQuery = parseQuery(searchParams.toString());
+ *
+ * deepEqual(query, {
+ *   fields: { user: ["age", "dateOfBirth"] },
+ *   filter: {
+ *     age: "2",
+ *     dateOfBirth: { gt: date1, lt: date2 },
+ *     isActive: "true",
+ *   },
+ *   include: "article",
+ *   page: {
+ *     size: "10",
+ *   },
+ *   sort: "-age",
+ * });
+ * ```
+ *
+ * </embedex>
+ */
+function parseQuery(query) {
+    return (0, qs_1.parse)(query, {
+        decoder: (item, defaultDecoder, charset, type) => {
+            const decoded = decodeURIComponent(item);
+            if (type === "value") {
+                return decoded.includes(",") ? decoded.split(",") : decoded;
+            }
+            return defaultDecoder(decoded, charset, type);
+        },
+        ignoreQueryPrefix: true,
+    });
+}
+//# sourceMappingURL=parseQuery.js.map

package/src/lib/query/parseQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseQuery.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/parseQuery.ts"],"names":[],"mappings":";;AA0CA,gCAYC;AAtDD,2BAA2B;AAI3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,OAAO,IAAA,UAAK,EAAC,KAAK,EAAE;QAClB,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;YAC/C,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAC9D,CAAC;YAED,OAAO,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;QACD,iBAAiB,EAAE,IAAI;KACxB,CAAuB,CAAC;AAC3B,CAAC"}

package/src/lib/query/{toClientSearchParams.d.ts → stringifyQuery.d.ts}

@@ -1,14 +1,15 @@
 import { type ClientJsonApiQuery } from "../types";
 /**
- * Call this function from clients to convert from {@link ClientJsonApiQuery} to {@link URLSearchParams}.
+ * Converts from an ergonomic query format to URLSearchParams, providing a more user-friendly API
+ * than {@link toClientSearchParams} while maintaining JSON:API compliance.
  *
  * @example
- * <embedex source="packages/json-api/examples/toClientSearchParams.ts">
+ * <embedex source="packages/json-api/examples/stringifyQuery.ts">
  *
  * ```ts
  * import { deepEqual } from "node:assert/strict";
  *
- * import { toClientSearchParams } from "@clipboard-health/json-api";
+ * import { stringifyQuery } from "@clipboard-health/json-api";
  *
  * import { type ClientJsonApiQuery } from "../src/lib/types";
  *
@@ -16,19 +17,22 @@ import { type ClientJsonApiQuery } from "../types";
  * const query: ClientJsonApiQuery = {
  *   fields: { user: ["age", "dateOfBirth"] },
  *   filter: {
- *     age: { eq: ["2"] },
- *     dateOfBirth: { gt: [date1], lt: [date2] },
- *     isActive: { eq: ["true"] },
+ *     age: 2,
+ *     dateOfBirth: {
+ *       gt: date1,
+ *       lt: date2,
+ *     },
+ *     isActive: true,
  *   },
- *   include: ["article"],
+ *   include: "article",
  *   page: {
- *     size: "10",
+ *     size: 10,
  *   },
- *   sort: ["-age"],
+ *   sort: "-age",
  * };
  *
  * deepEqual(
- *   toClientSearchParams(query).toString(),
+ *   stringifyQuery(query),
  *   new URLSearchParams(
  *     `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`,
  *   ).toString(),
@@ -37,4 +41,6 @@ import { type ClientJsonApiQuery } from "../types";
  *
  * </embedex>
  */
-export declare function toClientSearchParams(query: ClientJsonApiQuery): URLSearchParams;
+export declare function stringifyQuery(query: ClientJsonApiQuery, options?: {
+    encode?: boolean;
+}): string;

package/src/lib/query/stringifyQuery.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyQuery = stringifyQuery;
+const qs_1 = require("qs");
+/**
+ * Converts from an ergonomic query format to URLSearchParams, providing a more user-friendly API
+ * than {@link toClientSearchParams} while maintaining JSON:API compliance.
+ *
+ * @example
+ * <embedex source="packages/json-api/examples/stringifyQuery.ts">
+ *
+ * ```ts
+ * import { deepEqual } from "node:assert/strict";
+ *
+ * import { stringifyQuery } from "@clipboard-health/json-api";
+ *
+ * import { type ClientJsonApiQuery } from "../src/lib/types";
+ *
+ * const [date1, date2] = ["2024-01-01", "2024-01-02"];
+ * const query: ClientJsonApiQuery = {
+ *   fields: { user: ["age", "dateOfBirth"] },
+ *   filter: {
+ *     age: 2,
+ *     dateOfBirth: {
+ *       gt: date1,
+ *       lt: date2,
+ *     },
+ *     isActive: true,
+ *   },
+ *   include: "article",
+ *   page: {
+ *     size: 10,
+ *   },
+ *   sort: "-age",
+ * };
+ *
+ * deepEqual(
+ *   stringifyQuery(query),
+ *   new URLSearchParams(
+ *     `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`,
+ *   ).toString(),
+ * );
+ * ```
+ *
+ * </embedex>
+ */
+function stringifyQuery(query, options) {
+    const { encode = true } = options ?? {};
+    return (0, qs_1.stringify)(query, { arrayFormat: "comma", encode });
+}
+//# sourceMappingURL=stringifyQuery.js.map

package/src/lib/query/stringifyQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringifyQuery.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/stringifyQuery.ts"],"names":[],"mappings":";;AA8CA,wCAIC;AAlDD,2BAA+B;AAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,SAAgB,cAAc,CAAC,KAAyB,EAAE,OAA8B;IACtF,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAExC,OAAO,IAAA,cAAS,EAAC,KAAK,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC"}

package/src/lib/types.d.ts

@@ -1,52 +1,86 @@
 /**
- * Filter types to build complex filter queries.
- * - eq: Equal to; the default when no filter type is provided, do not explicitly include it.
+ * Filter operators to build complex filter queries.
+ * - eq: Equal to; the default when no filter operator is provided, do not explicitly include it.
  * - ne: Not equal to.
  * - gt: Greater than.
  * - gte: Greater than or equal to.
  * - lt: Less than.
  * - lte: Less than or equal to.
  */
-type FilterType = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
-type PageKey = "cursor" | "limit" | "number" | "offset" | "size";
+export type FilterOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
+export type PageKey = "cursor" | "limit" | "number" | "offset" | "size";
 export { type URLSearchParams } from "node:url";
-export interface JsonApiQueryTypes {
-    filterValue: unknown;
-    pageValue: unknown;
+export type FilterValue = Date | number | string | boolean;
+export type FilterObject = {
+    [K in FilterOperator]?: FilterValue | FilterValue[];
+};
+export interface NestedFilter {
+    [key: string]: FilterValue | FilterValue[] | FilterObject | NestedFilter | undefined;
 }
-export interface ClientTypes {
-    filterValue: Array<Date | number | string | boolean>;
-    pageValue: number | string;
-}
-export interface ServerTypes {
-    filterValue: string[];
-    pageValue: string;
+/**
+ * A JSON:API URL query.
+ */
+export interface ClientJsonApiQuery {
+    /**
+     * Fields to include in the response.
+     *
+     * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
+     */
+    fields?: Record<string, string | string[]>;
+    /**
+     * Filters to apply to the query.
+     *
+     * @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
+     * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}
+     */
+    filter?: Record<string, FilterValue | FilterValue[] | FilterObject | NestedFilter | undefined>;
+    /**
+     * Relationships to include in the response.
+     *
+     * @see {@link https://jsonapi.org/format/#fetching-includes JSON:API fetching includes}
+     */
+    include?: string | string[];
+    /**
+     * Pagination data.
+     *
+     * @see {@link https://jsonapi.org/format/#fetching-pagination JSON:API pagination}
+     * @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}
+     */
+    page?: {
+        [K in PageKey]?: number | string;
+    };
+    /**
+     * Sorting data. Include the "-" prefix for descending order.
+     *
+     * @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
+     */
+    sort?: string | string[];
 }
 /**
- * A JSON:API URL query string.
+ * A JSON:API URL query.
  */
-export interface JsonApiQuery<T extends JsonApiQueryTypes> {
+export interface ServerJsonApiQuery {
     /**
      * Fields to include in the response.
      *
      * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
      */
-    fields?: Record<string, string[]>;
+    fields?: Record<string, string | string[]>;
     /**
      * Filters to apply to the query.
      *
      * @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
      * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}
      */
-    filter?: Record<string, {
-        [K in FilterType]?: T["filterValue"];
+    filter?: Record<string, string | string[] | {
+        [K in FilterOperator]?: string | string[];
     }>;
     /**
      * Relationships to include in the response.
      *
      * @see {@link https://jsonapi.org/format/#fetching-includes JSON:API fetching includes}
      */
-    include?: string[];
+    include?: string | string[];
     /**
      * Pagination data.
      *
@@ -54,14 +88,12 @@ export interface JsonApiQuery<T extends JsonApiQueryTypes> {
      * @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}
      */
     page?: {
-        [K in PageKey]?: T["pageValue"];
+        [K in PageKey]?: string;
     };
     /**
      * Sorting data. Include the "-" prefix for descending order.
      *
      * @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
      */
-    sort?: string[];
+    sort?: string | string[];
 }
-export type ClientJsonApiQuery = JsonApiQuery<ClientTypes>;
-export type ServerJsonApiQuery = JsonApiQuery<ServerTypes>;

package/src/lib/query/toClientSearchParams.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toClientSearchParams = toClientSearchParams;
-function filterValueString(value) {
-    return value instanceof Date ? value.toISOString() : String(value);
-}
-function join(values) {
-    return values.join(",");
-}
-/**
- * Call this function from clients to convert from {@link ClientJsonApiQuery} to {@link URLSearchParams}.
- *
- * @example
- * <embedex source="packages/json-api/examples/toClientSearchParams.ts">
- *
- * ```ts
- * import { deepEqual } from "node:assert/strict";
- *
- * import { toClientSearchParams } from "@clipboard-health/json-api";
- *
- * import { type ClientJsonApiQuery } from "../src/lib/types";
- *
- * const [date1, date2] = ["2024-01-01", "2024-01-02"];
- * const query: ClientJsonApiQuery = {
- *   fields: { user: ["age", "dateOfBirth"] },
- *   filter: {
- *     age: { eq: ["2"] },
- *     dateOfBirth: { gt: [date1], lt: [date2] },
- *     isActive: { eq: ["true"] },
- *   },
- *   include: ["article"],
- *   page: {
- *     size: "10",
- *   },
- *   sort: ["-age"],
- * };
- *
- * deepEqual(
- *   toClientSearchParams(query).toString(),
- *   new URLSearchParams(
- *     `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`,
- *   ).toString(),
- * );
- * ```
- *
- * </embedex>
- */
-function toClientSearchParams(query) {
-    const searchParams = new URLSearchParams();
-    if (query.fields) {
-        Object.entries(query.fields).forEach(([type, fields]) => {
-            searchParams.append(`fields[${type}]`, join(fields));
-        });
-    }
-    if (query.filter) {
-        Object.entries(query.filter).forEach(([field, values]) => {
-            const filterField = `filter[${field}]`;
-            Object.entries(values).forEach(([fieldType, value]) => {
-                searchParams.append(fieldType === "eq" ? filterField : `${filterField}[${fieldType}]`, join(value.map((value) => filterValueString(value))));
-            });
-        });
-    }
-    if (query.include) {
-        searchParams.append("include", join(query.include));
-    }
-    if (query.page) {
-        Object.entries(query.page).forEach(([key, value]) => {
-            searchParams.append(`page[${key}]`, String(value));
-        });
-    }
-    if (query.sort) {
-        searchParams.append("sort", join(query.sort));
-    }
-    return searchParams;
-}
-//# sourceMappingURL=toClientSearchParams.js.map

package/src/lib/query/toClientSearchParams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toClientSearchParams.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toClientSearchParams.ts"],"names":[],"mappings":";;AAgDA,oDAoCC;AAlFD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;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"}

package/src/lib/query/toServerJsonApiQuery.js

@@ -1,93 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toServerJsonApiQuery = toServerJsonApiQuery;
-const REGEX = {
-    fields: /^fields\[(.*?)]$/i,
-    filter: /^filter\[([^\]]*?)]$/i,
-    filterType: /^filter\[(.*?)]\[(.*?)]$/i,
-    include: /^include$/i,
-    page: /^page\[(.*?)]$/i,
-    sort: /^sort$/i,
-};
-/**
- * Call this function from servers to convert from {@link URLSearchParams} to {@link ServerJsonApiQuery}.
- *
- * @example
- * <embedex source="packages/json-api/examples/toServerJsonApiQuery.ts">
- *
- * ```ts
- * import { deepEqual } from "node:assert/strict";
- *
- * import { type ServerJsonApiQuery, toServerJsonApiQuery } from "@clipboard-health/json-api";
- *
- * const [date1, date2] = ["2024-01-01", "2024-01-02"];
- * // The URLSearchParams constructor also supports URL-encoded strings
- * const searchParams = new URLSearchParams(
- *   `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`,
- * );
- *
- * const query: ServerJsonApiQuery = toServerJsonApiQuery(searchParams);
- *
- * deepEqual(query, {
- *   fields: { user: ["age", "dateOfBirth"] },
- *   filter: {
- *     age: { eq: ["2"] },
- *     dateOfBirth: { gt: [date1], lt: [date2] },
- *     isActive: { eq: ["true"] },
- *   },
- *   include: ["article"],
- *   page: {
- *     size: "10",
- *   },
- *   sort: ["-age"],
- * });
- * ```
- *
- * </embedex>
- */
-function toServerJsonApiQuery(searchParams) {
-    return [...searchParams].reduce((accumulator, [key, value]) => {
-        const match = Object.entries(REGEX).find(([, regex]) => regex.test(key));
-        if (!match) {
-            return accumulator;
-        }
-        const [type, regex] = match;
-        const groups = regex.exec(key)?.slice(1);
-        if (type === "fields" && groups?.[0]) {
-            return {
-                ...accumulator,
-                fields: {
-                    ...accumulator.fields,
-                    [groups[0]]: value.split(","),
-                },
-            };
-        }
-        if ((type === "filter" || type === "filterType") && groups?.length) {
-            const [field, fieldType] = groups;
-            if (field) {
-                return {
-                    ...accumulator,
-                    filter: {
-                        ...accumulator.filter,
-                        [field]: {
-                            ...accumulator.filter?.[field],
-                            [fieldType ?? "eq"]: value.split(","),
-                        },
-                    },
-                };
-            }
-        }
-        if (type === "include" || type === "sort") {
-            return { ...accumulator, [type]: value.split(",") };
-        }
-        if (type === "page" && groups?.[0]) {
-            return {
-                ...accumulator,
-                page: { ...accumulator.page, [groups[0]]: value },
-            };
-        }
-        /* istanbul ignore next */
-        return accumulator;
-    }, {});
-}
-//# sourceMappingURL=toServerJsonApiQuery.js.map

package/src/lib/query/toServerJsonApiQuery.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"toServerJsonApiQuery.js","sourceRoot":"","sources":["../../../../../../packages/json-api/src/lib/query/toServerJsonApiQuery.ts"],"names":[],"mappings":";;AA+CA,oDAiDC;AA9FD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;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"}