krawlet-js 2.0.1 → 2.1.0

package/dist/index.cjs

@@ -30,7 +30,8 @@ __export(index_exports, {
   PlayersResource: () => PlayersResource,
   ReportsResource: () => ReportsResource,
   ShopsResource: () => ShopsResource,
-  StorageResource: () => StorageResource
+  StorageResource: () => StorageResource,
+  TransfersResource: () => TransfersResource
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -749,6 +750,84 @@ var ApiKeyResource = class {
   }
 };
 
+// src/resources/transfers.ts
+var TransfersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List all transfers where the authenticated player is sender or recipient
+   * @returns Array of transfer records
+   */
+  async getAll() {
+    const response = await this.client.request("/v1/transfers");
+    return response.data;
+  }
+  /**
+   * Queue a new transfer request
+   * @param data - Transfer request payload
+   * @returns Transfer record
+   */
+  async create(data) {
+    const response = await this.client.request("/v1/transfers", {
+      method: "POST",
+      body: data
+    });
+    return response.data;
+  }
+  /**
+   * Retrieve transfer details by ID
+   * @param transferId - Transfer UUID
+   * @returns Transfer record
+   */
+  async get(transferId) {
+    const response = await this.client.request(`/v1/transfers/${transferId}`);
+    return response.data;
+  }
+  /**
+   * Cancel a pending or in-progress transfer
+   * @param transferId - Transfer UUID
+   * @returns Updated transfer record
+   */
+  async cancel(transferId) {
+    const response = await this.client.request(`/v1/transfers/${transferId}/cancel`, {
+      method: "POST"
+    });
+    return response.data;
+  }
+  /**
+   * Get current ender storage contents for the authenticated player
+   * @returns Contents snapshot
+   */
+  async getContents() {
+    const response = await this.client.request("/v1/transfers/contents");
+    return response.data;
+  }
+  /**
+   * List active transfer targets available to the authenticated user
+   * @returns Array of transfer targets
+   */
+  async getTargets() {
+    const response = await this.client.request("/v1/transfers/targets");
+    return response.data;
+  }
+  /**
+   * Request transfer from public/service storage into the authenticated player's storage
+   * @param data - Public storage transfer payload
+   * @returns Transfer and resolved source entity information
+   */
+  async requestPublicStorage(data) {
+    const response = await this.client.request(
+      "/v1/requests/public-storage",
+      {
+        method: "POST",
+        body: data
+      }
+    );
+    return response.data;
+  }
+};
+
 // src/client.ts
 var KrawletClient = class {
   /**
@@ -774,6 +853,7 @@ var KrawletClient = class {
     this.storage = new StorageResource(this.httpClient);
     this.reports = new ReportsResource(this.httpClient);
     this.apiKey = new ApiKeyResource(this.httpClient);
+    this.transfers = new TransfersResource(this.httpClient);
   }
   /**
    * Get the last known rate limit information
@@ -813,5 +893,6 @@ var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
   PlayersResource,
   ReportsResource,
   ShopsResource,
-  StorageResource
+  StorageResource,
+  TransfersResource
 });

package/dist/index.d.cts

@@ -396,6 +396,65 @@ interface StorageData {
     data: EnderStorageChest[];
     retrievedAt: string;
 }
+interface StorageSlotItem {
+    name: string;
+    count: number;
+    nbt?: string | null;
+}
+interface StorageSlotContents {
+    items: StorageSlotItem[];
+}
+interface TransferTargetLink {
+    type: string;
+    value: string;
+}
+interface TransferTarget {
+    id: string;
+    name: string;
+    type: string;
+    links: TransferTargetLink[];
+}
+type TransferStatus = 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
+interface Transfer {
+    id: string;
+    status: TransferStatus;
+    error: string | null;
+    workerId?: number | null;
+    fromUUID: string;
+    fromUsername: string;
+    toUUID: string;
+    toUsername: string;
+    itemName: string | null;
+    itemNbt: string | null;
+    quantity: number | null;
+    quantityTransferred: number;
+    timestamp: string;
+}
+interface TransferCreateRequest {
+    to: string;
+    itemName?: string;
+    itemNbt?: string;
+    quantity?: number;
+    timeout?: number;
+}
+interface PublicStorageSourceEntity {
+    id: string;
+    name: string;
+    type: string;
+    alias?: string;
+}
+interface PublicStorageTransferRequest {
+    itemName: string;
+    itemNbt?: string;
+    quantity: number;
+    timeout?: number;
+    source?: string;
+    colors?: [number, number, number];
+}
+interface PublicStorageTransferResponse {
+    transfer: Transfer;
+    sourceEntity: PublicStorageSourceEntity;
+}
 interface ReportRecords<TRecord = unknown> {
     count: number;
     records: TRecord[];
@@ -558,6 +617,18 @@ declare class ApiKeyResource {
     redeemQuickCode(code: string): Promise<QuickCodeRedeemResponse>;
 }
 
+declare class TransfersResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Transfer[]>;
+    create(data: TransferCreateRequest): Promise<Transfer>;
+    get(transferId: string): Promise<Transfer>;
+    cancel(transferId: string): Promise<Transfer>;
+    getContents(): Promise<StorageSlotContents>;
+    getTargets(): Promise<TransferTarget[]>;
+    requestPublicStorage(data: PublicStorageTransferRequest): Promise<PublicStorageTransferResponse>;
+}
+
 interface KrawletClientConfig {
     baseUrl?: string;
     apiKey?: string;
@@ -577,6 +648,7 @@ declare class KrawletClient {
     readonly storage: StorageResource;
     readonly reports: ReportsResource;
     readonly apiKey: ApiKeyResource;
+    readonly transfers: TransfersResource;
     constructor(config?: KrawletClientConfig);
     getRateLimit(): RateLimit | undefined;
 }
@@ -593,4 +665,4 @@ declare class KrawletError extends Error {
     isRateLimitError(): boolean;
 }
 
-export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type BaseQueryParams, type ChangeLogOptions, type ChangeLogResult, type ChatboxServiceInfo, type DetailedHealthResponse, type DiscordServiceInfo, type EnderStorageApiPayload, type EnderStorageChest, type EnderStorageCollection, type EnderStorageColor, type EnderStorageItem, type EnderStorageMeta, type EnderStoragePayload, ErrorCode, type ErrorResponse, type HealthChecks, HealthResource, type HealthResponse, type HealthServices, type HealthServicesDetailed, type Item, type ItemChangeLog, type ItemChangeLogResponse, type ItemChangeRecord, type ItemChangeType, type ItemChangesParams, type ItemSummary, type ItemUpdateSummary, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type KromerServiceInfo, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type PriceChangeLogResponse, type PriceChangesParams, type QuickCodeGenerateResponse, type QuickCodeRedeemResponse, type RateLimit, type ReportRecords, type ReporterStats, ReportsResource, type RequestLog, type RequestLogsResponse, type ServiceInfo, type ServiceName, type ServiceStatus, type Shop, type ShopChangeField, type ShopChangeLog, type ShopChangeLogResponse, type ShopChangeRecord, type ShopChangesParams, type ShopSourceType, type ShopSyncData, ShopsResource, type StorageData, StorageResource, type SuccessfulPostRecord, type ValidationFailureRecord };
+export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type BaseQueryParams, type ChangeLogOptions, type ChangeLogResult, type ChatboxServiceInfo, type DetailedHealthResponse, type DiscordServiceInfo, type EnderStorageApiPayload, type EnderStorageChest, type EnderStorageCollection, type EnderStorageColor, type EnderStorageItem, type EnderStorageMeta, type EnderStoragePayload, ErrorCode, type ErrorResponse, type HealthChecks, HealthResource, type HealthResponse, type HealthServices, type HealthServicesDetailed, type Item, type ItemChangeLog, type ItemChangeLogResponse, type ItemChangeRecord, type ItemChangeType, type ItemChangesParams, type ItemSummary, type ItemUpdateSummary, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type KromerServiceInfo, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type PriceChangeLogResponse, type PriceChangesParams, type PublicStorageSourceEntity, type PublicStorageTransferRequest, type PublicStorageTransferResponse, type QuickCodeGenerateResponse, type QuickCodeRedeemResponse, type RateLimit, type ReportRecords, type ReporterStats, ReportsResource, type RequestLog, type RequestLogsResponse, type ServiceInfo, type ServiceName, type ServiceStatus, type Shop, type ShopChangeField, type ShopChangeLog, type ShopChangeLogResponse, type ShopChangeRecord, type ShopChangesParams, type ShopSourceType, type ShopSyncData, ShopsResource, type StorageData, StorageResource, type StorageSlotContents, type StorageSlotItem, type SuccessfulPostRecord, type Transfer, type TransferCreateRequest, type TransferStatus, type TransferTarget, type TransferTargetLink, TransfersResource, type ValidationFailureRecord };

package/dist/index.d.ts

@@ -396,6 +396,65 @@ interface StorageData {
     data: EnderStorageChest[];
     retrievedAt: string;
 }
+interface StorageSlotItem {
+    name: string;
+    count: number;
+    nbt?: string | null;
+}
+interface StorageSlotContents {
+    items: StorageSlotItem[];
+}
+interface TransferTargetLink {
+    type: string;
+    value: string;
+}
+interface TransferTarget {
+    id: string;
+    name: string;
+    type: string;
+    links: TransferTargetLink[];
+}
+type TransferStatus = 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
+interface Transfer {
+    id: string;
+    status: TransferStatus;
+    error: string | null;
+    workerId?: number | null;
+    fromUUID: string;
+    fromUsername: string;
+    toUUID: string;
+    toUsername: string;
+    itemName: string | null;
+    itemNbt: string | null;
+    quantity: number | null;
+    quantityTransferred: number;
+    timestamp: string;
+}
+interface TransferCreateRequest {
+    to: string;
+    itemName?: string;
+    itemNbt?: string;
+    quantity?: number;
+    timeout?: number;
+}
+interface PublicStorageSourceEntity {
+    id: string;
+    name: string;
+    type: string;
+    alias?: string;
+}
+interface PublicStorageTransferRequest {
+    itemName: string;
+    itemNbt?: string;
+    quantity: number;
+    timeout?: number;
+    source?: string;
+    colors?: [number, number, number];
+}
+interface PublicStorageTransferResponse {
+    transfer: Transfer;
+    sourceEntity: PublicStorageSourceEntity;
+}
 interface ReportRecords<TRecord = unknown> {
     count: number;
     records: TRecord[];
@@ -558,6 +617,18 @@ declare class ApiKeyResource {
     redeemQuickCode(code: string): Promise<QuickCodeRedeemResponse>;
 }
 
+declare class TransfersResource {
+    private client;
+    constructor(client: HttpClient);
+    getAll(): Promise<Transfer[]>;
+    create(data: TransferCreateRequest): Promise<Transfer>;
+    get(transferId: string): Promise<Transfer>;
+    cancel(transferId: string): Promise<Transfer>;
+    getContents(): Promise<StorageSlotContents>;
+    getTargets(): Promise<TransferTarget[]>;
+    requestPublicStorage(data: PublicStorageTransferRequest): Promise<PublicStorageTransferResponse>;
+}
+
 interface KrawletClientConfig {
     baseUrl?: string;
     apiKey?: string;
@@ -577,6 +648,7 @@ declare class KrawletClient {
     readonly storage: StorageResource;
     readonly reports: ReportsResource;
     readonly apiKey: ApiKeyResource;
+    readonly transfers: TransfersResource;
     constructor(config?: KrawletClientConfig);
     getRateLimit(): RateLimit | undefined;
 }
@@ -593,4 +665,4 @@ declare class KrawletError extends Error {
     isRateLimitError(): boolean;
 }
 
-export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type BaseQueryParams, type ChangeLogOptions, type ChangeLogResult, type ChatboxServiceInfo, type DetailedHealthResponse, type DiscordServiceInfo, type EnderStorageApiPayload, type EnderStorageChest, type EnderStorageCollection, type EnderStorageColor, type EnderStorageItem, type EnderStorageMeta, type EnderStoragePayload, ErrorCode, type ErrorResponse, type HealthChecks, HealthResource, type HealthResponse, type HealthServices, type HealthServicesDetailed, type Item, type ItemChangeLog, type ItemChangeLogResponse, type ItemChangeRecord, type ItemChangeType, type ItemChangesParams, type ItemSummary, type ItemUpdateSummary, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type KromerServiceInfo, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type PriceChangeLogResponse, type PriceChangesParams, type QuickCodeGenerateResponse, type QuickCodeRedeemResponse, type RateLimit, type ReportRecords, type ReporterStats, ReportsResource, type RequestLog, type RequestLogsResponse, type ServiceInfo, type ServiceName, type ServiceStatus, type Shop, type ShopChangeField, type ShopChangeLog, type ShopChangeLogResponse, type ShopChangeRecord, type ShopChangesParams, type ShopSourceType, type ShopSyncData, ShopsResource, type StorageData, StorageResource, type SuccessfulPostRecord, type ValidationFailureRecord };
+export { AddressesResource, type ApiKeyInfo, ApiKeyResource, type ApiKeyTier, type ApiKeyUsage, type ApiResponse, type ApiResponseMeta, type BaseQueryParams, type ChangeLogOptions, type ChangeLogResult, type ChatboxServiceInfo, type DetailedHealthResponse, type DiscordServiceInfo, type EnderStorageApiPayload, type EnderStorageChest, type EnderStorageCollection, type EnderStorageColor, type EnderStorageItem, type EnderStorageMeta, type EnderStoragePayload, ErrorCode, type ErrorResponse, type HealthChecks, HealthResource, type HealthResponse, type HealthServices, type HealthServicesDetailed, type Item, type ItemChangeLog, type ItemChangeLogResponse, type ItemChangeRecord, type ItemChangeType, type ItemChangesParams, type ItemSummary, type ItemUpdateSummary, ItemsResource, type KnownAddress, type KnownAddressType, KrawletClient, type KrawletClientConfig, KrawletError, type KromerServiceInfo, type Player, type PlayerNotifications, PlayersResource, type Price, type PriceChangeLog, type PriceChangeLogResponse, type PriceChangesParams, type PublicStorageSourceEntity, type PublicStorageTransferRequest, type PublicStorageTransferResponse, type QuickCodeGenerateResponse, type QuickCodeRedeemResponse, type RateLimit, type ReportRecords, type ReporterStats, ReportsResource, type RequestLog, type RequestLogsResponse, type ServiceInfo, type ServiceName, type ServiceStatus, type Shop, type ShopChangeField, type ShopChangeLog, type ShopChangeLogResponse, type ShopChangeRecord, type ShopChangesParams, type ShopSourceType, type ShopSyncData, ShopsResource, type StorageData, StorageResource, type StorageSlotContents, type StorageSlotItem, type SuccessfulPostRecord, type Transfer, type TransferCreateRequest, type TransferStatus, type TransferTarget, type TransferTargetLink, TransfersResource, type ValidationFailureRecord };

package/dist/index.js

@@ -713,6 +713,84 @@ var ApiKeyResource = class {
   }
 };
 
+// src/resources/transfers.ts
+var TransfersResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List all transfers where the authenticated player is sender or recipient
+   * @returns Array of transfer records
+   */
+  async getAll() {
+    const response = await this.client.request("/v1/transfers");
+    return response.data;
+  }
+  /**
+   * Queue a new transfer request
+   * @param data - Transfer request payload
+   * @returns Transfer record
+   */
+  async create(data) {
+    const response = await this.client.request("/v1/transfers", {
+      method: "POST",
+      body: data
+    });
+    return response.data;
+  }
+  /**
+   * Retrieve transfer details by ID
+   * @param transferId - Transfer UUID
+   * @returns Transfer record
+   */
+  async get(transferId) {
+    const response = await this.client.request(`/v1/transfers/${transferId}`);
+    return response.data;
+  }
+  /**
+   * Cancel a pending or in-progress transfer
+   * @param transferId - Transfer UUID
+   * @returns Updated transfer record
+   */
+  async cancel(transferId) {
+    const response = await this.client.request(`/v1/transfers/${transferId}/cancel`, {
+      method: "POST"
+    });
+    return response.data;
+  }
+  /**
+   * Get current ender storage contents for the authenticated player
+   * @returns Contents snapshot
+   */
+  async getContents() {
+    const response = await this.client.request("/v1/transfers/contents");
+    return response.data;
+  }
+  /**
+   * List active transfer targets available to the authenticated user
+   * @returns Array of transfer targets
+   */
+  async getTargets() {
+    const response = await this.client.request("/v1/transfers/targets");
+    return response.data;
+  }
+  /**
+   * Request transfer from public/service storage into the authenticated player's storage
+   * @param data - Public storage transfer payload
+   * @returns Transfer and resolved source entity information
+   */
+  async requestPublicStorage(data) {
+    const response = await this.client.request(
+      "/v1/requests/public-storage",
+      {
+        method: "POST",
+        body: data
+      }
+    );
+    return response.data;
+  }
+};
+
 // src/client.ts
 var KrawletClient = class {
   /**
@@ -738,6 +816,7 @@ var KrawletClient = class {
     this.storage = new StorageResource(this.httpClient);
     this.reports = new ReportsResource(this.httpClient);
     this.apiKey = new ApiKeyResource(this.httpClient);
+    this.transfers = new TransfersResource(this.httpClient);
   }
   /**
    * Get the last known rate limit information
@@ -776,5 +855,6 @@ export {
   PlayersResource,
   ReportsResource,
   ShopsResource,
-  StorageResource
+  StorageResource,
+  TransfersResource
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "krawlet-js",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "TypeScript/JavaScript client library for the Krawlet Minecraft economy tracking API",
   "type": "module",
   "main": "dist/index.cjs",