feat: add status property for installations

Author: jviide

.changeset/chubby-doodles-stand.md

@@ -0,0 +1,9 @@
+---
+"@badrap/libapp": patch
+---
+
+Add `status` property for installations
+
+The `status` property can have three different values: `"active"`, `"paused"` and `"uninstalled"`.
+
+The old `removed` is now marked as deprecated and will be removed in a future release. For the time being the flag will still be kept around for now for backwards compatibility. Its value will be `true` when `status` is `"uninstalled"`, otherwise `false`.

src/api/index.ts

@@ -15,9 +15,11 @@ export class UpdateFailed extends Error {
 
 export type Installation<State extends Record<string, unknown>> = {
   id: string;
-  removed: boolean;
   state: State;
   owner?: { type: "team"; name: string } | { type: "user"; email: string };
+  status: "active" | "paused" | "uninstalled";
+  /** @deprecated Use status instead. */
+  removed: boolean;
 };
 
 export type Asset = Readonly<{
@@ -127,6 +129,11 @@ export class API<
       responseType: v.object({
         id: v.string(),
         removed: v.boolean(),
+        status: v.union(
+          v.literal("active"),
+          v.literal("paused"),
+          v.literal("uninstalled"),
+        ),
         state: this.#stateType,
         owner: v
           .union(
@@ -158,6 +165,11 @@ export class API<
         responseType: v.object({
           id: v.string(),
           removed: v.boolean(),
+          status: v.union(
+            v.literal("active"),
+            v.literal("paused"),
+            v.literal("uninstalled"),
+          ),
           state: this.#stateType,
           owner: v
             .union(