dub 0.34.2 → 0.36.0

package/src/lib/sdks.ts

@@ -1,16 +1,31 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ResponseMatcher, HTTPClient, matchStatusCode } from "./http.js";
-import { SecurityState, resolveSecurity, resolveGlobalSecurity } from "./security.js";
+import {
+    HTTPClient,
+    matchContentType,
+    matchStatusCode,
+    isAbortError,
+    isTimeoutError,
+    isConnectionError,
+} from "./http.js";
+import { SecurityState } from "./security.js";
 import { retry, RetryConfig } from "./retries.js";
-import { pathToFunc } from "./url.js";
+import { Logger } from "./logger.js";
 import { encodeForm } from "./encodings.js";
 import { stringToBase64 } from "./base64.js";
-import { SDK_METADATA } from "./config.js";
+import { SDKOptions, SDK_METADATA, serverURLFromOptions } from "./config.js";
 import { SDKHooks } from "../hooks/hooks.js";
 import { HookContext } from "../hooks/types.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ERR, OK, Result } from "../types/fp.js";
 
 export type RequestOptions = {
     /**
@@ -58,32 +73,49 @@ const isBrowserLike =
     (typeof window === "object" && typeof window.document !== "undefined");
 
 export class ClientSDK {
-    private readonly client: HTTPClient;
+    private readonly httpClient: HTTPClient;
     protected readonly baseURL: URL | null;
     protected readonly hooks$: SDKHooks;
+    protected readonly logger?: Logger | undefined;
+    public readonly options$: SDKOptions & { hooks?: SDKHooks };
 
-    constructor(init: { client: HTTPClient; baseURL: URL | null; hooks: SDKHooks }) {
-        const url = init.baseURL;
+    constructor(options: SDKOptions = {}) {
+        const opt = options as unknown;
+        if (
+            typeof opt === "object" &&
+            opt != null &&
+            "hooks" in opt &&
+            opt.hooks instanceof SDKHooks
+        ) {
+            this.hooks$ = opt.hooks;
+        } else {
+            this.hooks$ = new SDKHooks();
+        }
+        this.options$ = { ...options, hooks: this.hooks$ };
+
+        const url = serverURLFromOptions(options);
         if (url) {
             url.pathname = url.pathname.replace(/\/+$/, "") + "/";
         }
-
-        this.hooks$ = init.hooks;
-        const { baseURL, client } = this.hooks$.sdkInit({ baseURL: url, client: init.client });
+        const { baseURL, client } = this.hooks$.sdkInit({
+            baseURL: url,
+            client: options.httpClient || new HTTPClient(),
+        });
         this.baseURL = baseURL;
-        this.client = client;
+        this.httpClient = client;
+        this.logger = options.debugLogger;
     }
 
-    protected createRequest$(
+    public createRequest$(
         context: HookContext,
         conf: RequestConfig,
         options?: RequestOptions
-    ): Request {
+    ): Result<Request, InvalidRequestError | UnexpectedClientError> {
         const { method, path, query, headers: opHeaders, security } = conf;
 
         const base = conf.baseURL ?? this.baseURL;
         if (!base) {
-            throw new TypeError("No base URL provided for operation");
+            return ERR(new InvalidRequestError("No base URL provided for operation"));
         }
         const reqURL = new URL(base);
         const inputURL = new URL(path, reqURL);
@@ -149,20 +181,27 @@ export class ClientSDK {
             }
         }
 
-        const input = this.hooks$.beforeCreateRequest(context, {
-            url: reqURL,
-            options: {
-                ...fetchOptions,
-                body: conf.body ?? null,
-                headers,
-                method,
-            },
-        });
+        let input;
+        try {
+            input = this.hooks$.beforeCreateRequest(context, {
+                url: reqURL,
+                options: {
+                    ...fetchOptions,
+                    body: conf.body ?? null,
+                    headers,
+                    method,
+                },
+            });
+        } catch (err: unknown) {
+            return ERR(
+                new UnexpectedClientError("Create request hook failed to execute", { cause: err })
+            );
+        }
 
-        return new Request(input.url, input.options);
+        return OK(new Request(input.url, input.options));
     }
 
-    protected async do$(
+    public async do$(
         request: Request,
         options: {
             context: HookContext;
@@ -170,19 +209,25 @@ export class ClientSDK {
             retryConfig?: RetryConfig | undefined;
             retryCodes?: string[] | undefined;
         }
-    ): Promise<Response> {
+    ): Promise<
+        Result<
+            Response,
+            RequestAbortedError | RequestTimeoutError | ConnectionError | UnexpectedClientError
+        >
+    > {
         const { context, errorCodes } = options;
         const retryConfig = options.retryConfig || { strategy: "none" };
         const retryCodes = options.retryCodes || [];
 
         return retry(
             async () => {
-                const req = request.clone();
-
-                let response = await this.client.request(
-                    await this.hooks$.beforeRequest(context, req)
+                const req = await this.hooks$.beforeRequest(context, request.clone());
+                await logRequest(this.logger, req).catch((e) =>
+                    this.logger?.log("Failed to log request:", e)
                 );
 
+                let response = await this.httpClient.request(req);
+
                 if (matchStatusCode(response, errorCodes)) {
                     const result = await this.hooks$.afterError(context, response, null);
                     if (result.error) {
@@ -193,18 +238,120 @@ export class ClientSDK {
                     response = await this.hooks$.afterSuccess(context, response);
                 }
 
+                await logResponse(this.logger, response, req).catch((e) =>
+                    this.logger?.log("Failed to log response:", e)
+                );
+
                 return response;
             },
             { config: retryConfig, statusCodes: retryCodes }
+        ).then(
+            (r) => OK(r),
+            (err) => {
+                switch (true) {
+                    case isAbortError(err):
+                        return ERR(
+                            new RequestAbortedError("Request aborted by client", { cause: err })
+                        );
+                    case isTimeoutError(err):
+                        return ERR(new RequestTimeoutError("Request timed out", { cause: err }));
+                    case isConnectionError(err):
+                        return ERR(new ConnectionError("Unable to make request", { cause: err }));
+                    default:
+                        return ERR(
+                            new UnexpectedClientError("Unexpected HTTP client error", {
+                                cause: err,
+                            })
+                        );
+                }
+            }
         );
     }
+}
 
-    protected matcher<Result>(): ResponseMatcher<Result> {
-        return new ResponseMatcher<Result>();
+const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/;
+async function logRequest(logger: Logger | undefined, req: Request) {
+    if (!logger) {
+        return;
     }
 
-    protected templateURLComponent = pathToFunc;
+    const contentType = req.headers.get("content-type");
+    const ct = contentType?.split(";")[0] || "";
+
+    logger.group(`> Request: ${req.method} ${req.url}`);
+
+    logger.group("Headers:");
+    for (const [k, v] of req.headers.entries()) {
+        logger.log(`${k}: ${v}`);
+    }
+    logger.groupEnd();
+
+    logger.group("Body:");
+    switch (true) {
+        case jsonLikeContentTypeRE.test(ct):
+            logger.log(await req.clone().json());
+            break;
+        case ct.startsWith("text/"):
+            logger.log(await req.clone().text());
+            break;
+        case ct === "multipart/form-data": {
+            const body = await req.clone().formData();
+            for (const [k, v] of body) {
+                const vlabel = v instanceof Blob ? "<Blob>" : v;
+                logger.log(`${k}: ${vlabel}`);
+            }
+            break;
+        }
+        default:
+            logger.log(`<${contentType}>`);
+            break;
+    }
+    logger.groupEnd();
+
+    logger.groupEnd();
+}
+
+async function logResponse(logger: Logger | undefined, res: Response, req: Request) {
+    if (!logger) {
+        return;
+    }
+
+    const contentType = res.headers.get("content-type");
+    const ct = contentType?.split(";")[0] || "";
+
+    logger.group(`< Response: ${req.method} ${req.url}`);
+    logger.log("Status Code:", res.status, res.statusText);
+
+    logger.group("Headers:");
+    for (const [k, v] of res.headers.entries()) {
+        logger.log(`${k}: ${v}`);
+    }
+    logger.groupEnd();
+
+    logger.group("Body:");
+    switch (true) {
+        case matchContentType(res, "application/json") || jsonLikeContentTypeRE.test(ct):
+            logger.log(await res.clone().json());
+            break;
+        case matchContentType(res, "text/event-stream"):
+            logger.log(`<${contentType}>`);
+            break;
+        case matchContentType(res, "text/*"):
+            logger.log(await res.clone().text());
+            break;
+        case matchContentType(res, "multipart/form-data"): {
+            const body = await res.clone().formData();
+            for (const [k, v] of body) {
+                const vlabel = v instanceof Blob ? "<Blob>" : v;
+                logger.log(`${k}: ${vlabel}`);
+            }
+            break;
+        }
+        default:
+            logger.log(`<${contentType}>`);
+            break;
+    }
+    logger.groupEnd();
 
-    protected resolveSecurity = resolveSecurity;
-    protected resolveGlobalSecurity = resolveGlobalSecurity;
+    logger.groupEnd();
 }

package/src/lib/security.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as components from "../models/components/index.js";
@@ -180,3 +180,13 @@ export function resolveGlobalSecurity(
         },
     ]);
 }
+
+export async function extractSecurity<T extends string | Record<string, unknown>>(
+    sec: T | (() => Promise<T>) | undefined
+): Promise<T | undefined> {
+    if (sec == null) {
+        return;
+    }
+
+    return typeof sec === "function" ? sec() : sec;
+}

package/src/lib/url.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 const hasOwn = Object.prototype.hasOwnProperty;

package/src/models/components/clickevents.ts

@@ -0,0 +1,112 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as z from "zod";
+
+export type ClickEvents = {
+    timestamp: string;
+    clickId: string;
+    linkId: string;
+    domain: string;
+    key: string;
+    url: string;
+    continent: string | null;
+    country: string | null;
+    city: string | null;
+    device: string | null;
+    browser: string | null;
+    os: string | null;
+    referer: string | null;
+    ip: string | null;
+    qr: number | null;
+};
+
+/** @internal */
+export const ClickEvents$inboundSchema: z.ZodType<ClickEvents, z.ZodTypeDef, unknown> = z
+    .object({
+        timestamp: z.string(),
+        click_id: z.string(),
+        link_id: z.string(),
+        domain: z.string(),
+        key: z.string(),
+        url: z.string(),
+        continent: z.nullable(z.string()),
+        country: z.nullable(z.string()),
+        city: z.nullable(z.string()),
+        device: z.nullable(z.string()),
+        browser: z.nullable(z.string()),
+        os: z.nullable(z.string()),
+        referer: z.nullable(z.string()),
+        ip: z.nullable(z.string()),
+        qr: z.nullable(z.number()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            click_id: "clickId",
+            link_id: "linkId",
+        });
+    });
+
+/** @internal */
+export type ClickEvents$Outbound = {
+    timestamp: string;
+    click_id: string;
+    link_id: string;
+    domain: string;
+    key: string;
+    url: string;
+    continent: string | null;
+    country: string | null;
+    city: string | null;
+    device: string | null;
+    browser: string | null;
+    os: string | null;
+    referer: string | null;
+    ip: string | null;
+    qr: number | null;
+};
+
+/** @internal */
+export const ClickEvents$outboundSchema: z.ZodType<
+    ClickEvents$Outbound,
+    z.ZodTypeDef,
+    ClickEvents
+> = z
+    .object({
+        timestamp: z.string(),
+        clickId: z.string(),
+        linkId: z.string(),
+        domain: z.string(),
+        key: z.string(),
+        url: z.string(),
+        continent: z.nullable(z.string()),
+        country: z.nullable(z.string()),
+        city: z.nullable(z.string()),
+        device: z.nullable(z.string()),
+        browser: z.nullable(z.string()),
+        os: z.nullable(z.string()),
+        referer: z.nullable(z.string()),
+        ip: z.nullable(z.string()),
+        qr: z.nullable(z.number()),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            clickId: "click_id",
+            linkId: "link_id",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ClickEvents$ {
+    /** @deprecated use `ClickEvents$inboundSchema` instead. */
+    export const inboundSchema = ClickEvents$inboundSchema;
+    /** @deprecated use `ClickEvents$outboundSchema` instead. */
+    export const outboundSchema = ClickEvents$outboundSchema;
+    /** @deprecated use `ClickEvents$Outbound` instead. */
+    export type Outbound = ClickEvents$Outbound;
+}

package/src/models/components/clicksbrowsers.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clickscities.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";

package/src/models/components/clickscount.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clickscountries.ts

@@ -1,12 +1,12 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";
 import * as z from "zod";
 
 /**
- * The 2-letter country code: https://d.to/geo
+ * The 2-letter ISO 3166-1 country code for the country associated with the location of the user. Learn more: https://d.to/geo
  */
 export const Country = {
     Af: "AF",
@@ -261,13 +261,13 @@ export const Country = {
     Xk: "XK",
 } as const;
 /**
- * The 2-letter country code: https://d.to/geo
+ * The 2-letter ISO 3166-1 country code for the country associated with the location of the user. Learn more: https://d.to/geo
  */
 export type Country = ClosedEnum<typeof Country>;
 
 export type ClicksCountries = {
     /**
-     * The 2-letter country code: https://d.to/geo
+     * The 2-letter ISO 3166-1 country code for the country associated with the location of the user. Learn more: https://d.to/geo
      */
     country: Country;
     /**

package/src/models/components/clicksdevices.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clicksos.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clicksreferers.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clickstimeseries.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clickstoplinks.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/clickstopurls.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/continentcode.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as z from "zod";
+
+/**
+ * The continent to retrieve analytics for.
+ */
+export const ContinentCode = {
+    Af: "AF",
+    An: "AN",
+    As: "AS",
+    Eu: "EU",
+    Na: "NA",
+    Oc: "OC",
+    Sa: "SA",
+} as const;
+/**
+ * The continent to retrieve analytics for.
+ */
+export type ContinentCode = ClosedEnum<typeof ContinentCode>;
+
+/** @internal */
+export const ContinentCode$inboundSchema: z.ZodNativeEnum<typeof ContinentCode> =
+    z.nativeEnum(ContinentCode);
+
+/** @internal */
+export const ContinentCode$outboundSchema: z.ZodNativeEnum<typeof ContinentCode> =
+    ContinentCode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ContinentCode$ {
+    /** @deprecated use `ContinentCode$inboundSchema` instead. */
+    export const inboundSchema = ContinentCode$inboundSchema;
+    /** @deprecated use `ContinentCode$outboundSchema` instead. */
+    export const outboundSchema = ContinentCode$outboundSchema;
+}

package/src/models/components/countrycode.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";

package/src/models/components/domainschema.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";
@@ -47,9 +47,9 @@ export type DomainSchema = {
 export const DomainSchema$inboundSchema: z.ZodType<DomainSchema, z.ZodTypeDef, unknown> = z.object({
     id: z.string(),
     slug: z.string(),
-    verified: z.boolean().default(false),
-    primary: z.boolean().default(false),
-    archived: z.boolean().default(false),
+    verified: z.boolean(),
+    primary: z.boolean(),
+    archived: z.boolean(),
     placeholder: z.string().default("https://dub.co/help/article/what-is-dub"),
     expiredUrl: z.nullable(z.string()),
     createdAt: z.string(),

package/src/models/components/index.ts

@@ -1,7 +1,8 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./clickevents.js";
 export * from "./clicksbrowsers.js";
 export * from "./clickscities.js";
 export * from "./clickscount.js";
@@ -12,6 +13,7 @@ export * from "./clicksreferers.js";
 export * from "./clickstimeseries.js";
 export * from "./clickstoplinks.js";
 export * from "./clickstopurls.js";
+export * from "./continentcode.js";
 export * from "./countrycode.js";
 export * from "./domainschema.js";
 export * from "./leadsbrowsers.js";

package/src/models/components/leadsbrowsers.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/components/leadscities.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";

package/src/models/components/leadscount.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";