endform 0.66.1 → 0.68.0

package/lib/index.cjs

@@ -0,0 +1,9 @@
+/**
+ * Define an Endform configuration in an `endform.config.ts` (or `.js`) file.
+ * This is an identity function that exists to provide type checking and editor completion.
+ */
+function defineEndformConfig(config) {
+  return config;
+}
+
+module.exports = { defineEndformConfig };

package/lib/index.d.ts

@@ -0,0 +1,204 @@
+/**
+ * A concurrency limit for running tests, applied within a single suite run
+ * or across all currently running suite runs in your organization.
+ *
+ * Running tests must satisfy all applicable limits.
+ *
+ * @see https://endform.dev/docs/reference/endform-config-ts#concurrenttestlimits
+ */
+export interface ConcurrentTestLimit {
+  /**
+   * The scope this limit applies to:
+   *
+   * - `"within-suite-run"` limits concurrent tests in that test suite run.
+   * - `"across-all-runs"` limits concurrent tests across all matching test
+   *   suites that your organization is running - a shared, global limit.
+   */
+  scope: "within-suite-run" | "across-all-runs";
+  /**
+   * Optionally restrict which tests the limit applies to:
+   *
+   * - Use `"tag:@my-tag"` to limit by test tag
+   *   (see https://playwright.dev/docs/test-annotations#tag-tests).
+   * - Use `"project:project-name"` to limit runs of tests within a Playwright project.
+   * - If not set, the limit applies to all tests in the run.
+   */
+  label?: string;
+  /**
+   * The maximum number of allowed concurrent tests to run within this group.
+   * Must be greater than 0.
+   */
+  limit: number;
+}
+
+/**
+ * Endform configuration.
+ *
+ * All fields are optional - Endform works without any configuration,
+ * enriching the defaults derived from your Playwright config.
+ *
+ * @see https://endform.dev/docs/reference/endform-config-ts
+ */
+export interface EndformConfig {
+  /**
+   * An array of strings used as globs to send extra files to your test machines.
+   * Patterns are resolved relative to your Playwright config directory.
+   *
+   * If your Playwright config already specifies `storageState`, this parameter
+   * should not be needed - Endform will read and send those files automatically.
+   * Use this parameter if your tests have implicit dependencies on more files.
+   *
+   * @example ["user-state/*"]
+   * @see https://endform.dev/docs/reference/endform-config-ts#additionalfiles
+   */
+  additionalFiles?: string[];
+  /**
+   * An array of string regular expressions that are used to match environment
+   * variables that should be transferred to the remote runners.
+   *
+   * By default the following environment variables are automatically transferred:
+   *
+   * - Environment variables that start with `E2E_`
+   * - All environment variables that are set in your `playwright.config.ts`
+   *
+   * @example ["VERCEL_.*"]
+   * @see https://endform.dev/docs/reference/endform-config-ts#environmentvariables
+   */
+  environmentVariables?: string[];
+  /**
+   * Host names whose HTTP traffic will be redirected from the remote runners
+   * to the CLI on your local network. This is the easiest option for local web
+   * apps and APIs, and uses HTTP interception in Node and in the browser.
+   *
+   * Each string in the array is a match rule. Either:
+   *
+   * - A hostname pattern like `"my-domain.com"` or `"*.internal.org"`
+   * - An IP literal like `"127.0.0.1"`
+   * - `"<loopback>"` to match the interfaces `localhost`, `*.localhost`,
+   *   `127.0.0.1` and `[::1]`
+   *
+   * All the traffic sent from the remote runners to your CLI is sent encrypted
+   * over direct peer-to-peer connections.
+   *
+   * @example ["*.test.internal-domain", "<loopback>"]
+   * @see https://endform.dev/docs/reference/endform-config-ts#proxynetworkhosts
+   * @see https://endform.dev/docs/guides/proxy-via-local
+   */
+  proxyNetworkHosts?: string[];
+  /**
+   * Local loopback ports that will accept raw TCP connections from the remote
+   * runners. Use this for databases or other clients that need to connect
+   * directly to `127.0.0.1:<port>`.
+   *
+   * All the traffic sent from the remote runners to your CLI is sent encrypted
+   * over direct peer-to-peer connections.
+   *
+   * @example [5432, 6379]
+   * @see https://endform.dev/docs/reference/endform-config-ts#proxynetworkports
+   * @see https://endform.dev/docs/guides/proxy-via-local
+   */
+  proxyNetworkPorts?: number[];
+  /**
+   * The organization ID this project should run within. This is the
+   * highest-precedence configuration for organization ID when running suites.
+   * Suite runs fail if the authenticated user does not have access to that
+   * organization.
+   *
+   * @see https://endform.dev/docs/reference/endform-config-ts#organizationid
+   */
+  organizationId?: string;
+  /**
+   * By default, your tests are run in the closest available region to where
+   * the Endform CLI was run. Set this to override that choice, for example if
+   * your test environment is in a different region from your CI jobs.
+   *
+   * @see https://endform.dev/docs/reference/endform-config-ts#region
+   */
+  region?: "eu" | "us";
+  /**
+   * An array of reporter names that should run exclusively during remote
+   * execution of tests. Each name must correspond to the name of a reporter
+   * configured in your Playwright config.
+   *
+   * Reporters listed here run once on each remotely running test machine
+   * (one per test), and _not_ on the collected result.
+   *
+   * @example ["./custom-reporter.ts"]
+   * @see https://endform.dev/docs/reference/endform-config-ts#remotereporters
+   */
+  remoteReporters?: string[];
+  /**
+   * Control whether Endform retains Playwright traces for viewing in the
+   * dashboard. Defaults to `"on"`.
+   *
+   * When set to `"off"`, traces are not uploaded to Endform. This can be
+   * useful for compliance requirements or if you have privacy concerns about
+   * trace data.
+   *
+   * Note: this setting only controls what Endform stores for dashboard
+   * viewing. Regardless of this setting, traces are still generated and
+   * accessible locally depending on your Playwright `trace` config option.
+   *
+   * @see https://endform.dev/docs/reference/endform-config-ts#traceretention
+   */
+  traceRetention?: "on" | "off";
+  /**
+   * Extra HTTP headers that will be applied to the Playwright browser
+   * contexts when tests run on remote runners.
+   *
+   * These headers are merged into Playwright's `extraHTTPHeaders` option on
+   * both the top-level `use` and each project's `use`. Headers defined in your
+   * `playwright.config.ts` take precedence - if the same header name exists in
+   * both your Playwright config and your Endform config, the value from your
+   * Playwright config wins.
+   *
+   * Can be overridden with the `ENDFORM_EXTRA_HTTP_HEADERS` environment
+   * variable, set to a JSON string of key-value pairs. When that environment
+   * variable is set, it fully replaces this value (the two are not merged).
+   *
+   * @example { "x-bypass-protection": "token-value" }
+   * @see https://endform.dev/docs/reference/endform-config-ts#extrahttpheaders
+   */
+  extraHttpHeaders?: Record<string, string>;
+  /**
+   * Concurrency limits for a suite run. Each item has a `scope`, optional
+   * `label`, and `limit`. Running tests must satisfy all applicable limits.
+   *
+   * @example
+   * [
+   *   { scope: "within-suite-run", limit: 20 },
+   *   { scope: "within-suite-run", label: "tag:@smoke", limit: 2 },
+   *   { scope: "across-all-runs", label: "project:slow-backend", limit: 10 },
+   * ]
+   * @see https://endform.dev/docs/reference/endform-config-ts#concurrenttestlimits
+   */
+  concurrentTestLimits?: ConcurrentTestLimit[];
+}
+
+/**
+ * Define an Endform configuration in an `endform.config.ts` file
+ * (`.mts`, `.js`, `.mjs` and `.cjs` are also supported).
+ *
+ * Place the config file:
+ *
+ * - In the same folder as your Playwright suite -> applies to that suite
+ * - In the root of your repository -> applies to all suites in your repository
+ *
+ * This is an identity function that exists to provide type checking and
+ * editor completion.
+ *
+ * @example
+ * ```ts
+ * import { defineEndformConfig } from "endform";
+ *
+ * export default defineEndformConfig({
+ *   environmentVariables: ["VERCEL_.*"],
+ * });
+ * ```
+ */
+export declare function defineEndformConfig(
+  config: EndformConfig,
+): EndformConfig;
+export declare function defineEndformConfig(
+  config: () => EndformConfig | Promise<EndformConfig>,
+): () => EndformConfig | Promise<EndformConfig>;

package/lib/index.mjs

@@ -0,0 +1,7 @@
+/**
+ * Define an Endform configuration in an `endform.config.ts` (or `.js`) file.
+ * This is an identity function that exists to provide type checking and editor completion.
+ */
+export function defineEndformConfig(config) {
+  return config;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "endform",
-  "version": "0.66.1",
+  "version": "0.68.0",
   "description": "Endform CLI",
   "license": "UNLICENSED",
   "repository": "https://github.com/endformdev/npm",
@@ -8,13 +8,22 @@
     "endform": "./bin/endform"
   },
   "files": [
-    "bin"
+    "bin",
+    "lib"
   ],
-  "main": "./bin/endform",
+  "main": "./lib/index.cjs",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs"
+    }
+  },
   "optionalDependencies": {
-    "endform-darwin-arm64": "0.66.1",
-    "endform-darwin-x86": "0.66.1",
-    "endform-linux-arm64": "0.66.1",
-    "endform-linux-x86": "0.66.1"
+    "endform-darwin-arm64": "0.68.0",
+    "endform-darwin-x86": "0.68.0",
+    "endform-linux-arm64": "0.68.0",
+    "endform-linux-x86": "0.68.0"
   }
 }