@warp-drive-mirror/json-api 5.10.0-alpha.10 → 5.10.0-alpha.12

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.
Files changed (2) hide show
  1. package/README.md +81 -7
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -8,13 +8,11 @@
8
8
  />
9
9
  </p>
10
10
 
11
- ![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=fdb155)
12
- ![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=fdb155)
11
+ ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive%2Fjson-api/latest?label=version&style=flat&color=fdb155)
12
+ ![NPM Downloads](https://img.shields.io/npm/dm/%40warp-drive%2Fjson-api.svg?style=flat&color=fdb155)
13
13
  ![License](https://img.shields.io/github/license/warp-drive-data/warp-drive.svg?style=flat&color=fdb155)
14
- [![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS
15
- )
16
- [![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S
17
- )
14
+ [![EmberJS Discord Community Server](https://img.shields.io/badge/EmberJS-grey?logo=discord&logoColor=fdb155)](https://discord.gg/zT3asNS)
15
+ [![WarpDrive Discord Server](https://img.shields.io/badge/WarpDrive-grey?logo=discord&logoColor=fdb155)](https://discord.gg/PHBbnWJx5S)
18
16
 
19
17
  # @warp-drive-mirror/json-api
20
18
 
@@ -24,11 +22,27 @@ A [{json:api}](https://jsonapi.org) Cache Implementation for ***Warp*Drive**.
24
22
 
25
23
  Because most API responses can be quickly transformed into the `{json:api}` format without losing any information, ***Warp*Drive** recommends that most-if-not-all apps should use this Cache implementation.
26
24
 
25
+ ## Usage
26
+
27
+ Hand the cache to your Store:
28
+
29
+ ```ts
30
+ import { useRecommendedStore } from '@warp-drive-mirror/core';
31
+ import { JSONAPICache } from '@warp-drive-mirror/json-api';
32
+
33
+ export const AppStore = useRecommendedStore({
34
+ cache: JSONAPICache,
35
+ schemas: [
36
+ // ... your schemas here
37
+ ],
38
+ });
39
+ ```
40
+
27
41
  <br>
28
42
 
29
43
  ## Documentation
30
44
 
31
- *Get Started* → [Guides](https://warp-drive.io)
45
+ *Get Started* → [Guides](https://warp-drive.io/guides/)
32
46
 
33
47
 
34
48
  <br>
@@ -42,3 +56,63 @@ Refer to the [Code of Conduct](https://github.com/warp-drive-data/warp-drive/blo
42
56
  ### License
43
57
 
44
58
  This project is licensed under the [MIT License](LICENSE.md).
59
+
60
+ ### ♥️ Credits
61
+
62
+ <details>
63
+ <summary>Brought to you with ♥️ love by <a href="https://emberjs.com" title="EmberJS">🐹 Ember</a></summary>
64
+
65
+ <style type="text/css">
66
+ img.project-logo {
67
+ padding: 0 5em 1em 5em;
68
+ width: 100px;
69
+ border-bottom: 2px solid #bbb;
70
+ margin: 0 auto;
71
+ display: block;
72
+ }
73
+ details > summary {
74
+ font-size: 1.1rem;
75
+ line-height: 1rem;
76
+ margin-bottom: 1rem;
77
+ }
78
+ details {
79
+ font-size: 1rem;
80
+ }
81
+ details > summary strong {
82
+ display: inline-block;
83
+ padding: .2rem 0;
84
+ color: #000;
85
+ border-bottom: 3px solid #bbb;
86
+ }
87
+
88
+ details > details {
89
+ margin-left: 2rem;
90
+ }
91
+ details > details > summary {
92
+ font-size: 1rem;
93
+ line-height: 1rem;
94
+ margin-bottom: 1rem;
95
+ }
96
+ details > details > summary strong {
97
+ display: inline-block;
98
+ padding: .2rem 0;
99
+ color: #555;
100
+ border-bottom: 2px solid #555;
101
+ }
102
+ details > details {
103
+ font-size: .85rem;
104
+ }
105
+
106
+ @media (prefers-color-scheme: dark) {
107
+ details > summary strong {
108
+ color: #fff;
109
+ }
110
+ }
111
+ @media (prefers-color-scheme: dark) {
112
+ details > details > summary strong {
113
+ color: #afaba0;
114
+ border-bottom: 2px solid #afaba0;
115
+ }
116
+ }
117
+ </style>
118
+ </details>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@warp-drive-mirror/json-api",
3
- "version": "5.10.0-alpha.10",
3
+ "version": "5.10.0-alpha.12",
4
4
  "description": "A {json:api} Cache Implementation for WarpDrive",
5
5
  "keywords": [
6
6
  "ember-addon"
@@ -39,7 +39,7 @@
39
39
  }
40
40
  },
41
41
  "peerDependencies": {
42
- "@warp-drive-mirror/core": "5.10.0-alpha.10"
42
+ "@warp-drive-mirror/core": "5.10.0-alpha.12"
43
43
  },
44
44
  "dependencies": {
45
45
  "@embroider/macros": "^1.21.1",
@@ -51,12 +51,12 @@
51
51
  "@babel/plugin-transform-typescript": "^7.29.9",
52
52
  "@babel/preset-typescript": "^7.29.7",
53
53
  "@types/json-to-ast": "^2.1.4",
54
- "@warp-drive-mirror/core": "5.10.0-alpha.10",
55
- "@warp-drive/internal-config": "5.10.0-alpha.10",
54
+ "@warp-drive-mirror/core": "5.10.0-alpha.12",
55
+ "@warp-drive/internal-config": "5.10.0-alpha.12",
56
56
  "decorator-transforms": "^2.4.0",
57
57
  "expect-type": "^1.4.0",
58
58
  "tsdown": "^0.23.0",
59
- "typescript-7": "npm:typescript@7.1.0-dev.20260920.1"
59
+ "typescript-7": "npm:typescript@7.1.0-dev.20260922.1"
60
60
  },
61
61
  "ember-addon": {
62
62
  "main": "addon-main.cjs",