digitaltwin-core 0.14.2 → 1.0.0

package/dist/openapi/types.d.ts

@@ -0,0 +1,182 @@
+/**
+ * @fileoverview OpenAPI 3.0 type definitions for automatic documentation generation
+ *
+ * These types provide a structured way to define OpenAPI specifications
+ * for digital twin components.
+ */
+/**
+ * OpenAPI Info object
+ */
+export interface OpenAPIInfo {
+    title: string;
+    description?: string;
+    version: string;
+}
+/**
+ * OpenAPI Server object
+ */
+export interface OpenAPIServer {
+    url: string;
+    description?: string;
+}
+/**
+ * OpenAPI Tag object
+ */
+export interface OpenAPITag {
+    name: string;
+    description?: string;
+}
+/**
+ * OpenAPI Parameter object
+ */
+export interface OpenAPIParameter {
+    name: string;
+    in: 'path' | 'query' | 'header' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema: OpenAPISchema;
+}
+/**
+ * OpenAPI Schema object (simplified)
+ */
+export interface OpenAPISchema {
+    type?: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
+    format?: string;
+    items?: OpenAPISchema;
+    properties?: Record<string, OpenAPISchema>;
+    required?: string[];
+    $ref?: string;
+    description?: string;
+    nullable?: boolean;
+    enum?: string[];
+    default?: unknown;
+    additionalProperties?: boolean | OpenAPISchema;
+}
+/**
+ * OpenAPI Media Type object
+ */
+export interface OpenAPIMediaType {
+    schema: OpenAPISchema;
+}
+/**
+ * OpenAPI Request Body object
+ */
+export interface OpenAPIRequestBody {
+    description?: string;
+    required?: boolean;
+    content: Record<string, OpenAPIMediaType>;
+}
+/**
+ * OpenAPI Response object
+ */
+export interface OpenAPIResponse {
+    description: string;
+    content?: Record<string, OpenAPIMediaType>;
+    headers?: Record<string, {
+        description?: string;
+        schema: OpenAPISchema;
+    }>;
+}
+/**
+ * OpenAPI Security Requirement object
+ */
+export interface OpenAPISecurityRequirement {
+    [name: string]: string[];
+}
+/**
+ * OpenAPI Operation object
+ */
+export interface OpenAPIOperation {
+    summary?: string;
+    description?: string;
+    operationId?: string;
+    tags?: string[];
+    parameters?: OpenAPIParameter[];
+    requestBody?: OpenAPIRequestBody;
+    responses: Record<string, OpenAPIResponse>;
+    security?: OpenAPISecurityRequirement[];
+    deprecated?: boolean;
+}
+/**
+ * OpenAPI Path Item object
+ */
+export interface OpenAPIPathItem {
+    get?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+}
+/**
+ * OpenAPI Security Scheme object
+ */
+export interface OpenAPISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+}
+/**
+ * OpenAPI Components object
+ */
+export interface OpenAPIComponents {
+    schemas?: Record<string, OpenAPISchema>;
+    securitySchemes?: Record<string, OpenAPISecurityScheme>;
+}
+/**
+ * Complete OpenAPI Document
+ */
+export interface OpenAPIDocument {
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    tags?: OpenAPITag[];
+    paths: Record<string, OpenAPIPathItem>;
+    components?: OpenAPIComponents;
+}
+/**
+ * Specification returned by a component's getOpenAPISpec() method
+ */
+export interface OpenAPIComponentSpec {
+    /** Paths contributed by this component */
+    paths: Record<string, OpenAPIPathItem>;
+    /** Tags used by this component */
+    tags?: OpenAPITag[];
+    /** Schemas contributed by this component */
+    schemas?: Record<string, OpenAPISchema>;
+}
+/**
+ * Options for OpenAPI generation
+ */
+export interface OpenAPIGeneratorOptions {
+    /** API information */
+    info: OpenAPIInfo;
+    /** Server URLs */
+    servers?: OpenAPIServer[];
+    /** Components to document */
+    components: OpenAPIDocumentable[];
+    /** Additional schemas to merge (e.g., from external file) */
+    additionalSchemas?: Record<string, OpenAPISchema>;
+    /** Additional tags to include */
+    additionalTags?: OpenAPITag[];
+    /** Include security scheme for authentication */
+    includeAuth?: boolean;
+}
+/**
+ * Interface for components that can provide OpenAPI documentation
+ */
+export interface OpenAPIDocumentable {
+    /**
+     * Returns the OpenAPI specification for this component's endpoints
+     */
+    getOpenAPISpec(): OpenAPIComponentSpec;
+}
+/**
+ * Type guard to check if an object implements OpenAPIDocumentable
+ */
+export declare function isOpenAPIDocumentable(obj: unknown): obj is OpenAPIDocumentable;
+//# sourceMappingURL=types.d.ts.map

