@aurabase/aurabase-js 0.3.1 → 0.4.0

package/packages/storage/dist/index.d.cts

@@ -1,185 +0,0 @@
-import { AuraResponse, BaseService, AuraClientLike, StorageBucket, UploadResult, ImageTransform, FileEntry, ObjectMeta, AuraError } from '@aurabase/core';
-
-type DownloadFn = () => Promise<Response>;
-/** Download paresseux (Blob par défaut). La requête ne part qu'à l'await ; résultat mémoïsé. */
-declare class BlobDownloadBuilder implements PromiseLike<AuraResponse<Blob>> {
-    private readonly _fn;
-    private _promise;
-    constructor(_fn: DownloadFn);
-    asStream(): StreamDownloadBuilder;
-    private _run;
-    then<TR1 = AuraResponse<Blob>, TR2 = never>(onfulfilled?: ((v: AuraResponse<Blob>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2>;
-}
-/** Variante flux — `res.body` (ReadableStream). */
-declare class StreamDownloadBuilder implements PromiseLike<AuraResponse<ReadableStream<Uint8Array>>> {
-    private readonly _fn;
-    private _promise;
-    constructor(_fn: DownloadFn);
-    private _run;
-    then<TR1 = AuraResponse<ReadableStream<Uint8Array>>, TR2 = never>(onfulfilled?: ((v: AuraResponse<ReadableStream<Uint8Array>>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2>;
-}
-
-declare class StorageService extends BaseService {
-    constructor(client: AuraClientLike);
-    private get prefix();
-    listBuckets(): Promise<AuraResponse<StorageBucket[]>>;
-    getBucket(id: string): Promise<AuraResponse<StorageBucket>>;
-    createBucket(name: string, options?: {
-        public?: boolean;
-        fileSizeLimit?: number;
-        allowedMimeTypes?: string[];
-    }): Promise<AuraResponse<StorageBucket>>;
-    /**
-     * Met à jour un bucket existant (mise à jour PARTIELLE : seuls les champs
-     * fournis sont envoyés). Mapping identique à `createBucket`
-     * (`public`/`file_size_limit`/`allowed_mime_types`).
-     *
-     * Backend route: PATCH /v1/storage/{project_id}/buckets/{id}
-     */
-    updateBucket(id: string, options?: {
-        public?: boolean;
-        fileSizeLimit?: number;
-        allowedMimeTypes?: string[];
-    }): Promise<AuraResponse<StorageBucket>>;
-    deleteBucket(id: string): Promise<AuraResponse<null>>;
-    /**
-     * Upload a file to a bucket.
-     *
-     * Le serveur génère une clé unique `<uuid>.<ext>` (relative au bucket).
-     * Réutilisez directement `data.key` pour download(), remove(), copy(), etc.
-     *
-     * @example
-     * const { data } = await client.storage.upload('avatars', 'photo.png', file)
-     * await client.storage.download('avatars', data!.key)  // fonctionne directement
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}
-     */
-    upload(bucketId: string, path: string, file: Blob | File | ArrayBuffer, options?: {
-        contentType?: string;
-        upsert?: boolean;
-        metadata?: Record<string, string>;
-    }): Promise<AuraResponse<UploadResult>>;
-    /**
-     * Download paresseux d'un fichier. Renvoie un builder (Blob par défaut, `.asStream()` pour
-     * le flux) ; la requête part à l'`await`. Refresh proactif du token avant la requête.
-     * `options?.transform` (image) : appende `renderTransformParams(...)` à l'URL — figée à
-     * l'appel, le builder reste inchangé.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/{*key}
-     */
-    download(bucketId: string, path: string, options?: {
-        transform?: ImageTransform;
-    }): BlobDownloadBuilder;
-    /**
-     * List files in a bucket.
-     *
-     * ⚠️ `offset` n'est PAS supporté par le backend (`ListQuery` ne connaît que
-     * `prefix`+`limit`) : le paramètre est accepté pour compatibilité ascendante
-     * mais IGNORÉ (jamais envoyé au serveur). Pour restreindre les résultats,
-     * utilisez `prefix`. La vraie pagination (continuation token) relève du backend.
-     *
-     * Backend route: GET /v1/storage/{project_id}/{bucket}
-     */
-    list(bucketId: string, options?: {
-        prefix?: string;
-        limit?: number;
-        offset?: number;
-    }): Promise<AuraResponse<FileEntry[]>>;
-    /**
-     * Delete one or more files from a bucket.
-     * Backend route: DELETE /v1/storage/{project_id}/{bucket}/{*key}
-     * Note: for single file deletion, paths[0] is used. Multi-delete is done in sequence.
-     */
-    remove(bucketId: string, paths: string[]): Promise<AuraResponse<null>>;
-    /**
-     * Copy a file within a bucket.
-     *
-     * `fromPath`/`toPath` sont relatifs au bucket (cohérent avec `download`/
-     * `remove`/`upload`) — le SDK les préfixe par `bucketId` pour produire les
-     * clés MinIO complètes attendues par le backend.
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}/copy
-     */
-    copy(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{
-        key: string;
-    }>>;
-    /**
-     * Move/rename a file within a bucket.
-     *
-     * `fromPath`/`toPath` sont relatifs au bucket (cohérent avec `download`/
-     * `remove`/`upload`) — le SDK les préfixe par `bucketId` pour produire les
-     * clés MinIO complètes attendues par le backend.
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}/move
-     */
-    move(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{
-        key: string;
-    }>>;
-    /**
-     * Get file metadata.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/meta/{*key}
-     */
-    getMetadata(bucketId: string, path: string): Promise<AuraResponse<ObjectMeta>>;
-    /**
-     * Generate a signed (temporary) download URL.
-     *
-     * `options?.transform` (image) : dérisqué en réel (stack live) — les params transform
-     * sont HORS HMAC (le backend ne les couvre pas dans la signature), donc on les appende
-     * à l'URL signée APRÈS réception de `{ url, expires_in }`, sans toucher à la requête
-     * `signed-url` elle-même.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/signed-url?key=...&ttl_secs=...
-     */
-    createSignedUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: {
-        transform?: ImageTransform;
-    }): Promise<AuraResponse<{
-        url: string;
-        expires_in: number;
-    }>>;
-    /**
-     * Génère plusieurs URLs signées en une passe (batch).
-     *
-     * Il n'existe pas d'endpoint batch côté backend : l'implémentation fait un
-     * fan-out `Promise.all` sur `createSignedUrl` (même patron que `remove()`),
-     * RÉSILIENT PAR-ITEM — chaque entrée est soit `{ path, url, expires_in }`
-     * (succès), soit `{ path, error }` (échec), sans faire échouer les autres.
-     *
-     * @example
-     * const { data } = await client.storage.createSignedUrls('avatars', ['a.png', 'b.png'])
-     * data?.forEach((r) => 'url' in r ? use(r.url) : console.warn(r.path, r.error))
-     */
-    createSignedUrls(bucketId: string, paths: string[], expiresInSeconds?: number, options?: {
-        transform?: ImageTransform;
-    }): Promise<AuraResponse<Array<{
-        path: string;
-        url: string;
-        expires_in: number;
-    } | {
-        path: string;
-        error: AuraError;
-    }>>>;
-    /**
-     * Generate a signed upload URL (presigned POST/PUT).
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/upload-url?key=...&ttl_secs=...
-     */
-    createSignedUploadUrl(bucketId: string, path: string, expiresInSeconds?: number): Promise<AuraResponse<{
-        url: string;
-        expires_in: number;
-    }>>;
-    /**
-     * Construit une URL vers un fichier d'un bucket.
-     *
-     * ⚠️ Cette URL N'EST PAS accessible sans authentification : le gateway exige
-     * une clé API (`apikey`/`x-api-key`) sur toutes les routes storage, y compris
-     * pour les buckets créés avec `public: true` (ce flag n'est actuellement pas
-     * vérifié côté gateway — une requête non authentifiée renvoie 401). Pour
-     * partager un fichier sans authentification, utilisez `createSignedUrl()`,
-     * qui génère une URL signée HMAC vérifiée côté serveur sans clé API.
-     *
-     * `options?.transform` (image) : appende `renderTransformParams(...)` en query string.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/{*key} (clé API requise)
-     */
-    getPublicUrl(bucketId: string, path: string, options?: {
-        transform?: ImageTransform;
-    }): string;
-}
-
-export { BlobDownloadBuilder, StorageService, StreamDownloadBuilder };

package/packages/storage/dist/index.d.ts

@@ -1,185 +0,0 @@
-import { AuraResponse, BaseService, AuraClientLike, StorageBucket, UploadResult, ImageTransform, FileEntry, ObjectMeta, AuraError } from '@aurabase/core';
-
-type DownloadFn = () => Promise<Response>;
-/** Download paresseux (Blob par défaut). La requête ne part qu'à l'await ; résultat mémoïsé. */
-declare class BlobDownloadBuilder implements PromiseLike<AuraResponse<Blob>> {
-    private readonly _fn;
-    private _promise;
-    constructor(_fn: DownloadFn);
-    asStream(): StreamDownloadBuilder;
-    private _run;
-    then<TR1 = AuraResponse<Blob>, TR2 = never>(onfulfilled?: ((v: AuraResponse<Blob>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2>;
-}
-/** Variante flux — `res.body` (ReadableStream). */
-declare class StreamDownloadBuilder implements PromiseLike<AuraResponse<ReadableStream<Uint8Array>>> {
-    private readonly _fn;
-    private _promise;
-    constructor(_fn: DownloadFn);
-    private _run;
-    then<TR1 = AuraResponse<ReadableStream<Uint8Array>>, TR2 = never>(onfulfilled?: ((v: AuraResponse<ReadableStream<Uint8Array>>) => TR1 | PromiseLike<TR1>) | null, onrejected?: ((e: unknown) => TR2 | PromiseLike<TR2>) | null): Promise<TR1 | TR2>;
-}
-
-declare class StorageService extends BaseService {
-    constructor(client: AuraClientLike);
-    private get prefix();
-    listBuckets(): Promise<AuraResponse<StorageBucket[]>>;
-    getBucket(id: string): Promise<AuraResponse<StorageBucket>>;
-    createBucket(name: string, options?: {
-        public?: boolean;
-        fileSizeLimit?: number;
-        allowedMimeTypes?: string[];
-    }): Promise<AuraResponse<StorageBucket>>;
-    /**
-     * Met à jour un bucket existant (mise à jour PARTIELLE : seuls les champs
-     * fournis sont envoyés). Mapping identique à `createBucket`
-     * (`public`/`file_size_limit`/`allowed_mime_types`).
-     *
-     * Backend route: PATCH /v1/storage/{project_id}/buckets/{id}
-     */
-    updateBucket(id: string, options?: {
-        public?: boolean;
-        fileSizeLimit?: number;
-        allowedMimeTypes?: string[];
-    }): Promise<AuraResponse<StorageBucket>>;
-    deleteBucket(id: string): Promise<AuraResponse<null>>;
-    /**
-     * Upload a file to a bucket.
-     *
-     * Le serveur génère une clé unique `<uuid>.<ext>` (relative au bucket).
-     * Réutilisez directement `data.key` pour download(), remove(), copy(), etc.
-     *
-     * @example
-     * const { data } = await client.storage.upload('avatars', 'photo.png', file)
-     * await client.storage.download('avatars', data!.key)  // fonctionne directement
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}
-     */
-    upload(bucketId: string, path: string, file: Blob | File | ArrayBuffer, options?: {
-        contentType?: string;
-        upsert?: boolean;
-        metadata?: Record<string, string>;
-    }): Promise<AuraResponse<UploadResult>>;
-    /**
-     * Download paresseux d'un fichier. Renvoie un builder (Blob par défaut, `.asStream()` pour
-     * le flux) ; la requête part à l'`await`. Refresh proactif du token avant la requête.
-     * `options?.transform` (image) : appende `renderTransformParams(...)` à l'URL — figée à
-     * l'appel, le builder reste inchangé.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/{*key}
-     */
-    download(bucketId: string, path: string, options?: {
-        transform?: ImageTransform;
-    }): BlobDownloadBuilder;
-    /**
-     * List files in a bucket.
-     *
-     * ⚠️ `offset` n'est PAS supporté par le backend (`ListQuery` ne connaît que
-     * `prefix`+`limit`) : le paramètre est accepté pour compatibilité ascendante
-     * mais IGNORÉ (jamais envoyé au serveur). Pour restreindre les résultats,
-     * utilisez `prefix`. La vraie pagination (continuation token) relève du backend.
-     *
-     * Backend route: GET /v1/storage/{project_id}/{bucket}
-     */
-    list(bucketId: string, options?: {
-        prefix?: string;
-        limit?: number;
-        offset?: number;
-    }): Promise<AuraResponse<FileEntry[]>>;
-    /**
-     * Delete one or more files from a bucket.
-     * Backend route: DELETE /v1/storage/{project_id}/{bucket}/{*key}
-     * Note: for single file deletion, paths[0] is used. Multi-delete is done in sequence.
-     */
-    remove(bucketId: string, paths: string[]): Promise<AuraResponse<null>>;
-    /**
-     * Copy a file within a bucket.
-     *
-     * `fromPath`/`toPath` sont relatifs au bucket (cohérent avec `download`/
-     * `remove`/`upload`) — le SDK les préfixe par `bucketId` pour produire les
-     * clés MinIO complètes attendues par le backend.
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}/copy
-     */
-    copy(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{
-        key: string;
-    }>>;
-    /**
-     * Move/rename a file within a bucket.
-     *
-     * `fromPath`/`toPath` sont relatifs au bucket (cohérent avec `download`/
-     * `remove`/`upload`) — le SDK les préfixe par `bucketId` pour produire les
-     * clés MinIO complètes attendues par le backend.
-     *
-     * Backend route: POST /v1/storage/{project_id}/{bucket}/move
-     */
-    move(bucketId: string, fromPath: string, toPath: string): Promise<AuraResponse<{
-        key: string;
-    }>>;
-    /**
-     * Get file metadata.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/meta/{*key}
-     */
-    getMetadata(bucketId: string, path: string): Promise<AuraResponse<ObjectMeta>>;
-    /**
-     * Generate a signed (temporary) download URL.
-     *
-     * `options?.transform` (image) : dérisqué en réel (stack live) — les params transform
-     * sont HORS HMAC (le backend ne les couvre pas dans la signature), donc on les appende
-     * à l'URL signée APRÈS réception de `{ url, expires_in }`, sans toucher à la requête
-     * `signed-url` elle-même.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/signed-url?key=...&ttl_secs=...
-     */
-    createSignedUrl(bucketId: string, path: string, expiresInSeconds?: number, options?: {
-        transform?: ImageTransform;
-    }): Promise<AuraResponse<{
-        url: string;
-        expires_in: number;
-    }>>;
-    /**
-     * Génère plusieurs URLs signées en une passe (batch).
-     *
-     * Il n'existe pas d'endpoint batch côté backend : l'implémentation fait un
-     * fan-out `Promise.all` sur `createSignedUrl` (même patron que `remove()`),
-     * RÉSILIENT PAR-ITEM — chaque entrée est soit `{ path, url, expires_in }`
-     * (succès), soit `{ path, error }` (échec), sans faire échouer les autres.
-     *
-     * @example
-     * const { data } = await client.storage.createSignedUrls('avatars', ['a.png', 'b.png'])
-     * data?.forEach((r) => 'url' in r ? use(r.url) : console.warn(r.path, r.error))
-     */
-    createSignedUrls(bucketId: string, paths: string[], expiresInSeconds?: number, options?: {
-        transform?: ImageTransform;
-    }): Promise<AuraResponse<Array<{
-        path: string;
-        url: string;
-        expires_in: number;
-    } | {
-        path: string;
-        error: AuraError;
-    }>>>;
-    /**
-     * Generate a signed upload URL (presigned POST/PUT).
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/upload-url?key=...&ttl_secs=...
-     */
-    createSignedUploadUrl(bucketId: string, path: string, expiresInSeconds?: number): Promise<AuraResponse<{
-        url: string;
-        expires_in: number;
-    }>>;
-    /**
-     * Construit une URL vers un fichier d'un bucket.
-     *
-     * ⚠️ Cette URL N'EST PAS accessible sans authentification : le gateway exige
-     * une clé API (`apikey`/`x-api-key`) sur toutes les routes storage, y compris
-     * pour les buckets créés avec `public: true` (ce flag n'est actuellement pas
-     * vérifié côté gateway — une requête non authentifiée renvoie 401). Pour
-     * partager un fichier sans authentification, utilisez `createSignedUrl()`,
-     * qui génère une URL signée HMAC vérifiée côté serveur sans clé API.
-     *
-     * `options?.transform` (image) : appende `renderTransformParams(...)` en query string.
-     * Backend route: GET /v1/storage/{project_id}/{bucket}/{*key} (clé API requise)
-     */
-    getPublicUrl(bucketId: string, path: string, options?: {
-        transform?: ImageTransform;
-    }): string;
-}
-
-export { BlobDownloadBuilder, StorageService, StreamDownloadBuilder };