Software Management. Full API + Interaction with Fleet

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/DispatchResponse.java

@@ -3,16 +3,6 @@
 import lombok.Builder;
 import lombok.Data;
 
-/**
- * Result of a fire-and-forget RMM dispatch over core NATS — running a command,
- * cancelling an in-flight execution, or running a saved script. Carries the
- * server-minted {@code executionId} the dashboard uses to correlate the agent's
- * asynchronous result.
- *
- * <p>Shared by all dispatch mutations ({@code runCommand}, {@code cancelExecution},
- * {@code runScript}): they are structurally identical, so a single type avoids
- * three duplicate one-field DTOs.
- */
 @Data
 @Builder
 public class DispatchResponse {

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/script/ScriptFilterOption.java

@@ -5,11 +5,6 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-/**
- * One option for a scripts-list filter dropdown: the raw {@code value} to filter by,
- * a human {@code label} to show, and the {@code count} of matching scripts. Mirrors
- * {@code DeviceFilterOption}.
- */
 @Data
 @Builder
 @NoArgsConstructor

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/CreateSoftwareBundleInput.java

@@ -0,0 +1,31 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.rmm.software.SoftwareAction;
+import com.openframe.data.document.rmm.software.SoftwareBundleMode;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Pattern;
+import lombok.Data;
+
+import java.time.Instant;
+import java.util.List;
+
+@Data
+public class CreateSoftwareBundleInput {
+
+    @NotNull(message = "action must not be null")
+    private SoftwareAction action;
+
+    @NotNull(message = "mode must not be null")
+    private SoftwareBundleMode mode;
+
+    @NotEmpty(message = "machineIds must not be empty")
+    private List<@Pattern(regexp = "^[A-Za-z0-9_-]+$",
+            message = "each machineId must be a single subject-safe token (A-Za-z0-9_-)") String> machineIds;
+
+    @Valid
+    private List<SoftwarePackageInput> packages;
+
+    private Instant startAt;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionDeviceFilterInput.java

@@ -0,0 +1,13 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.rmm.software.SoftwareActionStatus;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class SoftwareActionDeviceFilterInput {
+
+    private List<SoftwareActionStatus> statuses;
+    private List<String> organizationIds;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionDeviceResponse.java

@@ -0,0 +1,28 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.rmm.software.SoftwareActionStatus;
+import lombok.Builder;
+import lombok.Data;
+
+import java.time.Instant;
+
+@Data
+@Builder
+public class SoftwareActionDeviceResponse {
+
+    private String machineId;
+    private String hostname;
+    private String organizationId;
+    private String organizationName;
+    private SoftwareActionStatus status;
+
+    private Integer exitCode;
+    private String stdout;
+    private Boolean stdoutTruncated;
+    private String stderr;
+    private Boolean stderrTruncated;
+    private String error;
+
+    private Instant dispatchedAt;
+    private Instant finishedAt;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionFilterInput.java

@@ -0,0 +1,16 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.packagesearch.PackageManagerType;
+import com.openframe.data.document.rmm.software.SoftwareAction;
+import com.openframe.data.document.rmm.software.SoftwareActionStatus;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class SoftwareActionFilterInput {
+
+    private List<SoftwareActionStatus> statuses;
+    private List<SoftwareAction> actions;
+    private List<PackageManagerType> engines;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionFilters.java

@@ -0,0 +1,21 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.api.dto.rmm.script.ScriptFilterOption;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.util.List;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class SoftwareActionFilters {
+
+    private List<ScriptFilterOption> statuses;
+    private List<ScriptFilterOption> actions;
+    private List<ScriptFilterOption> engines;
+    private Integer filteredCount;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionId.java

@@ -0,0 +1,41 @@
+package com.openframe.api.dto.rmm.software;
+
+import java.nio.charset.StandardCharsets;
+import java.util.Base64;
+
+public record SoftwareActionId(String executionId, String bundleId, String scheduleId) {
+
+    private static final String SEP = ":"; // absent in UUIDs / Mongo ObjectIds, and not regex-special
+
+    public String encode() {
+        String raw = nullToEmpty(executionId) + SEP + nullToEmpty(bundleId) + SEP + nullToEmpty(scheduleId);
+        return Base64.getUrlEncoder().withoutPadding().encodeToString(raw.getBytes(StandardCharsets.UTF_8));
+    }
+
+    public static SoftwareActionId of(String executionId, String bundleId, String scheduleId) {
+        return new SoftwareActionId(executionId, bundleId, scheduleId);
+    }
+
+    public static SoftwareActionId decode(String actionId) {
+        if (actionId == null || actionId.isBlank()) {
+            return new SoftwareActionId(null, null, null);
+        }
+        try {
+            String raw = new String(Base64.getUrlDecoder().decode(actionId), StandardCharsets.UTF_8);
+            String[] parts = raw.split(SEP, -1);
+            if (parts.length == 3) {
+                return new SoftwareActionId(emptyToNull(parts[0]), emptyToNull(parts[1]), emptyToNull(parts[2]));
+            }
+        } catch (IllegalArgumentException ignored) {
+        }
+        return new SoftwareActionId(actionId, null, null);
+    }
+
+    private static String nullToEmpty(String s) {
+        return s == null ? "" : s;
+    }
+
+    private static String emptyToNull(String s) {
+        return s == null || s.isEmpty() ? null : s;
+    }
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareActionResponse.java

@@ -0,0 +1,33 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.packagesearch.PackageManagerType;
+import com.openframe.data.document.rmm.software.SoftwareAction;
+import com.openframe.data.document.rmm.software.SoftwareActionStatus;
+import lombok.Builder;
+import lombok.Data;
+
+import java.time.Instant;
+
+@Data
+@Builder
+public class SoftwareActionResponse {
+
+    private String id;
+    private String executionId;
+
+    private String software;
+    private SoftwareAction action;
+    private PackageManagerType engine;
+    private SoftwareActionStatus status;
+
+    private int totalMachineCount;
+    private int respondedMachineCount;
+
+    private Instant scheduledAt;
+    private Instant dispatchedAt;
+    private Instant finishedAt;
+    private String initiatedBy;
+
+    private String bundleId;
+    private String scheduleId;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareBundleResponse.java

@@ -0,0 +1,30 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.rmm.software.SoftwareAction;
+import com.openframe.data.document.rmm.software.SoftwareBundleMode;
+import com.openframe.data.document.rmm.software.SoftwareBundlePackage;
+import com.openframe.data.document.rmm.software.SoftwareBundleStatus;
+import lombok.Builder;
+import lombok.Data;
+
+import java.time.Instant;
+import java.util.List;
+
+@Data
+@Builder
+public class SoftwareBundleResponse {
+
+    private String id;
+    private SoftwareAction action;
+    private SoftwareBundleMode mode;
+    private SoftwareBundleStatus status;
+    private List<String> machineIds;
+    private List<SoftwareBundlePackage> packages;
+    private Instant startAt;
+    private String scheduleId;
+    private String createdBy;
+    private Instant createdAt;
+    private Instant updatedAt;
+    private Instant completedAt;
+    private List<String> executionIds;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareBundleScheduleInput.java

@@ -0,0 +1,23 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.rmm.schedule.ScheduleOfflineBehavior;
+import com.openframe.data.document.rmm.schedule.ScheduleTimeReference;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+import java.time.Instant;
+
+@Data
+public class SoftwareBundleScheduleInput {
+
+    private String name;
+    private String description;
+    private ScheduleTimeReference timeReference;
+    private ScheduleOfflineBehavior offlineBehavior;
+    private Long reconnectWindowSeconds;
+
+    @NotNull(message = "startAt is required")
+    private Instant startAt;
+
+    private Long repeat;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareCveSeverity.java

@@ -0,0 +1,9 @@
+package com.openframe.api.dto.rmm.software;
+
+public enum SoftwareCveSeverity {
+    CRITICAL,
+    HIGH,
+    MEDIUM,
+    LOW,
+    NONE
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareFilterInput.java

@@ -0,0 +1,17 @@
+package com.openframe.api.dto.rmm.software;
+
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class SoftwareFilterInput {
+
+    private List<SoftwareSource> sources;
+
+    private List<SoftwareVersionStatus> versionStatuses;
+
+    private SoftwareCveSeverity minSeverity;
+
+    private List<String> deviceTagIds;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareFilterOption.java

@@ -0,0 +1,13 @@
+package com.openframe.api.dto.rmm.software;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+public class SoftwareFilterOption {
+
+    private String value;
+    private String label;
+    private int count;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareFilters.java

@@ -0,0 +1,23 @@
+package com.openframe.api.dto.rmm.software;
+
+import lombok.Builder;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+@Builder
+public class SoftwareFilters {
+
+    private List<SoftwareFilterOption> sources;
+    private List<SoftwareFilterOption> versionStatuses;
+    private List<SoftwareFilterOption> severities;
+
+    public static SoftwareFilters empty() {
+        return SoftwareFilters.builder()
+                .sources(List.of())
+                .versionStatuses(List.of())
+                .severities(List.of())
+                .build();
+    }
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareOnDeviceResponse.java

@@ -0,0 +1,14 @@
+package com.openframe.api.dto.rmm.software;
+
+import com.openframe.data.document.device.Machine;
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+public class SoftwareOnDeviceResponse {
+
+    private Machine device;
+    private String softwareVersion;
+    private SoftwareOnDeviceStatus status;
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareOnDeviceStatus.java

@@ -0,0 +1,9 @@
+package com.openframe.api.dto.rmm.software;
+
+public enum SoftwareOnDeviceStatus {
+    UP_TO_DATE,
+    OUTDATED,
+    SCHEDULED_UPDATE,
+    UNINSTALLING,
+    SCHEDULED_UNINSTALL
+}

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwarePackageInput.java

@@ -15,6 +15,6 @@ public class SoftwarePackageInput {
     @NotBlank
     private String packageName;
 
-    /** Brew-only sub-type (CASK/FORMULA). Required for brew (enforced by its handler), ignored by managers that do not distinguish. */
     private BrewPackageType brewPackageType;
+    private String version;
 }

openframe-api-lib/src/main/java/com/openframe/api/dto/rmm/software/SoftwareResponse.java

@@ -0,0 +1,24 @@
+package com.openframe.api.dto.rmm.software;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class SoftwareResponse {
+    private String id;
+    private String name;
+    private String publisher;
+    private SoftwareSource source;
+    private String currentVersion;
+    private String latestVersion;
+    private SoftwareVersionStatus versionStatus;
+    private Integer olderVersionsCount;
+    private Integer devicesCount;
+    private SoftwareVulnerabilitySummaryResponse vulnerabilitySummary;
+    private Boolean cpeMatched;
+}