alepha 0.15.0 → 0.15.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.
- package/README.md +43 -98
- package/dist/api/audits/index.d.ts +240 -240
- package/dist/api/audits/index.d.ts.map +1 -1
- package/dist/api/audits/index.js +2 -2
- package/dist/api/audits/index.js.map +1 -1
- package/dist/api/files/index.d.ts +185 -185
- package/dist/api/files/index.d.ts.map +1 -1
- package/dist/api/files/index.js +2 -2
- package/dist/api/files/index.js.map +1 -1
- package/dist/api/jobs/index.d.ts +245 -245
- package/dist/api/jobs/index.d.ts.map +1 -1
- package/dist/api/notifications/index.browser.js +4 -4
- package/dist/api/notifications/index.browser.js.map +1 -1
- package/dist/api/notifications/index.d.ts +74 -74
- package/dist/api/notifications/index.d.ts.map +1 -1
- package/dist/api/notifications/index.js +4 -4
- package/dist/api/notifications/index.js.map +1 -1
- package/dist/api/parameters/index.d.ts +221 -221
- package/dist/api/parameters/index.d.ts.map +1 -1
- package/dist/api/users/index.d.ts +1632 -1631
- package/dist/api/users/index.d.ts.map +1 -1
- package/dist/api/users/index.js +26 -34
- package/dist/api/users/index.js.map +1 -1
- package/dist/api/verifications/index.d.ts +132 -132
- package/dist/api/verifications/index.d.ts.map +1 -1
- package/dist/batch/index.d.ts +122 -122
- package/dist/batch/index.d.ts.map +1 -1
- package/dist/bucket/index.d.ts +163 -163
- package/dist/bucket/index.d.ts.map +1 -1
- package/dist/cache/core/index.d.ts +46 -46
- package/dist/cache/core/index.d.ts.map +1 -1
- package/dist/cache/redis/index.d.ts.map +1 -1
- package/dist/cache/redis/index.js +2 -2
- package/dist/cache/redis/index.js.map +1 -1
- package/dist/cli/index.d.ts +5933 -201
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +609 -169
- package/dist/cli/index.js.map +1 -1
- package/dist/command/index.d.ts +296 -296
- package/dist/command/index.d.ts.map +1 -1
- package/dist/command/index.js +19 -19
- package/dist/command/index.js.map +1 -1
- package/dist/core/index.browser.js +268 -79
- package/dist/core/index.browser.js.map +1 -1
- package/dist/core/index.d.ts +768 -694
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.js +268 -79
- package/dist/core/index.js.map +1 -1
- package/dist/core/index.native.js +268 -79
- package/dist/core/index.native.js.map +1 -1
- package/dist/datetime/index.d.ts +44 -44
- package/dist/datetime/index.d.ts.map +1 -1
- package/dist/email/index.d.ts +25 -25
- package/dist/email/index.d.ts.map +1 -1
- package/dist/fake/index.d.ts +5409 -5409
- package/dist/fake/index.d.ts.map +1 -1
- package/dist/fake/index.js +22 -22
- package/dist/fake/index.js.map +1 -1
- package/dist/file/index.d.ts +435 -435
- package/dist/file/index.d.ts.map +1 -1
- package/dist/lock/core/index.d.ts +208 -208
- package/dist/lock/core/index.d.ts.map +1 -1
- package/dist/lock/redis/index.d.ts.map +1 -1
- package/dist/logger/index.d.ts +24 -24
- package/dist/logger/index.d.ts.map +1 -1
- package/dist/logger/index.js +1 -5
- package/dist/logger/index.js.map +1 -1
- package/dist/mcp/index.d.ts +216 -198
- package/dist/mcp/index.d.ts.map +1 -1
- package/dist/mcp/index.js +28 -4
- package/dist/mcp/index.js.map +1 -1
- package/dist/orm/index.browser.js +9 -9
- package/dist/orm/index.browser.js.map +1 -1
- package/dist/orm/index.bun.js +83 -76
- package/dist/orm/index.bun.js.map +1 -1
- package/dist/orm/index.d.ts +961 -960
- package/dist/orm/index.d.ts.map +1 -1
- package/dist/orm/index.js +88 -81
- package/dist/orm/index.js.map +1 -1
- package/dist/queue/core/index.d.ts +244 -244
- package/dist/queue/core/index.d.ts.map +1 -1
- package/dist/queue/redis/index.d.ts.map +1 -1
- package/dist/redis/index.d.ts +105 -105
- package/dist/redis/index.d.ts.map +1 -1
- package/dist/retry/index.d.ts +69 -69
- package/dist/retry/index.d.ts.map +1 -1
- package/dist/router/index.d.ts +6 -6
- package/dist/router/index.d.ts.map +1 -1
- package/dist/scheduler/index.d.ts +108 -26
- package/dist/scheduler/index.d.ts.map +1 -1
- package/dist/scheduler/index.js +393 -1
- package/dist/scheduler/index.js.map +1 -1
- package/dist/security/index.d.ts +532 -209
- package/dist/security/index.d.ts.map +1 -1
- package/dist/security/index.js +1422 -11
- package/dist/security/index.js.map +1 -1
- package/dist/server/auth/index.d.ts +1296 -271
- package/dist/server/auth/index.d.ts.map +1 -1
- package/dist/server/auth/index.js +1249 -18
- package/dist/server/auth/index.js.map +1 -1
- package/dist/server/cache/index.d.ts +56 -56
- package/dist/server/cache/index.d.ts.map +1 -1
- package/dist/server/compress/index.d.ts +3 -3
- package/dist/server/compress/index.d.ts.map +1 -1
- package/dist/server/cookies/index.d.ts +6 -6
- package/dist/server/cookies/index.d.ts.map +1 -1
- package/dist/server/core/index.d.ts +196 -186
- package/dist/server/core/index.d.ts.map +1 -1
- package/dist/server/core/index.js +43 -27
- package/dist/server/core/index.js.map +1 -1
- package/dist/server/cors/index.d.ts +11 -11
- package/dist/server/cors/index.d.ts.map +1 -1
- package/dist/server/health/index.d.ts.map +1 -1
- package/dist/server/helmet/index.d.ts +2 -2
- package/dist/server/helmet/index.d.ts.map +1 -1
- package/dist/server/links/index.browser.js +9 -1
- package/dist/server/links/index.browser.js.map +1 -1
- package/dist/server/links/index.d.ts +83 -83
- package/dist/server/links/index.d.ts.map +1 -1
- package/dist/server/links/index.js +13 -5
- package/dist/server/links/index.js.map +1 -1
- package/dist/server/metrics/index.d.ts +514 -1
- package/dist/server/metrics/index.d.ts.map +1 -1
- package/dist/server/metrics/index.js +4462 -4
- package/dist/server/metrics/index.js.map +1 -1
- package/dist/server/multipart/index.d.ts +6 -6
- package/dist/server/multipart/index.d.ts.map +1 -1
- package/dist/server/proxy/index.d.ts +102 -102
- package/dist/server/proxy/index.d.ts.map +1 -1
- package/dist/server/rate-limit/index.d.ts +16 -16
- package/dist/server/rate-limit/index.d.ts.map +1 -1
- package/dist/server/static/index.d.ts +44 -44
- package/dist/server/static/index.d.ts.map +1 -1
- package/dist/server/swagger/index.d.ts +47 -47
- package/dist/server/swagger/index.d.ts.map +1 -1
- package/dist/sms/index.d.ts +11 -11
- package/dist/sms/index.d.ts.map +1 -1
- package/dist/sms/index.js +3 -3
- package/dist/sms/index.js.map +1 -1
- package/dist/thread/index.d.ts +71 -71
- package/dist/thread/index.d.ts.map +1 -1
- package/dist/thread/index.js +2 -2
- package/dist/thread/index.js.map +1 -1
- package/dist/topic/core/index.d.ts +318 -318
- package/dist/topic/core/index.d.ts.map +1 -1
- package/dist/topic/redis/index.d.ts +6 -6
- package/dist/topic/redis/index.d.ts.map +1 -1
- package/dist/vite/index.d.ts +2324 -1719
- package/dist/vite/index.d.ts.map +1 -1
- package/dist/vite/index.js +123 -475
- package/dist/vite/index.js.map +1 -1
- package/dist/websocket/index.browser.js +3 -3
- package/dist/websocket/index.browser.js.map +1 -1
- package/dist/websocket/index.d.ts +275 -275
- package/dist/websocket/index.d.ts.map +1 -1
- package/dist/websocket/index.js +3 -3
- package/dist/websocket/index.js.map +1 -1
- package/package.json +9 -9
- package/src/api/users/services/SessionService.ts +0 -10
- package/src/cli/apps/AlephaCli.ts +2 -2
- package/src/cli/apps/AlephaPackageBuilderCli.ts +9 -1
- package/src/cli/assets/apiHelloControllerTs.ts +2 -1
- package/src/cli/assets/biomeJson.ts +2 -1
- package/src/cli/assets/claudeMd.ts +9 -4
- package/src/cli/assets/dummySpecTs.ts +2 -1
- package/src/cli/assets/editorconfig.ts +2 -1
- package/src/cli/assets/mainBrowserTs.ts +2 -1
- package/src/cli/assets/mainCss.ts +24 -0
- package/src/cli/assets/tsconfigJson.ts +2 -1
- package/src/cli/assets/webAppRouterTs.ts +2 -1
- package/src/cli/assets/webHelloComponentTsx.ts +6 -2
- package/src/cli/atoms/appEntryOptions.ts +13 -0
- package/src/cli/atoms/buildOptions.ts +1 -1
- package/src/cli/atoms/changelogOptions.ts +1 -1
- package/src/cli/commands/build.ts +63 -47
- package/src/cli/commands/dev.ts +16 -33
- package/src/cli/commands/gen/env.ts +1 -1
- package/src/cli/commands/init.ts +17 -8
- package/src/cli/commands/lint.ts +1 -1
- package/src/cli/defineConfig.ts +9 -0
- package/src/cli/index.ts +2 -1
- package/src/cli/providers/AppEntryProvider.ts +131 -0
- package/src/cli/providers/ViteBuildProvider.ts +82 -0
- package/src/cli/providers/ViteDevServerProvider.ts +350 -0
- package/src/cli/providers/ViteTemplateProvider.ts +27 -0
- package/src/cli/services/AlephaCliUtils.ts +33 -2
- package/src/cli/services/PackageManagerUtils.ts +13 -6
- package/src/cli/services/ProjectScaffolder.ts +72 -49
- package/src/core/Alepha.ts +2 -8
- package/src/core/primitives/$module.ts +12 -0
- package/src/core/providers/KeylessJsonSchemaCodec.spec.ts +257 -0
- package/src/core/providers/KeylessJsonSchemaCodec.ts +396 -14
- package/src/core/providers/SchemaValidator.spec.ts +236 -0
- package/src/logger/providers/PrettyFormatterProvider.ts +0 -9
- package/src/mcp/errors/McpError.ts +30 -0
- package/src/mcp/index.ts +3 -0
- package/src/mcp/transports/SseMcpTransport.ts +16 -6
- package/src/orm/providers/DrizzleKitProvider.ts +3 -5
- package/src/orm/services/Repository.ts +11 -0
- package/src/server/core/index.ts +1 -1
- package/src/server/core/providers/BunHttpServerProvider.ts +1 -1
- package/src/server/core/providers/NodeHttpServerProvider.spec.ts +125 -0
- package/src/server/core/providers/NodeHttpServerProvider.ts +71 -22
- package/src/server/core/providers/ServerLoggerProvider.ts +2 -2
- package/src/server/core/providers/ServerProvider.ts +9 -12
- package/src/server/links/atoms/apiLinksAtom.ts +7 -0
- package/src/server/links/index.browser.ts +2 -0
- package/src/server/links/index.ts +2 -0
- package/src/vite/index.ts +3 -2
- package/src/vite/tasks/buildClient.ts +0 -1
- package/src/vite/tasks/buildServer.ts +68 -21
- package/src/vite/tasks/copyAssets.ts +5 -4
- package/src/vite/tasks/generateSitemap.ts +64 -23
- package/src/vite/tasks/index.ts +0 -2
- package/src/vite/tasks/prerenderPages.ts +49 -24
- package/src/cli/assets/indexHtml.ts +0 -15
- package/src/cli/commands/format.ts +0 -23
- package/src/vite/helpers/boot.ts +0 -117
- package/src/vite/plugins/viteAlephaDev.ts +0 -177
- package/src/vite/tasks/devServer.ts +0 -71
- package/src/vite/tasks/runAlepha.ts +0 -270
- /package/dist/orm/{chunk-DtkW-qnP.js → chunk-DH6iiROE.js} +0 -0
|
@@ -80,114 +80,114 @@ type TObjectUpdate<T extends TObject> = TObject<{ [K in keyof T["properties"]]:
|
|
|
80
80
|
//#region ../../src/orm/primitives/$entity.d.ts
|
|
81
81
|
interface EntityPrimitiveOptions<T extends TObject, Keys = keyof Static<T>> {
|
|
82
82
|
/**
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
83
|
+
* The database table name that will be created for this entity.
|
|
84
|
+
* If not provided, name will be inferred from the $repository variable name.
|
|
85
|
+
*/
|
|
86
86
|
name: string;
|
|
87
87
|
/**
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
* TypeBox schema defining the table structure and column types.
|
|
89
|
+
*/
|
|
90
90
|
schema: T;
|
|
91
91
|
/**
|
|
92
|
-
|
|
93
|
-
|
|
92
|
+
* Database indexes to create for query optimization.
|
|
93
|
+
*/
|
|
94
94
|
indexes?: (Keys | {
|
|
95
95
|
/**
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
* Single column to index.
|
|
97
|
+
*/
|
|
98
98
|
column: Keys;
|
|
99
99
|
/**
|
|
100
|
-
|
|
101
|
-
|
|
100
|
+
* Whether this should be a unique index (enforces uniqueness constraint).
|
|
101
|
+
*/
|
|
102
102
|
unique?: boolean;
|
|
103
103
|
/**
|
|
104
|
-
|
|
105
|
-
|
|
104
|
+
* Custom name for the index. If not provided, generates name automatically.
|
|
105
|
+
*/
|
|
106
106
|
name?: string;
|
|
107
107
|
} | {
|
|
108
108
|
/**
|
|
109
|
-
|
|
110
|
-
|
|
109
|
+
* Multiple columns for composite index (order matters for query optimization).
|
|
110
|
+
*/
|
|
111
111
|
columns: Keys[];
|
|
112
112
|
/**
|
|
113
|
-
|
|
114
|
-
|
|
113
|
+
* Whether this should be a unique index (enforces uniqueness constraint).
|
|
114
|
+
*/
|
|
115
115
|
unique?: boolean;
|
|
116
116
|
/**
|
|
117
|
-
|
|
118
|
-
|
|
117
|
+
* Custom name for the index. If not provided, generates name automatically.
|
|
118
|
+
*/
|
|
119
119
|
name?: string;
|
|
120
120
|
})[];
|
|
121
121
|
/**
|
|
122
|
-
|
|
123
|
-
|
|
122
|
+
* Foreign key constraints to maintain referential integrity.
|
|
123
|
+
*/
|
|
124
124
|
foreignKeys?: Array<{
|
|
125
125
|
/**
|
|
126
|
-
|
|
127
|
-
|
|
126
|
+
* Optional name for the foreign key constraint.
|
|
127
|
+
*/
|
|
128
128
|
name?: string;
|
|
129
129
|
/**
|
|
130
|
-
|
|
131
|
-
|
|
130
|
+
* Local columns that reference the foreign table.
|
|
131
|
+
*/
|
|
132
132
|
columns: Array<keyof Static<T>>;
|
|
133
133
|
/**
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
134
|
+
* Referenced columns in the foreign table.
|
|
135
|
+
* Must be EntityColumn references from other entities.
|
|
136
|
+
*/
|
|
137
137
|
foreignColumns: Array<() => EntityColumn<any>>;
|
|
138
138
|
}>;
|
|
139
139
|
/**
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
140
|
+
* Additional table constraints for data validation.
|
|
141
|
+
*
|
|
142
|
+
* Constraints enforce business rules at the database level, providing
|
|
143
|
+
* an additional layer of data integrity beyond application validation.
|
|
144
|
+
*
|
|
145
|
+
* **Constraint Types**:
|
|
146
|
+
* - **Unique constraints**: Prevent duplicate values across columns
|
|
147
|
+
* - **Check constraints**: Enforce custom validation rules with SQL expressions
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* ```ts
|
|
151
|
+
* constraints: [
|
|
152
|
+
* {
|
|
153
|
+
* name: "unique_user_email",
|
|
154
|
+
* columns: ["email"],
|
|
155
|
+
* unique: true
|
|
156
|
+
* },
|
|
157
|
+
* {
|
|
158
|
+
* name: "valid_age_range",
|
|
159
|
+
* columns: ["age"],
|
|
160
|
+
* check: sql`age >= 0 AND age <= 150`
|
|
161
|
+
* },
|
|
162
|
+
* {
|
|
163
|
+
* name: "unique_user_username_per_tenant",
|
|
164
|
+
* columns: ["tenantId", "username"],
|
|
165
|
+
* unique: true
|
|
166
|
+
* }
|
|
167
|
+
* ]
|
|
168
|
+
* ```
|
|
169
|
+
*/
|
|
170
170
|
constraints?: Array<{
|
|
171
171
|
/**
|
|
172
|
-
|
|
173
|
-
|
|
172
|
+
* Columns involved in this constraint.
|
|
173
|
+
*/
|
|
174
174
|
columns: Array<keyof Static<T>>;
|
|
175
175
|
/**
|
|
176
|
-
|
|
177
|
-
|
|
176
|
+
* Optional name for the constraint.
|
|
177
|
+
*/
|
|
178
178
|
name?: string;
|
|
179
179
|
/**
|
|
180
|
-
|
|
181
|
-
|
|
180
|
+
* Whether this is a unique constraint.
|
|
181
|
+
*/
|
|
182
182
|
unique?: boolean | {};
|
|
183
183
|
/**
|
|
184
|
-
|
|
185
|
-
|
|
184
|
+
* SQL expression for check constraint validation.
|
|
185
|
+
*/
|
|
186
186
|
check?: SQL;
|
|
187
187
|
}>;
|
|
188
188
|
/**
|
|
189
|
-
|
|
190
|
-
|
|
189
|
+
* Advanced Drizzle ORM configuration for complex table setups.
|
|
190
|
+
*/
|
|
191
191
|
config?: (self: BuildExtraConfigColumns<string, FromSchema<T>, "pg">) => PgTableExtraConfigValue[];
|
|
192
192
|
}
|
|
193
193
|
declare class EntityPrimitive<T extends TObject = TObject> {
|
|
@@ -235,8 +235,8 @@ type PgSymbols = {
|
|
|
235
235
|
[PG_REF]: PgRefOptions;
|
|
236
236
|
[PG_ENUM]: PgEnumOptions;
|
|
237
237
|
/**
|
|
238
|
-
|
|
239
|
-
|
|
238
|
+
* @deprecated Use `PG_IDENTITY` instead.
|
|
239
|
+
*/
|
|
240
240
|
[PG_SERIAL]: {};
|
|
241
241
|
};
|
|
242
242
|
type PgSymbolKeys = keyof PgSymbols;
|
|
@@ -339,57 +339,57 @@ declare class FileService {
|
|
|
339
339
|
protected onUploadFile: alepha160.HookPrimitive<"bucket:file:uploaded">;
|
|
340
340
|
protected onDeleteBucketFile: alepha160.HookPrimitive<"bucket:file:deleted">;
|
|
341
341
|
/**
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
342
|
+
* Calculates SHA-256 checksum of a file.
|
|
343
|
+
*
|
|
344
|
+
* @param file - The file to calculate checksum for
|
|
345
|
+
* @returns Hexadecimal string representation of the SHA-256 hash
|
|
346
|
+
* @protected
|
|
347
|
+
*/
|
|
348
348
|
protected calculateChecksum(file: FileLike): Promise<string>;
|
|
349
349
|
/**
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
350
|
+
* Gets a bucket primitive by name.
|
|
351
|
+
*
|
|
352
|
+
* @param bucketName - The name of the bucket to retrieve (defaults to "default")
|
|
353
|
+
* @returns The bucket primitive
|
|
354
|
+
* @throws {NotFoundError} If the bucket is not found
|
|
355
|
+
*/
|
|
356
356
|
bucket(bucketName?: string): BucketPrimitive;
|
|
357
357
|
/**
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
358
|
+
* Finds files matching the given query criteria with pagination support.
|
|
359
|
+
* Supports filtering by bucket, tags, name, mimeType, creator, and date range.
|
|
360
|
+
*
|
|
361
|
+
* @param q - Query parameters including bucket, tags, name, mimeType, creator, date range, pagination, and sorting
|
|
362
|
+
* @returns Paginated list of file entities
|
|
363
|
+
*/
|
|
364
364
|
findFiles(q?: FileQuery): Promise<Page<FileEntity>>;
|
|
365
365
|
/**
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
366
|
+
* Finds files that have expired based on their expiration date.
|
|
367
|
+
* Limited to 1000 files per call to prevent memory issues.
|
|
368
|
+
*
|
|
369
|
+
* @returns Array of expired file entities
|
|
370
|
+
*/
|
|
371
371
|
findExpiredFiles(): Promise<FileEntity[]>;
|
|
372
372
|
/**
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
373
|
+
* Calculates an expiration date based on a TTL (time to live) duration.
|
|
374
|
+
*
|
|
375
|
+
* @param ttl - Duration like "1 day", "2 hours", etc.
|
|
376
|
+
* @returns DateTime representation of the expiration date, or undefined if no TTL provided
|
|
377
|
+
* @protected
|
|
378
|
+
*/
|
|
379
379
|
protected getExpirationDate(ttl?: DurationLike): string | undefined;
|
|
380
380
|
/**
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
381
|
+
* Uploads a file to a bucket and creates a database record with metadata.
|
|
382
|
+
* Automatically calculates and stores the file checksum (SHA-256).
|
|
383
|
+
*
|
|
384
|
+
* @param file - The file to upload
|
|
385
|
+
* @param options - Upload options including bucket, expiration, user, and tags
|
|
386
|
+
* @param options.bucket - Target bucket name (defaults to "default")
|
|
387
|
+
* @param options.expirationDate - When the file should expire
|
|
388
|
+
* @param options.user - User performing the upload (for audit trail)
|
|
389
|
+
* @param options.tags - Tags to associate with the file
|
|
390
|
+
* @returns The created file entity with all metadata
|
|
391
|
+
* @throws {NotFoundError} If the specified bucket doesn't exist
|
|
392
|
+
*/
|
|
393
393
|
uploadFile(file: FileLike, options?: {
|
|
394
394
|
expirationDate?: string | DateTime;
|
|
395
395
|
bucket?: string;
|
|
@@ -397,63 +397,63 @@ declare class FileService {
|
|
|
397
397
|
tags?: string[];
|
|
398
398
|
}): Promise<FileEntity>;
|
|
399
399
|
/**
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
400
|
+
* Streams a file from storage by its database ID.
|
|
401
|
+
*
|
|
402
|
+
* @param id - The database ID (UUID) of the file to stream
|
|
403
|
+
* @returns The file object ready for streaming/downloading
|
|
404
|
+
* @throws {NotFoundError} If the file doesn't exist in the database
|
|
405
|
+
* @throws {FileNotFoundError} If the file exists in database but not in storage
|
|
406
|
+
*/
|
|
407
407
|
streamFile(id: string): Promise<FileLike>;
|
|
408
408
|
/**
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
409
|
+
* Updates file metadata (name, tags, expiration date).
|
|
410
|
+
* Does not modify the actual file content in storage.
|
|
411
|
+
*
|
|
412
|
+
* @param id - The database ID (UUID) of the file to update
|
|
413
|
+
* @param data - Partial file data to update
|
|
414
|
+
* @param data.name - New file name
|
|
415
|
+
* @param data.tags - New tags array
|
|
416
|
+
* @param data.expirationDate - New expiration date
|
|
417
|
+
* @returns The updated file entity
|
|
418
|
+
* @throws {NotFoundError} If the file doesn't exist in the database
|
|
419
|
+
*/
|
|
420
420
|
updateFile(id: string, data: {
|
|
421
421
|
name?: string;
|
|
422
422
|
tags?: string[];
|
|
423
423
|
expirationDate?: DateTime | string;
|
|
424
424
|
}): Promise<FileEntity>;
|
|
425
425
|
/**
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
426
|
+
* Deletes a file from both storage and database.
|
|
427
|
+
* Handles cases where file is already deleted from storage gracefully.
|
|
428
|
+
* Always ensures database record is removed even if storage deletion fails.
|
|
429
|
+
*
|
|
430
|
+
* @param id - The database ID (UUID) of the file to delete
|
|
431
|
+
* @returns Success response with the deleted file ID
|
|
432
|
+
* @throws {NotFoundError} If the file doesn't exist in the database
|
|
433
|
+
*/
|
|
434
434
|
deleteFile(id: string): Promise<Ok>;
|
|
435
435
|
/**
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
436
|
+
* Retrieves a file entity by its ID.
|
|
437
|
+
* If already an entity object, returns it as-is (convenience method).
|
|
438
|
+
*
|
|
439
|
+
* @param id - Either a UUID string or an existing FileEntity object
|
|
440
|
+
* @returns The file entity
|
|
441
|
+
* @throws {NotFoundError} If the file doesn't exist in the database
|
|
442
|
+
*/
|
|
443
443
|
getFileById(id: string | FileEntity): Promise<FileEntity>;
|
|
444
444
|
/**
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
445
|
+
* Gets storage statistics including total size, file count, and breakdowns by bucket and MIME type.
|
|
446
|
+
*
|
|
447
|
+
* @returns Storage statistics with aggregated data
|
|
448
|
+
*/
|
|
449
449
|
getStorageStats(): Promise<StorageStats>;
|
|
450
450
|
/**
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
451
|
+
* Converts a file entity to a file resource (API response format).
|
|
452
|
+
* Currently a pass-through, but allows for future transformation logic.
|
|
453
|
+
*
|
|
454
|
+
* @param entity - The file entity to convert
|
|
455
|
+
* @returns The file resource for API responses
|
|
456
|
+
*/
|
|
457
457
|
entityToResource(entity: FileEntity): FileResource;
|
|
458
458
|
}
|
|
459
459
|
//#endregion
|
|
@@ -467,10 +467,10 @@ declare class AdminFileStatsController {
|
|
|
467
467
|
protected readonly group = "admin:files";
|
|
468
468
|
protected readonly fileService: FileService;
|
|
469
469
|
/**
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
470
|
+
* GET /files/stats - Gets storage statistics.
|
|
471
|
+
* Returns aggregated data including total size, file count,
|
|
472
|
+
* and breakdowns by bucket and MIME type.
|
|
473
|
+
*/
|
|
474
474
|
readonly getStats: alepha_server0.ActionPrimitiveFn<{
|
|
475
475
|
response: alepha160.TObject<{
|
|
476
476
|
totalSize: alepha160.TNumber;
|
|
@@ -498,9 +498,9 @@ declare class FileController {
|
|
|
498
498
|
protected readonly group = "files";
|
|
499
499
|
protected readonly fileService: FileService;
|
|
500
500
|
/**
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
501
|
+
* GET /files - Lists files with optional filtering and pagination.
|
|
502
|
+
* Supports filtering by bucket and tags.
|
|
503
|
+
*/
|
|
504
504
|
readonly findFiles: alepha_server0.ActionPrimitiveFn<{
|
|
505
505
|
query: alepha160.TObject<{
|
|
506
506
|
page: alepha160.TOptional<alepha160.TInteger>;
|
|
@@ -533,9 +533,9 @@ declare class FileController {
|
|
|
533
533
|
}>>;
|
|
534
534
|
}>;
|
|
535
535
|
/**
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
536
|
+
* DELETE /files/:id - Deletes a file from both storage and database.
|
|
537
|
+
* Removes the file from the bucket and cleans up the database record.
|
|
538
|
+
*/
|
|
539
539
|
readonly deleteFile: alepha_server0.ActionPrimitiveFn<{
|
|
540
540
|
params: alepha160.TObject<{
|
|
541
541
|
id: alepha160.TString;
|
|
@@ -547,10 +547,10 @@ declare class FileController {
|
|
|
547
547
|
}>;
|
|
548
548
|
}>;
|
|
549
549
|
/**
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
550
|
+
* POST /files - Uploads a new file to storage.
|
|
551
|
+
* Creates a database record with metadata and calculates checksum.
|
|
552
|
+
* Optionally specify bucket and expiration date.
|
|
553
|
+
*/
|
|
554
554
|
readonly uploadFile: alepha_server0.ActionPrimitiveFn<{
|
|
555
555
|
body: alepha160.TObject<{
|
|
556
556
|
file: alepha160.TFile;
|
|
@@ -578,9 +578,9 @@ declare class FileController {
|
|
|
578
578
|
}>;
|
|
579
579
|
}>;
|
|
580
580
|
/**
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
581
|
+
* PATCH /files/:id - Updates file metadata.
|
|
582
|
+
* Allows updating name, tags, and expiration date without modifying file content.
|
|
583
|
+
*/
|
|
584
584
|
readonly updateFile: alepha_server0.ActionPrimitiveFn<{
|
|
585
585
|
params: alepha160.TObject<{
|
|
586
586
|
id: alepha160.TString;
|
|
@@ -609,10 +609,10 @@ declare class FileController {
|
|
|
609
609
|
}>;
|
|
610
610
|
}>;
|
|
611
611
|
/**
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
612
|
+
* GET /files/:id - Streams/downloads a file by its ID.
|
|
613
|
+
* Returns the file content with appropriate Content-Type header.
|
|
614
|
+
* Cached with ETag support for 1 year (immutable).
|
|
615
|
+
*/
|
|
616
616
|
readonly streamFile: alepha_server0.ActionPrimitiveFn<{
|
|
617
617
|
params: alepha160.TObject<{
|
|
618
618
|
id: alepha160.TString;
|
|
@@ -631,22 +631,22 @@ declare class FileJobs {
|
|
|
631
631
|
declare module "alepha/bucket" {
|
|
632
632
|
interface BucketFileOptions {
|
|
633
633
|
/**
|
|
634
|
-
|
|
635
|
-
|
|
634
|
+
* Time to live for the files in the bucket.
|
|
635
|
+
*/
|
|
636
636
|
ttl?: DurationLike;
|
|
637
637
|
/**
|
|
638
|
-
|
|
639
|
-
|
|
638
|
+
* Tags for the bucket.
|
|
639
|
+
*/
|
|
640
640
|
tags?: string[];
|
|
641
641
|
/**
|
|
642
|
-
|
|
643
|
-
|
|
642
|
+
* User performing the operation.
|
|
643
|
+
*/
|
|
644
644
|
user?: UserAccountToken;
|
|
645
645
|
/**
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
646
|
+
* Whether to persist the file metadata in the database.
|
|
647
|
+
*
|
|
648
|
+
* @default true
|
|
649
|
+
*/
|
|
650
650
|
persist?: boolean;
|
|
651
651
|
}
|
|
652
652
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/api/files/entities/files.ts","../../../src/api/files/schemas/fileQuerySchema.ts","../../../src/orm/schemas/insertSchema.ts","../../../src/orm/schemas/updateSchema.ts","../../../src/orm/primitives/$entity.ts","../../../src/orm/constants/PG_SYMBOLS.ts","../../../src/orm/helpers/pgAttr.ts","../../../src/api/files/schemas/fileResourceSchema.ts","../../../src/api/files/schemas/storageStatsSchema.ts","../../../src/api/files/services/FileService.ts","../../../src/api/files/controllers/AdminFileStatsController.ts","../../../src/api/files/controllers/FileController.ts","../../../src/api/files/jobs/FileJobs.ts","../../../src/api/files/index.ts"],"mappings":";;;;;;;;;;;;;;;;;;cAGa,KAAA,EAAK,YAAA,CAAA,eAAA,WAAA,OAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/api/files/entities/files.ts","../../../src/api/files/schemas/fileQuerySchema.ts","../../../src/orm/schemas/insertSchema.ts","../../../src/orm/schemas/updateSchema.ts","../../../src/orm/primitives/$entity.ts","../../../src/orm/constants/PG_SYMBOLS.ts","../../../src/orm/helpers/pgAttr.ts","../../../src/api/files/schemas/fileResourceSchema.ts","../../../src/api/files/schemas/storageStatsSchema.ts","../../../src/api/files/services/FileService.ts","../../../src/api/files/controllers/AdminFileStatsController.ts","../../../src/api/files/controllers/FileController.ts","../../../src/api/files/jobs/FileJobs.ts","../../../src/api/files/index.ts"],"mappings":";;;;;;;;;;;;;;;;;;cAGa,KAAA,EAAK,YAAA,CAAA,eAAA,WAAA,OAAA;8CA6BhB,SAAA,CAAA,OAAA;;;;;;;;;;;;;;;;KAEU,UAAA,GAAa,MAAA,QAAc,KAAA,CAAM,MAAA;;;cC9BhC,eAAA,YAAe,OAAA;4BAQ1B,SAAA,CAAA,QAAA;;;;;;;;;;;KAEU,SAAA,GAAY,MAAA,QAAc,eAAA;;;;;;;;;;;KCD1B,aAAA,WAAwB,OAAA,IAAW,OAAA,eACjC,CAAA,iBAAkB,CAAA,eAAgB,CAAA;EAAA,CACvC,UAAA;AAAA;EACD,WAAA;AAAA,IACF,SAAA,CAAU,CAAA,eAAgB,CAAA,KAC1B,CAAA,eAAgB,CAAA;;;;;;;;;;;;KCDV,aAAA,WAAwB,OAAA,IAAW,OAAA,eACjC,CAAA,iBAAkB,CAAA,eAAgB,CAAA,UAAW,SAAA,YACrD,SAAA,CAAU,MAAA,EAAQ,CAAA,EAAG,KAAA,MACrB,CAAA,eAAgB,CAAA;;;UCgBL,sBAAA,WACL,OAAA,eACG,MAAA,CAAO,CAAA;;;;;EAMpB,IAAA;;;;EAKA,MAAA,EAAQ,CAAA;;;;EAKR,OAAA,IACI,IAAA;;;;IAKE,MAAA,EAAQ,IAAA;;;;IAIR,MAAA;;;;IAIA,IAAA;EAAA;;;;IAMA,OAAA,EAAS,IAAA;;;;IAIT,MAAA;IJ3EU;;;II+EV,IAAA;EAAA;;;;EAON,WAAA,GAAc,KAAA;;;;IAIZ,IAAA;;;;IAIA,OAAA,EAAS,KAAA,OAAY,MAAA,CAAO,CAAA;;;;;IAK5B,cAAA,EAAgB,KAAA,OAAY,YAAA;EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkC9B,WAAA,GAAc,KAAA;;;;IAIZ,OAAA,EAAS,KAAA,OAAY,MAAA,CAAO,CAAA;IJ1GV;;;II8GlB,IAAA;IJ9GmC;;;IIkHnC,MAAA;;;;IAIA,KAAA,GAAQ,GAAA;EAAA;;;;EAMV,MAAA,IACE,IAAA,EAAM,uBAAA,SAAgC,UAAA,CAAW,CAAA,aAC9C,uBAAA;AAAA;AAAA,cAKM,eAAA,WAA0B,OAAA,GAAU,OAAA;EAAA,SAC/B,OAAA,EAAS,sBAAA,CAAuB,CAAA;cAEpC,OAAA,EAAS,sBAAA,CAAuB,CAAA;EAI5C,KAAA,CAAM,KAAA;EAAA,IAYF,IAAA,CAAA,GAAQ,aAAA,CAAc,CAAA;EAAA,IActB,IAAA,CAAA;EAAA,IAIA,MAAA,CAAA,GAAU,CAAA;EAAA,IAIV,YAAA,CAAA,GAAgB,aAAA,CAAc,CAAA;EAAA,IAI9B,YAAA,CAAA,GAAgB,aAAA,CAAc,CAAA;AAAA;;;;KAYxB,UAAA,WAAqB,OAAA,oBACjB,CAAA,iBAAkB,mBAAA;AAAA,KAYtB,YAAA,WAAuB,OAAA;EACjC,IAAA;EACA,MAAA,EAAQ,eAAA,CAAgB,CAAA;AAAA;AAAA,KAGd,aAAA,WAAwB,OAAA,oBACpB,CAAA,iBAAkB,YAAA,CAAa,CAAA;;;cC3OlC,UAAA;AAAA,cACA,cAAA;AAAA,cACA,aAAA;AAAA,cACA,aAAA;AAAA,cACA,aAAA;AAAA,cACA,UAAA;AAAA,cACA,WAAA;AAAA,cACA,OAAA;AAAA,cACA,MAAA;;;;cAKA,SAAA;AAAA,KAMD,SAAA;EAAA,CACT,UAAA;EAAA,CACA,cAAA;EAAA,CACA,aAAA;EAAA,CACA,aAAA;EAAA,CACA,aAAA;EAAA,CACA,UAAA;EAAA,CACA,WAAA,GAAc,iBAAA;EAAA,CACd,MAAA,GAAS,YAAA;EAAA,CACT,OAAA,GAAU,aAAA;;;;GAKV,SAAA;AAAA;AAAA,KAGS,YAAA,SAAqB,SAAA;AAAA,KAErB,iBAAA;EACV,IAAA;AAAA,IACE,iBAAA;EACA,IAAA;AAAA;AAAA,UAGa,aAAA;EACf,IAAA;EACA,WAAA;AAAA;AAAA,UAGe,YAAA;EACf,GAAA;IACE,IAAA;IACA,MAAA,EAAQ,eAAA;EAAA;EAEV,OAAA;IACE,QAAA,GAAW,kBAAA;IACX,QAAA,GAAW,kBAAA;EAAA;AAAA;;;;;;KCTH,MAAA,WAAiB,OAAA,gBAAuB,YAAA,IAAgB,CAAA,WAC5D,KAAA,GAAQ,SAAA,CAAU,CAAA;;;cCnDb,kBAAA,YAAkB,OAAA;oBAO9B,SAAA,CAAA,OAAA;;;;;;;;;;;;;;;;KAEW,YAAA,GAAe,MAAA,QAAc,kBAAA;;;cCT5B,iBAAA,YAAiB,OAAA;UAI5B,SAAA,CAAA,OAAA;;;;cAEW,mBAAA,YAAmB,OAAA;YAG9B,SAAA,CAAA,OAAA;;;cAEW,kBAAA,YAAkB,OAAA;aAK7B,SAAA,CAAA,OAAA;;;;;;;;;;;;KAEU,WAAA,GAAc,MAAA,QAAc,iBAAA;AAAA,KAC5B,aAAA,GAAgB,MAAA,QAAc,mBAAA;AAAA,KAC9B,YAAA,GAAe,MAAA,QAAc,kBAAA;;;cCD5B,WAAA;EAAA,mBACQ,MAAA,EAAM,MAAA;EAAA,mBACN,GAAA,EADM,cAAA,CACH,MAAA;EAAA,mBACH,cAAA,EAAc,YAAA,CAAA,UAAA,WAAA,OAAA;gDADX,SAAA,CAAA,OAAA;;;;;;;;;;;;;;;;qBAEH,gBAAA,EAAgB,gBAAA;EAAA,mBAChB,aAAA,EAAa,eAAA;EAAA,UAEtB,YAAA,EAFsB,SAAA,CAEV,aAAA;EAAA,UAuBZ,kBAAA,EAvBY,SAAA,CAuBM,aAAA;;;;;;;;YAmBZ,iBAAA,CAAkB,IAAA,EAAM,QAAA,GAAW,OAAA;;;;;;;;EAc5C,MAAA,CAAO,UAAA,YAA+C,eAAA;;;;;;;;EAqBhD,SAAA,CAAU,CAAA,GAAG,SAAA,GAAiB,OAAA,CAAQ,IAAA,CAAK,UAAA;;;;;;;EAoD3C,gBAAA,CAAA,GAAoB,OAAA,CAAQ,UAAA;;;;;;;;YAgB/B,iBAAA,CAAkB,GAAA,GAAM,YAAA;;;;;;;;;;;;;;EAsBrB,UAAA,CACX,IAAA,EAAM,QAAA,EACN,OAAA;IACE,cAAA,YAA0B,QAAA;IAC1B,MAAA;IACA,IAAA,GAAO,gBAAA;IACP,IAAA;EAAA,IAED,OAAA,CAAQ,UAAA;;;;;;;;;EAsCE,UAAA,CAAW,EAAA,WAAa,OAAA,CAAQ,QAAA;;;;;;;;;;;;;EAmBhC,UAAA,CACX,EAAA,UACA,IAAA;IACE,IAAA;IACA,IAAA;IACA,cAAA,GAAiB,QAAA;EAAA,IAElB,OAAA,CAAQ,UAAA;;;AT1Ob;;;;;;;ESyQe,UAAA,CAAW,EAAA,WAAa,OAAA,CAAQ,EAAA;ETzQI;;;;AC9BnD;;;;EQ0Ue,WAAA,CAAY,EAAA,WAAa,UAAA,GAAa,OAAA,CAAQ,UAAA;;;;;;EAa9C,eAAA,CAAA,GAAmB,OAAA,CAAQ,YAAA;;;;;;;;EAoDjC,gBAAA,CAAiB,MAAA,EAAQ,UAAA,GAAa,YAAA;AAAA;;;;;;;cCtYlC,wBAAA;EAAA,mBACQ,GAAA;EAAA,mBACA,KAAA;EAAA,mBACA,WAAA,EAAW,WAAA;;;;;;WAOd,QAAA,iBAAQ,iBAAA;;iBAPM,SAAA,CAAA,OAAA;;;;;;;;;;;;;;;;;;;;cCFnB,cAAA;EAAA,mBACQ,GAAA;EAAA,mBACA,KAAA;EAAA,mBACA,WAAA,EAAW,WAAA;;;;;WAMd,SAAA,iBAAS,iBAAA;;gCANK,SAAA,CAAA,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqBd,UAAA,iBAAU,iBAAA;;UAfD,SAAA,CAAA,OAAA;IAAA;;;;;;;;;;;;WAkCT,UAAA,iBAAU,iBAAA;;YAnBA,SAAA,CAAA,KAAA;IAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4CV,UAAA,iBAAU,iBAAA;;UAzBA,SAAA,CAAA,OAAA;IAAA;;;;;;;;;;;;;;;;;;;;;;;;EXnBhB;;;;;EAAA,SWoEM,UAAA,iBAAU,iBAAA;;UAxBA,SAAA,CAAA,OAAA;IAAA;;;;;;cC1Ef,QAAA;EAAA,mBACQ,WAAA,EAAW,WAAA;EAAA,SAEd,UAAA,EAFc,iBAAA,CAEJ,kBAAA;AAAA;;;;YCgBhB,iBAAA;;;;IAIR,GAAA,GAAM,YAAA;;;;IAKN,IAAA;Ib7BS;;;IakCT,IAAA,GAAO,gBAAA;;;;;;IAOP,OAAA;EAAA;AAAA;;;;;;;;;cAcS,cAAA,EAAc,SAAA,CAAA,OAAA,CAYzB,SAAA,CAZyB,MAAA"}
|
package/dist/api/files/index.js
CHANGED
|
@@ -478,8 +478,8 @@ var FileJobs = class {
|
|
|
478
478
|
description: "Purge files that are marked for deletion",
|
|
479
479
|
cron: "*/15 * * * *",
|
|
480
480
|
handler: async () => {
|
|
481
|
-
const files
|
|
482
|
-
await Promise.all(files
|
|
481
|
+
const files = await this.fileService.findExpiredFiles();
|
|
482
|
+
await Promise.all(files.map((file) => this.fileService.deleteFile(file.id)));
|
|
483
483
|
}
|
|
484
484
|
});
|
|
485
485
|
};
|