@lusor/sdk 0.0.0-stage → 1.0.0

package/dist/api/types/index.js

@@ -0,0 +1,133 @@
+export * from "./Agent.js";
+export * from "./AgentDetail.js";
+export * from "./AgentDetailResponse.js";
+export * from "./AgentDevice.js";
+export * from "./AgentDeviceInput.js";
+export * from "./AgentListResponse.js";
+export * from "./AgentTurn.js";
+export * from "./AgentTurnDispatchResponse.js";
+export * from "./AgentTurnPage.js";
+export * from "./AgentTurnPageResponse.js";
+export * from "./AnswerHitlResult.js";
+export * from "./AppInstall.js";
+export * from "./AppInstallBatch.js";
+export * from "./AppInstallBatchStarted.js";
+export * from "./AppInstallEvent.js";
+export * from "./AppStoreInstallResponse.js";
+export * from "./ArchiveAgentResponse.js";
+export * from "./BackChainStep.js";
+export * from "./BadRequestErrorBody.js";
+export * from "./Busy.js";
+export * from "./CancelQueuedFollowupResult.js";
+export * from "./CaptureField.js";
+export * from "./CaptureOnlyFilter.js";
+export * from "./CaptureOptions.js";
+export * from "./CaptureResponse.js";
+export * from "./CaptureVerbosity.js";
+export * from "./CatalogApp.js";
+export * from "./ChainCapturePolicy.js";
+export * from "./ChainResponse.js";
+export * from "./ChainStep.js";
+export * from "./ChainStepResponse.js";
+export * from "./ChainVerb.js";
+export * from "./ClearChainStep.js";
+export * from "./ContinueSessionResult.js";
+export * from "./CreateSessionResult.js";
+export * from "./Dataset.js";
+export * from "./DatasetColumn.js";
+export * from "./DatasetColumnType.js";
+export * from "./DatasetListResponse.js";
+export * from "./DatasetOutput.js";
+export * from "./DatasetResponse.js";
+export * from "./DeleteDatasetResponse.js";
+export * from "./Device.js";
+export * from "./DeviceAdvertisingIdReset.js";
+export * from "./DeviceChangeConfirmInput.js";
+export * from "./DeviceChangePreview.js";
+export * from "./DeviceChangeResult.js";
+export * from "./DeviceControlError.js";
+export * from "./DeviceControlInProgress.js";
+export * from "./DeviceControlState.js";
+export * from "./DeviceGeo.js";
+export * from "./DeviceIdentity.js";
+export * from "./DeviceIdentityFields.js";
+export * from "./DeviceInternetLocation.js";
+export * from "./DeviceLanguage.js";
+export * from "./DeviceOccupancy.js";
+export * from "./DeviceRemoveResult.js";
+export * from "./DeviceReset.js";
+export * from "./DeviceState.js";
+export * from "./DeviceStaticIp.js";
+export * from "./DeviceStaticIpStatus.js";
+export * from "./EmailAddress.js";
+export * from "./EmailAddressListResponse.js";
+export * from "./EmailMessage.js";
+export * from "./EmailMessageListResponse.js";
+export * from "./EmptyChainStepParams.js";
+export * from "./EmptyVerbInput.js";
+export * from "./ErrorResponse.js";
+export * from "./HistoryPolicy.js";
+export * from "./HomeChainStep.js";
+export * from "./IceServer.js";
+export * from "./IceServerIssuance.js";
+export * from "./InboxAddressAddResult.js";
+export * from "./InboxAddressPreview.js";
+export * from "./InboxAddressRemoveResult.js";
+export * from "./KeyChainStep.js";
+export * from "./KeyChainStepParams.js";
+export * from "./LegacySession.js";
+export * from "./ModelKey.js";
+export * from "./NotificationApp.js";
+export * from "./NotificationFeedItem.js";
+export * from "./NotificationRule.js";
+export * from "./NotificationSettings.js";
+export * from "./PhoneNumber.js";
+export * from "./PhoneNumberListResponse.js";
+export * from "./PhoneNumberMessage.js";
+export * from "./PhoneNumberMessageListResponse.js";
+export * from "./PhoneNumberResponse.js";
+export * from "./RecentChainStep.js";
+export * from "./RecordingFinalizationStatus.js";
+export * from "./RetargetQueuedTurnsResult.js";
+export * from "./ScreenshotChainStep.js";
+export * from "./SecretTag.js";
+export * from "./SessionArtifacts.js";
+export * from "./SessionDetail.js";
+export * from "./SessionEvent.js";
+export * from "./SessionRecording.js";
+export * from "./SessionRecordingResponse.js";
+export * from "./SessionRecordingSegment.js";
+export * from "./SessionReplayFrame.js";
+export * from "./SessionReplayResponse.js";
+export * from "./SessionStatusV2.js";
+export * from "./SessionStatusView.js";
+export * from "./SessionV2.js";
+export * from "./ShellResult.js";
+export * from "./Skill.js";
+export * from "./StartAppChainStep.js";
+export * from "./StartAppChainStepParams.js";
+export * from "./StopAppChainStep.js";
+export * from "./StopAppChainStepParams.js";
+export * from "./StopSessionResult.js";
+export * from "./StreamCommandResult.js";
+export * from "./StreamSignalEvent.js";
+export * from "./StreamStartInput.js";
+export * from "./StreamViewerInput.js";
+export * from "./SwipeChainStep.js";
+export * from "./SwipeChainStepParams.js";
+export * from "./TapChainStep.js";
+export * from "./TapChainStepParams.js";
+export * from "./TapResult.js";
+export * from "./TypeChainStep.js";
+export * from "./TypeChainStepParams.js";
+export * from "./ValidationErrorResponse.js";
+export * from "./VerbResult.js";
+export * from "./VerbResultWithOptionalCapture.js";
+export * from "./WaitChainStep.js";
+export * from "./WaitChainStepParams.js";
+export * from "./Workspace.js";
+export * from "./WorkspaceFile.js";
+export * from "./WorkspaceFileDownload.js";
+export * from "./WorkspaceScopeInput.js";
+export * from "./WorkspaceSecret.js";
+export * from "./WorkspaceSecretListResponse.js";

