@jsenv/https-local 2.1.0 → 3.0.0

package/README.md

@@ -61,13 +61,13 @@ node ./install_certificate_authority.mjs
  *
  * > node ./install_certificate_authority.mjs
  *
- * Read more in https://github.com/jsenv/https-local#requestCertificateForLocalhost
+ * Read more in https://github.com/jsenv/https-local#requestCertificate
  */
 
 import { createServer } from "node:https"
-import { requestCertificateForLocalhost } from "@jsenv/https-local"
+import { requestCertificate } from "@jsenv/https-local"
 
-const { certificate, privateKey } = requestCertificateForLocalhost()
+const { certificate, privateKey } = requestCertificate()
 
 const server = createServer(
   {
@@ -99,10 +99,10 @@ The rest of the documentation goes into details.
 
 # Certificate expiration
 
-| Certificate | Expires after | How to renew?                           |
-| ----------- | ------------- | --------------------------------------- |
-| server      | 1 year        | Re-run _requestCertificateForLocalhost_ |
-| authority   | 20 year       | Re-run _installCertificateAuthority_    |
+| Certificate | Expires after | How to renew?                        |
+| ----------- | ------------- | ------------------------------------ |
+| server      | 1 year        | Re-run _requestCertificate_          |
+| authority   | 20 year       | Re-run _installCertificateAuthority_ |
 
 The **server** certificate expires after one year which is the maximum duration allowed by web browsers. In the unlikely scenario where your local server is running for more than a year without interruption, restart it and you're good for one more year.
 
@@ -352,15 +352,15 @@ Check if certificate is trusted by firefox...
 
 </details>
 
-# requestCertificateForLocalhost
+# requestCertificate
 
-_requestCertificateForLocalhost_ function returns a certificate and private key that can be used to start a server in HTTPS.
+_requestCertificate_ function returns a certificate and private key that can be used to start a server in HTTPS.
 
 ```js
 import { createServer } from "node:https"
-import { requestCertificateForLocalhost } from "@jsenv/https-local"
+import { requestCertificate } from "@jsenv/https-local"
 
-const { certificate, privateKey } = requestCertificateForLocalhost({
+const { certificate, privateKey } = requestCertificate({
   altNames: ["localhost", "local.example"],
 })
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/https-local",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "A programmatic way to generate locally trusted certificates",
   "license": "MIT",
   "author": {
@@ -13,8 +13,7 @@
     "url": "https://github.com/jsenv/https-local"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "engines": {
     "node": ">=16.13.0"
@@ -48,9 +47,9 @@
     "playwright-install": "npx playwright install-deps && npx playwright install"
   },
   "dependencies": {
-    "@jsenv/filesystem": "4.1.0",
-    "@jsenv/log": "2.0.1",
-    "@jsenv/urls": "1.2.6",
+    "@jsenv/filesystem": "4.1.2",
+    "@jsenv/log": "3.1.0",
+    "@jsenv/urls": "1.2.7",
     "command-exists": "1.2.9",
     "node-forge": "1.3.1",
     "sudo-prompt": "9.2.1",
@@ -58,15 +57,15 @@
   },
   "devDependencies": {
     "@jsenv/assert": "2.6.0",
-    "@jsenv/core": "27.0.0-alpha.92",
-    "@jsenv/eslint-config": "16.0.9",
+    "@jsenv/core": "28.0.2",
+    "@jsenv/eslint-config": "16.2.1",
     "@jsenv/eslint-import-resolver": "0.3.0",
-    "@jsenv/github-release-package": "1.4.0",
-    "@jsenv/package-publish": "1.7.5",
+    "@jsenv/github-release-package": "1.5.0",
+    "@jsenv/package-publish": "1.10.0",
     "@jsenv/performance-impact": "2.3.0",
-    "eslint": "8.18.0",
+    "eslint": "8.21.0",
     "eslint-plugin-import": "2.26.0",
-    "playwright": "1.22.2",
+    "playwright": "1.24.2",
     "prettier": "2.7.1"
   }
-}
+}

package/src/{certificate_for_localhost.js → certificate_request.js}

@@ -11,7 +11,7 @@ import { getAuthorityFileInfos } from "./internal/authority_file_infos.js"
 import { requestCertificateFromAuthority } from "./internal/certificate_generator.js"
 import { formatDuration } from "./internal/validity_formatting.js"
 
-export const requestCertificateForLocalhost = ({
+export const requestCertificate = ({
   logLevel,
   logger = createLogger({ logLevel }), // to be able to catch logs during unit tests
 
@@ -47,7 +47,7 @@ export const requestCertificateForLocalhost = ({
   } = getAuthorityFileInfos()
   if (!rootCertificateFileInfo.exists) {
     throw new Error(
-      `Certificate authority not found, "installCertificateAuthority" must be called before "requestCertificateForLocalhost"`,
+      `Certificate authority not found, "installCertificateAuthority" must be called before "requestServerCertificate"`,
     )
   }
   if (!rootCertificatePrivateKeyFileInfo.exists) {
@@ -81,10 +81,6 @@ export const requestCertificateForLocalhost = ({
     JSON.stringify({ serialNumber: serverCertificateSerialNumber }, null, "  "),
   )
 
-  if (!altNames.includes("localhost")) {
-    altNames.push("localhost")
-  }
-
   logger.debug(`Generating server certificate...`)
   const { certificateForgeObject, certificatePrivateKeyForgeObject } =
     requestCertificateFromAuthority({

package/src/main.js

@@ -16,4 +16,4 @@ export {
 
 export { verifyHostsFile } from "./hosts_file_verif.js"
 
-export { requestCertificateForLocalhost } from "./certificate_for_localhost.js"
+export { requestCertificate } from "./certificate_request.js"