Page MenuHomeSealhub
Files F8929085

image.ts
No OneTemporary
Actions

image.ts
View Options

import Field, { ValidationResult } from "../../../chip-types/field.js";
import type { FileDBEntry, FileFromDB } from "../../../data-structures/file.js";
import { Context, ExtractInput, File } from "../../../main.js";
import { module_dirname } from "../../../utils/module_filename.js";
import FileField, { FileStorage, FileStorageFormat } from "./file.js";
import _locreq from "locreq";
const locreq = _locreq(module_dirname(import.meta.url));
/** Like {@link FileField}, but meant for images. Has the capacity to format images and serve thumbnails and different sizes.
*
* **Params**:
* - `default_format` - string - one of the image formats defined in the app config. If not specified otherwise in the `format` parameter upon request, images will be served in the size corresponding to this format.
*/
export default class Image extends FileStorage {
typeName = "image";
default_format: string;
async isProperValue(
context: Context,
input: ExtractInput<FileField>
): Promise<ValidationResult> {
const result = await super.isProperValue(context, input);
if (!result.valid) {
return result;
}
if (Array.isArray(input)) {
if (input.length !== 1) {
throw new Error(
"If you use array for this field, it can only have one file element"
);
}
input = input[0];
}
if (input.getMimeType().indexOf("image/") !== 0) {
return Field.invalid(context.app.i18n("invalid_image"));
}
return Field.valid();
}
setParams(
params: Partial<
Parameters<FileStorage["setParams"]>[0] & {
default_format: string;
}
>
): void {
super.setParams({
get_default_file: () =>
File.fromPath(
this.app,
locreq.resolve(
"src/app/base-chips/field-types/default-image.jpg"
)
),
...params,
});
this.default_format = params.default_format || "url";
}
async decode(
context: Context,
db_value: FileStorageFormat | null,
_: unknown,
format?: "file" | "url" | "path"
): Promise<FileDBEntry | FileFromDB | string | null> {
if (db_value === undefined || db_value === null) {
return null;
}
if (format === "file") {
return File.fromID(context.app, db_value.id);
}
if (format === "path") {
const file = await File.fromID(context.app, db_value.id);
return file.getURL();
}
if (format === "url") {
const file = await File.fromID(context.app, db_value.id);
return `${context.app.manifest.base_url}${file.getURL()}`;
}
return db_value;
}
}

File Metadata

Mime Type
text/x-java
Expires
Sat, Sep 20, 21:35 (4 h, 50 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
949703
Default Alt Text
image.ts (2 KB)

Event Timeline