wrc-ts 0.1.0

package/dist/config.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Configuration for renting a browser session.
+ * Create with the required parameters, then chain optional setters.
+ *
+ * @example
+ * const config = new BrowserConfig("api-key", 300, "proxy.example.com", 8080, "user", "pass")
+ *   .withCountryCode("DE")
+ *   .withTimezone("Europe/Berlin");
+ */
+export declare class BrowserConfig {
+    readonly apiKey: string;
+    readonly rentDuration: number;
+    readonly proxyHost: string;
+    readonly proxyPort: number;
+    readonly proxyUsername: string;
+    readonly proxyPassword: string;
+    private _countryCode?;
+    private _timezone?;
+    private _fingerprint?;
+    constructor(apiKey: string, rentDuration: number, proxyHost: string, proxyPort: number, proxyUsername: string, proxyPassword: string);
+    /**
+     * Sets the geo-IP country code for the rented session.
+     *
+     * Drives both the assigned exit-IP region and the locale defaults
+     * (Accept-Language, timezone fallback) when those are not overridden
+     * separately.
+     *
+     * @param countryCode - ISO-3166 country code (e.g. "DE", "US")
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withCountryCode("DE");
+     */
+    withCountryCode(countryCode: string): BrowserConfig;
+    /**
+     * Sets the IANA timezone for the rented session.
+     *
+     * @param timezone - IANA timezone (e.g. "Europe/Berlin")
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withTimezone("Europe/Berlin");
+     */
+    withTimezone(timezone: string): BrowserConfig;
+    /**
+     * Pins a specific browser fingerprint id for the session.
+     *
+     * When omitted the server picks a fingerprint based on the country
+     * code. Pass a known id (e.g. one returned by a previous rental) to
+     * keep fingerprints stable across sessions.
+     *
+     * @param fingerprint - server-side fingerprint id
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withFingerprint("fp_abc123");
+     */
+    withFingerprint(fingerprint: string): BrowserConfig;
+    get countryCode(): string | undefined;
+    get timezone(): string | undefined;
+    get fingerprint(): string | undefined;
+}

package/dist/config.js

@@ -0,0 +1,78 @@
+/**
+ * Configuration for renting a browser session.
+ * Create with the required parameters, then chain optional setters.
+ *
+ * @example
+ * const config = new BrowserConfig("api-key", 300, "proxy.example.com", 8080, "user", "pass")
+ *   .withCountryCode("DE")
+ *   .withTimezone("Europe/Berlin");
+ */
+export class BrowserConfig {
+    constructor(apiKey, rentDuration, proxyHost, proxyPort, proxyUsername, proxyPassword) {
+        this.apiKey = apiKey;
+        this.rentDuration = rentDuration;
+        this.proxyHost = proxyHost;
+        this.proxyPort = proxyPort;
+        this.proxyUsername = proxyUsername;
+        this.proxyPassword = proxyPassword;
+    }
+    /**
+     * Sets the geo-IP country code for the rented session.
+     *
+     * Drives both the assigned exit-IP region and the locale defaults
+     * (Accept-Language, timezone fallback) when those are not overridden
+     * separately.
+     *
+     * @param countryCode - ISO-3166 country code (e.g. "DE", "US")
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withCountryCode("DE");
+     */
+    withCountryCode(countryCode) {
+        this._countryCode = countryCode;
+        return this;
+    }
+    /**
+     * Sets the IANA timezone for the rented session.
+     *
+     * @param timezone - IANA timezone (e.g. "Europe/Berlin")
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withTimezone("Europe/Berlin");
+     */
+    withTimezone(timezone) {
+        this._timezone = timezone;
+        return this;
+    }
+    /**
+     * Pins a specific browser fingerprint id for the session.
+     *
+     * When omitted the server picks a fingerprint based on the country
+     * code. Pass a known id (e.g. one returned by a previous rental) to
+     * keep fingerprints stable across sessions.
+     *
+     * @param fingerprint - server-side fingerprint id
+     *
+     * @returns this BrowserConfig for chaining
+     *
+     * @example
+     * new BrowserConfig(apiKey, 600, "", 0, "", "").withFingerprint("fp_abc123");
+     */
+    withFingerprint(fingerprint) {
+        this._fingerprint = fingerprint;
+        return this;
+    }
+    get countryCode() {
+        return this._countryCode;
+    }
+    get timezone() {
+        return this._timezone;
+    }
+    get fingerprint() {
+        return this._fingerprint;
+    }
+}

package/dist/cookies.d.ts

@@ -0,0 +1,21 @@
+/** Partition metadata for partitioned cookies (CHIPS). */
+export interface CookiePartitionKey {
+    topLevelSite: string;
+    hasCrossSiteAncestor: boolean;
+}
+/** CookieParam is one entry returned by getCookies() or passed to setCookies(). */
+export interface CookieParam {
+    name: string;
+    value: string;
+    url?: string;
+    domain: string;
+    path: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    sameSite?: string;
+    expires?: number;
+    priority?: string;
+    sourceScheme?: string;
+    sourcePort?: number;
+    partitionKey?: CookiePartitionKey;
+}

