feat(sdk): add x-pd-sdk-version, triggerDeploy (1.0.9) (#14836)

tjk · web-flow · commit b973d29e5efd · 2024-12-04T16:04:58.000-08:00
diff --git a/.github/workflows/pipedream-sdk-test.yaml b/.github/workflows/pipedream-sdk-test.yaml
@@ -36,7 +36,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '22'
 
       - name: Install dependencies
         run: pnpm install
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -2,6 +2,7 @@ import jsonc from "eslint-plugin-jsonc";
 import putout from "eslint-plugin-putout";
 import pipedream from "eslint-plugin-pipedream";
 import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import importPlugin from "eslint-plugin-import";
 import jest from "eslint-plugin-jest";
 import globals from "globals";
 import parser from "jsonc-eslint-parser";
@@ -52,6 +53,7 @@ export default [
       pipedream,
       "@typescript-eslint": typescriptEslint,
       jest,
+      "import": importPlugin,
     },
 
     languageOptions: {
@@ -313,4 +315,17 @@ export default [
       "react/react-in-jsx-scope": "off",
     },
   },
+  {
+    files: [
+      "packages/sdk/src/browser/**/*.ts",
+      "packages/sdk/src/shared/**/*.ts",
+    ],
+
+    rules: {
+      "import/extensions": [
+        "error",
+        "always",
+      ],
+    },
+  },
 ];
diff --git a/jest.config.js b/jest.config.js
@@ -4,18 +4,22 @@ module.exports = {
   testEnvironment: "node",
   // See https://kulshekhar.github.io/ts-jest/docs/guides/esm-support
   extensionsToTreatAsEsm: [
+    ".js",
     ".ts",
     ".mts",
   ],
-  globals: {
-    "ts-jest": {
-      useESM: true,
-    },
-  },
   moduleNameMapper: {
-    "^(\\.{1,2}/.*)\\.js$": "$1",
+    "^(.+)\\.js$": "$1",
   },
   testPathIgnorePatterns: [
     "types/.*.types.test..*$",
   ],
+  transform: {
+    "\\.[jt]s$": [
+      "ts-jest",
+      {
+        "useESM": true,
+      },
+    ],
+  },
 };
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
     "@typescript-eslint/parser": "^8",
     "eslint": "^8",
     "eslint-config-next": "^15",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-jest": "^28",
     "eslint-plugin-jsonc": "^1.6.0",
     "eslint-plugin-pipedream": "0.2.4",
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
@@ -1,6 +1,13 @@
 <!-- markdownlint-disable MD024 -->
 # Changelog
 
+## [1.0.9] - 2024-12-04
+
+### Added
+
+- `triggerDeploy` preview API
+- `client.version` and `x-pd-sdk-version` header
+
 ## [1.0.8] - 2024-11-29
 
 ### Changed
diff --git a/packages/sdk/examples/browser/Makefile b/packages/sdk/examples/browser/Makefile
@@ -0,0 +1,8 @@
+default:
+	make -j2 server delayed-open
+
+server:
+	cd ../.. && python -m http.server
+
+delayed-open:
+	sleep 1 && xdg-open http://localhost:8000/examples/browser/index.html
diff --git a/packages/sdk/examples/browser/index.html b/packages/sdk/examples/browser/index.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <body>
+    <h1>Load SDK in browser</h1>
+    <script type="importmap">
+    {
+      "imports": {
+        "@rails/actioncable": "/node_modules/@rails/actioncable/app/assets/javascripts/actioncable.esm.js"
+      }
+    }
+    </script>
+    <script type="module">
+      import { createFrontendClient } from "/dist/browser/browser/index.js"
+      const client = createFrontendClient()
+      const p = document.createElement("p")
+      p.textContent = "sdk version: " + client.version
+      document.body.appendChild(p)
+    </script>
+  </body>
+</html>
diff --git a/packages/sdk/examples/server/Makefile b/packages/sdk/examples/server/Makefile
@@ -0,0 +1,2 @@
+default:
+	@node index.mjs
diff --git a/packages/sdk/examples/server/index.mjs b/packages/sdk/examples/server/index.mjs
@@ -0,0 +1,10 @@
+import { createBackendClient } from "../../dist/server/server/index.js";
+
+const client = createBackendClient({
+  environment: "development",
+  credentials: {
+    clientId: "not-empty",
+    clientSecret: "not-empty",
+  },
+});
+console.log("sdk version: " + client.version);
diff --git a/packages/sdk/jest.config.js b/packages/sdk/jest.config.js
@@ -15,10 +15,13 @@ module.exports = {
     "ts",
     "js",
   ],
