@howells/stow-next 0.2.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -38,11 +38,13 @@
38
38
  * }
39
39
  * ```
40
40
  */
41
+ /** Next.js image loader input contract. */
41
42
  interface ImageLoaderProps {
42
43
  quality?: number;
43
44
  src: string;
44
45
  width: number;
45
46
  }
47
+ /** Configuration for `createStowLoader`. */
46
48
  interface StowLoaderConfig {
47
49
  /**
48
50
  * Fixed aspect ratio (width / height).
@@ -38,11 +38,13 @@
38
38
  * }
39
39
  * ```
40
40
  */
41
+ /** Next.js image loader input contract. */
41
42
  interface ImageLoaderProps {
42
43
  quality?: number;
43
44
  src: string;
44
45
  width: number;
45
46
  }
47
+ /** Configuration for `createStowLoader`. */
46
48
  interface StowLoaderConfig {
47
49
  /**
48
50
  * Fixed aspect ratio (width / height).
package/dist/index.d.mts CHANGED
@@ -23,6 +23,7 @@ export { StowLoaderConfig, createStowLoader, stowLoader } from './image-loader.m
23
23
  * ```
24
24
  */
25
25
 
26
+ /** CORS options applied to generated route handlers. */
26
27
  interface CorsConfig {
27
28
  /** Allowed headers (default: ["Content-Type"]) */
28
29
  allowedHeaders?: string[];
@@ -37,6 +38,7 @@ interface CorsConfig {
37
38
  * Create an OPTIONS handler for CORS preflight requests
38
39
  */
39
40
  declare function createCorsPreflightHandler(config?: CorsConfig): () => NextResponse;
41
+ /** Minimal server SDK shape required by handler factories. */
40
42
  interface StowServerLike {
41
43
  confirmUpload: (request: {
42
44
  fileKey: string;
@@ -62,11 +64,11 @@ interface StowServerLike {
62
64
  } | {
63
65
  fileKey: string;
64
66
  uploadUrl: string;
65
- r2Key: string;
66
67
  confirmUrl: string;
67
68
  dedupe?: false;
68
69
  }>;
69
70
  }
71
+ /** Options for `createPresignHandler`. */
70
72
  interface PresignHandlerConfig {
71
73
  /** Allowed content types (supports wildcards like "image/*") */
72
74
  allowedTypes?: string[];
@@ -85,6 +87,7 @@ interface PresignHandlerConfig {
85
87
  size: number;
86
88
  }) => Promise<boolean | string> | boolean | string;
87
89
  }
90
+ /** Options for `createConfirmHandler`. */
88
91
  interface ConfirmHandlerConfig {
89
92
  /** CORS configuration (enabled by default for browser uploads) */
90
93
  cors?: CorsConfig | false;
@@ -112,6 +115,7 @@ declare function createPresignHandler(config: PresignHandlerConfig): (request: N
112
115
  * Returns both POST handler and OPTIONS handler for CORS preflight.
113
116
  */
114
117
  declare function createConfirmHandler(config: ConfirmHandlerConfig): (request: NextRequest) => Promise<NextResponse>;
118
+ /** Minimal combined shape for single-route upload handlers. */
115
119
  interface StowLike {
116
120
  uploadFile: (file: Blob, options?: {
117
121
  filename?: string;
@@ -124,6 +128,7 @@ interface StowLike {
124
128
  contentType: string;
125
129
  }>;
126
130
  }
131
+ /** Options for `createUploadHandler`. */
127
132
  interface UploadHandlerConfig {
128
133
  /** Allowed content types (supports wildcards like "image/*") */
129
134
  allowedTypes?: string[];
package/dist/index.d.ts CHANGED
@@ -23,6 +23,7 @@ export { StowLoaderConfig, createStowLoader, stowLoader } from './image-loader.j
23
23
  * ```
24
24
  */
25
25
 
26
+ /** CORS options applied to generated route handlers. */
26
27
  interface CorsConfig {
27
28
  /** Allowed headers (default: ["Content-Type"]) */
28
29
  allowedHeaders?: string[];
@@ -37,6 +38,7 @@ interface CorsConfig {
37
38
  * Create an OPTIONS handler for CORS preflight requests
38
39
  */
39
40
  declare function createCorsPreflightHandler(config?: CorsConfig): () => NextResponse;
41
+ /** Minimal server SDK shape required by handler factories. */
40
42
  interface StowServerLike {
41
43
  confirmUpload: (request: {
42
44
  fileKey: string;
@@ -62,11 +64,11 @@ interface StowServerLike {
62
64
  } | {
63
65
  fileKey: string;
64
66
  uploadUrl: string;
65
- r2Key: string;
66
67
  confirmUrl: string;
67
68
  dedupe?: false;
68
69
  }>;
69
70
  }
71
+ /** Options for `createPresignHandler`. */
70
72
  interface PresignHandlerConfig {
71
73
  /** Allowed content types (supports wildcards like "image/*") */
72
74
  allowedTypes?: string[];
@@ -85,6 +87,7 @@ interface PresignHandlerConfig {
85
87
  size: number;
86
88
  }) => Promise<boolean | string> | boolean | string;
87
89
  }
90
+ /** Options for `createConfirmHandler`. */
88
91
  interface ConfirmHandlerConfig {
89
92
  /** CORS configuration (enabled by default for browser uploads) */
90
93
  cors?: CorsConfig | false;
@@ -112,6 +115,7 @@ declare function createPresignHandler(config: PresignHandlerConfig): (request: N
112
115
  * Returns both POST handler and OPTIONS handler for CORS preflight.
113
116
  */
114
117
  declare function createConfirmHandler(config: ConfirmHandlerConfig): (request: NextRequest) => Promise<NextResponse>;
118
+ /** Minimal combined shape for single-route upload handlers. */
115
119
  interface StowLike {
116
120
  uploadFile: (file: Blob, options?: {
117
121
  filename?: string;
@@ -124,6 +128,7 @@ interface StowLike {
124
128
  contentType: string;
125
129
  }>;
126
130
  }
131
+ /** Options for `createUploadHandler`. */
127
132
  interface UploadHandlerConfig {
128
133
  /** Allowed content types (supports wildcards like "image/*") */
129
134
  allowedTypes?: string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@howells/stow-next",
3
- "version": "0.2.0",
3
+ "version": "0.3.1",
4
4
  "description": "Next.js integration for Stow file storage",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -1,39 +0,0 @@
1
- // src/image-loader.ts
2
- function createStowLoader(config = {}) {
3
- const {
4
- baseUrl = "https://stow.sh",
5
- defaultQuality = 75,
6
- defaultFormat
7
- } = config;
8
- return function stowLoader2({
9
- src,
10
- width,
11
- quality
12
- }) {
13
- if (src.startsWith(baseUrl) || src.startsWith("/files/")) {
14
- const url = new URL(src, baseUrl);
15
- const pathname = url.pathname;
16
- const params = new URLSearchParams();
17
- params.set("w", width.toString());
18
- params.set("q", (quality || defaultQuality).toString());
19
- if (defaultFormat) {
20
- params.set("f", defaultFormat);
21
- }
22
- if (pathname.startsWith("/files/")) {
23
- const transformPath = pathname.replace("/files/", "/transform/");
24
- return `${baseUrl}${transformPath}?${params.toString()}`;
25
- }
26
- if (pathname.startsWith("/transform/")) {
27
- return `${baseUrl}${pathname}?${params.toString()}`;
28
- }
29
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
30
- }
31
- return src;
32
- };
33
- }
34
- var stowLoader = createStowLoader();
35
-
36
- export {
37
- createStowLoader,
38
- stowLoader
39
- };
@@ -1,87 +0,0 @@
1
- // src/image-loader.ts
2
- var STOW_DOMAIN_PATTERN = /\.stow\.sh$/;
3
- function isStowUrl(src) {
4
- try {
5
- const url = new URL(src);
6
- return STOW_DOMAIN_PATTERN.test(url.hostname);
7
- } catch {
8
- return false;
9
- }
10
- }
11
- function buildTransformParams(width, quality, config) {
12
- const params = new URLSearchParams();
13
- params.set("w", width.toString());
14
- if (config.aspectRatio) {
15
- params.set("h", Math.round(width / config.aspectRatio).toString());
16
- }
17
- params.set("q", quality.toString());
18
- if (config.fit) {
19
- params.set("fit", config.fit);
20
- }
21
- if (config.gravity) {
22
- params.set("gravity", config.gravity);
23
- }
24
- if (config.defaultFormat) {
25
- params.set("f", config.defaultFormat);
26
- }
27
- return params;
28
- }
29
- function transformStowUrl(src, baseUrl, params) {
30
- const url = new URL(src, baseUrl);
31
- const pathname = url.pathname;
32
- if (pathname.startsWith("/files/")) {
33
- const transformPath = pathname.replace("/files/", "/transform/");
34
- return `${baseUrl}${transformPath}?${params.toString()}`;
35
- }
36
- if (pathname.startsWith("/transform/")) {
37
- return `${baseUrl}${pathname}?${params.toString()}`;
38
- }
39
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
40
- }
41
- function createStowLoader(config = {}) {
42
- const {
43
- baseUrl = "https://stow.sh",
44
- defaultQuality = 75,
45
- defaultFormat,
46
- proxySlug,
47
- fit,
48
- gravity,
49
- aspectRatio
50
- } = config;
51
- return function stowLoader2({
52
- src,
53
- width,
54
- quality
55
- }) {
56
- const resolvedQuality = quality || defaultQuality;
57
- const paramConfig = { defaultFormat, fit, gravity, aspectRatio };
58
- if (isStowUrl(src)) {
59
- const params = buildTransformParams(width, resolvedQuality, paramConfig);
60
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
61
- }
62
- if (src.startsWith(baseUrl) || src.startsWith("/files/")) {
63
- const params = buildTransformParams(width, resolvedQuality, paramConfig);
64
- return transformStowUrl(src, baseUrl, params);
65
- }
66
- if (proxySlug && (src.startsWith("http://") || src.startsWith("https://"))) {
67
- const params = new URLSearchParams();
68
- params.set("url", src);
69
- params.set("w", width.toString());
70
- if (aspectRatio) {
71
- params.set("h", Math.round(width / aspectRatio).toString());
72
- }
73
- params.set("q", resolvedQuality.toString());
74
- if (fit) params.set("fit", fit);
75
- if (gravity) params.set("gravity", gravity);
76
- if (defaultFormat) params.set("f", defaultFormat);
77
- return `https://proxy.stow.sh/${proxySlug}/?${params.toString()}`;
78
- }
79
- return src;
80
- };
81
- }
82
- var stowLoader = createStowLoader();
83
-
84
- export {
85
- createStowLoader,
86
- stowLoader
87
- };
@@ -1,31 +0,0 @@
1
- // src/image-loader.ts
2
- function createObliqLoader(config = {}) {
3
- const { baseUrl = "https://obliq.co", defaultQuality = 75, defaultFormat } = config;
4
- return function obliqLoader2({ src, width, quality }) {
5
- if (src.startsWith(baseUrl) || src.startsWith("/files/")) {
6
- const url = new URL(src, baseUrl);
7
- const pathname = url.pathname;
8
- const params = new URLSearchParams();
9
- params.set("w", width.toString());
10
- params.set("q", (quality || defaultQuality).toString());
11
- if (defaultFormat) {
12
- params.set("f", defaultFormat);
13
- }
14
- if (pathname.startsWith("/files/")) {
15
- const transformPath = pathname.replace("/files/", "/transform/");
16
- return `${baseUrl}${transformPath}?${params.toString()}`;
17
- }
18
- if (pathname.startsWith("/transform/")) {
19
- return `${baseUrl}${pathname}?${params.toString()}`;
20
- }
21
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
22
- }
23
- return src;
24
- };
25
- }
26
- var obliqLoader = createObliqLoader();
27
-
28
- export {
29
- createObliqLoader,
30
- obliqLoader
31
- };
@@ -1,62 +0,0 @@
1
- // src/image-loader.ts
2
- function buildTransformParams(width, quality, defaultFormat) {
3
- const params = new URLSearchParams();
4
- params.set("w", width.toString());
5
- params.set("q", quality.toString());
6
- if (defaultFormat) {
7
- params.set("f", defaultFormat);
8
- }
9
- return params;
10
- }
11
- function transformStowUrl(src, baseUrl, params) {
12
- const url = new URL(src, baseUrl);
13
- const pathname = url.pathname;
14
- if (pathname.startsWith("/files/")) {
15
- const transformPath = pathname.replace("/files/", "/transform/");
16
- return `${baseUrl}${transformPath}?${params.toString()}`;
17
- }
18
- if (pathname.startsWith("/transform/")) {
19
- return `${baseUrl}${pathname}?${params.toString()}`;
20
- }
21
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
22
- }
23
- function createStowLoader(config = {}) {
24
- const {
25
- baseUrl = "https://stow.sh",
26
- defaultQuality = 75,
27
- defaultFormat,
28
- proxySlug
29
- } = config;
30
- return function stowLoader2({
31
- src,
32
- width,
33
- quality
34
- }) {
35
- const resolvedQuality = quality || defaultQuality;
36
- if (src.startsWith(baseUrl) || src.startsWith("/files/")) {
37
- const params = buildTransformParams(
38
- width,
39
- resolvedQuality,
40
- defaultFormat
41
- );
42
- return transformStowUrl(src, baseUrl, params);
43
- }
44
- if (proxySlug && (src.startsWith("http://") || src.startsWith("https://"))) {
45
- const params = new URLSearchParams();
46
- params.set("url", src);
47
- params.set("w", width.toString());
48
- params.set("q", resolvedQuality.toString());
49
- if (defaultFormat) {
50
- params.set("f", defaultFormat);
51
- }
52
- return `https://proxy.stow.sh/${proxySlug}/?${params.toString()}`;
53
- }
54
- return src;
55
- };
56
- }
57
- var stowLoader = createStowLoader();
58
-
59
- export {
60
- createStowLoader,
61
- stowLoader
62
- };
@@ -1,31 +0,0 @@
1
- // src/image-loader.ts
2
- function createStowLoader(config = {}) {
3
- const { baseUrl = "https://stow.sh", defaultQuality = 75, defaultFormat } = config;
4
- return function stowLoader2({ src, width, quality }) {
5
- if (src.startsWith(baseUrl) || src.startsWith("/files/")) {
6
- const url = new URL(src, baseUrl);
7
- const pathname = url.pathname;
8
- const params = new URLSearchParams();
9
- params.set("w", width.toString());
10
- params.set("q", (quality || defaultQuality).toString());
11
- if (defaultFormat) {
12
- params.set("f", defaultFormat);
13
- }
14
- if (pathname.startsWith("/files/")) {
15
- const transformPath = pathname.replace("/files/", "/transform/");
16
- return `${baseUrl}${transformPath}?${params.toString()}`;
17
- }
18
- if (pathname.startsWith("/transform/")) {
19
- return `${baseUrl}${pathname}?${params.toString()}`;
20
- }
21
- return `${src}${src.includes("?") ? "&" : "?"}${params.toString()}`;
22
- }
23
- return src;
24
- };
25
- }
26
- var stowLoader = createStowLoader();
27
-
28
- export {
29
- createStowLoader,
30
- stowLoader
31
- };