@softure-ai/files 0.0.0-stage → 0.1.2

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.
Files changed (156) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/LICENSE +21 -0
  3. package/README.md +213 -2
  4. package/dist/contract.d.ts +51 -0
  5. package/dist/contract.d.ts.map +1 -0
  6. package/dist/contract.js +4 -0
  7. package/dist/contract.js.map +1 -0
  8. package/dist/index.d.ts +45 -0
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/index.js +49 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/jobs/index.d.ts +12 -0
  13. package/dist/jobs/index.d.ts.map +1 -0
  14. package/dist/jobs/index.js +22 -0
  15. package/dist/jobs/index.js.map +1 -0
  16. package/dist/messages/en.d.ts +17 -0
  17. package/dist/messages/en.d.ts.map +1 -0
  18. package/dist/messages/en.js +17 -0
  19. package/dist/messages/en.js.map +1 -0
  20. package/dist/messages/index.d.ts +24 -0
  21. package/dist/messages/index.d.ts.map +1 -0
  22. package/dist/messages/index.js +10 -0
  23. package/dist/messages/index.js.map +1 -0
  24. package/dist/next/context.d.ts +4 -0
  25. package/dist/next/context.d.ts.map +1 -0
  26. package/dist/next/context.js +13 -0
  27. package/dist/next/context.js.map +1 -0
  28. package/dist/next/index.d.ts +3 -0
  29. package/dist/next/index.d.ts.map +1 -0
  30. package/dist/next/index.js +5 -0
  31. package/dist/next/index.js.map +1 -0
  32. package/dist/next/route.d.ts +3 -0
  33. package/dist/next/route.d.ts.map +1 -0
  34. package/dist/next/route.js +11 -0
  35. package/dist/next/route.js.map +1 -0
  36. package/dist/options.d.ts +26 -0
  37. package/dist/options.d.ts.map +1 -0
  38. package/dist/options.js +59 -0
  39. package/dist/options.js.map +1 -0
  40. package/dist/schema.d.ts +214 -0
  41. package/dist/schema.d.ts.map +1 -0
  42. package/dist/schema.js +19 -0
  43. package/dist/schema.js.map +1 -0
  44. package/dist/server/context.d.ts +13 -0
  45. package/dist/server/context.d.ts.map +1 -0
  46. package/dist/server/context.js +19 -0
  47. package/dist/server/context.js.map +1 -0
  48. package/dist/server/files.d.ts +48 -0
  49. package/dist/server/files.d.ts.map +1 -0
  50. package/dist/server/files.js +104 -0
  51. package/dist/server/files.js.map +1 -0
  52. package/dist/server/health.d.ts +4 -0
  53. package/dist/server/health.d.ts.map +1 -0
  54. package/dist/server/health.js +20 -0
  55. package/dist/server/health.js.map +1 -0
  56. package/dist/server/index.d.ts +15 -0
  57. package/dist/server/index.d.ts.map +1 -0
  58. package/dist/server/index.js +17 -0
  59. package/dist/server/index.js.map +1 -0
  60. package/dist/server/keys.d.ts +14 -0
  61. package/dist/server/keys.d.ts.map +1 -0
  62. package/dist/server/keys.js +47 -0
  63. package/dist/server/keys.js.map +1 -0
  64. package/dist/server/links.d.ts +30 -0
  65. package/dist/server/links.d.ts.map +1 -0
  66. package/dist/server/links.js +122 -0
  67. package/dist/server/links.js.map +1 -0
  68. package/dist/server/local-storage.d.ts +7 -0
  69. package/dist/server/local-storage.d.ts.map +1 -0
  70. package/dist/server/local-storage.js +83 -0
  71. package/dist/server/local-storage.js.map +1 -0
  72. package/dist/server/names.d.ts +11 -0
  73. package/dist/server/names.d.ts.map +1 -0
  74. package/dist/server/names.js +32 -0
  75. package/dist/server/names.js.map +1 -0
  76. package/dist/server/options.d.ts +8 -0
  77. package/dist/server/options.d.ts.map +1 -0
  78. package/dist/server/options.js +31 -0
  79. package/dist/server/options.js.map +1 -0
  80. package/dist/server/privacy.d.ts +16 -0
  81. package/dist/server/privacy.d.ts.map +1 -0
  82. package/dist/server/privacy.js +39 -0
  83. package/dist/server/privacy.js.map +1 -0
  84. package/dist/server/prune.d.ts +13 -0
  85. package/dist/server/prune.d.ts.map +1 -0
  86. package/dist/server/prune.js +34 -0
  87. package/dist/server/prune.js.map +1 -0
  88. package/dist/server/queries.d.ts +7 -0
  89. package/dist/server/queries.d.ts.map +1 -0
  90. package/dist/server/queries.js +17 -0
  91. package/dist/server/queries.js.map +1 -0
  92. package/dist/server/s3-storage.d.ts +33 -0
  93. package/dist/server/s3-storage.d.ts.map +1 -0
  94. package/dist/server/s3-storage.js +223 -0
  95. package/dist/server/s3-storage.js.map +1 -0
  96. package/dist/server/save.d.ts +29 -0
  97. package/dist/server/save.d.ts.map +1 -0
  98. package/dist/server/save.js +141 -0
  99. package/dist/server/save.js.map +1 -0
  100. package/dist/server/serve.d.ts +11 -0
  101. package/dist/server/serve.d.ts.map +1 -0
  102. package/dist/server/serve.js +108 -0
  103. package/dist/server/serve.js.map +1 -0
  104. package/dist/server/sigv4.d.ts +23 -0
  105. package/dist/server/sigv4.d.ts.map +1 -0
  106. package/dist/server/sigv4.js +57 -0
  107. package/dist/server/sigv4.js.map +1 -0
  108. package/dist/storage.d.ts +32 -0
  109. package/dist/storage.d.ts.map +1 -0
  110. package/dist/storage.js +10 -0
  111. package/dist/storage.js.map +1 -0
  112. package/dist/testing/index.d.ts +3 -0
  113. package/dist/testing/index.d.ts.map +1 -0
  114. package/dist/testing/index.js +4 -0
  115. package/dist/testing/index.js.map +1 -0
  116. package/dist/testing/links.d.ts +22 -0
  117. package/dist/testing/links.d.ts.map +1 -0
  118. package/dist/testing/links.js +30 -0
  119. package/dist/testing/links.js.map +1 -0
  120. package/dist/testing/memory-storage.d.ts +11 -0
  121. package/dist/testing/memory-storage.d.ts.map +1 -0
  122. package/dist/testing/memory-storage.js +52 -0
  123. package/dist/testing/memory-storage.js.map +1 -0
  124. package/migrations/0001_create_files.sql +32 -0
  125. package/module.json +24 -0
  126. package/package.json +72 -4
  127. package/src/contract.ts +59 -0
  128. package/src/index.ts +53 -0
  129. package/src/jobs/index.ts +23 -0
  130. package/src/messages/en.ts +16 -0
  131. package/src/messages/index.ts +13 -0
  132. package/src/next/context.ts +14 -0
  133. package/src/next/index.ts +4 -0
  134. package/src/next/route.ts +11 -0
  135. package/src/options.ts +64 -0
  136. package/src/schema.ts +22 -0
  137. package/src/server/context.ts +32 -0
  138. package/src/server/files.ts +133 -0
  139. package/src/server/health.ts +20 -0
  140. package/src/server/index.ts +45 -0
  141. package/src/server/keys.ts +56 -0
  142. package/src/server/links.ts +152 -0
  143. package/src/server/local-storage.ts +87 -0
  144. package/src/server/names.ts +35 -0
  145. package/src/server/options.ts +34 -0
  146. package/src/server/privacy.ts +53 -0
  147. package/src/server/prune.ts +46 -0
  148. package/src/server/queries.ts +19 -0
  149. package/src/server/s3-storage.ts +255 -0
  150. package/src/server/save.ts +167 -0
  151. package/src/server/serve.ts +106 -0
  152. package/src/server/sigv4.ts +82 -0
  153. package/src/storage.ts +43 -0
  154. package/src/testing/index.ts +3 -0
  155. package/src/testing/links.ts +47 -0
  156. package/src/testing/memory-storage.ts +64 -0
