@frontegg/rest-api 3.0.107 → 3.0.108

package/fetch.d.ts

@@ -10,6 +10,7 @@ interface RequestOptions {
     credentials?: RequestCredentials;
 }
 export declare function getBaseUrl(context: ContextOptions, url: string, withFronteggPrefix?: boolean): string;
+export declare function getMetaDataHeaders(context: ContextOptions): Record<string, string>;
 export declare const Get: (url: string, params?: any, opts?: Pick<RequestOptions, "body" | "params" | "contentType" | "responseType" | "headers" | "credentials"> | undefined) => Promise<any>;
 export declare const Post: (url: string, body?: any, opts?: Pick<RequestOptions, "body" | "params" | "contentType" | "responseType" | "headers" | "credentials"> | undefined) => Promise<any>;
 export declare const Patch: (url: string, body?: any, opts?: Pick<RequestOptions, "body" | "params" | "contentType" | "responseType" | "headers" | "credentials"> | undefined) => Promise<any>;

package/fetch.js

@@ -1,5 +1,6 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import { ContextHolder } from './ContextHolder';
+import { fronteggHeaders } from './interfaces';
 import { FronteggApiError } from './error';
 export function getBaseUrl(context, url, withFronteggPrefix = true) {
   let baseUrl;
@@ -38,23 +39,39 @@ async function prepareUrl(context, url, params) {
   return finalUrl;
 }
 
+export function getMetaDataHeaders(context) {
+  var _context$metaDataHead, _context$metaDataHead2;
+
+  const headers = {};
+
+  if (context != null && (_context$metaDataHead = context.metaDataHeaders) != null && _context$metaDataHead.fronteggSdkVersion) {
+    headers[fronteggHeaders.fronteggSdkVersion] = context.metaDataHeaders.fronteggSdkVersion;
+  }
+
+  if (context != null && (_context$metaDataHead2 = context.metaDataHeaders) != null && _context$metaDataHead2.framework) {
+    headers[fronteggHeaders.frameWork] = context.metaDataHeaders.framework;
+  }
+
+  return headers;
+}
+
 async function buildRequestHeaders(context, contentType) {
   var _context$tokenResolve;
 
+  const headers = getMetaDataHeaders(context);
   const authToken = await ((_context$tokenResolve = context == null ? void 0 : context.tokenResolver) != null ? _context$tokenResolve : ContextHolder.getAccessToken)();
   const requestSource = ContextHolder.getRequestSource();
-  const headers = {};
-
-  if (authToken) {
-    headers.Authorization = `Bearer ${authToken}`;
-  }
 
   if (contentType) {
-    headers['Content-Type'] = contentType;
+    headers[fronteggHeaders.contentType] = contentType;
   }
 
   if (requestSource) {
-    headers['frontegg-source'] = requestSource;
+    headers[fronteggHeaders.source] = requestSource;
+  }
+
+  if (authToken) {
+    headers.Authorization = `Bearer ${authToken}`;
   }
 
   for (const additionalHeader of await getAdditionalHeaders(context)) {

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.107
+/** @license Frontegg v3.0.108
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/interfaces.d.ts

@@ -30,7 +30,30 @@ export interface ResolvedTenantResult {
     tenant?: string | null;
 }
 export declare type LogLevel = "warn" | "error";
-export declare type RequestSource = "admin-portal" | "login-box";
+export declare const fronteggHeaders: {
+    frameWork: string;
+    fronteggSdkVersion: string;
+    contentType: string;
+    source: string;
+};
+export declare enum RequestSource {
+    AdminPortal = "admin-portal",
+    LoginBox = "login-box"
+}
+export declare enum FronteggFrameworks {
+    Nextjs = "nextjs",
+    React = "react",
+    Angular = "angular",
+    Vuejs = "vuejs",
+    Flutter = "flutter",
+    Ios = "ios",
+    Android = "android",
+    Vanillajs = "vanillajs"
+}
+export interface MetaDataHeaders {
+    framework?: FronteggFrameworks;
+    fronteggSdkVersion?: string;
+}
 export interface ContextOptions {
     baseUrl: string | ((url: string) => string);
     clientId?: string;
@@ -49,6 +72,7 @@ export interface ContextOptions {
     auditsOptions?: {
         virtualScroll?: boolean;
     };
+    metaDataHeaders?: MetaDataHeaders;
 }
 export interface QuerySort {
     id: string;

package/interfaces.js

@@ -1 +1,25 @@
-export {};
+export const fronteggHeaders = {
+  frameWork: 'x-frontegg-framework',
+  fronteggSdkVersion: 'x-frontegg-sdk',
+  contentType: 'Content-Type',
+  source: 'frontegg-source'
+};
+export let RequestSource;
+
+(function (RequestSource) {
+  RequestSource["AdminPortal"] = "admin-portal";
+  RequestSource["LoginBox"] = "login-box";
+})(RequestSource || (RequestSource = {}));
+
+export let FronteggFrameworks;
+
+(function (FronteggFrameworks) {
+  FronteggFrameworks["Nextjs"] = "nextjs";
+  FronteggFrameworks["React"] = "react";
+  FronteggFrameworks["Angular"] = "angular";
+  FronteggFrameworks["Vuejs"] = "vuejs";
+  FronteggFrameworks["Flutter"] = "flutter";
+  FronteggFrameworks["Ios"] = "ios";
+  FronteggFrameworks["Android"] = "android";
+  FronteggFrameworks["Vanillajs"] = "vanillajs";
+})(FronteggFrameworks || (FronteggFrameworks = {}));

package/node/fetch.js

@@ -7,11 +7,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.extractHeadersFromOptions = exports.Put = exports.PostDownload = exports.Post = exports.Patch = exports.Get = exports.Delete = void 0;
 exports.getBaseUrl = getBaseUrl;
+exports.getMetaDataHeaders = getMetaDataHeaders;
 
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 
 var _ContextHolder = require("./ContextHolder");
 
+var _interfaces = require("./interfaces");
+
 var _error = require("./error");
 
 function getBaseUrl(context, url, withFronteggPrefix = true) {
@@ -51,25 +54,40 @@ async function prepareUrl(context, url, params) {
   return finalUrl;
 }
 
+function getMetaDataHeaders(context) {
+  var _context$metaDataHead, _context$metaDataHead2;
+
+  const headers = {};
+
+  if (context != null && (_context$metaDataHead = context.metaDataHeaders) != null && _context$metaDataHead.fronteggSdkVersion) {
+    headers[_interfaces.fronteggHeaders.fronteggSdkVersion] = context.metaDataHeaders.fronteggSdkVersion;
+  }
+
+  if (context != null && (_context$metaDataHead2 = context.metaDataHeaders) != null && _context$metaDataHead2.framework) {
+    headers[_interfaces.fronteggHeaders.frameWork] = context.metaDataHeaders.framework;
+  }
+
+  return headers;
+}
+
 async function buildRequestHeaders(context, contentType) {
   var _context$tokenResolve;
 
+  const headers = getMetaDataHeaders(context);
   const authToken = await ((_context$tokenResolve = context == null ? void 0 : context.tokenResolver) != null ? _context$tokenResolve : _ContextHolder.ContextHolder.getAccessToken)();
 
   const requestSource = _ContextHolder.ContextHolder.getRequestSource();
 
-  const headers = {};
-
-  if (authToken) {
-    headers.Authorization = `Bearer ${authToken}`;
-  }
-
   if (contentType) {
-    headers['Content-Type'] = contentType;
+    headers[_interfaces.fronteggHeaders.contentType] = contentType;
   }
 
   if (requestSource) {
-    headers['frontegg-source'] = requestSource;
+    headers[_interfaces.fronteggHeaders.source] = requestSource;
+  }
+
+  if (authToken) {
+    headers.Authorization = `Bearer ${authToken}`;
   }
 
   for (const additionalHeader of await getAdditionalHeaders(context)) {

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v3.0.107
+/** @license Frontegg v3.0.108
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/interfaces.js

@@ -2,4 +2,33 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.fronteggHeaders = exports.RequestSource = exports.FronteggFrameworks = void 0;
+const fronteggHeaders = {
+  frameWork: 'x-frontegg-framework',
+  fronteggSdkVersion: 'x-frontegg-sdk',
+  contentType: 'Content-Type',
+  source: 'frontegg-source'
+};
+exports.fronteggHeaders = fronteggHeaders;
+let RequestSource;
+exports.RequestSource = RequestSource;
+
+(function (RequestSource) {
+  RequestSource["AdminPortal"] = "admin-portal";
+  RequestSource["LoginBox"] = "login-box";
+})(RequestSource || (exports.RequestSource = RequestSource = {}));
+
+let FronteggFrameworks;
+exports.FronteggFrameworks = FronteggFrameworks;
+
+(function (FronteggFrameworks) {
+  FronteggFrameworks["Nextjs"] = "nextjs";
+  FronteggFrameworks["React"] = "react";
+  FronteggFrameworks["Angular"] = "angular";
+  FronteggFrameworks["Vuejs"] = "vuejs";
+  FronteggFrameworks["Flutter"] = "flutter";
+  FronteggFrameworks["Ios"] = "ios";
+  FronteggFrameworks["Android"] = "android";
+  FronteggFrameworks["Vanillajs"] = "vanillajs";
+})(FronteggFrameworks || (exports.FronteggFrameworks = FronteggFrameworks = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontegg/rest-api",
-  "version": "3.0.107",
+  "version": "3.0.108",
   "main": "./node/index.js",
   "license": "MIT",
   "dependencies": {