@newskit-render/feature-flags 0.1.2 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,50 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.4.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/feature-flags@0.3.1...@newskit-render/feature-flags@0.4.0) (2021-11-22)
+
+
+### Features
+
+* **PPDSR-0:** fix broken dependecy ([#521](https://github.com/newscorp-ghfb/ncu-newskit-render/issues/521)) ([2690dd3](https://github.com/newscorp-ghfb/ncu-newskit-render/commit/2690dd3bc6cf61a88740a0ff935adf461be02416))
+
+
+
+
+
+## [0.3.1](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/feature-flags@0.3.0...@newskit-render/feature-flags@0.3.1) (2021-11-15)
+
+
+### Bug Fixes
+
+* **PPDSR-541:** change packages to get published ([#506](https://github.com/newscorp-ghfb/ncu-newskit-render/issues/506)) ([4de773b](https://github.com/newscorp-ghfb/ncu-newskit-render/commit/4de773b8e22663a2822f64255f347c32384532c0))
+
+
+
+
+
+# [0.3.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/feature-flags@0.2.0...@newskit-render/feature-flags@0.3.0) (2021-11-10)
+
+
+### Features
+
+* **PPDSR-496:** add next link wrapper component ([#500](https://github.com/newscorp-ghfb/ncu-newskit-render/issues/500)) ([a8ca436](https://github.com/newscorp-ghfb/ncu-newskit-render/commit/a8ca436f6f8061d58e857eb83d7d3ee9cfb449a6))
+
+
+
+
+
+# [0.2.0](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/feature-flags@0.1.2...@newskit-render/feature-flags@0.2.0) (2021-11-10)
+
+
+### Features
+
+* **PPDSR-500:** Up next version and switch to es2015 ([#496](https://github.com/newscorp-ghfb/ncu-newskit-render/issues/496)) ([1e41435](https://github.com/newscorp-ghfb/ncu-newskit-render/commit/1e414351247e4c069a829a0a2210a8e6da0e0287))
+
+
+
+
+
 ## [0.1.2](https://github.com/newscorp-ghfb/ncu-newskit-render/compare/@newskit-render/feature-flags@0.1.1...@newskit-render/feature-flags@0.1.2) (2021-11-08)
 
 **Note:** Version bump only for package @newskit-render/feature-flags

package/README.md

@@ -3,13 +3,15 @@
 A package for adding feature flags to projects generated by newskit-render.
 
 ## How to use:
+
 `yarn add @newskit-render/feature-flags` or <br />
 `npm install --save @newskit-render/feature-flags` <br /><br />
 
 There are two ways that feature flags can be utilized.
-### getFeatureFlags() in getServerSideProps ###
 
-The most performant way to use feature flags is to call `getFeatureFlags()` in `getServersideProps` and then use them throughout the page. This way the implementation will only be available for the current page and and wouldn't effect the rest of the site. 
+### getFeatureFlags() in getServerSideProps
+
+The most performant way to use feature flags is to call `getFeatureFlags()` in `getServersideProps` and then use them throughout the page. This way the implementation will only be available for the current page and and wouldn't effect the rest of the site.
 To do so you will need to initialize the package by calling `createFeatureFlagsInstance` with the sdkKey from optimizely.
 Best practice is to store your sdk key in environment variables, the examples below utilize that method.
 For local use, you cadd the Optimizely SDK key from your project in your `.env.local` file like so
@@ -19,6 +21,7 @@ Optionally the config can be switched to suit your need. More on this can be fou
 An example implementation would be as follows:
 
 `pages/index.ts`
+
 ```
 import {getFeatureFlags, createFeatureFlagsInstance} from '@newskit-render/feature-flags';
 
@@ -31,7 +34,7 @@ export async function getServerSideProps(context) {
      // other queries,
      getFeatureFlags()
   ])
-  
+
   const featureFlags = featureFlagsResult.value;
 
   return {
@@ -42,6 +45,7 @@ export async function getServerSideProps(context) {
   }
 }
 ```
+
 `samplePage/index.tsx`
 
 ```
@@ -51,9 +55,9 @@ import { FeatureFlag } from '@newskit-render/feature-flags'
 const SectionPage: React.FC<{
   page: Page
   // pageprops...
-  featureFlags?: FeatureFlag[] 
+  featureFlags?: FeatureFlag[]
 }> = ({ page, pageprops..., featureFlags }) => {
-  
+
   return(
       <Layout>
         {featureFlags && featureFlags['test_flag'] && <p>FEATURE FLAG IS HEREEE</p>}
@@ -67,14 +71,15 @@ export default SamplePage
 
 ```
 
-### hooks in getInitialProps ###
+### hooks in getInitialProps
 
 Alternatively, feature flags can be applied on the whole app. To do so, you'll need to instantiate the package in `getInitialProps` of the main app, then call `getFeatureFlags` and pass the result to the whole app.
-By calling the `useFeatureFlagsContext` hook, the list of featureFlags can be accessed from any point of the site. 
+By calling the `useFeatureFlagsContext` hook, the list of featureFlags can be accessed from any point of the site.
 <br /> <br />
 Below we explore a solution, where we use it in the header of the app.
 
 `pages/_app.tsx`
+
 ```
 import { getFeatureFlags, FeatureFlagsContextProvider, FeatureFlag, createFeatureFlagsInstance } from '@newskit-render/feature-flags';
 
@@ -94,7 +99,6 @@ MyApp.getInitialProps = async () => {
 export default MyApp
 ```
 
-
 `header/index.tsx`
 
 ```
@@ -102,7 +106,7 @@ import { useFeatureFlagsContext } from '@newskit-render/feature-flags';
 
 const Header: React.FC<{ user: UserData }> = ({ user }) => {
   const featureFlags = useFeatureFlagsContext();
-  
+
   return (
     <>
       <StyledHeader>
@@ -122,8 +126,10 @@ const Header: React.FC<{ user: UserData }> = ({ user }) => {
 
 export default Header
 ```
-### createFeatureFlagsInstance ###
-`createFeatureFlagsInstance` takes config object as parameter. The config object consists of [`optimizelyConfig`](https://docs.developers.optimizely.com/full-stack/v4.0/docs/initialize-sdk-javascript-node#section-parameters), `userId`, `defaultFeatureFlags`, `logLevel`. The only requirement for the feature flags to be instantiated is passing optimizely sdk key to `optimizelyConfig`. Further, the whole config can be changed to suit your needs. 
+
+### createFeatureFlagsInstance
+
+`createFeatureFlagsInstance` takes config object as parameter. The config object consists of [`optimizelyConfig`](https://docs.developers.optimizely.com/full-stack/v4.0/docs/initialize-sdk-javascript-node#section-parameters), `userId`, `defaultFeatureFlags`, `logLevel`. The only requirement for the feature flags to be instantiated is passing optimizely sdk key to `optimizelyConfig`. Further, the whole config can be changed to suit your needs.
 `userId` serves as optimizely user identity.
 `defaultFeatureFlags` are used in the event that optimizely doesn't load up and initial values are required.
 `logLevel` serves to configure the optimizely logger if you wish to use it. It accepts `critical`, `error`, `warning`, `debug` or `info`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newskit-render/feature-flags",
-  "version": "0.1.2",
+  "version": "0.4.0",
   "description": "A package for utilizing feature flags for newskit-render consumers, based on optimizely's capabilities.",
   "author": "",
   "license": "UNLICENSED",