DBlobs: subsystem for storing blobs

Uses Dexie.js fro IndexedDB access.
2026-05-10 21:50:14 -07:00 · 2024-05-14 02:06:04 -07:00
parent 44ab0483b6
commit a9c1c34dc9
4 changed files with 260 additions and 0 deletions
@@ -30,6 +30,7 @@
        "@vercel/speed-insights": "^1.0.10",
        "browser-fs-access": "^0.35.0",
        "cheerio": "^1.0.0-rc.12",
+        "dexie": "^4.0.4",
        "eventsource-parser": "^1.1.2",
        "idb-keyval": "^6.2.1",
        "next": "~14.1.4",
@@ -3257,6 +3258,11 @@
      "integrity": "sha512-wvq+KscQ7/6spEV7czhnZc9RM/woz1AY+/Vpd8/h2HFMwJSdTliu7f/yr1A6vDdJfKICZsShqsYpEQbdhg8AFQ==",
      "dev": true
    },
+    "node_modules/dexie": {
+      "version": "4.0.4",
+      "resolved": "https://registry.npmjs.org/dexie/-/dexie-4.0.4.tgz",
+      "integrity": "sha512-wFzwWSUdi+MC3jiFeQcCp9nInR7EaX8edzYY+4wmiITkQAiSnHpe4Wo2o5Ce5tJZe2nqt7mLW91MsW4GYx3ziQ=="
+    },
    "node_modules/dir-glob": {
      "version": "3.0.1",
      "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz",
@@ -39,6 +39,7 @@
    "@vercel/speed-insights": "^1.0.10",
    "browser-fs-access": "^0.35.0",
    "cheerio": "^1.0.0-rc.12",
+    "dexie": "^4.0.4",
    "eventsource-parser": "^1.1.2",
    "idb-keyval": "^6.2.1",
    "next": "~14.1.4",
@@ -0,0 +1,69 @@
+import Dexie from 'dexie';
+
+import { DBlobAudioItem, DBlobDBItem, DBlobImageItem, DBlobItem, DBlobMetaDataType } from './dblobs.types';
+
+
+class DigitalAssetsDB extends Dexie {
+  items!: Dexie.Table<DBlobDBItem, string>;
+
+  constructor() {
+    super('DigitalAssetsDB');
+    this.version(1).stores({
+      items: 'id, uId, wId, cId, type, data.mimeType, origin.origin, origin.dir, origin.source, createdAt, updatedAt', // Index common properties
+    });
+  }
+}
+
+const db = new DigitalAssetsDB();
+
+
+// CRUD
+
+
+export async function addDBlobItem(item: DBlobItem): Promise<void> {
+  const dbItem: DBlobDBItem = {
+    ...item,
+    uId: '1',
+    wId: '1',
+    cId: 'global', // context Id
+  };
+  await db.items.add(dbItem);
+}
+
+export async function getDBlobItemsByType<T extends DBlobItem>(type: T['type']) {
+  return await db.items.where('type').equals(type).toArray() as unknown as T[];
+}
+
+export async function getItemsByMimeType<T extends DBlobItem>(mimeType: T['data']['mimeType']) {
+  return await db.items.where('data.mimeType').equals(mimeType).toArray() as unknown as T[];
+}
+
+export async function getItemById<T extends DBlobItem = DBlobItem>(id: string) {
+  return await db.items.get(id) as T | undefined;
+}
+
+export async function updateDBlobItem(id: string, updates: Partial<DBlobItem>) {
+  return db.items.update(id, updates);
+}
+
+export async function deleteDBlobItem(id: string) {
+  return db.items.delete(id);
+}
+
+
+// Example usage:
+async function getAllImages(): Promise<DBlobImageItem[]> {
+  return await getDBlobItemsByType<DBlobImageItem>(DBlobMetaDataType.IMAGE);
+}
+
+async function getAllAudio(): Promise<DBlobAudioItem[]> {
+  return await getDBlobItemsByType<DBlobAudioItem>(DBlobMetaDataType.AUDIO);
+}
+
+async function getHighResImages() {
+  return await db.items
+    .where('data.mimeType')
+    .startsWith('image/')
+    .and(item => (item as DBlobImageItem).metadata.width > 1920)
+    .toArray() as DBlobImageItem[];
+}
@@ -0,0 +1,184 @@
+import { v4 as uuidv4 } from 'uuid';
+
+
+// Blob
+
+enum DBlobMimeType {
+  IMG_PNG = 'image/png', IMG_JPEG = 'image/jpeg',
+  AUDIO_MPEG = 'audio/mpeg', AUDIO_WAV = 'audio/wav',
+  // VIDEO_MP4 = 'video/mp4',
+  // DOCUMENT_PDF = 'application/pdf', DOCUMENT_PLAIN = 'text/plain', DOCUMENT_HTML = 'text/html',
+  // ...
+}
+
+interface DBlobData<M extends DBlobMimeType> {
+  mimeType: M; // | ArrayBuffer; // Base64 encoded content or ArrayBuffer
+  base64: string; // Base64 encoded content
+  size?: number; // Size in bytes (optional)
+  altMimeType?: DBlobMimeType; // Alternative MIME type for the input (optional)
+  altData?: string; // Alternative data for the input (optional)
+}
+
+
+// Item Origin
+
+interface UploadOrigin {
+  origin: 'upload';
+  dir: 'out';
+  source: 'attachment'; // 'attachment' | 'message' | 'note' | 'task' | 'event' | 'contact' | 'file' | 'url' | 'text' | 'ego'..
+  fileName: string;
+  fileSize?: number; // Size of the uploaded file (optional)
+  fileType?: string; // Type of the uploaded file (optional)
+  attachmentMessageId?: string; // ID of the message that the attachment is associated with (optional)
+}
+
+interface GeneratedOrigin {
+  origin: 'generated';
+  dir: 'in';
+  source: 'ai-text-to-image';
+  generatorName: string;
+  parameters: { [key: string]: any }; // Parameters used for generation
+  generatedAt?: string; // When was generated (optional ISO date)
+}
+
+/*interface UrlOrigin {
+  source: 'url';
+  dir: OriginDirection;
+  url: string; // URL of the source
+  // refUrl: string; // Reference URL
+  fetchedAt?: string; // When the URL was fetched (optional ISO date)
+}
+
+interface FileOrigin {
+  source: 'file';
+  dir: OriginDirection;
+  filePath: string;
+  fileLastModifiedAt?: string; // Modified date of the file (optional ISO date)
+}
+
+interface TextOrigin {
+  source: 'text';
+  dir: OriginDirection;
+  method: 'clipboard-read' | 'drop' | 'paste';
+  textPlain?: string; // Plain text content (optional)
+  textHtml?: string; // HTML text content (optional)
+  capturedAt?: string; // Time when the text was captured (optional ISO date)
+}
+
+interface EgoOrigin {
+  dir: OriginDirection;
+  source: 'ego';
+  label: string; // Label for the ego message
+  blockTitle: string; // Title of the block
+  textPlain: string; // Plain text content
+  messageId?: string; // ID of the message (optional)
+}*/
+
+// Union type for ItemDataOrigin
+type ItemDataOrigin = UploadOrigin | GeneratedOrigin;
+
+
+// Item Base type
+
+interface DBlobBase<TType extends DBlobMetaDataType, TMime extends DBlobMimeType, TMeta extends Record<string, any>> {
+  id: string; // Unique identifier
+  type: TType; // Type of item, used for discrimination
+
+  label: string; // Textual representation
+  data: DBlobData<TMime>; // Original data as a BlobData object
+  origin: ItemDataOrigin; // Source of the data (e.g., "upload", "generated")
+
+  createdAt: Date; // Creation date
+  updatedAt: Date; // Last updated date
+
+  metadata: TMeta; // Flexible metadata for specific .type(s)
+  cache: Record<string, DBlobData<DBlobMimeType>>; // Cached conversions as BlobData objects
+}
+
+export function createDBlobBase<TType extends DBlobMetaDataType, TMime extends DBlobMimeType, TMeta extends Record<string, any>>(type: TType, label: string, data: DBlobData<TMime>, origin: ItemDataOrigin, metadata: TMeta): DBlobBase<TType, TMime, TMeta> {
+  return {
+    id: uuidv4(),
+    type,
+    label,
+    data,
+    origin,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+    metadata,
+    cache: {},
+  };
+}
+
+
+// Item Specialization
+
+export enum DBlobMetaDataType {
+  IMAGE = 'image',
+  AUDIO = 'audio',
+  // VIDEO = 'video',
+  // DOCUMENT = 'document',
+  // EGO = 'ego',
+}
+
+interface ImageMetadata {
+  width: number;
+  height: number;
+  averageColor?: string; // Average html color of the image (optional)
+  author?: string; // Author of the image (optional)
+  tags?: string[]; // Tags associated with the image (optional)
+  description?: string; // Description of the image (optional)
+}
+
+interface AudioMetadata {
+  duration: number; // Duration in seconds
+  sampleRate: number; // Sample rate of the audio
+  bitrate?: number; // Bitrate of the audio (optional)
+  channels?: number; // Number of audio channels (optional)
+  // artist?: string; // Artist of the audio (optional)
+  // album?: string; // Album of the audio (optional)
+  // genre?: string; // Genre of the audio (optional)
+}
+
+/*interface VideoMetadata {
+  width: number;
+  height: number;
+  duration: number; // Duration in seconds
+  frameRate?: number; // Frame rate of the video (optional)
+  bitrate?: number; // Bitrate of the video (optional)
+  codec?: string; // Codec used for the video (optional)
+  // director?: string; // Director of the video (optional)
+  // cast?: string[]; // Cast members of the video (optional)
+  // genre?: string; // Genre of the video (optional)
+}
+
+interface DocumentMetadata {
+  pageCount: number; // Number of pages in the document
+  author?: string; // Author of the document (optional)
+  title?: string; // Title of the document (optional)
+  subject?: string; // Subject of the document (optional)
+  keywords?: string[]; // Keywords associated with the document (optional)
+}*/
+
+
+// Item Data
+
+export type DBlobImageItem = DBlobBase<DBlobMetaDataType.IMAGE, DBlobMimeType.IMG_PNG | DBlobMimeType.IMG_JPEG, ImageMetadata>;
+export type DBlobAudioItem = DBlobBase<DBlobMetaDataType.AUDIO, DBlobMimeType.AUDIO_MPEG | DBlobMimeType.AUDIO_WAV, AudioMetadata>;
+// type DBlobVideoItem = DBlobBase<ItemDataType.VIDEO, BlobMimeType.VIDEO_MP4, VideoMetadata>;
+// type DBlobDocumentItem = DBlobBase<ItemDataType.DOCUMENT, BlobMimeType.DOCUMENT_PDF, DocumentMetadata>;
+// type DBlobTextItem = DBlobBase<ItemDataType.TEXT, BlobMimeType.DOCUMENT_PLAIN, {}>;
+
+
+// DB Item Data
+
+export type DBlobItem = DBlobImageItem | DBlobAudioItem; // | DBlobVideoItem | DBlobDocumentItem | DBlobTextItem | DBlobEgoItem;
+
+export function createDBlobImageItem(label: string, data: DBlobImageItem['data'], origin: ItemDataOrigin, metadata: ImageMetadata): DBlobImageItem {
+  return createDBlobBase(DBlobMetaDataType.IMAGE, label, data, origin, metadata);
+}
+
+export type DBlobDBItem = DBlobItem & {
+  uId: '1';
+  wId: '1';
+  cId: 'global';
+}