@opengeni/documents 0.2.66 → 0.2.69

package/dist/google-drive.d.ts

@@ -0,0 +1,160 @@
+import type { ScopedKnowledgeScope } from "@opengeni/contracts";
+import type { GoogleDriveSelectedSource, GoogleDriveTargetScope } from "@opengeni/contracts/google-drive";
+export declare const GOOGLE_DRIVE_PROVIDER_KEY: "google-drive";
+export declare const GOOGLE_DRIVE_FOLDER_MIME_TYPE: "application/vnd.google-apps.folder";
+export declare const GOOGLE_DRIVE_SHORTCUT_MIME_TYPE: "application/vnd.google-apps.shortcut";
+export type GoogleDriveKnowledgeSourceIdentity = {
+    providerKey: typeof GOOGLE_DRIVE_PROVIDER_KEY;
+    externalTenantId: string;
+    externalSourceId: string;
+    sourceKind: "google-drive-my-drive" | "google-drive-shared-drive" | "google-drive-folder";
+    sourceUri: string;
+    scope: ScopedKnowledgeScope;
+};
+/**
+ * Normalized item metadata expected from a bounded Drive files.list adapter.
+ * The adapter owns provider JSON validation; this planner owns traversal,
+ * checkpointing, resource limits, stable identity, and transfer classification.
+ */
+export type GoogleDriveInventoryProviderItem = {
+    id: string;
+    name: string;
+    mimeType: string;
+    driveId: string | null;
+    parents: string[];
+    modifiedTime: string | null;
+    createdTime: string | null;
+    version: string | null;
+    md5Checksum: string | null;
+    size: string | null;
+    webViewLink: string | null;
+    trashed: boolean;
+};
+export type GoogleDriveInventoryPage = {
+    items: GoogleDriveInventoryProviderItem[];
+    nextPageToken: string | null;
+    incompleteSearch: boolean;
+};
+export type GoogleDriveInventoryLimits = {
+    /** Hard cumulative provider-item discovery limit for this checkpoint. */
+    maxItems: number;
+    /** Hard cumulative known-byte limit for ordinary file downloads. */
+    maxKnownBytes: number;
+    /** Hard cumulative Drive list request/cost limit for this checkpoint. */
+    maxApiRequests: number;
+    /** Wall-clock budget for one invocation; checkpoint counters remain cumulative. */
+    maxElapsedMs: number;
+    /** Per-file byte ceiling. Unknown/export sizes must be enforced again while streaming. */
+    maxFileBytes: number;
+    /** Cycle/graph explosion guard for traversed folders. */
+    maxFolders: number;
+    /** Requested Drive page size. */
+    pageSize: number;
+};
+export type GoogleDriveTransferSkipReason = "file_too_large" | "folder_limit" | "folder_loop" | "shortcut_unsupported" | "trashed" | "unsupported_file_type" | "unsupported_native_type";
+export type GoogleDriveTransferPlan = {
+    action: "traverse";
+} | {
+    action: "export";
+    contentType: string;
+    filename: string;
+    declaredBytes: null;
+} | {
+    action: "download";
+    contentType: string;
+    filename: string;
+    declaredBytes: string | null;
+} | {
+    action: "skip";
+    reason: GoogleDriveTransferSkipReason;
+};
+export type GoogleDriveInventoryEntry = {
+    externalObjectId: string;
+    externalVersionId: string | null;
+    sourceId: string;
+    parentFolderId: string;
+    driveId: string | null;
+    title: string;
+    mimeType: string;
+    modifiedTime: string | null;
+    createdTime: string | null;
+    sourceUri: string;
+    transfer: GoogleDriveTransferPlan;
+};
+export type GoogleDriveInventoryIssue = {
+    code: "incomplete_search" | "invalid_page" | "provider_error";
+    folderId: string;
+    providerCode: string | null;
+};
+export type GoogleDriveInventoryStopReason = "api_request_limit" | "elapsed_time_limit" | "incomplete_search" | "item_limit" | "known_byte_limit" | "provider_error";
+export type GoogleDriveInventoryTotals = {
+    itemCount: number;
+    folderCount: number;
+    plannedFileCount: number;
+    skippedItemCount: number;
+    exportFileCount: number;
+    downloadFileCount: number;
+    unknownSizeFileCount: number;
+    apiRequestCount: number;
+    knownBytes: string;
+};
+type GoogleDriveInventoryFrame = {
+    folderId: string;
+    driveId: string | null;
+    pageToken: string | null;
+    loaded: boolean;
+    bufferedItems: GoogleDriveInventoryProviderItem[];
+    nextPageToken: string | null;
+};
+export type GoogleDriveInventoryCheckpoint = {
+    version: 2;
+    googlePermissionId: string;
+    externalTenantId: string;
+    sourceId: string;
+    sourceDriveId: string | null;
+    scope: ScopedKnowledgeScope;
+    pendingFolders: GoogleDriveInventoryFrame[];
+    seenFolderIds: string[];
+    totals: GoogleDriveInventoryTotals;
+};
+export type GoogleDriveInventoryResult = {
+    status: "complete" | "paused";
+    stopReason: GoogleDriveInventoryStopReason | null;
+    source: GoogleDriveKnowledgeSourceIdentity;
+    entries: GoogleDriveInventoryEntry[];
+    issues: GoogleDriveInventoryIssue[];
+    totals: GoogleDriveInventoryTotals;
+    run: GoogleDriveInventoryTotals & {
+        elapsedMs: number;
+    };
+    checkpoint: GoogleDriveInventoryCheckpoint | null;
+};
+export type GoogleDriveListChildren = (input: {
+    folderId: string;
+    driveId: string | null;
+    pageToken: string | null;
+    pageSize: number;
+}) => Promise<GoogleDriveInventoryPage>;
+export declare class GoogleDriveInventoryProviderError extends Error {
+    readonly providerCode: string;
+    constructor(providerCode: string);
+}
+export declare function googleDriveKnowledgeScope(targetScope: GoogleDriveTargetScope, workspaceId: string, initiatingSubjectId: string): ScopedKnowledgeScope;
+export declare function googleDriveKnowledgeSourceIdentity(input: {
+    googlePermissionId: string;
+    source: Pick<GoogleDriveSelectedSource, "id" | "driveId" | "targetScope">;
+    workspaceId: string;
+    initiatingSubjectId: string;
+}): GoogleDriveKnowledgeSourceIdentity;
+export declare function planGoogleDriveTransfer(item: GoogleDriveInventoryProviderItem, maxFileBytes: number): GoogleDriveTransferPlan;
+export declare function inventoryGoogleDriveSource(input: {
+    googlePermissionId: string;
+    source: GoogleDriveSelectedSource;
+    workspaceId: string;
+    initiatingSubjectId: string;
+    limits: GoogleDriveInventoryLimits;
+    listChildren: GoogleDriveListChildren;
+    checkpoint?: GoogleDriveInventoryCheckpoint | null;
+    now?: (() => number) | undefined;
+}): Promise<GoogleDriveInventoryResult>;
+export {};