create-monolayer-app 0.2.2 → 0.3.0

package/template/vendor/file-bucket/types.ts

@@ -0,0 +1,153 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+// Modified
+
+/**
+ * Shared types for FileBucket and browser transfers.
+ * This file has zero runtime dependencies — types only.
+ */
+import type { Readable } from "node:stream";
+
+// ── Method options ──────────────────────────────────────────────────────────
+
+export interface UploadProgress {
+  uploadedBytes: number;
+  totalBytes?: number;
+}
+
+export interface UploadOptions {
+  signal?: AbortSignal;
+  /** Successfully transferred bytes; retries are not counted twice. */
+  onProgress?: (progress: UploadProgress) => void;
+}
+
+export type FileUploadBody =
+  | string
+  | Uint8Array
+  | Blob
+  | Readable
+  | ReadableStream<Uint8Array>;
+
+export interface PutOptions extends UploadOptions {
+  /** MIME type of the file (e.g., `image/png`). */
+  contentType?: string;
+  /** Custom metadata key-value pairs. */
+  metadata?: Record<string, string>;
+  /** Cache-Control header value. */
+  cacheControl?: string;
+}
+
+export interface MultipartUploadOptions extends Pick<
+  PutOptions,
+  "contentType" | "metadata" | "cacheControl"
+> {
+  /** Expected size in bytes. The browser verifies it before uploading. */
+  size: number;
+  /** Signed URL lifetime in seconds. Defaults to 3600. */
+  expiresIn?: number;
+}
+
+export interface GetUrlOptions {
+  /** Override the download response disposition, for example "attachment". */
+  contentDisposition?: string;
+  /** URL expiration in seconds. Default: 3600. */
+  expiresIn?: number;
+}
+
+export interface PutUrlOptions extends Pick<
+  PutOptions,
+  "metadata" | "cacheControl"
+> {
+  /** URL expiration in seconds. Default: 3600. */
+  expiresIn?: number;
+  /** Required content type for the upload. */
+  contentType?: string;
+}
+
+export interface ScanOptions {
+  /** Only list files whose keys start with this prefix. */
+  prefix?: string;
+}
+
+// ── Return types ────────────────────────────────────────────────────────────
+
+export interface FileContent {
+  /** The file body as a Buffer. */
+  body: Buffer;
+  /** MIME type of the file. */
+  contentType: string;
+  /** Custom metadata key-value pairs. */
+  metadata: Record<string, string>;
+  /** File size in bytes. */
+  size: number;
+}
+
+export interface FileInfo {
+  /** The object key. */
+  path: string;
+  /** File size in bytes. */
+  size: number;
+  /** Last modification timestamp. */
+  lastModified: Date;
+}
+
+// ── Client handle types ────────────────────────────
+
+/** Client-side download handle. Works server-side and serializes via toJSON() for the wire. */
+export interface FileDownloadClient {
+  /** Download the file as a Blob (server) or via fetch (client). */
+  download: () => Promise<Blob>;
+  /** Get the presigned URL. */
+  getUrl: () => string;
+  /** Transferable serialization — call explicitly when returning route data. */
+  toJSON: () => FileDownloadDescriptor;
+}
+
+/** Client-side upload handle. Works server-side and serializes via toJSON() for the wire. */
+export interface FileUploadClient {
+  /** Upload a file body to the presigned URL. */
+  upload: (
+    body: Blob | File | ArrayBuffer | Uint8Array,
+    options?: UploadOptions
+  ) => Promise<void>;
+  /** Get the presigned URL. */
+  getUrl: () => string;
+  /** Transferable serialization — call explicitly when returning route data. */
+  toJSON: () => FileUploadDescriptor;
+}
+
+// ── Wire descriptor types ───────────────────────────────────────────────────
+
+export interface FileDownloadDescriptor {
+  readonly __blocks: "file-bucket/download";
+  readonly url: string;
+}
+
+export interface FileUploadDescriptor {
+  readonly __blocks: "file-bucket/upload";
+  readonly url: string;
+  readonly contentType?: string;
+  readonly cacheControl?: string;
+}
+
+/** A single-use multipart upload session, transferable to the browser. */
+export interface FileMultipartUploadClient {
+  upload: (
+    body: Blob | File | ArrayBuffer | Uint8Array,
+    options?: UploadOptions
+  ) => Promise<void>;
+  /** Cancel active work and release the upload session. Safe to repeat. */
+  abort: () => Promise<void>;
+  toJSON: () => FileMultipartUploadDescriptor;
+}
+
+export interface FileMultipartUploadDescriptor {
+  readonly __blocks: "file-bucket/multipart-upload";
+  readonly uploadId: string;
+  readonly size: number;
+  readonly partSize: number;
+  readonly expiresAt: number;
+  readonly partUrls: readonly string[];
+  readonly completeUrl: string;
+  readonly abortUrl: string;
+}

package/template/vendor/file-bucket/vite.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from "vite";
+export interface S3EmulatorOptions {
+    /** S3 port. Defaults to 4566; use 0 for an available port. */
+    port?: number;
+}
+/** Start the embedded S3 emulator for Vite development. */
+export declare function s3Emulator(options?: S3EmulatorOptions): Plugin;