@loopback/docs 5.2.0 → 5.2.1

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 (81) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/package.json +4 -4
  3. package/site/Application-generator.md +1 -1
  4. package/site/CHANGELOG.md +1 -0
  5. package/site/Discovering-models.md +5 -0
  6. package/site/apidocs/sequelize.md +1 -1
  7. package/site/apidocs/sequelize.sequelizecrudrepository.begintransaction.md +32 -0
  8. package/site/apidocs/sequelize.sequelizecrudrepository.db_specific_settings_keys.md +1 -1
  9. package/site/apidocs/sequelize.sequelizecrudrepository.md +2 -1
  10. package/site/apidocs/sequelize.sequelizedatasource.begintransaction.md +36 -0
  11. package/site/apidocs/sequelize.sequelizedatasource.getpooloptions.md +25 -0
  12. package/site/apidocs/sequelize.sequelizedatasource.md +4 -0
  13. package/site/apidocs/sequelize.sequelizedatasource.stop.md +2 -2
  14. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +8 -0
  15. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +8 -0
  16. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +8 -0
  17. package/site/changelogs/examples/context/CHANGELOG.md +8 -0
  18. package/site/changelogs/examples/express-composition/CHANGELOG.md +8 -0
  19. package/site/changelogs/examples/file-transfer/CHANGELOG.md +8 -0
  20. package/site/changelogs/examples/graphql/CHANGELOG.md +8 -0
  21. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +8 -0
  22. package/site/changelogs/examples/greeting-app/CHANGELOG.md +8 -0
  23. package/site/changelogs/examples/hello-world/CHANGELOG.md +8 -0
  24. package/site/changelogs/examples/lb3-application/CHANGELOG.md +8 -0
  25. package/site/changelogs/examples/log-extension/CHANGELOG.md +8 -0
  26. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +8 -0
  27. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +8 -0
  28. package/site/changelogs/examples/passport-login/CHANGELOG.md +8 -0
  29. package/site/changelogs/examples/references-many/CHANGELOG.md +8 -0
  30. package/site/changelogs/examples/rest-crud/CHANGELOG.md +8 -0
  31. package/site/changelogs/examples/rpc-server/CHANGELOG.md +8 -0
  32. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +8 -0
  33. package/site/changelogs/examples/socketio/CHANGELOG.md +8 -0
  34. package/site/changelogs/examples/todo/CHANGELOG.md +8 -0
  35. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +8 -0
  36. package/site/changelogs/examples/todo-list/CHANGELOG.md +8 -0
  37. package/site/changelogs/examples/validation-app/CHANGELOG.md +8 -0
  38. package/site/changelogs/examples/webpack/CHANGELOG.md +8 -0
  39. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +8 -0
  40. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +8 -0
  41. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +8 -0
  42. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +8 -0
  43. package/site/changelogs/extensions/cron/CHANGELOG.md +8 -0
  44. package/site/changelogs/extensions/graphql/CHANGELOG.md +8 -0
  45. package/site/changelogs/extensions/health/CHANGELOG.md +8 -0
  46. package/site/changelogs/extensions/logging/CHANGELOG.md +8 -0
  47. package/site/changelogs/extensions/metrics/CHANGELOG.md +8 -0
  48. package/site/changelogs/extensions/pooling/CHANGELOG.md +8 -0
  49. package/site/changelogs/extensions/sequelize/CHANGELOG.md +22 -0
  50. package/site/changelogs/extensions/socketio/CHANGELOG.md +8 -0
  51. package/site/changelogs/extensions/typeorm/CHANGELOG.md +8 -0
  52. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +19 -0
  53. package/site/changelogs/packages/authentication/CHANGELOG.md +8 -0
  54. package/site/changelogs/packages/authorization/CHANGELOG.md +8 -0
  55. package/site/changelogs/packages/boot/CHANGELOG.md +8 -0
  56. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +8 -0
  57. package/site/changelogs/packages/build/CHANGELOG.md +14 -0
  58. package/site/changelogs/packages/cli/CHANGELOG.md +35 -0
  59. package/site/changelogs/packages/context/CHANGELOG.md +8 -0
  60. package/site/changelogs/packages/core/CHANGELOG.md +8 -0
  61. package/site/changelogs/packages/eslint-config/CHANGELOG.md +11 -0
  62. package/site/changelogs/packages/express/CHANGELOG.md +8 -0
  63. package/site/changelogs/packages/filter/CHANGELOG.md +11 -0
  64. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +12 -0
  65. package/site/changelogs/packages/http-server/CHANGELOG.md +8 -0
  66. package/site/changelogs/packages/metadata/CHANGELOG.md +11 -0
  67. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +8 -0
  68. package/site/changelogs/packages/monorepo/CHANGELOG.md +11 -0
  69. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +11 -0
  70. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +8 -0
  71. package/site/changelogs/packages/repository/CHANGELOG.md +8 -0
  72. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +8 -0
  73. package/site/changelogs/packages/repository-tests/CHANGELOG.md +8 -0
  74. package/site/changelogs/packages/rest/CHANGELOG.md +8 -0
  75. package/site/changelogs/packages/rest-crud/CHANGELOG.md +8 -0
  76. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +8 -0
  77. package/site/changelogs/packages/security/CHANGELOG.md +8 -0
  78. package/site/changelogs/packages/service-proxy/CHANGELOG.md +8 -0
  79. package/site/changelogs/packages/testlab/CHANGELOG.md +11 -0
  80. package/site/changelogs/packages/tsdocs/CHANGELOG.md +19 -0
  81. package/site/readmes/loopback-next/extensions/sequelize/README.md +79 -3
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.repository-tests.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.21.9](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.21.8...@loopback/repository-tests@0.21.9) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/repository-tests
19
+
20
+
21
+
22
+
23
+
16
24
  ## [0.21.8](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.21.7...@loopback/repository-tests@0.21.8) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.rest.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [12.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@12.0.8...@loopback/rest@12.0.9) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/rest
