@howells/stow-server - npm Package Compare versions

Comparing version 2.4.0 to 2.5.0

dist/index.d.mts

@@ -242,2 +242,9 @@ /** Error thrown when the Stow API returns a non-success response. */
 }
+/** Result payload returned by `getSignedUrl()`. */
+interface SignedUrlResult {
+    /** Unix timestamp (seconds) when the signed URL expires. */
+    expiresAt: number;
+    /** HMAC-signed URL granting temporary access to a private-bucket file. */
+    url: string;
+}
 /** Full file detail payload returned by `getFile()`. */
@@ -1113,2 +1120,16 @@ interface FileResult {
     /**
+     * Generate a temporary signed URL for accessing a file in a private bucket.
+     *
+     * The returned URL is HMAC-signed and accepted by the files CDN worker,
+     * which skips the `isPublic` check when a valid signature is present.
+     *
+     * @param key - The file key to generate a signed URL for.
+     * @param options.bucket - Bucket override (uses constructor default otherwise).
+     * @param options.expiresIn - TTL in seconds (default 3600).
+     */
+    getSignedUrl(key: string, options?: {
+        bucket?: string;
+        expiresIn?: number;
+    }): Promise<SignedUrlResult>;
+    /**
      * Extract color palette from an image file.
@@ -1401,2 +1422,2 @@ * Requires a searchable bucket.
 
-export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ClusterCreateRequest, type ClusterFileResult, type ClusterFilesResult, type ClusterGroupResult, type ClusterResourceResult, 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 };
+export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ClusterCreateRequest, type ClusterFileResult, type ClusterFilesResult, type ClusterGroupResult, type ClusterResourceResult, 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 SignedUrlResult, 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

@@ -242,2 +242,9 @@ /** Error thrown when the Stow API returns a non-success response. */
 }
+/** Result payload returned by `getSignedUrl()`. */
+interface SignedUrlResult {
+    /** Unix timestamp (seconds) when the signed URL expires. */
+    expiresAt: number;
+    /** HMAC-signed URL granting temporary access to a private-bucket file. */
+    url: string;
+}
 /** Full file detail payload returned by `getFile()`. */
@@ -1113,2 +1120,16 @@ interface FileResult {
     /**
+     * Generate a temporary signed URL for accessing a file in a private bucket.
+     *
+     * The returned URL is HMAC-signed and accepted by the files CDN worker,
+     * which skips the `isPublic` check when a valid signature is present.
+     *
+     * @param key - The file key to generate a signed URL for.
+     * @param options.bucket - Bucket override (uses constructor default otherwise).
+     * @param options.expiresIn - TTL in seconds (default 3600).
+     */
+    getSignedUrl(key: string, options?: {
+        bucket?: string;
+        expiresIn?: number;
+    }): Promise<SignedUrlResult>;
+    /**
      * Extract color palette from an image file.
@@ -1401,2 +1422,2 @@ * Requires a searchable bucket.
 
-export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ClusterCreateRequest, type ClusterFileResult, type ClusterFilesResult, type ClusterGroupResult, type ClusterResourceResult, 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 };
+export { type Anchor, type AnchorSearchResult, type AppliedFilters, type BucketResult, type ClusterCreateRequest, type ClusterFileResult, type ClusterFilesResult, type ClusterGroupResult, type ClusterResourceResult, 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 SignedUrlResult, 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

@@ -842,2 +842,23 @@ "use strict";
   /**
+   * Generate a temporary signed URL for accessing a file in a private bucket.
+   *
+   * The returned URL is HMAC-signed and accepted by the files CDN worker,
+   * which skips the `isPublic` check when a valid signature is present.
+   *
+   * @param key - The file key to generate a signed URL for.
+   * @param options.bucket - Bucket override (uses constructor default otherwise).
+   * @param options.expiresIn - TTL in seconds (default 3600).
+   */
+  getSignedUrl(key, options) {
+    const body = { key };
+    if (options?.expiresIn !== void 0) {
+      body.expiresIn = options.expiresIn;
+    }
+    return this.request(this.withBucket("/files/signed-url", options?.bucket), {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body)
+    });
+  }
+  /**
    * Extract color palette from an image file.
@@ -844,0 +865,0 @@ * Requires a searchable bucket.

dist/index.mjs

@@ -817,2 +817,23 @@ // src/index.ts
   /**
+   * Generate a temporary signed URL for accessing a file in a private bucket.
+   *
+   * The returned URL is HMAC-signed and accepted by the files CDN worker,
+   * which skips the `isPublic` check when a valid signature is present.
+   *
+   * @param key - The file key to generate a signed URL for.
+   * @param options.bucket - Bucket override (uses constructor default otherwise).
+   * @param options.expiresIn - TTL in seconds (default 3600).
+   */
+  getSignedUrl(key, options) {
+    const body = { key };
+    if (options?.expiresIn !== void 0) {
+      body.expiresIn = options.expiresIn;
+    }
+    return this.request(this.withBucket("/files/signed-url", options?.bucket), {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body)
+    });
+  }
+  /**
    * Extract color palette from an image file.
@@ -819,0 +840,0 @@ * Requires a searchable bucket.

package.json

 {
   "name": "@howells/stow-server",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Server-side SDK for Stow file storage",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

201243

1.72%

Lines of code

4446

1.44%

No dependency changes