+  moduleNameMapper: {
+    "^(.+)\\.js$": "$1",
+  },
   transform: {
     // '^.+\\.[tj]sx?$' to process ts,js,tsx,jsx with `ts-jest`
     // '^.+\\.m?[tj]sx?$' to process ts,js,tsx,jsx,mts,mjs,mtsx,mjsx with `ts-jest`
-    "^.+\\.tsx?$": [
+    "^.+\\.[jt]sx?$": [
       "ts-jest",
       {
         tsconfig: "tsconfig.node.json",
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/sdk",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Pipedream SDK",
   "main": "dist/server/server/index.js",
   "module": "dist/server/server/index.js",
@@ -35,8 +35,9 @@
     "access": "public"
   },
   "scripts": {
-    "prepublish": "rm -rf dist && pnpm run build",
-    "build": "pnpm run build:node && pnpm run build:browser",
+    "prepublish": "pnpm run build",
+    "prebuild": "node scripts/updateVersion.mjs",
+    "build": "rm -rf dist && pnpm run prebuild && pnpm run build:node && pnpm run build:browser",
     "build:node": "tsc -p tsconfig.node.json",
     "build:browser": "tsc -p tsconfig.browser.json",
     "test": "jest",
diff --git a/packages/sdk/scripts/updateVersion.mjs b/packages/sdk/scripts/updateVersion.mjs
@@ -0,0 +1,13 @@
+import fs from "fs";
+import cp from "child_process";
+
+if (!process.env.CI) {
+  // make sure people building locally automatically do not track changes to version file
+  cp.execSync("git update-index --skip-worktree src/version.ts");
+}
+
+const pkg = JSON.parse(String(fs.readFileSync("./package.json", "utf8")))
+const versionTsPath = "./src/version.ts";
+const data = String(fs.readFileSync(versionTsPath, "utf8"));
+const newData = data.replace(/"(.*)"/, `"${pkg.version}"`);
+fs.writeFileSync(versionTsPath, newData);
diff --git a/packages/sdk/src/browser/async.ts b/packages/sdk/src/browser/async.ts
@@ -1,5 +1,5 @@
-import { AsyncResponseManager } from "../shared/async";
-import type { AsyncResponseManagerOpts } from "../shared/async";
+import { AsyncResponseManager } from "../shared/async.js";
+import type { AsyncResponseManagerOpts } from "../shared/async.js";
 
 export type BrowserAsyncResponseManagerOpts = {
   apiHost: string;
diff --git a/packages/sdk/src/browser/index.ts b/packages/sdk/src/browser/index.ts
@@ -4,14 +4,14 @@
 // operations, like connecting accounts via Pipedream Connect. See the server/
 // directory for the server client.
 
-import { BrowserAsyncResponseManager } from "./async";
+import { BrowserAsyncResponseManager } from "./async.js";
 import {
   AccountsRequestResponse,
   BaseClient,
   GetAccountOpts,
   type ConnectTokenResponse,
-} from "../shared";
-export type * from "../shared";
+} from "../shared/index.js";
+export type * from "../shared/index.js";
 
 /**
  * Options for creating a browser-side client. This is used to configure the
diff --git a/packages/sdk/src/server/async.ts b/packages/sdk/src/server/async.ts
@@ -26,7 +26,7 @@ export class ServerAsyncResponseManager extends AsyncResponseManager {
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     global.removeEventListener = () => {};
     if (typeof adapters.WebSocket === "undefined")
-      adapters.WebSocket = WebSocket;
+      adapters.WebSocket = WebSocket as unknown as typeof adapters.WebSocket;
   }
 
   protected override async getOpts(): Promise<AsyncResponseManagerOpts> {
diff --git a/packages/sdk/src/shared/component.ts b/packages/sdk/src/shared/component.ts
@@ -94,3 +94,17 @@ export type V1Component<T extends ConfigurableProps = any> = { // eslint-disable
   version: string;
   configurable_props: T;
 };
+
+export type V1DeployedComponent<T extends ConfigurableProps = any> = { // eslint-disable-line @typescript-eslint/no-explicit-any
+  id: string;
+  owner_id: string;
+  component_id: string;
+  configurable_props: T;
+  configured_props: ConfiguredProps<T>;
+  active: boolean;
+  created_at: number;
+  updated_at: number;
+  name: string;
+  name_slug: string;
+  callback_observations?: unknown;
+};
diff --git a/packages/sdk/src/shared/index.ts b/packages/sdk/src/shared/index.ts
@@ -1,10 +1,15 @@
 // This code is meant to be shared between the browser and server.
-import { AsyncResponseManager } from "./async";
 import type {
-  AsyncResponse, AsyncErrorResponse,
-} from "./async";
-import type { V1Component } from "./component";
-export * from "./component";
+  AsyncResponse,
+  AsyncErrorResponse,
+  AsyncResponseManager,
+} from "./async.js";
+import type {
+  V1Component,
+  V1DeployedComponent,
+} from "./component.js";
+export * from "./component.js";
+import { version as sdkVersion } from "../version.js";
 
 type RequestInit = globalThis.RequestInit;
 
@@ -290,6 +295,7 @@ export interface AsyncRequestOptions extends RequestOptions {
  * A client for interacting with the Pipedream Connect API on the server-side.
  */
 export abstract class BaseClient {
+  version = sdkVersion;
   protected apiHost: string;
   protected abstract asyncResponseManager: AsyncResponseManager;
   protected readonly baseApiUrl: string;
@@ -351,6 +357,7 @@ export abstract class BaseClient {
 
     const headers: Record<string, string> = {
       ...customHeaders,
+      "X-PD-SDK-Version": sdkVersion,
       "X-PD-Environment": this.environment,
     };
 
@@ -572,7 +579,6 @@ export abstract class BaseClient {
       prop_name: opts.propName,
       configured_props: opts.configuredProps,
       dynamic_props_id: opts.dynamicPropsId,
-      environment: this.environment,
     };
     return await this.makeConnectRequestAsync<{
       options: { label: string; value: string; }[];
@@ -592,7 +598,6 @@ export abstract class BaseClient {
       id: opts.componentId,
       configured_props: opts.configuredProps,
       dynamic_props_id: opts.dynamicPropsId,
-      environment: this.environment,
     };
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     return await this.makeConnectRequestAsync<Record<string, any>>("/components/props", {
@@ -614,7 +619,6 @@ export abstract class BaseClient {
       id: opts.actionId,
       configured_props: opts.configuredProps,
       dynamic_props_id: opts.dynamicPropsId,
-      environment: this.environment,
     };
     return await this.makeConnectRequestAsync<{
       exports: unknown;
@@ -626,6 +630,27 @@ export abstract class BaseClient {
     });
   }
 
+  public async triggerDeploy(opts: {
+    userId: string;
+    triggerId: string;
+    configuredProps: Record<string, any>;  // eslint-disable-line @typescript-eslint/no-explicit-any
+    dynamicPropsId?: string;
+    webhookUrl?: string;
+  }) {
+    const body = {
+      async_handle: this.asyncResponseManager.createAsyncHandle(),
+      external_user_id: opts.userId,
+      id: opts.triggerId,
+      configured_props: opts.configuredProps,
+      dynamic_props_id: opts.dynamicPropsId,
+      webhook_url: opts.webhookUrl,
+    }
+    return await this.makeConnectRequestAsync<V1DeployedComponent>("/triggers/deploy", {
+      method: "POST",
+      body,
+    });
+  }
+
   /**
    * Builds a full workflow URL based on the input.
    *
diff --git a/packages/sdk/src/version.ts b/packages/sdk/src/version.ts
@@ -0,0 +1,2 @@
+// DO NOT EDIT, SET AT BUILD TIME
+export const version = "0.0.0"
diff --git a/packages/sdk/tsconfig.browser.json b/packages/sdk/tsconfig.browser.json
@@ -10,7 +10,8 @@
     "forceConsistentCasingInFileNames": true,
     "moduleResolution": "node",
     "skipLibCheck": true,
-    "types": []
+    "types": [],
+    "allowJs": true
   },
   "include": [
     "src/browser/**/*"
diff --git a/packages/sdk/tsconfig.node.json b/packages/sdk/tsconfig.node.json
@@ -10,6 +10,7 @@
     "strict": true,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true,
     "sourceMap": true,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
