feat: Adding CreatePlatformInfo for Akamai SDK (#122)

Adding the Create platform class and test for the Akamai SDK
Added `@launchdarkly/js-server-sdk-common-edge` dependency
Removed unnecessary file inclusion from tsconfig

Author: dariushar

.github/workflows/akamai.yml

@@ -20,5 +20,5 @@ jobs:
         name: Shared CI Steps
         uses: ./actions/ci
         with:
-          workspace_name: '@launchdarkly/akamai-server-sdk'
+          workspace_name: '@launchdarkly/akamai-edgeworker-sdk'
           workspace_path: packages/sdk/akamai

README.md

@@ -10,7 +10,7 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
 | [@launchdarkly/cloudflare-server-sdk](packages/sdk/cloudflare/README.md) | [![NPM][sdk-cloudflare-npm-badge]][sdk-cloudflare-npm-link]   | [Cloudflare][package-sdk-cloudflare-issues]      | [![Actions Status][sdk-cloudflare-ci-badge]][sdk-cloudflare-ci]   |
 | [@launchdarkly/node-server-sdk](packages/sdk/server-node/README.md)      | [![NPM][sdk-server-node-npm-badge]][sdk-server-node-npm-link] | [Node.js Server][package-sdk-server-node-issues] | [![Actions Status][sdk-server-node-ci-badge]][sdk-server-node-ci] |
 | [@launchdarkly/vercel-server-sdk](packages/sdk/vercel/README.md)         | [![NPM][sdk-vercel-npm-badge]][sdk-vercel-npm-link]           | [Vercel][package-sdk-vercel-issues]              | [![Actions Status][sdk-vercel-ci-badge]][sdk-vercel-ci]           |
-| [@launchdarkly/akamai-server-sdk](packages/sdk/akamai/README.md)         | [![NPM][sdk-akamai-npm-badge]][sdk-akamai-npm-link]           | [Akamai][package-sdk-akamai-issues]              | [![Actions Status][sdk-akamai-ci-badge]][sdk-akamai-ci]           |
+| [@launchdarkly/akamai-edgeworker-sdk](packages/sdk/akamai/README.md)         | [![NPM][sdk-akamai-npm-badge]][sdk-akamai-npm-link]           | [Akamai][package-sdk-akamai-issues]              | [![Actions Status][sdk-akamai-ci-badge]][sdk-akamai-ci]           |
 
 | Shared packages                                                                      | npm                                                                       | issues                                                      | tests                                                                           |
 | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------- |
@@ -101,10 +101,10 @@ We encourage pull requests and other contributions from the community. Check out
 [//]: # 'sdk/akamai'
 [sdk-akamai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml/badge.svg
 [sdk-akamai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml
-[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-sdk.svg?style=flat-square
-[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-sdk
+[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
+[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-edgeworker-sdk
 [sdk-akamai-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
 [sdk-akamai-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/
-[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-sdk.svg?style=flat-square
-[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-sdk.svg?style=flat-square
+[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
+[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
 [package-sdk-akamai-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fakamai%22+

packages/sdk/akamai/README.md

@@ -13,7 +13,7 @@ For more information, see the [complete reference guide for this SDK](https://do
 ## Install
 
 ```shell
-npm i @launchdarkly/akamai-server-sdk
+npm i @launchdarkly/akamai-edgeworker-sdk
 ```
 
 Then turn on the Node.js compatibility flag in your `wrangler.toml`. This allows the SDK to use `node:events`:
@@ -53,9 +53,9 @@ yarn test
 
 [sdk-akamai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml/badge.svg
 [sdk-akamai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/akamai.yml
-[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-server-sdk.svg?style=flat-square
-[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-server-sdk
+[sdk-akamai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
+[sdk-akamai-npm-link]: https://www.npmjs.com/package/@launchdarkly/akamai-edgeworker-sdk
 [sdk-akamai-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
 [sdk-akamai-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/akamai/docs/
-[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-server-sdk.svg?style=flat-square
-[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-server-sdk.svg?style=flat-square
+[sdk-akamai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square
+[sdk-akamai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/akamai-edgeworker-sdk.svg?style=flat-square

packages/sdk/akamai/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@launchdarkly/akamai-server-sdk",
+  "name": "@launchdarkly/akamai-edgeworker-sdk",
   "version": "0.0.1",
   "description": "Akamai LaunchDarkly SDK",
   "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/akamai",
@@ -37,7 +37,9 @@
     "coverage": "yarn test --coverage",
     "check": "yarn prettier && yarn lint && yarn build && yarn test && yarn doc"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@launchdarkly/js-server-sdk-common-edge": "^1.0.2"
+  },
   "devDependencies": {
     "@types/jest": "^29.5.1",
     "@typescript-eslint/eslint-plugin": "^5.57.0",

packages/sdk/akamai/src/createPlatformInfo.test.ts

@@ -0,0 +1,22 @@
+import createPlatformInfo from './createPlatformInfo';
+
+const packageJson = require('../package.json');
+
+describe('Akamai Platform Info', () => {
+  it('platformData shows correct information', () => {
+    const platformData = createPlatformInfo();
+
+    expect(platformData.platformData()).toEqual({
+      name: 'Akamai EdgeWorker',
+    });
+  });
+
+  it('sdkData shows correct information', () => {
+    const platformData = createPlatformInfo();
+
+    expect(platformData.sdkData()).toEqual({
+      name: packageJson.name,
+      version: packageJson.version,
+    });
+  });
+});

packages/sdk/akamai/src/createPlatformInfo.ts

@@ -0,0 +1,25 @@
+import type { Info, PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common-edge';
+
+/*
+  TODO: 
+    Add to release-please-config.json when ready for release
+    This is needed to update the version number for sdkData
+*/
+class AkamaiPlatformInfo implements Info {
+  platformData(): PlatformData {
+    return {
+      name: 'Akamai EdgeWorker',
+    };
+  }
+
+  sdkData(): SdkData {
+    return {
+      name: '@launchdarkly/akamai-edgeworker-sdk',
+      version: '0.0.1', // {x-release-please-version}
+    };
+  }
+}
+
+const createPlatformInfo = () => new AkamaiPlatformInfo();
+
+export default createPlatformInfo;

packages/sdk/akamai/tsconfig.ref.json

@@ -1,6 +1,6 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["src/**/*", "package.json", "src/**/testData.json"],
+  "include": ["src/**/*", "package.json"],
   "compilerOptions": {
     "composite": true
   }