@powersync/common 1.53.1 → 1.54.0

package/src/attachments/LocalStorageAdapter.ts

@@ -1,5 +1,11 @@
+/**
+ * @alpha
+ */
 export type AttachmentData = ArrayBuffer | string;
 
+/**
+ * @alpha
+ */
 export enum EncodingType {
   UTF8 = 'utf8',
   Base64 = 'base64'
@@ -15,41 +21,41 @@ export enum EncodingType {
 export interface LocalStorageAdapter {
   /**
    * Saves data to a local file.
-   * @param filePath Path where the file will be stored
-   * @param data Data to store (ArrayBuffer, Blob, or string)
+   * @param filePath - Path where the file will be stored
+   * @param data - Data to store (ArrayBuffer, Blob, or string)
    * @returns Number of bytes written
    */
   saveFile(filePath: string, data: AttachmentData): Promise<number>;
 
   /**
    * Retrieves file data as an ArrayBuffer.
-   * @param filePath Path where the file is stored
+   * @param filePath - Path where the file is stored
    * @returns ArrayBuffer containing the file data
    */
   readFile(filePath: string): Promise<ArrayBuffer>;
 
   /**
    * Deletes the file at the given path.
-   * @param filePath Path where the file is stored
+   * @param filePath - Path where the file is stored
    */
   deleteFile(filePath: string): Promise<void>;
 
   /**
    * Checks if a file exists at the given path.
-   * @param filePath Path where the file is stored
+   * @param filePath - Path where the file is stored
    * @returns True if the file exists, false otherwise
    */
   fileExists(filePath: string): Promise<boolean>;
 
   /**
    * Creates a directory at the specified path.
-   * @param path The full path to the directory
+   * @param path - The full path to the directory
    */
   makeDir(path: string): Promise<void>;
 
   /**
    * Removes a directory at the specified path.
-   * @param path The full path to the directory
+   * @param path - The full path to the directory
    */
   rmDir(path: string): Promise<void>;
 
@@ -65,7 +71,7 @@ export interface LocalStorageAdapter {
 
   /**
    * Returns the file path for the provided filename in the storage directory.
-   * @param filename The filename to get the path for
+   * @param filename - The filename to get the path for
    * @returns The full file path
    */
   getLocalUri(filename: string): string;

package/src/attachments/README.md

@@ -427,10 +427,12 @@ type WatchedAttachmentItem = {
   id: string;
   fileExtension: string;  // e.g., 'jpg', 'pdf'
   metaData?: string;
+  mediaType?: string;     // e.g., 'image/jpeg'
 } | {
   id: string;
   filename: string;       // e.g., 'document.pdf'
   metaData?: string;
+  mediaType?: string;     // e.g., 'application/pdf'
 };
 ```
 

package/src/attachments/RemoteStorageAdapter.ts

@@ -10,21 +10,21 @@ import { AttachmentRecord } from './Schema.js';
 export interface RemoteStorageAdapter {
   /**
    * Uploads a file to remote storage.
-   * @param fileData The binary content of the file to upload
-   * @param attachment The associated attachment metadata
+   * @param fileData - The binary content of the file to upload
+   * @param attachment - The associated attachment metadata
    */
   uploadFile(fileData: ArrayBuffer, attachment: AttachmentRecord): Promise<void>;
 
   /**
    * Downloads a file from remote storage.
-   * @param attachment The attachment describing the file to download
+   * @param attachment - The attachment describing the file to download
    * @returns The binary data of the downloaded file
    */
   downloadFile(attachment: AttachmentRecord): Promise<ArrayBuffer>;
 
   /**
    * Deletes a file from remote storage.
-   * @param attachment The attachment describing the file to delete
+   * @param attachment - The attachment describing the file to delete
    */
   deleteFile(attachment: AttachmentRecord): Promise<void>;
 }

package/src/attachments/Schema.ts

@@ -2,12 +2,17 @@ import { column } from '../db/schema/Column.js';
 import { Table } from '../db/schema/Table.js';
 import { TableV2Options } from '../db/schema/Table.js';
 
+/**
+ * The default name of the local table storing attachment data.
+ *
+ * @alpha
+ */
 export const ATTACHMENT_TABLE = 'attachments';
 
 /**
  * AttachmentRecord represents an attachment in the local database.
  *
- * @experimental
+ * @alpha
  */
 export interface AttachmentRecord {
   id: string;
@@ -27,7 +32,7 @@ export interface AttachmentRecord {
  * @param row - The database row object
  * @returns The corresponding AttachmentRecord
  *
- * @experimental
+ * @alpha
  */
 export function attachmentFromSql(row: any): AttachmentRecord {
   return {
@@ -46,7 +51,7 @@ export function attachmentFromSql(row: any): AttachmentRecord {
 /**
  * AttachmentState represents the current synchronization state of an attachment.
  *
- * @experimental
+ * @alpha
  */
 export enum AttachmentState {
   QUEUED_UPLOAD = 0, // Attachment to be uploaded
@@ -56,12 +61,15 @@ export enum AttachmentState {
   ARCHIVED = 4 // Attachment has been orphaned, i.e. the associated record has been deleted
 }
 
+/**
+ * @alpha
+ */
 export interface AttachmentTableOptions extends Omit<TableV2Options, 'name' | 'columns'> {}
 
 /**
  * AttachmentTable defines the schema for the attachment queue table.
  *
- * @internal
+ * @alpha
  */
 export class AttachmentTable extends Table {
   constructor(options?: AttachmentTableOptions) {

package/src/attachments/WatchedAttachmentItem.ts

@@ -2,7 +2,7 @@
  * WatchedAttachmentItem represents an attachment reference in your application's data model.
  * Use either filename OR fileExtension (not both).
  *
- * @experimental
+ * @alpha
  */
 export type WatchedAttachmentItem =
   | {
@@ -10,10 +10,12 @@ export type WatchedAttachmentItem =
       filename: string;
       fileExtension?: never;
       metaData?: string;
+      mediaType?: string;
     }
   | {
       id: string;
       fileExtension: string;
       filename?: never;
       metaData?: string;
+      mediaType?: string;
     };