package/dist/auth/HeaderAuthProvider.d.ts

@@ -0,0 +1,20 @@
+import * as core from "../core/index.js";
+declare const PARAM_KEY: "apiKey";
+export declare class HeaderAuthProvider implements core.AuthProvider {
+    private readonly options;
+    constructor(options: HeaderAuthProvider.Options);
+    static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
+    getAuthRequest({ endpointMetadata, }?: {
+        endpointMetadata?: core.EndpointMetadata;
+    }): Promise<core.AuthRequest>;
+}
+export declare namespace HeaderAuthProvider {
+    const AUTH_SCHEME: "ApiKey";
+    const AUTH_CONFIG_ERROR_MESSAGE: string;
+    type Options = AuthOptions;
+    type AuthOptions = {
+        [PARAM_KEY]?: core.Supplier<string>;
+    };
+    function createInstance(options: Options): core.AuthProvider;
+}
+export {};

package/dist/auth/HeaderAuthProvider.js

@@ -0,0 +1,33 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as core from "../core/index.js";
+import * as errors from "../errors/index.js";
+const PARAM_KEY = "apiKey";
+const HEADER_NAME = "X-Api-Key";
+export class HeaderAuthProvider {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    static canCreate(options) {
+        return options?.[PARAM_KEY] != null;
+    }
+    async getAuthRequest({ endpointMetadata, } = {}) {
+        const headerValue = await core.Supplier.get(this.options[PARAM_KEY]);
+        if (headerValue == null) {
+            throw new errors.LusorError({
+                message: HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
+            });
+        }
+        return {
+            headers: { [HEADER_NAME]: headerValue },
+        };
+    }
+}
+(function (HeaderAuthProvider) {
+    HeaderAuthProvider.AUTH_SCHEME = "ApiKey";
+    HeaderAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${PARAM_KEY}' when initializing the client`;
+    function createInstance(options) {
+        return new HeaderAuthProvider(options);
+    }
+    HeaderAuthProvider.createInstance = createInstance;
+})(HeaderAuthProvider || (HeaderAuthProvider = {}));

package/dist/auth/index.d.ts

@@ -0,0 +1 @@
+export { HeaderAuthProvider } from "./HeaderAuthProvider.js";

package/dist/auth/index.js

@@ -0,0 +1 @@
+export { HeaderAuthProvider } from "./HeaderAuthProvider.js";

package/dist/core/auth/AuthProvider.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
+import type { AuthRequest } from "./AuthRequest.js";
+export interface AuthProvider {
+    getAuthRequest(arg?: {
+        endpointMetadata?: EndpointMetadata;
+    }): Promise<AuthRequest>;
+}
+export declare function isAuthProvider(value: unknown): value is AuthProvider;

package/dist/core/auth/AuthProvider.js

@@ -0,0 +1,6 @@
+export function isAuthProvider(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "getAuthRequest" in value &&
+        typeof value.getAuthRequest === "function");
+}

package/dist/core/auth/AuthRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/dist/core/auth/AuthRequest.js

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

package/dist/core/auth/BasicAuth.d.ts

@@ -0,0 +1,8 @@
+export interface BasicAuth {
+    username?: string;
+    password?: string;
+}
+export declare const BasicAuth: {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BasicAuth;
+};

package/dist/core/auth/BasicAuth.js

