@framers/agentos 0.9.34 → 0.9.36

package/dist/io/segmentation/types.d.ts

@@ -0,0 +1,134 @@
+/**
+ * @module io/segmentation/types
+ *
+ * Type definitions for provider-agnostic image segmentation.
+ *
+ * The segmentation surface takes an image plus exactly one prompt (text,
+ * points, box, or automatic "segment everything") and returns one
+ * {@link SegmentMask} per detected region. Masks are encoded white=object /
+ * black=background so they drop straight into the image-editing `mask` input.
+ *
+ * @see {@link ISegmentationProvider} for the provider contract.
+ */
+/** Identifier for a segmentation backend. */
+export type SegmentationProviderId = 'replicate' | (string & {});
+/** Which kind of prompt drives the segmentation. Exactly one per call. */
+export type SegmentationMode = 'text' | 'points' | 'box' | 'automatic';
+/** A click point for point-prompted segmentation. */
+export interface SegmentationPoint {
+    x: number;
+    y: number;
+    /** Defaults to `'foreground'` during normalization. */
+    label?: 'foreground' | 'background';
+}
+/** An axis-aligned box in image pixels (top-left origin). */
+export interface SegmentationBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/** Per-provider passthrough options for the Replicate backend. */
+export interface ReplicateSegmentationOptions {
+    /** Override the SAM2 model slug used for geometric prompts. */
+    samModelId?: string;
+    /** Override the GroundedSAM model slug used for text prompts. */
+    groundedSamModelId?: string;
+    /** Poll interval in milliseconds (default 1000). */
+    pollIntervalMs?: number;
+    /** Overall timeout in milliseconds (default 120000). */
+    timeoutMs?: number;
+    /** Extra fields merged verbatim into the Replicate `input`. */
+    input?: Record<string, unknown>;
+}
+/** Namespaced bag of per-provider options. */
+export interface SegmentationProviderOptionBag {
+    replicate?: ReplicateSegmentationOptions;
+    [providerId: string]: unknown;
+}
+/** Public options accepted by the high-level {@link segment} helper. */
+export interface SegmentOptions {
+    /** Source image as raw bytes or a file path. */
+    image: Buffer | Uint8Array | string;
+    /** Provider id. Defaults to `'replicate'`. */
+    provider?: SegmentationProviderId;
+    /** Model id override. Provider default is used when omitted. */
+    model?: string;
+    /** Open-vocabulary text prompt (routes to GroundedSAM). */
+    prompt?: string;
+    /** Point prompts (foreground/background clicks). */
+    points?: SegmentationPoint[];
+    /** Bounding-box prompt. */
+    box?: SegmentationBox;
+    /** "Segment everything" when `true`. */
+    automatic?: boolean;
+    /** Cap on returned masks (automatic/text can produce many). */
+    maxMasks?: number;
+    /** Confidence floor; masks scoring below this are dropped. */
+    minScore?: number;
+    /** Provider-specific passthrough options. */
+    providerOptions?: SegmentationProviderOptionBag | Record<string, unknown>;
+    /** Caller id for usage tracking. */
+    userId?: string;
+}
+/** A single segmented region. */
+export interface SegmentMask {
+    /** PNG bytes; white(255)=object, black(0)=background (matches editImage mask). */
+    mask: Buffer;
+    /** Tight bounding box in source-image pixels, top-left origin. */
+    bbox: SegmentationBox;
+    /** Model confidence 0–1 (1 when the model reports none). */
+    score: number;
+    /** Grounding phrase for text prompts; undefined for geometric/automatic. */
+    label?: string;
+    /** Stable index within the result. */
+    index: number;
+}
+/** Aggregated segmentation result. */
+export interface SegmentationResult {
+    masks: SegmentMask[];
+    /** Source image width in pixels (so bboxes/masks are interpretable). */
+    width: number;
+    /** Source image height in pixels. */
+    height: number;
+    providerId: string;
+    modelId: string;
+    promptMode: SegmentationMode;
+    usage?: {
+        totalMasks: number;
+        totalCostUSD?: number;
+    };
+    durationMs: number;
+}
+/**
+ * Normalized provider-level request produced by the {@link segment} helper
+ * from {@link SegmentOptions}. The image is already a `Buffer`, exactly one
+ * `mode` is resolved, and point labels are defaulted.
+ */
+export interface SegmentationRequest {
+    modelId: string;
+    image: Buffer;
+    mode: SegmentationMode;
+    prompt?: string;
+    points?: Array<{
+        x: number;
+        y: number;
+        label: 'foreground' | 'background';
+    }>;
+    box?: SegmentationBox;
+    maxMasks?: number;
+    minScore?: number;
+    providerOptions?: SegmentationProviderOptionBag | Record<string, unknown>;
+}
+/** Contract implemented by every segmentation backend. */
+export interface ISegmentationProvider {
+    readonly providerId: string;
+    readonly isInitialized: boolean;
+    readonly defaultModelId?: string;
+    initialize(config: Record<string, unknown>): Promise<void>;
+    segment(request: SegmentationRequest): Promise<SegmentationResult>;
+    /** Prompt modes this provider supports, for up-front validation. */
+    supportedModes(): ReadonlyArray<SegmentationMode>;
+    shutdown?(): Promise<void>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/io/segmentation/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/io/segmentation/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,6CAA6C;AAC7C,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEjE,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,WAAW,CAAC;AAEvE,qDAAqD;AACrD,MAAM,WAAW,iBAAiB;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,uDAAuD;IACvD,KAAK,CAAC,EAAE,YAAY,GAAG,YAAY,CAAC;CACrC;AAED,6DAA6D;AAC7D,MAAM,WAAW,eAAe;IAC9B,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,kEAAkE;AAClE,MAAM,WAAW,4BAA4B;IAC3C,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,8CAA8C;AAC9C,MAAM,WAAW,6BAA6B;IAC5C,SAAS,CAAC,EAAE,4BAA4B,CAAC;IACzC,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/B;AAED,wEAAwE;AACxE,MAAM,WAAW,cAAc;IAC7B,gDAAgD;IAChD,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACpC,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,2BAA2B;IAC3B,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,wCAAwC;IACxC,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,eAAe,CAAC,EAAE,6BAA6B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1E,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,iCAAiC;AACjC,MAAM,WAAW,WAAW;IAC1B,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,IAAI,EAAE,eAAe,CAAC;IACtB,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,KAAK,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACtD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,gBAAgB,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAAA;KAAE,CAAC,CAAC;IAC7E,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,6BAA6B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3E;AAED,0DAA0D;AAC1D,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D,OAAO,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACnE,oEAAoE;IACpE,cAAc,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAAC;IAClD,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B"}

package/dist/io/segmentation/types.js

@@ -0,0 +1,14 @@
+/**
+ * @module io/segmentation/types
+ *
+ * Type definitions for provider-agnostic image segmentation.
+ *
+ * The segmentation surface takes an image plus exactly one prompt (text,
+ * points, box, or automatic "segment everything") and returns one
+ * {@link SegmentMask} per detected region. Masks are encoded white=object /
+ * black=background so they drop straight into the image-editing `mask` input.
+ *
+ * @see {@link ISegmentationProvider} for the provider contract.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/io/segmentation/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/io/segmentation/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@framers/agentos",
-  "version": "0.9.34",
+  "version": "0.9.36",
   "description": "AgentOS: open-source TypeScript framework for autonomous AI agents. Unified graph orchestration, cognitive memory, runtime tool forging, multi-tier guardrails, voice pipeline, and 11 LLM providers.",
   "homepage": "https://agentos.sh",
   "repository": {