Skip to content

Commit d7dbfc1

Browse files
ppwang-sameta-codesync[bot]
authored andcommitted
Standardize on yarn, remove npm references
Summary: Standardize the client_js package on yarn as the sole package manager. - README: Remove npm install option, keep only yarn add - CI workflow: Switch from npm ci/test/build to yarn equivalents - CD workflow: Update title and debug log step - CHANGELOG: Add v1.2.2 open source release notes - Delete package-lock.json (redundant with yarn.lock) Differential Revision: D99834215 fbshipit-source-id: e647f026cf7838582cf60671bf1d7f98aacf2bc2
1 parent 807af11 commit d7dbfc1

6 files changed

Lines changed: 26 additions & 12663 deletions

File tree

.github/workflows/client_js_cd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ jobs:
3232
run: yarn build
3333
- name: Publish to npm
3434
run: yarn publish --non-interactive
35-
- name: Show npm debug log if publish failed
35+
- name: Show debug log if publish failed
3636
if: failure()
37-
run: cat /home/runner/.npm/_logs/*.log || echo "No npm log found"
37+
run: cat /home/runner/.yarn/*.log 2>/dev/null || echo "No yarn log found"

.github/workflows/client_js_ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ jobs:
3131
with:
3232
node-version: ${{ matrix.node-version }}
3333
- name: Install dependencies
34-
run: npm ci
34+
run: yarn install --frozen-lockfile
3535
- name: Run tests
36-
run: npm test
36+
run: yarn test
3737
- name: Build
38-
run: npm run build
38+
run: yarn build

client_js/CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
44

55
## Unreleased
66

7+
## Version v1.3.0
8+
- Standardized on yarn as the sole package manager — removed all npm references
9+
- Switched CI workflow from npm to yarn (`yarn install --frozen-lockfile`, `yarn test`, `yarn build`)
10+
- Updated CD workflow title and debug logging for yarn
11+
- Removed `package-lock.json` (redundant with `yarn.lock`)
12+
- Updated README: removed npm install option, kept only `yarn add`
13+
- Updated yarn prerequisite to recommend `corepack enable`
14+
15+
## Version v1.2.2
16+
- Open sourced the SDK and published to yarn registry as `meta-capi-param-builder-clientjs`
17+
- Added CI/CD GitHub Actions workflows for automated testing and publishing
18+
- Added unit tests for `ipUtil` and `getClientIpAddress` (506 tests passing)
19+
- Rewrote README with yarn install instructions and structured API docs
20+
- Removed deprecated `clientParamsHelper` module
21+
- Fixed `==` to `===` for strict equality
22+
- Fixed prototype pollution vulnerability in `flatted` (CWE-1321)
23+
- Resolved dependency vulnerabilities in `serialize-javascript` and `@tootallnate/once`
24+
725
## Version v1.2.1
826
- Improve the is_new flag with more breakdown on net new and modified new option.
927

client_js/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,7 @@ The Conversions API parameter builder SDK is a lightweight client-side JavaScrip
1313

1414
### Installation
1515

16-
Install the package via npm or yarn:
17-
18-
```bash
19-
npm install meta-capi-param-builder-clientjs
20-
```
21-
22-
or
16+
Install the package via yarn:
2317

2418
```bash
2519
yarn add meta-capi-param-builder-clientjs
@@ -100,7 +94,7 @@ Supported `dataType` values: `phone`, `email`, `first_name`, `last_name`, `date_
10094
### Prerequisites
10195

10296
- Node.js >= 18
103-
- yarn (`npm install --global yarn`)
97+
- yarn (install via `corepack enable` or see [yarnpkg.com](https://yarnpkg.com/getting-started/install))
10498

10599
### Setup
106100

0 commit comments

Comments
 (0)