@ezpaarse-project/ezreeport-sdk-js 1.0.0-beta.5 → 1.0.0-beta.6

package/README.md

@@ -1,4 +1,4 @@
-# ezREEPORT-sdk-js
+# @ezpaarse-project/ezreeport-sdk-js
 
 > SDK used to interact with ezREEPORT API
 
@@ -9,766 +9,33 @@
 - ✅ Automatic parsing (dates, enums, etc.)
 - ❌ Admin requests (the ones that need API key)
 
----
----
+## Install
 
-## Modules
-
-- [auth](#auth)
-- [setup](#setup)
-- [health](#health)
-- [tasks](#tasks)
-- [reports](#reports)
-- [templates](#templates)
-- [history](#history)
-- [crons](#crons)
-- [queues](#queues)
-- [namespaces](#namespaces)
-
-All responses use the `ApiResponse` or `PaginatedApiResponse` types which refer to this :
-
-```ts
-interface ApiResponse<T> {
-  /**
-   * HTTP Status
-   */
-  status: {
-    code: number,
-    message: string,
-  },
-  /**
-   * Content of the response
-   */
-  content: T
-}
-
-interface PaginatedApiResponse<T> extends ApiResponse<T> {
-  meta: {
-    /**
-     * Count of items in response
-     */
-    count: number,
-    /**
-     * Count of items wanted
-     */
-    size: number,
-    /**
-     * Count of items available
-     */
-    total: number,
-    /**
-     * Id of last item in response
-     */
-    lastId?: unknown
-  }
-}
-
-```
-
----
-
-### auth
-
-Methods used to interact with current user
-
-#### login
-
-```ts
-login(token: string): void
-```
-
-Set the given token into axios
-
-#### logout
-
-```ts
-logout(): void
-```
-
-Unset any token from axios
-
-#### isLogged
-
-```ts
-isLogged(): boolean
-```
-
-Check if any token is in axios. **DOESN'T CHECK IF TOKEN IS VALID !**
-
-#### getCurrentUser
-
-```ts
-getCurrentUser(): Promise<ApiResponse<auth.User>>
-```
-
-Get info about logged user
-
-#### getCurrentPermissions
-
-```ts
-getCurrentPermissions(): Promise<ApiResponse<auth.Permissions>>
-```
-
-Get permissions of logged user.
-
-There a 2 types of permissions :
-
-- Namespaced: Those ones depends from a namespace to another. If a namespace is not in the list, then the current user doesn't have access to this namespace.
-- General: Those ones are global to ezREEPORT and doesn't depends on namespace.
-
-#### getCurrentNamespaces
-
-```ts
-getCurrentNamespaces(): Promise<ApiResponse<namespaces.Namespace[]>>
-```
-
-Get accessible namespaces by logged user. It should returns the same namespaces as [auth::getCurrentPermissions](#getcurrentpermissions) but with more info about namespaces.
-
----
-
-### crons
-
-Methods used to manage crons, it should be only available to admins of ezREEPORT.
-
-#### getAllCrons
-
-```ts
-getAllCrons(): Promise<ApiResponse<crons.Cron[]>>
-```
-
-Get all available crons and their statuses.
-
-Needs `general.crons-get` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-#### getCron
-
-```ts
-getCron(name: string): Promise<ApiResponse<crons.Cron>>
-```
-
-Get more info about specific cron
-
-Needs `general.crons-get-cron` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: The name of the cron
-
-#### startCron
-
-```ts
-startCron(name: string): Promise<ApiResponse<crons.Cron>>
-```
-
-Start cron
-
-Needs `general.crons-put-cron-start` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: The name of the cron
-
-#### stopCron
-
-```ts
-stopCron(name: string): Promise<ApiResponse<crons.Cron>>
-```
-
-Stop cron
-
-Needs `general.crons-put-cron-stop` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: The name of the cron
-
-#### forceCron
-
-```ts
-forceCron(name: string): Promise<ApiResponse<crons.Cron>>
-```
-
-Force run of a cron
-
-Needs `general.crons-post-cron-force` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: The name of the cron
-
----
-
-### health
-
-Methods used to monitor health of ezREEPORT.
-
-#### getAllConnectedServices
-
-```ts
-type R = {
-  current: string;
-  currentVersion: string;
-  services: health.PingResult['name'][];
-};
-
-getAllConnectedServices(): Promise<ApiResponse<R>>
-```
-
-Get all services connected to current service.
-
-#### checkAllConnectedService
-
-```ts
-checkAllConnectedService(service: string): Promise<ApiResponse<health.PingResult>>
-```
-
-Check connection for all connected service from current service
-
-__Params__:
-
-- `service`: The name of the service
-
-#### checkConnectedService
-
-```ts
-checkConnectedService(service: string): Promise<ApiResponse<health.PingResult>>
-```
-
-Check connection of a specific service from current service
-
-__Params__:
-
-- `service`: The name of the service
-
-#### checkCurrentService
-
-```ts
-checkCurrentService(): Promise<ApiResponse<health.PingResult>>
-```
-
-Check connection of current service
-
-It's useful when the app will have limited connection, or if you just want the processing time.
-
----
-
-### namespaces
-
-Only used for types.
-
----
-
-### queues
-
-Methods used to manage queues
-
-#### getAllQueues
-
-```ts
-getAllQueues(): Promise<ApiResponse<queues.Queue[]>>
-```
-
-Get all available queues
-
-Needs `general.queues-get` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-#### pauseQueue
-
-```ts
-pauseQueue(name: string): Promise<ApiResponse<queues.Queue>>
-```
-
-Pause specific queue
-
-Needs `general.queues-put-queue-pause` permission(see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: Name of the queue
-
-#### resumeQueue
-
-```ts
-resumeQueue(name: string): Promise<ApiResponse<queues.Queue>>
-```
-
-
-Restart specific queue
-
-Needs `general.queues-put-queue-resume` permission(see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: Name of the queue
-
-#### getQueueJobs
-
-```ts
-getQueueJobs<Data, Result>(name: string): Promise<PaginatedApiResponse<queues.FullJob<Data, Result>[]>>
-```
-
-Get specific queue info
-
-Needs `general.queues-get-queue-jobs` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Type Params__:
-
-- `Data`: Data passed to the job (accessible with the `data` property)
-- `Result`: Result returned by the job (accessible with the `result` property)
-
-__Params__:
-
-- `name`: Name of the queue
-
-#### getJob
-
-```ts
-getJob<Data, Result>(name: string, jobId: string | number, namespaces?: string[]): Promise<ApiResponse<FullJob<Data, Result>>>
-```
-
-Get specific job info
-
-Needs `namespaces[namespaceId].queues-get-queue-jobs-jobId` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Type Params__:
-
-- `Data`: Data passed to the job (accessible with the `data` property)
-- `Result`: Result returned by the job (accessible with the `result` property)
-
-__Params__:
-
-- `name`: Name of the queue
-- `jobId`: Id of the job
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### retryJob
-
-```ts
-retryJob(): void
-```
-
-Retry job that failed
-
-Needs `namespaces[namespaceId].queues-post-queue-jobs-jobId-retry` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-
-__Type Params__:
-
-- `Data`: Data passed to the job (accessible with the `data` property)
-- `Result`: Result returned by the job (accessible with the `result` property)
-
-__Params__:
-
-- `name`: Name of the queue
-- `jobId`: Id of the job
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
----
-
-### reports
-
-Methods to start generation of reports and to get results
-
-#### startGeneration
-
-```ts
-type P = {
-  /**
-   * Override targets of task. Also enable first level of debugging
-   * (disable generation history)
-   */
-  testEmails?: string[],
-  /**
-   * Override period, must match task's recurrence
-   */
-  period?: Period,
-}
-
-startGeneration(taskId: string, params: P, namespaces?: string[]): Promise<ApiResponse<queues.Job>>
-```
-
-Start generation of a report. Returns the job info in order to track progress.
-
-Needs `namespaces[namespaceId].tasks-post-task-run` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `taskId`: Id of the task
-- `params`: Other params for overriding default
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### startAndListenGeneration
-
-```ts
-type P = {
-  /**
-   * Override targets of task. Also enable first level of debugging
-   * (disable generation history)
-   */
-  testEmails?: string[],
-  /**
-   * Override period, must match task's recurrence
-   */
-  period?: Period,
-}
-
-startAndListenGeneration(taskId: string, params: P, namespaces?: string[]): EventfulPromise<ReportResult>
-```
-
-Start generation of a report and track progress. Returns the detail when generation ends as an `EventfulPromise` (a promise that can send events so you can still use async/await while tracking progress).
-
-Needs `namespaces[namespaceId].tasks-post-task-run` & `namespaces[namespaceId].queues-get-queue-jobs-jobId` permissions permissions (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-> **Note**
-> If job's fails it will throws an error but __not if generation fails !__
-
-__Params__:
-
-- `taskId`: Id of the task
-- `params`: Other params for overriding default
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-__Fires__:
-
-- `started` When generation started. Type: `reports.GenerationStartedEvent`.
-- `progress` When generation started. Job's progress is between 0 and 1. Type: `reports.GenerationStartedEvent`.
-
-#### getReportFileByName
-
-```ts
-// Parameter to give to have...
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-// ...matching return type
-type Result = ArrayBuffer | Blob | object | string | Stream
-
-getReportFileByName(pathName: string, namespaces?: string[], responseType: ResultTypes = 'text'): Promise<Result>
-```
-
-Get report main file (the result) by giving the report's name
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `pathName`: Path to the file
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type
-
-#### getReportFileByJob
-
-```ts
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-type Result = ArrayBuffer | Blob | object | string | Stream
-
-getReportFileByJob(queueName: string, jobId: string | number, namespaces?: string[], responseType: Result = 'text'): Promise<Result>
-```
-
-Get report main file (the result) by giving job's info
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` & `namespaces[namespaceId].queues-get-queue-jobs-jobId ` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: Name of the queue
-- `jobId`: Id of the job
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type
-
-#### getReportDetailByName
-
-```ts
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-
-getReportDetailByName(pathName: string, namespaces?: string[], responseType: ResultTypes = 'json'): Promise<reports.ReportResult>
-```
-
-Get report detail by giving the report's name
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `pathName`: Path to the file
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type. **If provided with anything but `json` you will have to cast in your type to avoid auto-completion issues.**
-
-#### getReportDetailByJob
-
-```ts
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-
-getReportDetailByJob(queueName: string, jobId: string | number, namespaces?: string[], responseType: ResultTypes = 'json'): Promise<reports.ReportResult>
-```
-
-Get report detail by giving job's info
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
- * & `namespaces[namespaceId].queues-get-queue-jobs-jobId ` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: Name of the queue
-- `jobId`: Id of the job
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type. **If provided with anything but `json` you will have to cast in your type to avoid auto-completion issues.**
-
-#### getReportDebugByName
-
-```ts
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-type Result = ArrayBuffer | Blob | object | string | Stream
-
-getReportDebugByName(pathName: string, namespaces?: string[], responseType: ResultTypes = 'text'): Promise<Result>
-```
-
-Get report debug file by giving the report's name
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `pathName`: Path to the file
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type
-
-#### getReportDebugByJob
-
-```ts
-type ResultTypes = "arraybuffer" | "blob" | "json" | "text" | "stream"
-type Result = ArrayBuffer | Blob | object | string | Stream
-
-getReportDebugByJob(queueName: string, jobId: string | number, namespaces?: string[], responseType: ResultTypes = 'json'): Promise<Result>
-```
-
-Get report debug file by giving job's info
-
-Needs `namespaces[namespaceId].reports-get-year-yearMonth-filename`
- * & `namespaces[namespaceId].queues-get-queue-jobs-jobId ` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `name`: Name of the queue
-- `jobId`: Id of the job
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-- `responseType`: Wanted response type
-
----
-
-### setup
-
-Methods to setup SDK before using it
-
-#### setURL
-
-```ts
-setURL(url: string): void
-```
-
-Set API url to axios
-
-__Params__:
-
-- `url`: The base URL to ezREEPORT API
-
-#### unsetURL
-
-```ts
-unsetURL(): void
-```
-
-Unset API url from axios
-
-#### isURLset
-
-```ts
-isURLset(): void
-```
-Check if API url is setup in axios
-
-#### login
-
-Same as in [auth module](#login)
-
-#### logout
-
-Same as in [auth module](#logout)
-
-#### isLogged
-
-Same as in [auth module](#isLogged)
-
----
-
-### tasks
-
-#### getAllTasks
-
-```ts
-type P = {
-  /**
-   * Previous id
-   */
-  previous?: string,
-  /**
-   * Wanted count of items
-   */
-  count?: number
-}
-
-getAllTasks(paginationOpts: P, namespaces?: string[]): Promise<PaginatedApiResponse<tasks.Task[]>>
-```
-
-Get all available tasks
-
-Needs `namespaces[namespaceId].tasks-get` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `paginationOpts`: Options for pagination
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### getTask
-
-```ts
-getTask(id: string, namespaces?: string[]): Promise<ApiResponse<tasks.Task>>
-```
-
-Get specific task info
-
-Needs `namespaces[namespaceId].tasks-get-task` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### createTask
-
-```ts
-createTask(data: tasks.InputTask, namespaces?: string[]): Promise<ApiResponse<tasks.FullTask>>
-```
-
-Create a new task with a random UUID
-
-Needs `namespaces[namespaceId].tasks-post-task` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `data`: Task's data
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### upsertTask
-
-```ts
-upsertTask(id: string, data: tasks.InputTask, namespaces?: string[]): Promise<ApiResponse<tasks.FullTask>>
-```
-
-Update or create a task
-
-Needs `namespaces[namespaceId].tasks-put-task` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `data`: Task's data
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### deleteTask
-
-```ts
-deleteTask(id: string, namespaces?: string[]): Promise<void>
-```
-
-Delete specific task
-
-Needs `namespaces[namespaceId].tasks-delete-task` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### enableTask
-
-```ts
-enableTask(id: string, namespaces?: string[]): Promise<ApiResponse<FullTask>>
-```
-
-Shorthand to enable a task
-
-Needs `namespaces[namespaceId].tasks-put-task-enable` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
-#### disableTask
-
-```ts
-disableTask(id: string, namespaces?: string[]): Promise<ApiResponse<FullTask>>
-```
-
-Shorthand to disable a task
-
-Needs `namespaces[namespaceId].tasks-put-task-disable` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `namespaces`: Select which namespaces are concerned by the request. Default to all possible namespaces.
-
----
-
-### templates
-
-#### getAllTemplates
-
-```ts
-getAllTemplates(): Promise<ApiResponse<templates.Template[]>>
-```
-
-Get all available templates
-
-Needs `general.templates-get` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-#### getTemplate
-
-```ts
-getTemplate(name: string): Promise<ApiResponse<templates.Template>>
-```
-
-Needs `general.templates-get-name(*)` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
-
-__Params__:
-
-- `id`: Task's id
-- `data`: Task's data
-
-#### upsertTemplate
-
-```ts
-upsertTemplate(name: string, data: templates.InputTemplate): Promise<ApiResponse<templates.Template>>
+```sh
+npm i --save @ezpaarse-project/ezreeport-sdk-js
 ```
 
-Update or create a template
+## First Usage
 
-Needs `general.templates-put-name(*)` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
+You will need to wrap your app with the `<ezr-provider>` and give some parameters :
 
-__Params__:
+```js
+import * as sdk from '@ezpaarse-project/ezreeport-sdk-js';
 
-- `name`: Template's name
-- `data`: Template's data
+// Set URL to ezREEPORT API
+sdk.setup.setURL('https://url-to-ezreeport.api/');
+// Set token of current user
+sdk.auth.login('mySuperSecretToken');
 
-#### deleteTemplate
+// You can now use sdk
 
-```ts
-deleteTemplate(name: string): Promise<void>
+// Log current user
+sdk.auth.getCurrentUser()
+  .then(({ content }) => { console.log(content); }),
 ```
-Delete a template
 
-Needs `general.templates-delete-name(*)` permission (see [auth::getCurrentPermissions](#getcurrentpermissions) for more info)
+## Documentation
 
-__Params__:
+The documentation is available at ...
 
-- `name`: Template's name
+You can also run `npm run build:docs && npm run docs` to run it on a local server.