@qodalis/cli-server-jobs 2.4.1 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli-server-jobs",
-  "version": "2.4.1",
+  "version": "2.5.0",
   "description": "Background job management",
   "author": "Qodalis Solutions",
   "license": "MIT",
@@ -18,7 +18,7 @@
   "umd": "./umd/index.global.js",
   "unpkg": "./umd/index.global.js",
   "dependencies": {
-    "@qodalis/cli-core": "2.4.1"
+    "@qodalis/cli-core": "2.5.0"
   },
   "sideEffects": false,
   "main": "./public-api.js",

package/public-api.d.mts

@@ -5,6 +5,8 @@ interface JobDto {
     name: string;
     description: string;
     group?: string;
+    /** Free-form labels to filter jobs by (servers with job tags; missing on older servers). */
+    tags?: string[];
     status: 'active' | 'paused' | 'stopped';
     schedule?: string;
     /** Milliseconds (.NET, Node) or a span such as `30s` (Python). */
@@ -53,6 +55,8 @@ interface JobHistoryResponse {
 interface UpdateJobRequest {
     description?: string;
     group?: string;
+    /** Replaces the job's tags; `null` clears them. */
+    tags?: string[] | null;
     schedule?: string;
     interval?: string;
     maxRetries?: number;
@@ -115,12 +119,24 @@ declare class CliJobNameCompletionProvider implements ICliCompletionProvider {
     getCompletions(context: ICliCompletionContext): Promise<string[]>;
 }
 
+/** Whether the job has every tag in `tags`, ignoring case. */
+declare function jobHasTags(job: JobDto, tags: string[]): boolean;
+/**
+ * The tags of a `--tag` option: repeated (`--tag a --tag b`) or comma-separated (`--tag a,b`),
+ * trimmed, empty ones dropped.
+ */
+declare function parseTagArgs(value: unknown): string[];
 declare class CliJobsService {
     private baseUrl;
     private headers;
     constructor(baseUrl: string, headers?: Record<string, string>);
     private request;
-    listJobs(): Promise<JobDto[]>;
+    /**
+     * The jobs; with `tags`, only those that have every tag (ignoring case). The server filters
+     * (`?tag=`), and the list is filtered here too, so a server without job tags lists nothing
+     * for a tag filter instead of every job.
+     */
+    listJobs(tags?: string[]): Promise<JobDto[]>;
     getJob(id: string): Promise<JobDto>;
     triggerJob(id: string): Promise<void>;
     pauseJob(id: string): Promise<void>;
@@ -136,10 +152,10 @@ declare class CliJobsService {
     getExecution(jobId: string, execId: string): Promise<JobExecutionDto>;
 }
 
-declare const LIBRARY_VERSION = "2.4.1";
+declare const LIBRARY_VERSION = "2.5.0";
 declare const API_VERSION = 2;
 
 declare const jobsModule: ICliModule;
 
-export { API_VERSION, CliJobNameCompletionProvider, CliJobsCommandProcessor, CliJobsService, LIBRARY_VERSION, formatRunning, formatSpan, jobsModule };
+export { API_VERSION, CliJobNameCompletionProvider, CliJobsCommandProcessor, CliJobsService, LIBRARY_VERSION, formatRunning, formatSpan, jobHasTags, jobsModule, parseTagArgs };
 export type { JobDto, JobExecutionDto, JobHistoryResponse, JobLogEntryDto, UpdateJobRequest };

package/public-api.d.ts

@@ -5,6 +5,8 @@ interface JobDto {
     name: string;
     description: string;
     group?: string;
+    /** Free-form labels to filter jobs by (servers with job tags; missing on older servers). */
+    tags?: string[];
     status: 'active' | 'paused' | 'stopped';
     schedule?: string;
     /** Milliseconds (.NET, Node) or a span such as `30s` (Python). */
@@ -53,6 +55,8 @@ interface JobHistoryResponse {
 interface UpdateJobRequest {
     description?: string;
     group?: string;
+    /** Replaces the job's tags; `null` clears them. */
+    tags?: string[] | null;
     schedule?: string;
     interval?: string;
     maxRetries?: number;
@@ -115,12 +119,24 @@ declare class CliJobNameCompletionProvider implements ICliCompletionProvider {
     getCompletions(context: ICliCompletionContext): Promise<string[]>;
 }
 
+/** Whether the job has every tag in `tags`, ignoring case. */
+declare function jobHasTags(job: JobDto, tags: string[]): boolean;
+/**
+ * The tags of a `--tag` option: repeated (`--tag a --tag b`) or comma-separated (`--tag a,b`),
+ * trimmed, empty ones dropped.
+ */
+declare function parseTagArgs(value: unknown): string[];
 declare class CliJobsService {
     private baseUrl;
     private headers;
     constructor(baseUrl: string, headers?: Record<string, string>);
     private request;
-    listJobs(): Promise<JobDto[]>;
+    /**
+     * The jobs; with `tags`, only those that have every tag (ignoring case). The server filters
+     * (`?tag=`), and the list is filtered here too, so a server without job tags lists nothing
+     * for a tag filter instead of every job.
+     */
+    listJobs(tags?: string[]): Promise<JobDto[]>;
     getJob(id: string): Promise<JobDto>;
     triggerJob(id: string): Promise<void>;
     pauseJob(id: string): Promise<void>;
@@ -136,10 +152,10 @@ declare class CliJobsService {
     getExecution(jobId: string, execId: string): Promise<JobExecutionDto>;
 }
 
-declare const LIBRARY_VERSION = "2.4.1";
+declare const LIBRARY_VERSION = "2.5.0";
 declare const API_VERSION = 2;
 
 declare const jobsModule: ICliModule;
 
-export { API_VERSION, CliJobNameCompletionProvider, CliJobsCommandProcessor, CliJobsService, LIBRARY_VERSION, formatRunning, formatSpan, jobsModule };
+export { API_VERSION, CliJobNameCompletionProvider, CliJobsCommandProcessor, CliJobsService, LIBRARY_VERSION, formatRunning, formatSpan, jobHasTags, jobsModule, parseTagArgs };
 export type { JobDto, JobExecutionDto, JobHistoryResponse, JobLogEntryDto, UpdateJobRequest };

package/public-api.js

@@ -5,6 +5,14 @@ var cliCore = require('@qodalis/cli-core');
 // src/lib/processors/cli-jobs-command-processor.ts
 
 // src/lib/services/cli-jobs-service.ts
+function jobHasTags(job, tags) {
+  const own = new Set((job.tags ?? []).map((t) => t.toLowerCase()));
+  return tags.every((t) => own.has(t.toLowerCase()));
+}
+function parseTagArgs(value) {
+  const values = Array.isArray(value) ? value : value === void 0 || value === null || value === true ? [] : [value];
+  return values.flatMap((v) => String(v).split(",")).map((t) => t.trim()).filter(Boolean);
+}
 var CliJobsService = class {
   constructor(baseUrl, headers = {}) {
     this.baseUrl = baseUrl;
@@ -37,8 +45,15 @@ var CliJobsService = class {
     }
     return JSON.parse(text);
   }
-  async listJobs() {
-    return this.request("");
+  /**
+   * The jobs; with `tags`, only those that have every tag (ignoring case). The server filters
+   * (`?tag=`), and the list is filtered here too, so a server without job tags lists nothing
+   * for a tag filter instead of every job.
+   */
+  async listJobs(tags = []) {
+    const query = tags.map((t) => `tag=${encodeURIComponent(t)}`).join("&");
+    const jobs = await this.request(query ? `?${query}` : "");
+    return tags.length ? jobs.filter((j) => jobHasTags(j, tags)) : jobs;
   }
   async getJob(id) {
     return this.request(`/${encodeURIComponent(id)}`);
@@ -186,6 +201,9 @@ function formatRunning(job) {
   if (job.queued) parts.push("1 queued");
   return parts.join(", ");
 }
+function formatTags(tags) {
+  return tags && tags.length > 0 ? tags.join(", ") : "-";
+}
 function formatDuration(ms) {
   if (ms == null) return "-";
   if (ms < 1e3) return `${ms}ms`;
@@ -283,12 +301,14 @@ var CliJobsCommandProcessor = class {
               context.writer.writeln();
               cliCore.writeUsage(context, [
                 ["server jobs list", t.t("cli.server.jobs.list.help.jobs_all_connected_servers", "Jobs on all connected servers")],
-                ["server jobs ls --group <name>", t.t("cli.server.jobs.list.help.only_one_group", "Only one group")]
+                ["server jobs ls --group <name>", t.t("cli.server.jobs.list.help.only_one_group", "Only one group")],
+                ["server jobs ls --tag <tag> [--tag <tag>]", t.t("cli.server.jobs.list.help.only_tagged", "Only the jobs that have every tag given")]
               ]);
               context.writer.writeln();
               cliCore.writeExamples(context, [
                 ["server jobs ls --server node", t.t("cli.server.jobs.list.help.jobs_node_server", "Jobs on the node server")],
-                ["server jobs list --group reports", t.t("cli.server.jobs.list.help.jobs_reports_group", "Jobs in the reports group")]
+                ["server jobs list --group reports", t.t("cli.server.jobs.list.help.jobs_reports_group", "Jobs in the reports group")],
+                ["server jobs list --tag country:ro --tag bank", t.t("cli.server.jobs.list.help.jobs_tagged", "Jobs tagged both country:ro and bank")]
               ]);
             },
             aliases: ["ls"],
@@ -299,6 +319,12 @@ var CliJobsCommandProcessor = class {
                 description: "Filter jobs by group",
                 required: false,
                 type: "string"
+              },
+              {
+                name: "tag",
+                description: "Only jobs that have this tag (repeatable or comma-separated; every tag must match)",
+                required: false,
+                type: "array"
               }
             ],
             processCommand: async (cmd, context) => {
@@ -613,10 +639,11 @@ var CliJobsCommandProcessor = class {
       return;
     }
     const groupFilter = cmd.args["group"];
+    const tagFilter = parseTagArgs(cmd.args["tag"]);
     const multiServer = services.length > 1;
     for (const { name, service } of services) {
       try {
-        let jobs = await service.listJobs();
+        let jobs = await service.listJobs(tagFilter);
         if (groupFilter) {
           jobs = jobs.filter(
             (j) => j.group?.toLowerCase() === groupFilter.toLowerCase()
@@ -634,9 +661,11 @@ var CliJobsCommandProcessor = class {
           context.writer.writeInfo("  No jobs found.");
           continue;
         }
+        const showTags = jobs.some((j) => (j.tags?.length ?? 0) > 0);
         const headers = [
           "Name",
           "Group",
+          ...showTags ? ["Tags"] : [],
           "Status",
           "Schedule",
           "Last Run",
@@ -646,6 +675,7 @@ var CliJobsCommandProcessor = class {
         const rows = jobs.map((j) => [
           j.name,
           j.group ?? "-",
+          ...showTags ? [formatTags(j.tags)] : [],
           statusColor(j.status, context.writer),
           j.schedule ?? (formatSpan(j.interval) ? `every ${formatSpan(j.interval)}` : "-"),
           formatRelativeTime(j.lastRunAt),
@@ -682,6 +712,7 @@ var CliJobsCommandProcessor = class {
         ["Name", job.name],
         ["Description", job.description],
         ["Group", job.group ?? "-"],
+        ["Tags", formatTags(job.tags)],
         ["Status", statusColor(job.status, context.writer)],
         [
           "Schedule",
@@ -938,6 +969,10 @@ var CliJobsCommandProcessor = class {
       const newGroup = await ask(`Group [${job.group ?? "none"}]: `);
       if (newGroup == null) return cancelled();
       if (newGroup) update.group = newGroup;
+      const newTags = await ask(`Tags, comma-separated, - for none [${formatTags(job.tags)}]: `);
+      if (newTags == null) return cancelled();
+      if (newTags.trim() === "-") update.tags = null;
+      else if (newTags.trim()) update.tags = parseTagArgs(newTags);
       const currentSchedule = job.schedule ?? (formatSpan(job.interval) ? `interval: ${formatSpan(job.interval)}` : "none");
       const newSchedule = await ask(
         `Cron schedule [${currentSchedule}]: `
@@ -1218,7 +1253,7 @@ var CliJobNameCompletionProvider = class {
 };
 
 // src/lib/version.ts
-var LIBRARY_VERSION = "2.4.1";
+var LIBRARY_VERSION = "2.5.0";
 var API_VERSION = 2;
 var completionProvider = new CliJobNameCompletionProvider();
 var jobsModule = {
@@ -1244,6 +1279,8 @@ exports.CliJobsService = CliJobsService;
 exports.LIBRARY_VERSION = LIBRARY_VERSION;
 exports.formatRunning = formatRunning;
 exports.formatSpan = formatSpan;
+exports.jobHasTags = jobHasTags;
 exports.jobsModule = jobsModule;
+exports.parseTagArgs = parseTagArgs;
 //# sourceMappingURL=public-api.js.map
 //# sourceMappingURL=public-api.js.map