@camstack/types 0.1.40 → 0.1.41

package/dist/capabilities/storage-evictable.cap.d.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+import { type InferProvider } from './capability-definition.js';
+/**
+ * `storage-evictable` — implemented by any addon that owns evictable data on a
+ * storage location (recordings, event clips, thumbnails, …).
+ *
+ * The core `StoragePressureManager` (in storage-orchestrator) owns the TRIGGER:
+ * it monitors free space per location and, on breach of a location's
+ * `minFreePercent`, asks each evictable provider to free a share of the deficit.
+ * The provider decides WHAT is expendable and does the deletion itself — core
+ * never deletes data it doesn't understand. This inverts control so disk-space
+ * arbitration is one cross-consumer concern, not re-implemented per addon.
+ *
+ * `internal: true` — consumed only by the orchestrator's pressure manager, never
+ * a public client surface.
+ */
+declare const EvictableUsageSchema: z.ZodObject<{
+    bytes: z.ZodNumber;
+}, z.core.$strip>;
+export type EvictableUsage = z.infer<typeof EvictableUsageSchema>;
+declare const EvictResultSchema: z.ZodObject<{
+    reclaimedBytes: z.ZodNumber;
+    exhausted: z.ZodBoolean;
+}, z.core.$strip>;
+export type EvictResult = z.infer<typeof EvictResultSchema>;
+export declare const storageEvictableCapability: {
+    readonly name: "storage-evictable";
+    readonly scope: "system";
+    readonly mode: "collection";
+    readonly internal: true;
+    readonly methods: {
+        /** Bytes this provider holds on the given location — drives proportional fan-out. */
+        readonly getEvictableUsage: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            locationId: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            bytes: z.ZodNumber;
+        }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
+        /**
+         * Free approximately `targetBytes` of this provider's OWN least-valuable
+         * data on the location (oldest footage, expired clips, …). Returns what it
+         * actually reclaimed + whether it is now exhausted.
+         */
+        readonly evict: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
+            locationId: z.ZodString;
+            targetBytes: z.ZodNumber;
+        }, z.core.$strip>, z.ZodObject<{
+            reclaimedBytes: z.ZodNumber;
+            exhausted: z.ZodBoolean;
+        }, z.core.$strip>, "mutation">;
+    };
+};
+export type IStorageEvictableProvider = InferProvider<typeof storageEvictableCapability>;
+export {};
+//# sourceMappingURL=storage-evictable.cap.d.ts.map

package/dist/capabilities/storage-evictable.cap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-evictable.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/storage-evictable.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAqC,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAElG;;;;;;;;;;;;;GAaG;AAEH,QAAA,MAAM,oBAAoB;;iBAGxB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,QAAA,MAAM,iBAAiB;;;iBAKrB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAE3D,eAAO,MAAM,0BAA0B;;;;;;QAMnC,qFAAqF;;;;;;QAKrF;;;;WAIG;;;;;;;;;CAOkC,CAAA;AAEzC,MAAM,MAAM,yBAAyB,GAAG,aAAa,CAAC,OAAO,0BAA0B,CAAC,CAAA"}

package/dist/capabilities/storage-provider.cap.d.ts

@@ -1,24 +1,18 @@
 import { z } from 'zod';
 import { type InferProvider } from './capability-definition.js';
