frameio 2.0.3 → 3.0.0

package/dist/esm/core/logging/logger.mjs

@@ -0,0 +1,138 @@
+export const LogLevel = {
+    Debug: "debug",
+    Info: "info",
+    Warn: "warn",
+    Error: "error",
+};
+const logLevelMap = {
+    [LogLevel.Debug]: 1,
+    [LogLevel.Info]: 2,
+    [LogLevel.Warn]: 3,
+    [LogLevel.Error]: 4,
+};
+/**
+ * Default console-based logger implementation.
+ */
+export class ConsoleLogger {
+    debug(message, ...args) {
+        console.debug(message, ...args);
+    }
+    info(message, ...args) {
+        console.info(message, ...args);
+    }
+    warn(message, ...args) {
+        console.warn(message, ...args);
+    }
+    error(message, ...args) {
+        console.error(message, ...args);
+    }
+}
+/**
+ * Logger class that provides level-based logging functionality.
+ */
+export class Logger {
+    /**
+     * Creates a new logger instance.
+     * @param config - Logger configuration
+     */
+    constructor(config) {
+        this.level = logLevelMap[config.level];
+        this.logger = config.logger;
+        this.silent = config.silent;
+    }
+    /**
+     * Checks if a log level should be output based on configuration.
+     * @param level - The log level to check
+     * @returns True if the level should be logged
+     */
+    shouldLog(level) {
+        return !this.silent && this.level <= logLevelMap[level];
+    }
+    /**
+     * Checks if debug logging is enabled.
+     * @returns True if debug logs should be output
+     */
+    isDebug() {
+        return this.shouldLog(LogLevel.Debug);
+    }
+    /**
+     * Logs a debug message if debug logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    debug(message, ...args) {
+        if (this.isDebug()) {
+            this.logger.debug(message, ...args);
+        }
+    }
+    /**
+     * Checks if info logging is enabled.
+     * @returns True if info logs should be output
+     */
+    isInfo() {
+        return this.shouldLog(LogLevel.Info);
+    }
+    /**
+     * Logs an info message if info logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    info(message, ...args) {
+        if (this.isInfo()) {
+            this.logger.info(message, ...args);
+        }
+    }
+    /**
+     * Checks if warning logging is enabled.
+     * @returns True if warning logs should be output
+     */
+    isWarn() {
+        return this.shouldLog(LogLevel.Warn);
+    }
+    /**
+     * Logs a warning message if warning logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    warn(message, ...args) {
+        if (this.isWarn()) {
+            this.logger.warn(message, ...args);
+        }
+    }
+    /**
+     * Checks if error logging is enabled.
+     * @returns True if error logs should be output
+     */
+    isError() {
+        return this.shouldLog(LogLevel.Error);
+    }
+    /**
+     * Logs an error message if error logging is enabled.
+     * @param message - The message to log
+     * @param args - Additional arguments to log
+     */
+    error(message, ...args) {
+        if (this.isError()) {
+            this.logger.error(message, ...args);
+        }
+    }
+}
+export function createLogger(config) {
+    var _a, _b, _c;
+    if (config == null) {
+        return defaultLogger;
+    }
+    if (config instanceof Logger) {
+        return config;
+    }
+    config = config !== null && config !== void 0 ? config : {};
+    (_a = config.level) !== null && _a !== void 0 ? _a : (config.level = LogLevel.Info);
+    (_b = config.logger) !== null && _b !== void 0 ? _b : (config.logger = new ConsoleLogger());
+    (_c = config.silent) !== null && _c !== void 0 ? _c : (config.silent = true);
+    return new Logger(config);
+}
+const defaultLogger = new Logger({
+    level: LogLevel.Info,
+    logger: new ConsoleLogger(),
+    silent: true,
+});

package/dist/esm/core/pagination/Page.d.mts

@@ -0,0 +1,33 @@
+import type { HttpResponsePromise, RawResponse } from "../fetcher/index.mjs";
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export declare class Page<T, R = unknown> implements AsyncIterable<T> {
+    data: T[];
+    rawResponse: RawResponse;
+    response: R;
+    private _hasNextPage;
+    private getItems;
+    private loadNextPage;
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
+        response: R;
+        rawResponse: RawResponse;
+        hasNextPage: (response: R) => boolean;
+        getItems: (response: R) => T[];
+        loadPage: (response: R) => HttpResponsePromise<R>;
+    });
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage(): Promise<this>;
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage(): boolean;
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+}

package/dist/esm/core/pagination/Page.mjs

