Merge branch 'main' of https://github.com/microsoft/FeatureManagement-JavaScript into zhiyuanliang/recurring-time-window

Author: zhiyuanliang-ms

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
 
     defaults:
       run:
-        working-directory: sdk/feature-management
+        working-directory: src/feature-management
 
     steps:
     - uses: actions/checkout@v3
@@ -31,40 +31,40 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-        cache-dependency-path: sdk/feature-management/package-lock.json
+        cache-dependency-path: src/feature-management/package-lock.json
 
     - name: Install dependencies
       run: npm ci
-      working-directory: sdk/feature-management
+      working-directory: src/feature-management
 
     - name: Run lint check for feature-management
       run: npm run lint
-      working-directory: sdk/feature-management
+      working-directory: src/feature-management
 
     - name: Build feature-management
       run: npm run build
-      working-directory: sdk/feature-management
+      working-directory: src/feature-management
 
     - name: Run tests
       run: npm run test
-      working-directory: sdk/feature-management
+      working-directory: src/feature-management
 
     - name: Run browser tests
       run: npm run test-browser
-      working-directory: sdk/feature-management
+      working-directory: src/feature-management
 
     - name: Build feature-management-applicationinsights-browser
       run: npm run build
-      working-directory: sdk/feature-management-applicationinsights-browser
+      working-directory: src/feature-management-applicationinsights-browser
 
     - name: Run lint check for feature-management-applicationinsights-browser
       run: npm run lint
-      working-directory: sdk/feature-management-applicationinsights-browser
+      working-directory: src/feature-management-applicationinsights-browser
 
     - name: Build feature-management-applicationinsights-node
       run: npm run build
-      working-directory: sdk/feature-management-applicationinsights-node
+      working-directory: src/feature-management-applicationinsights-node
 
     - name: Run lint check for feature-management-applicationinsights-node
       run: npm run lint
-      working-directory: sdk/feature-management-applicationinsights-node
+      working-directory: src/feature-management-applicationinsights-node

README.md

@@ -2,26 +2,29 @@
 
 [![feature-management](https://img.shields.io/npm/v/@microsoft/feature-management?label=@microsoft/feature-management)](https://www.npmjs.com/package/@microsoft/feature-management)
 
-Feature Management is a library for enabling/disabling features at runtime.
-Developers can use feature flags in simple use cases like conditional statement to more advanced scenarios like conditionally adding routes.
+Feature management provides a way to develop and expose application functionality based on features. Many applications have special requirements when a new feature is developed such as when the feature should be enabled and under what conditions. This library provides a way to define these relationships, and also integrates into common JavaScript code patterns to make exposing these features possible.
 
 ## Getting Started
 
-### Prerequisites
+[Azure App Configuration Quickstart](https://learn.microsoft.com/azure/azure-app-configuration/quickstart-feature-flag-javascript): A quickstart guide about how to integrate feature flags from Azure App Configuration into your JavaScript applications.
 
-- Node.js LTS version
+[Feature Overview](https://learn.microsoft.com/azure/azure-app-configuration/feature-management-overview#feature-development-status): This document provides a feature status overview.
+
+[Feature Reference](https://learn.microsoft.com/azure/azure-app-configuration/feature-management-javascript-reference): This document provides a full feature rundown.
 
 ### Usage
 
-You can use feature flags from the Azure App Configuration service, local files or any other sources.
+You can use feature flags from the Azure App Configuration service, local files or any other sources. For more information, please go to [Feature flag configuration](https://learn.microsoft.com/azure/azure-app-configuration/feature-management-javascript-reference#feature-flag-configuration).
 
 #### Use feature flags from Azure App Configuration
 
 The App Configuration JavaScript provider provides feature flags in as a `Map` object.
 A builtin `ConfigurationMapFeatureFlagProvider` helps to load feature flags in this case.
 
 ```js
-const appConfig = await load(connectionString, {featureFlagOptions}); // load feature flags from Azure App Configuration service
+import { load } from "@azure/app-configuration-provider";
+import { FeatureManager, ConfigurationMapFeatureFlagProvider } from "@microsoft/feature-management";
+const appConfig = await load("<CONNECTION-STRING>", {featureFlagOptions}); // load feature flags from Azure App Configuration service
 const featureProvider = new ConfigurationMapFeatureFlagProvider(appConfig);
 const featureManager = new FeatureManager(featureProvider);
 const isAlphaEnabled = await featureManager.isEnabled("Alpha");
@@ -54,13 +57,18 @@ Content of `sample.json`:
 
 Load feature flags from `sample.json` file.
 ```js
+import { FeatureManager, ConfigurationObjectFeatureFlagProvider } from "@microsoft/feature-management";
 const config = JSON.parse(await fs.readFile("path/to/sample.json"));
 const featureProvider = new ConfigurationObjectFeatureFlagProvider(config);
 const featureManager = new FeatureManager(featureProvider);
 const isAlphaEnabled = await featureManager.isEnabled("Alpha");
 console.log("Feature Alpha is:", isAlphaEnabled);
 ```
 
+## Examples
+
+See code snippets under [examples/](./examples/) folder.
+
 ## Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a

scripts/build-and-pack.sh

@@ -5,10 +5,16 @@ set -e
 
 SCRIPT_DIR=$(dirname $(readlink -f $0))
 PROJECT_BASE_DIR=$(dirname $SCRIPT_DIR)
-SDK_DIR="$PROJECT_BASE_DIR/sdk"
+NPMRC_FILE="$PROJECT_BASE_DIR/.npmrc"
+SRC_DIR="$PROJECT_BASE_DIR/src"
 
 PACKAGE="feature-management"
-PACKAGE_DIR="$SDK_DIR/$PACKAGE"
+PACKAGE_DIR="$SRC_DIR/$PACKAGE"
+
+if [ -f "$NPMRC_FILE" ]; then
+    echo "Copy .npmrc file to $PACKAGE_DIR"
+    cp "$NPMRC_FILE" "$PACKAGE_DIR"
+fi
 
 echo "Building package $PACKAGE in $PACKAGE_DIR"
 cd "$PACKAGE_DIR"
@@ -29,7 +35,12 @@ echo "copy $PACKAGE package to $PROJECT_BASE_DIR"
 cp "$PACKAGE_DIR"/*.tgz "$PROJECT_BASE_DIR"
 
 PACKAGE="feature-management-applicationinsights-browser"
-PACKAGE_DIR="$SDK_DIR/$PACKAGE"
+PACKAGE_DIR="$SRC_DIR/$PACKAGE"
+
+if [ -f "$NPMRC_FILE" ]; then
+    echo "Copy .npmrc file to $PACKAGE_DIR"
+    cp "$NPMRC_FILE" "$PACKAGE_DIR"
+fi
 
 echo "Building package $PACKAGE in $PACKAGE_DIR"
 cd "$PACKAGE_DIR"
@@ -44,7 +55,12 @@ echo "copy $PACKAGE package to $PROJECT_BASE_DIR"
 cp "$PACKAGE_DIR"/*.tgz "$PROJECT_BASE_DIR"
 
 PACKAGE="feature-management-applicationinsights-node"
-PACKAGE_DIR="$SDK_DIR/$PACKAGE"
+PACKAGE_DIR="$SRC_DIR/$PACKAGE"
+
+if [ -f "$NPMRC_FILE" ]; then
+    echo "Copy .npmrc file to $PACKAGE_DIR"
+    cp "$NPMRC_FILE" "$PACKAGE_DIR"
+fi
 
 echo "Building package $PACKAGE in $PACKAGE_DIR"
 cd "$PACKAGE_DIR"