Skip to content

Commit 462af88

Browse files
chore(release): 2.2.0 [skip ci]
## [2.2.0](v2.1.0...v2.2.0) (2022-09-23) ### Features * links deserialization ([fc0b05d](fc0b05d))
1 parent fc0b05d commit 462af88

File tree

8 files changed

+86
-57
lines changed

8 files changed

+86
-57
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## [2.2.0](https://github.com/andersondanilo/jsonapi-fractal/compare/v2.1.0...v2.2.0) (2022-09-23)
2+
3+
4+
### Features
5+
6+
* links deserialization ([fc0b05d](https://github.com/andersondanilo/jsonapi-fractal/commit/fc0b05de2905a6d62d3c25fd13a1633c5d4eecab))
7+
18
## [2.1.0](https://github.com/andersondanilo/jsonapi-fractal/compare/v2.0.1...v2.1.0) (2022-05-01)
29

310

docs/README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,18 @@ jsonapi-fractal
1515
- [JsonApiFractalError](classes/JsonApiFractalError.md)
1616
- [Transformer](classes/Transformer.md)
1717

18-
### JSON Type aliases
18+
### JSON Type Aliases
1919

2020
- [JsonObject](README.md#jsonobject)
2121

22-
### Other Type aliases
22+
### Other Type Aliases
2323

2424
- [AttributesObject](README.md#attributesobject)
2525
- [Context](README.md#context)
2626
- [DocumentObject](README.md#documentobject)
2727
- [ExistingDocumentObject](README.md#existingdocumentobject)
2828
- [ExistingResourceObject](README.md#existingresourceobject)
29+
- [LinkObject](README.md#linkobject)
2930
- [MetaObject](README.md#metaobject)
3031
- [NewDocumentObject](README.md#newdocumentobject)
3132
- [NewResourceObject](README.md#newresourceobject)
@@ -45,7 +46,7 @@ jsonapi-fractal
4546
- [transform](README.md#transform)
4647
- [whitelist](README.md#whitelist)
4748

48-
## JSON Type aliases
49+
## JSON Type Aliases
4950

5051
### JsonObject
5152

@@ -61,15 +62,15 @@ node_modules/type-fest/source/basic.d.ts:22
6162

6263
___
6364

64-
## Other Type aliases
65+
## Other Type Aliases
6566

6667
### AttributesObject
6768

6869
Ƭ **AttributesObject**: [`JsonObject`](README.md#jsonobject)
6970

7071
#### Defined in
7172

72-
[src/types.ts:17](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L17)
73+
[src/types.ts:17](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L17)
7374

7475
___
7576

@@ -95,7 +96,7 @@ ___
9596

9697
#### Defined in
9798

98-
[src/context.ts:5](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L5)
99+
[src/context.ts:5](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L5)
99100

100101
___
101102

@@ -105,7 +106,7 @@ ___
105106

106107
#### Defined in
107108

108-
[src/types.ts:15](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L15)
109+
[src/types.ts:15](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L15)
109110

110111
___
111112

@@ -115,17 +116,27 @@ ___
115116

116117
#### Defined in
117118

118-
[src/types.ts:11](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L11)
119+
[src/types.ts:11](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L11)
119120

120121
___
121122

122123
### ExistingResourceObject
123124

124-
Ƭ **ExistingResourceObject**: [`ResourceIdentifierObject`](README.md#resourceidentifierobject) & { `attributes`: [`AttributesObject`](README.md#attributesobject) ; `id`: `string` ; `relationships?`: `Record`<`string`, [`RelationshipObject`](README.md#relationshipobject)\> }
125+
Ƭ **ExistingResourceObject**: [`ResourceIdentifierObject`](README.md#resourceidentifierobject) & { `attributes`: [`AttributesObject`](README.md#attributesobject) ; `id`: `string` ; `links?`: [`LinkObject`](README.md#linkobject) ; `relationships?`: `Record`<`string`, [`RelationshipObject`](README.md#relationshipobject)\> }
125126

126127
#### Defined in
127128

128-
[src/types.ts:26](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L26)
129+
[src/types.ts:28](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L28)
130+
131+
___
132+
133+
### LinkObject
134+
135+
Ƭ **LinkObject**: [`JsonObject`](README.md#jsonobject)
136+
137+
#### Defined in
138+
139+
[src/types.ts:21](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L21)
129140

130141
___
131142

@@ -135,7 +146,7 @@ ___
135146

136147
#### Defined in
137148

138-
[src/types.ts:19](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L19)
149+
[src/types.ts:19](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L19)
139150

140151
___
141152

@@ -145,7 +156,7 @@ ___
145156

146157
#### Defined in
147158

148-
[src/types.ts:13](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L13)
159+
[src/types.ts:13](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L13)
149160

150161
___
151162

@@ -155,7 +166,7 @@ ___
155166

156167
#### Defined in
157168

158-
[src/types.ts:32](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L32)
169+
[src/types.ts:35](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L35)
159170

160171
___
161172

@@ -181,7 +192,7 @@ ___
181192

182193
#### Defined in
183194

184-
[src/types.ts:46](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L46)
195+
[src/types.ts:50](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L50)
185196

186197
___
187198

@@ -194,10 +205,11 @@ ___
194205
| Name | Type |
195206
| :------ | :------ |
196207
| `data` | [`ResourceIdentifierObject`](README.md#resourceidentifierobject) \| [`ResourceIdentifierObject`](README.md#resourceidentifierobject)[] |
208+
| `links?` | [`LinkObject`](README.md#linkobject) |
197209

198210
#### Defined in
199211

200-
[src/types.ts:36](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L36)
212+
[src/types.ts:39](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L39)
201213

202214
___
203215

@@ -222,7 +234,7 @@ ___
222234

223235
#### Defined in
224236

225-
[src/transformer.ts:24](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/transformer.ts#L24)
237+
[src/transformer.ts:24](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/transformer.ts#L24)
226238

227239
___
228240

@@ -254,7 +266,7 @@ ___
254266

255267
#### Defined in
256268

257-
[src/transformer.ts:19](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/transformer.ts#L19)
269+
[src/transformer.ts:19](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/transformer.ts#L19)
258270

259271
___
260272

@@ -271,7 +283,7 @@ ___
271283

272284
#### Defined in
273285

274-
[src/types.ts:21](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L21)
286+
[src/types.ts:23](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L23)
275287

276288
___
277289

@@ -281,7 +293,7 @@ ___
281293

282294
#### Defined in
283295

284-
[src/types.ts:34](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L34)
296+
[src/types.ts:37](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L37)
285297

286298
___
287299

@@ -297,7 +309,7 @@ ___
297309

298310
#### Defined in
299311

300-
[src/types.ts:59](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L59)
312+
[src/types.ts:63](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L63)
301313

302314
___
303315

@@ -314,7 +326,7 @@ ___
314326

315327
#### Defined in
316328

317-
[src/transformer.ts:14](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/transformer.ts#L14)
329+
[src/transformer.ts:14](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/transformer.ts#L14)
318330

319331
## Functions
320332

@@ -344,7 +356,7 @@ Deserialize a JSON:API response
344356

345357
#### Defined in
346358

347-
[src/deserializer.ts:12](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/deserializer.ts#L12)
359+
[src/deserializer.ts:12](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/deserializer.ts#L12)
348360

349361
___
350362

@@ -375,7 +387,7 @@ Serialize the entity
375387

376388
#### Defined in
377389

378-
[src/serializer.ts:32](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/serializer.ts#L32)
390+
[src/serializer.ts:32](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/serializer.ts#L32)
379391

380392
___
381393

@@ -398,7 +410,7 @@ Create a ContextBuilder, used to configure the transformation
398410

399411
#### Defined in
400412

401-
[src/serializer.ts:21](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/serializer.ts#L21)
413+
[src/serializer.ts:21](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/serializer.ts#L21)
402414

403415
___
404416

@@ -421,4 +433,4 @@ Keep only a set of fields on a given object
421433

422434
#### Defined in
423435

424-
[src/utils.ts:55](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/utils.ts#L55)
436+
[src/utils.ts:55](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/utils.ts#L55)

docs/classes/ContextBuilder.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353

5454
#### Defined in
5555

56-
[src/context.ts:18](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L18)
56+
[src/context.ts:18](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L18)
5757

5858
## Properties
5959

@@ -63,7 +63,7 @@
6363

6464
#### Defined in
6565

66-
[src/context.ts:15](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L15)
66+
[src/context.ts:15](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L15)
6767

6868
___
6969

@@ -73,7 +73,7 @@ ___
7373

7474
#### Defined in
7575

76-
[src/context.ts:13](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L13)
76+
[src/context.ts:13](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L13)
7777

7878
___
7979

@@ -83,7 +83,7 @@ ___
8383

8484
#### Defined in
8585

86-
[src/context.ts:16](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L16)
86+
[src/context.ts:16](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L16)
8787

8888
___
8989

@@ -105,6 +105,10 @@ ___
105105

106106
[`DocumentObject`](../README.md#documentobject)
107107

108+
#### Defined in
109+
110+
[src/context.ts:18](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L18)
111+
108112
___
109113

110114
### transformer
@@ -113,7 +117,7 @@ ___
113117

114118
#### Defined in
115119

116-
[src/context.ts:14](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L14)
120+
[src/context.ts:14](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L14)
117121

118122
## Methods
119123

@@ -127,7 +131,7 @@ ___
127131

128132
#### Defined in
129133

130-
[src/context.ts:60](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L60)
134+
[src/context.ts:60](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L60)
131135

132136
___
133137

@@ -141,7 +145,7 @@ ___
141145

142146
#### Defined in
143147

144-
[src/context.ts:43](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L43)
148+
[src/context.ts:43](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L43)
145149

146150
___
147151

@@ -161,7 +165,7 @@ ___
161165

162166
#### Defined in
163167

164-
[src/context.ts:31](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L31)
168+
[src/context.ts:31](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L31)
165169

166170
___
167171

@@ -181,7 +185,7 @@ ___
181185

182186
#### Defined in
183187

184-
[src/context.ts:20](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L20)
188+
[src/context.ts:20](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L20)
185189

186190
___
187191

@@ -201,7 +205,7 @@ ___
201205

202206
#### Defined in
203207

204-
[src/context.ts:37](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L37)
208+
[src/context.ts:37](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L37)
205209

206210
___
207211

@@ -221,4 +225,4 @@ ___
221225

222226
#### Defined in
223227

224-
[src/context.ts:25](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/context.ts#L25)
228+
[src/context.ts:25](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/context.ts#L25)

docs/classes/DefaultTransformer.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
#### Defined in
5858

59-
[src/default-transformer.ts:8](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/default-transformer.ts#L8)
59+
[src/default-transformer.ts:8](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/default-transformer.ts#L8)
6060

6161
## Properties
6262

@@ -70,7 +70,7 @@
7070

7171
#### Defined in
7272

73-
[src/default-transformer.ts:6](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/default-transformer.ts#L6)
73+
[src/default-transformer.ts:6](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/default-transformer.ts#L6)
7474

7575
___
7676

@@ -82,6 +82,10 @@ ___
8282

8383
[Transformer](Transformer.md).[type](Transformer.md#type)
8484

85+
#### Defined in
86+
87+
[src/default-transformer.ts:8](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/default-transformer.ts#L8)
88+
8589
## Methods
8690

8791
### transform
@@ -104,4 +108,4 @@ ___
104108

105109
#### Defined in
106110

107-
[src/default-transformer.ts:23](https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/default-transformer.ts#L23)
111+
[src/default-transformer.ts:23](https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/default-transformer.ts#L23)

0 commit comments

Comments
 (0)