@oino-ts/blob-azure 1.0.6 → 1.0.8

package/dist/cjs/OINOBlobAzure.js

@@ -38,6 +38,7 @@ const blob_1 = require("@oino-ts/blob");
  * })
  * ```
  */
+const BLOB_AZURE_ILLEGAL_CHARS_REGEX = /[\x00-\x1f\x7f\\]/g;
 class OINOBlobAzure extends blob_1.OINOBlob {
     _containerClient = null;
     constructor(params) {
@@ -46,6 +47,13 @@ class OINOBlobAzure extends blob_1.OINOBlob {
             throw new Error("OINOBlobAzure: missing or invalid credentials (provide either connectionStr or url and clientId)");
         }
     }
+    /**
+     * Replace characters that Azure Blob Storage does not permit in blob names
+     * (`\` and ASCII control characters) with `_`.
+     */
+    sanitizeName(name) {
+        return name.replace(BLOB_AZURE_ILLEGAL_CHARS_REGEX, "_");
+    }
     /**
      * Initialise the Azure SDK client.  Does not perform any network call.
      */

package/dist/esm/OINOBlobAzure.js

@@ -35,6 +35,7 @@ import { OINOBlob, OINOBlobDataModel } from "@oino-ts/blob";
  * })
  * ```
  */
+const BLOB_AZURE_ILLEGAL_CHARS_REGEX = /[\x00-\x1f\x7f\\]/g;
 export class OINOBlobAzure extends OINOBlob {
     _containerClient = null;
     constructor(params) {
@@ -43,6 +44,13 @@ export class OINOBlobAzure extends OINOBlob {
             throw new Error("OINOBlobAzure: missing or invalid credentials (provide either connectionStr or url and clientId)");
         }
     }
+    /**
+     * Replace characters that Azure Blob Storage does not permit in blob names
+     * (`\` and ASCII control characters) with `_`.
+     */
+    sanitizeName(name) {
+        return name.replace(BLOB_AZURE_ILLEGAL_CHARS_REGEX, "_");
+    }
     /**
      * Initialise the Azure SDK client.  Does not perform any network call.
      */

package/dist/types/OINOBlobAzure.d.ts

@@ -1,34 +1,13 @@
 import { OINOApi, OINOResult, OINOQueryFilter } from "@oino-ts/common";
 import { OINOBlob, OINOBlobParams, type OINOBlobEntry, type OINOBlobFetchResult } from "@oino-ts/blob";
-/**
- * Azure Blob Storage implementation of `OINOBlob`.
- *
- * Authenticates using an Azure Storage connection string.  Connection parameters map as:
- * - `params.url`           → blob service endpoint, e.g. `https://<account>.blob.core.windows.net`
- * - `params.container`     → container name
- * - `params.connectionStr` → Azure Storage connection string (e.g. `DefaultEndpointsProtocol=https;AccountName=...`)
- *
- * Register and use via the factory:
- * ```ts
- * import { OINOBlobFactory } from "@oino-ts/blob"
- * import { OINOBlobAzure }   from "@oino-ts/blob-azure"
- *
- * OINOBlobFactory.registerBlob("OINOBlobAzure", OINOBlobAzure)
- *
- * const blob = await OINOBlobFactory.createBlob({
- *     type:          "OINOBlobAzure",
- *     container:     "my-container",
- *     credentials:   either connectionStr or url and clientId
- * })
- * const api = await OINOBlobFactory.createApi(blob, {
- *     apiName:   "files",
- *     tableName: "uploads/"   // blob prefix / folder
- * })
- * ```
- */
 export declare class OINOBlobAzure extends OINOBlob {
     private _containerClient;
     constructor(params: OINOBlobParams);
+    /**
+     * Replace characters that Azure Blob Storage does not permit in blob names
+     * (`\` and ASCII control characters) with `_`.
+     */
+    sanitizeName(name: string): string;
     /**
      * Initialise the Azure SDK client.  Does not perform any network call.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/blob-azure",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "OINO TS package for using Azure Blob Storage as a REST API.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",
@@ -22,11 +22,11 @@
   "dependencies": {
     "@azure/storage-blob": "^12.0.0",
     "@azure/identity": "^3.0.0",
-    "@oino-ts/blob": "1.0.6",
-    "@oino-ts/common": "1.0.6"
+    "@oino-ts/blob": "1.0.8",
+    "@oino-ts/common": "1.0.8"
   },
   "devDependencies": {
-    "@oino-ts/types": "1.0.6",
+    "@oino-ts/types": "1.0.8",
     "@types/bun": "^1.1.14",
     "@types/node": "^22.0.00",
     "typescript": "~5.9.0"