@squidcloud/google-drive-client 1.0.146-beta

package/dist/common/src/google-drive-types.d.ts

@@ -0,0 +1,137 @@
+import { AiContextMetadata } from '@squidcloud/client';
+export { AiContextMetadata };
+/**
+ * The type of document in personal storage.
+ * @category GoogleDrive
+ */
+export type PsDocumentType = 'file' | 'folder';
+/**
+ * Document data from Google Drive.
+ * @category GoogleDrive
+ */
+export interface PsDocumentData {
+    /** The unique identifier of the document. */
+    id: string;
+    /** The name of the document. */
+    name: string;
+    /** The type of the document (file or folder). */
+    type: PsDocumentType;
+    /** The MIME type of the document. */
+    mimeType: string;
+    /** The last modified date of the document. */
+    modifiedDate: Date;
+}
+/**
+ * Represents a document that has been indexed for AI processing.
+ * @category GoogleDrive
+ */
+export interface PsIndexedDocument {
+    /** The unique identifier of the document. */
+    id: string;
+    /** The name of the document. */
+    name: string;
+    /** The type of the document (file or folder). */
+    type: PsDocumentType;
+    /** Metadata associated with the document. */
+    metadata: AiContextMetadata;
+    /** The ID of the parent folder, if the document was indexed as part of a folder. */
+    folderDocumentId?: string;
+}
+/**
+ * Error information for a document that failed to index.
+ * @category GoogleDrive
+ */
+export interface PsIndexDocumentError {
+    /** The unique identifier of the document. */
+    documentId: string;
+    /** The name of the document. */
+    name: string;
+    /** The error message describing why indexing failed. */
+    errorMessage: string;
+}
+/**
+ * Error information for a document that failed to unindex.
+ * @category GoogleDrive
+ */
+export interface PsUnindexDocumentError {
+    /** The unique identifier of the document. */
+    documentId: string;
+    /** The name of the document. */
+    name: string;
+    /** The error message describing why unindexing failed. */
+    errorMessage: string;
+}
+/**
+ * Request to index a document or folder for AI processing.
+ * @category GoogleDrive
+ */
+export interface PsIndexDocumentOrFolderRequest {
+    /** The ID of the integration in the Squid console. */
+    integrationId: string;
+    /** User-specific identifier to retrieve the correct OAuth tokens. */
+    identifier: string;
+    /** The ID of the document or folder to index. */
+    documentOrFolderId: string;
+    /** Optional metadata to associate with the indexed document(s). */
+    metadata?: AiContextMetadata;
+}
+/**
+ * Response from indexing a document or folder.
+ * @category GoogleDrive
+ */
+export interface PsIndexDocumentOrFolderResponse {
+    /** Array of errors for documents that failed to index. Empty if all succeeded. */
+    errors: Array<PsIndexDocumentError>;
+}
+/**
+ * Request to list indexed documents.
+ * @category GoogleDrive
+ */
+export interface PsListIndexedDocumentsRequest {
+    /** The ID of the integration in the Squid console. */
+    integrationId: string;
+    /** User-specific identifier to retrieve the correct OAuth tokens. */
+    identifier: string;
+    /** Optional filter for document type (file or folder). */
+    type?: PsDocumentType;
+}
+/**
+ * Response containing list of indexed documents.
+ * @category GoogleDrive
+ */
+export interface PsListIndexedDocumentsResponse {
+    /** Array of indexed documents. */
+    documents: Array<PsIndexedDocument>;
+}
+/**
+ * Request to unindex a document or folder.
+ * @category GoogleDrive
+ */
+export interface PsUnindexDocumentOrFolderRequest {
+    /** The ID of the integration in the Squid console. */
+    integrationId: string;
+    /** User-specific identifier to retrieve the correct OAuth tokens. */
+    identifier: string;
+    /** The ID of the document or folder to unindex. */
+    documentOrFolderId: string;
+}
+/**
+ * Response from unindexing a document or folder.
+ * @category GoogleDrive
+ */
+export interface PsUnindexDocumentOrFolderResponse {
+    /** Array of errors for documents that failed to unindex. Empty if all succeeded. */
+    errors: Array<PsUnindexDocumentError>;
+}
+/**
+ * Request to extract data from a document.
+ * @category GoogleDrive
+ */
+export interface PsExtractDataFromDocumentRequest {
+    /** The ID of the integration in the Squid console. */
+    integrationId: string;
+    /** User-specific identifier to retrieve the correct OAuth tokens. */
+    identifier: string;
+    /** The ID of the document to extract data from. */
+    documentId: string;
+}

package/dist/googledrive-client/src/google-drive-client.d.ts

