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

Comparing version 0.14.0 to 0.15.0

package.json

 {
   "name": "@clipboard-health/json-api-nestjs",
   "description": "TypeScript-friendly utilities for adhering to the JSON:API specification with NestJS.",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
@@ -13,3 +13,3 @@ "dependencies": {
   "devDependencies": {
-    "@clipboard-health/testing-core": "0.10.0"
+    "@clipboard-health/testing-core": "0.11.0"
   },
@@ -16,0 +16,0 @@ "keywords": [

README.md

@@ -24,5 +24,5 @@ # @clipboard-health/json-api-nestjs <!-- omit from toc -->
 
-<!-- prettier-ignore -->
+<embedex source="packages/example-nestjs/examples/query.ts">
+
 ```ts
-// packages/example-nestjs/examples/query.ts
 import { booleanString } from "@clipboard-health/contract-core";
@@ -83,7 +83,8 @@ import {
   .strict();
-
 ```
 
+</embedex>
+
 ## Local development commands
 
 See [`package.json`](./package.json) `scripts` for a list of commands.

src/lib/query/cursorPaginationQuery.d.ts

@@ -12,4 +12,5 @@ import { z } from "zod";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -70,5 +71,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-pagination JSON:API pagination}
@@ -75,0 +77,0 @@ * @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}

src/lib/query/cursorPaginationQuery.js

@@ -17,4 +17,5 @@ "use strict";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -75,5 +76,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-pagination JSON:API pagination}
@@ -80,0 +82,0 @@ * @see {@link https://jsonapi.org/examples/#pagination JSON:API pagination examples}

src/lib/query/fieldsQuery.d.ts

@@ -17,4 +17,5 @@ import { z } from "zod";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -75,5 +76,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
@@ -80,0 +82,0 @@ */

src/lib/query/fieldsQuery.js

@@ -10,4 +10,5 @@ "use strict";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -68,5 +69,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-sparse-fieldsets JSON:API sparse fieldsets}
@@ -73,0 +75,0 @@ */

src/lib/query/filterQuery.d.ts

@@ -20,4 +20,5 @@ import { z } from "zod";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -78,5 +79,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
@@ -83,0 +85,0 @@ * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}

src/lib/query/filterQuery.js

@@ -11,4 +11,5 @@ "use strict";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -69,5 +70,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/recommendations/#filtering JSON:API filtering}
@@ -74,0 +76,0 @@ * @see {@link https://discuss.jsonapi.org/t/share-propose-a-filtering-strategy/257 JSON:API filtering strategy}

src/lib/query/includeQuery.d.ts

@@ -27,4 +27,5 @@ import { type GreaterThan, type Subtract } from "type-fest";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -85,5 +86,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-includes JSON:API includes}
@@ -90,0 +92,0 @@ */

src/lib/query/includeQuery.js

@@ -10,4 +10,5 @@ "use strict";
  * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -68,5 +69,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-includes JSON:API includes}
@@ -73,0 +75,0 @@ */

src/lib/query/sortQuery.d.ts

@@ -6,5 +6,5 @@ import { z } from "zod";
  *
- * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -65,5 +65,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
@@ -70,0 +71,0 @@ */

src/lib/query/sortQuery.js

@@ -9,5 +9,5 @@ "use strict";
  *
- * @example
+ * <embedex source="packages/example-nestjs/examples/query.ts">
+ *
  * ```ts
- * // packages/example-nestjs/examples/query.ts
  * import { booleanString } from "@clipboard-health/contract-core";
@@ -68,5 +68,6 @@ * import {
  *   .strict();
- *
  * ```
  *
+ * </embedex>
+ *
  * @see {@link https://jsonapi.org/format/#fetching-sorting JSON:API sorting}
@@ -73,0 +74,0 @@ */

No alert changes

Improved metrics

Total package byte prevSize

45719

increased by0.7%

Lines of code

1008

increased by1.82%

Number of lines in readme file

89

increased by1.14%

No dependency changes