Merge branch 'main' into SyncV1ServicesDeprecationWarning

twilio-labs · Mar 25, 2024 · 36e0b08 · 36e0b08
2 parents d5df90d + 4432c02
commit 36e0b08
Show file tree

Hide file tree

Showing 43 changed files with 883 additions and 1,121 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -3,9 +3,7 @@
   "projectOwner": "dkundel",
   "repoType": "github",
   "repoHost": "https://github.com",
-  "files": [
-    "README.md"
-  ],
+  "files": ["README.md"],
   "imageSize": 100,
   "commit": true,
   "contributors": [
@@ -14,79 +12,65 @@
       "name": "Dominik Kundel",
       "avatar_url": "https://avatars3.githubusercontent.com/u/1505101?v=4",
       "profile": "https://dkundel.com",
-      "contributions": [
-        "code"
-      ]
+      "contributions": ["code"]
     },
     {
       "login": "dbbidclips",
       "name": "dbbidclips",
       "avatar_url": "https://avatars1.githubusercontent.com/u/41997517?v=4",
       "profile": "https://github.com/dbbidclips",
-      "contributions": [
-        "code",
-        "bug"
-      ]
+      "contributions": ["code", "bug"]
     },
     {
       "login": "ShelbyZ",
       "name": "Shelby Hagman",
       "avatar_url": "https://avatars0.githubusercontent.com/u/1033099?v=4",
       "profile": "https://shagman.codes",
-      "contributions": [
-        "bug",
-        "code"
-      ]
+      "contributions": ["bug", "code"]
     },
     {
       "login": "jsjoeio",
       "name": "JavaScript Joe",
       "avatar_url": "https://avatars3.githubusercontent.com/u/3806031?v=4",
       "profile": "https://joeprevite.com/",
-      "contributions": [
-        "bug"
-      ]
+      "contributions": ["bug"]
     },
     {
       "login": "stefanjudis",
       "name": "Stefan Judis",
       "avatar_url": "https://avatars3.githubusercontent.com/u/962099?v=4",
       "profile": "https://www.stefanjudis.com/",
-      "contributions": [
-        "bug",
-        "code"
-      ]
+      "contributions": ["bug", "code"]
     },
     {
       "login": "philnash",
       "name": "Phil Nash",
       "avatar_url": "https://avatars3.githubusercontent.com/u/31462?v=4",
       "profile": "https://philna.sh",
-      "contributions": [
-        "bug",
-        "code",
-        "review"
-      ]
+      "contributions": ["bug", "code", "review"]
     },
     {
       "login": "childish-sambino",
       "name": "childish-sambino",
       "avatar_url": "https://avatars0.githubusercontent.com/u/47228322?v=4",
       "profile": "https://github.com/childish-sambino",
-      "contributions": [
-        "code",
-        "bug"
-      ]
+      "contributions": ["code", "bug"]
     },
     {
       "login": "thinkingserious",
       "name": "Elmer Thomas",
       "avatar_url": "https://avatars0.githubusercontent.com/u/146695?v=4",
       "profile": "http://www.ThinkingSerious.com",
-      "contributions": [
-        "bug",
-        "doc"
-      ]
+      "contributions": ["bug", "doc"]
+    },
+    {
+      "login": "makserik",
+      "name": "makserik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15821542?v=4",
+      "profile": "https://github.com/makserik",
+      "contributions": ["code", "doc"]
     }
-  ]
+  ],
+  "commitConvention": "angular"
 }
