@howells/stow-server - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

dist/index.d.mts

@@ -630,2 +630,43 @@ /**
 }
+/** Input specifying the image source for search-by-image. Exactly one of url or fileKey. */
+interface SearchByImageInput {
+    /** Key of an existing file to use as the image source */
+    fileKey?: string;
+    /** URL of an external image to download, persist, and embed */
+    url?: string;
+}
+/** Options for search-by-image. */
+interface SearchByImageOptions {
+    /** Bucket name or ID to scope search */
+    bucket?: string;
+    /** File keys to exclude from results (e.g. already-seen items). Max 500. */
+    excludeKeys?: string[];
+    /** Structured post-filters (taxonomy, tag, color, content type, metadata) */
+    filters?: SearchFilters;
+    /** Opt-in enrichment fields to include in results */
+    include?: SearchIncludeField[];
+    /** Max results (default 10, max 50) */
+    limit?: number;
+    /** Custom metadata to attach when persisting a URL-sourced image */
+    metadata?: Record<string, string>;
+    /** Minimum similarity threshold (0–1, default 0.25) */
+    threshold?: number;
+}
+/** Source image metadata returned by search-by-image. */
+interface SearchByImageSource {
+    embedding: {
+        dimensions: number;
+        durationMs: number;
+        model: string;
+    };
+    fileKey: string;
+    vector: number[];
+}
+/** Result payload returned by search-by-image. */
+interface SearchByImageResult {
+    anchors?: AnchorSearchResult[];
+    filtered?: FilteredMetadata;
+    results: SearchResultItem[];
+    source: SearchByImageSource;
+}
 /** A taxonomy term within a group. */
@@ -941,2 +982,3 @@ interface TaxonomyTerm {
         color: (params: ColorSearchRequest) => Promise<ColorSearchResult>;
+        image: (input: SearchByImageInput, options?: SearchByImageOptions) => Promise<SearchByImageResult>;
     };
@@ -947,2 +989,3 @@ private searchSimilar;
     private searchColor;
