@adminforth/background-jobs 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build.log CHANGED
@@ -11,5 +11,5 @@ custom/StateToIcon.vue
11
11
  custom/tsconfig.json
12
12
  custom/utils.ts
13
13
 
14
- sent 11,397 bytes received 134 bytes 23,062.00 bytes/sec
14
+ sent 11,390 bytes received 134 bytes 23,048.00 bytes/sec
15
15
  total size is 10,912 speedup is 0.95
package/dist/index.js CHANGED
@@ -123,16 +123,16 @@ export default class extends AdminForthPlugin {
123
123
  return Promise.resolve(null);
124
124
  });
125
125
  }
126
- registerTaskHandler(jobHandlerName, handler, customComponent, parrallelLimit = 3) {
126
+ registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3, }) {
127
127
  //register the handler in a map with jobHandlerName as key and handler as value
128
128
  this.taskHandlers[jobHandlerName] = handler;
129
- this.jobParallelLimits[jobHandlerName] = parrallelLimit;
130
- if (customComponent) {
131
- this.jobCustomComponents[jobHandlerName] = customComponent;
132
- }
129
+ this.jobParallelLimits[jobHandlerName] = parallelLimit;
130
+ }
131
+ registerTaskDetailsComponent({ jobHandlerName, component, }) {
132
+ this.jobCustomComponents[jobHandlerName] = component;
133
133
  }
134
- startNewJob(jobName_1, adminUser_1, tasks_1) {
135
- return __awaiter(this, arguments, void 0, function* (jobName, adminUser, tasks, initialFields = {}, jobHandlerName) {
134
+ startNewJob(jobName, adminUser, tasks, jobHandlerName) {
135
+ return __awaiter(this, void 0, void 0, function* () {
136
136
  const handleTask = this.taskHandlers[jobHandlerName];
137
137
  if (!handleTask) {
138
138
  throw new Error(`No handler registered for jobHandler ${jobHandlerName}. Please register a handler using the registerTaskHandler method before starting a job with this jobHandler.`);
@@ -143,7 +143,6 @@ export default class extends AdminForthPlugin {
143
143
  const objectToSave = {
144
144
  [this.options.nameField]: jobName,
145
145
  [this.options.startedByField]: adminUser.pk,
146
- [this.options.stateField]: JSON.stringify(initialFields),
147
146
  [this.options.progressField]: 0,
148
147
  [this.options.statusField]: 'IN_PROGRESS',
149
148
  [this.options.jobHandlerField]: jobHandlerName,
package/index.ts CHANGED
@@ -127,25 +127,24 @@ export default class extends AdminForthPlugin {
127
127
  return Promise.resolve(null);
128
128
  }
129
129
 
130
- public registerTaskHandler(
131
- jobHandlerName: string,
132
- handler: taskHandlerType,
133
- customComponent?: AdminForthComponentDeclarationFull,
134
- parrallelLimit: number = 3,
135
- ) {
130
+ public registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3,
131
+ }:{jobHandlerName: string, handler: taskHandlerType, parallelLimit?: number}) {
136
132
  //register the handler in a map with jobHandlerName as key and handler as value
137
133
  this.taskHandlers[jobHandlerName] = handler;
138
- this.jobParallelLimits[jobHandlerName] = parrallelLimit;
139
- if (customComponent) {
140
- this.jobCustomComponents[jobHandlerName] = customComponent;
141
- }
134
+ this.jobParallelLimits[jobHandlerName] = parallelLimit;
135
+ }
136
+
137
+ public registerTaskDetailsComponent({
138
+ jobHandlerName,
139
+ component,
140
+ }:{jobHandlerName: string, component: AdminForthComponentDeclarationFull}) {
141
+ this.jobCustomComponents[jobHandlerName] = component;
142
142
  }
143
143
 
144
144
  public async startNewJob(
145
145
  jobName: string,
146
146
  adminUser: AdminUser,
147
147
  tasks: taskType[],
148
- initialFields: Record<string, any> = {},
149
148
  jobHandlerName: string,
150
149
  ) {
151
150
 
@@ -159,7 +158,6 @@ export default class extends AdminForthPlugin {
159
158
  const objectToSave = {
160
159
  [this.options.nameField]: jobName,
161
160
  [this.options.startedByField]: adminUser.pk,
162
- [this.options.stateField]: JSON.stringify(initialFields),
163
161
  [this.options.progressField]: 0,
164
162
  [this.options.statusField]: 'IN_PROGRESS',
165
163
  [this.options.jobHandlerField]: jobHandlerName,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adminforth/background-jobs",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "type": "module",