feat: create sdk-server-edge package (#83)

* feat: improved the cloudflare LDClient type. Fixed typedoc completely. Removed redundant createLDClient function.

* fix: broken waitForInitialization link

* chore: moved shared code to shared/sdk-server-edge-function

* chore: add platformInfo to typedoc

* chore: move common code to shared-server-edge. refactored cloudflare package to use that.

* test: support track, initialized and close. add unit tests for unsupported functions.

* chore: enable sendEvents and fix hanging unit tests.

* fix: change build target commonjs

* chore: cleanup readme and changelog. Changed EdgeFunction* to just Edge*

* chore: add ci

* feat: include all ldClient functions. Set sendEvents to false.

* fix: remove unused import

* fix: support logger as an option. validate options before constructor. added comments to BasicLogger.get.

* chore: improve docs. start validation of public options.

* test: added validateOptions function and unit tests.

* fix: improved typedoc

---------

Co-authored-by: Yusinto Ngadiman <[email protected]>

Author: yusinto

.github/workflows/sdk-server-edge.yml

@@ -0,0 +1,27 @@
+name: shared/sdk-server
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-sdk-server:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/js-server-sdk-common-edge'
+          workspace_path: packages/shared/sdk-server-edge

package.json

@@ -3,6 +3,7 @@
   "workspaces": [
     "packages/shared/common",
     "packages/shared/sdk-server",
+    "packages/shared/sdk-server-edge",
     "packages/sdk/server-node",
     "packages/sdk/cloudflare"
   ],

packages/sdk/cloudflare/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@launchdarkly/cloudflare-server-sdk",
   "version": "0.0.1",
-  "description": "LaunchDarkly Server-Side SDK for Cloudflare workers",
+  "description": "Cloudflare LaunchDarkly SDK",
   "packageManager": "[email protected]",
   "keywords": [
     "launchdarkly",
@@ -11,22 +11,22 @@
   ],
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",
-  "type": "module",
   "files": [
     "/dist"
   ],
   "scripts": {
+    "doc": "../../../scripts/build-doc.sh .",
     "build": "rimraf dist && yarn tsc",
     "tsw": "yarn tsc --watch",
     "start": "rimraf dist && yarn tsw",
     "lint": "eslint . --ext .ts",
     "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest --ci --runInBand --coverage",
-    "check": "yarn prettier && yarn lint && yarn tsc && yarn test"
+    "check": "yarn prettier && yarn lint && yarn build && yarn test && yarn doc"
   },
   "dependencies": {
     "@cloudflare/workers-types": "^4.20230321.0",
-    "@launchdarkly/js-server-sdk-common": "0.2.0",
+    "@launchdarkly/js-server-sdk-common-edge": "0.0.1",
     "crypto-js": "^4.1.1"
   },
   "devDependencies": {

packages/sdk/cloudflare/src/createLDClient/createFeatureStore.test.ts renamed to packages/sdk/cloudflare/src/createFeatureStore.test.ts

@@ -1,8 +1,8 @@
-import { AsyncStoreFacade, LDFeatureStore } from '@launchdarkly/js-server-sdk-common';
+import { AsyncStoreFacade, LDFeatureStore } from '@launchdarkly/js-server-sdk-common-edge';
 import createFeatureStore from './createFeatureStore';
 
-import mockKV from '../utils/mockKV';
-import * as testData from '../utils/testData.json';
+import mockKV from './utils/mockKV';
+import * as testData from './utils/testData.json';
 
 describe('createFeatureStore', () => {
   const sdkKey = 'sdkKey';

packages/sdk/cloudflare/src/createLDClient/createFeatureStore.ts renamed to packages/sdk/cloudflare/src/createFeatureStore.ts

@@ -1,13 +1,13 @@
 import type { KVNamespace } from '@cloudflare/workers-types';
-import type {
+import {
   DataKind,
   LDLogger,
   LDFeatureStore,
   LDFeatureStoreDataStorage,
   LDFeatureStoreItem,
   LDFeatureStoreKindData,
-} from '@launchdarkly/js-server-sdk-common';
-import noop from '../utils/noop';
+  noop,
+} from '@launchdarkly/js-server-sdk-common-edge';
 
 const createFeatureStore = (kvNamespace: KVNamespace, sdkKey: string, logger: LDLogger) => {
   const key = `LD-Env-${sdkKey}`;

packages/sdk/cloudflare/src/createLDClient/CloudflareImpl.ts

@@ -1,8 +1,8 @@
-import type { Info, PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common';
+import type { Info, PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common-edge';
 
-import { name, version } from '../../package.json';
+import { name, version } from '../package.json';
 
-export default class CloudflareInfo implements Info {
+class CloudflarePlatformInfo implements Info {
   platformData(): PlatformData {
     return {
       name: 'Cloudflare worker',
@@ -16,3 +16,7 @@ export default class CloudflareInfo implements Info {
     };
   }
 }
+
+const createPlatformInfo = () => new CloudflarePlatformInfo();
+
+export default createPlatformInfo;