+    private searchImage;
     /**
@@ -1032,2 +1075,2 @@ * Upload a file as a drop (quick share)
 
-export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ColorSearchRequest, type ColorSearchResult, type ColorSearchResultItem, type ConfirmUploadRequest, type CreateAnchorRequest, type CreateBucketRequest, type DeleteProfileSignalsResult, type DiverseSearchRequest, type Drop, type DropResult, type FileColor, type FileColorProfile, type FileIncludeField, type FileResult, type FileTag, type FileTaxonomy, type FilteredMetadata, type ListBucketsResult, type ListDropsResult, type ListFilesItem, type ListFilesResult, type PresignDedupeResult, type PresignNewResult, type PresignRequest, type PresignResult, type ProfileClusterResult, type ProfileCreateRequest, type ProfileFilesResult, type ProfileResult, type ProfileSignalInput, type ProfileSignalResult, type ProfileSignalType, type ProfileSignalsResponse, type QueuedResult, type ReclusterRequest, type ReclusterResult, type RenameClusterRequest, type ReplaceResult, type SearchFilters, type SearchIncludeField, type SearchResultItem, type SimilarSearchRequest, type SimilarSearchResult, StowError, StowServer, type StowServerConfig, type TaskTriggerResult, type TaxonomyGroup, type TaxonomyListResult, type TaxonomyTerm, type TextSearchRequest, type TransformOptions, type UpdateAnchorRequest, type UpdateBucketRequest, type UploadResult, type WhoamiResult };
+export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ColorSearchRequest, type ColorSearchResult, type ColorSearchResultItem, type ConfirmUploadRequest, type CreateAnchorRequest, type CreateBucketRequest, type DeleteProfileSignalsResult, type DiverseSearchRequest, type Drop, type DropResult, type FileColor, type FileColorProfile, type FileIncludeField, type FileResult, type FileTag, type FileTaxonomy, type FilteredMetadata, type ListBucketsResult, type ListDropsResult, type ListFilesItem, type ListFilesResult, type PresignDedupeResult, type PresignNewResult, type PresignRequest, type PresignResult, type ProfileClusterResult, type ProfileCreateRequest, type ProfileFilesResult, type ProfileResult, type ProfileSignalInput, type ProfileSignalResult, type ProfileSignalType, type ProfileSignalsResponse, type QueuedResult, type ReclusterRequest, type ReclusterResult, type RenameClusterRequest, type ReplaceResult, type SearchByImageInput, type SearchByImageOptions, type SearchByImageResult, type SearchByImageSource, type SearchFilters, type SearchIncludeField, type SearchResultItem, type SimilarSearchRequest, type SimilarSearchResult, StowError, StowServer, type StowServerConfig, type TaskTriggerResult, type TaxonomyGroup, type TaxonomyListResult, type TaxonomyTerm, type TextSearchRequest, type TransformOptions, type UpdateAnchorRequest, type UpdateBucketRequest, type UploadResult, type WhoamiResult };

dist/index.d.ts

@@ -630,2 +630,43 @@ /**
 }
+/** Input specifying the image source for search-by-image. Exactly one of url or fileKey. */
+interface SearchByImageInput {
+    /** Key of an existing file to use as the image source */
+    fileKey?: string;
+    /** URL of an external image to download, persist, and embed */
+    url?: string;
+}
+/** Options for search-by-image. */
+interface SearchByImageOptions {
+    /** Bucket name or ID to scope search */
+    bucket?: string;
+    /** File keys to exclude from results (e.g. already-seen items). Max 500. */
+    excludeKeys?: string[];
+    /** Structured post-filters (taxonomy, tag, color, content type, metadata) */
+    filters?: SearchFilters;
+    /** Opt-in enrichment fields to include in results */
+    include?: SearchIncludeField[];
+    /** Max results (default 10, max 50) */
+    limit?: number;
+    /** Custom metadata to attach when persisting a URL-sourced image */
+    metadata?: Record<string, string>;
+    /** Minimum similarity threshold (0–1, default 0.25) */
+    threshold?: number;
+}
+/** Source image metadata returned by search-by-image. */
+interface SearchByImageSource {
+    embedding: {
+        dimensions: number;
+        durationMs: number;
+        model: string;
+    };
+    fileKey: string;
+    vector: number[];
+}
+/** Result payload returned by search-by-image. */
+interface SearchByImageResult {
+    anchors?: AnchorSearchResult[];
+    filtered?: FilteredMetadata;
+    results: SearchResultItem[];
+    source: SearchByImageSource;
+}
 /** A taxonomy term within a group. */
@@ -941,2 +982,3 @@ interface TaxonomyTerm {
         color: (params: ColorSearchRequest) => Promise<ColorSearchResult>;
+        image: (input: SearchByImageInput, options?: SearchByImageOptions) => Promise<SearchByImageResult>;
     };
@@ -947,2 +989,3 @@ private searchSimilar;
     private searchColor;