package/dist/openapi/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/openapi/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,EAAE,aAAa,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAC1C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,oBAAoB,CAAC,EAAE,OAAO,GAAG,aAAa,CAAA;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,aAAa,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,CAAC,CAAA;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAC1C,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAA;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAA;IACpD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,WAAW,CAAA;IACjB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,UAAU,CAAC,EAAE,iBAAiB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,kCAAkC;IAClC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,sBAAsB;IACtB,IAAI,EAAE,WAAW,CAAA;IACjB,kBAAkB;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;IACzB,6BAA6B;IAC7B,UAAU,EAAE,mBAAmB,EAAE,CAAA;IACjC,6DAA6D;IAC7D,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACjD,iCAAiC;IACjC,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;IAC7B,iDAAiD;IACjD,WAAW,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,cAAc,IAAI,oBAAoB,CAAA;CACzC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,mBAAmB,CAO9E"}

package/dist/openapi/types.js

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview OpenAPI 3.0 type definitions for automatic documentation generation
+ *
+ * These types provide a structured way to define OpenAPI specifications
+ * for digital twin components.
+ */
+/**
+ * Type guard to check if an object implements OpenAPIDocumentable
+ */
+export function isOpenAPIDocumentable(obj) {
+    return (typeof obj === 'object' &&
+        obj !== null &&
+        'getOpenAPISpec' in obj &&
+        typeof obj.getOpenAPISpec === 'function');
+}
+//# sourceMappingURL=types.js.map

package/dist/openapi/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/openapi/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA2LH;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAY;IAC9C,OAAO,CACH,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,gBAAgB,IAAI,GAAG;QACvB,OAAQ,GAA2B,CAAC,cAAc,KAAK,UAAU,CACpE,CAAA;AACL,CAAC"}

package/dist/storage/adapters/local_storage_service.d.ts

@@ -0,0 +1,57 @@
+import { StorageService } from '../storage_service.js';
+/**
+ * Local filesystem-based implementation of the StorageService.
+ * Saves files in a configured folder using a timestamp as filename.
+ */
+export declare class LocalStorageService extends StorageService {
+    #private;
+    private baseDir;
+    constructor(baseDir?: string);
+    /**
+     * Saves the given buffer to disk under a unique filename.
+     * @param buffer - Content to save
+     * @param collectorName - Name of the collector (used for folder)
+     * @param extension - Optional file extension (e.g. 'json', 'txt')
+     * @returns Relative path to the saved file
+     */
+    save(buffer: Buffer, collectorName: string, extension?: string): Promise<string>;
+    /**
+     * Retrieves a file as buffer using its relative path.
+     * @param relativePath - Filename previously returned by `save`
+     * @returns File content as Buffer
+     * @throws Error if path traversal is detected
+     */
+    retrieve(relativePath: string): Promise<Buffer>;
+    /**
+     * Deletes a stored file.
+     * @param relativePath - Filename previously returned by `save`
+     * @throws Error if path traversal is detected
+     */
+    delete(relativePath: string): Promise<void>;
+    /**
+     * Saves the given buffer to disk at a specific path (preserves filename).
+     * Unlike save(), this method does not auto-generate a timestamp filename.
+     * @param buffer - Content to save
+     * @param relativePath - Full relative path including filename (e.g., 'tilesets/123/tileset.json')
+     * @returns The same relative path that was provided
+     * @throws Error if path traversal is detected
+     */
+    saveWithPath(buffer: Buffer, relativePath: string): Promise<string>;
+    /**
+     * Returns a local file path for the stored file.
+     * Note: For local storage, this returns a relative file path, not an HTTP URL.
+     * In production, use a cloud storage service (OVH, S3) for public URLs.
+     * @param relativePath - The storage path of the file
+     * @returns The file path (relative to baseDir)
+     * @throws Error if path traversal is detected
+     */
+    getPublicUrl(relativePath: string): string;
+    /**
+     * Deletes all files under a given prefix (folder).
+     * @param prefix - The folder/prefix to delete (e.g., 'tilesets/123')
+     * @returns Number of files deleted
+     * @throws Error if path traversal is detected
+     */
+    deleteByPrefix(prefix: string): Promise<number>;
+}
+//# sourceMappingURL=local_storage_service.d.ts.map

