@forge/bridge 5.6.0-next.2 → 5.6.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @forge/bridge
 
+## 5.6.0-next.3
+
+### Patch Changes
+
+- 4c1e39d: Added Readme for Forge feature flags client SDK
+- Updated dependencies [b1f257c]
+  - @forge/manifest@10.7.0-next.5
+
 ## 5.6.0-next.2
 
 ### Patch Changes

package/out/featureFlags/featureFlags.d.ts

@@ -1,7 +1,7 @@
 export interface ForgeFeatureFlagConfig {
     environment?: 'development' | 'staging' | 'production';
 }
-export interface FeatureFlagsUser {
+export interface FeatureFlagUser {
     userId?: string;
     custom?: Record<string, string | number | boolean>;
     attributes?: Record<string, string | number | boolean>;
@@ -10,15 +10,15 @@ export interface FeatureFlagsUser {
         accountId?: string;
     };
 }
-export declare class ForgeFeatureService {
+export declare class ForgeFeatureFlags {
     private initialized;
     private client;
     private dataAdapter;
     private readonly CLIENT_KEY;
-    initialize(user: FeatureFlagsUser, config?: ForgeFeatureFlagConfig): Promise<void>;
+    initialize(user: FeatureFlagUser, config?: ForgeFeatureFlagConfig): Promise<void>;
     checkFlag(flagName: string): boolean;
     shutdown(): Promise<void>;
-    isInitialised(): boolean;
+    isInitialized(): boolean;
     private convertUser;
 }
 //# sourceMappingURL=featureFlags.d.ts.map

package/out/featureFlags/featureFlags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"featureFlags.d.ts","sourceRoot":"","sources":["../../src/featureFlags/featureFlags.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC;CACxD;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACvD,WAAW,CAAC,EAAE;QACZ,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAID,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuC;IAKrD,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB5F,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAW9B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B,aAAa;IAIpB,OAAO,CAAC,WAAW;CAOpB"}
+{"version":3,"file":"featureFlags.d.ts","sourceRoot":"","sources":["../../src/featureFlags/featureFlags.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC;CACxD;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACvD,WAAW,CAAC,EAAE;QACZ,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAID,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,MAAM,CAA8B;IAC5C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAuC;IAKrD,UAAU,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,GAAE,sBAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB3F,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAW9B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B,aAAa;IAIpB,OAAO,CAAC,WAAW;CAOpB"}

package/out/featureFlags/featureFlags.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ForgeFeatureService = void 0;
+exports.ForgeFeatureFlags = void 0;
 const js_client_1 = require("@statsig/js-client");
 const dataAdapter_1 = require("./dataAdapter");
-class ForgeFeatureService {
+class ForgeFeatureFlags {
     constructor() {
         this.initialized = false;
         this.client = null;
@@ -11,7 +11,7 @@ class ForgeFeatureService {
         this.CLIENT_KEY = 'client-forge-internal-key';
     }
     async initialize(user, config = {}) {
-        if (this.isInitialised()) {
+        if (this.isInitialized()) {
             return;
         }
         this.dataAdapter = new dataAdapter_1.ForgeDataAdapter();
@@ -27,13 +27,13 @@ class ForgeFeatureService {
         this.initialized = true;
     }
     checkFlag(flagName) {
-        if (!this.isInitialised() || !this.client) {
-            throw new Error('ForgeFeatureService not initialized. Call initialize() first.');
+        if (!this.isInitialized() || !this.client) {
+            throw new Error('ForgeFeatureFlags not initialized. Call initialize() first.');
         }
         return this.client.checkGate(flagName, { disableExposureLog: true });
     }
     async shutdown() {
-        if (!this.isInitialised() || !this.client) {
+        if (!this.isInitialized() || !this.client) {
             return;
         }
         await this.client.shutdown();
@@ -42,7 +42,7 @@ class ForgeFeatureService {
         }
         this.initialized = false;
     }
-    isInitialised() {
+    isInitialized() {
         return this.initialized;
     }
     convertUser(user) {
@@ -53,4 +53,4 @@ class ForgeFeatureService {
         };
     }
 }
-exports.ForgeFeatureService = ForgeFeatureService;
+exports.ForgeFeatureFlags = ForgeFeatureFlags;

package/out/featureFlags/index.d.ts

@@ -1,3 +1,3 @@
 export * from './initFeatureFlags';
-export { ForgeFeatureService, FeatureFlagsUser, ForgeFeatureFlagConfig } from './featureFlags';
+export { ForgeFeatureFlags, FeatureFlagUser, ForgeFeatureFlagConfig } from './featureFlags';
 //# sourceMappingURL=index.d.ts.map

package/out/featureFlags/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/featureFlags/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/featureFlags/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC"}

package/out/featureFlags/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ForgeFeatureService = void 0;
+exports.ForgeFeatureFlags = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./initFeatureFlags"), exports);
 var featureFlags_1 = require("./featureFlags");
-Object.defineProperty(exports, "ForgeFeatureService", { enumerable: true, get: function () { return featureFlags_1.ForgeFeatureService; } });
+Object.defineProperty(exports, "ForgeFeatureFlags", { enumerable: true, get: function () { return featureFlags_1.ForgeFeatureFlags; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.6.0-next.2",
+  "version": "5.6.0-next.3",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -18,7 +18,7 @@
     "@forge/resolver": "1.7.0",
     "@statsig/js-client": "3.18.2",
     "@types/history": "^4.7.11",
-    "@forge/manifest": "10.7.0-next.4"
+    "@forge/manifest": "10.7.0-next.5"
   },
   "devDependencies": {
     "history": "5.3.0",