@objectstack/spec 0.6.1 → 0.7.2

package/dist/integration/connector/file-storage.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-storage.zod.d.ts","sourceRoot":"","sources":["../../../src/integration/connector/file-storage.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;;;;GAMG;AAEH;;GAEG;AACH,eAAO,MAAM,yBAAyB,8HAYG,CAAC;AAE1C,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,uBAAuB,uGAMF,CAAC;AAEnC,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;EAenC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;EAQtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;EAMrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;EAYjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAS9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6ErC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAM9E;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgF9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2CrC,CAAC"}

package/dist/integration/connector/file-storage.zod.js

@@ -0,0 +1,346 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.azureBlobConnectorExample = exports.googleDriveConnectorExample = exports.s3ConnectorExample = exports.FileStorageConnectorSchema = exports.StorageBucketSchema = exports.FileFilterConfigSchema = exports.FileVersioningConfigSchema = exports.MultipartUploadConfigSchema = exports.FileMetadataConfigSchema = exports.FileAccessPatternSchema = exports.FileStorageProviderSchema = void 0;
+const zod_1 = require("zod");
+const connector_zod_1 = require("../connector.zod");
+/**
+ * File Storage Connector Protocol Template
+ *
+ * Specialized connector for file storage systems (S3, Azure Blob, Google Cloud Storage, etc.)
+ * Extends the base connector with file-specific features like multipart uploads,
+ * versioning, and metadata extraction.
+ */
+/**
+ * File Storage Provider Types
+ */
+exports.FileStorageProviderSchema = zod_1.z.enum([
+    's3', // Amazon S3
+    'azure_blob', // Azure Blob Storage
+    'gcs', // Google Cloud Storage
+    'dropbox', // Dropbox
+    'box', // Box
+    'onedrive', // Microsoft OneDrive
+    'google_drive', // Google Drive
+    'sharepoint', // SharePoint
+    'ftp', // FTP/SFTP
+    'local', // Local file system
+    'custom', // Custom file storage
+]).describe('File storage provider type');
+/**
+ * File Access Pattern
+ */
+exports.FileAccessPatternSchema = zod_1.z.enum([
+    'public_read', // Public read access
+    'private', // Private access
+    'authenticated_read', // Requires authentication
+    'bucket_owner_read', // Bucket owner has read access
+    'bucket_owner_full', // Bucket owner has full control
+]).describe('File access pattern');
+/**
+ * File Metadata Configuration
+ */
+exports.FileMetadataConfigSchema = zod_1.z.object({
+    extractMetadata: zod_1.z.boolean().default(true).describe('Extract file metadata'),
+    metadataFields: zod_1.z.array(zod_1.z.enum([
+        'content_type',
+        'file_size',
+        'last_modified',
+        'etag',
+        'checksum',
+        'creator',
+        'created_at',
+        'custom',
+    ])).optional().describe('Metadata fields to extract'),
+    customMetadata: zod_1.z.record(zod_1.z.string()).optional().describe('Custom metadata key-value pairs'),
+});
+/**
+ * Multipart Upload Configuration
+ */
+exports.MultipartUploadConfigSchema = zod_1.z.object({
+    enabled: zod_1.z.boolean().default(true).describe('Enable multipart uploads'),
+    partSize: zod_1.z.number().min(5 * 1024 * 1024).default(5 * 1024 * 1024).describe('Part size in bytes (min 5MB)'),
+    maxConcurrentParts: zod_1.z.number().min(1).max(10).default(5).describe('Maximum concurrent part uploads'),
+    threshold: zod_1.z.number().min(5 * 1024 * 1024).default(100 * 1024 * 1024).describe('File size threshold for multipart upload in bytes'),
+});
+/**
+ * File Versioning Configuration
+ */
+exports.FileVersioningConfigSchema = zod_1.z.object({
+    enabled: zod_1.z.boolean().default(false).describe('Enable file versioning'),
+    maxVersions: zod_1.z.number().min(1).max(100).optional().describe('Maximum versions to retain'),
+    retentionDays: zod_1.z.number().min(1).optional().describe('Version retention period in days'),
+});
+/**
+ * File Filter Configuration
+ */
+exports.FileFilterConfigSchema = zod_1.z.object({
+    includePatterns: zod_1.z.array(zod_1.z.string()).optional().describe('File patterns to include (glob)'),
+    excludePatterns: zod_1.z.array(zod_1.z.string()).optional().describe('File patterns to exclude (glob)'),
+    minFileSize: zod_1.z.number().min(0).optional().describe('Minimum file size in bytes'),
+    maxFileSize: zod_1.z.number().min(1).optional().describe('Maximum file size in bytes'),
+    allowedExtensions: zod_1.z.array(zod_1.z.string()).optional().describe('Allowed file extensions'),
+    blockedExtensions: zod_1.z.array(zod_1.z.string()).optional().describe('Blocked file extensions'),
+});
+/**
+ * File Storage Bucket/Container Configuration
+ */
+exports.StorageBucketSchema = zod_1.z.object({
+    name: zod_1.z.string().regex(/^[a-z_][a-z0-9_]*$/).describe('Bucket identifier in ObjectStack (snake_case)'),
+    label: zod_1.z.string().describe('Display label'),
+    bucketName: zod_1.z.string().describe('Actual bucket/container name in storage system'),
+    region: zod_1.z.string().optional().describe('Storage region'),
+    enabled: zod_1.z.boolean().default(true).describe('Enable sync for this bucket'),
+    prefix: zod_1.z.string().optional().describe('Prefix/path within bucket'),
+    accessPattern: exports.FileAccessPatternSchema.optional().describe('Access pattern'),
+    fileFilters: exports.FileFilterConfigSchema.optional().describe('File filter configuration'),
+});
+/**
+ * File Storage Connector Configuration Schema
+ */
+exports.FileStorageConnectorSchema = connector_zod_1.ConnectorSchema.extend({
+    type: zod_1.z.literal('file_storage'),
+    /**
+     * File storage provider
+     */
+    provider: exports.FileStorageProviderSchema.describe('File storage provider type'),
+    /**
+     * Storage configuration
+     */
+    storageConfig: zod_1.z.object({
+        endpoint: zod_1.z.string().url().optional().describe('Custom endpoint URL'),
+        region: zod_1.z.string().optional().describe('Default region'),
+        pathStyle: zod_1.z.boolean().optional().default(false).describe('Use path-style URLs (for S3-compatible)'),
+    }).optional().describe('Storage configuration'),
+    /**
+     * Buckets/containers to sync
+     */
+    buckets: zod_1.z.array(exports.StorageBucketSchema).describe('Buckets/containers to sync'),
+    /**
+     * File metadata configuration
+     */
+    metadataConfig: exports.FileMetadataConfigSchema.optional().describe('Metadata extraction configuration'),
+    /**
+     * Multipart upload configuration
+     */
+    multipartConfig: exports.MultipartUploadConfigSchema.optional().describe('Multipart upload configuration'),
+    /**
+     * File versioning configuration
+     */
+    versioningConfig: exports.FileVersioningConfigSchema.optional().describe('File versioning configuration'),
+    /**
+     * Enable server-side encryption
+     */
+    encryption: zod_1.z.object({
+        enabled: zod_1.z.boolean().default(false).describe('Enable server-side encryption'),
+        algorithm: zod_1.z.enum(['AES256', 'aws:kms', 'custom']).optional().describe('Encryption algorithm'),
+        kmsKeyId: zod_1.z.string().optional().describe('KMS key ID (for aws:kms)'),
+    }).optional().describe('Encryption configuration'),
+    /**
+     * Lifecycle policy
+     */
+    lifecyclePolicy: zod_1.z.object({
+        enabled: zod_1.z.boolean().default(false).describe('Enable lifecycle policy'),
+        deleteAfterDays: zod_1.z.number().min(1).optional().describe('Delete files after N days'),
+        archiveAfterDays: zod_1.z.number().min(1).optional().describe('Archive files after N days'),
+    }).optional().describe('Lifecycle policy'),
+    /**
+     * Content processing configuration
+     */
+    contentProcessing: zod_1.z.object({
+        extractText: zod_1.z.boolean().default(false).describe('Extract text from documents'),
+        generateThumbnails: zod_1.z.boolean().default(false).describe('Generate image thumbnails'),
+        thumbnailSizes: zod_1.z.array(zod_1.z.object({
+            width: zod_1.z.number().min(1),
+            height: zod_1.z.number().min(1),
+        })).optional().describe('Thumbnail sizes'),
+        virusScan: zod_1.z.boolean().default(false).describe('Scan for viruses'),
+    }).optional().describe('Content processing configuration'),
+    /**
+     * Download/upload buffer size
+     */
+    bufferSize: zod_1.z.number().min(1024).default(64 * 1024).describe('Buffer size in bytes'),
+    /**
+     * Enable transfer acceleration (for supported providers)
+     */
+    transferAcceleration: zod_1.z.boolean().default(false).describe('Enable transfer acceleration'),
+});
+// ============================================================================
+// Helper Functions & Examples
+// ============================================================================
+/**
+ * Example: Amazon S3 Connector Configuration
+ */
+exports.s3ConnectorExample = {
+    name: 's3_production_assets',
+    label: 'Production S3 Assets',
+    type: 'file_storage',
+    provider: 's3',
+    authentication: {
+        type: 'api_key',
+        apiKey: '${AWS_ACCESS_KEY_ID}:${AWS_SECRET_ACCESS_KEY}',
+        headerName: 'Authorization',
+    },
+    storageConfig: {
+        region: 'us-east-1',
+        pathStyle: false,
+    },
+    buckets: [
+        {
+            name: 'product_images',
+            label: 'Product Images',
+            bucketName: 'my-company-product-images',
+            region: 'us-east-1',
+            enabled: true,
+            prefix: 'products/',
+            accessPattern: 'public_read',
+            fileFilters: {
+                allowedExtensions: ['.jpg', '.jpeg', '.png', '.webp'],
+                maxFileSize: 10 * 1024 * 1024, // 10MB
+            },
+        },
+        {
+            name: 'customer_documents',
+            label: 'Customer Documents',
+            bucketName: 'my-company-customer-docs',
+            region: 'us-east-1',
+            enabled: true,
+            accessPattern: 'private',
+            fileFilters: {
+                allowedExtensions: ['.pdf', '.docx', '.xlsx'],
+                maxFileSize: 50 * 1024 * 1024, // 50MB
+            },
+        },
+    ],
+    metadataConfig: {
+        extractMetadata: true,
+        metadataFields: ['content_type', 'file_size', 'last_modified', 'etag'],
+    },
+    multipartConfig: {
+        enabled: true,
+        partSize: 5 * 1024 * 1024, // 5MB
+        maxConcurrentParts: 5,
+        threshold: 100 * 1024 * 1024, // 100MB
+    },
+    versioningConfig: {
+        enabled: true,
+        maxVersions: 10,
+    },
+    encryption: {
+        enabled: true,
+        algorithm: 'aws:kms',
+        kmsKeyId: '${AWS_KMS_KEY_ID}',
+    },
+    contentProcessing: {
+        extractText: true,
+        generateThumbnails: true,
+        thumbnailSizes: [
+            { width: 150, height: 150 },
+            { width: 300, height: 300 },
+            { width: 600, height: 600 },
+        ],
+        virusScan: true,
+    },
+    syncConfig: {
+        strategy: 'incremental',
+        direction: 'bidirectional',
+        realtimeSync: true,
+        conflictResolution: 'latest_wins',
+        batchSize: 100,
+    },
+    transferAcceleration: true,
+    status: 'active',
+    enabled: true,
+};
+/**
+ * Example: Google Drive Connector Configuration
+ */
+exports.googleDriveConnectorExample = {
+    name: 'google_drive_team',
+    label: 'Google Drive Team Folder',
+    type: 'file_storage',
+    provider: 'google_drive',
+    authentication: {
+        type: 'oauth2',
+        clientId: '${GOOGLE_CLIENT_ID}',
+        clientSecret: '${GOOGLE_CLIENT_SECRET}',
+        authorizationUrl: 'https://accounts.google.com/o/oauth2/v2/auth',
+        tokenUrl: 'https://oauth2.googleapis.com/token',
+        grantType: 'authorization_code',
+        scopes: ['https://www.googleapis.com/auth/drive.file'],
+    },
+    buckets: [
+        {
+            name: 'team_drive',
+            label: 'Team Drive',
+            bucketName: 'shared-team-drive',
+            enabled: true,
+            fileFilters: {
+                excludePatterns: ['*.tmp', '~$*'],
+            },
+        },
+    ],
+    metadataConfig: {
+        extractMetadata: true,
+        metadataFields: ['content_type', 'file_size', 'last_modified', 'creator', 'created_at'],
+    },
+    versioningConfig: {
+        enabled: true,
+        maxVersions: 5,
+    },
+    syncConfig: {
+        strategy: 'incremental',
+        direction: 'bidirectional',
+        realtimeSync: true,
+        conflictResolution: 'latest_wins',
+        batchSize: 50,
+    },
+    status: 'active',
+    enabled: true,
+};
+/**
+ * Example: Azure Blob Storage Connector Configuration
+ */
+exports.azureBlobConnectorExample = {
+    name: 'azure_blob_storage',
+    label: 'Azure Blob Storage',
+    type: 'file_storage',
+    provider: 'azure_blob',
+    authentication: {
+        type: 'api_key',
+        apiKey: '${AZURE_STORAGE_ACCOUNT_KEY}',
+        headerName: 'x-ms-blob-type',
+    },
+    storageConfig: {
+        endpoint: 'https://myaccount.blob.core.windows.net',
+    },
+    buckets: [
+        {
+            name: 'archive_container',
+            label: 'Archive Container',
+            bucketName: 'archive',
+            enabled: true,
+            accessPattern: 'private',
+        },
+    ],
+    metadataConfig: {
+        extractMetadata: true,
+        metadataFields: ['content_type', 'file_size', 'last_modified', 'etag'],
+    },
+    encryption: {
+        enabled: true,
+        algorithm: 'AES256',
+    },
+    lifecyclePolicy: {
+        enabled: true,
+        archiveAfterDays: 90,
+        deleteAfterDays: 365,
+    },
+    syncConfig: {
+        strategy: 'incremental',
+        direction: 'import',
+        schedule: '0 1 * * *', // Daily at 1 AM
+        batchSize: 200,
+    },
+    status: 'active',
+    enabled: true,
+};