@loopback/docs 8.0.3 → 8.0.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.4](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@8.0.3...@loopback/docs@8.0.4) (2025-07-15)
+
+**Note:** Version bump only for package @loopback/docs
+
+
+
+
+
 ## [8.0.3](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@8.0.2...@loopback/docs@8.0.3) (2025-06-13)
 
 **Note:** Version bump only for package @loopback/docs

package/ROADMAP.md

@@ -174,7 +174,6 @@ Includes migrating Useful LB3 Documentation to LB4.
 #### LB4 adoption
 
 - Articles/materials that can help more users adopting LoopBack 4
-
   - write an article about what LB can offer on top of Express #4852
   - Write an article/docs on "from API to UI: LoopBack + Angular" - using client
     generator #4849

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loopback/docs",
   "description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
-  "version": "8.0.3",
+  "version": "8.0.4",
   "keywords": [
     "LoopBack",
     "docs"
@@ -36,7 +36,7 @@
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@loopback/build": "^12.0.1"
+    "@loopback/build": "^12.0.2"
   },
-  "gitHead": "cb51b4297e6f1c6aadc6492ba2a7c8c3ac4867c7"
+  "gitHead": "c2a3c1ada086e3abd6ea195ec8f70ce5a63c924c"
 }

package/site/Application-generator.md

@@ -68,7 +68,6 @@ The tool will prompt you for:
 - Optional modules to add to the application. These modules are helpful tools to
   help format, test, and build a LoopBack4 application. Defaults to `true` for
   all of the modules. The prompted modules are:
