@archlast/sdk-core

Platform-agnostic core for Archlast SDKs. This package provides the base client class, HTTP transport layer, and shared types used by all platform-specific SDKs.

Installation

npm install @archlast/sdk-core

Usage

This package is typically used as a dependency of platform-specific SDKs (@archlast/client, @archlast/sdk-next, @archlast/sdk-expo), not directly by end users.

Direct Usage (Advanced)

If you need to build a custom platform integration:

import { BaseClient } from "@archlast/sdk-core";

class MyPlatformClient extends BaseClient {
    constructor(options: ClientOptions) {
        super(options);
        // Add platform-specific functionality
    }
}

const client = new MyPlatformClient({
    baseUrl: "http://localhost:4000",
    appId: "my-app",
});

// Use inherited methods
const state = await client.getAuthState();
const result = await client.query("myQuery", { arg1: "value" });

Features

• BaseClient: Core client with HTTP transport and auth methods
• HttpClient: Platform-agnostic HTTP client with error handling
• Type definitions: Shared types across all platforms
• No React dependencies: Can be used in any JavaScript/TypeScript environment

API

BaseClient

The main client class that all platform clients extend.

Methods

• getAuthState() - Get current authentication state
• signUp(input) - Sign up new user
• signIn(input) - Sign in with email/username and password
• signOut() - Sign out and revoke session
• requestPasswordReset(email) - Request password reset
• resetPassword(token, password) - Reset password
• query(name, args) - Call a query function
• mutate(name, args) - Call a mutation function
• action(name, args) - Call an action function

HttpClient

Low-level HTTP client used by BaseClient.

Methods

• get(path, params) - GET request
• post(path, body) - POST request
• put(path, body) - PUT request
• delete(path) - DELETE request
• uploadFile(path, file) - Upload file

Types

All types are exported from the package:

• AuthUser - User information
• AuthSession - Session information
• AuthState - Authentication state
• SignUpInput - Sign up parameters
• SignInInput - Sign in parameters
• ClientOptions - Client configuration options
• PaginatedResponse<T> - Paginated query response
• SdkError, AuthError, NetworkError, ValidationError - Error types

License

MIT