Fixes DJ-2470 (#14106)

@pipedream/sdk 1.0.0

---------

Co-authored-by: Jay Vercellone <jay@pipedream.com>
Co-authored-by: Jay Vercellone <jverce@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: 3 people

.github/workflows/pipedream-sdk-markdown-lint.yaml

@@ -0,0 +1,24 @@
+name: Lint SDK Markdown Files
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+    paths:
+      - 'packages/sdk/**/*.md'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Lint markdown files
+        uses: DavidAnson/markdownlint-cli2-action@v17
+        with:
+          globs: 'packages/sdk/**/*.md'

.github/workflows/pipedream-sdk-test.yaml

@@ -6,13 +6,17 @@ on:
     paths:
       - 'packages/sdk/**'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Node.js
         uses: actions/setup-node@v3

packages/sdk/.tool-versions

@@ -0,0 +1 @@
+nodejs 22.10.0

packages/sdk/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## [1.0.0-rc.1] - 2024-11-01
+
+### Changed
+
+- Renamed the server-side client class from `ServerClient` to `BackendClient` to
+  better indicate its purpose.
+- Removed the `oauthClient` optional argument to the `BackendClient` constructor
+- Renamed the client factory methods so that developers can know exactly the
+  kind of client they are creating.
+- Removed project-key-based authentication in favor of a more secure
+  token-based authentication using OAuth.

packages/sdk/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# How to Contribute to the SDK
+
+## Local Environment Setup
+
+### Global Dependencies
+
+Clone the repo (ideally your own fork of it) and initialize the global
+dependencies like Node.js, NPM, etc. We use [`asdf`](https://asdf-vm.com/) to
+manage these, so assuming we're located in this directory (i.e. `packages/sdk/`)
+we can run the following command to install them:
+
+```shell
+asdf install
+```
+
+If you prefer to use another tool make sure you use the same versions that are
+specified in the `.tool-versions` files [in this current directory, and
+recursively going up until you reach the root of the
+repo](https://asdf-vm.com/guide/getting-started.html#_6-set-a-version).
+
+### Local Dependencies
+
+You can install the package's dependencies by using `pnpm` or `npm`:
+
+```shell
+pnpm install
+```
+
+Since other packages in this repository already use `pnpm`, we recommend you use
+it in this case too to keep your `node_modules` footprint low.
+
+## Build the Package
+
+There's a script that you can invoke with `pnpm` to build the package artifacts:
+
+```shell
+pnpm build
+```
+
+You can also watch the code for changes, and automatically build a new artifact
+after each change with the `watch` script:
+
+```shell
+pnpm watch
+```
+
+### Use the Package
+
+You can use pnpm's `link` command to point other code to your local version of
+this package during development. This lets you test the SDK in other local apps,
+end-to-end.
+
+In this `packages/sdk/` directory:
+
+```shell
+pnpm link --global
+```
+
+> [!NOTE]
+When using the version of Node.js specified in
+[`.tool-versions`](./.tool-versions) (via `asdf`), the command above will
+install the package in the `asdf` Node.js environment. To use this package
+elsewhere, you'll need to use the same version of Node.js. Please reference the
+latest version of [the `.tool-versions` file](./.tool-versions) and add that to
+the `.tool-versions` file in your local project where you'd like to use the SDK.
+
+For example, in your app's directory:
+
+```shell
+# Replace /path/to/pipedream with the actual path to this repository
+grep nodejs /path/to/pipedream/packages/sdk/.tool-versions >> .tool-versions
+asdf install
+pnpm install @pipedream/sdk
+```
+
+Then, link the SDK package to it's local path:
+
+```shell
+pnpm link @pipedream/sdk
+```
+
+To confirm you successfully installed the correct version of the SDK, and that
+it's tied to your local copy of the Pipedream SDK:
+
+```shell
+ls -l node_modules/@pipedream
+```
+
+You should see an output like this one (notice the last line):
+
+```text
+total 0
+drwxr-xr-x   9 jay  staff  288 30 Oct 14:01 mysql
+drwxr-xr-x  10 jay  staff  320 30 Oct 14:01 platform
+lrwxr-xr-x   1 jay  staff   31 30 Oct 14:06 sdk -> ../../../pipedream/packages/sdk
+```

packages/sdk/README.md

@@ -1,6 +1,7 @@
 # `@pipedream/sdk`
 
-TypeScript SDK for [Pipedream](https://pipedream.com). [See the docs](https://pipedream.com/docs/connect) for usage instructions.
+TypeScript SDK for [Pipedream](https://pipedream.com). [See the
+docs](https://pipedream.com/docs/connect) for usage instructions.
 
 ## Install
 
@@ -10,12 +11,39 @@ npm i @pipedream/sdk
 
 ## Quickstart
 
-The [quickstart](https://pipedream.com/docs/connect/quickstart) is the easiest way to get started with the SDK and Pipedream Connect.
+The [quickstart](https://pipedream.com/docs/connect/quickstart) is the easiest
+way to get started with the SDK and Pipedream Connect.
 
 ## Usage
 
-[See the SDK docs](https://pipedream.com/docs/connect) for full usage instructions and examples for each method.
+[See the SDK docs](https://pipedream.com/docs/connect) for full usage
+instructions and examples for each method.
 
-## Example app
+## Example App
 
-Clone and run the [example app](https://github.com/PipedreamHQ/pipedream-connect-examples/) to get started.
+Clone and run the [example
+app](https://github.com/PipedreamHQ/pipedream-connect-examples/) to get started.
+
+## Importing the Client
+
+You can import the SDK from the root package name, and it will automatically
+load the appropriate code depending on the environment (e.g. Node.js server,
+browser, etc.).
+
+### CommonJS Modules
+
+```javascript
+const { createClient } = require("@pipedream/sdk");
+```
+
+### ES Modules
+
+```javascript
+import { createClient } from "@pipedream/sdk";
+```
+
+### Browser
+
+```javascript
+import { createClient } from "@pipedream/sdk";
+```

packages/sdk/jest.setup.js

@@ -1,3 +1,5 @@
 const fetchMock = require("jest-fetch-mock");
 fetchMock.enableMocks();
 global.fetch = fetchMock;
+
+jest.mock("simple-oauth2");