@@ -0,0 +1,11 @@
1
+ // The public link route, mounted with one line:
2
+ // `app/f/[...link]/route.ts → export { serveFileLinkRoute as GET, serveFileLinkRoute as HEAD } from "@softure-ai/files/next";`
3
+ // It reads no session: a link is protected by its signature, so the route must stay outside the app's sign-in guard
4
+ // and the edge's sign-in (README §4). The path is read from the request URL, not from Next's params.
5
+ import { getFilesContext } from "./context.js";
6
+ import { serveFileLink } from "../server/serve.js";
7
+ /** `GET` and `HEAD /f/<id>/<expiry>/<signature>/<name>`. */
8
+ export async function serveFileLinkRoute(request) {
9
+ return serveFileLink(await getFilesContext(), request);
10
+ }
11
+ //# sourceMappingURL=route.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/next/route.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,+HAA+H;AAC/H,oHAAoH;AACpH,qGAAqG;AACrG,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,4DAA4D;AAC5D,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAgB;IACvD,OAAO,aAAa,CAAC,MAAM,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;AACzD,CAAC"}
@@ -0,0 +1,26 @@
1
+ import { z } from "zod";
2
+ import { type FileStorage } from "./storage.js";
3
+ /** A file kind: lowercase letters, digits, `_` and `-`, starting with a letter, at most 32 characters. */
4
+ export declare const FILE_KIND_PATTERN: RegExp;
5
+ /** The kind of a file saved without one. */
6
+ export declare const DEFAULT_FILE_KIND = "file";
7
+ export declare const filesOptionsSchema: z.ZodObject<{
8
+ storage: z.ZodCustom<FileStorage, FileStorage>;
9
+ maxFileBytes: z.ZodDefault<z.ZodNumber>;
10
+ quotaBytesPerOwner: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
11
+ dedupe: z.ZodDefault<z.ZodBoolean>;
12
+ defaultTtlSeconds: z.ZodDefault<z.ZodNullable<z.ZodNumber>>;
13
+ links: z.ZodDefault<z.ZodObject<{
14
+ maxTtlSeconds: z.ZodDefault<z.ZodNumber>;
15
+ disposition: z.ZodDefault<z.ZodEnum<{
16
+ attachment: "attachment";
17
+ inline: "inline";
18
+ }>>;
19
+ }, z.core.$strict>>;
20
+ health: z.ZodDefault<z.ZodObject<{
21
+ minFreeBytes: z.ZodDefault<z.ZodNumber>;
22
+ }, z.core.$strict>>;
23
+ }, z.core.$strict>;
24
+ export type FilesOptionsInput = z.input<typeof filesOptionsSchema>;
25
+ export type FilesOptions = z.output<typeof filesOptionsSchema>;
26
+ //# sourceMappingURL=options.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAiB,KAAK,WAAW,EAAE,MAAM,cAAc,CAAC;AAK/D,0GAA0G;AAC1G,eAAO,MAAM,iBAAiB,QAA4B,CAAC;AAC3D,4CAA4C;AAC5C,eAAO,MAAM,iBAAiB,SAAS,CAAC;AAExC,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;kBA8C7B,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACnE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC"}
@@ -0,0 +1,59 @@
1
+ // The options an app passes to `files({ ... })` in softure.config.ts, parsed at startup. The storage driver is an
2
+ // object the app builds (`createLocalStorage`, `createS3Storage`); building one touches neither the disk nor the
3
+ // network, so `next build` runs without the folder or the bucket's secrets.
4
+ import { z } from "zod";
5
+ import { isFileStorage } from "./storage.js";
6
+ const MIB = 1024 * 1024;
7
+ const DAY_SECONDS = 24 * 60 * 60;
8
+ /** A file kind: lowercase letters, digits, `_` and `-`, starting with a letter, at most 32 characters. */
9
+ export const FILE_KIND_PATTERN = /^[a-z][a-z0-9_-]{0,31}$/;
10
+ /** The kind of a file saved without one. */
11
+ export const DEFAULT_FILE_KIND = "file";
12
+ export const filesOptionsSchema = z.strictObject({
13
+ /** Where the bytes live: `createLocalStorage({ dir })`, `createS3Storage({ ... })` or `createMemoryStorage()`. */
14
+ storage: z.custom(isFileStorage, "must be a storage driver such as createLocalStorage({ dir })"),
15
+ /** The largest file `saveFile` accepts. */
16
+ maxFileBytes: z
17
+ .number()
18
+ .int()
19
+ .min(1)
20
+ .max(Number.MAX_SAFE_INTEGER)
21
+ .default(100 * MIB),
22
+ /** The bytes one owner may keep in live files; null: no quota. */
23
+ quotaBytesPerOwner: z.number().int().min(1).max(Number.MAX_SAFE_INTEGER).nullable().default(null),
24
+ /** Saving content an owner already has (same SHA-256) answers the existing file instead of a second copy. */
25
+ dedupe: z.boolean().default(false),
26
+ /** The lifetime of a file saved without `expiresAt` or `ttlSeconds`; null: kept until deleted. */
27
+ defaultTtlSeconds: z
28
+ .number()
29
+ .int()
30
+ .min(60)
31
+ .max(3650 * DAY_SECONDS)
32
+ .nullable()
33
+ .default(null),
34
+ links: z
35
+ .strictObject({
36
+ /** The longest lifetime `createFileLink` grants. */
37
+ maxTtlSeconds: z
38
+ .number()
39
+ .int()
40
+ .min(60)
41
+ .max(365 * DAY_SECONDS)
42
+ .default(7 * DAY_SECONDS),
43
+ /** How a link hands the file over: a download (`attachment`) or shown in the browser (`inline`). */
44
+ disposition: z.enum(["attachment", "inline"]).default("attachment"),
45
+ })
46
+ .default({ maxTtlSeconds: 7 * DAY_SECONDS, disposition: "attachment" }),
47
+ health: z
48
+ .strictObject({
49
+ /** Below this many free bytes (when the driver can tell) the health check fails. */
50
+ minFreeBytes: z
51
+ .number()
52
+ .int()
53
+ .min(0)
54
+ .max(Number.MAX_SAFE_INTEGER)
55
+ .default(1024 * MIB),
56
+ })
57
+ .default({ minFreeBytes: 1024 * MIB }),
58
+ });
59
+ //# sourceMappingURL=options.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,iHAAiH;AACjH,4EAA4E;AAC5E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAoB,MAAM,cAAc,CAAC;AAE/D,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AACxB,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAEjC,0GAA0G;AAC1G,MAAM,CAAC,MAAM,iBAAiB,GAAG,yBAAyB,CAAC;AAC3D,4CAA4C;AAC5C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAExC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;IAC/C,kHAAkH;IAClH,OAAO,EAAE,CAAC,CAAC,MAAM,CAAc,aAAa,EAAE,8DAA8D,CAAC;IAC7G,2CAA2C;IAC3C,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC;SAC5B,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IACrB,kEAAkE;IAClE,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IACjG,6GAA6G;IAC7G,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAClC,kGAAkG;IAClG,iBAAiB,EAAE,CAAC;SACjB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,EAAE,CAAC;SACP,GAAG,CAAC,IAAI,GAAG,WAAW,CAAC;SACvB,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;IAChB,KAAK,EAAE,CAAC;SACL,YAAY,CAAC;QACZ,oDAAoD;QACpD,aAAa,EAAE,CAAC;aACb,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,EAAE,CAAC;aACP,GAAG,CAAC,GAAG,GAAG,WAAW,CAAC;aACtB,OAAO,CAAC,CAAC,GAAG,WAAW,CAAC;QAC3B,oGAAoG;QACpG,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;KACpE,CAAC;SACD,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC,GAAG,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;IACzE,MAAM,EAAE,CAAC;SACN,YAAY,CAAC;QACZ,oFAAoF;QACpF,YAAY,EAAE,CAAC;aACZ,MAAM,EAAE;aACR,GAAG,EAAE;aACL,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC;aAC5B,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC;KACvB,CAAC;SACD,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC;CACzC,CAAC,CAAC"}
@@ -0,0 +1,214 @@
1
+ export declare const filesSchema: import("drizzle-orm/pg-core").PgSchema<"files">;
2
+ export declare const files: import("drizzle-orm/pg-core").PgTableWithColumns<{
3
+ name: "files";
4
+ schema: "files";
5
+ columns: {
6
+ id: import("drizzle-orm/pg-core").PgColumn<{
7
+ name: "id";
8
+ tableName: "files";
9
+ dataType: "string";
10
+ columnType: "PgUUID";
11
+ data: string;
12
+ driverParam: string;
13
+ notNull: true;
14
+ hasDefault: false;
15
+ isPrimaryKey: true;
16
+ isAutoincrement: false;
17
+ hasRuntimeDefault: false;
18
+ enumValues: undefined;
19
+ baseColumn: never;
20
+ identity: undefined;
21
+ generated: undefined;
22
+ }, {}, {}>;
23
+ ownerId: import("drizzle-orm/pg-core").PgColumn<{
24
+ name: "owner_id";
25
+ tableName: "files";
26
+ dataType: "string";
27
+ columnType: "PgText";
28
+ data: string;
29
+ driverParam: string;
30
+ notNull: true;
31
+ hasDefault: false;
32
+ isPrimaryKey: false;
33
+ isAutoincrement: false;
34
+ hasRuntimeDefault: false;
35
+ enumValues: [string, ...string[]];
36
+ baseColumn: never;
37
+ identity: undefined;
38
+ generated: undefined;
39
+ }, {}, {}>;
40
+ sha256: import("drizzle-orm/pg-core").PgColumn<{
41
+ name: "sha256";
42
+ tableName: "files";
43
+ dataType: "string";
44
+ columnType: "PgText";
45
+ data: string;
46
+ driverParam: string;
47
+ notNull: true;
48
+ hasDefault: false;
49
+ isPrimaryKey: false;
50
+ isAutoincrement: false;
51
+ hasRuntimeDefault: false;
52
+ enumValues: [string, ...string[]];
53
+ baseColumn: never;
54
+ identity: undefined;
55
+ generated: undefined;
56
+ }, {}, {}>;
57
+ size: import("drizzle-orm/pg-core").PgColumn<{
58
+ name: "size";
59
+ tableName: "files";
60
+ dataType: "number";
61
+ columnType: "PgBigInt53";
62
+ data: number;
63
+ driverParam: string | number;
64
+ notNull: true;
65
+ hasDefault: false;
66
+ isPrimaryKey: false;
67
+ isAutoincrement: false;
68
+ hasRuntimeDefault: false;
69
+ enumValues: undefined;
70
+ baseColumn: never;
71
+ identity: undefined;
72
+ generated: undefined;
73
+ }, {}, {}>;
74
+ contentType: import("drizzle-orm/pg-core").PgColumn<{
75
+ name: "content_type";
76
+ tableName: "files";
77
+ dataType: "string";
78
+ columnType: "PgText";
79
+ data: string;
80
+ driverParam: string;
81
+ notNull: true;
82
+ hasDefault: false;
83
+ isPrimaryKey: false;
84
+ isAutoincrement: false;
85
+ hasRuntimeDefault: false;
86
+ enumValues: [string, ...string[]];
87
+ baseColumn: never;
88
+ identity: undefined;
89
+ generated: undefined;
90
+ }, {}, {}>;
91
+ originalName: import("drizzle-orm/pg-core").PgColumn<{
92
+ name: "original_name";
93
+ tableName: "files";
94
+ dataType: "string";
95
+ columnType: "PgText";
96
+ data: string;
97
+ driverParam: string;
98
+ notNull: true;
99
+ hasDefault: false;
100
+ isPrimaryKey: false;
101
+ isAutoincrement: false;
102
+ hasRuntimeDefault: false;
103
+ enumValues: [string, ...string[]];
104
+ baseColumn: never;
105
+ identity: undefined;
106
+ generated: undefined;
107
+ }, {}, {}>;
108
+ kind: import("drizzle-orm/pg-core").PgColumn<{
109
+ name: "kind";
110
+ tableName: "files";
111
+ dataType: "string";
112
+ columnType: "PgText";
113
+ data: string;
114
+ driverParam: string;
115
+ notNull: true;
116
+ hasDefault: false;
117
+ isPrimaryKey: false;
118
+ isAutoincrement: false;
119
+ hasRuntimeDefault: false;
120
+ enumValues: [string, ...string[]];
121
+ baseColumn: never;
122
+ identity: undefined;
123
+ generated: undefined;
124
+ }, {}, {}>;
125
+ storageKey: import("drizzle-orm/pg-core").PgColumn<{
126
+ name: "storage_key";
127
+ tableName: "files";
128
+ dataType: "string";
129
+ columnType: "PgText";
130
+ data: string;
131
+ driverParam: string;
132
+ notNull: true;
133
+ hasDefault: false;
134
+ isPrimaryKey: false;
135
+ isAutoincrement: false;
136
+ hasRuntimeDefault: false;
137
+ enumValues: [string, ...string[]];
138
+ baseColumn: never;
139
+ identity: undefined;
140
+ generated: undefined;
141
+ }, {}, {}>;
142
+ linkGeneration: import("drizzle-orm/pg-core").PgColumn<{
143
+ name: "link_generation";
144
+ tableName: "files";
145
+ dataType: "number";
146
+ columnType: "PgInteger";
147
+ data: number;
148
+ driverParam: string | number;
149
+ notNull: true;
150
+ hasDefault: false;
151
+ isPrimaryKey: false;
152
+ isAutoincrement: false;
153
+ hasRuntimeDefault: false;
154
+ enumValues: undefined;
155
+ baseColumn: never;
156
+ identity: undefined;
157
+ generated: undefined;
158
+ }, {}, {}>;
159
+ expiresAt: import("drizzle-orm/pg-core").PgColumn<{
160
+ name: "expires_at";
161
+ tableName: "files";
162
+ dataType: "date";
163
+ columnType: "PgTimestamp";
164
+ data: Date;
165
+ driverParam: string;
166
+ notNull: false;
167
+ hasDefault: false;
168
+ isPrimaryKey: false;
169
+ isAutoincrement: false;
170
+ hasRuntimeDefault: false;
171
+ enumValues: undefined;
172
+ baseColumn: never;
173
+ identity: undefined;
174
+ generated: undefined;
175
+ }, {}, {}>;
176
+ deletedAt: import("drizzle-orm/pg-core").PgColumn<{
177
+ name: "deleted_at";
178
+ tableName: "files";
179
+ dataType: "date";
180
+ columnType: "PgTimestamp";
181
+ data: Date;
182
+ driverParam: string;
183
+ notNull: false;
184
+ hasDefault: false;
185
+ isPrimaryKey: false;
186
+ isAutoincrement: false;
187
+ hasRuntimeDefault: false;
188
+ enumValues: undefined;
189
+ baseColumn: never;
190
+ identity: undefined;
191
+ generated: undefined;
192
+ }, {}, {}>;
193
+ createdAt: import("drizzle-orm/pg-core").PgColumn<{
194
+ name: "created_at";
195
+ tableName: "files";
196
+ dataType: "date";
197
+ columnType: "PgTimestamp";
198
+ data: Date;
199
+ driverParam: string;
200
+ notNull: true;
201
+ hasDefault: false;
202
+ isPrimaryKey: false;
203
+ isAutoincrement: false;
204
+ hasRuntimeDefault: false;
205
+ enumValues: undefined;
206
+ baseColumn: never;
207
+ identity: undefined;
208
+ generated: undefined;
209
+ }, {}, {}>;
210
+ };
211
+ dialect: "pg";
212
+ }>;
213
+ export type FileRow = typeof files.$inferSelect;
214
+ //# sourceMappingURL=schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,WAAW,iDAAoB,CAAC;AAE7C,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAahB,CAAC;AAEH,MAAM,MAAM,OAAO,GAAG,OAAO,KAAK,CAAC,YAAY,CAAC"}
package/dist/schema.js ADDED
@@ -0,0 +1,19 @@
1
+ // Drizzle view of the module's table (migrations/0001_create_files.sql). The migration is the source of truth;
2
+ // this file only types the queries.
3
+ import { bigint, integer, pgSchema, text, timestamp, uuid } from "drizzle-orm/pg-core";
4
+ export const filesSchema = pgSchema("files");
5
+ export const files = filesSchema.table("files", {
6
+ id: uuid("id").primaryKey(),
7
+ ownerId: text("owner_id").notNull(),
8
+ sha256: text("sha256").notNull(),
9
+ size: bigint("size", { mode: "number" }).notNull(),
10
+ contentType: text("content_type").notNull(),
11
+ originalName: text("original_name").notNull(),
12
+ kind: text("kind").notNull(),
13
+ storageKey: text("storage_key").notNull(),
14
+ linkGeneration: integer("link_generation").notNull(),
15
+ expiresAt: timestamp("expires_at", { withTimezone: true }),
16
+ deletedAt: timestamp("deleted_at", { withTimezone: true }),
17
+ createdAt: timestamp("created_at", { withTimezone: true }).notNull(),
18
+ });
19
+ //# sourceMappingURL=schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,+GAA+G;AAC/G,oCAAoC;AACpC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAEvF,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;AAE7C,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE;IAC9C,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE;IAC3B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE;IACnC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IAClD,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE;IAC3C,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE;IAC7C,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE;IAC5B,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE;IACzC,cAAc,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,EAAE;IACpD,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1D,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;IAC1D,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;CACrE,CAAC,CAAC"}
@@ -0,0 +1,13 @@
1
+ import type { ModuleContext } from "@softure-ai/core";
2
+ import type { Queryable } from "@softure-ai/db";
3
+ import type { StoredFile } from "../contract.js";
4
+ import type { FileRow } from "../schema.js";
5
+ export type Env = Readonly<Record<string, string | undefined>>;
6
+ /** The module context; `env` defaults to `process.env` (the link keyring). */
7
+ export interface FilesContext extends ModuleContext<Queryable> {
8
+ readonly env?: Env;
9
+ }
10
+ export declare function toStoredFile(row: FileRow): StoredFile;
11
+ /** The storage key of a file: two levels of fan-out by its id, so no folder holds more than 256 entries per level. */
12
+ export declare function getStorageKey(fileId: string): string;
13
+ //# sourceMappingURL=context.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/server/context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C,MAAM,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;AAE/D,8EAA8E;AAC9E,MAAM,WAAW,YAAa,SAAQ,aAAa,CAAC,SAAS,CAAC;IAC5D,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;CACpB;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU,CAYrD;AAED,sHAAsH;AACtH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAGpD"}
@@ -0,0 +1,19 @@
1
+ export function toStoredFile(row) {
2
+ return {
3
+ id: row.id,
4
+ ownerId: row.ownerId,
5
+ sha256: row.sha256,
6
+ size: row.size,
7
+ contentType: row.contentType,
8
+ name: row.originalName,
9
+ kind: row.kind,
10
+ expiresAt: row.expiresAt,
11
+ createdAt: row.createdAt,
12
+ };
13
+ }
14
+ /** The storage key of a file: two levels of fan-out by its id, so no folder holds more than 256 entries per level. */
15
+ export function getStorageKey(fileId) {
16
+ const hex = fileId.replaceAll("-", "");
17
+ return `${hex.slice(0, 2)}/${hex.slice(2, 4)}/${fileId}`;
18
+ }
19
+ //# sourceMappingURL=context.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/server/context.ts"],"names":[],"mappings":"AAaA,MAAM,UAAU,YAAY,CAAC,GAAY;IACvC,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,IAAI,EAAE,GAAG,CAAC,YAAY;QACtB,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,SAAS,EAAE,GAAG,CAAC,SAAS;KACzB,CAAC;AACJ,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACvC,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;AAC3D,CAAC"}
@@ -0,0 +1,48 @@
1
+ import { type Err, type Ok } from "@softure-ai/core";
2
+ import type { ByteRange, FilesLookupErrorCode, StoredFile } from "../contract.js";
3
+ import { type FileRow } from "../schema.js";
4
+ import { type FilesContext } from "./context.js";
5
+ export interface FileLookupOptions {
6
+ /** Only this owner's file; another owner's reads as missing. */
7
+ readonly ownerId?: string;
8
+ }
9
+ /** The live row with this id, or undefined. Not a uuid reads as missing. */
10
+ export declare function findLiveRow(ctx: FilesContext, fileId: string, options?: FileLookupOptions): Promise<FileRow | undefined>;
11
+ export declare const UUID_PATTERN: RegExp;
12
+ /** A live file, or null. */
13
+ export declare function findFile(ctx: FilesContext, fileId: string, options?: FileLookupOptions): Promise<StoredFile | null>;
14
+ export interface OpenFileOptions extends FileLookupOptions {
15
+ /** Only these bytes; `end` past the file is clipped to its last byte. */
16
+ readonly range?: ByteRange;
17
+ }
18
+ export interface OpenedFile {
19
+ readonly file: StoredFile;
20
+ readonly body: ReadableStream<Uint8Array>;
21
+ /** The bytes `body` carries; the whole file when no range was asked. */
22
+ readonly range: ByteRange | null;
23
+ }
24
+ export type OpenFileResult = Ok<OpenedFile> | Err<FilesLookupErrorCode>;
25
+ /** A live file's bytes as a stream. A row whose bytes are missing from storage reads as not found (and is logged). */
26
+ export declare function openFile(ctx: FilesContext, fileId: string, options?: OpenFileOptions): Promise<OpenFileResult>;
27
+ /** The range within a file of `size` bytes, or false when it starts past the end (or is malformed). */
28
+ export declare function clipRange(range: ByteRange, size: number): ByteRange | false;
29
+ export interface ListFilesInput {
30
+ readonly ownerId: string;
31
+ readonly kind?: string;
32
+ /** At most this many, newest first; 100 by default, at most 1000. */
33
+ readonly limit?: number;
34
+ readonly offset?: number;
35
+ }
36
+ /** An owner's live files, newest first. */
37
+ export declare function listFiles(ctx: FilesContext, input: ListFilesInput): Promise<StoredFile[]>;
38
+ /** The bytes an owner keeps in live files, the figure the quota is checked against. */
39
+ export declare function getOwnerUsage(ctx: FilesContext, ownerId: string): Promise<number>;
40
+ export type DeleteFileResult = Ok<undefined> | Err<"files.not_found">;
41
+ /**
42
+ * Deletes a file: it stops being found and served at once, its bytes leave storage, then its row goes. When the
43
+ * storage delete fails the row stays marked deleted and `pruneFiles` finishes the job.
44
+ */
45
+ export declare function deleteFile(ctx: FilesContext, fileId: string, options?: FileLookupOptions): Promise<DeleteFileResult>;
46
+ /** Removes a deleted or expired file's bytes and then its row; answers whether both went. */
47
+ export declare function removeMarkedFile(ctx: FilesContext, row: FileRow): Promise<boolean>;
48
+ //# sourceMappingURL=files.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/server/files.ts"],"names":[],"mappings":"AAEA,OAAO,EAA0B,KAAK,GAAG,EAAE,KAAK,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAE7E,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAClF,OAAO,EAAS,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAgB,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAO/D,MAAM,WAAW,iBAAiB;IAChC,gEAAgE;IAChE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,4EAA4E;AAC5E,wBAAsB,WAAW,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CASlI;AAED,eAAO,MAAM,YAAY,QAAmE,CAAC;AAE7F,4BAA4B;AAC5B,wBAAsB,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAG7H;AAED,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,yEAAyE;IACzE,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAC1C,wEAAwE;IACxE,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,MAAM,cAAc,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,oBAAoB,CAAC,CAAC;AAExE,sHAAsH;AACtH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,CAWxH;AAED,uGAAuG;AACvG,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,KAAK,CAI3E;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,qEAAqE;IACrE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,2CAA2C;AAC3C,wBAAsB,SAAS,CAAC,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAa/F;AAED,uFAAuF;AACvF,wBAAsB,aAAa,CAAC,GAAG,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAEvF;AAED,MAAM,MAAM,gBAAgB,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAEtE;;;GAGG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAY9H;AAED,6FAA6F;AAC7F,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CASxF"}
@@ -0,0 +1,104 @@
1
+ // Reading, listing and deleting stored files. Only live files (neither deleted nor expired) are found; an owner
2
+ // filter makes another owner's file read as missing.
3
+ import { err, errorLogLabel, ok } from "@softure-ai/core";
4
+ import { and, desc, eq, isNull } from "drizzle-orm";
5
+ import { files } from "../schema.js";
6
+ import { toStoredFile } from "./context.js";
7
+ import { getFilesOptions } from "./options.js";
8
+ import { isLive, sumOwnerBytes } from "./queries.js";
9
+ const DEFAULT_LIST_LIMIT = 100;
10
+ const MAX_LIST_LIMIT = 1000;
11
+ /** The live row with this id, or undefined. Not a uuid reads as missing. */
12
+ export async function findLiveRow(ctx, fileId, options = {}) {
13
+ if (!UUID_PATTERN.test(fileId))
14
+ return undefined;
15
+ const conditions = [eq(files.id, fileId), isLive(ctx.clock.now())];
16
+ if (options.ownerId !== undefined)
17
+ conditions.push(eq(files.ownerId, options.ownerId));
18
+ const [row] = await ctx.db
19
+ .select()
20
+ .from(files)
21
+ .where(and(...conditions));
22
+ return row;
23
+ }
24
+ export const UUID_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/;
25
+ /** A live file, or null. */
26
+ export async function findFile(ctx, fileId, options = {}) {
27
+ const row = await findLiveRow(ctx, fileId, options);
28
+ return row === undefined ? null : toStoredFile(row);
29
+ }
30
+ /** A live file's bytes as a stream. A row whose bytes are missing from storage reads as not found (and is logged). */
31
+ export async function openFile(ctx, fileId, options = {}) {
32
+ const row = await findLiveRow(ctx, fileId, options);
33
+ if (row === undefined)
34
+ return err("files.not_found");
35
+ const range = options.range === undefined ? null : clipRange(options.range, row.size);
36
+ if (range === false)
37
+ return err("files.range_not_satisfiable");
38
+ const body = await getFilesOptions(ctx.config).storage.get(row.storageKey, range ?? undefined);
39
+ if (body === null) {
40
+ console.error(`@softure-ai/files: file ${row.id} has a row but no bytes in storage`);
41
+ return err("files.not_found");
42
+ }
43
+ return ok({ file: toStoredFile(row), body, range });
44
+ }
45
+ /** The range within a file of `size` bytes, or false when it starts past the end (or is malformed). */
46
+ export function clipRange(range, size) {
47
+ const isValid = Number.isSafeInteger(range.start) && Number.isSafeInteger(range.end) && range.start >= 0 && range.end >= range.start;
48
+ if (!isValid || range.start >= size)
49
+ return false;
50
+ return { start: range.start, end: Math.min(range.end, size - 1) };
51
+ }
52
+ /** An owner's live files, newest first. */
53
+ export async function listFiles(ctx, input) {
54
+ const limit = Math.min(Math.max(Math.trunc(input.limit ?? DEFAULT_LIST_LIMIT), 1), MAX_LIST_LIMIT);
55
+ const offset = Math.max(Math.trunc(input.offset ?? 0), 0);
56
+ const conditions = [eq(files.ownerId, input.ownerId), isLive(ctx.clock.now())];
57
+ if (input.kind !== undefined)
58
+ conditions.push(eq(files.kind, input.kind));
59
+ const rows = await ctx.db
60
+ .select()
61
+ .from(files)
62
+ .where(and(...conditions))
63
+ .orderBy(desc(files.createdAt), desc(files.id))
64
+ .limit(limit)
65
+ .offset(offset);
66
+ return rows.map(toStoredFile);
67
+ }
68
+ /** The bytes an owner keeps in live files, the figure the quota is checked against. */
69
+ export async function getOwnerUsage(ctx, ownerId) {
70
+ return sumOwnerBytes(ctx.db, ownerId, ctx.clock.now());
71
+ }
72
+ /**
73
+ * Deletes a file: it stops being found and served at once, its bytes leave storage, then its row goes. When the
74
+ * storage delete fails the row stays marked deleted and `pruneFiles` finishes the job.
75
+ */
76
+ export async function deleteFile(ctx, fileId, options = {}) {
77
+ if (!UUID_PATTERN.test(fileId))
78
+ return err("files.not_found");
79
+ const conditions = [eq(files.id, fileId), isNull(files.deletedAt)];
80
+ if (options.ownerId !== undefined)
81
+ conditions.push(eq(files.ownerId, options.ownerId));
82
+ const [marked] = await ctx.db
83
+ .update(files)
84
+ .set({ deletedAt: ctx.clock.now() })
85
+ .where(and(...conditions))
86
+ .returning();
87
+ if (marked === undefined)
88
+ return err("files.not_found");
89
+ await removeMarkedFile(ctx, marked);
90
+ return ok();
91
+ }
92
+ /** Removes a deleted or expired file's bytes and then its row; answers whether both went. */
93
+ export async function removeMarkedFile(ctx, row) {
94
+ try {
95
+ await getFilesOptions(ctx.config).storage.delete(row.storageKey);
96
+ }
97
+ catch (error) {
98
+ console.error(`@softure-ai/files: deleting the bytes of file ${row.id} failed, pruneFiles retries: ${errorLogLabel(error)}`);
99
+ return false;
100
+ }
101
+ await ctx.db.delete(files).where(eq(files.id, row.id));
102
+ return true;
103
+ }
104
+ //# sourceMappingURL=files.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/server/files.ts"],"names":[],"mappings":"AAAA,gHAAgH;AAChH,qDAAqD;AACrD,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,EAAE,EAAqB,MAAM,kBAAkB,CAAC;AAC7E,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAY,MAAM,aAAa,CAAC;AAE9D,OAAO,EAAE,KAAK,EAAgB,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,YAAY,EAAqB,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAErD,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,MAAM,cAAc,GAAG,IAAI,CAAC;AAO5B,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAiB,EAAE,MAAc,EAAE,UAA6B,EAAE;IAClG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACjD,MAAM,UAAU,GAAU,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC1E,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACvF,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE;SACvB,MAAM,EAAE;SACR,IAAI,CAAC,KAAK,CAAC;SACX,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAC7B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,gEAAgE,CAAC;AAE7F,4BAA4B;AAC5B,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAiB,EAAE,MAAc,EAAE,UAA6B,EAAE;IAC/F,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;AACtD,CAAC;AAgBD,sHAAsH;AACtH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAiB,EAAE,MAAc,EAAE,UAA2B,EAAE;IAC7F,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACpD,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IACtF,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,IAAI,SAAS,CAAC,CAAC;IAC/F,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,2BAA2B,GAAG,CAAC,EAAE,oCAAoC,CAAC,CAAC;QACrF,OAAO,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC;IACD,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AACtD,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,SAAS,CAAC,KAAgB,EAAE,IAAY;IACtD,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC;IACrI,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAClD,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC;AACpE,CAAC;AAUD,2CAA2C;AAC3C,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAiB,EAAE,KAAqB;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IACnG,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAU,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACtF,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;QAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,EAAE;SACtB,MAAM,EAAE;SACR,IAAI,CAAC,KAAK,CAAC;SACX,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;SACzB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;SAC9C,KAAK,CAAC,KAAK,CAAC;SACZ,MAAM,CAAC,MAAM,CAAC,CAAC;IAClB,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAChC,CAAC;AAED,uFAAuF;AACvF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAiB,EAAE,OAAe;IACpE,OAAO,aAAa,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;AACzD,CAAC;AAID;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAiB,EAAE,MAAc,EAAE,UAA6B,EAAE;IACjG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC9D,MAAM,UAAU,GAAU,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACvF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,EAAE;SAC1B,MAAM,CAAC,KAAK,CAAC;SACb,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;SACnC,KAAK,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;SACzB,SAAS,EAAE,CAAC;IACf,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACxD,MAAM,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpC,OAAO,EAAE,EAAE,CAAC;AACd,CAAC;AAED,6FAA6F;AAC7F,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,GAAiB,EAAE,GAAY;IACpE,IAAI,CAAC;QACH,MAAM,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,iDAAiD,GAAG,CAAC,EAAE,gCAAgC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC7H,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AACd,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { type HealthCheck } from "@softure-ai/core";
2
+ export type FilesHealthErrorCode = "files.storage_unwritable" | "files.storage_low_space";
3
+ export declare const checkFilesHealth: HealthCheck;
4
+ //# sourceMappingURL=health.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/server/health.ts"],"names":[],"mappings":"AAEA,OAAO,EAAW,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAK7D,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,GAAG,yBAAyB,CAAC;AAE1F,eAAO,MAAM,gBAAgB,EAAE,WAU9B,CAAC"}
@@ -0,0 +1,20 @@
1
+ // The module's readiness probe for `GET /api/health` of `@softure-ai/ops`: the table answers (`softure migrate`
2
+ // ran), and the storage takes a write and keeps at least `health.minFreeBytes` free when its driver can tell.
3
+ import { err, ok } from "@softure-ai/core";
4
+ import { sql } from "drizzle-orm";
5
+ import { getFilesOptions } from "./options.js";
6
+ export const checkFilesHealth = async (context) => {
7
+ // Core types `db` as unknown; the health route passes the @softure-ai/db handle.
8
+ const db = context.db;
9
+ await db.execute(sql `select 1 from files.files limit 0`);
10
+ const options = getFilesOptions(context.config);
11
+ const check = await options.storage.check?.();
12
+ if (check === undefined)
13
+ return ok();
14
+ if (!check.isWritable)
15
+ return err("files.storage_unwritable");
16
+ if (check.freeBytes !== null && check.freeBytes < options.health.minFreeBytes)
17
+ return err("files.storage_low_space");
18
+ return ok();
19
+ };
20
+ //# sourceMappingURL=health.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/server/health.ts"],"names":[],"mappings":"AAAA,gHAAgH;AAChH,8GAA8G;AAC9G,OAAO,EAAE,GAAG,EAAE,EAAE,EAAoB,MAAM,kBAAkB,CAAC;AAE7D,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAI/C,MAAM,CAAC,MAAM,gBAAgB,GAAgB,KAAK,EAAE,OAAO,EAAE,EAAE;IAC7D,iFAAiF;IACjF,MAAM,EAAE,GAAG,OAAO,CAAC,EAAe,CAAC;IACnC,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,CAAA,mCAAmC,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;IAC9C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,EAAE,EAAE,CAAC;IACrC,IAAI,CAAC,KAAK,CAAC,UAAU;QAAE,OAAO,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9D,IAAI,KAAK,CAAC,SAAS,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY;QAAE,OAAO,GAAG,CAAC,yBAAyB,CAAC,CAAC;IACrH,OAAO,EAAE,EAAE,CAAC;AACd,CAAC,CAAC"}
@@ -0,0 +1,15 @@
1
+ export { getStorageKey, type Env, type FilesContext } from "./context.js";
2
+ export { clipRange, deleteFile, findFile, getOwnerUsage, listFiles, openFile, type DeleteFileResult, type FileLookupOptions, type ListFilesInput, type OpenedFile, type OpenFileOptions, type OpenFileResult, } from "./files.js";
3
+ export { checkFilesHealth, type FilesHealthErrorCode } from "./health.js";
4
+ export { FILES_LINK_KEYS_ENV, generateFilesLinkKey, readLinkKeyring, type LinkKeyring, type LinkKeyringResult } from "./keys.js";
5
+ export { createFileLink, revokeFileLinks, verifyFileLink, type CreateFileLinkInput, type CreateFileLinkResult, type RevokeFileLinksResult, type VerifiedLink, type VerifyFileLinkResult, } from "./links.js";
6
+ export { createLocalStorage, type LocalStorageOptions } from "./local-storage.js";
7
+ export { DEFAULT_CONTENT_TYPE, formatContentDisposition, normalizeContentType, sanitizeFileName } from "./names.js";
8
+ export { getFilesModule, getFilesOptions, getLinksRoute } from "./options.js";
9
+ export { deleteFilesUserData, exportFilesUserData, filesPrivacyContributor, type FilesDeletionReport, type FilesUserData } from "./privacy.js";
10
+ export { pruneFiles, type PruneFilesOptions, type PruneFilesReport } from "./prune.js";
11
+ export { createS3Storage, S3_ACCESS_KEY_ID_ENV, S3_SECRET_ACCESS_KEY_ENV, S3StorageError, splitIntoParts, type S3StorageOptions, } from "./s3-storage.js";
12
+ export { saveFile, type SaveFileInput, type SaveFileResult } from "./save.js";
13
+ export { parseRangeHeader, serveFileLink } from "./serve.js";
14
+ export { EMPTY_PAYLOAD_SHA256, encodeRfc3986, signRequest, type SigV4Credentials, type SignRequestInput } from "./sigv4.js";
15
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,KAAK,GAAG,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EACL,SAAS,EACT,UAAU,EACV,QAAQ,EACR,aAAa,EACb,SAAS,EACT,QAAQ,EACR,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,eAAe,EAAE,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACjI,OAAO,EACL,cAAc,EACd,eAAe,EACf,cAAc,EACd,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,YAAY,EACjB,KAAK,oBAAoB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACpH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,KAAK,mBAAmB,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC/I,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACvF,OAAO,EACL,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EACxB,cAAc,EACd,cAAc,EACd,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,WAAW,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC7D,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC"}