launchdarkly-node-client-sdk 3.2.1 → 3.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/actions/publish-docs/action.yml +16 -0
- package/.github/actions/publish-npm/action.yml +20 -0
- package/.github/workflows/ci.yml +47 -0
- package/.github/workflows/lint-pr-title.yml +12 -0
- package/.github/workflows/release-please.yml +56 -0
- package/.release-please-manifest.json +3 -0
- package/.sdk_metadata.json +2 -1
- package/CHANGELOG.md +18 -0
- package/README.md +1 -1
- package/contract-tests/index.js +1 -0
- package/package.json +6 -5
- package/release-please-config.json +10 -0
- package/scripts/publish-npm.sh +11 -0
- package/src/index.js +1 -0
- package/typedoc.json +17 -0
- package/typings.d.ts +32 -15
- package/.circleci/config.yml +0 -96
- package/.ldrelease/config.yml +0 -27
- package/docs/Makefile +0 -28
- package/docs/doc.md +0 -7
- package/docs/tsconfig.json +0 -12
- package/docs/typedoc.js +0 -17
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
name: Publish Documentation
|
|
2
|
+
description: 'Publish documentation to github pages.'
|
|
3
|
+
|
|
4
|
+
inputs:
|
|
5
|
+
github_token:
|
|
6
|
+
description: 'The github token to use for committing'
|
|
7
|
+
required: true
|
|
8
|
+
|
|
9
|
+
runs:
|
|
10
|
+
using: composite
|
|
11
|
+
steps:
|
|
12
|
+
- uses: launchdarkly/gh-actions/actions/publish-pages@publish-pages-v1.0.2
|
|
13
|
+
name: 'Publish to Github pages'
|
|
14
|
+
with:
|
|
15
|
+
docs_path: docs
|
|
16
|
+
github_token: ${{ inputs.github_token }}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
name: Publish to NPM
|
|
2
|
+
description: Publish an npm package.
|
|
3
|
+
inputs:
|
|
4
|
+
prerelease:
|
|
5
|
+
description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
|
|
6
|
+
required: false
|
|
7
|
+
dry-run:
|
|
8
|
+
description: 'Is this a dry run. If so no package will be published.'
|
|
9
|
+
required: false
|
|
10
|
+
|
|
11
|
+
runs:
|
|
12
|
+
using: composite
|
|
13
|
+
steps:
|
|
14
|
+
- name: Publish
|
|
15
|
+
shell: bash
|
|
16
|
+
run: |
|
|
17
|
+
./scripts/publish-npm.sh
|
|
18
|
+
env:
|
|
19
|
+
LD_RELEASE_IS_PRERELEASE: ${{ inputs.prerelease }}
|
|
20
|
+
LD_RELEASE_IS_DRYRUN: ${{ inputs.dry-run }}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
name: Build and Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
paths-ignore:
|
|
7
|
+
- '**.md' #Do not need to run CI for markdown changes.
|
|
8
|
+
pull_request:
|
|
9
|
+
branches: [main]
|
|
10
|
+
paths-ignore:
|
|
11
|
+
- '**.md'
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build-test:
|
|
15
|
+
strategy:
|
|
16
|
+
matrix:
|
|
17
|
+
variations: [
|
|
18
|
+
{os: ubuntu-latest, node: latest},
|
|
19
|
+
{os: ubuntu-latest, node: 18}
|
|
20
|
+
]
|
|
21
|
+
|
|
22
|
+
runs-on: ${{ matrix.variations.os }}
|
|
23
|
+
env:
|
|
24
|
+
TEST_SERVICE_PORT: 8000
|
|
25
|
+
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@v4
|
|
28
|
+
- uses: actions/setup-node@v4
|
|
29
|
+
with:
|
|
30
|
+
node-version: ${{ matrix.variations.node }}
|
|
31
|
+
registry-url: 'https://registry.npmjs.org'
|
|
32
|
+
- name: Install
|
|
33
|
+
run: npm install
|
|
34
|
+
- name: Test
|
|
35
|
+
run: npm test
|
|
36
|
+
- name: Lint
|
|
37
|
+
run: npm run lint:all
|
|
38
|
+
- name: Check typescript
|
|
39
|
+
run: npm run check-typescript
|
|
40
|
+
- name: Run contract test service
|
|
41
|
+
run: npm run contract-test-service 2>&1 &
|
|
42
|
+
- uses: launchdarkly/gh-actions/actions/contract-tests@contract-tests-v1.0.0
|
|
43
|
+
with:
|
|
44
|
+
test_service_port: ${{ env.TEST_SERVICE_PORT }}
|
|
45
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
|
46
|
+
- name: Build Docs
|
|
47
|
+
run: npm run doc
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
name: Release Please
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release-please:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
outputs:
|
|
12
|
+
release_created: ${{ steps.release.outputs.release_created }}
|
|
13
|
+
steps:
|
|
14
|
+
- uses: googleapis/release-please-action@v4
|
|
15
|
+
id: release
|
|
16
|
+
with:
|
|
17
|
+
token: ${{secrets.GITHUB_TOKEN}}
|
|
18
|
+
|
|
19
|
+
publish-package:
|
|
20
|
+
runs-on: ubuntu-latest
|
|
21
|
+
needs: ['release-please']
|
|
22
|
+
permissions:
|
|
23
|
+
id-token: write
|
|
24
|
+
contents: write
|
|
25
|
+
if: ${{ needs.release-please.outputs.release_created == 'true' }}
|
|
26
|
+
steps:
|
|
27
|
+
- uses: actions/checkout@v4
|
|
28
|
+
|
|
29
|
+
- uses: actions/setup-node@v4
|
|
30
|
+
with:
|
|
31
|
+
node-version: 24.x
|
|
32
|
+
registry-url: 'https://registry.npmjs.org'
|
|
33
|
+
|
|
34
|
+
- name: Update NPM
|
|
35
|
+
shell: bash
|
|
36
|
+
# Must be greater than 11.5.1 for OIDC.
|
|
37
|
+
run: npm install -g npm@11.6.2
|
|
38
|
+
|
|
39
|
+
- name: Install Dependencies
|
|
40
|
+
run: npm install
|
|
41
|
+
|
|
42
|
+
- id: publish-npm
|
|
43
|
+
name: Publish NPM Package
|
|
44
|
+
uses: ./.github/actions/publish-npm
|
|
45
|
+
with:
|
|
46
|
+
dry-run: 'false'
|
|
47
|
+
prerelease: 'false'
|
|
48
|
+
|
|
49
|
+
- name: Build Documentation
|
|
50
|
+
run: npm run doc
|
|
51
|
+
|
|
52
|
+
- id: publish-docs
|
|
53
|
+
name: Publish Documentation
|
|
54
|
+
uses: ./.github/actions/publish-docs
|
|
55
|
+
with:
|
|
56
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
package/.sdk_metadata.json
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to the LaunchDarkly Client-Side SDK for Node.js will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## [3.3.1](https://github.com/launchdarkly/node-client-sdk/compare/3.3.0...3.3.1) (2025-12-02)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* Correct typing and prevents warnings for secure mode hash during initialization. ([#59](https://github.com/launchdarkly/node-client-sdk/issues/59)) ([33c129d](https://github.com/launchdarkly/node-client-sdk/commit/33c129de7b7a8032d2749445058e0aeca9e38b10)), closes [#57](https://github.com/launchdarkly/node-client-sdk/issues/57)
|
|
11
|
+
|
|
12
|
+
## [3.3.0](https://github.com/launchdarkly/node-client-sdk/compare/3.2.1...3.3.0) (2024-10-18)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* Add support for client-side prerequisite events. ([#49](https://github.com/launchdarkly/node-client-sdk/issues/49)) ([7495877](https://github.com/launchdarkly/node-client-sdk/commit/7495877e9bcff857b3ba6cef36e0de8a9120c57e))
|
|
18
|
+
|
|
19
|
+
## [3.2.1] - 2024-05-23
|
|
20
|
+
### Fixed:
|
|
21
|
+
- Updated `launchdarkly-evensource` to version `2.0.3` which includes improvements to error handling and shutdown of SSE streams.
|
|
22
|
+
|
|
5
23
|
## [3.2.0] - 2024-05-01
|
|
6
24
|
### Added:
|
|
7
25
|
- Added an optional timeout to the `waitForInitialization` method. When a timeout is specified the returned promise will be rejected after the timeout elapses if the client has not finished initializing within that time. When no timeout is specified the returned promise will not be resolved or rejected until the initialization either completes or fails.
|
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# LaunchDarkly Client-Side SDK for Node.js
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/launchdarkly-node-client-sdk)
|
|
4
|
-
[](https://github.com/launchdarkly/node-client-sdk/actions/workflows/ci.yml)
|
|
5
5
|
[](https://launchdarkly.github.io/node-client-sdk)
|
|
6
6
|
|
|
7
7
|
The LaunchDarkly Client-Side SDK for Node.js is designed primarily for use by code that is deployed to an end user, such as in a desktop application or a smart device. It follows the client-side LaunchDarkly model for single-user contexts (much like our mobile or JavaScript SDKs). It is not intended for use in multi-user systems such as web servers and applications.
|
package/contract-tests/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "launchdarkly-node-client-sdk",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.3.1",
|
|
4
4
|
"description": "LaunchDarkly Client-Side SDK for Node.js",
|
|
5
5
|
"author": "LaunchDarkly <team@launchdarkly.com>",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
"check-typescript": "node_modules/typescript/bin/tsc",
|
|
19
19
|
"contract-test-service": "npm --prefix contract-tests install && npm --prefix contract-tests start",
|
|
20
20
|
"contract-test-harness": "curl -s https://raw.githubusercontent.com/launchdarkly/sdk-test-harness/main/downloader/run.sh \\ | VERSION=v2 PARAMS=\"-url http://localhost:8000 -debug -stop-service-at-end $TEST_HARNESS_PARAMS\" sh",
|
|
21
|
-
"contract-tests": "npm run contract-test-service & npm run contract-test-harness"
|
|
21
|
+
"contract-tests": "npm run contract-test-service & npm run contract-test-harness",
|
|
22
|
+
"doc": "typedoc"
|
|
22
23
|
},
|
|
23
24
|
"engines": {
|
|
24
25
|
"node": ">= 12.0.0"
|
|
@@ -40,8 +41,8 @@
|
|
|
40
41
|
"jest-junit": "^14.0.1",
|
|
41
42
|
"launchdarkly-js-test-helpers": "1.2.1",
|
|
42
43
|
"prettier": "2.7.1",
|
|
43
|
-
"typescript": "
|
|
44
|
-
"typedoc": "^0.
|
|
44
|
+
"typescript": "~5.4.5",
|
|
45
|
+
"typedoc": "^0.25.13"
|
|
45
46
|
},
|
|
46
47
|
"jest": {
|
|
47
48
|
"rootDir": "src",
|
|
@@ -65,7 +66,7 @@
|
|
|
65
66
|
},
|
|
66
67
|
"dependencies": {
|
|
67
68
|
"launchdarkly-eventsource": "2.0.3",
|
|
68
|
-
"launchdarkly-js-sdk-common": "5.
|
|
69
|
+
"launchdarkly-js-sdk-common": "5.4.0",
|
|
69
70
|
"node-localstorage": "^1.3.1"
|
|
70
71
|
},
|
|
71
72
|
"repository": {
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
if $LD_RELEASE_IS_DRYRUN ; then
|
|
3
|
+
echo "Doing a dry run of publishing."
|
|
4
|
+
else
|
|
5
|
+
if $LD_RELEASE_IS_PRERELEASE ; then
|
|
6
|
+
echo "Publishing with prerelease tag."
|
|
7
|
+
npm publish --tag prerelease --provenance --access public || { echo "npm publish failed" >&2; exit 1; }
|
|
8
|
+
else
|
|
9
|
+
npm publish --provenance --access public || { echo "npm publish failed" >&2; exit 1; }
|
|
10
|
+
fi
|
|
11
|
+
fi
|
package/src/index.js
CHANGED
|
@@ -10,6 +10,7 @@ function initialize(env, context, options = {}) {
|
|
|
10
10
|
const extraOptionDefs = {
|
|
11
11
|
localStoragePath: { type: 'string' },
|
|
12
12
|
tlsParams: { type: 'object' },
|
|
13
|
+
hash: { type: 'string' },
|
|
13
14
|
};
|
|
14
15
|
if (!options.logger) {
|
|
15
16
|
extraOptionDefs.logger = { default: basicLogger() };
|
package/typedoc.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://typedoc.org/schema.json",
|
|
3
|
+
"name": "launchdarkly-node-client-sdk",
|
|
4
|
+
"includeVersion": true,
|
|
5
|
+
"entryPoints": [
|
|
6
|
+
"typings.d.ts",
|
|
7
|
+
],
|
|
8
|
+
"readme": "none",
|
|
9
|
+
"visibilityFilters": {
|
|
10
|
+
"protected": false,
|
|
11
|
+
"private": false,
|
|
12
|
+
"inherited": true,
|
|
13
|
+
"external": true,
|
|
14
|
+
"@alpha": false,
|
|
15
|
+
"@beta": false
|
|
16
|
+
}
|
|
17
|
+
}
|
package/typings.d.ts
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
/**
|
|
2
|
+
* This is the API reference for the LaunchDarkly Client-Side Node SDK.
|
|
3
|
+
*
|
|
4
|
+
*
|
|
5
|
+
* In typical usage, you will call {@link initialize} once at startup time to obtain an instance of
|
|
6
|
+
* {@link LDClient}, which provides access to all of the SDK's functionality.
|
|
7
|
+
*
|
|
8
|
+
* For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/client-side/node-js).
|
|
9
|
+
*
|
|
10
|
+
* @packageDocumentation
|
|
11
|
+
*/
|
|
2
12
|
|
|
3
|
-
|
|
13
|
+
declare module 'launchdarkly-node-client-sdk' {
|
|
4
14
|
export * from 'launchdarkly-js-sdk-common';
|
|
5
15
|
|
|
6
16
|
import {
|
|
@@ -14,7 +24,6 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
14
24
|
LDOptionsBase,
|
|
15
25
|
LDContext
|
|
16
26
|
} from 'launchdarkly-js-sdk-common';
|
|
17
|
-
//// DOCBUILD-END-REPLACE
|
|
18
27
|
|
|
19
28
|
/**
|
|
20
29
|
* The current version string of the SDK.
|
|
@@ -26,13 +35,13 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
26
35
|
*
|
|
27
36
|
* Applications should instantiate a single instance for the lifetime of the application.
|
|
28
37
|
* The client will begin attempting to connect to LaunchDarkly as soon as it is created. To
|
|
29
|
-
* determine when it is ready to use, call
|
|
30
|
-
* event listener for the `"ready"` event using
|
|
38
|
+
* determine when it is ready to use, call {@link LDClient.waitForInitialization}, or register an
|
|
39
|
+
* event listener for the `"ready"` event using {@link LDClient.on}.
|
|
31
40
|
*
|
|
32
41
|
* @param envKey
|
|
33
42
|
* The LaunchDarkly environment ID.
|
|
34
43
|
* @param context
|
|
35
|
-
* The initial context properties. These can be changed later with
|
|
44
|
+
* The initial context properties. These can be changed later with {@link LDClient.identify}.
|
|
36
45
|
* The context must have a `key` property, except that if you omit `context.key` and set `context.anonymous` to
|
|
37
46
|
* true, the SDK will create a randomized unique key (which will be cached in local storage for the
|
|
38
47
|
* current OS user account, so the next initialization will reuse the same key).
|
|
@@ -56,13 +65,21 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
56
65
|
* of the TLS-related parameters supported by `https.request()`, such as `ca`, `cert`, and `key`.
|
|
57
66
|
*/
|
|
58
67
|
tlsParams?: LDTLSOptions;
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* The signed context key for Secure Mode.
|
|
71
|
+
*
|
|
72
|
+
* For more information, see the JavaScript SDK Reference Guide on
|
|
73
|
+
* [Secure mode](https://launchdarkly.com/docs/sdk/features/secure-mode#configure-secure-mode-in-javascript-based-sdks).
|
|
74
|
+
*/
|
|
75
|
+
hash?: string;
|
|
59
76
|
}
|
|
60
77
|
|
|
61
78
|
/**
|
|
62
79
|
* Additional parameters to pass to the Node HTTPS API for secure requests. These can include any
|
|
63
80
|
* of the TLS-related parameters supported by `https.request()`, such as `ca`, `cert`, and `key`.
|
|
64
|
-
* This object should be stored in the `tlsParams` property of
|
|
65
|
-
*
|
|
81
|
+
* This object should be stored in the `tlsParams` property of {@link LDOptions}.
|
|
82
|
+
*
|
|
66
83
|
* For more information, see the Node documentation for `https.request()` and `tls.connect()`.
|
|
67
84
|
*/
|
|
68
85
|
export interface LDTLSOptions {
|
|
@@ -81,7 +98,7 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
81
98
|
/**
|
|
82
99
|
* The LaunchDarkly SDK client object.
|
|
83
100
|
*
|
|
84
|
-
* Applications should configure the client at startup time with
|
|
101
|
+
* Applications should configure the client at startup time with {@link initialize}, and reuse the same instance.
|
|
85
102
|
*
|
|
86
103
|
* For more information, see the [SDK Reference Guide](https://docs.launchdarkly.com/sdk/client-side/node-js).
|
|
87
104
|
*/
|
|
@@ -89,19 +106,19 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
89
106
|
}
|
|
90
107
|
|
|
91
108
|
/**
|
|
92
|
-
* Provides a simple
|
|
109
|
+
* Provides a simple {@link LDLogger} implementation.
|
|
93
110
|
*
|
|
94
111
|
* This logging implementation uses a simple format that includes only the log level
|
|
95
112
|
* and the message text. Output is written to the standard error stream (`console.error`).
|
|
96
|
-
* You can filter by log level as described in
|
|
113
|
+
* You can filter by log level as described in {@link BasicLoggerOptions.level}.
|
|
97
114
|
*
|
|
98
|
-
* To use the logger created by this function, put it into
|
|
99
|
-
* you do not set
|
|
115
|
+
* To use the logger created by this function, put it into {@link LDOptions.logger}. If
|
|
116
|
+
* you do not set {@link LDOptions.logger} to anything, the SDK uses a default logger
|
|
100
117
|
* that is equivalent to `ld.basicLogger({ level: 'info' })`.
|
|
101
118
|
*
|
|
102
119
|
* @param options Configuration for the logger. If no options are specified, the
|
|
103
120
|
* logger uses `{ level: 'info' }`.
|
|
104
|
-
*
|
|
121
|
+
*
|
|
105
122
|
* @example
|
|
106
123
|
* This example shows how to use `basicLogger` in your SDK options to enable console
|
|
107
124
|
* logging only at `warn` and `error` levels.
|
|
@@ -120,7 +137,7 @@ declare module 'launchdarkly-node-client-sdk' {
|
|
|
120
137
|
* };
|
|
121
138
|
* ```
|
|
122
139
|
*/
|
|
123
|
-
|
|
140
|
+
export function basicLogger(
|
|
124
141
|
options?: BasicLoggerOptions
|
|
125
142
|
): LDLogger;
|
|
126
143
|
}
|
package/.circleci/config.yml
DELETED
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
version: 2.1
|
|
2
|
-
|
|
3
|
-
orbs:
|
|
4
|
-
win: circleci/windows@2.4.0
|
|
5
|
-
|
|
6
|
-
workflows:
|
|
7
|
-
test:
|
|
8
|
-
jobs:
|
|
9
|
-
# CircleCI's current generation of Node images, cimg/node, allow you to leave the
|
|
10
|
-
# patch version unpinned, but require you to specify the minor version. The one
|
|
11
|
-
# exception is cimg/node:current, which will always give us the latest release in
|
|
12
|
-
# the latest major version-- and the latest major version is where it's most likely
|
|
13
|
-
# that there would be a new minor version, anyway.
|
|
14
|
-
- build-test-linux:
|
|
15
|
-
name: latest Node version
|
|
16
|
-
docker-image: cimg/node:current
|
|
17
|
-
run-lint: true
|
|
18
|
-
- build-test-linux:
|
|
19
|
-
name: Node 18.10
|
|
20
|
-
docker-image: cimg/node:18.10
|
|
21
|
-
- build-test-linux:
|
|
22
|
-
name: Node 16.14
|
|
23
|
-
docker-image: cimg/node:16.17
|
|
24
|
-
- build-test-linux:
|
|
25
|
-
name: Node 14.19
|
|
26
|
-
docker-image: cimg/node:14.20
|
|
27
|
-
- build-test-windows:
|
|
28
|
-
name: Windows
|
|
29
|
-
|
|
30
|
-
jobs:
|
|
31
|
-
build-test-linux:
|
|
32
|
-
parameters:
|
|
33
|
-
docker-image:
|
|
34
|
-
type: string
|
|
35
|
-
run-lint:
|
|
36
|
-
type: boolean
|
|
37
|
-
default: false
|
|
38
|
-
run-contract-tests:
|
|
39
|
-
type: boolean
|
|
40
|
-
default: true
|
|
41
|
-
|
|
42
|
-
docker:
|
|
43
|
-
- image: <<parameters.docker-image>>
|
|
44
|
-
|
|
45
|
-
environment:
|
|
46
|
-
NODE_ENV: test
|
|
47
|
-
|
|
48
|
-
steps:
|
|
49
|
-
- checkout
|
|
50
|
-
- run: echo "Node version:" `node --version`
|
|
51
|
-
|
|
52
|
-
- run: npm install
|
|
53
|
-
|
|
54
|
-
- run: npm run test
|
|
55
|
-
|
|
56
|
-
- when:
|
|
57
|
-
condition: <<parameters.run-lint>>
|
|
58
|
-
steps:
|
|
59
|
-
- run: npm run lint:all
|
|
60
|
-
- run: npm run check-typescript
|
|
61
|
-
|
|
62
|
-
- when:
|
|
63
|
-
condition: <<parameters.run-contract-tests>>
|
|
64
|
-
steps:
|
|
65
|
-
- run:
|
|
66
|
-
name: start contact test service
|
|
67
|
-
command: npm run contract-test-service
|
|
68
|
-
background: true
|
|
69
|
-
- run:
|
|
70
|
-
name: run contract tests
|
|
71
|
-
command: |
|
|
72
|
-
mkdir -p reports/junit
|
|
73
|
-
TEST_HARNESS_PARAMS="-junit reports/junit/contract-test-results.xml" npm run contract-test-harness
|
|
74
|
-
|
|
75
|
-
- run:
|
|
76
|
-
name: dependency audit
|
|
77
|
-
command: ./scripts/better-audit.sh
|
|
78
|
-
|
|
79
|
-
- store_test_results:
|
|
80
|
-
path: reports/junit
|
|
81
|
-
- store_artifacts:
|
|
82
|
-
path: reports/junit
|
|
83
|
-
|
|
84
|
-
build-test-windows:
|
|
85
|
-
executor:
|
|
86
|
-
name: win/default
|
|
87
|
-
shell: powershell.exe
|
|
88
|
-
|
|
89
|
-
environment:
|
|
90
|
-
NODE_ENV: test
|
|
91
|
-
|
|
92
|
-
steps:
|
|
93
|
-
- checkout
|
|
94
|
-
- run: node --version
|
|
95
|
-
- run: npm install
|
|
96
|
-
- run: npm test
|
package/.ldrelease/config.yml
DELETED
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
version: 2
|
|
2
|
-
|
|
3
|
-
repo:
|
|
4
|
-
public: node-client-sdk
|
|
5
|
-
private: node-client-sdk-private
|
|
6
|
-
|
|
7
|
-
branches:
|
|
8
|
-
- name: main
|
|
9
|
-
description: 3.x
|
|
10
|
-
- name: 2.x
|
|
11
|
-
|
|
12
|
-
publications:
|
|
13
|
-
- url: https://www.npmjs.com/package/launchdarkly-node-client-sdk
|
|
14
|
-
description: npm
|
|
15
|
-
|
|
16
|
-
jobs:
|
|
17
|
-
- docker:
|
|
18
|
-
image: node:14-buster
|
|
19
|
-
template:
|
|
20
|
-
name: npm
|
|
21
|
-
|
|
22
|
-
documentation:
|
|
23
|
-
gitHubPages: true
|
|
24
|
-
title: LaunchDarkly Client-Side Node SDK
|
|
25
|
-
|
|
26
|
-
sdk:
|
|
27
|
-
displayName: "Node.js (client-side)"
|
package/docs/Makefile
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# The TypeDoc build for this module is more complicated than for ldclient-node because it takes some of
|
|
3
|
-
# its types from launchdarkly-js-sdk-common. TypeDoc unfortunately does not understand the directive
|
|
4
|
-
# "export * from 'launchdarkly-js-sdk-common'" - so, by default, even though it does see the common types (like
|
|
5
|
-
# LDUser), it will not include them in the output.
|
|
6
|
-
#
|
|
7
|
-
# The current solution is to run TypeDoc on a hacked-together file that puts all of the types directly
|
|
8
|
-
# into one package. The sed commands below create this temporary declaration file by taking our types file
|
|
9
|
-
# and replacing the launchdarkly-js-sdk-common imports with the actual contents of the launchdarkly-js-sdk-common module.
|
|
10
|
-
# We then run TypeDoc from the docs directory, which contains its own tsconfig.json that points to the
|
|
11
|
-
# temporarily file instead of the original files.
|
|
12
|
-
#
|
|
13
|
-
|
|
14
|
-
.PHONY: html prepare
|
|
15
|
-
|
|
16
|
-
html: prepare
|
|
17
|
-
../node_modules/.bin/typedoc --options typedoc.js
|
|
18
|
-
|
|
19
|
-
prepare:
|
|
20
|
-
rm -rf build
|
|
21
|
-
mkdir build
|
|
22
|
-
@# Extract the whole module declaration from launchdarkly-js-sdk-common, then remove the first and last lines
|
|
23
|
-
sed -n '/^declare module/,/^}/p' ../node_modules/launchdarkly-js-sdk-common/typings.d.ts | \
|
|
24
|
-
sed '1d;$$d' \
|
|
25
|
-
>build/common-excerpt
|
|
26
|
-
@# Replace the block from DOCBUILD-START-REPLACE to DOCBUILD-END-REPLACE with that excerpt
|
|
27
|
-
sed -e '/DOCBUILD-END-REPLACE/r build/common-excerpt' ../typings.d.ts | \
|
|
28
|
-
sed -e '/DOCBUILD-START-REPLACE/,/DOCBUILD-END-REPLACE/d' >build/typings.d.ts
|
package/docs/doc.md
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
This is the API reference for the LaunchDarkly Client-Side Node SDK.
|
|
2
|
-
|
|
3
|
-
In typical usage, you will call [[initialize]] in the main process at startup time to obtain an
|
|
4
|
-
an instance of [[LDClient]].
|
|
5
|
-
|
|
6
|
-
For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/client-side/node-js).
|
|
7
|
-
|
package/docs/tsconfig.json
DELETED
package/docs/typedoc.js
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
// Note that the format of this file is barely documented on the TypeDoc site. In general,
|
|
2
|
-
// the properties are equivalent to the command-line options described here:
|
|
3
|
-
// https://typedoc.org/api/
|
|
4
|
-
|
|
5
|
-
let version = process.env.VERSION;
|
|
6
|
-
if (!version) {
|
|
7
|
-
const package = require('../package.json');
|
|
8
|
-
version = package.version;
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
module.exports = {
|
|
12
|
-
out: './build/html',
|
|
13
|
-
name: 'LaunchDarkly Client-Side Node SDK (' + version + ')',
|
|
14
|
-
readme: 'doc.md',
|
|
15
|
-
entryPointStrategy: 'resolve', // Allows us to specify the specific entrypoints.
|
|
16
|
-
entryPoints: ["./build/typings.d.ts"] // This is the updated version created by the makefile.
|
|
17
|
-
};
|