package/dist/cookies.js

@@ -0,0 +1 @@
+export {};

package/dist/defaults.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Default timeout (ms) used by wait() / waitAny() when no opts.timeoutMs
+ * is passed.
+ */
+export declare const DefaultWaitTimeoutMs = 30000;
+/**
+ * Default visibility flag baked into css(...) and js(...). For JS
+ * expressions returning a non-Element value (boolean, string, number,
+ * plain object) this flag is a no-op. Use .visible(false) on the returned
+ * Locator to opt out.
+ */
+export declare const DefaultVisible = true;
+/**
+ * Default steady-time (ms) baked into css(...) and js(...). For JS
+ * expressions returning a non-Element value this is a no-op. Use
+ * .steady(ms) (or .steady(0) to disable) on the returned Locator to
+ * override.
+ */
+export declare const DefaultSteadyMs = 500;

package/dist/defaults.js

@@ -0,0 +1,22 @@
+// Defaults the SDK applies automatically before sending a request. Any
+// field not listed here is left unset on the wire and follows the WRC API's
+// server-side default.
+/**
+ * Default timeout (ms) used by wait() / waitAny() when no opts.timeoutMs
+ * is passed.
+ */
+export const DefaultWaitTimeoutMs = 30000;
+/**
+ * Default visibility flag baked into css(...) and js(...). For JS
+ * expressions returning a non-Element value (boolean, string, number,
+ * plain object) this flag is a no-op. Use .visible(false) on the returned
+ * Locator to opt out.
+ */
+export const DefaultVisible = true;
+/**
+ * Default steady-time (ms) baked into css(...) and js(...). For JS
+ * expressions returning a non-Element value this is a no-op. Use
+ * .steady(ms) (or .steady(0) to disable) on the returned Locator to
+ * override.
+ */
+export const DefaultSteadyMs = 500;

package/dist/errors.d.ts

@@ -0,0 +1,18 @@
+/**
+ * WRCError is the single error type thrown by all SDK methods. It wraps
+ * either:
+ *   - a client-side validation failure (bad locator, missing patterns, …)
+ *   - a server-side gRPC error (Connect's ConnectError, available as `cause`)
+ *
+ * Catch it with `instanceof WRCError`:
+ *
+ *   try {
+ *     await browser.click(css("#btn"));
+ *   } catch (e) {
+ *     if (e instanceof WRCError) { ... }
+ *   }
+ */
+export declare class WRCError extends Error {
+    readonly cause?: unknown | undefined;
+    constructor(message: string, cause?: unknown | undefined);
+}

package/dist/errors.js

@@ -0,0 +1,21 @@
+/**
+ * WRCError is the single error type thrown by all SDK methods. It wraps
+ * either:
+ *   - a client-side validation failure (bad locator, missing patterns, …)
+ *   - a server-side gRPC error (Connect's ConnectError, available as `cause`)
+ *
+ * Catch it with `instanceof WRCError`:
+ *
+ *   try {
+ *     await browser.click(css("#btn"));
+ *   } catch (e) {
+ *     if (e instanceof WRCError) { ... }
+ *   }
+ */
+export class WRCError extends Error {
+    constructor(message, cause) {
+        super(message);
+        this.cause = cause;
+        this.name = "WRCError";
+    }
+}

package/dist/gen/google/protobuf/empty_pb.d.ts

@@ -0,0 +1,15 @@
+import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file google/protobuf/empty.proto.
+ */
+export declare const file_google_protobuf_empty: GenFile;
+/**
+ * @generated from message google.protobuf.Empty
+ */
+export type Empty = Message<"google.protobuf.Empty"> & {};
+/**
+ * Describes the message google.protobuf.Empty.
+ * Use `create(EmptySchema)` to create a new message.
+ */
+export declare const EmptySchema: GenMessage<Empty>;

package/dist/gen/google/protobuf/empty_pb.js

@@ -0,0 +1,13 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=ts"
+// @generated from file google/protobuf/empty.proto (package google.protobuf, syntax proto3)
+/* eslint-disable */
+import { fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+/**
+ * Describes the file google/protobuf/empty.proto.
+ */
+export const file_google_protobuf_empty = /*@__PURE__*/ fileDesc("Chtnb29nbGUvcHJvdG9idWYvZW1wdHkucHJvdG8SD2dvb2dsZS5wcm90b2J1ZiIHCgVFbXB0eUIwWi5nb29nbGUuZ29sYW5nLm9yZy9wcm90b2J1Zi90eXBlcy9rbm93bi9lbXB0eXBiYgZwcm90bzM");
+/**
+ * Describes the message google.protobuf.Empty.
+ * Use `create(EmptySchema)` to create a new message.
+ */
+export const EmptySchema = /*@__PURE__*/ messageDesc(file_google_protobuf_empty, 0);