@@ -0,0 +1,29 @@
+import { base64Decode, base64Encode } from "../base64.js";
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const username = basicAuth.username ?? "";
+        const password = basicAuth.password ?? "";
+        if (username === "" && password === "") {
+            return undefined;
+        }
+        const token = base64Encode(`${username}:${password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, ...passwordParts] = decoded.split(":");
+        const password = passwordParts.length > 0 ? passwordParts.join(":") : undefined;
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/dist/core/auth/BearerToken.d.ts

@@ -0,0 +1,7 @@
+export type BearerToken = string;
+declare function toAuthorizationHeader(token: string | undefined): string | undefined;
+export declare const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+};
+export {};

package/dist/core/auth/BearerToken.js

@@ -0,0 +1,13 @@
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+function toAuthorizationHeader(token) {
+    if (token == null) {
+        return undefined;
+    }
+    return `Bearer ${token}`;
+}
+export const BearerToken = {
+    toAuthorizationHeader: toAuthorizationHeader,
+    fromAuthorizationHeader: (header) => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim();
+    },
+};

package/dist/core/auth/NoOpAuthProvider.d.ts

@@ -0,0 +1,5 @@
+import type { AuthProvider } from "./AuthProvider.js";
+import type { AuthRequest } from "./AuthRequest.js";
+export declare class NoOpAuthProvider implements AuthProvider {
+    getAuthRequest(): Promise<AuthRequest>;
+}

package/dist/core/auth/NoOpAuthProvider.js

@@ -0,0 +1,5 @@
+export class NoOpAuthProvider {
+    getAuthRequest() {
+        return Promise.resolve({ headers: {} });
+    }
+}

package/dist/core/auth/index.d.ts

@@ -0,0 +1,5 @@
+export { type AuthProvider, isAuthProvider } from "./AuthProvider.js";
+export type { AuthRequest } from "./AuthRequest.js";
+export { BasicAuth } from "./BasicAuth.js";
+export { BearerToken } from "./BearerToken.js";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.js";

package/dist/core/auth/index.js

@@ -0,0 +1,4 @@
+export { isAuthProvider } from "./AuthProvider.js";
+export { BasicAuth } from "./BasicAuth.js";
+export { BearerToken } from "./BearerToken.js";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.js";

package/dist/core/base64.d.ts

@@ -0,0 +1,2 @@
+export declare function base64Encode(input: string): string;
+export declare function base64Decode(input: string): string;

package/dist/core/base64.js

@@ -0,0 +1,22 @@
+function base64ToBytes(base64) {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0));
+}
+function bytesToBase64(bytes) {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+export function base64Encode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+export function base64Decode(input) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/dist/core/exports.d.ts

@@ -0,0 +1 @@
+export * from "./logging/exports.js";

package/dist/core/exports.js

@@ -0,0 +1 @@
+export * from "./logging/exports.js";

package/dist/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,20 @@
+import type { RawResponse } from "./RawResponse.js";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/core/fetcher/APIResponse.js

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

package/dist/core/fetcher/BinaryResponse.d.ts

@@ -0,0 +1,19 @@
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: Response["bodyUsed"];
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => Response["body"];
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => ReturnType<Response["arrayBuffer"]>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => ReturnType<Response["blob"]>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: Response): BinaryResponse;

package/dist/core/fetcher/BinaryResponse.js

@@ -0,0 +1,14 @@
+export function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}

package/dist/core/fetcher/EndpointMetadata.d.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/dist/core/fetcher/EndpointMetadata.js

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

package/dist/core/fetcher/EndpointSupplier.d.ts

@@ -0,0 +1,12 @@
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+import type { Supplier } from "./Supplier.js";
+type EndpointSupplierFn<T> = (arg: {
+    endpointMetadata?: EndpointMetadata;
+}) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export declare const EndpointSupplier: {
+    get: <T>(supplier: EndpointSupplier<T>, arg: {
+        endpointMetadata?: EndpointMetadata;
+    }) => Promise<T>;
+};
+export {};

package/dist/core/fetcher/EndpointSupplier.js

@@ -0,0 +1,10 @@
+export const EndpointSupplier = {
+    get: async (supplier, arg) => {
+        if (typeof supplier === "function") {
+            return supplier(arg);
+        }
+        else {
+            return supplier;
+        }
+    },
+};

package/dist/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,56 @@
+import { type LogConfig, type Logger } from "../logging/logger.js";
+import type { APIResponse } from "./APIResponse.js";
+import type { EndpointMetadata } from "./EndpointMetadata.js";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, unknown>;
+        /**
+         * @deprecated Prefer `queryString` (produced by `core.url.queryBuilder()`).
+         * Retained for backwards compatibility with custom fetchers and callers that
+         * still construct request args with a query-parameter object.
+         */
+        queryParameters?: Record<string, unknown>;
+        queryString?: string;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes" | "form" | "other";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+        endpointMetadata?: EndpointMetadata;
+        fetchFn?: typeof fetch;
+        logging?: LogConfig | Logger;
+    }
+    type Error = FailedStatusCodeError | NonJsonError | BodyIsNullError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface BodyIsNullError {
+        reason: "body-is-null";
+        statusCode: number;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+        cause?: unknown;
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+        cause?: unknown;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;