@aravinthan_p/appnest-app-sdk-utils 1.0.2 → 1.0.3

package/appnestFunctions/appnestFunctions.MD

@@ -11,9 +11,9 @@ This document is the **single source of truth** for the Appnest custom SDK funct
 ## Import
 
 ```javascript
-const AppnestFunctions = require('appnest-app-sdk-utils');
+const { AppnestFunctions } = require('appnest-app-sdk-utils');
 // or from path:
-// const AppnestFunctions = require('<path-to-sdk>/appnestFunctions');
+// const { AppnestFunctions } = require('<path-to-sdk>/appnestFunctions');
 
 const { $db, $file, $http, $next, $schedule, getTraceId } = AppnestFunctions;
 ```

package/appnestFunctions/httpFunction/http.MD

@@ -38,6 +38,8 @@ const { $http } = require('appnest-app-sdk-utils');
 
 ## Installation params (iparams) for API calls
 
+**Rule — required for all API calls:** Any value that comes from app configuration (installation params / iparams) and is used in a `$http` request **must** be expressed using the replace syntax `<%=iparams.<param_key>%>` in **url**, **headers**, **body**, or **query**. Do not hardcode these values or read them at runtime; the AppNest framework replaces the placeholders at request time.
+
 When making an API call through `$http`, if the developer needs to use an iparam-specific key/value from their manifest, they must define it under **installation_params** in the manifest.
 
 ### Defining iparams in the manifest
@@ -73,6 +75,14 @@ Reference iparams in the request **url**, **headers**, or **body** using the rep
 
 The same replacement syntax (`<%=iparams.<param_key>%>`) can be used wherever dynamic values from iparams are required in the request configuration.
 
+### For AI / code generation
+
+When generating code that uses `$http.request`:
+
+- **Always** use `<%=iparams.<param_key>%>` for any value that comes from installation params (API keys, base URLs, tenant IDs, etc.) in `url`, `headers`, `body`, or `query`. Never substitute a variable or literal for an iparam value in the request config.
+- **Never** hardcode API keys, base URLs, or other config that is (or could be) defined in the app manifest; use the replace syntax so the framework can inject the correct value per installation.
+- If the manifest defines an iparam (e.g. `api_key`, `api_url`), every `$http` usage that needs that value **must** reference it as `<%=iparams.<param_key>%>` in the request object.
+
 ### Using access_token in headers
 
 To send the platform’s **access_token** in the request (e.g. for OAuth or API auth), use the replace syntax in **headers**. The AppNest framework will replace `<%=user_oauth.access_token%>` with the actual token at runtime.
@@ -81,12 +91,12 @@ To send the platform’s **access_token** in the request (e.g. for OAuth or API
 
 ```javascript
 headers: {
-  Authorization: "Bearer <%=access_token%>",
+  Authorization: "Bearer <%=user_oauth.access_token%>",
   "Content-Type": "application/json"
 }
 ```
 
-Use this in your `$http.request` call; the framework replaces `<%=access_token%>` before the request is sent.
+Use this in your `$http.request` call; the framework replaces `<%=user_oauth.access_token%>` before the request is sent.
 
 ---
 
@@ -138,7 +148,7 @@ const result = await $http.request({
   url: 'https://api.example.com/v1/me',
   method: 'GET',
   headers: {
-    Authorization: "Bearer <%=access_token%>",
+    Authorization: "Bearer <%=user_oauth.access_token%>",
     "Content-Type": "application/json"
   },
   body: {},

package/appnestFunctions/httpFunction/http.js

@@ -6,8 +6,10 @@ const validateRequestData = ({ url, query, method, headers, body }) => {
     if (!url) throw new Error("url is required");
     if (typeof url !== "string") throw new Error("url must be a string");
     if (url.length === 0) throw new Error("url must be a non-empty string");
-    if (!url.startsWith("https://") && !url.startsWith("http://")) {
-        throw new Error("url must start with https:// or http://");
+    if(!url.includes("<%=")) {
+        if (!url.startsWith("https://") && !url.startsWith("http://")) {
+            throw new Error("url must start with https:// or http://");
+        }
     }
     if (url.length > 2048) throw new Error("url must be less than 2048 characters");
     if (!method) throw new Error("method is required");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@aravinthan_p/appnest-app-sdk-utils",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "main": "index.js",
     "dependencies": {
         "axios": "^1.2.1",