which-url 0.0.6 → 0.0.7

package/README.md

@@ -160,6 +160,8 @@ Zero config — [portless](https://portless.sh) sets `PORTLESS_URL` and `which-u
 origin → https://myapp.localhost
 ```
 
+When sharing via Tailscale (`portless run --tailscale`), `PORTLESS_TAILSCALE_URL` takes priority so `origin` returns the publicly-reachable URL.
+
 ### Tunnels (ngrok, Cloudflare Tunnel)
 
 Tunnel URLs can't be auto-detected — they're external to the app process. Set `APP_URL`:
@@ -182,10 +184,13 @@ Modern wrangler polyfills `process.env` from `[vars]`, so `which-url` picks it u
 ### Debugging
 
 ```typescript
-import { debug } from 'which-url'
+import appUrl from 'which-url'
 
-console.log(debug)
-// "platform=vercel | source=provider | url=https://myapp.com | env=production"
+console.log(appUrl.debug)
+// "[provider:vercel] url=myapp.com | env=production (vercel:production)"
+// "[override] APP_URL=https://custom.com | env=production (NODE_ENV=production)"
+// "[portless] PORTLESS_URL=https://myapp.localhost | env=local (NODE_ENV=development)"
+// "[fallback] PORT=3004 | env=local (NODE_ENV=development)"
 ```
 
 ## API
@@ -206,8 +211,9 @@ An object with URL properties and environment helpers.
 | `port` | `string` | `""` or `"3000"` |
 | `env` | `AppEnv` | `"production"` \| `"preview"` \| `"local"` |
 | `platform` | `Platform` | `"vercel"` \| `"netlify"` \| ... \| `null` |
-| `source` | `Source` | `"override"` \| `"provider"` \| `"browser"` \| `"fallback"` \| `null` |
-| `debug` | `string` | `"platform=vercel \| source=provider \| url=https://myapp.com \| env=production"` |
+| `debug`* | `string` | `"[provider:vercel] url=myapp.com \| env=production (vercel:production)"` |
+
+\* `debug` is non-enumerable — excluded from `JSON.stringify` to avoid React hydration mismatches. Access via `appUrl.debug`.
 | `isProduction` | `boolean` | |
 | `isPreview` | `boolean` | |
 | `isLocal` | `boolean` | |

package/dist/env-var.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"env-var.d.ts","sourceRoot":"","sources":["../src/env-var.ts"],"names":[],"mappings":"AAgGA;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CA0BpB;AAED,wBAAgB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAK3D"}
+{"version":3,"file":"env-var.d.ts","sourceRoot":"","sources":["../src/env-var.ts"],"names":[],"mappings":"AAkGA;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EACvC,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CA4BpB;AAED,wBAAgB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAK3D"}

package/dist/index.d.ts

@@ -1,16 +1,40 @@
-import type { WhichUrl, AppEnv, Platform } from "./types";
-declare let _resolved: WhichUrl;
+import type { WhichUrlWithDebug, AppEnv, Platform } from "./types";
+declare let _resolved: WhichUrlWithDebug;
+/** Full URL including protocol — `"https://myapp.com"` */
 export declare const href: string;
+/** Full origin — `"https://myapp.com"` (same as href) */
 export declare const origin: string;
+/** Hostname without port — `"myapp.com"` */
 export declare const hostname: string;
+/** Hostname with port — `"myapp.com"` or `"localhost:3000"` */
 export declare const host: string;
+/** Protocol with colon — `"https:"` or `"http:"` */
 export declare const protocol: string;
+/** Port string — `""` for default ports, `"3000"` for custom */
 export declare const port: string;
+/** Current environment — `"production"`, `"preview"`, or `"local"` */
 export declare const env: AppEnv;
+/** Detected hosting platform — `"vercel"`, `"netlify"`, etc. or `null` */
 export declare const platform: Platform;
+/** `true` when running in production */
 export declare const isProduction: boolean;
+/** `true` when running in a preview/staging deployment */
 export declare const isPreview: boolean;
+/** `true` when running locally (development) */
 export declare const isLocal: boolean;
+/**
+ * Auto-detected app URL with environment metadata.
+ *
+ * @example
+ * ```ts
+ * import appUrl from 'which-url'
+ *
+ * appUrl.origin      // "https://myapp.com"
+ * appUrl.env         // "production"
+ * appUrl.platform    // "vercel"
+ * appUrl.debug       // "[provider:vercel] url=myapp.com | env=production (vercel:production)"
+ * ```
+ */
 export default _resolved;
-export type { WhichUrl, AppEnv, Platform };
+export type { WhichUrl, WhichUrlWithDebug, AppEnv, Platform, PlatformName } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAqCzD,QAAA,IAAI,SAAS,EAAE,QAAQ,CAAA;AA8BvB,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,eAAO,MAAM,MAAM,EAAE,MAAyB,CAAA;AAC9C,eAAO,MAAM,QAAQ,EAAE,MAA2B,CAAA;AAClD,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,eAAO,MAAM,QAAQ,EAAE,MAA2B,CAAA;AAClD,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,eAAO,MAAM,GAAG,EAAE,MAAsB,CAAA;AACxC,eAAO,MAAM,QAAQ,EAAE,QAA6B,CAAA;AACpD,eAAO,MAAM,YAAY,EAAE,OAAgC,CAAA;AAC3D,eAAO,MAAM,SAAS,EAAE,OAA6B,CAAA;AACrD,eAAO,MAAM,OAAO,EAAE,OAA2B,CAAA;AAGjD,eAAe,SAAS,CAAA;AAExB,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAqClE,QAAA,IAAI,SAAS,EAAE,iBAAiB,CAAA;AA6BhC,0DAA0D;AAC1D,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,yDAAyD;AACzD,eAAO,MAAM,MAAM,EAAE,MAAyB,CAAA;AAC9C,4CAA4C;AAC5C,eAAO,MAAM,QAAQ,EAAE,MAA2B,CAAA;AAClD,+DAA+D;AAC/D,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,oDAAoD;AACpD,eAAO,MAAM,QAAQ,EAAE,MAA2B,CAAA;AAClD,gEAAgE;AAChE,eAAO,MAAM,IAAI,EAAE,MAAuB,CAAA;AAC1C,sEAAsE;AACtE,eAAO,MAAM,GAAG,EAAE,MAAsB,CAAA;AACxC,0EAA0E;AAC1E,eAAO,MAAM,QAAQ,EAAE,QAA6B,CAAA;AACpD,wCAAwC;AACxC,eAAO,MAAM,YAAY,EAAE,OAAgC,CAAA;AAC3D,0DAA0D;AAC1D,eAAO,MAAM,SAAS,EAAE,OAA6B,CAAA;AACrD,gDAAgD;AAChD,eAAO,MAAM,OAAO,EAAE,OAA2B,CAAA;AAEjD;;;;;;;;;;;;GAYG;AACH,eAAe,SAAS,CAAA;AAExB,YAAY,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -1,4 +1,12 @@
 // src/env-var.ts
+var ENV_VARS = [
+  "VERCEL_ENV",
+  "VERCEL_URL",
+  "VERCEL_BRANCH_URL",
+  "VERCEL_PROJECT_PRODUCTION_URL",
+  "APP_URL",
+  "APP_ENV"
+];
 function readStatic(name) {
   switch (name) {
     case "VERCEL_ENV":
@@ -13,13 +21,17 @@ function readStatic(name) {
       return process.env.APP_URL || process.env.NEXT_PUBLIC_APP_URL || process.env.NUXT_ENV_APP_URL || process.env.VITE_APP_URL || process.env.PUBLIC_APP_URL || process.env.REACT_APP_APP_URL || process.env.GATSBY_APP_URL || process.env.VUE_APP_APP_URL || process.env.REDWOOD_ENV_APP_URL || process.env.SANITY_STUDIO_APP_URL || undefined;
     case "APP_ENV":
       return process.env.APP_ENV || process.env.NEXT_PUBLIC_APP_ENV || process.env.NUXT_ENV_APP_ENV || process.env.VITE_APP_ENV || process.env.PUBLIC_APP_ENV || process.env.REACT_APP_APP_ENV || process.env.GATSBY_APP_ENV || process.env.VUE_APP_APP_ENV || process.env.REDWOOD_ENV_APP_ENV || process.env.SANITY_STUDIO_APP_ENV || undefined;
+    default:
+      return;
   }
 }
 function getVar(env, name) {
   if (typeof process !== "undefined" && process?.env && env === process.env) {
-    const val = readStatic(name);
-    if (val)
-      return val;
+    if (ENV_VARS.includes(name)) {
+      const val = readStatic(name);
+      if (val)
+        return val;
+    }
   }
   const PREFIXES = [
     "",
@@ -149,8 +161,12 @@ function resolveUrl() {
   const override = getVar(env, "APP_URL");
   if (override)
     return { url: normalizeUrl(override), debugLabel: `[override] APP_URL=${override}` };
-  if (env.PORTLESS_URL)
+  if (env.PORTLESS_TAILSCALE_URL) {
+    return { url: env.PORTLESS_TAILSCALE_URL, debugLabel: `[portless:tailscale] PORTLESS_TAILSCALE_URL=${env.PORTLESS_TAILSCALE_URL}` };
+  }
+  if (env.PORTLESS_URL) {
     return { url: env.PORTLESS_URL, debugLabel: `[portless] PORTLESS_URL=${env.PORTLESS_URL}` };
+  }
   for (const p of providers) {
     if (p.detect(env)) {
       const url = p.resolveUrl(env);

package/dist/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,UAAU,IAAI,aAAa,CAkC1C;AAED,wBAAgB,eAAe,IAAI,QAAQ,CAQ1C"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,UAAU,IAAI,aAAa,CAuC1C;AAED,wBAAgB,eAAe,IAAI,QAAQ,CAQ1C"}

package/dist/types.d.ts

@@ -1,21 +1,36 @@
 export type AppEnv = "production" | "preview" | "local";
-export type Platform = "vercel" | "netlify" | "cloudflare" | "railway" | "fly" | "render" | "digitalocean" | "heroku" | null;
+export type PlatformName = "vercel" | "netlify" | "cloudflare" | "railway" | "fly" | "render" | "digitalocean" | "heroku";
+export type Platform = PlatformName | null;
 export interface WhichUrl {
-    href: string;
-    origin: string;
-    hostname: string;
-    host: string;
-    protocol: string;
-    port: string;
-    env: AppEnv;
-    platform: Platform;
-    debug: string;
-    isProduction: boolean;
-    isPreview: boolean;
-    isLocal: boolean;
+    /** Full URL including protocol — `"https://myapp.com"` */
+    readonly href: string;
+    /** Full origin — `"https://myapp.com"` (same as href) */
+    readonly origin: string;
+    /** Hostname without port — `"myapp.com"` */
+    readonly hostname: string;
+    /** Hostname with port — `"myapp.com"` or `"localhost:3000"` */
+    readonly host: string;
+    /** Protocol with colon — `"https:"` or `"http:"` */
+    readonly protocol: string;
+    /** Port string — `""` for default ports, `"3000"` for custom */
+    readonly port: string;
+    /** Current environment — `"production"`, `"preview"`, or `"local"` */
+    readonly env: AppEnv;
+    /** Detected hosting platform — `"vercel"`, `"netlify"`, etc. or `null` */
+    readonly platform: Platform;
+    /** `true` when running in production */
+    readonly isProduction: boolean;
+    /** `true` when running in a preview/staging deployment */
+    readonly isPreview: boolean;
+    /** `true` when running locally (development) */
+    readonly isLocal: boolean;
+}
+export interface WhichUrlWithDebug extends WhichUrl {
+    /** Resolution debug string (non-enumerable — excluded from JSON.stringify and object spread). */
+    readonly debug: string;
 }
 export interface ProviderDetector {
-    name: string;
+    name: PlatformName;
     detect: (env: Record<string, string | undefined>) => boolean;
     resolveUrl: (env: Record<string, string | undefined>) => string | null;
     resolveEnv: (env: Record<string, string | undefined>) => AppEnv;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;AAEvD,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,SAAS,GACT,YAAY,GACZ,SAAS,GACT,KAAK,GACL,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,IAAI,CAAA;AAER,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,OAAO,CAAA;IACrB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,OAAO,CAAA;IAC5D,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,MAAM,GAAG,IAAI,CAAA;IACtE,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,MAAM,CAAA;CAChE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,CAAA;AAEvD,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,SAAS,GACT,YAAY,GACZ,SAAS,GACT,KAAK,GACL,QAAQ,GACR,cAAc,GACd,QAAQ,CAAA;AAEZ,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAA;AAE1C,MAAM,WAAW,QAAQ;IACvB,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,yDAAyD;IACzD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,4CAA4C;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,oDAAoD;IACpD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,sEAAsE;IACtE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,0EAA0E;IAC1E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;IAC3B,gDAAgD;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD,iGAAiG;IACjG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,YAAY,CAAA;IAClB,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,OAAO,CAAA;IAC5D,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,MAAM,GAAG,IAAI,CAAA;IACtE,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,KAAK,MAAM,CAAA;CAChE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "which-url",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Auto-detect your app's URL across hosting providers. Zero config.",
   "type": "module",
   "exports": {