@@ -0,0 +1,60 @@
+import { ExtractDataFromDocumentResponse, GetAccessTokenResponse, Squid } from '@squidcloud/client';
+import { AiContextMetadata, PsExtractDataFromDocumentRequest, PsIndexDocumentError, PsIndexDocumentOrFolderRequest, PsIndexDocumentOrFolderResponse, PsIndexedDocument, PsListIndexedDocumentsRequest, PsListIndexedDocumentsResponse, PsUnindexDocumentError, PsUnindexDocumentOrFolderRequest, PsUnindexDocumentOrFolderResponse } from '../../common/src/google-drive-types';
+/**
+ * OAuth2 scopes required for Google Drive integration.
+ * Use these scopes when requesting the OAuth2 auth code from Google.
+ */
+export declare const GOOGLE_DRIVE_SCOPES: readonly ["openid", "email", "https://www.googleapis.com/auth/drive.readonly", "https://www.googleapis.com/auth/drive.metadata.readonly"];
+export { AiContextMetadata, PsExtractDataFromDocumentRequest, PsIndexDocumentError, PsIndexDocumentOrFolderRequest, PsIndexDocumentOrFolderResponse, PsIndexedDocument, PsListIndexedDocumentsRequest, PsListIndexedDocumentsResponse, PsUnindexDocumentError, PsUnindexDocumentOrFolderRequest, PsUnindexDocumentOrFolderResponse, };
+/**
+ * Client for Google Drive personal storage integration.
+ * Provides convenient methods to interact with Google Drive via Squid's personal storage APIs.
+ */
+export declare class GoogleDriveClient {
+    private readonly squid;
+    private readonly integrationId;
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Save an OAuth authorization code after the user completes the OAuth flow.
+     *
+     * @param authCode - The authorization code from Google
+     * @param identifier - User-specific identifier
+     * @returns Access token and expiration time
+     */
+    saveAuthCode(authCode: string, identifier: string): Promise<GetAccessTokenResponse>;
+    /**
+     * List all indexed documents for an identifier.
+     *
+     * @param identifier - User-specific identifier
+     * @param type - Optional filter by type ('file' or 'folder')
+     * @returns Array of indexed documents
+     */
+    listIndexedDocuments(identifier: string, type?: 'file' | 'folder'): Promise<Array<PsIndexedDocument>>;
+    /**
+     * Index a document or folder for AI context.
+     * If it is a folder, all files within it are indexed recursively.
+     *
+     * @param documentOrFolderId - Google Drive document or folder ID
+     * @param identifier - User-specific identifier
+     * @param metadata - Optional metadata to attach
+     * @returns Array of errors for documents that failed to index. Empty if all succeeded.
+     */
+    indexDocumentOrFolder(documentOrFolderId: string, identifier: string, metadata?: AiContextMetadata): Promise<Array<PsIndexDocumentError>>;
+    /**
+     * Remove a document or folder from the index (and AI context).
+     * If a folder is provided, all files within it will be unindexed.
+     *
+     * @param documentOrFolderId - Google Drive document or folder ID
+     * @param identifier - User-specific identifier
+     * @returns Array of errors for documents that failed to unindex. Empty if all succeeded.
+     */
+    unindexDocumentOrFolder(documentOrFolderId: string, identifier: string): Promise<Array<PsUnindexDocumentError>>;
+    /**
+     * Extract data from a document (download file content).
+     *
+     * @param documentId - Google Drive document ID
+     * @param identifier - User-specific identifier
+     * @returns Extracted document data with pages
+     */
+    extractDataFromDocument(documentId: string, identifier: string): Promise<ExtractDataFromDocumentResponse>;
+}

package/dist/googledrive-client/src/index.d.ts

@@ -0,0 +1 @@
+export * from './google-drive-client';

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,i)=>{for(var o in i)e.o(i,o)&&!e.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:i[o]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{GOOGLE_DRIVE_SCOPES:()=>i,GoogleDriveClient:()=>o});const i=["openid","email","https://www.googleapis.com/auth/drive.readonly","https://www.googleapis.com/auth/drive.metadata.readonly"];class o{constructor(e,t){this.squid=e,this.integrationId=t}async saveAuthCode(e,t){return await this.squid.externalAuth(this.integrationId).saveAuthCode(e,t)}async listIndexedDocuments(e,t){const i={integrationId:this.integrationId,identifier:e,type:t};return(await this.squid.executeFunction("getGoogleDriveIndexedDocuments",i)).documents}async indexDocumentOrFolder(e,t,i){const o={integrationId:this.integrationId,identifier:t,documentOrFolderId:e,metadata:i};return(await this.squid.executeFunction("indexGoogleDriveDocumentOrFolder",o)).errors}async unindexDocumentOrFolder(e,t){const i={integrationId:this.integrationId,identifier:t,documentOrFolderId:e};return(await this.squid.executeFunction("unindexGoogleDriveDocumentOrFolder",i)).errors}async extractDataFromDocument(e,t){const i={integrationId:this.integrationId,identifier:t,documentId:e};return await this.squid.executeFunction("extractGoogleDriveDocument",i)}}var n=exports;for(var r in t)n[r]=t[r];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@squidcloud/google-drive-client",
+  "version": "1.0.146-beta",
+  "description": "Squid Google Drive Client",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prebuild": "del-cli dist",
+    "build": "webpack --mode=production",
+    "lint": "eslint",
+    "publish:public": "npm run build && npm publish --access public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "lodash": "^4.17.21",
+    "@squidcloud/client": "^1.0.146-beta"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}