krawlet-js 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,362 @@
+declare enum ErrorCode {
+    BAD_REQUEST = "BAD_REQUEST",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    FORBIDDEN = "FORBIDDEN",
+    NOT_FOUND = "NOT_FOUND",
+    VALIDATION_ERROR = "VALIDATION_ERROR",
+    RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
+    PLAYER_NOT_FOUND = "PLAYER_NOT_FOUND",
+    SHOP_NOT_FOUND = "SHOP_NOT_FOUND",
+    TURTLE_NOT_FOUND = "TURTLE_NOT_FOUND",
+    INVALID_API_KEY = "INVALID_API_KEY",
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    DATABASE_ERROR = "DATABASE_ERROR",
+    HEALTH_CHECK_FAILED = "HEALTH_CHECK_FAILED"
+}
+type KnownAddressType = 'official' | 'shop' | 'gamble' | 'service' | 'company';
+type PlayerNotifications = 'none' | 'self' | 'all';
+type ItemChangeType = 'added' | 'removed';
+interface Price {
+    id: string;
+    value: number;
+    currency: string;
+    address: string | null;
+    requiredMeta: string | null;
+}
+interface Item {
+    id: string;
+    shopId: string;
+    itemName: string;
+    itemNbt: string | null;
+    itemDisplayName: string | null;
+    itemDescription: string | null;
+    shopBuysItem: boolean | null;
+    noLimit: boolean | null;
+    dynamicPrice: boolean;
+    madeOnDemand: boolean;
+    requiresInteraction: boolean;
+    stock: number;
+    prices: Price[];
+    addresses: string[];
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface Shop {
+    id: string;
+    name: string;
+    description: string | null;
+    owner: string | null;
+    computerId: number;
+    softwareName: string | null;
+    softwareVersion: string | null;
+    locationCoordinates: string | null;
+    locationDescription: string | null;
+    locationDimension: string | null;
+    items: Item[];
+    addresses: string[];
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface Player {
+    minecraftUUID: string;
+    minecraftName: string;
+    kromerAddress: string;
+    notifications: PlayerNotifications;
+    createdDate: string | null;
+    updatedDate: string | null;
+    online: boolean;
+}
+interface KnownAddress {
+    id: string;
+    type: KnownAddressType;
+    address: string;
+    imageSrc: string | null;
+    name: string;
+    description: string;
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface ShopChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    field: string;
+    previousValue: string | null;
+    newValue: string | null;
+    isNewShop: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ItemChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    changeType: ItemChangeType;
+    itemName: string;
+    itemDisplayName: string;
+    itemHash: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PriceChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    itemName: string;
+    itemDisplayName: string;
+    itemHash: string;
+    field: string;
+    previousValue: string | null;
+    newValue: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ShopSyncData {
+    info: {
+        name: string;
+        description?: string;
+        owner?: string;
+        computerID: number;
+        software?: {
+            name: string;
+            version: string;
+        };
+        location?: {
+            coordinates: [number, number, number];
+            description?: string;
+            dimension?: string;
+        };
+    };
+    items: Array<{
+        item: {
+            name: string;
+            nbt?: string;
+            displayName?: string;
+            description?: string;
+        };
+        shopBuysItem?: boolean;
+        noLimit?: boolean;
+        dynamicPrice?: boolean;
+        madeOnDemand?: boolean;
+        requiresInteraction?: boolean;
+        stock?: number;
+        prices: Array<{
+            value: number;
+            currency: string;
+            address?: string;
+            requiredMeta?: string;
+        }>;
+    }>;
+}
+interface RateLimit {
+    limit: number;
+    remaining: number;
+    reset: number;
+}
+interface ApiResponseMeta {
+    timestamp: string;
+    elapsed: number;
+    version: string;
+    requestId: string;
+    rateLimit?: RateLimit;
+}
+interface ApiResponse<T> {
+    success: true;
+    data: T;
+    meta: ApiResponseMeta;
+}
+interface ErrorResponse {
+    success: false;
+    error: {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    meta: ApiResponseMeta;
+}
+interface HealthResponse {
+    status: string;
+    timestamp: string;
+    uptime: number;
+    version: string;
+    name: string;
+}
+interface DetailedHealthResponse {
+    status: 'healthy' | 'degraded';
+    checks: {
+        database: boolean;
+        memory: boolean;
+    };
+    details: {
+        timestamp: string;
+        uptime: number;
+        version: string;
+        name: string;
+        memory: {
+            heapUsed: string;
+            heapTotal: string;
+            rss: string;
+        };
+        node: string;
+        platform: string;
+    };
+}
+interface StorageData {
+    data: unknown;
+    retrievedAt: string;
+}
+interface ReportRecords {
+    count: number;
+    records: unknown[];
+}
+interface ChangeLogResult {
+    count: number;
+    logs: unknown[];
+}
+interface ChangeLogOptions {
+    limit?: number;
+    offset?: number;
+    shopId?: string;
+    since?: string;
+    until?: string;
+}
+
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    enableRetry?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+}
+interface RequestOptions {
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    params?: Record<string, string | number | boolean | undefined>;
+    body?: unknown;
+    headers?: Record<string, string>;
+    apiKey?: string;
+}
+declare class HttpClient {
+    private config;
+    private lastRateLimit?;
+    constructor(config: HttpClientConfig);
+    getRateLimit(): RateLimit | undefined;
+    request<T>(path: string, options?: RequestOptions): Promise<ApiResponse<T>>;
+    private buildUrl;
+    private buildHeaders;
+    private extractRateLimit;
+    private handleErrorResponse;
+    private shouldRetry;
+    private calculateRetryDelay;
+    private sleep;
+}
+
+declare class HealthResource {
+    private client;
+    constructor(client: HttpClient);
+    check(): Promise<HealthResponse>;
+    detailed(): Promise<DetailedHealthResponse>;
+}
+
+declare class PlayersResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Player[]>;
+    getByAddresses(addresses: string[]): Promise<Player[]>;
+    getByNames(names: string[]): Promise<Player[]>;
+    getByUuids(uuids: string[]): Promise<Player[]>;
+}
+
+declare class ShopsResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Shop[]>;
+    get(id: string): Promise<Shop>;
+    getItems(id: string): Promise<Item[]>;
+    update(data: ShopSyncData, token: string): Promise<{
+        message: string;
+    }>;
+}
+
+declare class ItemsResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Item[]>;
+}
+
+declare class AddressesResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<KnownAddress[]>;
+}
+
+declare class StorageResource {
+    private client;
+    constructor(client: HttpClient);
+    get(): Promise<StorageData>;
+    set(data: unknown, token: string): Promise<{
+        message: string;
+        timestamp: string;
+    }>;
+}
+
+declare class ReportsResource {
+    private client;
+    constructor(client: HttpClient);
+    getStats(): Promise<unknown>;
+    getValidationFailures(options?: {
+        limit?: number;
+    }): Promise<ReportRecords>;
+    getSuccessfulPosts(options?: {
+        limit?: number;
+    }): Promise<ReportRecords>;
+    getShopChanges(options?: {
+        limit?: number;
+        shopId?: string;
+    }): Promise<ReportRecords>;
+    getItemChanges(options?: {
+        limit?: number;
+        shopId?: string;
+    }): Promise<ReportRecords>;
+    getShopChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    getItemChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    getPriceChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    get(id: string): Promise<unknown>;
+}
+
+interface KrawletClientConfig {
+    baseUrl?: string;
+    apiKey?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    enableRetry?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+}
+declare class KrawletClient {
+    private httpClient;
+    readonly health: HealthResource;
+    readonly players: PlayersResource;
+    readonly shops: ShopsResource;
+    readonly items: ItemsResource;
+    readonly addresses: AddressesResource;
+    readonly storage: StorageResource;
+    readonly reports: ReportsResource;
+    constructor(config?: KrawletClientConfig);
+    getRateLimit(): RateLimit | undefined;
+}
+
+declare class KrawletError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    readonly response?: ErrorResponse;
+    constructor(message: string, code: string, statusCode: number, requestId?: string, details?: unknown, response?: ErrorResponse);
+    isClientError(): boolean;
+    isServerError(): boolean;
+    isRateLimitError(): boolean;
+}
+
+export { AddressesResource, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };

