@small-tech/https 6.0.0 → 6.1.0

package/index.d.ts

@@ -0,0 +1,62 @@
+import {
+  ClientRequest,
+  IncomingMessage,
+  ServerResponse,
+  RequestListener,
+} from "node:http"
+import { RequestOptions, Server, ServerOptions } from "node:https"
+import EventEmitter from "node:events"
+import { AutoEncryptedLocalhostServer } from "@small-tech/auto-encrypt-localhost"
+import { AutoEncryptedServer, AutoEncryptOptions, IPAddresses } from "@small-tech/auto-encrypt"
+
+export { IPAddresses }
+
+export class Events extends EventEmitter {
+  CREATING_SERVER: symbol
+  SERVER_CREATED: symbol
+  SERVER_CLOSED: symbol
+}
+
+export const events: Events
+export const SMALL_TECH_HOME_PATH: string
+export const DEFAULT_SETTINGS_PATH: string
+
+export type SmallTechHttpsOptions = AutoEncryptOptions & {
+  staging?: boolean
+}
+
+export function request(
+  options: RequestOptions | string | URL,
+  callback?: (res: IncomingMessage) => void
+): ClientRequest
+
+export function request(
+  url: string | URL,
+  options: RequestOptions,
+  callback?: (res: IncomingMessage) => void
+): ClientRequest
+
+
+declare const _default: typeof import("node:https") & {
+  createServer: typeof createServer
+  request: typeof request
+}
+
+declare class https {
+  static async createServer<
+    Request extends typeof IncomingMessage = typeof IncomingMessage,
+    Response extends typeof ServerResponse = typeof ServerResponse
+  >(
+    requestListener?: RequestListener<Request, Response>
+  ): Promise<AutoEncryptedLocalhostServer> | Promise<AutoEncryptedServer>
+
+  static async createServer<
+    Request extends typeof IncomingMessage = typeof IncomingMessage,
+    Response extends typeof ServerResponse = typeof ServerResponse
+  >(
+    options: SmallTechHttpsOptions,
+    requestListener?: RequestListener<Request, Response>
+  ): Promise<AutoEncryptedLocalhostServer> | Promise<AutoEncryptedServer>
+}
+
+export default https

package/index.js

@@ -1,9 +1,17 @@
+/**
+  @small-tech/https
+
+  Provides isomorphic access to Auto Encryt and Auto Encrypt Localhost, creating the correct server (localhost using local certificate authority or globally-reachable using Let’s Encrypt TLS certificates).
+
+  Copyright ⓒ 2019-present Aral Balkan, Small Technology Foundation
+*/
 import os from 'node:os'
 import process from 'node:process'
 import path from 'node:path'
 import EventEmitter from 'node:events'
 
 import AutoEncrypt from '@small-tech/auto-encrypt'
+export { IPAddresses } from '@small-tech/auto-encrypt'
 import AutoEncryptLocalhost from '@small-tech/auto-encrypt-localhost'
 
 class Events extends EventEmitter {
@@ -38,7 +46,7 @@ export default class https {
   static async createServer (options = {}, listener) {
       // There can be only server per node process. Enforce that here.
       if (this.server !== null) {
-        console.warn('Create server called when server already exists for this process. Returning existing server instance.')
+        console.warn('Create server called when server already exists for this process. This is likely a coding error. Returning existing server instance.')
         return this.server
       }
       
@@ -49,8 +57,13 @@ export default class https {
       }
 
       const localDomains = ['localhost', 'place1.localhost', 'place2.localhost', 'place3.localhost', 'place4.localhost']
-      const isLocal = (options.domains == undefined || options.domains.some(domain => localDomains.includes(domain))) && !options.ipv4 && !options.ipv6 && !options.ipOnly
+      const domainsListDoestExistOrIncludesALocalDomain = options.domains == undefined || options.domains.some(domain => localDomains.includes(domain))
+      const automaticIPAddressDetectionRequested = options.ipv4 || options.ipv6
+
+      const isLocal = domainsListDoestExistOrIncludesALocalDomain && !automaticIPAddressDetectionRequested
+
       const serverScope =  isLocal ? 'local' : 'global'
+
       const settingsPath = options.settingsPath ? path.join(path.resolve(options.settingsPath), serverScope) : path.join(DEFAULT_SETTINGS_PATH, serverScope)
       options.settingsPath = settingsPath
 

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@small-tech/https",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "description": "A drop-in standard Node.js HTTPS module replacement with both automatic development-time (localhost) certificates via Auto Encrypt Localhost and automatic production certificates via Auto Encrypt.",
   "main": "index.js",
   "files": [
-    "lib"
+    "lib",
+    "index.d.ts"
   ],
   "type": "module",
+  "types": "index.d.ts",
   "engines": {
     "node": ">=18.20.0"
   },
@@ -49,7 +51,7 @@
   },
   "license": "AGPL-3.0",
   "dependencies": {
-    "@small-tech/auto-encrypt": "^5.0.0",
+    "@small-tech/auto-encrypt": "^5.1.0",
     "@small-tech/auto-encrypt-localhost": "^10.0.0"
   },
   "devDependencies": {