-
   - [`eslint`](https://www.npmjs.com/package/eslint)
   - [`prettier`](https://www.npmjs.com/package/prettier)
   - [`mocha`](https://www.npmjs.com/package/mocha)

package/site/Appsody-LoopBack.md

@@ -904,7 +904,6 @@ terminal window opened in your project directory. In our case, this is the
     ![lb4appsody_template_webpage_cloud_1.png](./imgs/lb4appsody_template_webpage_cloud_1.png)
 
     As mentioned earlier, all these endpoints are available:
-
     - Application endpoint: /
     - API explorer: /explorer
     - Open API Spec: /openapi.json

package/site/Binding.md

@@ -532,7 +532,6 @@ reqCtx.scope = BindingScope.REQUEST;
     ```
 
     The owner context for the code snippet above will be:
-
     - 'foo.app': appCtx
     - 'foo.server': serverCtx
 
@@ -560,7 +559,6 @@ reqCtx.scope = BindingScope.REQUEST;
     ancestors recursively
 
     b. Use the scope of binding found to locate the resolution context:
-
     - Use the `current context` for `CONTEXT` and `TRANSIENT` scopes
     - Use the `owner context` for `SINGLETON` scope
     - Use the first context that matches the binding scope in the chain starting

package/site/Crafting-LoopBack-4.md

@@ -70,7 +70,6 @@ as:
 
 2.  Technical debt is accumulating, for example inconsistent designs across
     modules and feature flags for different behaviors. Here are a few examples:
-
     - Various modules use different registries to manage different types of
       artifacts, such as remoting metadata, models, datasources, and middleware.
     - Different flavors are used to allow custom logic to intercept
@@ -81,7 +80,6 @@ as:
 
 3.  It is becoming more difficult to add new features or fix bugs as some areas
     start to reach the limit of the current design.
-
     - The `loopback-datasource-juggler` module is a kitchen sink for many
       things, such as typing, data modeling, validation, aggregation,
       persistence, and service integration.
@@ -94,7 +92,6 @@ as:
     make code changes in LoopBack modules. The current version of LoopBack has
     ad-hoc extensibility at various layers. Extension points are not
     consistently defined. For example,
-
     - Use Express to register middleware.
     - Use remoting hooks to intercept remote method invocations.
     - Use CRUD hooks to add logic around CRUD operations.
@@ -149,7 +146,6 @@ generation of API creation platform. For more information, read the blog post
 LoopBack 4's goals are:
 
 1.  Catch up with latest and greatest technology advances.
-
     - Adopt [ES2016/2017](http://exploringjs.com/es2016-es2017/index.html) and
       [TypeScript](https://www.typescriptlang.org/) for ease of maintenance and
       productivity.
@@ -157,20 +153,17 @@ LoopBack 4's goals are:
       and [GraphQL](http://graphql.org/).
 
 2.  Promote extensibility to grow the ecosystem.
-
     - Build a minimal core and enable everything else to be implemented via
       extensions.
     - Open the door for more
       [extension points and extensions](https://github.com/loopbackio/loopback-next/issues/512).
 
 3.  Align with cloud native experience for microservices.
-
     - Adopt cloud native microservices by adopting initiatives such as
       [Cloud Native Computing Foundation](https://www.cncf.io/).
     - Make LoopBack a first-class citizen of the microservices ecosystem.
 
 4.  Remove the complexity and inconsistency across modules.
-
     - Use a consistent registry and APIs to manage artifacts and their
       dependencies.
     - Pay down technical debts by refactoring complex modules.
@@ -227,20 +220,16 @@ Here are the stages we are marching through toward the final version of LoopBack
 4 as illustrated below.
 
 1.  **Rebase and rewrite the core**
-
     - Leverage TypeScript for better code quality and productivity.
-
       - Provide optional type system for JavaScript.
       - Provide planned features from future JavaScript editions to current
         JavaScript engines.
 
     - Unify the asynchronous programming model/style.
-
       - 100% promise-based APIs.
       - Async/Await as first-class async programming style.
 
     - Implement an IoC Container for better visibility and extensibility
-
       - Universal registry across different modules
       - Dependency injection as a pattern to manage dependencies
 
@@ -249,11 +238,9 @@ Here are the stages we are marching through toward the final version of LoopBack
       - Component encapsulates a list of extensions as a whole
 
 2.  **Validate the core design by implementing an REST/HTTP invocation chain**
-
     - Add top-down REST API creation which starts with OpenAPI specs.
 
     - Build sequence of actions for inbound http processing
-
       - Introduce sequence as the composition of actions
       - Implement the most critical actions to fulfill the REST API routing and
         invocation
@@ -262,7 +249,6 @@ Here are the stages we are marching through toward the final version of LoopBack
 
       Models are the centerpieces of the current LoopBack applications. . They
       take multiple responsibilities:
-
       - Data modeling
       - Anchor for API related business logic
       - Persistence or service invocation
@@ -272,13 +258,11 @@ Here are the stages we are marching through toward the final version of LoopBack
 
       Implement the core functionality of authentication as a component, which
       includes:
-
       - Decorators to denote authentication requirement
       - `authenticate` action to handle authentication
       - Extension points for various authentication strategies
 
 3.  **Rebuild our integration and composition capabilities**
-
     - Introduce repositories to represent data access patterns such as CRUD or
       Key/Value stores
     - Provide a reference implementation of CRUD and KV flavors of repository
@@ -302,7 +286,6 @@ Here are the stages we are marching through toward the final version of LoopBack
     approach to describe these artifacts by code (apis and decorators), we would
     like to add declarative support so that they can be declared in JSON/YAML
     files.
-
     - Define a new domain-specific language (DSL) in JSON/YAML format and
       corresponding templates.
     - Define the project layout to organize project artifacts.
@@ -314,14 +297,12 @@ Here are the stages we are marching through toward the final version of LoopBack
       boot process can be tailored for both tooling and runtime.
 
 5.  **Tooling (CLI & UI)**
-
     - Add CLI and UI tools to:
       - Scaffold LoopBack 4 applications
       - Manage artifacts such as sequences, actions, controllers, repositories,
         services, datasources and models
 
 6.  **Enable cloud native experience**
-
     - Allow controllers to be exposed as gRPC services
     - Allow interaction with other gRPC services
     - Integration with microservices deployment infrastructure such as Docker
@@ -400,7 +381,6 @@ independent of the nature of such artifacts.
 
 - A consistent registry to provide visibility and addressability for all
   artifacts.
-
   - Visibility: Each artifact has a unique address and can be accessed via a URI
     or key. Artifacts can also be visible at different scopes.
 
@@ -410,13 +390,11 @@ independent of the nature of such artifacts.
     points/extensions decouples providers and consumers.
 
 - Ability to compose with dependency resolution.
-
   - Composability: It's common that one artifact to have dependencies on other
     artifacts. With dependency injection or service locator patterns, the core
     will greatly simplify how multiple artifacts work together.
 
 - A packaging model for extensions.
-
   - Pluggability: Extensions can be organized and contributed as a whole. We
     need to have a packaging model so that extension developers can create their
     own modules as bundles and plug into a LoopBack application.

package/site/Customizing-server-configuration.md

@@ -160,12 +160,10 @@ with the base path.
 The router can be configured to enforce `strict` mode as follows:
 
 1. `strict` is true:
-
    - request `/orders` matches route `/orders` but not `/orders/`
    - request `/orders/` matches route `/orders/` but not `/orders`
 
 2. `strict` is false (default)
-
    - request `/orders` matches route `/orders` first and falls back to
      `/orders/`
    - request `/orders/` matches route `/orders/` first and falls back to

package/site/DEVELOPING.md

@@ -387,7 +387,6 @@ two groups:
    blocks.
 
    Examples:
-
    - `@loopback/core` is re-exporting all public API provided by
      `@loopback/context`.
 
@@ -778,7 +777,6 @@ The script does the following steps:
 1. Determine the parentDir and package name.
 
    The first argument can be one of the following:
-
    - package-name
    - @loopback/package-name
    - extensions/package-name
@@ -792,7 +790,6 @@ and falls back to `extensions`.
    are skipped.
 
 3. Fix up the project
-
    - Remove unused files
    - Improve `package.json`
 
@@ -935,7 +932,6 @@ configuration, it's important to verify that all usage scenarios keep working.
     ```
 
 5.  Test integration with supported IDEs:
-
     - [Visual Studio Code](./Developing-with-vscode.md#how-to-verify-eslint-setup)
     - [WebStorm](./Developing-with-webstorm.md#how-to-verify-eslint-setup)
 

package/site/Developing-with-vscode.md

@@ -81,7 +81,6 @@ can e.g. rename `inject` to test.)
 
 2.  Verify that ESLint extension is not reporting any warnings in the output
     window:
-
     - pres _Cmd+shift+P_ or _Ctrl+shift+P_ to open task selector
     - find and run the task `ESLint: Show Output`
     - check the logs

package/site/Extension-generator.md

@@ -55,7 +55,6 @@ The tool will prompt you for:
 - Optional modules to add to the extension. These modules are helpful tools to
   help format, test, and build a LoopBack4 extension. Defaults to `true` for all
   of the modules. The prompted modules are:
-
   - [`eslint`](https://www.npmjs.com/package/eslint)
   - [`prettier`](https://www.npmjs.com/package/prettier)
   - [`mocha`](https://www.npmjs.com/package/mocha)

package/site/Inside-Loopback-Application.md

@@ -28,7 +28,6 @@ Once the API requirements are assessed,
 
 - LoopBack's features can be used to satisfy the requirements from different
   developers:
-
   - Front end designers:
 
     > Can create an `Online Shopping prototype` to try the UI experience by
@@ -74,7 +73,6 @@ mobile application is the same.
 Similar to this we can breakdown further use cases into API requirements.
 
 - `Shopping use cases`
-
   - User starts adding and removing items to the shopping cart.
   - If the user logs out the shopping cart is saved and re-loaded when the user
     logs in next time.

package/site/Interceptor.md

@@ -585,17 +585,14 @@ The `source` describes the caller that invokes a method with interceptors.
 Interceptors can be invoked in the following cases:
 
 1. A route to a controller method
-
    - The source describes the REST Route
 
 2. A controller to a repository/service with injected proxy
-
    - The source describes a ResolutionSession that tracks a stack of bindings
      and injections
 
 3. A controller/repository/service method invoked explicitly with
    `invokeMethodWithInterceptors()` or `invokeMethod`
-
    - The source can be set by the caller of `invokeMethodWithInterceptors()` or
      `invokeMethod`
 

package/site/Life-cycle.md

@@ -36,22 +36,18 @@ The state can transition as follows by operations including `boot`, `start`, and
 `stop`:
 
 1.  boot()
-
     - !booted -> booting -> booted
     - booting | booted -> booted (no-op)
 
 2.  init()
-
     - !initialized -> initializing -> initialized
     - initializing | initialized -> initialized (no-op)
 
 3.  start()
-
     - !started -> starting -> started
     - starting | started -> started (no-op)
 
 4.  stop()
-
     - started -> stopping -> stopped
     - stopping | !started -> stopped (no-op)
 
@@ -133,17 +129,14 @@ cycles and perform related processing upon `start` and `stop`. Good examples of
 such artifacts are:
 
 - Servers
-
   - start: Starts the HTTP server listening for connections.
   - stop: Stops the server from accepting new connections.
 
 - Components
-
   - A component itself can be a life cycle observer and it can also contribute
     life cycle observers
 
 - DataSources
-
   - connect: Connect to the underlying database or service
   - disconnect: Disconnect from the underlying database or service
 
@@ -277,7 +270,6 @@ First of all, we allow each of the life cycle observers to be tagged with a
 group. For example:
 
 - datasource (connect/disconnect)
-
   - mongodb
   - mysql
 

package/site/Middleware.md

@@ -42,7 +42,6 @@ Injection, as well as Extension Point and Extensions.
   add security protection middleware to our Sequence.
 
 - Embrace and adapt existing Express middleware modules with minimal effort
-
   - Run an explicit list of Express middleware handler functions
   - Support the factory and configuration pattern used by most Express
     middleware

package/site/Model-generator.md

@@ -41,7 +41,6 @@ The tool will prompt you for:
   been supplied with a valid model class name, the prompt is skipped. It will
   present you with a list of available models from `src/models` including the
   **Entity** and **Model** at the top of the list.
-
   - An **Entity** is a persisted model with an identity (ID).
   - A **Model** is a business domain object.
   - For more information, see

package/site/Preparing-the-API-for-consumption.shelved.md

@@ -76,18 +76,15 @@ Here is a sneak peek of what's coming:
   [loopback-next issue #559](https://github.com/loopbackio/loopback-next/issues/559)
 
 - Complete repository/service story for backend interactions
-
   - [loopback-next issue #419](https://github.com/loopbackio/loopback-next/issues/419)
   - [loopback-next issue #537](https://github.com/loopbackio/loopback-next/issues/537)
   - [loopback-next issue #522](https://github.com/loopbackio/loopback-next/issues/522)
 
 - Declarative support for various constructs
-
   - [loopback-next issue #441](https://github.com/loopbackio/loopback-next/issues/441)
   - [loopback-next issue #461](https://github.com/loopbackio/loopback-next/issues/461)
 
 - Alignment of microservices and cloud native experience
-
   - [loopback-next issue #442](https://github.com/loopbackio/loopback-next/issues/442)
   - [loopback-next issue #25](https://github.com/loopbackio/loopback-next/issues/25)
 

package/site/REST-middleware-sequence.md

@@ -138,7 +138,6 @@ responses. It typically includes the following logic.
 
 1.  Process the request from the server or upstream middleware with one of the
     following outcomes:
-
     - Reject the request by throwing an error if the request is invalid
 
       ```ts
@@ -174,7 +173,6 @@ responses. It typically includes the following logic.
 
 2.  Process the response from downstream middleware or the target operation with
     one the following outcomes:
-
     - Reject the response by throwing an error
 
       ```ts
@@ -262,7 +260,6 @@ The middleware for the sequence are executed in the order of groups in a
 cascading style. The order of groups is determined by two factors:
 
 1.  The relative order specified for a middleware binding.
-
     - upstreamGroups: An array of group names that should be upstream to this
       middleware
 

package/site/Relation-generator.md

@@ -133,7 +133,6 @@ The tool will prompt you for:
 - Relation type between models (`relationBaseClass`). Prompts a list of
   available relations to choose from as the type of the relation between the
   source model and the target model. Supported relation types:
-
   - [HasMany](HasMany-relation.md)
   - [HasManyThrough](HasManyThrough-relation.md)
   - [HasOne](HasOne-relation.md)
@@ -168,7 +167,6 @@ The tool will prompt you for:
 
 - Name of the relation (`relationName`). Prompts for the Source property name.
   Note: Leave blank to use the default. Default values:
-
   - plural form of `<targetModel>` for `hasMany` and `hasManyThrough` relations,
     e.g. `products`
   - singular form of `<targetModel>` for `hasOne` relations, e.g. `address`

package/site/apidocs/apiconnect.apiconnectbindings.md

@@ -44,4 +44,5 @@ Strongly-typed binding key for ApiConnectSpecEnhancer
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/apiconnect.apiconnectcomponent.md

@@ -61,4 +61,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/apiconnect.apiconnectspecenhancer._constructor_.md

@@ -70,4 +70,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/apiconnect.apiconnectspecenhancer.md

@@ -129,4 +129,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/apiconnect.apiconnectspecenhancer.modifyspec.md

@@ -52,6 +52,7 @@ OpenAPIObject
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 OpenAPIObject

package/site/apidocs/apiconnect.md

@@ -99,4 +99,5 @@ Configuration for IBM API Connect extensions to the OpenAPI spec
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtauthenticationcomponent._constructor_.md

@@ -54,4 +54,5 @@ app
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtauthenticationcomponent.md

@@ -95,4 +95,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtauthenticationstrategy._constructor_.md

@@ -54,4 +54,5 @@ tokenService
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtauthenticationstrategy.authenticate.md

@@ -52,6 +52,7 @@ Request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[UserProfile](./security.userprofile.md) \| undefined&gt;

package/site/apidocs/authentication-jwt.jwtauthenticationstrategy.extractcredentials.md

@@ -52,6 +52,7 @@ Request
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 string

package/site/apidocs/authentication-jwt.jwtauthenticationstrategy.md

@@ -156,4 +156,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtservice._constructor_.md

@@ -68,4 +68,5 @@ string
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtservice.generatetoken.md

@@ -52,6 +52,7 @@ userProfile
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;string&gt;

package/site/apidocs/authentication-jwt.jwtservice.md

@@ -97,4 +97,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.jwtservice.verifytoken.md

@@ -52,6 +52,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt;

package/site/apidocs/authentication-jwt.md

@@ -362,4 +362,5 @@ Describes the token object that returned by the refresh token service functions.
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.myuserservice._constructor_.md

@@ -54,4 +54,5 @@ userRepository
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.myuserservice.converttouserprofile.md

@@ -52,6 +52,7 @@ user
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [UserProfile](./security.userprofile.md)

package/site/apidocs/authentication-jwt.myuserservice.finduserbyid.md

@@ -52,6 +52,7 @@ string
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[User](./authentication-jwt.user.md) &amp; [UserWithRelations](./authentication-jwt.userwithrelations.md)<!-- -->&gt;

package/site/apidocs/authentication-jwt.myuserservice.md

@@ -151,4 +151,5 @@ Description
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.myuserservice.verifycredentials.md

@@ -52,6 +52,7 @@ credentials
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 Promise&lt;[User](./authentication-jwt.user.md)<!-- -->&gt;

package/site/apidocs/authentication-jwt.refreshtoken._constructor_.md

@@ -56,4 +56,5 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.refreshtoken.md

@@ -129,4 +129,5 @@ string
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.refreshtokenconstants.md

@@ -68,4 +68,5 @@ The default secret used when generating refresh token.
 
 </td></tr>
 </tbody></table>
+
 

package/site/apidocs/authentication-jwt.refreshtokenrepository._constructor_.md

@@ -54,4 +54,5 @@ juggler.DataSource
 
 </td></tr>
 </tbody></table>
+