sprntrl 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,148 @@
+export type ProxyProtocol = "HTTP" | "HTTPS" | "SOCKS5";
+export type SessionStatus = "creating" | "running" | "stopping" | "stopped" | "failed" | "archiving";
+export type OS = "macos" | "windows";
+export interface ProxyConfig {
+    protocol?: ProxyProtocol;
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+}
+/**
+ * Flattened, display-friendly view of the proxy attached to a session.
+ * Only present for BYO (bring-your-own) proxies — pool proxies are shared
+ * infra and the API deliberately hides their host/port. The password is
+ * never returned.
+ */
+export interface ProxySummary {
+    protocol: string;
+    host: string;
+    port: number;
+    username?: string;
+    /** Convenience form: `protocol://host:port`. */
+    address: string;
+}
+export interface Session {
+    id: string;
+    user_id: string;
+    profile_id?: string | null;
+    container_id?: string | null;
+    chrome_port?: number | null;
+    status: SessionStatus;
+    persistent: boolean;
+    captcha_solver: boolean;
+    session_name?: string | null;
+    data_dir_path?: string | null;
+    data_dir_size: number;
+    storage_status: string;
+    os: OS;
+    location: string;
+    started_at?: string | null;
+    stopped_at?: string | null;
+    created_at: string;
+    cdp_url?: string;
+    uptime_seconds: number;
+    sidecar_port?: number;
+    /** Present only for BYO-proxy sessions. */
+    proxy?: ProxySummary;
+}
+export interface PaginatedSessions {
+    sessions: Session[];
+    total: number;
+    page: number;
+    per_page: number;
+}
+export interface Profile {
+    id: string;
+    user_id: string;
+    name: string;
+    description?: string | null;
+    os?: string | null;
+    location?: string | null;
+    persona?: string | null;
+    config_json: unknown;
+    template_id?: string | null;
+    created_at: string;
+    updated_at: string;
+}
+export interface Template {
+    id: string;
+    name: string;
+    os: string;
+    config: unknown;
+}
+export interface IPWhitelistEntry {
+    id: string;
+    user_id: string;
+    ip_address: string;
+    label?: string | null;
+    created_at: string;
+}
+export interface APIKey {
+    id: string;
+    name: string;
+    key_prefix: string;
+    last_used_at?: string | null;
+    created_at: string;
+    revoked_at?: string | null;
+}
+export interface APIKeyCreated extends APIKey {
+    /** Returned ONLY once at creation time. Store it immediately. */
+    key: string;
+}
+export interface Usage {
+    total_minutes: number;
+    plan_minutes: number;
+    overage_minutes: number;
+    month: string;
+    plan: string;
+    usage_percentage: number;
+    allow_hours_overage: boolean;
+    /** Present when the plan exposes a profile cap. */
+    profile_count?: number;
+    max_profiles?: number;
+    /** Pool-proxy bandwidth, cents per GB. */
+    bandwidth_rate_cents?: number;
+    /** Charge per hour over the plan's included minutes, in cents. */
+    hours_overage_rate_cents?: number;
+    /** Bytes of pool-proxy bandwidth consumed this period. */
+    bandwidth_bytes?: number;
+    /** Accrued bandwidth overage charge this period, in cents. */
+    bandwidth_charge_amount_cents?: number;
+    /** Minutes used beyond the plan allowance this period. */
+    hours_overage_minutes?: number;
+    /** Accrued hours-overage charge this period, in cents. */
+    hours_overage_amount_cents?: number;
+}
+export interface UsageMonth {
+    month: string;
+    total_minutes: number;
+    plan_minutes: number;
+    overage_minutes: number;
+}
+export type AccountStatus = "pending_verification" | "pending_payment" | "active";
+export interface User {
+    id: string;
+    email: string;
+    name?: string | null;
+    plan: string;
+    role: string;
+    allow_hours_overage: boolean;
+    /** When true, the account may only use BYO proxies (no pool proxy). */
+    byo_proxy_only: boolean;
+    /** Pool-proxy bandwidth, cents per GB. */
+    bandwidth_rate_cents: number;
+    /** Charge per hour over the plan's included minutes, in cents. */
+    hours_overage_rate_cents: number;
+    must_change_password: boolean;
+    email_verified: boolean;
+    account_status: AccountStatus;
+    /** Set for OAuth signups ("google" | "github"); absent for password accounts. */
+    oauth_provider?: string;
+    created_at: string;
+}
+export interface FileInfo {
+    name: string;
+    size: number;
+    modified?: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "sprntrl",
+  "version": "0.1.0",
+  "description": "Supernatural Node SDK — stealth browser-as-a-service client.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "browser",
+    "automation",
+    "playwright",
+    "puppeteer",
+    "cdp",
+    "stealth",
+    "scraping"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/supernatural-browser/sprntrl-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/supernatural-browser/sprntrl-node/issues"
+  },
+  "homepage": "https://supernatural.sh",
+  "author": "Supernatural",
+  "license": "MIT",
+  "peerDependencies": {
+    "playwright": "^1.40.0",
+    "puppeteer": "^22.0.0",
+    "puppeteer-core": "^22.0.0"
+  },
+  "peerDependenciesMeta": {
+    "playwright": { "optional": true },
+    "puppeteer": { "optional": true },
+    "puppeteer-core": { "optional": true }
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0"
+  }
+}