@clipboard-health/json-api - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "@clipboard-health/json-api",
   "description": "Utilities for adhering to the JSON:API specification.",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "bugs": "https://github.com/clipboardhealth/core-utils/issues",
@@ -6,0 +6,0 @@ "dependencies": {

README.md

@@ -36,9 +36,9 @@ # @clipboard-health/json-api
 const query: ClientJsonApiQuery = {
-  fields: { dog: ["name", "age"] },
+  fields: { user: ["age", "name"] },
   filter: {
     age: { eq: ["2"] },
-    createdAt: { gt: [date1], lt: [date2] },
-    isGoodDog: { eq: ["true"] },
+    dateOfBirth: { gt: [date1], lt: [date2] },
+    isActive: { eq: ["true"] },
   },
-  include: ["owner"],
+  include: ["article"],
   page: {
@@ -53,3 +53,3 @@ size: "10",
   new URLSearchParams(
-    `fields[dog]=name,age&filter[age]=2&filter[createdAt][gt]=${date1}&filter[createdAt][lt]=${date2}&filter[isGoodDog]=true&include=owner&page[size]=10&sort=-age`,
+    `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`,
   ).toString(),
@@ -73,3 +73,3 @@ );
 const searchParams = new URLSearchParams(
-  `fields[dog]=name,age&filter[age]=2&filter[createdAt][gt]=${date1}&filter[createdAt][lt]=${date2}&filter[isGoodDog]=true&include=owner&page[size]=10&sort=-age`,
+  `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`,
 );
@@ -80,9 +80,9 @@
 deepEqual(query, {
-  fields: { dog: ["name", "age"] },
+  fields: { user: ["age", "name"] },
   filter: {
     age: { eq: ["2"] },
-    createdAt: { gt: [date1], lt: [date2] },
-    isGoodDog: { eq: ["true"] },
+    dateOfBirth: { gt: [date1], lt: [date2] },
+    isActive: { eq: ["true"] },
   },
-  include: ["owner"],
+  include: ["article"],
   page: {
@@ -89,0 +89,0 @@ size: "10",

src/lib/query/toClientSearchParams.d.ts

@@ -5,4 +5,6 @@ import { type ClientJsonApiQuery } from "../types";
  *
- * @see [Example](https://github.com/ClipboardHealth/core-utils/blob/main/packages/json-api/examples/toSearchParams.ts)
+ * @includeExample ./packages/json-api/examples/toClientSearchParams.ts
+ *
+ * @see [Usage example](../../../examples/toClientSearchParams.ts)
  */
 export declare function toClientSearchParams(query: ClientJsonApiQuery): URLSearchParams;

src/lib/query/toClientSearchParams.js

@@ -13,3 +13,5 @@ "use strict";
  *
- * @see [Example](https://github.com/ClipboardHealth/core-utils/blob/main/packages/json-api/examples/toSearchParams.ts)
+ * @includeExample ./packages/json-api/examples/toClientSearchParams.ts
+ *
+ * @see [Usage example](../../../examples/toClientSearchParams.ts)
  */
@@ -16,0 +18,0 @@ function toClientSearchParams(query) {

src/lib/query/toServerJsonApiQuery.d.ts

@@ -5,4 +5,6 @@ import { type ServerJsonApiQuery } from "../types";
  *
- * @see [Example](https://github.com/ClipboardHealth/core-utils/blob/main/packages/json-api/examples/toJsonApiQuery.ts)
+ * @includeExample packages/json-api/examples/toServerJsonApiQuery.ts
+ *
+ * @see [Usage example](../../../examples/toServerJsonApiQuery.ts)
  */
 export declare function toServerJsonApiQuery(searchParams: URLSearchParams): ServerJsonApiQuery;

src/lib/query/toServerJsonApiQuery.js

@@ -15,3 +15,5 @@ "use strict";
  *
- * @see [Example](https://github.com/ClipboardHealth/core-utils/blob/main/packages/json-api/examples/toJsonApiQuery.ts)
+ * @includeExample packages/json-api/examples/toServerJsonApiQuery.ts
+ *
+ * @see [Usage example](../../../examples/toServerJsonApiQuery.ts)
  */
@@ -18,0 +20,0 @@ function toServerJsonApiQuery(searchParams) {

src/lib/types.d.ts

@@ -9,7 +9,7 @@ /**
  * - lte: Less than or equal to.
- * - not: Not.
  */
-type FilterType = "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "not";
+type FilterType = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
 type PageKey = "cursor" | "limit" | "number" | "offset" | "size";
-interface JsonApiQueryTypes {
+export { type URLSearchParams } from "node:url";
+export interface JsonApiQueryTypes {
     filterValue: unknown;
@@ -22,3 +22,3 @@ pageValue: unknown;
 }
-interface ServerTypes {
+export interface ServerTypes {
     filterValue: string[];
@@ -30,7 +30,7 @@ pageValue: string;
  */
-interface JsonApiQuery<T extends JsonApiQueryTypes> {
+export interface JsonApiQuery<T extends JsonApiQueryTypes> {
     /**
      * Fields to include in the response.
      *
-     * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets Sparse fieldsets}
+     * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
      */
@@ -41,4 +41,4 @@ fields?: Record<string, string[]>;
      *
-     * @see {@link https://jsonapi.org/recommendations/#filtering Filtering}
-     * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 Filtering strategy}
+     * @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}
      */
@@ -51,3 +51,3 @@ filter?: Record<string, {
      *
-     * @see {@link https://jsonapi.org/format/#fetching-includes Fetching includes}
+     * @see {@link https://jsonapi.org/format/#fetching-includes JSON:API fetching includes}
      */
@@ -58,4 +58,4 @@ include?: string[];
      *
-     * @see {@link https://jsonapi.org/format/#fetching-pagination Pagination}
-     * @see {@link https://jsonapi.org/examples/#pagination Pagination examples}
+     * @see {@link https://jsonapi.org/format/#fetching-pagination JSON:API pagination}
+     * @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}
      */
@@ -68,3 +68,3 @@ page?: {
      *
-     * @see {@link https://jsonapi.org/format/#fetching-sorting Sorting}
+     * @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
      */
@@ -75,2 +75,1 @@ sort?: string[];
 export type ServerJsonApiQuery = JsonApiQuery<ServerTypes>;
-export {};

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14484

increased by1.46%

Lines of code

203

increased by3.57%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes