@secure-exec/google-drive 0.0.0-nathan-docs-sdk-expansion.c9c2e4e

package/README.md

@@ -0,0 +1,41 @@
+> **Preview** This package is in preview and may have breaking changes.
+
+# @secure-exec/google-drive
+
+Declarative Google Drive native mount helper for secure-exec VMs. This package keeps
+the public helper surface on the TypeScript side while routing first-party
+Google Drive-backed filesystems through the native `google_drive` sidecar
+plugin.
+
+## Usage
+
+```ts
+import { createGoogleDriveBackend } from "@secure-exec/google-drive";
+
+export const googleDriveMount = {
+  path: "/data",
+  plugin: createGoogleDriveBackend({
+    credentials: {
+      clientEmail: "...",
+      privateKey: "...",
+    },
+    folderId: "your-google-drive-folder-id",
+  }),
+};
+```
+
+## Configuration
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `credentials` | `{ clientEmail: string; privateKey: string }` | Yes | Google service account credentials |
+| `folderId` | `string` | Yes | Google Drive folder ID where blocks are stored |
+| `keyPrefix` | `string` | No | Optional prefix for the persisted manifest and block file names |
+| `chunkSize` | `number` | No | Optional persisted block chunk size used by the native plugin |
+| `inlineThreshold` | `number` | No | Optional maximum inline file size stored in the manifest before chunking |
+
+## Rate Limits
+
+Google Drive API has a rate limit of approximately 10 queries/sec/user. Heavy
+I/O workloads may experience throttling. Consider larger `chunkSize` values for
+write-heavy workloads so the native plugin emits fewer Drive API calls.

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import type { MountConfigJsonObject, NativeMountPluginDescriptor } from "@secure-exec/core/descriptors";
+export type GoogleDriveCredentials = MountConfigJsonObject & {
+    clientEmail: string;
+    privateKey: string;
+};
+export interface GoogleDriveFsOptions {
+    credentials: GoogleDriveCredentials;
+    folderId: string;
+    keyPrefix?: string;
+    chunkSize?: number;
+    inlineThreshold?: number;
+}
+export type GoogleDriveMountPluginConfig = MountConfigJsonObject & {
+    credentials: GoogleDriveCredentials;
+    folderId: string;
+    keyPrefix?: string;
+    chunkSize?: number;
+    inlineThreshold?: number;
+};
+/**
+ * Create a declarative Google Drive native mount descriptor.
+ *
+ * This keeps the package on the public mount-helper surface while routing
+ * first-party Google Drive-backed filesystems through the native
+ * `google_drive` plugin instead of a TypeScript runtime package.
+ */
+export declare function createGoogleDriveBackend(options: GoogleDriveFsOptions): NativeMountPluginDescriptor<GoogleDriveMountPluginConfig>;

package/dist/index.js

@@ -0,0 +1,21 @@
+/**
+ * Create a declarative Google Drive native mount descriptor.
+ *
+ * This keeps the package on the public mount-helper surface while routing
+ * first-party Google Drive-backed filesystems through the native
+ * `google_drive` plugin instead of a TypeScript runtime package.
+ */
+export function createGoogleDriveBackend(options) {
+    return {
+        id: "google_drive",
+        config: {
+            credentials: options.credentials,
+            folderId: options.folderId,
+            ...(options.keyPrefix ? { keyPrefix: options.keyPrefix } : {}),
+            ...(options.chunkSize != null ? { chunkSize: options.chunkSize } : {}),
+            ...(options.inlineThreshold != null
+                ? { inlineThreshold: options.inlineThreshold }
+                : {}),
+        },
+    };
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@secure-exec/google-drive",
+	"version": "0.0.0-nathan-docs-sdk-expansion.c9c2e4e",
+	"type": "module",
+	"license": "Apache-2.0",
+	"beta": true,
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"check-types": "tsc --noEmit",
+		"build": "tsc",
+		"test": "vitest run"
+	},
+	"dependencies": {
+		"@secure-exec/core": "0.0.0-nathan-docs-sdk-expansion.c9c2e4e"
+	},
+	"devDependencies": {
+		"@types/node": "^22.10.2",
+		"typescript": "^5.7.2",
+		"vitest": "^2.1.8"
+	}
+}