@camstack/types 1.2.112 → 1.2.114

package/dist/capabilities/face-gallery.cap.d.ts

@@ -42,6 +42,44 @@ declare const FaceInfoSchema: z.ZodObject<{
     suggestedMatchScore: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type FaceInfo = z.infer<typeof FaceInfoSchema>;
+/**
+ * What a `listRecentFaces` page is ORDERED BY.
+ *
+ *  - `timestamp` — when the face was seen. The historical (and default) order.
+ *  - `suggestionConfidence` — {@link FaceInfo.suggestedMatchScore}, the peak
+ *    cosine of the face's SUGGESTED identity. This is the "review by certainty"
+ *    order: it puts the suggestions an operator can confirm with one tap at the
+ *    top, and it is the reason this enum exists — a client that ranked a capped
+ *    page client-side was ranking the newest N, never the most certain N.
+ *
+ * A row with NO suggestion (`suggestedMatchScore` absent — a legacy row, an
+ * auto-assigned face, or a face below the suggestion band) has no certainty to
+ * compare. Under `suggestionConfidence` it sorts **LAST, in BOTH directions**
+ * — flipping the direction reorders the rows that HAVE a certainty and never
+ * floods the page with the ones that do not. `addon-post-analysis`'s
+ * `store/face-sort.ts` is the single implementation, tiebreaks newest-first
+ * then by faceId, and is what makes this a total order instead of the
+ * backend's NULL-collation accident.
+ */
+declare const FaceSortFieldEnum: z.ZodEnum<{
+    timestamp: "timestamp";
+    suggestionConfidence: "suggestionConfidence";
+}>;
+export type FaceSortField = z.infer<typeof FaceSortFieldEnum>;
+declare const FaceSortDirectionEnum: z.ZodEnum<{
+    asc: "asc";
+    desc: "desc";
+}>;
+export type FaceSortDirection = z.infer<typeof FaceSortDirectionEnum>;
+/** One suggested group of look-alike UNASSIGNED faces. Ids only — an embedding
+ *  never leaves the server. */
+declare const FaceClusterSchema: z.ZodObject<{
+    faceIds: z.ZodReadonly<z.ZodArray<z.ZodString>>;
+    representativeFaceId: z.ZodString;
+    size: z.ZodNumber;
+    cohesion: z.ZodNumber;
+}, z.core.$strip>;
+export type FaceCluster = z.infer<typeof FaceClusterSchema>;
 export declare const faceGalleryCapability: {
     readonly name: "face-gallery";
     readonly scope: "system";
@@ -90,6 +128,7 @@ export declare const faceGalleryCapability: {
         }, z.core.$strip>, z.ZodVoid, "mutation">;
         readonly listRecentFaces: import("./capability-definition.js").CapabilityMethodSchema<z.ZodOptional<z.ZodObject<{
             deviceId: z.ZodOptional<z.ZodNumber>;
+            deviceIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
             limit: z.ZodOptional<z.ZodNumber>;
             filter: z.ZodOptional<z.ZodEnum<{
                 all: "all";
@@ -97,6 +136,16 @@ export declare const faceGalleryCapability: {
                 recognized: "recognized";
                 identified: "identified";
             }>>;
+            since: z.ZodOptional<z.ZodNumber>;
+            until: z.ZodOptional<z.ZodNumber>;
+            sortBy: z.ZodOptional<z.ZodEnum<{
+                timestamp: "timestamp";
+                suggestionConfidence: "suggestionConfidence";
+            }>>;
+            sortDirection: z.ZodOptional<z.ZodEnum<{
+                asc: "asc";
+                desc: "desc";
+            }>>;
             includeCrops: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>>, z.ZodReadonly<z.ZodArray<z.ZodObject<{
             faceId: z.ZodString;
@@ -185,7 +234,9 @@ export declare const faceGalleryCapability: {
         readonly suggestFaceClusters: import("./capability-definition.js").CapabilityMethodSchema<z.ZodOptional<z.ZodObject<{
             threshold: z.ZodOptional<z.ZodNumber>;
             minClusterSize: z.ZodOptional<z.ZodNumber>;
+            maxClusters: z.ZodOptional<z.ZodNumber>;
             limit: z.ZodOptional<z.ZodNumber>;
+            maxFacesScanned: z.ZodOptional<z.ZodNumber>;
         }, z.core.$strip>>, z.ZodReadonly<z.ZodArray<z.ZodObject<{
             faceIds: z.ZodReadonly<z.ZodArray<z.ZodString>>;
             representativeFaceId: z.ZodString;
@@ -195,4 +246,13 @@ export declare const faceGalleryCapability: {
     };
 };
 export type IFaceGalleryProvider = InferProvider<typeof faceGalleryCapability>;
+/**
+ * The inputs, as the PROVIDER sees them.
+ *
+ * Named so an implementation can annotate its methods without re-typing the
+ * shape (`z.infer`, never a hand copy — a duplicated input shape is how a new
+ * field arrives at the router and is dropped by the provider).
+ */
+export type ListRecentFacesInput = z.infer<typeof faceGalleryCapability.methods.listRecentFaces.input>;
+export type SuggestFaceClustersInput = z.infer<typeof faceGalleryCapability.methods.suggestFaceClusters.input>;
 export {};

package/dist/capabilities/index.d.ts

@@ -142,7 +142,7 @@ export { type DoorbellPressEvent, DoorbellPressEventSchema, type DoorbellStatus,
 export { type EnumSensorDateTimeFormat, EnumSensorDateTimeFormatSchema, type EnumSensorStatus, EnumSensorStatusSchema, enumSensorCapability, type IEnumSensorProvider, } from './enum-sensor.cap.js';
 export { type EventEmitterStatus, EventEmitterStatusSchema, type EventFire, EventFireSchema, eventEmitterCapability, type IEventEmitterProvider, } from './event-emitter.cap.js';
 export { EventItemSchema, eventsCapability, type IEventsProvider } from './events.cap.js';
-export { type FaceInfo, faceGalleryCapability, type Identity, type IdentitySampleInfo, type IFaceGalleryProvider, } from './face-gallery.cap.js';
+export { type FaceCluster, type FaceInfo, type FaceSortDirection, type FaceSortField, faceGalleryCapability, type Identity, type IdentitySampleInfo, type IFaceGalleryProvider, type ListRecentFacesInput, type SuggestFaceClustersInput, } from './face-gallery.cap.js';
 export { type FanControlStatus, FanControlStatusSchema, type FanDirection, FanDirectionSchema, fanControlCapability, type IFanControlProvider, } from './fan-control.cap.js';
 export { type FeatureProbeStatus, FeatureProbeStatusSchema, featureProbeCapability, type IFeatureProbeProvider, } from './feature-probe.cap.js';
 export { type FloodStatus, FloodStatusSchema, floodCapability, type IFloodProvider, } from './flood.cap.js';
@@ -189,7 +189,7 @@ export { type CamStreamDescriptor, CamStreamDescriptorSchema, type IStreamCatalo
 export { type IStreamParamsProvider, type StreamParamsOptions, StreamParamsOptionsSchema, type StreamParamsStatus, StreamParamsStatusSchema, type StreamProfile, StreamProfileConfigSchema, StreamProfileOptionsSchema, type StreamProfilePatch, StreamProfilePatchSchema, StreamProfileSchema, streamParamsCapability, } from './stream-params.cap.js';
 export { buildStreamParamsConfigSchema, parseStreamParamsFormPatch, STREAM_PROFILE_META, type StreamProfileMeta, } from './stream-params-config-schema.js';
 export { type ISwitchProvider, type SwitchStatus, SwitchStatusSchema, switchCapability, } from './switch.cap.js';
-export { FeatureManifestSchema, HealthStatusSchema, type ISystemProvider, NetworkAddressSchema, type SetSiteLocationInput, SetSiteLocationInputSchema, type SiteLocation, SiteLocationSchema, type SiteLocationSource, SiteLocationSourceSchema, type SiteLocationStatus, SiteLocationStatusSchema, systemCapability, } from './system.cap.js';
+export { type DiagnosticId, DiagnosticIdSchema, type DiagnosticWindow, type DiagnosticWindowPatch, DiagnosticWindowPatchSchema, DiagnosticWindowSchema, FeatureManifestSchema, type GetLoggingSettingsInput, GetLoggingSettingsInputSchema, HealthStatusSchema, type ISystemProvider, type LoggingEffective, LoggingEffectiveSchema, type LoggingExplicit, LoggingExplicitSchema, type LoggingLevelLayer, LoggingLevelLayerSchema, type LoggingLevelSource, LoggingLevelSourceSchema, type LoggingScopeKind, LoggingScopeKindSchema, type LoggingSettingsPatch, LoggingSettingsPatchSchema, type LoggingSettingsState, LoggingSettingsStateSchema, NetworkAddressSchema, type RequestCensusGroup, RequestCensusGroupSchema, type RequestCensusProcedure, RequestCensusProcedureSchema, type RequestCensusSnapshot, RequestCensusSnapshotSchema, type RequestCensusStatus, RequestCensusStatusSchema, type SetLoggingSettingsInput, SetLoggingSettingsInputSchema, type SetSiteLocationInput, SetSiteLocationInputSchema, type SiteLocation, SiteLocationSchema, type SiteLocationSource, SiteLocationSourceSchema, type SiteLocationStatus, SiteLocationStatusSchema, systemCapability, type TransportPlane, type TransportPlaneCounts, TransportPlaneCountsSchema, TransportPlaneSchema, } from './system.cap.js';
 export { type ITamperProvider, type TamperStatus, TamperStatusSchema, tamperCapability, } from './tamper.cap.js';
 export { type ITemperatureSensorProvider, type TemperatureSensorStatus, TemperatureSensorStatusSchema, temperatureSensorCapability, } from './temperature-sensor.cap.js';
 export { type IToastProvider, ToastSchema, toastCapability } from './toast.cap.js';

package/dist/capabilities/recording.cap.d.ts

@@ -327,6 +327,12 @@ export declare const recordingCapability: {
                 triggers: z.ZodOptional<z.ZodObject<{
                     motion: z.ZodOptional<z.ZodBoolean>;
                     audioThresholdDbfs: z.ZodOptional<z.ZodNumber>;
+                    objectClasses: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                        person: "person";
+                        vehicle: "vehicle";
+                        animal: "animal";
+                    }>>>;
+                    sensorDeviceIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
                 }, z.core.$strip>>;
                 preBufferSec: z.ZodOptional<z.ZodNumber>;
                 postBufferSec: z.ZodOptional<z.ZodNumber>;
@@ -422,6 +428,12 @@ export declare const recordingCapability: {
                     triggers: z.ZodOptional<z.ZodObject<{
                         motion: z.ZodOptional<z.ZodBoolean>;
                         audioThresholdDbfs: z.ZodOptional<z.ZodNumber>;
+                        objectClasses: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                            person: "person";
+                            vehicle: "vehicle";
+                            animal: "animal";
+                        }>>>;
+                        sensorDeviceIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
                     }, z.core.$strip>>;
                     preBufferSec: z.ZodOptional<z.ZodNumber>;
                     postBufferSec: z.ZodOptional<z.ZodNumber>;
@@ -455,6 +467,12 @@ export declare const recordingCapability: {
                 triggers: z.ZodOptional<z.ZodObject<{
                     motion: z.ZodOptional<z.ZodBoolean>;
                     audioThresholdDbfs: z.ZodOptional<z.ZodNumber>;
+                    objectClasses: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                        person: "person";
+                        vehicle: "vehicle";
+                        animal: "animal";
+                    }>>>;
+                    sensorDeviceIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
                 }, z.core.$strip>>;
                 preBufferSec: z.ZodOptional<z.ZodNumber>;
                 postBufferSec: z.ZodOptional<z.ZodNumber>;