-declare const ProviderInfoSchema: z.ZodObject<{
+declare const ProviderInfoSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     providerId: z.ZodString;
     displayName: z.ZodString;
-    supportedLocationTypes: z.ZodReadonly<z.ZodArray<z.ZodEnum<{
-        data: "data";
-        media: "media";
-        recordings: "recordings";
-        cache: "cache";
-        logs: "logs";
-        models: "models";
-        "recordings-high": "recordings-high";
-        "recordings-low": "recordings-low";
-        "recordings-clips": "recordings-clips";
-        "event-images": "event-images";
-        "addons-data": "addons-data";
-        backups: "backups";
-    }>>>;
     configSchema: z.ZodUnknown;
-}, z.core.$strip>;
+    shouldSaveDiskSpace: z.ZodLiteral<true>;
+    minFreePercent: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+    providerId: z.ZodString;
+    displayName: z.ZodString;
+    configSchema: z.ZodUnknown;
+    shouldSaveDiskSpace: z.ZodLiteral<false>;
+    minFreePercent: z.ZodLiteral<null>;
+}, z.core.$strip>], "shouldSaveDiskSpace">;
 declare const TestLocationResultSchema: z.ZodObject<{
     ok: z.ZodBoolean;
     error: z.ZodOptional<z.ZodString>;
@@ -26,20 +20,7 @@ declare const TestLocationResultSchema: z.ZodObject<{
 declare const BeginUploadInputSchema: z.ZodObject<{
     location: z.ZodObject<{
         id: z.ZodString;
-        type: z.ZodEnum<{
-            data: "data";
-            media: "media";
-            recordings: "recordings";
-            cache: "cache";
-            logs: "logs";
-            models: "models";
-            "recordings-high": "recordings-high";
-            "recordings-low": "recordings-low";
-            "recordings-clips": "recordings-clips";
-            "event-images": "event-images";
-            "addons-data": "addons-data";
-            backups: "backups";
-        }>;
+        type: z.ZodString;
         displayName: z.ZodString;
         providerId: z.ZodString;
         config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -68,20 +49,7 @@ declare const AbortUploadInputSchema: z.ZodObject<{
 declare const BeginDownloadInputSchema: z.ZodObject<{
     location: z.ZodObject<{
         id: z.ZodString;
-        type: z.ZodEnum<{
-            data: "data";
-            media: "media";
-            recordings: "recordings";
-            cache: "cache";
-            logs: "logs";
-            models: "models";
-            "recordings-high": "recordings-high";
-            "recordings-low": "recordings-low";
-            "recordings-clips": "recordings-clips";
-            "event-images": "event-images";
-            "addons-data": "addons-data";
-            backups: "backups";
-        }>;
+        type: z.ZodString;
         displayName: z.ZodString;
         providerId: z.ZodString;
         config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -131,25 +99,19 @@ export declare const storageProviderCapability: {
     readonly internal: true;
     readonly methods: {
         /** Self-description for the "Add location" wizard. */
-        readonly getProviderInfo: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodObject<{
+        readonly getProviderInfo: import("./capability-definition.js").CapabilityMethodSchema<z.ZodVoid, z.ZodDiscriminatedUnion<[z.ZodObject<{
             providerId: z.ZodString;
             displayName: z.ZodString;
-            supportedLocationTypes: z.ZodReadonly<z.ZodArray<z.ZodEnum<{
-                data: "data";
-                media: "media";
-                recordings: "recordings";
-                cache: "cache";
-                logs: "logs";
-                models: "models";
-                "recordings-high": "recordings-high";
-                "recordings-low": "recordings-low";
-                "recordings-clips": "recordings-clips";
-                "event-images": "event-images";
-                "addons-data": "addons-data";
-                backups: "backups";
-            }>>>;
             configSchema: z.ZodUnknown;
-        }, z.core.$strip>, import("./capability-definition.js").CapabilityMethodKind>;
+            shouldSaveDiskSpace: z.ZodLiteral<true>;
+            minFreePercent: z.ZodNumber;
+        }, z.core.$strip>, z.ZodObject<{
+            providerId: z.ZodString;
+            displayName: z.ZodString;
+            configSchema: z.ZodUnknown;
+            shouldSaveDiskSpace: z.ZodLiteral<false>;
+            minFreePercent: z.ZodLiteral<null>;
+        }, z.core.$strip>], "shouldSaveDiskSpace">, import("./capability-definition.js").CapabilityMethodKind>;
         /** Validate config + probe connectivity. Called on add and on edit. */
         readonly testLocation: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -160,20 +122,7 @@ export declare const storageProviderCapability: {
         readonly resolve: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -187,20 +136,7 @@ export declare const storageProviderCapability: {
         readonly write: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -215,20 +151,7 @@ export declare const storageProviderCapability: {
         readonly read: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -242,20 +165,7 @@ export declare const storageProviderCapability: {
         readonly exists: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -269,20 +179,7 @@ export declare const storageProviderCapability: {
         readonly list: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -296,20 +193,7 @@ export declare const storageProviderCapability: {
         readonly delete: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -323,20 +207,7 @@ export declare const storageProviderCapability: {
         readonly getAvailableSpace: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -349,20 +220,7 @@ export declare const storageProviderCapability: {
         readonly beginUpload: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
@@ -390,20 +248,7 @@ export declare const storageProviderCapability: {
         readonly beginDownload: import("./capability-definition.js").CapabilityMethodSchema<z.ZodObject<{
             location: z.ZodObject<{
                 id: z.ZodString;
-                type: z.ZodEnum<{
-                    data: "data";
-                    media: "media";
-                    recordings: "recordings";
-                    cache: "cache";
-                    logs: "logs";
-                    models: "models";
-                    "recordings-high": "recordings-high";
-                    "recordings-low": "recordings-low";
-                    "recordings-clips": "recordings-clips";
-                    "event-images": "event-images";
-                    "addons-data": "addons-data";
-                    backups: "backups";
-                }>;
+                type: z.ZodString;
                 displayName: z.ZodString;
                 providerId: z.ZodString;
                 config: z.ZodRecord<z.ZodString, z.ZodUnknown>;

package/dist/capabilities/storage-provider.cap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage-provider.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/storage-provider.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAqC,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAgBlG,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;iBAKtB,CAAA;AAEF,QAAA,MAAM,wBAAwB;;;iBAG5B,CAAA;AAcF,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI1B,CAAA;AACF,QAAA,MAAM,uBAAuB;;iBAAqC,CAAA;AAClE,QAAA,MAAM,qBAAqB;;;;iBAIzB,CAAA;AACF,QAAA,MAAM,yBAAyB;;iBAAqC,CAAA;AACpE,QAAA,MAAM,sBAAsB;;iBAAqC,CAAA;AAMjE,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG5B,CAAA;AACF,QAAA,MAAM,yBAAyB;;;iBAG7B,CAAA;AACF,QAAA,MAAM,oBAAoB;;;;iBAIxB,CAAA;AACF,QAAA,MAAM,sBAAsB;;iBAAuC,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,yBAAyB;;;;;;QAMlC,sDAAsD;;;;;;;;;;;;;;;;;;;;QAGtD,uEAAuE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoDlC,CAAA;AAEzC,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAElF,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GACvB,CAAA"}
+{"version":3,"file":"storage-provider.cap.d.ts","sourceRoot":"","sources":["../../src/capabilities/storage-provider.cap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAqC,KAAK,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAsBlG,QAAA,MAAM,kBAAkB;;;;;;;;;;;;0CAiBtB,CAAA;AAEF,QAAA,MAAM,wBAAwB;;;iBAG5B,CAAA;AAcF,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;iBAI1B,CAAA;AACF,QAAA,MAAM,uBAAuB;;iBAAqC,CAAA;AAClE,QAAA,MAAM,qBAAqB;;;;iBAIzB,CAAA;AACF,QAAA,MAAM,yBAAyB;;iBAAqC,CAAA;AACpE,QAAA,MAAM,sBAAsB;;iBAAqC,CAAA;AAMjE,QAAA,MAAM,wBAAwB;;;;;;;;;;;;;iBAG5B,CAAA;AACF,QAAA,MAAM,yBAAyB;;;iBAG7B,CAAA;AACF,QAAA,MAAM,oBAAoB;;;;iBAIxB,CAAA;AACF,QAAA,MAAM,sBAAsB;;iBAAuC,CAAA;AAEnE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,yBAAyB;;;;;;QAMlC,sDAAsD;;;;;;;;;;;;;;QAGtD,uEAAuE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoDlC,CAAA;AAEzC,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAElF,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GACvB,CAAA"}