@@ -0,0 +1,97 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+/**
+ * A page of results from a paginated API.
+ *
+ * @template T The type of the items in the page.
+ * @template R The type of the API response.
+ */
+export class Page {
+    constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }) {
+        this.response = response;
+        this.rawResponse = rawResponse;
+        this.data = getItems(response);
+        this._hasNextPage = hasNextPage;
+        this.getItems = getItems;
+        this.loadNextPage = loadPage;
+    }
+    /**
+     * Retrieves the next page
+     * @returns this
+     */
+    getNextPage() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data, rawResponse } = yield this.loadNextPage(this.response).withRawResponse();
+            this.response = data;
+            this.rawResponse = rawResponse;
+            this.data = this.getItems(this.response);
+            return this;
+        });
+    }
+    /**
+     * @returns whether there is a next page to load
+     */
+    hasNextPage() {
+        return this._hasNextPage(this.response);
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            for (const item of this.data) {
+                yield yield __await(item);
+            }
+            while (this.hasNextPage()) {
+                yield __await(this.getNextPage());
+                for (const item of this.data) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var _b, e_1, _c, _d;
+            try {
+                for (var _e = true, _f = __asyncValues(this.iterMessages()), _g; _g = yield __await(_f.next()), _b = _g.done, !_b; _e = true) {
+                    _d = _g.value;
+                    _e = false;
+                    const message = _d;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+}

package/dist/esm/core/pagination/exports.d.mts

@@ -0,0 +1 @@
+export type { Page } from "./Page.mjs";

package/dist/esm/core/pagination/exports.mjs

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

package/dist/esm/core/pagination/index.d.mts

@@ -0,0 +1 @@
+export { Page } from "./Page.mjs";

package/dist/esm/core/pagination/index.mjs

@@ -0,0 +1 @@
+export { Page } from "./Page.mjs";

package/dist/esm/core/runtime/runtime.mjs

@@ -68,23 +68,9 @@ function evaluateRuntime() {
             version: Bun.version,
         };
     }
-    /**
-     * A constant that indicates whether the environment the code is running is Node.JS.
-     */
-    const isNode = typeof process !== "undefined" &&
-        "version" in process &&
-        !!process.version &&
-        "versions" in process &&
-        !!((_e = process.versions) === null || _e === void 0 ? void 0 : _e.node);
-    if (isNode) {
-        return {
-            type: "node",
-            version: process.versions.node,
-            parsedVersion: Number(process.versions.node.split(".")[0]),
-        };
-    }
     /**
      * A constant that indicates whether the environment the code is running is in React-Native.
+     * This check should come before Node.js detection since React Native may have a process polyfill.
      * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
      */
     const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
@@ -93,6 +79,22 @@ function evaluateRuntime() {
             type: "react-native",
         };
     }
+    /**
+     * A constant that indicates whether the environment the code is running is Node.JS.
+     *
+     * We assign `process` to a local variable first to avoid being flagged by
+     * bundlers that perform static analysis on `process.versions` (e.g. Next.js
+     * Edge Runtime warns about Node.js APIs even when they are guarded).
+     */
+    const _process = typeof process !== "undefined" ? process : undefined;
+    const isNode = typeof _process !== "undefined" && typeof ((_e = _process.versions) === null || _e === void 0 ? void 0 : _e.node) === "string";
+    if (isNode) {
+        return {
+            type: "node",
+            version: _process.versions.node,
+            parsedVersion: Number(_process.versions.node.split(".")[0]),
+        };
+    }
     return {
         type: "unknown",
     };

package/dist/esm/core/url/encodePathParam.d.mts

@@ -0,0 +1 @@
+export declare function encodePathParam(param: unknown): string;

package/dist/esm/core/url/encodePathParam.mjs

@@ -0,0 +1,18 @@
+export function encodePathParam(param) {
+    if (param === null) {
+        return "null";
+    }
+    const typeofParam = typeof param;
+    switch (typeofParam) {
+        case "undefined":
+            return "undefined";
+        case "string":
+        case "number":
+        case "boolean":
+            break;
+        default:
+            param = String(param);
+            break;
+    }
+    return encodeURIComponent(param);
+}

package/dist/esm/core/url/index.d.mts

@@ -1,2 +1,3 @@
+export { encodePathParam } from "./encodePathParam.mjs";
 export { join } from "./join.mjs";
 export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/index.mjs

@@ -1,2 +1,3 @@
+export { encodePathParam } from "./encodePathParam.mjs";
 export { join } from "./join.mjs";
 export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/join.mjs

@@ -11,11 +11,10 @@ export function join(base, ...segments) {
             url = new URL(base);
         }
         catch (_a) {
-            // Fallback to path joining if URL is malformed
             return joinPath(base, ...segments);
         }
         const lastSegment = segments[segments.length - 1];
-        const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+        const shouldPreserveTrailingSlash = lastSegment === null || lastSegment === void 0 ? void 0 : lastSegment.endsWith("/");
         for (const segment of segments) {
             const cleanSegment = trimSlashes(segment);
             if (cleanSegment) {
@@ -35,7 +34,7 @@ function joinPath(base, ...segments) {
     }
     let result = base;
     const lastSegment = segments[segments.length - 1];
-    const shouldPreserveTrailingSlash = lastSegment && lastSegment.endsWith("/");
+    const shouldPreserveTrailingSlash = lastSegment === null || lastSegment === void 0 ? void 0 : lastSegment.endsWith("/");
     for (const segment of segments) {
         const cleanSegment = trimSlashes(segment);
         if (cleanSegment) {
@@ -51,7 +50,7 @@ function joinPathSegments(left, right) {
     if (left.endsWith("/")) {
         return left + right;
     }
-    return left + "/" + right;
+    return `${left}/${right}`;
 }
 function trimSlashes(str) {
     if (!str)

package/dist/esm/errors/FrameioError.d.mts

@@ -1,4 +1,4 @@
-import * as core from "../core/index.mjs";
+import type * as core from "../core/index.mjs";
 export declare class FrameioError extends Error {
     readonly statusCode?: number;
     readonly body?: unknown;

package/dist/esm/errors/FrameioError.mjs

@@ -3,14 +3,18 @@ import { toJson } from "../core/json.mjs";
 export class FrameioError extends Error {
     constructor({ message, statusCode, body, rawResponse, }) {
         super(buildMessage({ message, statusCode, body }));
-        Object.setPrototypeOf(this, FrameioError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
         this.statusCode = statusCode;
         this.body = body;
         this.rawResponse = rawResponse;
     }
 }
 function buildMessage({ message, statusCode, body, }) {
-    let lines = [];
+    const lines = [];
     if (message != null) {
         lines.push(message);
     }

package/dist/esm/errors/FrameioTimeoutError.mjs

@@ -2,6 +2,10 @@
 export class FrameioTimeoutError extends Error {
     constructor(message) {
         super(message);
-        Object.setPrototypeOf(this, FrameioTimeoutError.prototype);
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
     }
 }

package/dist/esm/errors/handleNonStatusCodeError.d.mts

@@ -0,0 +1,2 @@
+import type * as core from "../core/index.mjs";
+export declare function handleNonStatusCodeError(error: core.Fetcher.Error, rawResponse: core.RawResponse, method: string, path: string): never;

package/dist/esm/errors/handleNonStatusCodeError.mjs

@@ -0,0 +1,29 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "./index.mjs";
+export function handleNonStatusCodeError(error, rawResponse, method, path) {
+    switch (error.reason) {
+        case "non-json":
+            throw new errors.FrameioError({
+                statusCode: error.statusCode,
+                body: error.rawBody,
+                rawResponse: rawResponse,
+            });
+        case "body-is-null":
+            throw new errors.FrameioError({
+                statusCode: error.statusCode,
+                rawResponse: rawResponse,
+            });
+        case "timeout":
+            throw new errors.FrameioTimeoutError(`Timeout exceeded when calling ${method} ${path}.`);
+        case "unknown":
+            throw new errors.FrameioError({
+                message: error.errorMessage,
+                rawResponse: rawResponse,
+            });
+        default:
+            throw new errors.FrameioError({
+                message: "Unknown error",
+                rawResponse: rawResponse,
+            });
+    }
+}

package/dist/esm/exports.d.mts

@@ -0,0 +1 @@
+export * from "./core/exports.mjs";

package/dist/esm/exports.mjs

@@ -0,0 +1 @@
+export * from "./core/exports.mjs";

package/dist/esm/index.d.mts

@@ -1,4 +1,6 @@
 export * as Frameio from "./api/index.mjs";
-export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
+export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
 export { FrameioClient } from "./Client.mjs";
 export { FrameioEnvironment } from "./environments.mjs";
+export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
+export * from "./exports.mjs";

package/dist/esm/index.mjs

@@ -1,4 +1,5 @@
 export * as Frameio from "./api/index.mjs";
-export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
 export { FrameioClient } from "./Client.mjs";
 export { FrameioEnvironment } from "./environments.mjs";
+export { FrameioError, FrameioTimeoutError } from "./errors/index.mjs";
+export * from "./exports.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.3";
+export declare const SDK_VERSION = "3.0.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.3";
+export const SDK_VERSION = "3.0.0";