Release 0.1.4

Scrapybara · Dec 7, 2024 · 2ff819c · 2ff819c
1 parent a7ed5d6
commit 2ff819c
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Instantiate and use the client with the following:
 ```typescript
 import { ScrapybaraClient } from "scrapybara";
 
-const client = new ScrapybaraClient({ authorization: "YOUR_AUTHORIZATION" });
+const client = new ScrapybaraClient({ apiKey: "YOUR_API_KEY" });
 await client.start();
 ```
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "scrapybara",
-    "version": "0.1.3",
+    "version": "0.1.4",
     "private": false,
     "repository": "https://github.com/scrapybara/scrapybara-ts",
     "main": "./index.js",

diff --git a/src/Client.ts b/src/Client.ts
@@ -14,8 +14,7 @@ import { Browser } from "./api/resources/browser/client/Client";
 export declare namespace ScrapybaraClient {
     interface Options {
         environment?: core.Supplier<environments.ScrapybaraEnvironment | string>;
-        /** Override the authorization header */
-        authorization: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
     }
 
     interface RequestOptions {
@@ -25,8 +24,6 @@ export declare namespace ScrapybaraClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }
@@ -57,8 +54,8 @@ export class ScrapybaraClient {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -136,8 +133,8 @@ export class ScrapybaraClient {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -207,7 +204,7 @@ export class ScrapybaraClient {
     }
 
     protected async _getCustomAuthorizationHeaders() {
-        const authorizationValue = await core.Supplier.get(this._options.authorization);
-        return { authorization: authorizationValue };
+        const apiKeyValue = (await core.Supplier.get(this._options.apiKey)) ?? process?.env["SCRAPYBARA_API_KEY"];
+        return { "X-API-Key": apiKeyValue };
     }
 }
diff --git a/src/api/resources/browser/client/Client.ts b/src/api/resources/browser/client/Client.ts
@@ -12,8 +12,7 @@ import * as errors from "../../../../errors/index";
 export declare namespace Browser {
     interface Options {
         environment?: core.Supplier<environments.ScrapybaraEnvironment | string>;
-        /** Override the authorization header */
-        authorization: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
     }
 
     interface RequestOptions {
@@ -23,8 +22,6 @@ export declare namespace Browser {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }
@@ -55,8 +52,8 @@ export class Browser {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -135,8 +132,8 @@ export class Browser {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -224,8 +221,8 @@ export class Browser {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -305,8 +302,8 @@ export class Browser {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -364,7 +361,7 @@ export class Browser {
     }
 
     protected async _getCustomAuthorizationHeaders() {
-        const authorizationValue = await core.Supplier.get(this._options.authorization);
-        return { authorization: authorizationValue };
+        const apiKeyValue = (await core.Supplier.get(this._options.apiKey)) ?? process?.env["SCRAPYBARA_API_KEY"];
+        return { "X-API-Key": apiKeyValue };
     }
 }
diff --git a/src/api/resources/instance/client/Client.ts b/src/api/resources/instance/client/Client.ts
@@ -12,8 +12,7 @@ import * as errors from "../../../../errors/index";
 export declare namespace Instance {
     interface Options {
         environment?: core.Supplier<environments.ScrapybaraEnvironment | string>;
-        /** Override the authorization header */
-        authorization: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
     }
 
     interface RequestOptions {
@@ -23,8 +22,6 @@ export declare namespace Instance {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }
@@ -55,8 +52,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -135,8 +132,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -219,8 +216,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -297,8 +294,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -378,8 +375,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -454,8 +451,8 @@ export class Instance {
             headers: {
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "scrapybara",
-                "X-Fern-SDK-Version": "0.1.3",
-                "User-Agent": "scrapybara/0.1.3",
+                "X-Fern-SDK-Version": "0.1.4",
+                "User-Agent": "scrapybara/0.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
                 ...(await this._getCustomAuthorizationHeaders()),
@@ -513,7 +510,7 @@ export class Instance {
     }
 
     protected async _getCustomAuthorizationHeaders() {
-        const authorizationValue = await core.Supplier.get(this._options.authorization);
-        return { authorization: authorizationValue };
+        const apiKeyValue = (await core.Supplier.get(this._options.apiKey)) ?? process?.env["SCRAPYBARA_API_KEY"];
+        return { "X-API-Key": apiKeyValue };
     }
 }
diff --git a/src/version.ts b/src/version.ts
@@ -1 +1 @@
-export const SDK_VERSION = "0.1.3";
+export const SDK_VERSION = "0.1.4";
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export const SDK_VERSION = "0.1.3";
		export const SDK_VERSION = "0.1.4";