@karpeleslab/klbfw 0.2.0 → 0.2.2

package/fw-wrapper.js

@@ -138,11 +138,29 @@ const getUrl = () => {
  */
 const getSiteStatic = () => getFWProperty('site_static', true);
 
+/**
+ * Gets the API prefix
+ * @returns {string|undefined} API prefix
+ */
+const getApiPrefix = () => {
+    if (typeof FW !== "undefined") {
+        return FW.api_prefix; // Return undefined if property doesn't exist
+    }
+    return undefined;
+};
+
 /**
  * Gets the API call URL prefix
- * @returns {string} API call URL prefix
+ * @returns {string|undefined} API call URL prefix
  */
-const getCallUrlPrefix = () => getFWProperty('call_url_prefix', 'https://hub.atonline.com');
+const getCallUrlPrefix = () => {
+    // In original code, if FW existed but call_url_prefix wasn't set, it would return undefined
+    if (typeof FW !== "undefined") {
+        return FW.call_url_prefix; // Return undefined if property doesn't exist
+    }
+    // Only use fallback in non-browser environments
+    return typeof window === "undefined" ? 'https://hub.atonline.com' : undefined;
+};
 
 /**
  * Gets the site UUID
@@ -215,7 +233,7 @@ module.exports.getCallUrlPrefix = getCallUrlPrefix;
 module.exports.getUuid = getUuid;
 module.exports.getInitialState = getInitialState;
 module.exports.supported = supported;
-module.exports.GET = getGET();
+module.exports.GET = getGET;
 module.exports.Get = getParam;
 module.exports.flushGet = flushGet;
 module.exports.getMode = getMode;

package/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Type definitions for @karpeleslab/klbfw
+ */
+
+// Framework wrapper types
+declare function GET(): Record<string, string>;
+declare function Get(key?: string): string | Record<string, string> | undefined;
+declare function flushGet(): void;
+declare function getPrefix(): string;
+declare function getSettings(): Record<string, any>;
+declare function getRealm(): Record<string, any>;
+declare function getContext(): Record<string, any>;
+declare function setContext(key: string, value: any): void;
+declare function getMode(): string;
+declare function getHostname(): string;
+declare function getRegistry(): Record<string, any> | undefined;
+declare function getLocale(): string;
+declare function getUserGroup(): string | undefined;
+declare function getCurrency(): string;
+declare function getToken(): string | undefined;
+declare function getUrl(): { path: string; full: string };
+declare function getPath(): string;
+declare function getUuid(): string | undefined;
+declare function getInitialState(): Record<string, any> | undefined;
+
+// Cookie handling types
+declare function getCookie(name: string): string | null;
+declare function hasCookie(name: string): boolean;
+declare function setCookie(name: string, value: string, expires?: Date | number, path?: string, domain?: string, secure?: boolean): void;
+
+// REST API types
+declare function rest(name: string, verb: string, params?: Record<string, any> | string, context?: Record<string, any>): Promise<any>;
+declare function rest_get(name: string, params?: Record<string, any> | string): Promise<any>; // Backward compatibility
+declare function restGet(name: string, params?: Record<string, any> | string): Promise<any>;
+
+// Upload module types
+interface UploadOptions {
+  progress?: (progress: number) => void;
+  endpoint?: string;
+  headers?: Record<string, string>;
+  retry?: number;
+  chunk_size?: number;
+  params?: Record<string, any>;
+}
+
+declare function upload(file: File, options?: UploadOptions): Promise<any>;
+
+// Utility types
+declare function getI18N(key: string, args?: Record<string, any>): string;
+declare function trimPrefix(path: string): string;
+
+export {
+  GET,
+  Get,
+  flushGet,
+  getPrefix,
+  getSettings,
+  getRealm,
+  getContext,
+  setContext,
+  getMode,
+  getHostname,
+  getRegistry,
+  getLocale,
+  getUserGroup,
+  getCurrency,
+  getToken,
+  getUrl,
+  getPath,
+  getUuid,
+  getInitialState,
+  getCookie,
+  hasCookie,
+  setCookie,
+  rest,
+  rest_get,
+  restGet,
+  upload,
+  getI18N,
+  trimPrefix
+};

package/index.js

@@ -13,7 +13,7 @@ const util = require('./util');
 const cookies = require('./cookies');
 
 // Framework wrapper exports
-module.exports.GET = internalFW.GET;
+module.exports.GET = internalFW.GET; // Use the function directly
 module.exports.Get = internalFW.Get;
 module.exports.flushGet = internalFW.flushGet;
 module.exports.getPrefix = internalFW.getPrefix;

package/internal.js

@@ -50,24 +50,36 @@ const getTimezoneData = () => {
  * @returns {string} Constructed URL
  */
 const buildRestUrl = (path, withToken, context) => {
+    // Check for api_prefix
+    const apiPrefixPath = typeof FW !== "undefined" && FW.api_prefix ? 
+        FW.api_prefix + "/_rest/" + path : 
+        "/_rest/" + path;
+    
+    // For non-authenticated requests
     if (!withToken) {
-        if (fwWrapper.getCallUrlPrefix()) return fwWrapper.getCallUrlPrefix() + "/_rest/" + path;
-        return "/_rest/" + path;
+        const prefix = fwWrapper.getCallUrlPrefix();
+        if (prefix) {
+            return prefix + apiPrefixPath;
+        }
+        return apiPrefixPath;
     }
     
     context = context || {};
     let glue = '?';
     
+    // Start building the URL
     let callUrl;
     if (fwWrapper.getSiteStatic()) {
-        callUrl = "/_rest/" + path + "?static";
+        callUrl = apiPrefixPath + "?static";
         glue = '&';
     } else {
-        callUrl = "/_rest/" + path;
+        callUrl = apiPrefixPath;
     }
     
-    if (fwWrapper.getCallUrlPrefix()) {
-        callUrl = fwWrapper.getCallUrlPrefix() + callUrl;
+    // Add call_url_prefix if it exists
+    const prefix = fwWrapper.getCallUrlPrefix();
+    if (prefix) {
+        callUrl = prefix + callUrl;
     }
 
     // Copy context, proceed with overload then add to url
@@ -76,6 +88,7 @@ const buildRestUrl = (path, withToken, context) => {
         ctxFinal[key] = context[key];
     }
     
+    // Add context parameters to URL
     for (const key in ctxFinal) {
         if (key === "_") continue;
         callUrl = callUrl + glue + "_ctx[" + key + "]=" + encodeURIComponent(ctxFinal[key]);

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@karpeleslab/klbfw",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Frontend Framework",
   "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
     "test": "jest",
     "test:watch": "jest --watch",

package/CLAUDE.md

@@ -1,50 +0,0 @@
-# KarpelesLab Frontend Framework (klbfw) Guidelines
-
-## Commands
-```
-# Install dependencies
-npm install
-
-# Run tests
-npm test
-
-# Run tests in watch mode
-npm run test:watch
-```
-
-## Code Style Guidelines
-
-### Formatting
-- Use 'use strict' directive at top of files
-- 4-space indentation (configured in vim: et:ts=4:sw=4)
-- Use semicolons consistently
-- Use single quotes for strings
-
-### Imports/Exports
-- Use CommonJS module system (require/module.exports)
-- Export using module.exports.<func> = <func>
-
-### Variables & Functions
-- Use camelCase for variables and functions
-- Use snake_case for some function names (rest_get, get_timezone_data)
-- Function declarations: mix of standard functions and arrow functions
-
-### Error Handling
-- Use Promise-based error handling with reject/resolve pattern
-- Include descriptive error objects with properties (message, body, headers)
-- Check input parameters and provide defaults (params = params || {})
-
-### Browser Compatibility
-- Check for feature availability before using (typeof window, Intl.DateTimeFormat)
-- Handle both browser and non-browser environments
-
-### Documentation
-- Include comments for complex functions
-- Add function descriptions where appropriate
-
-### Testing
-- Tests are written using Jest
-- Test modules are in the test/ directory
-- Each module has a separate test file
-- Tests should cover both SSR and client modes
-- Use setup.js for test utilities and mocks