package/dist/storage/adapters/local_storage_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local_storage_service.d.ts","sourceRoot":"","sources":["../../../src/storage/adapters/local_storage_service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAItD;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;;IAGvC,OAAO,CAAC,OAAO;gBAAP,OAAO,GAAE,MAAe;IAqB5C;;;;;;OAMG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAetF;;;;;OAKG;IACG,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrD;;;;OAIG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjD;;;;;;;OAOG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUzE;;;;;;;OAOG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAQ1C;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAgCxD"}

package/dist/storage/adapters/local_storage_service.js

@@ -0,0 +1,132 @@
+import { StorageService } from '../storage_service.js';
+import fs from 'fs/promises';
+import path from 'path';
+/**
+ * Local filesystem-based implementation of the StorageService.
+ * Saves files in a configured folder using a timestamp as filename.
+ */
+export class LocalStorageService extends StorageService {
+    #normalizedBase;
+    constructor(baseDir = 'data') {
+        super();
+        this.baseDir = baseDir;
+        this.#normalizedBase = path.resolve(this.baseDir);
+    }
+    /**
+     * Validates that a path does not escape the base directory (path traversal protection).
+     * @param relativePath - The relative path to validate
+     * @returns The resolved absolute path if valid
+     * @throws Error if path traversal is detected
+     */
+    #validatePath(relativePath) {
+        const resolved = path.resolve(this.#normalizedBase, relativePath);
+        if (!resolved.startsWith(this.#normalizedBase + path.sep) && resolved !== this.#normalizedBase) {
+            throw new Error(`Invalid path: path traversal detected for "${relativePath}"`);
+        }
+        return resolved;
+    }
+    /**
+     * Saves the given buffer to disk under a unique filename.
+     * @param buffer - Content to save
+     * @param collectorName - Name of the collector (used for folder)
+     * @param extension - Optional file extension (e.g. 'json', 'txt')
+     * @returns Relative path to the saved file
+     */
+    async save(buffer, collectorName, extension) {
+        const now = new Date();
+        const timestamp = now.toISOString().replace(/[:.]/g, '-');
+        const folder = collectorName || 'default';
+        const filename = extension ? `${timestamp}.${extension}` : timestamp;
+        const dirPath = path.join(this.baseDir, folder);
+        const filePath = path.join(dirPath, filename);
+        await fs.mkdir(dirPath, { recursive: true });
+        await fs.writeFile(filePath, buffer);
+        // return relative path (e.g., 'mycollector/2025-07-07T15-45-22-456Z.json')
+        return path.join(folder, filename);
+    }
+    /**
+     * Retrieves a file as buffer using its relative path.
+     * @param relativePath - Filename previously returned by `save`
+     * @returns File content as Buffer
+     * @throws Error if path traversal is detected
+     */
+    async retrieve(relativePath) {
+        const filePath = this.#validatePath(relativePath);
+        return fs.readFile(filePath);
+    }
+    /**
+     * Deletes a stored file.
+     * @param relativePath - Filename previously returned by `save`
+     * @throws Error if path traversal is detected
+     */
+    async delete(relativePath) {
+        const filePath = this.#validatePath(relativePath);
+        await fs.rm(filePath, { force: true });
+    }
+    /**
+     * Saves the given buffer to disk at a specific path (preserves filename).
+     * Unlike save(), this method does not auto-generate a timestamp filename.
+     * @param buffer - Content to save
+     * @param relativePath - Full relative path including filename (e.g., 'tilesets/123/tileset.json')
+     * @returns The same relative path that was provided
+     * @throws Error if path traversal is detected
+     */
+    async saveWithPath(buffer, relativePath) {
+        const filePath = this.#validatePath(relativePath);
+        const dirPath = path.dirname(filePath);
+        await fs.mkdir(dirPath, { recursive: true });
+        await fs.writeFile(filePath, buffer);
+        return relativePath;
+    }
+    /**
+     * Returns a local file path for the stored file.
+     * Note: For local storage, this returns a relative file path, not an HTTP URL.
+     * In production, use a cloud storage service (OVH, S3) for public URLs.
+     * @param relativePath - The storage path of the file
+     * @returns The file path (relative to baseDir)
+     * @throws Error if path traversal is detected
+     */
+    getPublicUrl(relativePath) {
+        // Validate path to prevent traversal (even though this just returns a string)
+        this.#validatePath(relativePath);
+        // For local storage, return the file path
+        // In a real deployment, you'd need Express static serving or similar
+        return path.join(this.baseDir, relativePath);
+    }
+    /**
+     * Deletes all files under a given prefix (folder).
+     * @param prefix - The folder/prefix to delete (e.g., 'tilesets/123')
+     * @returns Number of files deleted
+     * @throws Error if path traversal is detected
+     */
+    async deleteByPrefix(prefix) {
+        const folderPath = this.#validatePath(prefix);
+        try {
+            // Check if folder exists
+            await fs.access(folderPath);
+            // Count files before deletion
+            const countFiles = async (dir) => {
+                let count = 0;
+                const entries = await fs.readdir(dir, { withFileTypes: true });
+                for (const entry of entries) {
+                    if (entry.isDirectory()) {
+                        count += await countFiles(path.join(dir, entry.name));
+                    }
+                    else {
+                        count++;
+                    }
+                }
+                return count;
+            };
+            const fileCount = await countFiles(folderPath);
+            // Delete folder recursively
+            await fs.rm(folderPath, { recursive: true, force: true });
+            return fileCount;
+        }
+        catch {
+            // Folder doesn't exist
+            return 0;
+        }
+    }
+}
+//# sourceMappingURL=local_storage_service.js.map

package/dist/storage/adapters/local_storage_service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local_storage_service.js","sourceRoot":"","sources":["../../../src/storage/adapters/local_storage_service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,EAAE,MAAM,aAAa,CAAA;AAC5B,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IAC1C,eAAe,CAAQ;IAEhC,YAAoB,UAAkB,MAAM;QACxC,KAAK,EAAE,CAAA;QADS,YAAO,GAAP,OAAO,CAAiB;QAExC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACrD,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,YAAoB;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;QAEjE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,QAAQ,KAAK,IAAI,CAAC,eAAe,EAAE,CAAC;YAC7F,MAAM,IAAI,KAAK,CAAC,8CAA8C,YAAY,GAAG,CAAC,CAAA;QAClF,CAAC;QAED,OAAO,QAAQ,CAAA;IACnB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,aAAqB,EAAE,SAAkB;QAChE,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;QACtB,MAAM,SAAS,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QACzD,MAAM,MAAM,GAAG,aAAa,IAAI,SAAS,CAAA;QACzC,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;QAE7C,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC5C,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAEpC,2EAA2E;QAC3E,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,YAAoB;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;QACjD,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;QACjD,MAAM,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,YAAoB;QACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;QACjD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAEtC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAC5C,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAEpC,OAAO,YAAY,CAAA;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,YAAoB;QAC7B,8EAA8E;QAC9E,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;QAChC,0CAA0C;QAC1C,qEAAqE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;IAChD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,MAAc;QAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;QAE7C,IAAI,CAAC;YACD,yBAAyB;YACzB,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;YAE3B,8BAA8B;YAC9B,MAAM,UAAU,GAAG,KAAK,EAAE,GAAW,EAAmB,EAAE;gBACtD,IAAI,KAAK,GAAG,CAAC,CAAA;gBACb,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;gBAC9D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;oBAC1B,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;wBACtB,KAAK,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;oBACzD,CAAC;yBAAM,CAAC;wBACJ,KAAK,EAAE,CAAA;oBACX,CAAC;gBACL,CAAC;gBACD,OAAO,KAAK,CAAA;YAChB,CAAC,CAAA;YAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAA;YAE9C,4BAA4B;YAC5B,MAAM,EAAE,CAAC,EAAE,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;YAEzD,OAAO,SAAS,CAAA;QACpB,CAAC;QAAC,MAAM,CAAC;YACL,uBAAuB;YACvB,OAAO,CAAC,CAAA;QACZ,CAAC;IACL,CAAC;CACJ"}

package/dist/storage/adapters/ovh_storage_service.d.ts

@@ -0,0 +1,72 @@
+import { StorageService } from '../storage_service.js';
+export interface OvhS3Config {
+    accessKey: string;
+    secretKey: string;
+    endpoint: string;
+    region?: string;
+    bucket: string;
+}
+export declare class OvhS3StorageService extends StorageService {
+    #private;
+    constructor(config: OvhS3Config);
+    /**
+     * Uploads a file to the OVH S3-compatible object storage.
+     * @param buffer - File contents to upload
+     * @param collectorName - Folder/prefix to store under
+     * @param extension - Optional file extension (e.g. 'json')
+     * @returns The relative path (key) of the stored object
+     */
+    save(buffer: Buffer, collectorName: string, extension?: string): Promise<string>;
+    /**
+     * Downloads and returns a stored object as a Buffer.
+     * @param relativePath - The key/path of the object to retrieve
+     * @returns The object contents as a Buffer
+     */
+    retrieve(relativePath: string): Promise<Buffer>;
+    /**
+     * Deletes an object from the storage bucket.
+     * @param relativePath - The key/path of the object to delete
+     */
+    delete(relativePath: string): Promise<void>;
+    /**
+     * Uploads a file to OVH S3 at a specific path (preserves filename).
+     * Unlike save(), this method does not auto-generate a timestamp filename.
+     * Files are uploaded with public-read ACL for direct access (e.g., Cesium tilesets).
+     * @param buffer - File contents to upload
+     * @param relativePath - Full relative path including filename (e.g., 'tilesets/123/tileset.json')
+     * @returns The same relative path that was provided
+     */
+    saveWithPath(buffer: Buffer, relativePath: string): Promise<string>;
+    /**
+     * Deletes multiple objects in batch using S3 DeleteObjects API.
+     * Much faster than individual deletes - can delete up to 1000 objects per request.
+     * @param paths - Array of object keys to delete
+     */
+    deleteBatch(paths: string[]): Promise<void>;
+    /**
+     * Returns the public URL for a stored file.
+     * Constructs the OVH S3 public URL format: https://{bucket}.{endpoint_host}/{key}
+     * @param relativePath - The storage path/key of the file
+     * @returns The public URL to access the file directly
+     */
+    getPublicUrl(relativePath: string): string;
+    /**
+     * Deletes all objects under a given prefix (folder).
+     * Lists objects by prefix and deletes them in batches for performance.
+     * @param prefix - The folder/prefix to delete (e.g., 'tilesets/123')
+     * @returns Number of files deleted
+     */
+    deleteByPrefix(prefix: string): Promise<number>;
+    /**
+     * Configure CORS settings for the bucket.
+     * Required for browser-based access to public files (e.g., Cesium loading tilesets).
+     * Should be called once during application startup.
+     *
+     * @param allowedOrigins - List of allowed origins (default: ['*'])
+     * @param allowedMethods - List of allowed HTTP methods (default: ['GET', 'HEAD'])
+     * @param allowedHeaders - List of allowed headers (default: ['*', 'Authorization'])
+     * @returns true if successful, false otherwise
+     */
+    configureCors(allowedOrigins?: string[], allowedMethods?: string[], allowedHeaders?: string[]): Promise<boolean>;
+}
+//# sourceMappingURL=ovh_storage_service.d.ts.map

package/dist/storage/adapters/ovh_storage_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ovh_storage_service.d.ts","sourceRoot":"","sources":["../../../src/storage/adapters/ovh_storage_service.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAOtD,MAAM,WAAW,WAAW;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,mBAAoB,SAAQ,cAAc;;gBAKvC,MAAM,EAAE,WAAW;IAkB/B;;;;;;OAMG;IACG,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBtF;;;;OAIG;IACG,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBrD;;;OAGG;IACG,MAAM,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD;;;;;;;OAOG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAazE;;;;OAIG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCjD;;;;;OAKG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAO1C;;;;;OAKG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA0CrD;;;;;;;;;OASG;IACG,aAAa,CACf,cAAc,GAAE,MAAM,EAAU,EAChC,cAAc,GAAE,MAAM,EAAoB,EAC1C,cAAc,GAAE,MAAM,EAA2B,GAClD,OAAO,CAAC,OAAO,CAAC;CAyBtB"}