nikkei / node-http-helper

This package provides constants and utility for well known http values defined in various specs.

@nikkei/http-helper

This package provides constants and utility for well-known http values defined in various specs.

Design Goals

• ES Module support as Tier 1
  • This allows us tree shaking friendly.
• TypeScript friendly APIs
• Easy to replacement.
  • This does not aim to framework lock-in.
  • This allows to replace your codebase incrementally.
• Well documented for related specs

Not Goals

We'd like to keep this as a helper which you can replace easily. So we don't aim following goals.

• Comprehensive wrapper for some specific framework.
• Hard to migrate from/to this package.

node-http-helper's Issues

Support CommonJS import

A lot of Our internal projects still uses commonjs style and we want to use this in them.

To resolve this, we need to change this to a dual export package.

Implement `Sec-Fetch-Mode` header value

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Mode
• https://w3c.github.io/webappsec-fetch-metadata/#sec-fetch-mode-header
• https://fetch.spec.whatwg.org/#concept-request-mode

v0.10.1 is not published publicly

I think this is caused by here:

node-http-helper/.github/workflows/publish_package_to_npm.yaml

Line 22 in c763b64

- run: npm publish --workspace=packages/http-helper --access=restricted

We should change this to --access=public
https://docs.npmjs.com/cli/v7/commands/npm-access#details

Stop symbolic links to README/LICENSE

They was introduced in #53 to make the migration easy.
I think symbolic link is nice solution for migration but they are not work well with GitHub's UI. For example, GitHub cannot detect license style automatically and show it as that we license this repository under MIT License.

Ideally, we should copy (or generate?) them into packages/http-helper workspace by adding the step to our build process.

Add `Forwarded` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded

Add `DNT` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DNT

Setup CI for each of commits/PRs

Add items defined in trusted type spec to Content-Security-Policy related values

see:

• https://w3c.github.io/trusted-types/dist/spec/#enforcement-hdr
• https://w3c.github.io/trusted-types/dist/spec/#integration-with-content-security-policy

Add `Feature-Policy` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy

Add `Content-Disposition` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition

Implement `Sec-Fetch-Dest` header value

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Dest
• https://w3c.github.io/webappsec-fetch-metadata/#sec-fetch-dest-header
• https://fetch.spec.whatwg.org/#concept-request-destination
• https://fetch.spec.whatwg.org/#destination-table

Add `Transfer-Encoding` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Transfer-Encoding

unittest fails on the main branch

https://github.com/Nikkei/node-http-helper/runs/8010818359?check_suite_focus=true

npm run tests has been getting failure with no changes since when it's succeeded

Add `Expect-CT` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Expect-CT

Add `Alt-Svc` http header name constant

https://developer.mozilla.org/en-us/docs/Web/HTTP/Headers/Alt-Svc

Add User-Agent Client Hints headers

https://wicg.github.io/ua-client-hints/

Add Structured Field Values parser

Summary

Some http fields have Structured Field Values (e.g. Client Hints )

We should add functions to get parsed object for the values.

Specs

• https://www.rfc-editor.org/rfc/rfc8941.html

Reference implementations

• https://github.com/Jxck/structured-field-values

Implement `Sec-Fetch-User` header value

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-User
• https://w3c.github.io/webappsec-fetch-metadata/#sec-fetch-user-header

Update ESLint to v9

For a long term, we would like to upgrade ESLint to v9 but we need wait some related packages for it.

Improve README

`ETag` should be uppercase

node-http-helper/packages/http-helper/src/http_header_name.ts

Lines 214 to 218 in e525eb5

	/**
	* - https://www.rfc-editor.org/rfc/rfc9110.html#name-etag
	* - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
	*/
	export const ETag = 'etag';

This should be ETAG

Add `SourceMap` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/SourceMap

Add `Accept-Patch` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Patch

Add `Service-Worker-Navigation-Preload` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Service-Worker-Navigation-Preload

Add Structured Field Values builder

Related Issues

• #58

Implement helpers for W3C Trace Context spec

Motivation

1. Provide a function to manipulate their header simply.
2. At this moment, this does not aim for advanced use cases (in-production observability).
   • We would use some commercial products or a famous framework as an one-stop solution in the production.

Features

• header name: #184
• generate id
  • trace id
  • parent id
• simple builder function to create a value for traceparent header.

Specs

• Trace Context Level 2
• Trace Context Level (Latest Editors Draft)

Setup dependabot

Add `Referrer-Policy` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy

Enable ESLint

Implement `Sec-Fetch-Site` header value

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-Fetch-Site
• https://w3c.github.io/webappsec-fetch-metadata/#sec-fetch-site-header

Add `Timing-Allow-Origin` http header name constant

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Timing-Allow-Origin

Add http status code 429

Set up the pipeline to publish this package

Implement helpers for "HTTP Caching" field values

https://www.rfc-editor.org/rfc/rfc9111.html#name-field-definitions