@ezpaarse-project/ezreeport-sdk-js 1.1.0-beta.1 → 1.1.0-rc.1

package/dist/types/lib/axios.d.ts

@@ -40,7 +40,7 @@ export interface PaginatedApiResponse<T, K extends keyof T> extends ApiResponse<
  *
  * @returns Response
  */
-export declare const axiosWithErrorFormatter: <T, Method extends "delete" | "get" | "post" | "put" | "patch">(method: Method, ...params: Parameters<Axios[Method]>) => Promise<AxiosResponse<T, any>>;
+export declare const axiosWithErrorFormatter: <T, Method extends "delete" | "get" | "post" | "put" | "patch">(method: Method, ...params: Parameters<Axios[Method]>) => Promise<AxiosResponse<T>>;
 declare const _default: import("axios").AxiosInstance & {
     $get: <T>(url: string, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T>>;
     $post: <T_1>(url: string, data?: unknown, config?: import("axios").AxiosRequestConfig<unknown> | undefined) => Promise<ApiResponse<T_1>>;

package/dist/types/lib/promises.d.ts

@@ -17,5 +17,5 @@ export type EventfulPromise<T, E extends Record<string, any[]>> = Promise<T> & E
  *
  * @returns The EventfulPromise
  */
-declare const createEventfulPromise: <T, E extends Record<string, any[]> = Record<string, any[]>>(executor: (emitter: EventfulEmitter<E>) => Promise<T>, emitter?: EventEmitter) => EventfulPromise<T, E>;
+declare const createEventfulPromise: <T, E extends Record<string, any[]> = Record<string, any[]>>(executor: (emitter: EventfulEmitter<E>) => Promise<T>, emitter?: EventEmitter<[never]>) => EventfulPromise<T, E>;
 export default createEventfulPromise;

package/dist/types/modules/queues.d.ts

@@ -92,7 +92,7 @@ export declare const resumeQueue: (queueOrName: Queue | Queue['name']) => Promis
  *
  * @returns queue info
  */
-export declare const getQueueJobs: <Data, Result>(queueOrName: Queue | Queue['name'], paginationOpts?: PaginationOpts) => Promise<PaginatedApiResponse<FullJob<Data, Result>, "id">>;
+export declare const getQueueJobs: <Data, Result>(queueOrName: Queue | Queue['name'], paginationOpts?: PaginationOpts) => Promise<PaginatedApiResponse<FullJob<Data, Result>, 'id'>>;
 /**
  * Get job info
  *
@@ -104,7 +104,7 @@ export declare const getQueueJobs: <Data, Result>(queueOrName: Queue | Queue['na
  *
  * @returns Job full info
  */
-export declare const getJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: string | number | Job<Data>, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
+export declare const getJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: Job<Data> | Job<Data>['id'], namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
 /**
  * Retry job that failed
  *
@@ -116,5 +116,5 @@ export declare const getJob: <Data, Result>(queueOrName: Queue | Queue['name'],
  *
  * @returns queue info
  */
-export declare const retryJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: string | number | Job<Data>, namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
+export declare const retryJob: <Data, Result>(queueOrName: Queue | Queue['name'], jobOrId: Job<Data> | Job<Data>['id'], namespaces?: string[]) => Promise<ApiResponse<FullJob<Data, Result>>>;
 export {};

package/dist/types/modules/reports.d.ts

@@ -132,7 +132,7 @@ interface ResponseTypeMap {
  *
  * @returns The report's content
  */
-export declare const getReportFileByName: <Result extends keyof ResponseTypeMap = "text">(name: string, namespaces?: string[], responseType?: Result | undefined, ext?: string) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportFileByName: <Result extends keyof ResponseTypeMap = "text">(name: string, namespaces?: string[], responseType?: Result, ext?: string) => Promise<ResponseTypeMap[Result]>;
 /**
  * Get report main file (the result) by giving job's info
  *
@@ -146,7 +146,7 @@ export declare const getReportFileByName: <Result extends keyof ResponseTypeMap
  *
  * @returns The report's content
  */
-export declare const getReportFileByJob: <Result extends keyof ResponseTypeMap = "text">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportFileByJob: <Result extends keyof ResponseTypeMap = "text">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
 /**
  * Get report detail by giving the report's name
  *
@@ -186,7 +186,7 @@ export declare const getReportDetailByJob: (queueName: Queue | Queue['name'], jo
  *
  * @returns The debug's content
  */
-export declare const getReportDebugByName: <Result extends keyof ResponseTypeMap = "json">(name: string, namespaces?: string[], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportDebugByName: <Result extends keyof ResponseTypeMap = "json">(name: string, namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
 /**
  * Get report debug file by giving job's info
  *
@@ -200,5 +200,5 @@ export declare const getReportDebugByName: <Result extends keyof ResponseTypeMap
  *
  * @returns The debug's content
  */
-export declare const getReportDebugByJob: <Result extends keyof ResponseTypeMap = "json">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result | undefined) => Promise<ResponseTypeMap[Result]>;
+export declare const getReportDebugByJob: <Result extends keyof ResponseTypeMap = "json">(queueName: Queue | Queue['name'], jobId: Job<RawReportData> | Job<RawReportData>['id'], namespaces?: string[], responseType?: Result) => Promise<ResponseTypeMap[Result]>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ezpaarse-project/ezreeport-sdk-js",
-  "version": "1.1.0-beta.1",
+  "version": "1.1.0-rc.1",
   "description": "JS SDK to communicate with ezReeport API",
   "homepage": "https://github.com/ezpaarse-project/ezreeport#readme",
   "bugs": {
@@ -26,18 +26,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "prebuild": "rimraf --glob 'dist/*'",
-    "build": "run-s build:web build:node build:types build:docs",
-    "build:web": "tsc --project tsconfig.json && BUILD_TARGET=browser vite build",
-    "build:node": "tsc --project tsconfig.node.json && BUILD_TARGET=node vite build",
-    "build:types": "tsc --project tsconfig.types.json",
-    "build:docs": "typedoc src/index.ts",
-    "docs": "vite docs --open",
-    "dev": "run-p \"build:docs -- --watch\" docs",
-    "lint": "eslint --fix .",
-    "test": "npm run build && npm -w ezreeport-tests run test:sdk"
-  },
   "lint-staged": {
     "*.ts": [
       "eslint --fix"
@@ -57,5 +45,17 @@
   },
   "engines": {
     "node": "^16 || ^18"
+  },
+  "scripts": {
+    "prebuild": "rimraf --glob 'dist/*'",
+    "build": "run-s build:web build:node build:types build:docs",
+    "build:web": "tsc --project tsconfig.json && BUILD_TARGET=browser vite build",
+    "build:node": "tsc --project tsconfig.node.json && BUILD_TARGET=node vite build",
+    "build:types": "tsc --project tsconfig.types.json",
+    "build:docs": "typedoc src/index.ts",
+    "docs": "vite docs --open",
+    "dev": "run-p \"build:docs -- --watch\" docs",
+    "lint": "eslint --fix .",
+    "test": "npm run build && npm -w ezreeport-tests run test:sdk"
   }
-}
+}