@enonic-types/lib-task - npm Package Compare versions

Comparing version 7.11.0-B1 to 7.11.0-B3

package.json

 {
     "name": "@enonic-types/lib-task",
-    "version": "7.11.0-B1",
+    "version": "7.11.0-B3",
     "description": "Type definitions for lib-task.",
@@ -29,2 +29,5 @@ "types": "task.d.ts",
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "dependencies": {
+        "@enonic-types/core": "7.11.0-B3"
+    },
     "publishConfig": {
@@ -31,0 +34,0 @@ "access": "public"

README.md

@@ -8,3 +8,3 @@ # Enonic XP lib-task TS types
 ```bash
-npm i --save-dev @enonic/lib-task
+npm i --save-dev @enonic-types/lib-task
 ```
@@ -30,4 +30,4 @@
 
-To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP global
-objects, e.g. `log`, `app`, `__`, etc, requiring library by the default path will return typed object.
+To make `require` work out of the box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
+global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default path will return typed object.
 
@@ -54,3 +54,3 @@ `tsconfig.json`
 More detailed explanation on how it works and how to type custom import function can be
-found [here](https://github.com/enonic/xp/tree/master/modules/lib/typescript/README.md).
+found [here](https://developer.enonic.com/docs/xp/stable/api).
 
@@ -57,0 +57,0 @@ ### ES6-style import

task.d.ts

@@ -14,2 +14,4 @@ /**
 }
+import type { UserKey } from '@enonic-types/core';
+export type { UserKey } from '@enonic-types/core';
 export declare type CallbackFn = () => void;
@@ -27,3 +29,3 @@ export interface SubmitParams {
  * @type Object
- * @property {string} id Task Id.
+ * @property {string} id Task ID.
  * @property {string} name Task name.
@@ -70,5 +72,5 @@ * @property {string} description Task description.
 export declare function executeFunction(params: ExecuteFunctionParams): string;
-export interface SubmitNamedTaskParams {
+export interface SubmitNamedTaskParams<Config extends object = Record<string, unknown>> {
     name: string;
-    config?: Record<string, unknown> | null;
+    config?: Config;
 }
@@ -90,6 +92,6 @@ /**
  */
-export declare function submitNamed(params: SubmitNamedTaskParams): string;
-export interface SubmitTaskParams {
+export declare function submitNamed<Config extends object = Record<string, unknown>>(params: SubmitNamedTaskParams<Config>): string;
+export interface SubmitTaskParams<Config extends object = Record<string, unknown>> {
     descriptor: string;
-    config?: Record<string, unknown>;
+    config?: Config;
 }
@@ -109,3 +111,3 @@ /**
  */
-export declare function submitTask(params: SubmitTaskParams): string;
+export declare function submitTask<Config extends object = Record<string, unknown>>(params: SubmitTaskParams<Config>): string;
 export declare type TaskStateType = 'WAITING' | 'RUNNING' | 'FINISHED' | 'FAILED';
@@ -127,3 +129,3 @@ export interface ListTasksParams {
     application: string;
-    user: string;
+    user: UserKey;
     startTime: string;
@@ -130,0 +132,0 @@ progress: TaskProgress;

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9796

increased by3.5%

Lines of code

182

increased by1.11%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Added@enonic-types/core@7.11.0-B3

• + Added@enonic-types/core@7.11.0-B3(transitive)