ts-bitpin - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

CHANGELOG.md

@@ -10,4 +10,12 @@ # Changelog
 
-## [Unreleased](https://github.com/amiwrpremium/ts-bitpin/compare/v2.0.0...HEAD)
+## [Unreleased](https://github.com/amiwrpremium/ts-bitpin/compare/v2.0.1...HEAD)
 
+## [v2.0.1](https://github.com/amiwrpremium/ts-bitpin/compare/v2.0.0...v2.0.1) - 2024-11-02
+
+### Commits
+
+- chore(release): 2.0.1 [`9573f81`](https://github.com/amiwrpremium/ts-bitpin/commit/9573f81bf8b9a49d706d8100423edcf02236d9d4)
+- feat(package): export APIError and RequestError from exceptions in index [`6841be1`](https://github.com/amiwrpremium/ts-bitpin/commit/6841be1fc1332b98fc748fda1b05eeb8536c7755)
+- refactor(types): update order interfaces and methods in client [`c569e98`](https://github.com/amiwrpremium/ts-bitpin/commit/c569e98854d2476834e34259cababf7f6c6bc0d4)
+
 ## [v2.0.0](https://github.com/amiwrpremium/ts-bitpin/compare/v1.0.0...v2.0.0) - 2024-10-31
@@ -17,3 +25,3 @@
 
-- chore(release): 2.0.0 [`dbccb15`](https://github.com/amiwrpremium/ts-bitpin/commit/dbccb15a091a964556bfb21103d8585a7f0170b3)
+- chore(release): 2.0.0 [`2681a3a`](https://github.com/amiwrpremium/ts-bitpin/commit/2681a3a11db9acc48e5f6e9f817ea16381eecbd1)
 - ci(docs): add docs generation workflow and update package.json for Typedoc [`9d1c06d`](https://github.com/amiwrpremium/ts-bitpin/commit/9d1c06d5226050c9c87340d77ea3dfb362d65fc7)
@@ -20,0 +28,0 @@ - refactor(client): update baseUrl and method names for consistency [`aa17323`](https://github.com/amiwrpremium/ts-bitpin/commit/aa173231f338a5e3a28b258d2c427e999d3a596d)

lib/client.d.ts

@@ -357,3 +357,3 @@ import { type AxiosInstance, type AxiosRequestConfig } from 'axios';
      */
-    cancelOrder(params: t.ICancelOrderParams, kwargs?: t.IRequestOptions): Promise<t.IOrderStatusResponse>;
+    cancelOrder(params: t.ICancelOrderParams, kwargs?: t.IRequestOptions): Promise<undefined>;
     /**
@@ -360,0 +360,0 @@ * Retrieves the status of an order with the specified order ID(s).

lib/index.d.ts

@@ -8,3 +8,3 @@ /**
  *
- * @version 2.0.0
+ * @version 2.0.1
  * @package ts-bitpin
@@ -16,1 +16,2 @@ * @module src/index
 export * as types from './types';
+export { APIError, RequestError } from './exceptions';

lib/index.js

@@ -9,3 +9,3 @@ "use strict";
  *
- * @version 2.0.0
+ * @version 2.0.1
  * @package ts-bitpin
@@ -38,3 +38,3 @@ * @module src/index
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.types = exports.enums = exports.Client = void 0;
+exports.RequestError = exports.APIError = exports.types = exports.enums = exports.Client = void 0;
 var client_1 = require("./client");
@@ -44,2 +44,5 @@ Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
 exports.types = __importStar(require("./types"));
+var exceptions_1 = require("./exceptions");
+Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return exceptions_1.APIError; } });
+Object.defineProperty(exports, "RequestError", { enumerable: true, get: function () { return exceptions_1.RequestError; } });
 //# sourceMappingURL=index.js.map

lib/types/order/create-order.interface.d.ts

 import { Symbol as SymbolType } from '../types';
 import { OrderSide, OrderType } from '../../enums';
 /**
- * @interface PriceMixin
+ * @interface IPriceMixin
  * Interface representing a mixin for price.
@@ -9,18 +9,18 @@ *
  */
-export interface PriceMixin {
+export interface IPriceMixin {
     price: number;
 }
 /**
- * @interface StopPriceMixin
+ * @interface IStopPriceMixin
  * Interface representing a mixin for stop price.
  *
- * @extends PriceMixin
+ * @extends IPriceMixin
  *
  * @property {number} stop_price - The stop price value.
  */
-export interface StopPriceMixin extends PriceMixin {
+export interface IStopPriceMixin extends IPriceMixin {
     stop_price: number;
 }
 /**
- * @interface BaseCreateOrderParams
+ * @interface IBaseCreateOrderParams
  * Interface representing the base parameters for creating an order.
@@ -33,3 +33,3 @@ *
  */
-export interface BaseCreateOrderParams {
+export interface IBaseCreateOrderParams {
     symbol: SymbolType;
@@ -41,6 +41,6 @@ type: OrderType;
 /**
- * @interface CreateLimitOrderParams
+ * @interface ICreateLimitOrderParams
  * Interface representing the parameters for creating a limit order.
  *
- * @extends BaseCreateOrderParams, PriceMixin
+ * @extends IBaseCreateOrderParams, IPriceMixin
  *
@@ -50,3 +50,3 @@ * @property {'limit'} type - The type of the order (limit).
  * @example
- * const createLimitOrderParams: CreateLimitOrderParams = {
+ * const createLimitOrderParams: ICreateLimitOrderParams = {
  *   symbol: 'BTC_USDT',
@@ -59,10 +59,10 @@ *   type: OrderType.LIMIT,
  */
-export interface CreateLimitOrderParams extends BaseCreateOrderParams, PriceMixin {
+export interface ICreateLimitOrderParams extends IBaseCreateOrderParams, IPriceMixin {
     type: 'limit';
 }
 /**
- * @interface CreateMarketOrderParams
+ * @interface ICreateMarketOrderParams
  * Interface representing the parameters for creating a market order.
  *
- * @extends BaseCreateOrderParams
+ * @extends IBaseCreateOrderParams
  *
@@ -72,3 +72,3 @@ * @property {'market'} type - The type of the order (market).
  * @example
- * const createMarketOrderParams: CreateMarketOrderParams = {
+ * const createMarketOrderParams: ICreateMarketOrderParams = {
  *   symbol: 'BTC_USDT',
@@ -80,10 +80,10 @@ *   type: OrderType.MARKET,
  */
-export interface CreateMarketOrderParams extends BaseCreateOrderParams {
+export interface ICreateMarketOrderParams extends IBaseCreateOrderParams {
     type: 'market';
 }
 /**
- * @interface CreateStopLimitOrderParams
+ * @interface ICreateStopLimitOrderParams
  * Interface representing the parameters for creating a stop limit order.
  *
- * @extends BaseCreateOrderParams, StopPriceMixin
+ * @extends IBaseCreateOrderParams, IStopPriceMixin
  *
@@ -93,3 +93,3 @@ * @property {'stop_limit'} type - The type of the order (stop limit).
  * @example
- * const createStopLimitOrderParams: CreateStopLimitOrderParams = {
+ * const createStopLimitOrderParams: ICreateStopLimitOrderParams = {
  *   symbol: 'BTC_USDT',
@@ -103,10 +103,10 @@ *   type: OrderType.STOP_LIMIT,
  */
-export interface CreateStopLimitOrderParams extends BaseCreateOrderParams, StopPriceMixin {
+export interface ICreateStopLimitOrderParams extends IBaseCreateOrderParams, IStopPriceMixin {
     type: 'stop_limit';
 }
 /**
- * @interface CreateOCOOrderParams
+ * @interface ICreateOCOOrderParams
  * Interface representing the parameters for creating an OCO (One Cancels the Other) order.
  *
- * @extends BaseCreateOrderParams, StopPriceMixin
+ * @extends IBaseCreateOrderParams, IStopPriceMixin
  *
@@ -117,3 +117,3 @@ * @property {'oco'} type - The type of the order (OCO).
  * @example
- * const createOCOOrderParams: CreateOCOOrderParams = {
+ * const createOCOOrderParams: ICreateOCOOrderParams = {
  *   symbol: 'BTC_USDT',
@@ -128,3 +128,3 @@ *   type: OrderType.OCO,
  */
-export interface CreateOCOOrderParams extends BaseCreateOrderParams, StopPriceMixin {
+export interface ICreateOCOOrderParams extends IBaseCreateOrderParams, IStopPriceMixin {
     type: 'oco';
@@ -137,12 +137,12 @@ oco_target_price: number;
  * It can be one of the following types:
- * - CreateLimitOrderParams
- * - CreateMarketOrderParams
- * - CreateStopLimitOrderParams
- * - CreateOCOOrderParams
+ * - ICreateLimitOrderParams
+ * - ICreateMarketOrderParams
+ * - ICreateStopLimitOrderParams
+ * - ICreateOCOOrderParams
  *
- * @see {@link CreateLimitOrderParams}
- * @see {@link CreateMarketOrderParams}
- * @see {@link CreateStopLimitOrderParams}
- * @see {@link CreateOCOOrderParams}
+ * @see {@link ICreateLimitOrderParams}
+ * @see {@link ICreateMarketOrderParams}
+ * @see {@link ICreateStopLimitOrderParams}
+ * @see {@link ICreateOCOOrderParams}
  */
-export type CreateOrderParams = CreateLimitOrderParams | CreateMarketOrderParams | CreateStopLimitOrderParams | CreateOCOOrderParams;
+export type CreateOrderParams = ICreateLimitOrderParams | ICreateMarketOrderParams | ICreateStopLimitOrderParams | ICreateOCOOrderParams;

lib/types/order/order-status.interface.d.ts

@@ -40,2 +40,3 @@ import type { Symbol as SymbolType, NumberInString } from '../types';
  * const order: ICreateOrder = {
+ *   id: 535179385,
  *   symbol: "PIXFI_IRT",
@@ -60,2 +61,3 @@ *   type: "limit",
 export interface IOrderStatusResponse {
+    id: number;
     symbol: SymbolType;
@@ -62,0 +64,0 @@ type: OrderType;

package.json

 {
   "name": "ts-bitpin",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Unofficial BitPin SDK for Node.js.",
@@ -5,0 +5,0 @@ "author": {

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

157175

0.7%

Lines of code

2691

0.22%

Number of medium supply chain risk alerts

0

-100%

No dependency changes