WIP envvar SDK

Author: ericallam

packages/core/package.json

@@ -134,13 +134,14 @@
     "@opentelemetry/sdk-trace-base": "^1.22.0",
     "@opentelemetry/sdk-trace-node": "^1.22.0",
     "@opentelemetry/semantic-conventions": "^1.22.0",
+    "form-data-encoder": "^4.0.2",
     "humanize-duration": "^3.27.3",
+    "socket.io-client": "4.7.4",
     "superjson": "^2.2.1",
     "ulidx": "^2.2.1",
     "zod": "3.22.3",
     "zod-error": "1.5.0",
-    "zod-validation-error": "^1.5.0",
-    "socket.io-client": "4.7.4"
+    "zod-validation-error": "^1.5.0"
   },
   "devDependencies": {
     "@trigger.dev/tsconfig": "workspace:*",
@@ -150,10 +151,10 @@
     "@types/node": "20.12.7",
     "jest": "^29.6.2",
     "rimraf": "^3.0.2",
+    "socket.io": "4.7.4",
     "ts-jest": "^29.1.1",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.0",
-    "socket.io": "4.7.4"
+    "typescript": "^5.3.0"
   },
   "engines": {
     "node": ">=18.0.0"

packages/core/src/v3/apiClient/index.ts

@@ -6,9 +6,13 @@ import {
   BatchTriggerTaskRequestBody,
   BatchTriggerTaskResponse,
   CanceledRunResponse,
+  CreateEnvironmentVariableRequestBody,
   CreateScheduleOptions,
   CreateUploadPayloadUrlResponseBody,
   DeletedScheduleObject,
+  EnvironmentVariableResponseBody,
+  EnvironmentVariableValue,
+  EnvironmentVariables,
   ListScheduleOptions,
   ListSchedulesResult,
   ReplayRunResponse,
@@ -20,7 +24,8 @@ import {
   UpdateScheduleOptions,
 } from "../schemas";
 import { taskContext } from "../task-context-api";
-import { ZodFetchOptions, zodfetch } from "../zodfetch";
+import { ZodFetchOptions, isRecordLike, zodfetch, zodupload } from "../zodfetch";
+import { ImportEnvironmentVariablesParams } from "./types";
 
 export type TriggerOptions = {
   spanParentAsLink?: boolean;
@@ -234,6 +239,92 @@ export class ApiClient {
     });
   }
 
+  listEnvVars(projectRef: string, slug: string) {
+    return zodfetch(
+      EnvironmentVariables,
+      `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}`,
+      {
+        method: "GET",
+        headers: this.#getHeaders(false),
+      }
+    );
+  }
+
+  importEnvVars(projectRef: string, slug: string, body: ImportEnvironmentVariablesParams) {
+    if (isRecordLike(body.variables)) {
+      return zodfetch(
+        EnvironmentVariableResponseBody,
+        `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}/import`,
+        {
+          method: "POST",
+          headers: this.#getHeaders(false),
+          body: JSON.stringify(body),
+        }
+      );
+    } else {
+      return zodupload(
+        EnvironmentVariableResponseBody,
+        `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}/import`,
+        body,
+        {
+          method: "POST",
+          headers: this.#getHeaders(false),
+        }
+      );
+    }
+  }
+
+  retrieveEnvVar(projectRef: string, slug: string, key: string) {
+    return zodfetch(
+      EnvironmentVariableValue,
+      `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}/${key}`,
+      {
+        method: "GET",
+        headers: this.#getHeaders(false),
+      }
+    );
+  }
+
+  createEnvVar(projectRef: string, slug: string, body: CreateEnvironmentVariableRequestBody) {
+    return zodfetch(
+      EnvironmentVariableResponseBody,
+      `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}`,
+      {
+        method: "POST",
+        headers: this.#getHeaders(false),
+        body: JSON.stringify(body),
+      }
+    );
+  }
+
+  updateEnvVar(
+    projectRef: string,
+    slug: string,
+    key: string,
+    body: CreateEnvironmentVariableRequestBody
+  ) {
+    return zodfetch(
+      EnvironmentVariableResponseBody,
+      `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}/${key}`,
+      {
+        method: "PUT",
+        headers: this.#getHeaders(false),
+        body: JSON.stringify(body),
+      }
+    );
+  }
+
+  deleteEnvVar(projectRef: string, slug: string, key: string) {
+    return zodfetch(
+      EnvironmentVariableResponseBody,
+      `${this.baseUrl}/api/v1/projects/${projectRef}/envvars/${slug}/${key}`,
+      {
+        method: "DELETE",
+        headers: this.#getHeaders(false),
+      }
+    );
+  }
+
   #getHeaders(spanParentAsLink: boolean) {
     const headers: Record<string, string> = {
       "Content-Type": "application/json",

packages/core/src/v3/apiClient/types.ts

@@ -0,0 +1,15 @@
+import { BlobLikePart, Uploadable } from "../zodfetch";
+
+export interface ImportEnvironmentVariablesParams {
+  /**
+   * The variables to be imported. If a variable with the same key already exists, it will be overwritten when `overwrite` is `true`.
+   *
+   * There are two ways to specify the variables:
+   *
+   * 1. As a record of key-value pairs. e.g. `{ "key1": "value1", "key2": "value2" }`
+   * 2. As an "uploadable" object in dotenv format. An uploadable can be a Node readable stream, a string, or a Buffer. You can also pass the return value of a `fetch` call.
+   */
+  variables: Uploadable | BlobLikePart | Record<string, string>;
+
+  overwrite?: boolean;
+}

packages/core/src/v3/apiClientManager/index.ts

@@ -33,7 +33,7 @@ export class APIClientManagerAPI {
 
   get accessToken(): string | undefined {
     const store = this.#getConfig();
-    return store?.secretKey ?? getEnvVar("TRIGGER_SECRET_KEY");
+    return store?.secretKey ?? getEnvVar("TRIGGER_SECRET_KEY") ?? getEnvVar("TRIGGER_ACCESS_TOKEN");
   }
 
   get client(): ApiClient | undefined {

packages/core/src/v3/schemas/api.ts

@@ -389,3 +389,18 @@ export const ImportEnvironmentVariablesRequestBody = z.object({
 export type ImportEnvironmentVariablesRequestBody = z.infer<
   typeof ImportEnvironmentVariablesRequestBody
 >;
+
+export const EnvironmentVariableResponseBody = z.object({
+  success: z.boolean(),
+});
+
+export const EnvironmentVariableValue = z.object({
+  value: z.string(),
+});
+
+export const EnvironmentVariable = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+
+export const EnvironmentVariables = z.array(EnvironmentVariable);