19
+
20
+
21
+
22
+
23
+
16
24
  ## [12.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@12.0.7...@loopback/rest@12.0.8) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.rest-crud.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.15.8](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.15.7...@loopback/rest-crud@0.15.8) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/rest-crud
19
+
20
+
21
+
22
+
23
+
16
24
  ## [0.15.7](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.15.6...@loopback/rest-crud@0.15.7) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.rest-explorer.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@5.0.8...@loopback/rest-explorer@5.0.9) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/rest-explorer
19
+
20
+
21
+
22
+
23
+
16
24
  ## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@5.0.7...@loopback/rest-explorer@5.0.8) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.security.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.8.9](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.8.8...@loopback/security@0.8.9) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/security
19
+
20
+
21
+
22
+
23
+
16
24
  ## [0.8.8](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.8.7...@loopback/security@0.8.8) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.service-proxy.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@5.0.8...@loopback/service-proxy@5.0.9) (2023-03-09)
17
+
18
+ **Note:** Version bump only for package @loopback/service-proxy
19
+
20
+
21
+
22
+
23
+
16
24
  ## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@5.0.7...@loopback/service-proxy@5.0.8) (2023-02-07)
17
25
 
18
26
 
@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.testlab.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@5.0.9...@loopback/testlab@5.0.10) (2023-04-13)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
22
+
23
+
24
+
25
+
26
+
16
27
  ## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@5.0.8...@loopback/testlab@5.0.9) (2023-03-09)
17
28
 
18
29
  **Note:** Version bump only for package @loopback/testlab
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.tsdocs.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [4.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.9...@loopback/tsdocs@4.0.10) (2023-04-13)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
22
+
23
+
24
+
25
+
26
+
27
+ ## [4.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.8...@loopback/tsdocs@4.0.9) (2023-03-09)
28
+
29
+ **Note:** Version bump only for package @loopback/tsdocs
30
+
31
+
32
+
33
+
34
+
16
35
  ## [4.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.7...@loopback/tsdocs@4.0.8) (2023-02-07)
