@edifice.io/client 2.6.7-develop-pedago.20260930173910 → 2.6.7-develop-integration.20261001195124

package/dist/googledrive/Service.d.ts

@@ -0,0 +1,52 @@
+import { IOdeServices } from '../services/OdeServices';
+import { WorkspaceElement, WorkspaceVisibility } from '../workspace/interface';
+import { GoogleDriveCopyFailure, GoogleDriveDocument } from './interface';
+/**
+ * Raised when the backend failed to copy at least one document into the
+ * workspace. Carries the documents that were copied anyway, so a caller can
+ * still use them instead of discarding the whole selection.
+ */
+export declare class GoogleDriveCopyError extends Error {
+    readonly copied: WorkspaceElement[];
+    readonly failures: GoogleDriveCopyFailure[];
+    constructor(message: string, copied: WorkspaceElement[], failures: GoogleDriveCopyFailure[]);
+}
+export declare class GoogleDriveService {
+    private context;
+    constructor(context: IOdeServices);
+    private get http();
+    /**
+     * List a user's Google Drive documents and folders inside a given folder.
+     *
+     * Google Drive addresses its entries by opaque id, not by path: `parentId` is
+     * the id of the folder to list. The query param is nonetheless named `path`,
+     * as the backend kept the name it uses for Nextcloud.
+     *
+     * @param userId - the id of the user whose files are listed.
+     * @param parentId - id of the folder to list; the Drive root when omitted.
+     */
+    listDocuments(userId: string, parentId?: string): Promise<GoogleDriveDocument[]>;
+    /**
+     * Copy Google Drive documents into the entcore workspace.
+     *
+     * @param userId - the id of the user whose files are copied.
+     * @param ids - Drive ids of the documents to copy.
+     * @param parentId - the workspace folder to copy into; user's root when omitted.
+     * @param params.application - the application the documents are added from.
+     * @param params.visibility - "protected" files the documents under the
+     * documents added from applications, the way an upload does.
+     * @throws GoogleDriveCopyError when the backend reports at least one failure.
+     */
+    copyDocumentToWorkspace(userId: string, ids: string[], parentId?: string, params?: {
+        application?: string;
+        visibility?: WorkspaceVisibility;
+    }): Promise<WorkspaceElement[]>;
+    /**
+     * Build the URL to download/preview a Google Drive document.
+     * There is no dedicated thumbnail endpoint on the backend, so this is also
+     * used as an image preview source for image documents.
+     * @param userId - the id of the user who owns the file.
+     * @param doc - the document to build the URL for.
+     */
+    getFileUrl(userId: string, doc: GoogleDriveDocument): string;
+}

package/dist/googledrive/interface.d.ts

@@ -0,0 +1,41 @@
+/** Mime type identifying a folder in Google Drive. */
+export declare const GOOGLE_DRIVE_FOLDER_MIME_TYPE = "application/vnd.google-apps.folder";
+/** A user's Google Drive document or folder, as consumed by the frontend. */
+export interface GoogleDriveDocument {
+    /** Drive file id. Used as a unique id, and as the parent id when browsing. */
+    id: string;
+    name: string;
+    ownerDisplayName?: string;
+    contentType?: string;
+    size?: number;
+    isFolder: boolean;
+    lastModified?: string;
+    shared?: boolean;
+}
+/** Raw DTO returned by the `/googledrive/files/user/:userId` endpoint. */
+export interface GoogleDriveDocumentResponse {
+    id: string;
+    name: string;
+    mimeType: string;
+    size?: number;
+    modifiedTime?: string;
+    shared?: boolean;
+    ownerDisplayName?: string;
+}
+/**
+ * Per-document outcome returned by the copy-to-workspace endpoint. Unlike the
+ * Nextcloud equivalent, which returns a flat array of workspace documents, each
+ * entry here wraps the created document under `workspace` and carries its own
+ * status, so a copy can partially fail.
+ */
+export interface GoogleDriveCopyResult<TWorkspaceElement> {
+    id: string;
+    status?: 'ok' | 'error';
+    message?: string;
+    workspace?: TWorkspaceElement | null;
+}
+/** A single document the backend failed to copy into the workspace. */
+export interface GoogleDriveCopyFailure {
+    id: string;
+    message?: string;
+}