Added typescript definitions

Author: perki

nodejs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backloop.dev",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "Local HTTPS development with *.backloop.dev pointing to localhost and SSL certificates",
   "keywords": [
     "SSL",
@@ -28,12 +28,14 @@
   "author": "Perki (https://backloop.dev)",
   "exports": {
     ".": {
+      "types": "./src/index.d.ts",
       "import": "./src/index.mjs",
       "require": "./src/index.js"
     }
   },
   "main": "src/index.js",
   "module": "src/index.mjs",
+  "types": "src/index.d.ts",
   "bin": {
     "backloop.dev": "bin/webserver.js",
     "backloop.dev-proxy": "bin/proxy.js",

nodejs/src/index.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/perki/backloop.dev/blob/main/LICENSE)
+ */
+
+/**
+ * HTTPS options for use with Node.js https.createServer()
+ */
+export interface HttpsOptions {
+  /** Private key in PEM format */
+  key: string;
+  /** Certificate in PEM format */
+  cert: string;
+  /** Certificate Authority chain in PEM format */
+  ca: string;
+}
+
+/**
+ * Callback for httpsOptionsAsync
+ */
+export type HttpsOptionsCallback = (error: Error | null, options?: HttpsOptions) => void;
+
+/**
+ * Synchronously returns HTTPS options for backloop.dev certificates.
+ * If certificates are missing or expired, attempts an automatic update
+ * and exits the process.
+ *
+ * @returns HTTPS options object with key, cert, and ca properties
+ *
+ * @example
+ * ```js
+ * const https = require('https');
+ * const { httpsOptions } = require('backloop.dev');
+ *
+ * https.createServer(httpsOptions(), app).listen(443);
+ * ```
+ */
+export function httpsOptions(): HttpsOptions;
+
+/**
+ * Asynchronously retrieves HTTPS options using a callback.
+ * Updates certificates if needed before returning.
+ *
+ * @param done - Callback called with (error, options)
+ *
+ * @example
+ * ```js
+ * const { httpsOptionsAsync } = require('backloop.dev');
+ *
+ * httpsOptionsAsync((err, options) => {
+ *   if (err) throw err;
+ *   https.createServer(options, app).listen(443);
+ * });
+ * ```
+ */
+export function httpsOptionsAsync(done: HttpsOptionsCallback): void;
+
+/**
+ * Asynchronously retrieves HTTPS options using a Promise.
+ * Updates certificates if needed before returning.
+ *
+ * @returns Promise resolving to HTTPS options
+ *
+ * @example
+ * ```js
+ * const { httpsOptionsPromise } = require('backloop.dev');
+ *
+ * const options = await httpsOptionsPromise();
+ * https.createServer(options, app).listen(443);
+ * ```
+ */
+export function httpsOptionsPromise(): Promise<HttpsOptions>;

vitejs/index.d.ts

@@ -1,6 +1,13 @@
-export default backloop;
+/**
+ * Vite plugin for backloop.dev HTTPS local development
+ * @param hostname - Subdomain to use (e.g., 'myapp' becomes myapp.backloop.dev)
+ * @param port - Optional port number for the dev server
+ * @returns Vite plugin configuration
+ */
 declare function backloop(hostname?: string, port?: number): {
-    name: string;
-    apply: ConfigEnv;
-    config(options: UserConfigExport): void;
-};
+  name: string;
+  apply: 'serve';
+  config(config: Record<string, unknown>): void;
+};
+
+export default backloop;