17
36
 
18
37
  **Note:** Version bump only for package @loopback/tsdocs
@@ -128,6 +128,84 @@ contains "Art" in their title, which belongs to category "Programming":
128
128
  }
129
129
  ```
130
130
 
131
+ ## SQL Transactions
132
+
133
+ A Sequelize repository can perform operations in a transaction using the
134
+ `beginTransaction()` method.
135
+
136
+ ### Isolation levels
137
+
138
+ When you call `beginTransaction()`, you can optionally specify a transaction
139
+ isolation level. It support the following isolation levels:
140
+
141
+ - `Transaction.ISOLATION_LEVELS.READ_UNCOMMITTED` (default)
142
+ - `Transaction.ISOLATION_LEVELS.READ_COMMITTED`
143
+ - `Transaction.ISOLATION_LEVELS.REPEATABLE_READ`
144
+ - `Transaction.ISOLATION_LEVELS.SERIALIZABLE`
145
+
146
+ ### Options
147
+
148
+ Following are the supported options:
149
+
150
+ ```ts
151
+ {
152
+ autocommit?: boolean;
153
+ isolationLevel?: Transaction.ISOLATION_LEVELS;
154
+ type?: Transaction.TYPES;
155
+ deferrable?: string | Deferrable;
156
+ /**
157
+ * Parent transaction.
158
+ */
159
+ transaction?: Transaction | null;
160
+ }
161
+ ```
162
+
163
+ ### Example
164
+
165
+ ```ts
166
+ // Get repository instances. In a typical application, instances are injected
167
+ // via dependency injection using `@repository` decorator.
168
+ const userRepo = await app.getRepository(UserRepository);
169
+
170
+ // Begin a new transaction.
171
+ // It's also possible to call `userRepo.dataSource.beginTransaction` instead.
172
+ const tx = await userRepo.beginTransaction({
173
+ isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
174
+ });
175
+
176
+ try {
177
+ // Then, we do some calls passing this transaction as an option:
178
+ const user = await userRepo.create(
179
+ {
180
+ firstName: 'Jon',
181
+ lastName: 'Doe',
182
+ },
183
+ {transaction: tx},
184
+ );
185
+
186
+ await userRepo.updateById(
187
+ user.id,
188
+ {
189
+ firstName: 'John',
190
+ },
191
+ {transaction: tx},
192
+ );
193
+
194
+ // If the execution reaches this line, no errors were thrown.
195
+ // We commit the transaction.
196
+ await tx.commit();
197
+ } catch (error) {
198
+ // If the execution reaches this line, an error was thrown.
199
+ // We rollback the transaction.
200
+ await tx.rollback();
201
+ }
202
+ ```
203
+
204
+ Switching from loopback defaults to sequelize transaction is as simple as
205
+ [this commit](https://github.com/shubhamp-sf/loopback4-sequelize-transaction-example/commit/321791c93ffd10c3af13e8b891396ae99b632a23)
206
+ in
207
+ [loopback4-sequelize-transaction-example](https://github.com/shubhamp-sf/loopback4-sequelize-transaction-example).
208
+
131
209
  <!-- tutorial-end -->
132
210
 
133
211
  ## Debug strings reference
@@ -167,11 +245,9 @@ debugging. To learn more about how to use them, see
167
245
 
168
246
  Please note, the current implementation does not support the following:
169
247
 
170
- 1. SQL Transactions.
171
- 2. Loopback Migrations (via default `migrate.ts`). Though you're good if using
248
+ 1. Loopback Migrations (via default `migrate.ts`). Though you're good if using
172
249
  external packages like
173
250
  [`db-migrate`](https://www.npmjs.com/package/db-migrate).
174
- 3. Connection Pooling is not implemented yet.
175
251
 
176
252
  Community contribution is welcome.
177
253