@oino-ts/blob-aws 1.0.5 → 1.0.7

package/dist/cjs/OINOBlobAwsS3.js

@@ -38,6 +38,7 @@ const blob_1 = require("@oino-ts/blob");
  * })
  * ```
  */
+const BLOB_S3_UNSAFE_CHARS_REGEX = /[\x00-\x1f\x7f\\{}[\]^`|<>#%]/g;
 class OINOBlobAwsS3 extends blob_1.OINOBlob {
     _s3Client = null;
     constructor(params) {
@@ -46,6 +47,14 @@ class OINOBlobAwsS3 extends blob_1.OINOBlob {
             throw new Error("OINOBlobAwsS3: missing or invalid credentials (provide region, accessKeyId, secretAccessKey)");
         }
     }
+    /**
+     * Replace characters that are unsafe in S3 object key names
+     * (`\`, control characters, and shell/URL-special characters
+     * `{`, `}`, `[`, `]`, `^`, `` ` ``, `|`, `<`, `>`, `#`, `%`) with `_`.
+     */
+    sanitizeName(name) {
+        return name.replace(BLOB_S3_UNSAFE_CHARS_REGEX, "_");
+    }
     /**
      * Initialise the AWS SDK S3 client from the JSON-encoded `connectionStr`.
      * Does not perform any network call.

package/dist/esm/OINOBlobAwsS3.js

@@ -35,6 +35,7 @@ import { OINOBlob, OINOBlobDataModel } from "@oino-ts/blob";
  * })
  * ```
  */
+const BLOB_S3_UNSAFE_CHARS_REGEX = /[\x00-\x1f\x7f\\{}[\]^`|<>#%]/g;
 export class OINOBlobAwsS3 extends OINOBlob {
     _s3Client = null;
     constructor(params) {
@@ -43,6 +44,14 @@ export class OINOBlobAwsS3 extends OINOBlob {
             throw new Error("OINOBlobAwsS3: missing or invalid credentials (provide region, accessKeyId, secretAccessKey)");
         }
     }
+    /**
+     * Replace characters that are unsafe in S3 object key names
+     * (`\`, control characters, and shell/URL-special characters
+     * `{`, `}`, `[`, `]`, `^`, `` ` ``, `|`, `<`, `>`, `#`, `%`) with `_`.
+     */
+    sanitizeName(name) {
+        return name.replace(BLOB_S3_UNSAFE_CHARS_REGEX, "_");
+    }
     /**
      * Initialise the AWS SDK S3 client from the JSON-encoded `connectionStr`.
      * Does not perform any network call.

package/dist/types/OINOBlobAwsS3.d.ts

@@ -1,37 +1,14 @@
 import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
 import { OINOBlob, OINOBlobParams, type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
-/**
- * AWS S3 (and S3-compatible) implementation of `OINOBlob`.
- *
- * Authenticates using static access key credentials supplied via a JSON-encoded
- * connection string.  Connection parameters map as:
- * - `params.url`           → optional custom endpoint, e.g. `https://s3.eu-west-1.amazonaws.com`
- *                            or a compatible service such as MinIO / Cloudflare R2
- * - `params.container`     → S3 bucket name
- * - `params.connectionStr` → JSON string: `{"region":"…","accessKeyId":"…","secretAccessKey":"…"}`
- *
- * Register and use via the factory:
- * ```ts
- * import { OINOBlobFactory } from "@oino-ts/blob"
- * import { OINOBlobAwsS3 }      from "@oino-ts/blob-aws"
- *
- * OINOBlobFactory.registerBlob("OINOBlobAwsS3", OINOBlobAwsS3)
- *
- * const blob = await OINOBlobFactory.createBlob({
- *     type:          "OINOBlobAwsS3",
- *     url:           "",                             // leave empty for default AWS endpoint
- *     container:     "my-bucket",
- *     connectionStr: JSON.stringify({
- *         region:          "us-east-1",
- *         accessKeyId:     process.env.AWS_ACCESS_KEY_ID,
- *         secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
- *     })
- * })
- * ```
- */
 export declare class OINOBlobAwsS3 extends OINOBlob {
     private _s3Client;
     constructor(params: OINOBlobParams);
+    /**
+     * Replace characters that are unsafe in S3 object key names
+     * (`\`, control characters, and shell/URL-special characters
+     * `{`, `}`, `[`, `]`, `^`, `` ` ``, `|`, `<`, `>`, `#`, `%`) with `_`.
+     */
+    sanitizeName(name: string): string;
     /**
      * Initialise the AWS SDK S3 client from the JSON-encoded `connectionStr`.
      * Does not perform any network call.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/blob-aws",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "OINO TS package for using AWS S3 (or S3-compatible) storage as a REST API.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -22,11 +22,11 @@
   "types": "./dist/types/index.d.ts",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.0.0",
-    "@oino-ts/blob": "1.0.5",
-    "@oino-ts/common": "1.0.5"
+    "@oino-ts/blob": "1.0.7",
+    "@oino-ts/common": "1.0.7"
   },
   "devDependencies": {
-    "@oino-ts/types": "1.0.5",
+    "@oino-ts/types": "1.0.7",
     "@types/bun": "^1.1.14",
     "@types/node": "^22.0.00",
     "typescript": "~5.9.0"

package/src/OINOBlobAwsS3.ts

@@ -45,6 +45,8 @@ import { OINOBlob, OINOBlobParams, OINOBlobDataModel, OINOBlobApi, type OINOBlob
  * })
  * ```
  */
+const BLOB_S3_UNSAFE_CHARS_REGEX = /[\x00-\x1f\x7f\\{}[\]^`|<>#%]/g
+
 export class OINOBlobAwsS3 extends OINOBlob {
     private _s3Client: S3Client | null = null
 
@@ -55,6 +57,15 @@ export class OINOBlobAwsS3 extends OINOBlob {
         }
     }
 
+    /**
+     * Replace characters that are unsafe in S3 object key names
+     * (`\`, control characters, and shell/URL-special characters
+     * `{`, `}`, `[`, `]`, `^`, `` ` ``, `|`, `<`, `>`, `#`, `%`) with `_`.
+     */
+    override sanitizeName(name: string): string {
+        return name.replace(BLOB_S3_UNSAFE_CHARS_REGEX, "_")
+    }
+
     /**
      * Initialise the AWS SDK S3 client from the JSON-encoded `connectionStr`.
      * Does not perform any network call.