Merge remote-tracking branch 'origin/master' into docs-markdown-lint

dylburger · dylburger · commit a0e9f61c0a8d · 2024-12-04T17:40:08.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/components/airtable_oauth/actions/create-comment/create-comment.mjs b/components/airtable_oauth/actions/create-comment/create-comment.mjs
@@ -4,7 +4,7 @@ export default {
   key: "airtable_oauth-create-comment",
   name: "Create Comment",
   description: "Create a new comment on a record. [See the documentation](https://airtable.com/developers/web/api/create-comment)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/create-field/create-field.mjs b/components/airtable_oauth/actions/create-field/create-field.mjs
@@ -4,7 +4,7 @@ export default {
   key: "airtable_oauth-create-field",
   name: "Create Field",
   description: "Create a new field in a table. [See the documentation](https://airtable.com/developers/web/api/create-field)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/create-multiple-records/create-multiple-records.mjs b/components/airtable_oauth/actions/create-multiple-records/create-multiple-records.mjs
@@ -8,7 +8,7 @@ export default {
   key: "airtable_oauth-create-multiple-records",
   name: "Create Multiple Records",
   description: "Create one or more records in a table by passing an array of objects containing field names and values as key/value pairs. [See the documentation](https://airtable.com/developers/web/api/create-records)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/create-or-update-record/create-or-update-record.mjs b/components/airtable_oauth/actions/create-or-update-record/create-or-update-record.mjs
@@ -6,7 +6,7 @@ export default {
   key: "airtable_oauth-create-or-update-record",
   name: "Create Single Record Or Update",
   description: "Updates a record if `recordId` is provided or adds a record to a table.",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/create-single-record/create-single-record.mjs b/components/airtable_oauth/actions/create-single-record/create-single-record.mjs
@@ -6,7 +6,7 @@ export default {
   key: "airtable_oauth-create-single-record",
   name: "Create Single Record",
   description: "Adds a record to a table.",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/create-table/create-table.mjs b/components/airtable_oauth/actions/create-table/create-table.mjs
@@ -4,7 +4,7 @@ export default {
   key: "airtable_oauth-create-table",
   name: "Create Table",
   description: "Create a new table. [See the documentation](https://airtable.com/developers/web/api/create-table)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     airtable,
diff --git a/components/airtable_oauth/actions/delete-record/delete-record.mjs b/components/airtable_oauth/actions/delete-record/delete-record.mjs
@@ -5,7 +5,7 @@ export default {
   key: "airtable_oauth-delete-record",
   name: "Delete Record",
   description: "Delete a record from a table by record ID. [See the documentation](https://airtable.com/developers/web/api/delete-record)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/get-record-or-create/get-record-or-create.mjs b/components/airtable_oauth/actions/get-record-or-create/get-record-or-create.mjs
@@ -6,7 +6,7 @@ export default {
   key: "airtable_oauth-get-record-or-create",
   name: "Get Record Or Create",
   description: "Get a record from a table by record ID or create a new register.",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/get-record/get-record.mjs b/components/airtable_oauth/actions/get-record/get-record.mjs
@@ -6,7 +6,7 @@ export default {
   key: "airtable_oauth-get-record",
   name: "Get Record",
   description: "Get a record from a table by record ID. [See the documentation](https://airtable.com/developers/web/api/get-record)",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/list-records-in-view/list-records-in-view.mjs b/components/airtable_oauth/actions/list-records-in-view/list-records-in-view.mjs
@@ -6,7 +6,7 @@ export default {
   name: "List Records in View",
   description: "Retrieve records in a view with automatic pagination. Optionally sort and filter results. Only available for Enterprise accounts.",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.7",
   ...commonList,
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/list-records/list-records.mjs b/components/airtable_oauth/actions/list-records/list-records.mjs
@@ -6,7 +6,7 @@ export default {
   name: "List Records",
   description: "Retrieve records from a table with automatic pagination. Optionally sort and filter results.",
   type: "action",
-  version: "0.0.6",
+  version: "0.0.7",
   ...commonList,
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/search-records/search-records.mjs b/components/airtable_oauth/actions/search-records/search-records.mjs
@@ -5,7 +5,7 @@ export default {
   key: "airtable_oauth-search-records",
   name: "Search Records",
   description: "Searches for a record by formula or by field value. [See the documentation](https://airtable.com/developers/web/api/list-records)",
-  version: "0.0.8",
+  version: "0.0.9",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/update-comment/update-comment.mjs b/components/airtable_oauth/actions/update-comment/update-comment.mjs
@@ -4,7 +4,7 @@ export default {
   key: "airtable_oauth-update-comment",
   name: "Update Comment",
   description: "Updates an existing comment on a record. [See the documentation](https://airtable.com/developers/web/api/update-comment)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/update-field/update-field.mjs b/components/airtable_oauth/actions/update-field/update-field.mjs
@@ -5,7 +5,7 @@ export default {
   key: "airtable_oauth-update-field",
   name: "Update Field",
   description: "Updates an existing field in a table. [See the documentation](https://airtable.com/developers/web/api/update-field)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/update-record/update-record.mjs b/components/airtable_oauth/actions/update-record/update-record.mjs
@@ -6,7 +6,7 @@ export default {
   key: "airtable_oauth-update-record",
   name: "Update Record",
   description: "Update a single record in a table by Record ID. [See the documentation](https://airtable.com/developers/web/api/update-record)",
-  version: "0.0.7",
+  version: "0.0.8",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/actions/update-table/update-table.mjs b/components/airtable_oauth/actions/update-table/update-table.mjs
@@ -4,7 +4,7 @@ export default {
   key: "airtable_oauth-update-table",
   name: "Update Table",
   description: "Updates an existing table. [See the documentation](https://airtable.com/developers/web/api/update-table)",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "action",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/common/constants.mjs b/components/airtable_oauth/common/constants.mjs
@@ -32,8 +32,8 @@ const FieldType = {
   EXTERNAL_SYNC_SOURCE: "externalSyncSource",
   LAST_MODIFIED_BY: "lastModifiedBy",
   LAST_MODIFIED_TIME: "lastModifiedTime",
-  URL: "url",
   // string
+  URL: "url",
   SINGLE_COLLABORATOR: "singleCollaborator",
   DATE: "date",
   DATE_TIME: "dateTime",
diff --git a/components/airtable_oauth/common/utils.mjs b/components/airtable_oauth/common/utils.mjs
@@ -37,9 +37,9 @@ function fieldTypeToPropType(fieldType) {
   case FieldType.EXTERNAL_SYNC_SOURCE:
   case FieldType.LAST_MODIFIED_BY:
   case FieldType.LAST_MODIFIED_TIME:
-  case FieldType.URL:
     return "object";
   // string
+  case FieldType.URL:
   case FieldType.SINGLE_COLLABORATOR:
   case FieldType.DATE:
   case FieldType.DATE_TIME:
diff --git a/components/airtable_oauth/package.json b/components/airtable_oauth/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/airtable_oauth",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Pipedream Airtable (OAuth) Components",
   "main": "airtable_oauth.app.mjs",
   "keywords": [
diff --git a/components/airtable_oauth/sources/new-field/new-field.mjs b/components/airtable_oauth/sources/new-field/new-field.mjs
@@ -4,7 +4,7 @@ export default {
   name: "New Field",
   description: "Emit new event for each new field created in a table",
   key: "airtable_oauth-new-field",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/sources/new-modified-or-deleted-records-instant/new-modified-or-deleted-records-instant.mjs b/components/airtable_oauth/sources/new-modified-or-deleted-records-instant/new-modified-or-deleted-records-instant.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New Modified or Deleted Records (Instant)",
   description: "Emit new event each time a record is added, updated, or deleted in an Airtable table. [See the documentation](https://airtable.com/developers/web/api/create-a-webhook)",
   key: "airtable_oauth-new-modified-or-deleted-records-instant",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "source",
   dedupe: "unique",
   props: {
diff --git a/components/airtable_oauth/sources/new-modified-or-deleted-records/new-modified-or-deleted-records.mjs b/components/airtable_oauth/sources/new-modified-or-deleted-records/new-modified-or-deleted-records.mjs
@@ -5,7 +5,7 @@ export default {
   ...base,
   name: "New, Modified or Deleted Records",
   key: "airtable_oauth-new-modified-or-deleted-records",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   description: "Emit new event each time a record is added, updated, or deleted in an Airtable table. Supports tables up to 10,000 records",
   props: {
diff --git a/components/airtable_oauth/sources/new-or-modified-field/new-or-modified-field.mjs b/components/airtable_oauth/sources/new-or-modified-field/new-or-modified-field.mjs
@@ -4,7 +4,7 @@ export default {
   name: "New or Modified Field",
   description: "Emit new event for each new or modified field in a table",
   key: "airtable_oauth-new-or-modified-field",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   props: {
     ...common.props,
diff --git a/components/airtable_oauth/sources/new-or-modified-records-in-view/new-or-modified-records-in-view.mjs b/components/airtable_oauth/sources/new-or-modified-records-in-view/new-or-modified-records-in-view.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New or Modified Records in View",
   description: "Emit new event for each new or modified record in a view",
   key: "airtable_oauth-new-or-modified-records-in-view",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   props: {
     ...base.props,
diff --git a/components/airtable_oauth/sources/new-or-modified-records/new-or-modified-records.mjs b/components/airtable_oauth/sources/new-or-modified-records/new-or-modified-records.mjs
@@ -7,7 +7,7 @@ export default {
   name: "New or Modified Records",
   key: "airtable_oauth-new-or-modified-records",
   description: "Emit new event for each new or modified record in a table",
-  version: "0.0.8",
+  version: "0.0.9",
   type: "source",
   props: {
     ...base.props,
diff --git a/components/airtable_oauth/sources/new-records-in-view/new-records-in-view.mjs b/components/airtable_oauth/sources/new-records-in-view/new-records-in-view.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New Records in View",
   description: "Emit new event for each new record in a view",
   key: "airtable_oauth-new-records-in-view",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   props: {
     ...base.props,
diff --git a/components/airtable_oauth/sources/new-records/new-records.mjs b/components/airtable_oauth/sources/new-records/new-records.mjs
@@ -6,7 +6,7 @@ export default {
   name: "New Records",
   description: "Emit new event for each new record in a table",
   key: "airtable_oauth-new-records",
-  version: "0.0.6",
+  version: "0.0.7",
   type: "source",
   props: {
     ...base.props,
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
diff --git a/packages/sdk/scripts/updateVersion.mjs b/packages/sdk/scripts/updateVersion.mjs
diff --git a/packages/sdk/src/browser/async.ts b/packages/sdk/src/browser/async.ts
diff --git a/packages/sdk/src/browser/index.ts b/packages/sdk/src/browser/index.ts
diff --git a/packages/sdk/src/server/async.ts b/packages/sdk/src/server/async.ts
diff --git a/packages/sdk/src/shared/component.ts b/packages/sdk/src/shared/component.ts
diff --git a/packages/sdk/src/shared/index.ts b/packages/sdk/src/shared/index.ts
diff --git a/packages/sdk/src/version.ts b/packages/sdk/src/version.ts
diff --git a/packages/sdk/tsconfig.browser.json b/packages/sdk/tsconfig.browser.json
diff --git a/packages/sdk/tsconfig.node.json b/packages/sdk/tsconfig.node.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
