Added a second sdk version for Akamai that supports customers using their own custom feature store and updated semantic versioning for alpha release

Author: ctawiah

package.json

@@ -10,6 +10,8 @@
     "packages/sdk/cloudflare/example",
     "packages/sdk/vercel",
     "packages/sdk/vercel/example-vercel",
+    "packages/sdk/akamai",
+    "packages/sdk/akamai/example",
     "packages/sdk/akamai-edgekv",
     "packages/sdk/akamai-edgekv/example"
   ],

packages/sdk/akamai-edgekv/example/main.ts

@@ -16,9 +16,9 @@ export async function onClientRequest(request: EW.IngressClientRequest) {
   try {
     const showAds = await evaluateFlagWithEdgeKV('enable-ads', createLDContext(request), false);
 
-    let response = createResponse('Ads are hidden');
+    let response = createResponse('Ads are hidden with flag');
     if (showAds) {
-      response = createResponse('Showing random advertisements');
+      response = createResponse('Showing random advertisements with flag');
     }
 
     request.respondWith(200, {}, response);

packages/sdk/akamai-edgekv/example/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "akamai-playground",
-  "version": "1.0.2",
+  "name": "akamai-edgekv-playground",
+  "version": "1.0.4",
   "description": "",
   "main": "main.js",
   "config": {
@@ -31,6 +31,6 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@launchdarkly/akamai-server-edgekv-sdk": "^0.1.0-alpha"
+    "@launchdarkly/akamai-server-edgekv-sdk": "^0.1.0"
   }
 }

packages/sdk/akamai-edgekv/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@launchdarkly/akamai-server-edgekv-sdk",
-  "version": "0.1.0-alpha",
+  "version": "0.1.0",
   "description": "Akamai LaunchDarkly EdgeWorker SDK for EdgeKV feature store",
-  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai",
+  "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai-edgekv",
   "repository": {
     "type": "git",
     "url": "https://github.com/launchdarkly/js-core.git"

packages/sdk/akamai-edgekv/src/edgekv/edgeKVProvider.ts

@@ -1,4 +1,4 @@
-import { EdgeProvider } from './edgeFeatureStore';
+import { EdgeProvider } from '@launchdarkly/akamai-edgeworker-sdk-common';
 import { EdgeKV } from './edgekv';
 
 type EdgeKVProviderParams = {

packages/sdk/akamai-edgekv/src/index.ts

@@ -16,9 +16,9 @@ import {
   LDMultiKindContext,
   LDSingleKindContext,
   LDOptions,
+  EdgeFeatureStore,
 } from '@launchdarkly/akamai-edgeworker-sdk-common';
 import { BasicLogger } from '@launchdarkly/js-server-sdk-common';
-import { EdgeFeatureStore } from './edgekv/edgeFeatureStore';
 import EdgeKVProvider from './edgekv/edgeKVProvider';
 
 type AkamaiLDClientParams = {
@@ -51,6 +51,6 @@ export const init = ({
     edgeFeatureStore: featureStore,
     platformName: 'Akamai EdgeWorker',
     sdkName: '@launchdarkly/akamai-server-edgekv-sdk',
-    sdkVersion: '0.1.0-alpha', // {x-release-please-version}
+    sdkVersion: '0.1.0', // {x-release-please-version}
   });
 };

packages/sdk/akamai/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to the LaunchDarkly SDK for Akamai Workers will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).

packages/sdk/akamai/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Catamorphic, Co.
+
+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.

packages/sdk/akamai/README.md

@@ -0,0 +1,46 @@
+# LaunchDarkly Akamai SDK for EdgeKV
+
+[![NPM][sdk-akamai-npm-badge]][sdk-akamai-npm-link]
+[![Actions Status][sdk-akamai-ci-badge]][sdk-akamai-ci]
+[![Documentation][sdk-akamai-ghp-badge]][sdk-akamai-ghp-link]
+[![NPM][sdk-akamai-dm-badge]][sdk-akamai-npm-link]
+[![NPM][sdk-akamai-dt-badge]][sdk-akamai-npm-link]
+
+The LaunchDarkly Akamai SDK is designed primarily for use in Akamai Edgeworkers. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
+
+For more information, see the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/akamai).
+
+## Install
+
+```shell
+npm i @launchdarkly/akamai-server-edgekv-sdk
+```
+
+## Quickstart
+
+
+See the full [example app](https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai-edgekv/example).
+
+## Developing this SDK
+
+```shell
+# at js-core repo root
+yarn && yarn build && cd packages/sdk/akamai-edgekv
+
+# run tests
+yarn test
+```
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates

packages/sdk/akamai/example/README.md

@@ -0,0 +1,49 @@
+### Akamai Edge POC
+
+This is an internal POC to see how compatible our js-core package is with Akamai's EW runtime.
+
+## Getting started
+
+1. Run the following command to install dependencies
+
+```shell
+npm install
+```
+
+2. Install the [Akamai CLI](https://github.com/akamai/cli)
+
+```shell
+brew install akamai
+```
+
+3. Follow [these instructions](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials) to add your credentials to the CLI.
+
+4. Install the edgeworkers CLI package
+
+```shell
+akamai install edgeworkers
+```
+
+5. Install the sandbox CLI package
+
+```shell
+akamai install sandbox
+```
+
+6. Create a local sandbox
+
+```shell
+akamai sandbox create --property hello-akamai.dev.launchdarkly.com:15 --name <YOUR_NAME>CODING_SANDBOX
+```
+
+7. Transpile the code, create the bundle, and update the Sandbox client
+
+```shell
+npm run dev
+```
+
+8. Run the following command to test the EdgeWorker
+
+```shell
+curl -v -H 'Host: hello-akamai.dev.launchdarkly.com' -H 'Pragma: akamai-x-ew-debug'  http://127.0.0.1:9550/hello
+```