Skip to content

Commit 1411ccf

Browse files
committed
docs(gitbook): add base structure
1 parent 8b7053f commit 1411ccf

File tree

4 files changed

+342
-0
lines changed

4 files changed

+342
-0
lines changed

.gitbook.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root: ./docs/gitbook/
2+
3+
structure:
4+
readme: README.md
5+
summary: SUMMARY.md
6+
7+
redirects:
8+
changelog: ./CHANGELOG.md
9+
api-reference: ./api/index.md

docs/gitbook/README.md

Whitespace-only changes.

docs/gitbook/SUMMARY.md

Whitespace-only changes.

docs/gitbook/changelog.md

Lines changed: 333 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,333 @@
1+
# [4.16.0](https://github.com/roggervalf/iam-policies/compare/v4.15.0...v4.16.0) (2021-11-17)
2+
3+
4+
### Features
5+
6+
* **identity-based-policy:** add whyCannot method ([#71](https://github.com/roggervalf/iam-policies/issues/71)) ([47f21f1](https://github.com/roggervalf/iam-policies/commit/47f21f17c50b76fc3206a36a10778e3eb00c279a))
7+
8+
# [4.15.0](https://github.com/roggervalf/iam-policies/compare/v4.14.0...v4.15.0) (2021-11-09)
9+
10+
11+
### Features
12+
13+
* **identity-based-policy:** add whyCan method ([#68](https://github.com/roggervalf/iam-policies/issues/68)) ([51d32b2](https://github.com/roggervalf/iam-policies/commit/51d32b2423c44a76bebcde4772f7400cb3129e60))
14+
15+
# [4.14.0](https://github.com/roggervalf/iam-policies/compare/v4.13.0...v4.14.0) (2021-11-08)
16+
17+
18+
### Features
19+
20+
* **action-policy:** add whyCan and whyCannot methods ([#59](https://github.com/roggervalf/iam-policies/issues/59)) ([fef8e89](https://github.com/roggervalf/iam-policies/commit/fef8e8994ab57d29e3382cd9cf967b7d43a31879))
21+
22+
# [4.13.0](https://github.com/roggervalf/iam-policies/compare/v4.12.0...v4.13.0) (2021-10-17)
23+
24+
25+
### Features
26+
27+
* **generate-proxy:** update Proxy types ([#58](https://github.com/roggervalf/iam-policies/issues/58)) ([236627a](https://github.com/roggervalf/iam-policies/commit/236627acae923a334eb3635f177af9f3528ba42a))
28+
29+
# [4.12.0](https://github.com/roggervalf/iam-policies/compare/v4.11.0...v4.12.0) (2021-07-26)
30+
31+
32+
### Features
33+
34+
* **string:** add case-sensitive-matching if exist (stringLikeIfExists) ([695961d](https://github.com/roggervalf/iam-policies/commit/695961df60775e8cbe84cc46454a7cc86ddcbf0b))
35+
36+
# [4.11.0](https://github.com/roggervalf/iam-policies/compare/v4.10.0...v4.11.0) (2021-05-31)
37+
38+
39+
### Features
40+
41+
* **date:** add matching after a specific date and time operator (dateGreaterThan) ([9e5c93d](https://github.com/roggervalf/iam-policies/commit/9e5c93dd1c755614eb4090d8cb2d3a31df041187))
42+
* **date:** add matching at or after a specific date and time operator (dateGreaterThanEquals) ([a0e84ca](https://github.com/roggervalf/iam-policies/commit/a0e84ca5a4a7c5dfad4cfbf1a3ddae832a1f1d58))
43+
44+
# [4.10.0](https://github.com/roggervalf/iam-policies/compare/v4.9.0...v4.10.0) (2021-05-29)
45+
46+
47+
### Features
48+
49+
* **date:** add matching before a specific date and time operator (dateLessThan) ([3c6a7fe](https://github.com/roggervalf/iam-policies/commit/3c6a7fedabee69162ad84069f903c5075929fead))
50+
* **date:** add matching at or before a specific date and time (dateLessThanEquals) ([e359440](https://github.com/roggervalf/iam-policies/commit/e3594409c1e7045d83586a8dd0458070b9f60e50))
51+
52+
# [4.9.0](https://github.com/roggervalf/iam-policies/compare/v4.8.2...v4.9.0) (2021-05-06)
53+
54+
55+
### Features
56+
57+
* **date:** add negated date matching condition operator ([6081df9](https://github.com/roggervalf/iam-policies/commit/6081df9d83fba84599251914ece843f5a5ddd3a8))
58+
59+
## [4.8.2](https://github.com/roggervalf/iam-policies/compare/v4.8.1...v4.8.2) (2021-04-11)
60+
61+
62+
### Bug Fixes
63+
64+
* **evaluate:** use context in instantiation in IdentityBasedPolicy and ResourceBasedPolicy ([c0f3561](https://github.com/roggervalf/iam-policies/commit/c0f3561e4458baf15983425c64cb1d5550fdf6f8)), closes [#43](https://github.com/roggervalf/iam-policies/issues/43)
65+
66+
## [4.8.1](https://github.com/roggervalf/iam-policies/compare/v4.8.0...v4.8.1) (2021-04-09)
67+
68+
69+
### Bug Fixes
70+
71+
* **resourcebasedstatement:** check principalType when is undefined ([34ce2f4](https://github.com/roggervalf/iam-policies/commit/34ce2f49ecb6b41dd6fc2248fc6e98e11f2694e1)), closes [#42](https://github.com/roggervalf/iam-policies/issues/42)
72+
73+
# [4.8.0](https://github.com/roggervalf/iam-policies/compare/v4.7.0...v4.8.0) (2021-04-05)
74+
75+
76+
### Features
77+
78+
* **date:** add date exact matching condition operator ([07315cc](https://github.com/roggervalf/iam-policies/commit/07315cc30e757e97adfcc1d860e9ee5655373435))
79+
80+
# [4.7.0](https://github.com/roggervalf/iam-policies/compare/v4.6.0...v4.7.0) (2021-02-28)
81+
82+
83+
### Features
84+
85+
* **bool:** add boolean matching condition operator ([028c968](https://github.com/roggervalf/iam-policies/commit/028c96893ff9fb5919b70f9b9a9d2485e6cb05cb))
86+
87+
# [4.6.0](https://github.com/roggervalf/iam-policies/compare/v4.5.0...v4.6.0) (2021-02-25)
88+
89+
90+
### Features
91+
92+
* **numeric:** add numericEquals condition operator ([46b89c8](https://github.com/roggervalf/iam-policies/commit/46b89c8af4c7c796a826e9dd6f12770b933ded87))
93+
* **numeric:** add numericGreaterThan condition operator ([01384d0](https://github.com/roggervalf/iam-policies/commit/01384d02f601912b1e542b472365b538f17ffabd))
94+
* **numeric:** add numericGreaterThanEquals condition operator ([35ad211](https://github.com/roggervalf/iam-policies/commit/35ad2114505e1ac0ce4457d3d02af9b9b2945118))
95+
* **numeric:** add numericLessThan condition operator ([fb75c5f](https://github.com/roggervalf/iam-policies/commit/fb75c5f20ad22a9fca74c7118aa8f43b0ad8c49f))
96+
* **numeric:** add numericLessThanEquals condition operator ([7ceb06d](https://github.com/roggervalf/iam-policies/commit/7ceb06df5ab6b5e6fb1859d886ebb6582b051ce2))
97+
* **numeric:** add numericNotEquals condition operator ([1de1638](https://github.com/roggervalf/iam-policies/commit/1de163869fe18baaf47ac8faa1d2c11f102d60ae))
98+
99+
# [4.5.0](https://github.com/roggervalf/iam-policies/compare/v4.4.0...v4.5.0) (2021-02-21)
100+
101+
102+
### Features
103+
104+
* **stringlike:** add case sensitive matching with multi character match * ([e5f2fc8](https://github.com/roggervalf/iam-policies/commit/e5f2fc81b81982cab832be2c5e479db4933c14d7))
105+
106+
# [4.4.0](https://github.com/roggervalf/iam-policies/compare/v4.3.0...v4.4.0) (2021-02-18)
107+
108+
109+
### Features
110+
111+
* **stringequalsignorecase:** add exact matching string operator, ignoring case ([83665fa](https://github.com/roggervalf/iam-policies/commit/83665fa769ba76059a66a9f3ab2c72a1bf107692))
112+
* **stringnotequals:** add negated string matching operator ([83665fa](https://github.com/roggervalf/iam-policies/commit/83665fa769ba76059a66a9f3ab2c72a1bf107692))
113+
* **stringnotequalsignorecase:** add negated string matching operator, ignoring case ([83665fa](https://github.com/roggervalf/iam-policies/commit/83665fa769ba76059a66a9f3ab2c72a1bf107692))
114+
115+
# [4.3.0](https://github.com/roggervalf/iam-policies/compare/v4.2.1...v4.3.0) (2021-02-16)
116+
117+
118+
### Features
119+
120+
* **stringequals:** add exact matching string operator ([6fd5766](https://github.com/roggervalf/iam-policies/commit/6fd5766b9f0af96b30907af65763f72448fdd3d2))
121+
122+
## [4.2.1](https://github.com/roggervalf/iam-policies/compare/v4.2.0...v4.2.1) (2020-12-06)
123+
124+
125+
### Bug Fixes
126+
127+
* **matcher:** allow ignoring {} by using $, ie ${a} should match with {a} ([470f07d](https://github.com/roggervalf/iam-policies/commit/470f07db33303934a40bfbd7d252125f777cb72f)), closes [#37](https://github.com/roggervalf/iam-policies/issues/37)
128+
129+
# [4.2.0](https://github.com/roggervalf/iam-policies/compare/v4.1.0...v4.2.0) (2020-12-05)
130+
131+
132+
### Features
133+
134+
* **policies:** add addStatement function ([fc2697f](https://github.com/roggervalf/iam-policies/commit/fc2697f20fe4e14a77c78c0034654fdb498503dd)), closes [#35](https://github.com/roggervalf/iam-policies/issues/35)
135+
136+
# [4.1.0](https://github.com/roggervalf/iam-policies/compare/v4.0.3...v4.1.0) (2020-11-10)
137+
138+
139+
### Features
140+
141+
* **condition:** extend condition block type to accept unknown values ([38a6daa](https://github.com/roggervalf/iam-policies/commit/38a6daafd5e7d231c51bd50a0f914e4201ec5109))
142+
* **context:** allow passing objects as context ([b78d5fb](https://github.com/roggervalf/iam-policies/commit/b78d5fb98e3e2c4aa23889ecf8a8d865d339418e)), closes [#15](https://github.com/roggervalf/iam-policies/issues/15)
143+
144+
## [4.0.3](https://github.com/roggervalf/iam-policies/compare/v4.0.2...v4.0.3) (2020-11-03)
145+
146+
147+
### Bug Fixes
148+
149+
* **types:** use object type in generateProxy ([8f90ff1](https://github.com/roggervalf/iam-policies/commit/8f90ff1370250133a55387d7c1259f84a7fc5230))
150+
151+
## [4.0.2](https://github.com/roggervalf/iam-policies/compare/v4.0.1...v4.0.2) (2020-10-31)
152+
153+
154+
### Bug Fixes
155+
156+
* **sourcemaps:** allow sourceMap from ts config ([f071ca0](https://github.com/roggervalf/iam-policies/commit/f071ca0927d61152fb9ddf428b2685f95bbf2663))
157+
158+
## [4.0.1](https://github.com/roggervalf/iam-policies/compare/v4.0.0...v4.0.1) (2020-10-30)
159+
160+
161+
### Bug Fixes
162+
163+
* **types:** add this types in public functions in classes ([f182fd9](https://github.com/roggervalf/iam-policies/commit/f182fd9cad7603ed3c347f8475ea510b48d6a4f9))
164+
165+
# [4.0.0](https://github.com/roggervalf/iam-policies/compare/v3.5.0...v4.0.0) (2020-10-26)
166+
167+
168+
### Bug Fixes
169+
170+
* **resourcebasedstatement:** validate principal, notPrincipal, resource and notResource attributes ([2aee00c](https://github.com/roggervalf/iam-policies/commit/2aee00caf6ac720213cbb7bcc1da2c5292f41acb))
171+
* throw Type Error in Identity and Resource statements for actions and resources ([78c52ca](https://github.com/roggervalf/iam-policies/commit/78c52ca50a4edf84758d4d96e8d422ade6d3f1d7))
172+
* **actionbasedstatement:** throw TypeError when action and notAction are present ([2e4409d](https://github.com/roggervalf/iam-policies/commit/2e4409dd87cad000c85a0d8d2c6941b936293487))
173+
* **resourcebasedstatement:** return true in matchNotPrincipals ([f78553e](https://github.com/roggervalf/iam-policies/commit/f78553e307ed58b6823b05da3408d5fc5a3c1097))
174+
175+
176+
### Features
177+
178+
* **actionbasedpolicy:** allow to generate proxy from Action Based Policy ([72f4092](https://github.com/roggervalf/iam-policies/commit/72f40920e7869fd22b3ea3dbaa9dcaccc75dfd92))
179+
* extending Policy in Identity and Resource Based Policies ([bd06fc6](https://github.com/roggervalf/iam-policies/commit/bd06fc6ec22177e0fca38308bda7601e4c47fd1e))
180+
* **actionbasedpolicy:** allow to set and get conditionResolver ([10bee79](https://github.com/roggervalf/iam-policies/commit/10bee7935e7aa72d59995d170fe0f801acc5dc20))
181+
* **actionbasedpolicy:** allow to set and get context ([3420d87](https://github.com/roggervalf/iam-policies/commit/3420d871d98c7bc62ecef9f147479228640edba3))
182+
183+
184+
### BREAKING CHANGES
185+
186+
* new way to construct Policies instances with a json
187+
188+
# [3.5.0](https://github.com/roggervalf/iam-policies/compare/v3.4.1...v3.5.0) (2020-10-11)
189+
190+
191+
### Features
192+
193+
* **sid:** generate uuid to set sid in statements as default ([c23d6e6](https://github.com/roggervalf/iam-policies/commit/c23d6e66208df06f8d48702c6143252374c22deb)), closes [#27](https://github.com/roggervalf/iam-policies/issues/27)
194+
* **uuid:** add util functions to generate uuid ([f7687e6](https://github.com/roggervalf/iam-policies/commit/f7687e698e2c28e95fe37e6a744bb6f49e9cd9bb))
195+
196+
## [3.4.1](https://github.com/roggervalf/iam-policies/compare/v3.4.0...v3.4.1) (2020-09-06)
197+
198+
199+
### Bug Fixes
200+
201+
* **github:** try to publish on github ([#26](https://github.com/roggervalf/iam-policies/issues/26)) ([24d0672](https://github.com/roggervalf/iam-policies/commit/24d06720c57bfb9748e710f47246a9387324d0fe))
202+
203+
# [3.4.0](https://github.com/roggervalf/iam-policies/compare/v3.3.0...v3.4.0) (2020-08-28)
204+
205+
206+
### Features
207+
208+
* **actionbasedpolicy:** add new policy, just with actions ([994c0ff](https://github.com/roggervalf/iam-policies/commit/994c0ff4ab0720bf2a31e05dc0b533b44bc5507e))
209+
210+
# [3.3.0](https://github.com/roggervalf/iam-policies/compare/v3.2.0...v3.3.0) (2020-05-30)
211+
212+
213+
### Features
214+
215+
* **getstatements:** add public function to get statements in policies ([b1aa400](https://github.com/roggervalf/iam-policies/commit/b1aa4002eb1c3527d13742474588c9f8938f2220))
216+
217+
# [3.2.0](https://github.com/roggervalf/iam-policies/compare/v3.1.1...v3.2.0) (2020-05-24)
218+
219+
220+
### Bug Fixes
221+
222+
* **baseget:** validate value as object instead of null ([6998f6d](https://github.com/roggervalf/iam-policies/commit/6998f6d1399dfd32ef90d04acc95e64b7522a7e4))
223+
224+
225+
### Features
226+
227+
* **standalone:** keep standalone files in dist directory ([72962d3](https://github.com/roggervalf/iam-policies/commit/72962d37c413bd5c7b90e6aca44c2d773612fdd6))
228+
229+
230+
### Performance Improvements
231+
232+
* **types:** bundle d.ts files using rollup-plugin-dts ([ea3a17e](https://github.com/roggervalf/iam-policies/commit/ea3a17ec3212c742c056ed4f1685bbc85fd8e303))
233+
234+
## [3.1.1](https://github.com/roggervalf/iam-policies/compare/v3.1.0...v3.1.1) (2020-05-22)
235+
236+
237+
### Bug Fixes
238+
239+
* **matcher:** * should match at least one character ([5a42b66](https://github.com/roggervalf/iam-policies/commit/5a42b66250784b5e66b6ee8f616129eae99a57df))
240+
241+
# [3.1.0](https://github.com/roggervalf/iam-policies/compare/v3.0.5...v3.1.0) (2020-05-03)
242+
243+
244+
### Features
245+
246+
* **gettag:** add util function to get to string tag of a value ([29c981f](https://github.com/roggervalf/iam-policies/commit/29c981f66bad15d66efde7705839d83825ab5dcd))
247+
* **iskey:** add new util to match property names and paths ([97e60ed](https://github.com/roggervalf/iam-policies/commit/97e60eddee79e970efa640e03e0582758555e6bd))
248+
* **issymbol:** add new util for checking if a value is a symbol ([6ddf3d1](https://github.com/roggervalf/iam-policies/commit/6ddf3d12e9d336f4441b25050acca85163e025c3))
249+
* **memoize:** add new util function to memoize results ([c55032d](https://github.com/roggervalf/iam-policies/commit/c55032d4ec45039e8a558f959e569934ccd7f328))
250+
* **memoizecapped:** add specialized memoize function version ([4e88c35](https://github.com/roggervalf/iam-policies/commit/4e88c3590a02d8345e167e534aabb0c02b4be68e))
251+
* **stringtopath:** add util to convert string to a property path array ([c4d0dd4](https://github.com/roggervalf/iam-policies/commit/c4d0dd43fbc2612f28960ede973c2ba5e12885b4))
252+
* **tokey:** add util to convert value to a string key ([8d19068](https://github.com/roggervalf/iam-policies/commit/8d19068b6775289ca785dc8f3128ae9e102a9222))
253+
254+
255+
### Performance Improvements
256+
257+
* **dependencies:** upgrade deprecated dev-dependencies ([a6f09a9](https://github.com/roggervalf/iam-policies/commit/a6f09a95c1d2e560f4c01c23a28f8fbf38eaf26b))
258+
259+
## [3.0.5](https://github.com/roggervalf/iam-policies/compare/v3.0.4...v3.0.5) (2020-04-30)
260+
261+
262+
### Bug Fixes
263+
264+
* **matcher:** allow passing / into string comparison for \* ([94da308](https://github.com/roggervalf/iam-policies/commit/94da30873f2fc044bfaa890e7f2dd5fc1acede09)), closes [#18](https://github.com/roggervalf/iam-policies/issues/18)
265+
266+
## [3.0.4](https://github.com/roggervalf/iam-policies/compare/v3.0.3...v3.0.4) (2020-04-12)
267+
268+
269+
### Bug Fixes
270+
271+
* **github:** update github references ([974d818](https://github.com/roggervalf/iam-policies/commit/974d818e6a22c985c3c612f25c034b54f1076724))
272+
273+
## [3.0.3](https://github.com/roggervalf/iam-policies/compare/v3.0.2...v3.0.3) (2020-03-30)
274+
275+
276+
### Bug Fixes
277+
278+
* **rollup:** delete unused external-helpers plugin ([2b829de](https://github.com/roggervalf/iam-policies/commit/2b829de1baa2dc3aa774688654a0f8c9065d79c4))
279+
280+
## [3.0.2](https://github.com/roggervalf/iam-policies/compare/v3.0.1...v3.0.2) (2020-03-20)
281+
282+
283+
### Bug Fixes
284+
285+
* **getvaluefrompath:** return ConditionKey type values ([febbcb7](https://github.com/roggervalf/iam-policies/commit/febbcb7ae552ae29779899ab0b474218b1490f3f)), closes [#14](https://github.com/roggervalf/iam-policies/issues/14)
286+
287+
## [3.0.1](https://github.com/roggervalf/iam-policies/compare/v3.0.0...v3.0.1) (2020-03-06)
288+
289+
290+
### Bug Fixes
291+
292+
* **semantic-release:** try semantic-release from travis ([91e0384](https://github.com/roggervalf/iam-policies/commit/91e0384e56af1b0bbaf8d031f2aa8a2158487f80))
293+
294+
# [3.0.0](https://github.com/roggervalf/iam-policies/compare/v2.0.1...v3.0.0) (2020-03-06)
295+
296+
297+
### Bug Fixes
298+
299+
* exclude dist from ts compile ([9b6b754](https://github.com/roggervalf/iam-policies/commit/9b6b7545bae513100f52b76f8adb230990dbad80))
300+
* change node version into travis and package ([4347bd2](https://github.com/roggervalf/iam-policies/commit/4347bd274ed774db84d18584e94b8184befebe0a))
301+
* not rollup test files ([e153fbf](https://github.com/roggervalf/iam-policies/commit/e153fbf5d6d4325ed9ee3d3bd834877d574c2695))
302+
303+
304+
### Features
305+
306+
* **semantic-release:** add semantic-release package ([#12](https://github.com/roggervalf/iam-policies/issues/12)) ([28cf910](https://github.com/roggervalf/iam-policies/commit/28cf9102ca85db4f9dde7907ea3c0b1790e73600))
307+
308+
## [2.0.1](https://github.com/roggervalf/iam-policies/compare/2.0.0...v2.0.1) (2020-03-01)
309+
310+
311+
### Bug Fixes
312+
313+
* **resourcebasedstatement:** fix notprincipal attribute ([#9](https://github.com/roggervalf/iam-policies/issues/9)) ([cb21c66](https://github.com/roggervalf/iam-policies/commit/cb21c6655dc491ef5ef49c2540fdf7654563ff8b))
314+
315+
# [2.0.0](https://github.com/roggervalf/iam-policies/compare/1.3.2...2.0.0) (2020-02-23)
316+
317+
318+
### Bug Fixes
319+
320+
* more legibility ([#7](https://github.com/roggervalf/iam-policies/pull/7)) ([7c37cb1](https://github.com/roggervalf/iam-policies/commit/7c37cb1ab5deee71a7aaca757d01dceeb53909b9))
321+
322+
323+
### Features
324+
325+
* **identitybased and resourcebased:** add new policies ([#8](https://github.com/roggervalf/iam-policies/pull/8)) ([58210b7](https://github.com/roggervalf/iam-policies/commit/58210b738f95b9eb6f81d297a08a36af4ee2b19e))
326+
327+
### [1.3.2](https://github.com/roggervalf/iam-policies/compare/1.3.1...1.3.2) (2020-02-11)
328+
329+
### [1.3.1](https://github.com/roggervalf/iam-policies/compare/1.3.0...1.3.1) (2020-01-19)
330+
331+
## [1.3.0](https://github.com/roggervalf/iam-policies/compare/1.2.0...1.3.0) (2020-01-01)
332+
333+
## [1.2.0](https://github.com/roggervalf/iam-policies/compare/1.1.0...1.2.0) (2019-12-20)

0 commit comments

Comments
 (0)