@clipboard-health/json-api 0.32.1 → 1.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/json-api",
   "description": "TypeScript-friendly utilities for adhering to the JSON:API specification.",
-  "version": "0.32.1",
+  "version": "1.0.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "dependencies": {
     "tslib": "2.8.1"

package/src/index.d.ts

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

package/src/index.js

@@ -3,5 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 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,iEAAuC;AACvC,qEAA2C;AAC3C,sDAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/json-api/src/index.ts"],"names":[],"mappings":";;;AAAA,iEAAuC;AACvC,qEAA2C"}

package/src/lib/types.d.ts

@@ -11,9 +11,7 @@ export type FilterOperator = "eq" | "ne" | "gt" | "gte" | "lt" | "lte";
 export type PageKey = "cursor" | "limit" | "number" | "offset" | "size";
 export { type URLSearchParams } from "node:url";
 export type FilterValue = Date | number | string | boolean;
-export type FilterObject = {
-    [K in FilterOperator]?: FilterValue | FilterValue[];
-};
+export type FilterObject = Partial<Record<FilterOperator, FilterValue | FilterValue[]>>;
 export interface NestedFilter {
     [key: string]: FilterValue | FilterValue[] | FilterObject | NestedFilter | undefined;
 }
@@ -46,9 +44,7 @@ export interface ClientJsonApiQuery {
      * @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;
-    };
+    page?: Partial<Record<PageKey, number | string>>;
     /**
      * Sorting data. Include the "-" prefix for descending order.
      *
@@ -72,9 +68,7 @@ export interface ServerJsonApiQuery {
      * @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, string | string[] | {
-        [K in FilterOperator]?: string | string[];
-    }>;
+    filter?: Record<string, string | string[] | Partial<Record<FilterOperator, string | string[]>>>;
     /**
      * Relationships to include in the response.
      *
@@ -87,9 +81,7 @@ export interface ServerJsonApiQuery {
      * @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]?: string;
-    };
+    page?: Partial<Record<PageKey, string>>;
     /**
      * Sorting data. Include the "-" prefix for descending order.
      *