@loopback/docs 5.1.7 → 5.2.0

package/site/changelogs/packages/repository/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.repository.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.1.3](https://github.com/loopbackio/loopback-next/compare/@loopback/repository@5.1.2...@loopback/repository@5.1.3) (2023-02-07)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [5.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/repository@5.1.1...@loopback/repository@5.1.2) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/repository

package/site/changelogs/packages/repository-json-schema/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.repository-json-schema.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-json-schema@6.1.1...@loopback/repository-json-schema@6.1.2) (2023-02-07)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-json-schema@6.1.0...@loopback/repository-json-schema@6.1.1) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/repository-json-schema

package/site/changelogs/packages/repository-tests/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.repository-tests.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [0.21.7](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.21.6...@loopback/repository-tests@0.21.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/repository-tests

package/site/changelogs/packages/rest/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.rest.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [12.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@12.0.7...@loopback/rest@12.0.8) (2023-02-07)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [12.0.7](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@12.0.6...@loopback/rest@12.0.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/rest

package/site/changelogs/packages/rest-crud/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.rest-crud.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [0.15.6](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.15.5...@loopback/rest-crud@0.15.6) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/rest-crud

package/site/changelogs/packages/rest-explorer/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.rest-explorer.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [5.0.7](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@5.0.6...@loopback/rest-explorer@5.0.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/rest-explorer

package/site/changelogs/packages/security/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.security.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.8.8](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.8.7...@loopback/security@0.8.8) (2023-02-07)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [0.8.7](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.8.6...@loopback/security@0.8.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/security

package/site/changelogs/packages/service-proxy/CHANGELOG.md

@@ -13,6 +13,17 @@ permalink: /doc/en/lb4/changelog.service-proxy.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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)
+
+
+### Reverts
+
+* "chore: update dependency rimraf to v4" ([c516d5e](https://github.com/loopbackio/loopback-next/commit/c516d5e33e2d2ce950c6811305e7da3fe40ca9c6))
+
+
+
+
+
 ## [5.0.7](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@5.0.6...@loopback/service-proxy@5.0.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/service-proxy

package/site/changelogs/packages/testlab/CHANGELOG.md

@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.testlab.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@5.0.8...@loopback/testlab@5.0.9) (2023-03-09)
+
+**Note:** Version bump only for package @loopback/testlab
+
+
+
+
+
 ## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@5.0.7...@loopback/testlab@5.0.8) (2023-02-07)
 
 **Note:** Version bump only for package @loopback/testlab

package/site/changelogs/packages/tsdocs/CHANGELOG.md

@@ -13,6 +13,14 @@ permalink: /doc/en/lb4/changelog.tsdocs.html
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.7...@loopback/tsdocs@4.0.8) (2023-02-07)
+
+**Note:** Version bump only for package @loopback/tsdocs
+
+
+
+
+
 ## [4.0.7](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.6...@loopback/tsdocs@4.0.7) (2023-01-09)
 
 **Note:** Version bump only for package @loopback/tsdocs

package/site/readmes/loopback-next/extensions/sequelize/README.md

@@ -0,0 +1,194 @@
+# @loopback/sequelize
+
+This is a loopback4 extension that provides Sequelize's query builder at
+repository level in any loopback 4 application. It has zero learning curve as it
+follows similar interface as `DefaultCrudRepository`. For relational databases,
+Sequelize is a popular ORM of choice.
+
+For pending features, refer to the [Limitations](#limitations) section below.
+
+## Stability: ⚠️Experimental⚠️
+
+> Experimental packages provide early access to advanced or experimental
+> functionality to get community feedback. Such modules are published to npm
+> using `0.x.y` versions. Their APIs and functionality may be subject to
+> breaking changes in future releases.
+
+## Installation
+
+To install this extension in your Loopback 4 project, run the following command:
+
+```sh
+npm install @loopback/sequelize
+```
+
+You'll also need to install the driver for your preferred database:
+
+```sh
+# One of the following:
+npm install --save pg pg-hstore # Postgres
+npm install --save mysql2
+npm install --save mariadb
+npm install --save sqlite3
+npm install --save tedious # Microsoft SQL Server
+npm install --save oracledb # Oracle Database
+```
+
+## Usage
+
+> You can watch a video overview of this extension by
+> [clicking here](https://youtu.be/ZrUxIk63oRc).
+
+<!-- tutorial-start -->
+
+Both newly developed and existing projects can benefit from the extension by
+simply changing the parent classes in the target Data Source and Repositories.
+
+### Step 1: Configure DataSource
+
+Change the parent class from `juggler.DataSource` to `SequelizeDataSource` like
+below.
+
+```ts title="pg.datasource.ts"
+// ...
+import {SequelizeDataSource} from '@loopback/sequelize';
+
+// ...
+export class PgDataSource
+  extends SequelizeDataSource
+  implements LifeCycleObserver {
+  // ...
+}
+```
+
+### Step 2: Configure Repository
+
+Change the parent class from `DefaultCrudRepository` to
+`SequelizeCrudRepository` like below.
+
+```ts title="your.repository.ts"
+// ...
+import {SequelizeCrudRepository} from '@loopback/sequelize';
+
+export class YourRepository extends SequelizeCrudRepository<
+  YourModel,
+  typeof YourModel.prototype.id,
+  YourModelRelations
+> {
+  // ...
+}
+```
+
+## Relations
+
+### Supported Loopback Relations
+
+With `SequelizeCrudRepository`, you can utilize following relations without any
+additional configuration:
+
+1. [HasMany Relation](https://loopback.io/doc/en/lb4/HasMany-relation.html)
+2. [BelongsTo Relation](https://loopback.io/doc/en/lb4/BelongsTo-relation.html)
+3. [HasOne Relation](https://loopback.io/doc/en/lb4/HasOne-relation.html)
+4. [HasManyThrough Relation](https://loopback.io/doc/en/lb4/HasManyThrough-relation.html)
+5. [ReferencesMany Relation](https://loopback.io/doc/en/lb4/ReferencesMany-relation.html)
+
+The default relation configuration, generated using the
+[lb4 relation](https://loopback.io/doc/en/lb4/Relation-generator.html) command
+(i.e. inclusion resolvers in the repository and property decorators in the
+model), remain unchanged.
+
+### INNER JOIN
+
+> Check the demo video of using inner joins here:
+> https://youtu.be/ZrUxIk63oRc?t=76
+
+When using `SequelizeCrudRepository`, the `find()`, `findOne()`, and
+`findById()` methods accept a new option called `required` in the include
+filter. Setting this option to `true` will result in an inner join query that
+explicitly requires the specified condition for the child model. If the row does
+not meet this condition, it will not be fetched and returned.
+
+An example of the filter object might look like this to fetch the books who
+contains "Art" in their title, which belongs to category "Programming":
+
+```json
+{
+  "where": {"title": {"like": "%Art%"}},
+  "include": [
+    {
+      "relation": "category",
+      "scope": {
+        "where": {
+          "name": "Programming"
+        }
+      },
+      "required": true // 👈
+    }
+  ]
+}
+```
+
+<!-- tutorial-end -->
+
+## Debug strings reference
+
+There are three built-in debug strings available in this extension to aid in
+debugging. To learn more about how to use them, see
+[this page](https://loopback.io/doc/en/lb4/Setting-debug-strings.html).
+
+<table>
+  <tbody>
+    <tr>
+      <th>String</th>
+      <th>Description</th>
+    </tr>
+    <tr>
+      <th colspan="2">Datasource</th>
+    </tr>
+    <tr>
+      <td>loopback:sequelize:datasource</td>
+      <td>Database Connections logs</td>
+    </tr>
+    <tr>
+      <td>loopback:sequelize:queries</td>
+      <td>Logs Executed SQL Queries and Parameters</td>
+    </tr>
+    <tr>
+      <th colspan="2">Repository</th>
+    </tr>
+    <tr>
+      <td>loopback:sequelize:modelbuilder</td>
+      <td>Logs Translation of Loopback Models Into Sequelize Supported Definitions. Helpful When Debugging Datatype Issues</td>
+    </tr>
+  </tbody>
+</table>
+
+## Limitations
+
+Please note, the current implementation does not support the following:
+
+1. SQL Transactions.
+2. Loopback Migrations (via default `migrate.ts`). Though you're good if using
+   external packages like
+   [`db-migrate`](https://www.npmjs.com/package/db-migrate).
+3. Connection Pooling is not implemented yet.
+
+Community contribution is welcome.
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+[MIT](https://github.com/loopbackio/loopback-next/blob/master/LICENSE)