@proveanything/smartlinks 1.0.45 → 1.0.47

package/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.0.45  |  Generated: 2025-11-22T17:29:38.790Z
+Version: 1.0.47  |  Generated: 2025-11-23T09:18:23.853Z
 
 This is a concise summary of all available API functions and types.
 
@@ -35,9 +35,17 @@ Core HTTP functions for API configuration and communication:
   apiKey?: string
   bearerToken?: string
   proxyMode?: boolean
+  ngrokSkipBrowserWarning?: boolean
+  extraHeaders?: Record<string, string>
 }) → `void`
 Call this once (e.g. at app startup) to configure baseURL/auth.
 
+**setNgrokSkipBrowserWarning**(flag: boolean) → `void`
+Enable/disable automatic "ngrok-skip-browser-warning" header.
+
+**setExtraHeaders**(headers: Record<string, string>) → `void`
+Replace or augment globally applied custom headers.
+
 **setBearerToken**(token: string | undefined) → `void`
 Allows setting the bearerToken at runtime (e.g. after login/logout).
 

package/README.md

@@ -21,16 +21,16 @@ npm install @proveanything/smartlinks
 
 ## Quick start
 
-Initialize once at app startup with your API base URL. You may provide the URL with or without a trailing slash – the SDK normalizes it. In Node, you can also provide an API key for server-to-server calls.
+Initialize once at app startup with your API base URL. Trailing slashes are optional (normalized). In Node, you can also provide an API key for server-to-server calls. You can enable an ngrok header or supply custom headers.
 
 ```ts
 import { initializeApi } from '@proveanything/smartlinks'
 
 initializeApi({
-  // Both forms are accepted; trailing slashes are stripped automatically:
-  // baseURL: 'https://smartlinks.app/api/v1/'
-  baseURL: 'https://smartlinks.app/api/v1',
-  // apiKey: process.env.SMARTLINKS_API_KEY, // Node/server only (optional)
+  baseURL: 'https://smartlinks.app/api/v1',            // or 'https://smartlinks.app/api/v1/'
+  // apiKey: process.env.SMARTLINKS_API_KEY,            // Node/server only (optional)
+  // ngrokSkipBrowserWarning: true,                    // adds 'ngrok-skip-browser-warning: true'
+  // extraHeaders: { 'X-Debug': '1' }                  // merged into every request
 })
 ```
 
@@ -55,7 +55,7 @@ Use the built-in helpers to log in and verify tokens. After a successful login,
 import { initializeApi } from '@proveanything/smartlinks'
 import { auth } from '@proveanything/smartlinks'
 
-initializeApi({ baseURL: 'https://smartlinks.app/api/v1/' }) // works (slash removed internally)
+initializeApi({ baseURL: 'https://smartlinks.app/api/v1/' }) // trailing slash OK
 
 // Email + password login (browser or Node)
 const user = await auth.login('user@example.com', 'password')
@@ -135,7 +135,7 @@ The SDK works in modern browsers. Initialize once and call public endpoints with
 import { initializeApi } from '@proveanything/smartlinks'
 import { collection } from '@proveanything/smartlinks'
 
-initializeApi({ baseURL: 'https://smartlinks.app/api/v1' }) // trailing slash optional
+initializeApi({ baseURL: 'https://smartlinks.app/api/v1' })
 const collections = await collection.list(false)
 ```
 
@@ -145,11 +145,16 @@ For a fuller UI example, see `examples/react-demo.tsx`.
 
 ```ts
 initializeApi({
-  baseURL: string, // Provide with or without trailing slash; SDK normalizes
+  baseURL: string, // with or without trailing slash
   apiKey?: string,      // Node/server only
   bearerToken?: string, // optional at init; set by auth.login/verifyToken
   proxyMode?: boolean   // set true if running inside an iframe and using parent proxy
+  ngrokSkipBrowserWarning?: boolean // forces header 'ngrok-skip-browser-warning: true'
+  extraHeaders?: Record<string,string> // custom headers merged in each request
 })
+
+// Auto-detection: If baseURL contains '.ngrok.io' or '.ngrok-free.dev' the header is added automatically
+// unless you explicitly set ngrokSkipBrowserWarning: false.
 ```
 
 When embedding the SDK in an iframe with `proxyMode: true`, you can also use:
@@ -157,6 +162,11 @@ When embedding the SDK in an iframe with `proxyMode: true`, you can also use:
 ```ts
 import { sendCustomProxyMessage } from '@proveanything/smartlinks'
 const data = await sendCustomProxyMessage('my-action', { foo: 'bar' })