package/dist/index.d.ts

@@ -0,0 +1,362 @@
+declare enum ErrorCode {
+    BAD_REQUEST = "BAD_REQUEST",
+    UNAUTHORIZED = "UNAUTHORIZED",
+    FORBIDDEN = "FORBIDDEN",
+    NOT_FOUND = "NOT_FOUND",
+    VALIDATION_ERROR = "VALIDATION_ERROR",
+    RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED",
+    PLAYER_NOT_FOUND = "PLAYER_NOT_FOUND",
+    SHOP_NOT_FOUND = "SHOP_NOT_FOUND",
+    TURTLE_NOT_FOUND = "TURTLE_NOT_FOUND",
+    INVALID_API_KEY = "INVALID_API_KEY",
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    DATABASE_ERROR = "DATABASE_ERROR",
+    HEALTH_CHECK_FAILED = "HEALTH_CHECK_FAILED"
+}
+type KnownAddressType = 'official' | 'shop' | 'gamble' | 'service' | 'company';
+type PlayerNotifications = 'none' | 'self' | 'all';
+type ItemChangeType = 'added' | 'removed';
+interface Price {
+    id: string;
+    value: number;
+    currency: string;
+    address: string | null;
+    requiredMeta: string | null;
+}
+interface Item {
+    id: string;
+    shopId: string;
+    itemName: string;
+    itemNbt: string | null;
+    itemDisplayName: string | null;
+    itemDescription: string | null;
+    shopBuysItem: boolean | null;
+    noLimit: boolean | null;
+    dynamicPrice: boolean;
+    madeOnDemand: boolean;
+    requiresInteraction: boolean;
+    stock: number;
+    prices: Price[];
+    addresses: string[];
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface Shop {
+    id: string;
+    name: string;
+    description: string | null;
+    owner: string | null;
+    computerId: number;
+    softwareName: string | null;
+    softwareVersion: string | null;
+    locationCoordinates: string | null;
+    locationDescription: string | null;
+    locationDimension: string | null;
+    items: Item[];
+    addresses: string[];
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface Player {
+    minecraftUUID: string;
+    minecraftName: string;
+    kromerAddress: string;
+    notifications: PlayerNotifications;
+    createdDate: string | null;
+    updatedDate: string | null;
+    online: boolean;
+}
+interface KnownAddress {
+    id: string;
+    type: KnownAddressType;
+    address: string;
+    imageSrc: string | null;
+    name: string;
+    description: string;
+    createdDate: string | null;
+    updatedDate: string | null;
+}
+interface ShopChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    field: string;
+    previousValue: string | null;
+    newValue: string | null;
+    isNewShop: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ItemChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    changeType: ItemChangeType;
+    itemName: string;
+    itemDisplayName: string;
+    itemHash: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PriceChangeLog {
+    id: number;
+    shopId: string;
+    shopName: string;
+    itemName: string;
+    itemDisplayName: string;
+    itemHash: string;
+    field: string;
+    previousValue: string | null;
+    newValue: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ShopSyncData {
+    info: {
+        name: string;
+        description?: string;
+        owner?: string;
+        computerID: number;
+        software?: {
+            name: string;
+            version: string;
+        };
+        location?: {
+            coordinates: [number, number, number];
+            description?: string;
+            dimension?: string;
+        };
+    };
+    items: Array<{
+        item: {
+            name: string;
+            nbt?: string;
+            displayName?: string;
+            description?: string;
+        };
+        shopBuysItem?: boolean;
+        noLimit?: boolean;
+        dynamicPrice?: boolean;
+        madeOnDemand?: boolean;
+        requiresInteraction?: boolean;
+        stock?: number;
+        prices: Array<{
+            value: number;
+            currency: string;
+            address?: string;
+            requiredMeta?: string;
+        }>;
+    }>;
+}
+interface RateLimit {
+    limit: number;
+    remaining: number;
+    reset: number;
+}
+interface ApiResponseMeta {
+    timestamp: string;
+    elapsed: number;
+    version: string;
+    requestId: string;
+    rateLimit?: RateLimit;
+}
+interface ApiResponse<T> {
+    success: true;
+    data: T;
+    meta: ApiResponseMeta;
+}
+interface ErrorResponse {
+    success: false;
+    error: {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    meta: ApiResponseMeta;
+}
+interface HealthResponse {
+    status: string;
+    timestamp: string;
+    uptime: number;
+    version: string;
+    name: string;
+}
+interface DetailedHealthResponse {
+    status: 'healthy' | 'degraded';
+    checks: {
+        database: boolean;
+        memory: boolean;
+    };
+    details: {
+        timestamp: string;
+        uptime: number;
+        version: string;
+        name: string;
+        memory: {
+            heapUsed: string;
+            heapTotal: string;
+            rss: string;
+        };
+        node: string;
+        platform: string;
+    };
+}
+interface StorageData {
+    data: unknown;
+    retrievedAt: string;
+}
+interface ReportRecords {
+    count: number;
+    records: unknown[];
+}
+interface ChangeLogResult {
+    count: number;
+    logs: unknown[];
+}
+interface ChangeLogOptions {
+    limit?: number;
+    offset?: number;
+    shopId?: string;
+    since?: string;
+    until?: string;
+}
+
+interface HttpClientConfig {
+    baseUrl: string;
+    apiKey?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    enableRetry?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+}
+interface RequestOptions {
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    params?: Record<string, string | number | boolean | undefined>;
+    body?: unknown;
+    headers?: Record<string, string>;
+    apiKey?: string;
+}
+declare class HttpClient {
+    private config;
+    private lastRateLimit?;
+    constructor(config: HttpClientConfig);
+    getRateLimit(): RateLimit | undefined;
+    request<T>(path: string, options?: RequestOptions): Promise<ApiResponse<T>>;
+    private buildUrl;
+    private buildHeaders;
+    private extractRateLimit;
+    private handleErrorResponse;
+    private shouldRetry;
+    private calculateRetryDelay;
+    private sleep;
+}
+
+declare class HealthResource {
+    private client;
+    constructor(client: HttpClient);
+    check(): Promise<HealthResponse>;
+    detailed(): Promise<DetailedHealthResponse>;
+}
+
+declare class PlayersResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Player[]>;
+    getByAddresses(addresses: string[]): Promise<Player[]>;
+    getByNames(names: string[]): Promise<Player[]>;
+    getByUuids(uuids: string[]): Promise<Player[]>;
+}
+
+declare class ShopsResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Shop[]>;
+    get(id: string): Promise<Shop>;
+    getItems(id: string): Promise<Item[]>;
+    update(data: ShopSyncData, token: string): Promise<{
+        message: string;
+    }>;
+}
+
+declare class ItemsResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Item[]>;
+}
+
+declare class AddressesResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<KnownAddress[]>;
+}
+
+declare class StorageResource {
+    private client;
+    constructor(client: HttpClient);
+    get(): Promise<StorageData>;
+    set(data: unknown, token: string): Promise<{
+        message: string;
+        timestamp: string;
+    }>;
+}
+
+declare class ReportsResource {
+    private client;
+    constructor(client: HttpClient);
+    getStats(): Promise<unknown>;
+    getValidationFailures(options?: {
+        limit?: number;
+    }): Promise<ReportRecords>;
+    getSuccessfulPosts(options?: {
+        limit?: number;
+    }): Promise<ReportRecords>;
+    getShopChanges(options?: {
+        limit?: number;
+        shopId?: string;
+    }): Promise<ReportRecords>;
+    getItemChanges(options?: {
+        limit?: number;
+        shopId?: string;
+    }): Promise<ReportRecords>;
+    getShopChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    getItemChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    getPriceChangeLogs(options?: ChangeLogOptions): Promise<ChangeLogResult>;
+    get(id: string): Promise<unknown>;
+}
+
+interface KrawletClientConfig {
+    baseUrl?: string;
+    apiKey?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    enableRetry?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+}
+declare class KrawletClient {
+    private httpClient;
+    readonly health: HealthResource;
+    readonly players: PlayersResource;
+    readonly shops: ShopsResource;
+    readonly items: ItemsResource;
+    readonly addresses: AddressesResource;
+    readonly storage: StorageResource;
+    readonly reports: ReportsResource;
+    constructor(config?: KrawletClientConfig);
+    getRateLimit(): RateLimit | undefined;
+}
+
+declare class KrawletError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    readonly response?: ErrorResponse;
+    constructor(message: string, code: string, statusCode: number, requestId?: string, details?: unknown, response?: ErrorResponse);
+    isClientError(): boolean;
+    isServerError(): boolean;
+    isRateLimitError(): boolean;
+}
+
+export { AddressesResource, type ApiResponse, type ApiResponseMeta, type ChangeLogOptions, type ChangeLogResult, type DetailedHealthResponse, ErrorCode, type ErrorResponse, HealthResource, type HealthResponse, type Item, type ItemChangeLog, type ItemChangeType, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type RateLimit, type ReportRecords, ReportsResource, type Shop, type ShopChangeLog, type ShopSyncData, ShopsResource, type StorageData, StorageResource };