@howells/stow-server 2.2.1 → 2.3.1

package/dist/index.js

@@ -25,7 +25,10 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 var import_node_crypto = require("crypto");
+var import_promises = require("timers/promises");
 var import_zod = require("zod");
+
+// src/stow-error.ts
 var StowError = class extends Error {
   status;
   code;
@@ -36,6 +39,8 @@ var StowError = class extends Error {
     this.code = code;
   }
 };
+
+// src/index.ts
 var fileColorSchema = import_zod.z.object({
   position: import_zod.z.number().int(),
   proportion: import_zod.z.number(),
@@ -194,10 +199,7 @@ var presignDedupeResultSchema = import_zod.z.object({
   size: import_zod.z.number(),
   contentType: import_zod.z.string()
 });
-var presignResultSchema = import_zod.z.union([
-  presignDedupeResultSchema,
-  presignNewResultSchema
-]);
+var presignResultSchema = import_zod.z.union([presignDedupeResultSchema, presignNewResultSchema]);
 var confirmResultSchema = import_zod.z.object({
   key: import_zod.z.string(),
   url: import_zod.z.string().nullable(),
@@ -249,6 +251,42 @@ var profileResultSchema = import_zod.z.object({
   createdAt: import_zod.z.string(),
   updatedAt: import_zod.z.string()
 });
+var clusterGroupResultSchema = import_zod.z.object({
+  id: import_zod.z.string(),
+  index: import_zod.z.number().int(),
+  name: import_zod.z.string().nullable(),
+  description: import_zod.z.string().nullable(),
+  fileCount: import_zod.z.number().int(),
+  nameGeneratedAt: import_zod.z.string().nullable()
+});
+var clusterResourceResultSchema = import_zod.z.object({
+  id: import_zod.z.string(),
+  name: import_zod.z.string().nullable(),
+  clusterCount: import_zod.z.number().int(),
+  fileCount: import_zod.z.number().int(),
+  clusteredAt: import_zod.z.string().nullable(),
+  createdAt: import_zod.z.string(),
+  updatedAt: import_zod.z.string(),
+  clusters: import_zod.z.array(clusterGroupResultSchema)
+});
+var clusterFileResultSchema = import_zod.z.object({
+  id: import_zod.z.string(),
+  key: import_zod.z.string(),
+  bucketId: import_zod.z.string(),
+  originalFilename: import_zod.z.string().nullable(),
+  size: import_zod.z.number(),
+  contentType: import_zod.z.string(),
+  metadata: import_zod.z.record(import_zod.z.string(), import_zod.z.string()).nullable(),
+  createdAt: import_zod.z.string(),
+  distance: import_zod.z.number().nullable()
+});
+var clusterFilesResultSchema = import_zod.z.object({
+  clusterId: import_zod.z.string(),
+  files: import_zod.z.array(clusterFileResultSchema),
+  limit: import_zod.z.number().int(),
+  offset: import_zod.z.number().int(),
+  total: import_zod.z.number().int()
+});
 var profileFilesResultSchema = import_zod.z.object({
   id: import_zod.z.string(),
   fileCount: import_zod.z.number()
@@ -296,12 +334,48 @@ var anchorResponseSchema = import_zod.z.object({
 var anchorListResponseSchema = import_zod.z.object({
   anchors: import_zod.z.array(anchorResponseSchema)
 });
+function sleep(ms) {
+  return (0, import_promises.setTimeout)(ms);
+}
+function buildTransformUrl(url, options) {
+  if (!(options && (options.width || options.height || options.quality || options.format))) {
+    return url;
+  }
+  const parsed = new URL(url);
+  if (options.width) {
+    parsed.searchParams.set("w", String(options.width));
+  }
+  if (options.height) {
+    parsed.searchParams.set("h", String(options.height));
+  }
+  if (options.quality) {
+    parsed.searchParams.set("q", String(options.quality));
+  }
+  if (options.format) {
+    parsed.searchParams.set("f", options.format);
+  }
+  return parsed.toString();
+}
 var StowServer = class {
   apiKey;
   baseUrl;
   bucket;
   timeout;
   retries;
+  /**
+   * Pure helper for building signed transform URLs from an existing public file URL.
+   *
+   * This does not perform any network I/O and is safe to pass around as a plain
+   * function, for example to view-layer code that needs responsive image URLs.
+   */
+  getTransformUrl;
+  /**
+   * Create a server SDK instance.
+   *
+   * Pass a bare string when you only need the API key and want default values
+   * for `baseUrl`, `timeout`, and retries. Pass an object when you want a
+   * default bucket, a non-production API origin, or custom transport settings.
+   */
   constructor(config) {
     if (typeof config === "string") {
       this.apiKey = config;
@@ -315,10 +389,9 @@ var StowServer = class {
       this.timeout = config.timeout ?? 3e4;
       this.retries = config.retries ?? 3;
     }
+    this.getTransformUrl = buildTransformUrl;
   }
-  /**
-   * Get the base URL for this instance (used by client SDK)
-   */
+  /** Return the configured API origin, mainly for adapter packages such as `stow-next`. */
   getBaseUrl() {
     return this.baseUrl;
   }
@@ -432,7 +505,7 @@ var StowServer = class {
   // biome-ignore lint/complexity/noExcessiveCognitiveComplexity: retry + timeout + error normalization intentionally handled in one request pipeline
   async request(path, options, schema) {
     const maxAttempts = this.retries + 1;
-    for (let attempt = 0; attempt < maxAttempts; attempt++) {
+    for (let attempt = 0; attempt < maxAttempts; attempt += 1) {
       const controller = new AbortController();
       const timeoutId = setTimeout(() => controller.abort(), this.timeout);
       if (options.signal) {
@@ -454,32 +527,28 @@ var StowServer = class {
           const code = error.success ? error.data.code : void 0;
           const isRetryable = response.status === 429 || response.status >= 500;
           if (isRetryable && attempt < maxAttempts - 1) {
-            await this.sleep(1e3 * 2 ** attempt);
+            await sleep(1e3 * 2 ** attempt);
             continue;
           }
           throw new StowError(message, response.status, code);
         }
         return schema ? schema.parse(data) : data;
-      } catch (err) {
-        if (err instanceof StowError) {
-          throw err;
+      } catch (error) {
+        if (error instanceof StowError) {
+          throw error;
         }
-        if (err instanceof import_zod.z.ZodError) {
-          throw new StowError(
-            "Invalid response format",
-            500,
-            "INVALID_RESPONSE"
-          );
+        if (error instanceof import_zod.z.ZodError) {
+          throw new StowError("Invalid response format", 500, "INVALID_RESPONSE");
         }
-        if (err instanceof DOMException || err instanceof Error && err.name === "AbortError") {
+        if (error instanceof DOMException || error instanceof Error && error.name === "AbortError") {
           throw new StowError("Request timed out", 408, "TIMEOUT");
         }
         if (attempt < maxAttempts - 1) {
-          await this.sleep(1e3 * 2 ** attempt);
+          await sleep(1e3 * 2 ** attempt);
           continue;
         }
         throw new StowError(
-          err instanceof Error ? err.message : "Network error",
+          error instanceof Error ? error.message : "Network error",
           0,
           "NETWORK_ERROR"
         );
@@ -489,11 +558,30 @@ var StowServer = class {
     }
     throw new StowError("Max retries exceeded", 0, "MAX_RETRIES");
   }
-  sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-  }
   /**
-   * Upload a file directly from the server
+   * Upload bytes from a trusted server environment.
+   *
+   * This is the highest-level server upload helper:
+   * 1. compute a SHA-256 hash for dedupe
+   * 2. request a presigned upload URL
+   * 3. PUT bytes to storage
+   * 4. confirm the upload with optional AI metadata generation
+   *
+   * Prefer this method when your code already has the file bytes in memory.
+   * Use `getPresignedUrl()` + `confirmUpload()` for direct browser uploads
+   * instead, and `uploadFromUrl()` when the source is an external URL.
+   *
+   * @example
+   * ```typescript
+   * await stow.uploadFile(buffer, {
+   *   filename: "product.jpg",
+   *   contentType: "image/jpeg",
+   *   bucket: "catalog",
+   *   metadata: { sku: "SKU-123" },
+   *   title: true,
+   *   altText: true,
+   * });
+   * ```
    */
   async uploadFile(file, options) {
     const filename = options?.filename || "file";
@@ -527,10 +615,7 @@ var StowServer = class {
       throw new StowError("Failed to upload to storage", uploadRes.status);
     }
     return this.request(
-      this.withBucket(
-        presign.confirmUrl || "/presign/confirm",
-        options?.bucket
-      ),
+      this.withBucket(presign.confirmUrl || "/presign/confirm", options?.bucket),
       {
         method: "POST",
         headers: { "Content-Type": "application/json" },
@@ -550,7 +635,12 @@ var StowServer = class {
     );
   }
   /**
-   * Upload a file from a URL (server-side fetch + upload)
+   * Import a remote asset by URL.
+   *
+   * Stow fetches the remote URL server-side, stores the resulting bytes, and
+   * persists the file as if it had been uploaded normally. This is useful for
+   * migrations, ingestion pipelines, or bringing third-party assets into Stow
+   * without downloading them into your own process first.
    */
   async uploadFromUrl(url, filename, options) {
     const result = await this.request(
@@ -585,7 +675,7 @@ var StowServer = class {
    * The actual fetch, validation, and upload happen in a background worker.
    * Use this for bulk imports where you don't need immediate confirmation.
    */
-  async queueUploadFromUrl(url, filename, options) {
+  queueUploadFromUrl(url, filename, options) {
     return this.request(
       this.withBucket("/upload", options?.bucket),
       {
@@ -606,24 +696,20 @@ var StowServer = class {
     );
   }
   /**
-   * Get a presigned URL for direct client-side upload.
+   * Get a presigned URL for a direct client upload.
+   *
+   * This is the server-side half of the browser upload flow used by
+   * `@howells/stow-client` and `@howells/stow-next`:
+   * 1. browser calls your app
+   * 2. your app calls `getPresignedUrl()`
+   * 3. browser PUTs bytes to `uploadUrl`
+   * 4. browser or your app calls `confirmUpload()`
    *
-   * This enables uploads that bypass your server entirely:
-   * 1. Client calls your endpoint
-   * 2. Your endpoint calls this method
-   * 3. Client PUTs directly to the returned uploadUrl
-   * 4. Client calls confirmUpload to finalize
+   * If `contentHash` matches an existing file in the target bucket, the API
+   * short-circuits with `{ dedupe: true, ... }` and no upload is required.
    */
   getPresignedUrl(request) {
-    const {
-      filename,
-      contentType,
-      size,
-      route,
-      bucket,
-      metadata,
-      contentHash
-    } = request;
+    const { filename, contentType, size, route, bucket, metadata, contentHash } = request;
     return this.request(
       this.withBucket("/presign", bucket),
       {
@@ -642,8 +728,12 @@ var StowServer = class {
     );
   }
   /**
-   * Confirm a presigned upload after the client has uploaded to R2.
-   * This creates the file record in the database.
+   * Confirm a direct upload after the client has finished the storage PUT.
+   *
+   * This finalizes the file record in the database and optionally triggers
+   * post-processing such as AI-generated title/description/alt text.
+   *
+   * Call this exactly once per successful presigned upload.
    */
   confirmUpload(request) {
     const {
@@ -679,9 +769,13 @@ var StowServer = class {
     );
   }
   /**
-   * List files in the bucket
+   * List files in a bucket with optional prefix filtering and enrichment blocks.
+   *
+   * Use `cursor` to continue pagination from a previous page. When requesting
+   * `include`, Stow expands those relationships inline so you can avoid follow-up
+   * per-file lookups.
    *
-   * @param options.include - Optional enrichment fields: `"tags"`, `"taxonomies"`
+   * @param options.include Optional enrichment fields: `"tags"`, `"taxonomies"`
    */
   listFiles(options) {
     const params = new URLSearchParams();
@@ -701,11 +795,7 @@ var StowServer = class {
       params.set("include", options.include.join(","));
     }
     const path = `/files?${params}`;
-    return this.request(
-      this.withBucket(path, options?.bucket),
-      { method: "GET" },
-      listFilesSchema
-    );
+    return this.request(this.withBucket(path, options?.bucket), { method: "GET" }, listFilesSchema);
   }
   /**
    * Delete a file by key
@@ -728,9 +818,12 @@ var StowServer = class {
     });
   }
   /**
-   * Get a single file by key
+   * Get one file by key.
+   *
+   * This is the detailed file view and includes dimensions, embeddings status,
+   * extracted colors, and AI metadata fields when available.
    *
-   * @param options.include - Optional enrichment fields: `"tags"`, `"taxonomies"`
+   * @param options.include Optional enrichment fields: `"tags"`, `"taxonomies"`
    */
   getFile(key, options) {
     const params = new URLSearchParams();
@@ -838,35 +931,6 @@ var StowServer = class {
       replaceResultSchema
     );
   }
-  /**
-   * Get a transform URL for an image.
-   *
-   * Appends transform query params (?w=, ?h=, ?q=, ?f=) to a file URL.
-   * Transforms are applied at the edge by the Cloudflare Worker — no
-   * server round-trip needed.
-   *
-   * @param url - Full file URL (e.g. from upload result's fileUrl)
-   * @param options - Transform options (width, height, quality, format)
-   */
-  getTransformUrl(url, options) {
-    if (!(options && (options.width || options.height || options.quality || options.format))) {
-      return url;
-    }
-    const parsed = new URL(url);
-    if (options.width) {
-      parsed.searchParams.set("w", String(options.width));
-    }
-    if (options.height) {
-      parsed.searchParams.set("h", String(options.height));
-    }
-    if (options.quality) {
-      parsed.searchParams.set("q", String(options.quality));
-    }
-    if (options.format) {
-      parsed.searchParams.set("f", options.format);
-    }
-    return parsed.toString();
-  }
   // ============================================================
   // TAGS - Org-scoped labels for file organization
   // ============================================================
@@ -944,7 +1008,34 @@ var StowServer = class {
   // SEARCH - Vector similarity search
   // ============================================================
   /**
-   * Search namespace for vector similarity search
+   * Semantic search namespace.
+   *
+   * Methods:
+   * - `text(...)` embeds text and finds matching files
+   * - `similar(...)` finds nearest neighbors for a file, anchor, profile, or cluster
+   * - `diverse(...)` balances similarity against result spread
+   * - `color(...)` performs palette similarity search
+   * - `image(...)` searches using an existing file or an external image URL
+   *
+   * Cluster-aware search examples:
+   *
+   * @example
+   * ```typescript
+   * const cluster = await stow.clusters.create({
+   *   bucket: "inspiration",
+   *   fileKeys,
+   *   clusterCount: 12,
+   * });
+   *
+   * const firstGroup = cluster.clusters[0];
+   * if (firstGroup) {
+   *   const related = await stow.search.similar({
+   *     bucket: "inspiration",
+   *     clusterId: firstGroup.id,
+   *     limit: 20,
+   *   });
+   * }
+   * ```
    */
   get search() {
     return {
@@ -1116,7 +1207,11 @@ var StowServer = class {
   // PROFILES - Taste/preference profiles from file collections
   // ============================================================
   /**
-   * Profiles namespace for managing taste profiles
+   * Taste-profile namespace.
+   *
+   * Profiles are long-lived preference objects. They can be seeded from files,
+   * updated through weighted signals, clustered into interpretable segments, and
+   * then reused as semantic search seeds.
    */
   get profiles() {
     return {
@@ -1132,6 +1227,49 @@ var StowServer = class {
       renameCluster: (profileId, clusterId, params, bucket) => this.renameProfileCluster(profileId, clusterId, params, bucket)
     };
   }
+  /**
+   * Curated cluster namespace.
+   *
+   * Use this when you have an explicit file set that should be grouped by visual
+   * similarity, but should not be modeled as a behavioral profile.
+   *
+   * Typical workflow:
+   * 1. `create({ fileKeys, clusterCount })`
+   * 2. poll `get(id)` until `clusteredAt` is non-null
+   * 3. inspect `clusters`
+   * 4. fetch representative files with `files(id, clusterId)`
+   * 5. optionally `renameCluster(...)`
+   * 6. use `clusterId` with `search.similar(...)` or `search.diverse(...)`
+   *
+   * @example
+   * ```typescript
+   * const resource = await stow.clusters.create({
+   *   bucket: "featured-products",
+   *   fileKeys: featuredKeys,
+   *   clusterCount: 12,
+   *   name: "Navigator groups",
+   * });
+   *
+   * const latest = await stow.clusters.get(resource.id, "featured-products");
+   * const group = latest.clusters[0];
+   * if (group) {
+   *   const representatives = await stow.clusters.files(resource.id, group.id, {
+   *     limit: 12,
+   *     offset: 0,
+   *   });
+   * }
+   * ```
+   */
+  get clusters() {
+    return {
+      create: (params) => this.createClustersResource(params),
+      get: (id, bucket) => this.getClustersResource(id, bucket),
+      recluster: (id, params, bucket) => this.reclusterClustersResource(id, params, bucket),
+      files: (id, clusterId, params, bucket) => this.getClusterFiles(id, clusterId, params, bucket),
+      renameCluster: (id, clusterId, params, bucket) => this.renameClusterGroup(id, clusterId, params, bucket),
+      delete: (id, bucket) => this.deleteClustersResource(id, bucket)
+    };
+  }
   createProfile(params) {
     return this.request(
       this.withBucket("/profiles", params?.bucket),
@@ -1154,10 +1292,9 @@ var StowServer = class {
     );
   }
   async deleteProfile(id, bucket) {
-    await this.request(
-      this.withBucket(`/profiles/${encodeURIComponent(id)}`, bucket),
-      { method: "DELETE" }
-    );
+    await this.request(this.withBucket(`/profiles/${encodeURIComponent(id)}`, bucket), {
+      method: "DELETE"
+    });
   }
   addProfileFiles(id, fileKeys, bucket) {
     return this.request(
@@ -1204,36 +1341,98 @@ var StowServer = class {
     );
   }
   getProfileClusters(id, bucket) {
+    return this.request(this.withBucket(`/profiles/${encodeURIComponent(id)}/clusters`, bucket), {
+      method: "GET"
+    });
+  }
+  reclusterProfile(id, params, bucket) {
+    return this.request(this.withBucket(`/profiles/${encodeURIComponent(id)}/clusters`, bucket), {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(
+        params?.clusterCount === void 0 ? {} : { clusterCount: params.clusterCount }
+      )
+    });
+  }
+  renameProfileCluster(profileId, clusterId, params, bucket) {
     return this.request(
-      this.withBucket(`/profiles/${encodeURIComponent(id)}/clusters`, bucket),
-      { method: "GET" }
+      this.withBucket(
+        `/profiles/${encodeURIComponent(profileId)}/clusters/${encodeURIComponent(clusterId)}`,
+        bucket
+      ),
+      {
+        method: "PUT",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(params)
+      }
     );
   }
-  reclusterProfile(id, params, bucket) {
+  createClustersResource(params) {
     return this.request(
-      this.withBucket(`/profiles/${encodeURIComponent(id)}/clusters`, bucket),
+      this.withBucket("/clusters", params.bucket),
       {
         method: "POST",
         headers: { "Content-Type": "application/json" },
         body: JSON.stringify({
-          ...params?.clusterCount === void 0 ? {} : { clusterCount: params.clusterCount }
+          fileKeys: params.fileKeys,
+          ...params.clusterCount === void 0 ? {} : { clusterCount: params.clusterCount },
+          ...params.name ? { name: params.name } : {}
         })
-      }
+      },
+      clusterResourceResultSchema
     );
   }
-  renameProfileCluster(profileId, clusterId, params, bucket) {
+  getClustersResource(id, bucket) {
+    return this.request(
+      this.withBucket(`/clusters/${encodeURIComponent(id)}`, bucket),
+      { method: "GET" },
+      clusterResourceResultSchema
+    );
+  }
+  reclusterClustersResource(id, params, bucket) {
+    return this.request(
+      this.withBucket(`/clusters/${encodeURIComponent(id)}/recluster`, bucket),
+      {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(
+          params?.clusterCount === void 0 ? {} : { clusterCount: params.clusterCount }
+        )
+      },
+      clusterResourceResultSchema
+    );
+  }
+  getClusterFiles(id, clusterId, params, bucket) {
+    const searchParams = new URLSearchParams();
+    if (params?.limit !== void 0) {
+      searchParams.set("limit", String(params.limit));
+    }
+    if (params?.offset !== void 0) {
+      searchParams.set("offset", String(params.offset));
+    }
+    const qs = searchParams.toString();
+    const path = `/clusters/${encodeURIComponent(id)}/clusters/${encodeURIComponent(clusterId)}/files${qs ? `?${qs}` : ""}`;
+    return this.request(this.withBucket(path, bucket), { method: "GET" }, clusterFilesResultSchema);
+  }
+  renameClusterGroup(id, clusterId, params, bucket) {
     return this.request(
       this.withBucket(
-        `/profiles/${encodeURIComponent(profileId)}/clusters/${encodeURIComponent(clusterId)}`,
+        `/clusters/${encodeURIComponent(id)}/clusters/${encodeURIComponent(clusterId)}`,
         bucket
       ),
       {
         method: "PUT",
         headers: { "Content-Type": "application/json" },
         body: JSON.stringify(params)
-      }
+      },
+      clusterGroupResultSchema
     );
   }
+  async deleteClustersResource(id, bucket) {
+    await this.request(this.withBucket(`/clusters/${encodeURIComponent(id)}`, bucket), {
+      method: "DELETE"
+    });
+  }
   // ============================================================
   // ANCHORS - Named semantic reference points in vector space
   // ============================================================
@@ -1295,10 +1494,9 @@ var StowServer = class {
     );
   }
   async deleteAnchor(id, options) {
-    await this.request(
-      this.withBucket(`/anchors/${encodeURIComponent(id)}`, options?.bucket),
-      { method: "DELETE" }
-    );
+    await this.request(this.withBucket(`/anchors/${encodeURIComponent(id)}`, options?.bucket), {
+      method: "DELETE"
+    });
   }
 };
 // Annotate the CommonJS export names for ESM import in node: