npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ui5-middleware-route-proxy

v1.0.10

Published

UI5tooling middleware route proxy

Downloads

1,282

Readme

UI5 proxy middleware using routes

Middleware for ui5-server, enabling proxy support.

Install

npm install ui5-middleware-route-proxy --save-dev

Configuration options (in $yourapp/ui5.yaml)

  • debug: boolean enable logging
  • root directory of the request uri: object used to match and forward requests to your server. Needs to include the leading slash character (/).
    • target: string hostname of your backend server
    • replacePath: string optional. If the request path needs to be modified by taking out the root directory uri
    • auth: object authorization object with username and password ( pass false if authorization is not required )
      • user: string
      • pass: string
      • client: string optional. If the client is not the default client on the SAP system
      • header: string optional. Is used as value for the Authorization header if available. user and pass values are not used in this case.
    • changeOrigin: boolean optional. If provided, the value will be added to the options of the http-proxy.

Each boolean or string field in a root path object can either represent the actual value or the name of a parameter in a .env file.

Example:

      debug: true
      /sap: 
        target: http(s)://host:port
        replacePath: true
        auth:
          user: Username
          pass: Password!
          client: '100' 

Example with target/user/pass in .env file:

      debug: true
      /sap: 
        target: PROXY_TARGET
        auth:
          user: PROXY_USERNAME
          pass: PROXY_PASSWORD
          client: PROXY_CLIENT

Example with target and dedicated Authorization header in .env file:

      debug: true
      /sap: 
        target: PROXY_TARGET
        auth:
          header: PROXY_AUTHORIZATION
        changeOrigin: true

Usage

  1. Define the dependency in $yourapp/package.json:
"devDependencies": {
    // ...
    "ui5-middleware-route-proxy": "*"
    // ...
},
"ui5": {
  "dependencies": [
    // ...
    "ui5-middleware-route-proxy",
    // ...
  ]
}

As the devDependencies are not recognized by the UI5 tooling, they need to be listed in the ui5 > dependencies array. In addition, once using the ui5 > dependencies array you need to list all UI5 tooling relevant dependencies.

  1. configure it in $yourapp/ui5.yaml:
server:
  customMiddleware:
  - name: ui5-middleware-route-proxy
    afterMiddleware: compression
    configuration:
      debug: true
      /routeRootPath: 
        target: PROXY_TARGET
        auth:
          user: PROXY_USERNAME
          pass: PROXY_PASSWORD
  1. Add a .env file with your target, username and password for the proxy:
PROXY_TARGET=<http(s)://host:port>
PROXY_USERNAME=<username>
PROXY_PASSWORD=<password>