@atlaskit/web-config-client 0.2.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/web-config-client

package/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2023 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

package/README.md

@@ -0,0 +1,9 @@
+# WebConfigClient
+
+JavaScript Frontend Web Client for Dynamic Configuration.
+
+## Usage
+
+`import WebConfigClient from '@atlaskit/web-config-client';`
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/measurement/web-config-client).

package/dist/cjs/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ConfigClient", {
+  enumerable: true,
+  get: function get() {
+    return _main.ConfigClient;
+  }
+});
+Object.defineProperty(exports, "ConfigCollection", {
+  enumerable: true,
+  get: function get() {
+    return _configCommonLibs.ConfigCollection;
+  }
+});
+Object.defineProperty(exports, "ConfigError", {
+  enumerable: true,
+  get: function get() {
+    return _configCommonLibs.ConfigError;
+  }
+});
+Object.defineProperty(exports, "ConfigMapSchema", {
+  enumerable: true,
+  get: function get() {
+    return _configCommonLibs.ConfigMapSchema;
+  }
+});
+var _main = require("./main");
+var _configCommonLibs = require("@atlaskit/config-common-libs");

package/dist/cjs/main.js

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ConfigClient = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _configCommonLibs = require("@atlaskit/config-common-libs");
+var ConfigClient = exports.ConfigClient = /*#__PURE__*/function () {
+  function ConfigClient() {
+    (0, _classCallCheck2.default)(this, ConfigClient);
+  }
+  (0, _createClass2.default)(ConfigClient, null, [{
+    key: "fetch",
+    value: function () {
+      var _fetch = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(options) {
+        var _options$fetch;
+        var fetch, response, valuesPayload;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              fetch = (_options$fetch = options.fetch) !== null && _options$fetch !== void 0 ? _options$fetch : globalThis.fetch;
+              _context.next = 3;
+              return fetch("".concat(options.ffsBaseUrl, "/api/v2/configurations"), {
+                method: 'POST',
+                body: JSON.stringify(options.context),
+                headers: {
+                  'content-type': 'application/json',
+                  'x-api-key': options.ffsApiKey
+                }
+              });
+            case 3:
+              response = _context.sent;
+              if (response.ok) {
+                _context.next = 12;
+                break;
+              }
+              _context.t0 = Error;
+              _context.t1 = "Unexpected response ".concat(response.status, ": ");
+              _context.next = 9;
+              return response.text();
+            case 9:
+              _context.t2 = _context.sent;
+              _context.t3 = _context.t1.concat.call(_context.t1, _context.t2);
+              throw new _context.t0(_context.t3);
+            case 12:
+              _context.next = 14;
+              return response.text();
+            case 14:
+              valuesPayload = _context.sent;
+              return _context.abrupt("return", _configCommonLibs.ConfigCollection.fromValues(valuesPayload));
+            case 16:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      function fetch(_x) {
+        return _fetch.apply(this, arguments);
+      }
+      return fetch;
+    }()
+  }]);
+  return ConfigClient;
+}();

package/dist/es2019/index.js

@@ -0,0 +1,2 @@
+export { ConfigClient } from './main';
+export { ConfigCollection, ConfigError, ConfigMapSchema } from '@atlaskit/config-common-libs';

package/dist/es2019/main.js

@@ -0,0 +1,20 @@
+import { ConfigCollection } from '@atlaskit/config-common-libs';
+export class ConfigClient {
+  static async fetch(options) {
+    var _options$fetch;
+    const fetch = (_options$fetch = options.fetch) !== null && _options$fetch !== void 0 ? _options$fetch : globalThis.fetch;
+    const response = await fetch(`${options.ffsBaseUrl}/api/v2/configurations`, {
+      method: 'POST',
+      body: JSON.stringify(options.context),
+      headers: {
+        'content-type': 'application/json',
+        'x-api-key': options.ffsApiKey
+      }
+    });
+    if (!response.ok) {
+      throw new Error(`Unexpected response ${response.status}: ${await response.text()}`);
+    }
+    const valuesPayload = await response.text();
+    return ConfigCollection.fromValues(valuesPayload);
+  }
+}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { ConfigClient } from './main';
+export { ConfigCollection, ConfigError, ConfigMapSchema } from '@atlaskit/config-common-libs';

package/dist/esm/main.js

@@ -0,0 +1,62 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { ConfigCollection } from '@atlaskit/config-common-libs';
+export var ConfigClient = /*#__PURE__*/function () {
+  function ConfigClient() {
+    _classCallCheck(this, ConfigClient);
+  }
+  _createClass(ConfigClient, null, [{
+    key: "fetch",
+    value: function () {
+      var _fetch = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(options) {
+        var _options$fetch;
+        var fetch, response, valuesPayload;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              fetch = (_options$fetch = options.fetch) !== null && _options$fetch !== void 0 ? _options$fetch : globalThis.fetch;
+              _context.next = 3;
+              return fetch("".concat(options.ffsBaseUrl, "/api/v2/configurations"), {
+                method: 'POST',
+                body: JSON.stringify(options.context),
+                headers: {
+                  'content-type': 'application/json',
+                  'x-api-key': options.ffsApiKey
+                }
+              });
+            case 3:
+              response = _context.sent;
+              if (response.ok) {
+                _context.next = 12;
+                break;
+              }
+              _context.t0 = Error;
+              _context.t1 = "Unexpected response ".concat(response.status, ": ");
+              _context.next = 9;
+              return response.text();
+            case 9:
+              _context.t2 = _context.sent;
+              _context.t3 = _context.t1.concat.call(_context.t1, _context.t2);
+              throw new _context.t0(_context.t3);
+            case 12:
+              _context.next = 14;
+              return response.text();
+            case 14:
+              valuesPayload = _context.sent;
+              return _context.abrupt("return", ConfigCollection.fromValues(valuesPayload));
+            case 16:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      function fetch(_x) {
+        return _fetch.apply(this, arguments);
+      }
+      return fetch;
+    }()
+  }]);
+  return ConfigClient;
+}();

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export { type FetchOptions, ConfigClient } from './main';
+export { ConfigCollection, ConfigError, ConfigMapSchema, type ConfigResult, type ValuesPayload, type ZConfigMap, } from '@atlaskit/config-common-libs';

package/dist/types/main.d.ts

@@ -0,0 +1,29 @@
+import { ConfigCollection } from '@atlaskit/config-common-libs';
+import type { IdentifierEnum } from '@atlassian/feature-gate-node-client-standalone';
+export interface FetchOptions {
+    /**
+     * Base URL of the feature-flag-service
+     */
+    ffsBaseUrl: string;
+    /**
+     * Your fx3/feature-flag-service API Key
+     * You can get it from here: https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/
+     */
+    ffsApiKey: string;
+    /**
+     * User context to evaluate against
+     */
+    context: {
+        identifiers: {
+            [id in IdentifierEnum]?: string | undefined;
+        };
+        metadata: Record<string, string | number | boolean>;
+    };
+    /**
+     * Optional: use this to pass in your own `fetch` instance.
+     */
+    fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+}
+export declare class ConfigClient {
+    static fetch(options: FetchOptions): Promise<ConfigCollection>;
+}

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,2 @@
+export { type FetchOptions, ConfigClient } from './main';
+export { ConfigCollection, ConfigError, ConfigMapSchema, type ConfigResult, type ValuesPayload, type ZConfigMap, } from '@atlaskit/config-common-libs';

package/dist/types-ts4.5/main.d.ts

@@ -0,0 +1,29 @@
+import { ConfigCollection } from '@atlaskit/config-common-libs';
+import type { IdentifierEnum } from '@atlassian/feature-gate-node-client-standalone';
+export interface FetchOptions {
+    /**
+     * Base URL of the feature-flag-service
+     */
+    ffsBaseUrl: string;
+    /**
+     * Your fx3/feature-flag-service API Key
+     * You can get it from here: https://developer.atlassian.com/platform/frontend-feature-flags/resources/api-keys/
+     */
+    ffsApiKey: string;
+    /**
+     * User context to evaluate against
+     */
+    context: {
+        identifiers: {
+            [id in IdentifierEnum]?: string | undefined;
+        };
+        metadata: Record<string, string | number | boolean>;
+    };
+    /**
+     * Optional: use this to pass in your own `fetch` instance.
+     */
+    fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+}
+export declare class ConfigClient {
+    static fetch(options: FetchOptions): Promise<ConfigCollection>;
+}

package/package.json

@@ -0,0 +1,93 @@
+{
+	"name": "@atlaskit/web-config-client",
+	"version": "0.2.0",
+	"description": "JavaScript Frontend Web Client for Dynamic Configuration.",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "MEP: Switcheroo",
+		"website": {
+			"name": "WebConfigClient",
+			"category": "Components"
+		}
+	},
+	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <5.4": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": [
+		"*.compiled.css"
+	],
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/config-common-libs": "*",
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0"
+	},
+	"devDependencies": {
+		"@af/integration-testing": "*",
+		"@af/visual-regression": "*",
+		"@atlaskit/ssr": "*",
+		"@atlaskit/visual-regression": "*",
+		"@atlassian/feature-gate-node-client-standalone": "^3.5.0",
+		"@testing-library/react": "^12.1.5",
+		"react-dom": "^16.8.0",
+		"typescript": "~5.4.2",
+		"wait-for-expect": "^1.2.0"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"code-structure": [
+				"tangerine-next"
+			],
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			],
+			"styling": [
+				"static",
+				"compiled"
+			],
+			"imports": [
+				"import-no-extraneous-disable-for-examples-and-docs"
+			]
+		}
+	}
+}