+
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -16,10 +16,10 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        node-version: [ lts/-2, lts/-1, lts/*]
+        node-version: [ lts/-1, lts/*]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:

diff --git a/.github/workflows/on-merge-main.yml b/.github/workflows/on-merge-main.yml
@@ -18,13 +18,13 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
-      - name: Setup Node.js 16
+      - name: Setup Node.js 20
         uses: actions/setup-node@v3
         with:
-          node-version: 16
-      - name: Update npm to 8.x
+          node-version: 20
+      - name: Update npm to 10.x
         run: |
-          npm i -g npm@8
+          npm i -g npm@10
       - name: Install Dependencies
         run: npm install
       - name: Setup CI Git User
@@ -43,4 +43,4 @@ jobs:
           commit: "chore: version packages"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -72,3 +72,7 @@ dist/
 *.twiliodeployinfo
 
 packages/serverless-api/docs/
+
+.idea
+
+**/.DS_Store
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-14
+18
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -14,8 +14,8 @@ If you are planning to contribute something that does not have an open issue yet
 
 ## Requirements
 
-Make sure you have Node.js 14 or newer installed. Due to compatibility with Twilio
-Functions this project has to support at least Node.js 14.0.0.
+Make sure you have Node.js 18 or newer installed. Due to compatibility with Twilio
+Functions this project has to support at least Node.js 18.0.0.
 
 We are using the npm CLI to manage our project. You'll need at least `npm` version 8 or newer.
 
@@ -33,6 +33,7 @@ npm run bootstrap
 ## Contributing
 
 1. Perform changes. Check out [Working with Workspaces](#working-with-workspaces) for more info
+2. If you changed packages/plugins, run `twilio plugins:link <PATH_TO_THE_CHANGED_PACKAGE>` and then test the plugin locally by running `twilio <PLUGIN_NAME> <COMMAND>`
 2. Make sure tests pass by running `npm test`
 3. Stage the files you changed by running `git add` with the files you changed.
 4. If you have a customer facing change make sure to run `npm run changeset` at the root of the project, select what type of version change it is and which packages are impacted and describe the change. Check out ["How we version"](#how-we-version) for more details.
@@ -45,6 +46,8 @@ npm run bootstrap
 
 Version bumps are handled automatically by [this GitHub Action](../.github/workflows/on-merge-main.yml) whenever changes have been merged to `main`. If the automation will detect any changeset files inside the `.changeset` directory it will either open a new Pull Request to bump the version or force-push to the currently open Pull Request. In order to release to `npm` you'll have to merge that Pull Request which will automatically kick off the release.
 
+If the release fails, the issue might be in the NPM token expiring for twilio-labs-ci account. (For example a generic 404 not found response from NPM is usually token expiring) Current expiration is set for January 2026. Internal Slack channel for OSS support can help with the renewal.
+
 ## How we version
 
 All packages that are part of this project follow the [SemVer convention](https://semver.org/). Specifically this means the following version changes apply for the following changes:

diff --git a/jest.config.base.js b/jest.config.base.js
@@ -11,10 +11,13 @@ module.exports = {
   coverageDirectory: 'coverage',
 
   // A set of global variables that need to be available in all test environments
-  globals: {
-    'ts-jest': {
-      tsconfig: 'tsconfig.test.json',
-    },
+  transform: {
+    '^.+\\.ts?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.test.json',
+      },
+    ],
   },
   // The test environment that will be used for testing
   testEnvironment: 'node',

diff --git a/package.json b/package.json
@@ -24,24 +24,26 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.0",
-    "@commitlint/cli": "^9.1.2",
-    "@commitlint/config-conventional": "^10.0.0",
+    "@commitlint/cli": "^19.1.0",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@twilio/test-dep": "npm:[email protected]",
     "@types/jest": "^29.2.4",
     "all-contributors-cli": "^6.1.2",
     "commitizen": "^4.2.4",
     "commitlint-plugin-workspace-scopes": "^1.1.0",
     "conventional-changelog-cli": "^2.1.0",
     "cz-conventional-changelog": "^2.1.0",
     "husky": "^8.0.2",
-    "jest": "^28.1.3",
+    "jest": "^29.7.0",
     "jest-express": "^1.10.1",
-    "lint-staged": "^9.0.0",
+    "lint-staged": "^15.2.2",
+    "listr": "^0.14.3",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.2.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.8",
-    "typescript": "^4.9.4",
-    "@twilio/test-dep": "npm:[email protected]"
+    "ts-jest": "^29.1.2",
+    "typedoc": "^0.25.12",
+    "typescript": "^5.3.3"
   },
   "lint-staged": {
     "*.{js,jsx,ts,tsx}": [