@howells/stow-server 2.1.0 → 2.2.1

package/dist/index.d.mts

@@ -627,6 +627,47 @@ interface ColorSearchResultItem {
 interface ColorSearchResult {
     results: ColorSearchResultItem[];
 }
+/** 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. */
 interface TaxonomyTerm {
     name: string;
@@ -937,11 +978,13 @@ declare class StowServer {
         diverse: (params?: DiverseSearchRequest) => Promise<SimilarSearchResult>;
         text: (params: TextSearchRequest) => Promise<SimilarSearchResult>;
         color: (params: ColorSearchRequest) => Promise<ColorSearchResult>;
+        image: (input: SearchByImageInput, options?: SearchByImageOptions) => Promise<SearchByImageResult>;
     };
     private searchSimilar;
     private searchDiverse;
     private searchText;
     private searchColor;
+    private searchImage;
     /**
      * Upload a file as a drop (quick share)
      *
@@ -1026,4 +1069,4 @@ declare class StowServer {
     private deleteAnchor;
 }
 
-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 };

package/dist/index.d.ts

@@ -627,6 +627,47 @@ interface ColorSearchResultItem {
 interface ColorSearchResult {
     results: ColorSearchResultItem[];
 }
+/** 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. */
 interface TaxonomyTerm {
     name: string;
@@ -937,11 +978,13 @@ declare class StowServer {
         diverse: (params?: DiverseSearchRequest) => Promise<SimilarSearchResult>;
         text: (params: TextSearchRequest) => Promise<SimilarSearchResult>;
         color: (params: ColorSearchRequest) => Promise<ColorSearchResult>;
+        image: (input: SearchByImageInput, options?: SearchByImageOptions) => Promise<SearchByImageResult>;
     };
     private searchSimilar;
     private searchDiverse;
     private searchText;
     private searchColor;
+    private searchImage;
     /**
      * Upload a file as a drop (quick share)
      *
@@ -1026,4 +1069,4 @@ declare class StowServer {
     private deleteAnchor;
 }
 
-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 };

package/dist/index.js

@@ -881,17 +881,17 @@ var StowServer = class {
     };
   }
   listTags() {
-    return this.request("/tags", { method: "GET" });
+    return this.request(this.withBucket("/tags"), { method: "GET" });
   }
   createTag(params) {
-    return this.request("/tags", {
+    return this.request(this.withBucket("/tags"), {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(params)
     });
   }
   async deleteTag(id) {
-    await this.request(`/tags/${encodeURIComponent(id)}`, {
+    await this.request(this.withBucket(`/tags/${encodeURIComponent(id)}`), {
       method: "DELETE"
     });
   }
@@ -951,7 +951,8 @@ var StowServer = class {
       similar: (params) => this.searchSimilar(params),
       diverse: (params) => this.searchDiverse(params ?? {}),
       text: (params) => this.searchText(params),
-      color: (params) => this.searchColor(params)
+      color: (params) => this.searchColor(params),
+      image: (input, options) => this.searchImage(input, options)
     };
   }
   searchSimilar(params) {
@@ -1026,6 +1027,24 @@ var StowServer = class {
       })
     });
   }
+  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 } : {}
+      })
+    });
+  }
   // ============================================================
   // DROPS - Quick share without buckets
   // ============================================================

package/dist/index.mjs

@@ -856,17 +856,17 @@ var StowServer = class {
     };
   }
   listTags() {
-    return this.request("/tags", { method: "GET" });
+    return this.request(this.withBucket("/tags"), { method: "GET" });
   }
   createTag(params) {
-    return this.request("/tags", {
+    return this.request(this.withBucket("/tags"), {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(params)
     });
   }
   async deleteTag(id) {
-    await this.request(`/tags/${encodeURIComponent(id)}`, {
+    await this.request(this.withBucket(`/tags/${encodeURIComponent(id)}`), {
       method: "DELETE"
     });
   }
@@ -926,7 +926,8 @@ var StowServer = class {
       similar: (params) => this.searchSimilar(params),
       diverse: (params) => this.searchDiverse(params ?? {}),
       text: (params) => this.searchText(params),
-      color: (params) => this.searchColor(params)
+      color: (params) => this.searchColor(params),
+      image: (input, options) => this.searchImage(input, options)
     };
   }
   searchSimilar(params) {
@@ -1001,6 +1002,24 @@ var StowServer = class {
       })
     });
   }
+  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 } : {}
+      })
+    });
+  }
   // ============================================================
   // DROPS - Quick share without buckets
   // ============================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@howells/stow-server",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Server-side SDK for Stow file storage",
   "license": "MIT",
   "repository": {
@@ -29,21 +29,21 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
   "peerDependencies": {
     "zod": "^3.0.0 || ^4.0.0"
   },
   "devDependencies": {
+    "@stow/typescript-config": "workspace:*",
     "@types/node": "^25.5.0",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
     "vitest": "^4.1.0",
-    "zod": "^4.3.6",
-    "@stow/typescript-config": "0.0.0"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "test": "vitest run",
-    "test:watch": "vitest"
+    "zod": "^4.3.6"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Stow
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.