@adobe/exc-app 1.3.5 → 1.4.0

package/appapi.d.ts

@@ -74,7 +74,7 @@ export declare enum AppIds {
     GENSTUDIO = "GenStudio",
     HEADLESS_CMS = "hcms",
     JOURNEY_OPTIMIZER = "cjm-home",
-    JOURNEY_OPTIMIZER_B2B_EDITION = "sapphireUI",
+    JOURNEY_OPTIMIZER_B2B_EDITION = "sapphireHome",
     JOURNEY_ORCHESTRATION = "journeys",
     LAUNCH_IMPLEMENT = "implement",
     MARKETO = "marketo",

package/appapi.js

@@ -80,7 +80,7 @@ var AppIds;
     AppIds["GENSTUDIO"] = "GenStudio";
     AppIds["HEADLESS_CMS"] = "hcms";
     AppIds["JOURNEY_OPTIMIZER"] = "cjm-home";
-    AppIds["JOURNEY_OPTIMIZER_B2B_EDITION"] = "sapphireUI";
+    AppIds["JOURNEY_OPTIMIZER_B2B_EDITION"] = "sapphireHome";
     AppIds["JOURNEY_ORCHESTRATION"] = "journeys";
     AppIds["LAUNCH_IMPLEMENT"] = "implement";
     AppIds["MARKETO"] = "marketo";

package/appapi.js.map

@@ -1 +1 @@
-{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MAyDX;AAzDD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gDAAsC,CAAA;IACtC,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4EAAkE,CAAA;IAClE,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,8DAAoD,CAAA;IACpD,8DAAoD,CAAA;IACpD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,sDAA4C,CAAA;IAC5C,4CAAkC,CAAA;IAClC,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,oDAA0C,CAAA;IAC1C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAzDW,MAAM,GAAN,cAAM,KAAN,cAAM,QAyDjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"appapi.js","sourceRoot":"","sources":["appapi.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,yCAAqC;AAiCrC,0DAA0D;AAC1D,IAAY,MAyDX;AAzDD,WAAY,MAAM;IAChB,yBAAe,CAAA;IACf,wCAA8B,CAAA;IAC9B,oDAA0C,CAAA;IAC1C,uCAA6B,CAAA;IAC7B,iCAAuB,CAAA;IACvB,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oCAA0B,CAAA;IAC1B,8CAAoC,CAAA;IACpC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,0CAAgC,CAAA;IAChC,gDAAsC,CAAA;IACtC,gEAAsD,CAAA;IACtD,0DAAgD,CAAA;IAChD,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,sCAA4B,CAAA;IAC5B,+BAAqB,CAAA;IACrB,sCAA4B,CAAA;IAC5B,oDAA0C,CAAA;IAC1C,4EAAkE,CAAA;IAClE,kDAAwC,CAAA;IACxC,kDAAwC,CAAA;IACxC,0DAAgD,CAAA;IAChD,4DAAkD,CAAA;IAClD,4DAAkD,CAAA;IAClD,4CAAkC,CAAA;IAClC,8DAAoD,CAAA;IACpD,8DAAoD,CAAA;IACpD,gDAAsC,CAAA;IACtC,sDAA4C,CAAA;IAC5C,iCAAuB,CAAA;IACvB,+BAAqB,CAAA;IACrB,wCAA8B,CAAA;IAC9B,wDAA8C,CAAA;IAC9C,4CAAkC,CAAA;IAClC,wCAA8B,CAAA;IAC9B,6BAAmB,CAAA;IACnB,0CAAgC,CAAA;IAChC,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2BAAiB,CAAA;IACjB,oEAA0D,CAAA;IAC1D,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,kCAAwB,CAAA;IACxB,6CAAmC,CAAA;IACnC,qCAA2B,CAAA;IAC3B,oDAA0C,CAAA;IAC1C,wDAA8C,CAAA;IAC9C,wCAA8B,CAAA;IAC9B,2BAAiB,CAAA;IACjB,+BAAqB,CAAA;IACrB,iCAAuB,CAAA;IACvB,qCAA2B,CAAA;AAC7B,CAAC,EAzDW,MAAM,GAAN,cAAM,KAAN,cAAM,QAyDjB;AAWD,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,MAAM,CAAC,EAAE;QACZ,OAAO,IAAA,gBAAO,EAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;CACF,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/featureflags.d.ts

@@ -9,7 +9,7 @@
  * written permission of Adobe.
  **************************************************************************/
 /**
- * The Feature Flags API provides feature flag data from LaunchDarkly.
+ * The Feature Flags API provides feature flag data from LaunchDarkly and Floodgate.
  *
  * To consume this API, add the following import to your code.
  *
@@ -29,18 +29,31 @@
  * const featureFlags = await featureFlags.get(['cjm', 'experience-platform']);
  * ```
  *
+ * Feature flags can also be requested from Floodgate by:
+ * - including the provider in the options
+ * - including the clientIds in the options (instead of projectIds)
+ * If no provider is specified, the default provider is LaunchDarkly.
+ *
+ * ```typescript
+ * import featureFlags, {PROVIDERS} from '@adobe/exc-app/featureflags';
+ *
+ * const floodgateFlags = await featureFlags().get({clientIds: ['unified-shell'], provider: PROVIDERS.FLOODGATE});
+ * ```
+ *
  * All feature flags can be requested using the key '*'
  * ```typescript
- * import featureFlags from '@adobe/exc-app/featureflags';
+ * import featureFlags, {PROVIDERS} from '@adobe/exc-app/featureflags';
  *
  * const featureFlags = await featureFlags.get(['*']);
  *
+ * const featureFlags = await featureFlags.get({clientIds: ['*'], provider: PROVIDERS.FLOODGATE});
+ *
  * ```
  * In some cases you may want to include context options that are not already
  * included in the current app's active context. For example, requesting feature
  * flags for a project that uses sandboxes from an app that does not.
  *
- * To include options in the request, pass an object with projectIds and the context options.
+ * To include options in the request, pass an object with the projectIds or clientIds and the context options.
  *
  * ```typescript
  * import featureFlags from '@adobe/exc-app/featureflags';
@@ -57,6 +70,10 @@ export declare enum PROVIDERS {
     FLOODGATE = "Floodgate",
     LAUNCH_DARKLY = "Launch Darkly"
 }
+export declare enum SANDBOX_TYPES {
+    development = "DEVELOPMENT",
+    production = "PRODUCTION"
+}
 export interface FeatureFlagConfig {
     /**
      * If true, the feature flags will be fetched from the server and not from the cache.
@@ -85,16 +102,23 @@ export interface FeatureFlagsResponse {
 export interface SandboxOptions {
     name: string;
     region?: string;
+    type?: SANDBOX_TYPES;
 }
-/**
- * The data object when the projects and options are sent as a message through the API.
- */
-export interface GetFlagsWithOptions {
+export type GetFlagOptions<T> = T & {
     config?: FeatureFlagConfig;
-    projectIds: string[];
-    sandbox?: SandboxOptions;
     provider?: PROVIDERS;
+    sandbox?: SandboxOptions;
+};
+export interface FloodgateOptions {
+    clientIds: string[];
 }
+export interface LaunchDarklyOptions {
+    projectIds: string[];
+}
+/**
+ * The data object when the projects and options are sent as a message through the API.
+ */
+export type GetFlagsWithOptions = GetFlagOptions<FloodgateOptions> | GetFlagOptions<LaunchDarklyOptions>;
 /**
  * The input parameters for the feature flags API.
  * This should be a list of LaunchDarkly project ids to get.

package/featureflags.js

@@ -10,9 +10,9 @@
  * written permission of Adobe.
  **************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROVIDERS = void 0;
+exports.SANDBOX_TYPES = exports.PROVIDERS = void 0;
 /**
- * The Feature Flags API provides feature flag data from LaunchDarkly.
+ * The Feature Flags API provides feature flag data from LaunchDarkly and Floodgate.
  *
  * To consume this API, add the following import to your code.
  *
@@ -32,18 +32,31 @@ exports.PROVIDERS = void 0;
  * const featureFlags = await featureFlags.get(['cjm', 'experience-platform']);
  * ```
  *
+ * Feature flags can also be requested from Floodgate by:
+ * - including the provider in the options
+ * - including the clientIds in the options (instead of projectIds)
+ * If no provider is specified, the default provider is LaunchDarkly.
+ *
+ * ```typescript
+ * import featureFlags, {PROVIDERS} from '@adobe/exc-app/featureflags';
+ *
+ * const floodgateFlags = await featureFlags().get({clientIds: ['unified-shell'], provider: PROVIDERS.FLOODGATE});
+ * ```
+ *
  * All feature flags can be requested using the key '*'
  * ```typescript
- * import featureFlags from '@adobe/exc-app/featureflags';
+ * import featureFlags, {PROVIDERS} from '@adobe/exc-app/featureflags';
  *
  * const featureFlags = await featureFlags.get(['*']);
  *
+ * const featureFlags = await featureFlags.get({clientIds: ['*'], provider: PROVIDERS.FLOODGATE});
+ *
  * ```
  * In some cases you may want to include context options that are not already
  * included in the current app's active context. For example, requesting feature
  * flags for a project that uses sandboxes from an app that does not.
  *
- * To include options in the request, pass an object with projectIds and the context options.
+ * To include options in the request, pass an object with the projectIds or clientIds and the context options.
  *
  * ```typescript
  * import featureFlags from '@adobe/exc-app/featureflags';
@@ -61,6 +74,11 @@ var PROVIDERS;
     PROVIDERS["FLOODGATE"] = "Floodgate";
     PROVIDERS["LAUNCH_DARKLY"] = "Launch Darkly";
 })(PROVIDERS = exports.PROVIDERS || (exports.PROVIDERS = {}));
+var SANDBOX_TYPES;
+(function (SANDBOX_TYPES) {
+    SANDBOX_TYPES["development"] = "DEVELOPMENT";
+    SANDBOX_TYPES["production"] = "PRODUCTION";
+})(SANDBOX_TYPES = exports.SANDBOX_TYPES || (exports.SANDBOX_TYPES = {}));
 const Global_1 = require("./src/Global");
 const featureFlags = {
     get: (params) => {

package/featureflags.js.map

@@ -1 +1 @@
-{"version":3,"file":"featureflags.js","sourceRoot":"","sources":["featureflags.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAEH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,4CAA+B,CAAA;AACjC,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,yCAAqC;AAsErC,MAAM,YAAY,GAAoB;IACpC,GAAG,EAAE,CAAC,MAAkB,EAAE,EAAE;QAC1B,OAAO,IAAA,gBAAO,EAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,kBAAe,YAAY,CAAC"}
+{"version":3,"file":"featureflags.js","sourceRoot":"","sources":["featureflags.ts"],"names":[],"mappings":";AAAA;;;;;;;;;4EAS4E;;;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,4CAA+B,CAAA;AACjC,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,yCAAqC;AAgFrC,MAAM,YAAY,GAAoB;IACpC,GAAG,EAAE,CAAC,MAAkB,EAAE,EAAE;QAC1B,OAAO,IAAA,gBAAO,EAAC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;CACF,CAAC;AAEF,kBAAe,YAAY,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/exc-app",
-  "version": "1.3.5",
+  "version": "1.4.0",
   "main": "index.js",
   "source": "index.ts",
   "scripts": {

package/version.d.ts

@@ -8,5 +8,5 @@
  * then your use, modification, or distribution of it requires the prior
  * written permission of Adobe.
  **************************************************************************/
-declare const EXC_APP_VERSION = "1.3.5";
+declare const EXC_APP_VERSION = "1.4.0";
 export default EXC_APP_VERSION;

package/version.js

@@ -10,6 +10,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * then your use, modification, or distribution of it requires the prior
  * written permission of Adobe.
  **************************************************************************/
-const EXC_APP_VERSION = '1.3.5';
+const EXC_APP_VERSION = '1.4.0';
 exports.default = EXC_APP_VERSION;
 //# sourceMappingURL=version.js.map