+    private searchImage;
     /**
@@ -1032,2 +1075,2 @@ * Upload a file as a drop (quick share)
 
-export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ColorSearchRequest, type ColorSearchResult, type ColorSearchResultItem, type ConfirmUploadRequest, type CreateAnchorRequest, type CreateBucketRequest, type DeleteProfileSignalsResult, type DiverseSearchRequest, type Drop, type DropResult, type FileColor, type FileColorProfile, type FileIncludeField, type FileResult, type FileTag, type FileTaxonomy, type FilteredMetadata, type ListBucketsResult, type ListDropsResult, type ListFilesItem, type ListFilesResult, type PresignDedupeResult, type PresignNewResult, type PresignRequest, type PresignResult, type ProfileClusterResult, type ProfileCreateRequest, type ProfileFilesResult, type ProfileResult, type ProfileSignalInput, type ProfileSignalResult, type ProfileSignalType, type ProfileSignalsResponse, type QueuedResult, type ReclusterRequest, type ReclusterResult, type RenameClusterRequest, type ReplaceResult, type SearchFilters, type SearchIncludeField, type SearchResultItem, type SimilarSearchRequest, type SimilarSearchResult, StowError, StowServer, type StowServerConfig, type TaskTriggerResult, type TaxonomyGroup, type TaxonomyListResult, type TaxonomyTerm, type TextSearchRequest, type TransformOptions, type UpdateAnchorRequest, type UpdateBucketRequest, type UploadResult, type WhoamiResult };
+export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ColorSearchRequest, type ColorSearchResult, type ColorSearchResultItem, type ConfirmUploadRequest, type CreateAnchorRequest, type CreateBucketRequest, type DeleteProfileSignalsResult, type DiverseSearchRequest, type Drop, type DropResult, type FileColor, type FileColorProfile, type FileIncludeField, type FileResult, type FileTag, type FileTaxonomy, type FilteredMetadata, type ListBucketsResult, type ListDropsResult, type ListFilesItem, type ListFilesResult, type PresignDedupeResult, type PresignNewResult, type PresignRequest, type PresignResult, type ProfileClusterResult, type ProfileCreateRequest, type ProfileFilesResult, type ProfileResult, type ProfileSignalInput, type ProfileSignalResult, type ProfileSignalType, type ProfileSignalsResponse, type QueuedResult, type ReclusterRequest, type ReclusterResult, type RenameClusterRequest, type ReplaceResult, type SearchByImageInput, type SearchByImageOptions, type SearchByImageResult, type SearchByImageSource, type SearchFilters, type SearchIncludeField, type SearchResultItem, type SimilarSearchRequest, type SimilarSearchResult, StowError, StowServer, type StowServerConfig, type TaskTriggerResult, type TaxonomyGroup, type TaxonomyListResult, type TaxonomyTerm, type TextSearchRequest, type TransformOptions, type UpdateAnchorRequest, type UpdateBucketRequest, type UploadResult, type WhoamiResult };

dist/index.js

@@ -954,3 +954,4 @@ "use strict";
       text: (params) => this.searchText(params),
-      color: (params) => this.searchColor(params)
+      color: (params) => this.searchColor(params),
+      image: (input, options) => this.searchImage(input, options)
     };
@@ -1030,2 +1031,20 @@ }
   }
+  searchImage(input, options) {
+    const bucket = this.resolveBucket(options?.bucket);
+    return this.request("/search/image", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({
+        ...input.url ? { url: input.url } : {},
+        ...input.fileKey ? { fileKey: input.fileKey } : {},
+        ...bucket ? { bucket } : {},
+        ...options?.limit ? { limit: options.limit } : {},
+        ...options?.threshold === void 0 ? {} : { threshold: options.threshold },
+        ...options?.excludeKeys?.length ? { excludeKeys: options.excludeKeys } : {},
+        ...options?.filters ? { filters: options.filters } : {},
+        ...options?.include?.length ? { include: options.include } : {},
+        ...options?.metadata ? { metadata: options.metadata } : {}
+      })
+    });
+  }
   // ============================================================
@@ -1032,0 +1051,0 @@ // DROPS - Quick share without buckets

dist/index.mjs

@@ -929,3 +929,4 @@ // src/index.ts
       text: (params) => this.searchText(params),
-      color: (params) => this.searchColor(params)
+      color: (params) => this.searchColor(params),
+      image: (input, options) => this.searchImage(input, options)
     };
@@ -1005,2 +1006,20 @@ }
   }
+  searchImage(input, options) {
+    const bucket = this.resolveBucket(options?.bucket);
+    return this.request("/search/image", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({
+        ...input.url ? { url: input.url } : {},
+        ...input.fileKey ? { fileKey: input.fileKey } : {},
+        ...bucket ? { bucket } : {},
+        ...options?.limit ? { limit: options.limit } : {},
+        ...options?.threshold === void 0 ? {} : { threshold: options.threshold },
+        ...options?.excludeKeys?.length ? { excludeKeys: options.excludeKeys } : {},
+        ...options?.filters ? { filters: options.filters } : {},
+        ...options?.include?.length ? { include: options.include } : {},
+        ...options?.metadata ? { metadata: options.metadata } : {}
+      })
+    });
+  }
   // ============================================================
@@ -1007,0 +1026,0 @@ // DROPS - Quick share without buckets

package.json

 {
   "name": "@howells/stow-server",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Server-side SDK for Stow file storage",
@@ -5,0 +5,0 @@ "license": "MIT",

No alert changes

Improved metrics

Total package byte prevSize

158133

3.41%

Lines of code

3665

2.29%

No dependency changes