6 Commits

Author SHA1 Message Date
Sebastian 6e38c6d623 chore(deps): update dependency vuetify to v4.2.1
JS Unit Tests / test (pull_request) Successful in 1m9s
Build Test / test (pull_request) Successful in 1m21s
PHP Integration Tests / Integration Tests (pull_request) Failing after 1m26s
PHP Unit Tests / test (pull_request) Successful in 1m30s
2026-09-11 03:05:47 +00:00
Sebastian 9179492026 refactor(module): register browser integration through context
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
2026-08-31 22:55:11 -04:00
Sebastian dc60b5147e fix(preview): handle unavailable previews as no content
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
2026-08-31 22:55:11 -04:00
Sebastian 874668e67f feat: use new variant type
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
2026-08-29 19:12:28 -04:00
Sebastian 6af5704e5e refactor: simplify preview generation
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
2026-08-29 18:44:52 -04:00
Sebastian 59838af3db feat: implement attachement preview
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
2026-08-29 16:20:52 -04:00
8 changed files with 196 additions and 23 deletions
+33
View File
@@ -180,6 +180,7 @@ class DefaultController extends ControllerAbstract {
'entity.copy' => throw new InvalidArgumentException('Operation not implemented: ' . $operation), 'entity.copy' => throw new InvalidArgumentException('Operation not implemented: ' . $operation),
'entity.submit' => $this->entitySubmit($tenantId, $userId, $data), 'entity.submit' => $this->entitySubmit($tenantId, $userId, $data),
'entity.download' => $this->entityDownload($tenantId, $userId, $data), 'entity.download' => $this->entityDownload($tenantId, $userId, $data),
'entity.preview' => $this->entityPreview($tenantId, $userId, $data),
'entity.blobs' => $this->entityBlobs($tenantId, $userId, $data), 'entity.blobs' => $this->entityBlobs($tenantId, $userId, $data),
default => throw new InvalidArgumentException(self::ERR_INVALID_OPERATION . $operation) default => throw new InvalidArgumentException(self::ERR_INVALID_OPERATION . $operation)
@@ -968,4 +969,36 @@ class DefaultController extends ControllerAbstract {
return $results; return $results;
} }
private function entityPreview(string $tenantId, string $userId, array $data): Response {
if (!isset($data['target']) || !is_string($data['target'])) {
throw new InvalidArgumentException(self::ERR_MISSING_TARGET);
}
if (!isset($data['part']) || !is_array($data['part'])) {
throw new InvalidArgumentException('Attachment preview requires a part');
}
$target = ResourceIdentifier::fromString($data['target']);
if (!$target instanceof EntityIdentifier) {
throw new InvalidArgumentException(self::ERR_INVALID_IDENTIFIER);
}
$preview = $this->manager->entityPreview(
$tenantId,
$userId,
$target,
$data['part'],
isset($data['variant']) && is_string($data['variant']) ? $data['variant'] : 'inline',
);
if ($preview === null) {
return new Response('', Response::HTTP_NO_CONTENT);
}
return new StreamedResponse($preview->resource->stream(), Response::HTTP_OK, [
'Content-Type' => $preview->resource->mimeType(),
'Content-Length' => (string) $preview->size,
'ETag' => '"' . trim($preview->etag, '"') . '"',
'Cache-Control' => 'private, max-age=3600',
'X-Content-Type-Options' => 'nosniff',
]);
}
} }
+50 -7
View File
@@ -5,7 +5,10 @@ declare(strict_types=1);
namespace KTXM\MailManager; namespace KTXM\MailManager;
use InvalidArgumentException; use InvalidArgumentException;
use KTXC\Preview\Preview;
use KTXC\Preview\PreviewManager;
use KTXC\Resource\ProviderManager; use KTXC\Resource\ProviderManager;
use KTXF\Preview\PreviewSource;
use KTXF\Mail\Collection\CollectionBaseInterface; use KTXF\Mail\Collection\CollectionBaseInterface;
use KTXF\Mail\Collection\CollectionPropertiesMutableInterface; use KTXF\Mail\Collection\CollectionPropertiesMutableInterface;
use KTXF\Mail\Collection\ICollectionBase; use KTXF\Mail\Collection\ICollectionBase;
@@ -47,6 +50,7 @@ class Manager {
public function __construct( public function __construct(
private LoggerInterface $logger, private LoggerInterface $logger,
private ProviderManager $providerManager, private ProviderManager $providerManager,
private PreviewManager $previewManager,
) { } ) { }
/** /**
@@ -934,13 +938,6 @@ class Manager {
} }
} }
public function entityDownload(string $tenantId, string $userId, EntityIdentifier $targetEntity, array|null $targetPart): BinaryResource {
// retrieve service
$service = $this->serviceFetch($tenantId, $userId, $targetEntity->provider(), $targetEntity->service());
// download entity
return $service->entityDownload($targetEntity, $targetPart);
}
/** /**
* Check if messages exist * Check if messages exist
* *
@@ -1352,4 +1349,50 @@ class Manager {
return $service->entitySubmit($sender, $source, $message); return $service->entitySubmit($sender, $source, $message);
} }
public function entityDownload(string $tenantId, string $userId, EntityIdentifier $targetEntity, array|null $targetPart): BinaryResource {
// retrieve service
$service = $this->serviceFetch($tenantId, $userId, $targetEntity->provider(), $targetEntity->service());
// download entity
return $service->entityDownload($targetEntity, $targetPart);
}
/**
* Resolve an authorized attachment and lazily generate or retrieve its preview.
*/
public function entityPreview(string $tenantId, string $userId, EntityIdentifier $targetEntity, array $part, string $variant = 'inline'): ?Preview {
$mimeType = $part['type'] ?? null;
$size = $part['size'] ?? null;
if (!is_string($mimeType) || ($size !== null && !is_int($size))) {
throw new InvalidArgumentException('Attachment preview requires a MIME type and optional integer size');
}
$selector = array_filter([
'blobId' => $part['blobId'] ?? null,
'partId' => $part['partId'] ?? null,
'cid' => $part['cid'] ?? null,
], static fn(mixed $value): bool => is_string($value) && $value !== '');
if ($selector === []) {
throw new InvalidArgumentException('Attachment preview requires a blob, part, or content identifier');
}
$attachmentIdentity = hash('sha256', json_encode($selector, JSON_THROW_ON_ERROR));
return $this->previewManager->fetch($tenantId, new PreviewSource(
sourceType: 'mail-attachment',
identity: (string) $targetEntity . ':' . $attachmentIdentity,
// Attachments are immutable once delivered, so there is no revision to track;
// existence and access are enforced by entityDownload() (via serviceFetch) below,
// which only runs on a cache miss.
signature: 'immutable',
mimeType: $mimeType,
size: $size,
resourceFactory: fn(): BinaryResource => $this->entityDownload(
$tenantId,
$userId,
$targetEntity,
$selector,
),
), $variant);
}
} }
+8 -12
View File
@@ -2,7 +2,8 @@
namespace KTXM\MailManager; namespace KTXM\MailManager;
use KTXF\Module\ModuleBrowserInterface; use KTXF\Module\Configuration\BrowserModuleContextInterface;
use KTXF\Module\Configuration\ModuleContextInterface;
use KTXF\Module\ModuleInstanceAbstract; use KTXF\Module\ModuleInstanceAbstract;
/** /**
@@ -11,7 +12,7 @@ use KTXF\Module\ModuleInstanceAbstract;
* Provides unified mail sending and management across multiple providers * Provides unified mail sending and management across multiple providers
* with context-aware service discovery and queued delivery. * with context-aware service discovery and queued delivery.
*/ */
class Module extends ModuleInstanceAbstract implements ModuleBrowserInterface class Module extends ModuleInstanceAbstract
{ {
public function __construct() public function __construct()
@@ -58,15 +59,10 @@ class Module extends ModuleInstanceAbstract implements ModuleBrowserInterface
]; ];
} }
public function registerBI(): array { public function configure(ModuleContextInterface $context): void
return [ {
'handle' => $this->handle(), if ($context instanceof BrowserModuleContextInterface) {
'namespace' => 'MailManager', $context->registerModule($this, 'MailManager', 'static/module.mjs');
'version' => $this->version(), }
'label' => $this->label(),
'author' => $this->author(),
'description' => $this->description(),
'boot' => 'static/module.mjs',
];
} }
} }
+64 -2
View File
@@ -1130,6 +1130,63 @@
} }
} }
}, },
"node_modules/@vuetify/v0": {
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/@vuetify/v0/-/v0-1.2.2.tgz",
"integrity": "sha512-7AvM89l6l/pShSYKa+a5/zsht/xj/l4jFpWFOR6UqSelBrPfKxEQ8heO8iCNEGNK5yljwsdARx0JmDJjJRJdVw==",
"funding": [
{
"type": "github",
"url": "https://github.com/sponsors/johnleider"
},
{
"type": "opencollective",
"url": "https://opencollective.com/vuetify"
}
],
"license": "MIT",
"peerDependencies": {
"@adobe/leonardo-contrast-colors": ">=1.0.0",
"@ant-design/colors": ">=7.0.0",
"@flagsmith/flagsmith": ">=11.0.0",
"@floating-ui/dom": ">=1.8.0",
"@js-temporal/polyfill": ">=0.5.0",
"@material/material-color-utilities": ">=0.3.0",
"launchdarkly-js-client-sdk": "^3.0.0",
"posthog-js": "^1.0.0",
"vue": ">=3.5.0 || >=3.6.0-0",
"vue-i18n": ">=10.0.0"
},
"peerDependenciesMeta": {
"@adobe/leonardo-contrast-colors": {
"optional": true
},
"@ant-design/colors": {
"optional": true
},
"@flagsmith/flagsmith": {
"optional": true
},
"@floating-ui/dom": {
"optional": true
},
"@js-temporal/polyfill": {
"optional": true
},
"@material/material-color-utilities": {
"optional": true
},
"launchdarkly-js-client-sdk": {
"optional": true
},
"posthog-js": {
"optional": true
},
"vue-i18n": {
"optional": true
}
}
},
"node_modules/abbrev": { "node_modules/abbrev": {
"version": "2.0.0", "version": "2.0.0",
"dev": true, "dev": true,
@@ -3005,8 +3062,13 @@
} }
}, },
"node_modules/vuetify": { "node_modules/vuetify": {
"version": "4.1.4", "version": "4.2.1",
"resolved": "https://registry.npmjs.org/vuetify/-/vuetify-4.2.1.tgz",
"integrity": "sha512-K3ZIqu7YkorQFB6//dR5KEBpbfOo+y/LkcGtknsnneE3JN1pW3R7o/JB9QDkJuP1ELhENIdBZIkiSmXu0dQ9lQ==",
"license": "MIT", "license": "MIT",
"dependencies": {
"@vuetify/v0": "^1.2.1"
},
"funding": { "funding": {
"type": "github", "type": "github",
"url": "https://github.com/sponsors/johnleider" "url": "https://github.com/sponsors/johnleider"
@@ -3014,7 +3076,7 @@
"peerDependencies": { "peerDependencies": {
"typescript": ">=4.7", "typescript": ">=4.7",
"vite-plugin-vuetify": ">=2.1.0", "vite-plugin-vuetify": ">=2.1.0",
"vue": "^3.5.0", "vue": "^3.5.0 || ^3.6.0-0",
"webpack-plugin-vuetify": ">=3.1.0" "webpack-plugin-vuetify": ">=3.1.0"
}, },
"peerDependenciesMeta": { "peerDependenciesMeta": {
+6 -1
View File
@@ -2,7 +2,7 @@
* Entity management service * Entity management service
*/ */
import { transceivePost, transceiveStream, transceiveDownload } from './transceive'; import { transceivePost, transceiveStream, transceiveDownload, transceiveBlob } from './transceive';
import type { import type {
EntityFetchRequest, EntityFetchRequest,
EntityFetchResponse, EntityFetchResponse,
@@ -28,6 +28,7 @@ import type {
EntityPatchResponse, EntityPatchResponse,
EntityPatchRequest, EntityPatchRequest,
EntityDownloadRequest, EntityDownloadRequest,
EntityPreviewRequest,
EntityBlobsRequest, EntityBlobsRequest,
EntityBlobsResponse, EntityBlobsResponse,
EntityBlobsWireResponse, EntityBlobsWireResponse,
@@ -231,6 +232,10 @@ export const entityService = {
return transceiveDownload<EntityDownloadRequest>('entity.download', request); return transceiveDownload<EntityDownloadRequest>('entity.download', request);
}, },
async preview(request: EntityPreviewRequest): Promise<Blob> {
return await transceiveBlob<EntityPreviewRequest>('entity.preview', request);
},
/** /**
* Fetch one or more message parts (attachments) inline for rendering. * Fetch one or more message parts (attachments) inline for rendering.
* *
+22
View File
@@ -188,6 +188,28 @@ export function transceiveDownload<TRequest>(
return { transaction: request.transaction }; return { transaction: request.transaction };
} }
export async function transceiveBlob<TRequest>(operation: string, data: TRequest): Promise<Blob> {
const request: ApiRequest<TRequest> = {
version: API_VERSION,
transaction: generateTransactionId(),
operation,
data,
};
let blob: Blob | null = null;
await fetchWrapper.post(API_URL, request, {
headers: { 'Accept': '*/*' },
onStream: async (response: Response) => {
if (response.status === 204) {
throw new Error(`[${operation}] Preview unavailable`);
}
blob = await response.blob();
},
});
if (blob === null) throw new Error(`[${operation}] Empty preview response`);
return blob;
}
function appendHiddenField(form: HTMLFormElement, name: string, value: string): void { function appendHiddenField(form: HTMLFormElement, name: string, value: string): void {
const input = document.createElement('input'); const input = document.createElement('input');
input.type = 'hidden'; input.type = 'hidden';
+6
View File
@@ -10,6 +10,7 @@ import type {
EntityBlobSelector, EntityBlobSelector,
EntityBlobsResponse, EntityBlobsResponse,
EntityDownloadRequest, EntityDownloadRequest,
EntityPreviewRequest,
EntityTransmitRequest, EntityTransmitRequest,
EntityTransmitResponse, EntityTransmitResponse,
} from '../types/entity' } from '../types/entity'
@@ -518,6 +519,10 @@ export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
} }
} }
async function preview(request: EntityPreviewRequest): Promise<Blob> {
return await entityService.preview(request)
}
// Return public API // Return public API
return { return {
// State (readonly) // State (readonly)
@@ -540,6 +545,7 @@ export const useEntitiesStore = defineStore('mailEntitiesStore', () => {
move, move,
transmit, transmit,
download, download,
preview,
blobs, blobs,
} }
}) })
+6
View File
@@ -227,6 +227,12 @@ export interface EntityDownloadRequest {
filename?: string | null; filename?: string | null;
} }
export interface EntityPreviewRequest {
target: EntityIdentifier;
part: EntityBlobSelector & { type: string; size?: number | null };
variant?: string;
}
export interface EntityBlobsRequest { export interface EntityBlobsRequest {
target: EntityIdentifier; target: EntityIdentifier;
parts: EntityBlobSelector[]; parts: EntityBlobSelector[];