+
+// Toggle ngrok header or update custom headers later:
+import { setNgrokSkipBrowserWarning, setExtraHeaders } from '@proveanything/smartlinks'
+setNgrokSkipBrowserWarning(true)
+setExtraHeaders({ 'X-Debug': '1' })
 ```
 
 ## Full API surface

package/dist/http.d.ts

@@ -12,7 +12,13 @@ export declare function initializeApi(options: {
     apiKey?: string;
     bearerToken?: string;
     proxyMode?: boolean;
+    ngrokSkipBrowserWarning?: boolean;
+    extraHeaders?: Record<string, string>;
 }): void;
+/** Enable/disable automatic "ngrok-skip-browser-warning" header. */
+export declare function setNgrokSkipBrowserWarning(flag: boolean): void;
+/** Replace or augment globally applied custom headers. */
+export declare function setExtraHeaders(headers: Record<string, string>): void;
 /**
  * Allows setting the bearerToken at runtime (e.g. after login/logout).
  */

package/dist/http.js

@@ -6,6 +6,8 @@ let baseURL = null;
 let apiKey = undefined;
 let bearerToken = undefined;
 let proxyMode = false;
+let ngrokSkipBrowserWarning = false;
+let extraHeadersGlobal = {};
 /**
  * Call this once (e.g. at app startup) to configure baseURL/auth.
  *
@@ -16,10 +18,26 @@ let proxyMode = false;
  * @property {boolean} [options.proxyMode] - (Optional) Tells the API that it is running in an iframe via parent proxy
  */
 export function initializeApi(options) {
-    baseURL = options.baseURL.replace(/\/+\$/, ""); // trim trailing slash
+    // Normalize baseURL by removing trailing slashes.
+    baseURL = options.baseURL.replace(/\/+$/g, "");
     apiKey = options.apiKey;
     bearerToken = options.bearerToken;
     proxyMode = !!options.proxyMode;
+    // Auto-enable ngrok skip header if domain contains .ngrok.io and user did not explicitly set the flag.
+    // Infer ngrok usage from common domains (.ngrok.io or .ngrok-free.dev)
+    const inferredNgrok = /(\.ngrok\.io|\.ngrok-free\.dev)(\b|\/)/i.test(baseURL);
+    ngrokSkipBrowserWarning = options.ngrokSkipBrowserWarning !== undefined
+        ? !!options.ngrokSkipBrowserWarning
+        : inferredNgrok;
+    extraHeadersGlobal = options.extraHeaders ? Object.assign({}, options.extraHeaders) : {};
+}
+/** Enable/disable automatic "ngrok-skip-browser-warning" header. */
+export function setNgrokSkipBrowserWarning(flag) {
+    ngrokSkipBrowserWarning = flag;
+}
+/** Replace or augment globally applied custom headers. */
+export function setExtraHeaders(headers) {
+    extraHeadersGlobal = Object.assign({}, headers);
 }
 /**
  * Allows setting the bearerToken at runtime (e.g. after login/logout).
@@ -85,15 +103,15 @@ export async function request(path) {
         throw new Error("HTTP client is not initialized. Call initializeApi(...) first.");
     }
     const url = `${baseURL}${path}`;
-    const headers = {
-        "Content-Type": "application/json",
-    };
-    if (apiKey) {
+    const headers = { "Content-Type": "application/json" };
+    if (apiKey)
         headers["X-API-Key"] = apiKey;
-    }
-    if (bearerToken) {
+    if (bearerToken)
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
-    }
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        headers[k] = v;
     const response = await fetch(url, {
         method: "GET",
         headers,
@@ -129,6 +147,11 @@ export async function post(path, body, extraHeaders) {
         headers["X-API-Key"] = apiKey;
     if (bearerToken)
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
     // Only set Content-Type for non-FormData bodies
     if (!(body instanceof FormData)) {
         headers["Content-Type"] = "application/json";
@@ -168,6 +191,11 @@ export async function put(path, body, extraHeaders) {
         headers["X-API-Key"] = apiKey;
     if (bearerToken)
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
     // Only set Content-Type for non-FormData bodies
     if (!(body instanceof FormData)) {
         headers["Content-Type"] = "application/json";
@@ -218,7 +246,11 @@ export async function requestWithOptions(path, options) {
             extraHeaders = Object.assign({}, options.headers);
         }
     }
-    const headers = Object.assign(Object.assign(Object.assign({ "Content-Type": "application/json" }, (apiKey ? { "X-API-Key": apiKey } : {})), (bearerToken ? { "AUTHORIZATION": `Bearer ${bearerToken}` } : {})), extraHeaders);
+    const headers = Object.assign(Object.assign(Object.assign(Object.assign({ "Content-Type": "application/json" }, (apiKey ? { "X-API-Key": apiKey } : {})), (bearerToken ? { "AUTHORIZATION": `Bearer ${bearerToken}` } : {})), (ngrokSkipBrowserWarning ? { "ngrok-skip-browser-warning": "true" } : {})), extraHeaders);
+    // Merge global custom headers (do not override existing keys from options.headers)
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
     const response = await fetch(url, Object.assign(Object.assign({}, options), { headers }));
     if (!response.ok) {
         try {
@@ -249,6 +281,11 @@ export async function del(path, extraHeaders) {
         headers["X-API-Key"] = apiKey;
     if (bearerToken)
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
     const response = await fetch(url, {
         method: "DELETE",
         headers,
@@ -276,6 +313,11 @@ export function getApiHeaders() {
         headers["X-API-Key"] = apiKey;
     if (bearerToken)
         headers["AUTHORIZATION"] = `Bearer ${bearerToken}`;
+    if (ngrokSkipBrowserWarning)
+        headers["ngrok-skip-browser-warning"] = "true";
+    for (const [k, v] of Object.entries(extraHeadersGlobal))
+        if (!(k in headers))
+            headers[k] = v;
     return headers;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.0.45",
+  "version": "1.0.47",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",