ms_azure_helper 1.0.1

package/index.js

@@ -0,0 +1,153 @@
+const { BlobServiceClient } = require('@azure/storage-blob');
+const { ClientSecretCredential } = require('@azure/identity');
+
+/**
+ * Reads authentication parameters from Switch flow element properties.
+ *
+ * @param {SwitchHelper} sw
+ * @returns {Promise<object>}
+ */
+async function getAuthParams(sw) {
+    const useServicePrincipal = (await sw.getPropertyStringValue('tagUseServicePrincipal', 'No')) === 'Yes';
+    if (useServicePrincipal) {
+        return {
+            method: 'servicePrincipal',
+            accountName: await sw.getPropertyStringValue('tagAccountName'),
+            tenantId: await sw.getPropertyStringValue('tagTenantId'),
+            clientId: await sw.getPropertyStringValue('tagClientId'),
+            clientSecret: await sw.getPropertyStringValue('tagClientSecret'),
+        };
+    }
+    return {
+        method: 'connectionString',
+        connectionString: await sw.getPropertyStringValue('tagAuth'),
+    };
+}
+
+/**
+ * Creates a BlobServiceClient using the provided auth parameters.
+ *
+ * @param {object} authParams - Result of getAuthParams()
+ * @returns {BlobServiceClient}
+ */
+function createBlobServiceClient(authParams) {
+    if (authParams.method === 'servicePrincipal') {
+        const credential = new ClientSecretCredential(
+            authParams.tenantId,
+            authParams.clientId,
+            authParams.clientSecret
+        );
+        return new BlobServiceClient(
+            `https://${authParams.accountName}.blob.core.windows.net`,
+            credential
+        );
+    }
+    return BlobServiceClient.fromConnectionString(authParams.connectionString);
+}
+
+/**
+ * Returns all container names for the authenticated Azure account.
+ *
+ * @param {BlobServiceClient} blobServiceClient
+ * @returns {Promise<string[]>}
+ */
+async function listContainers(blobServiceClient) {
+    const containerNames = [];
+    for await (const container of blobServiceClient.listContainers()) {
+        containerNames.push(container.name);
+    }
+    return containerNames;
+}
+
+/**
+ * Normalizes a blob path prefix: removes leading slash, ensures trailing slash.
+ * Returns an empty string if the input is empty.
+ *
+ * @param {string} rawPath
+ * @returns {string}
+ */
+function normalizeBlobPath(rawPath) {
+    let p = rawPath || '';
+    if (p.startsWith('/')) p = p.substring(1);
+    if (p.length > 0 && !p.endsWith('/')) p += '/';
+    return p;
+}
+
+/**
+ * Extracts the blob name from a full Azure Blob Storage URL.
+ *
+ * The upload script stores URLs like:
+ *   https://account.blob.core.windows.net/containername/folder/file.pdf
+ * This function returns: folder/file.pdf
+ *
+ * @param {string} storedUrl - The full Azure blob URL
+ * @param {string} containerName - The container name to strip from the path
+ * @returns {string}
+ */
+function extractBlobNameFromUrl(storedUrl, containerName) {
+    const { pathname } = new URL(storedUrl);
+    // pathname: /containername/folder/file.pdf
+    const prefix = '/' + containerName + '/';
+    if (pathname.startsWith(prefix)) {
+        return pathname.substring(prefix.length);
+    }
+    // Fallback: strip leading slash and first path segment
+    const parts = pathname.replace(/^\//, '').split('/');
+    parts.shift();
+    return parts.join('/');
+}
+
+/**
+ * Resolves the blob name to operate on from Switch flow element properties.
+ * Reads from job private data (when tagBlobPathSource = 'Yes') or from
+ * the tagBlobPath property directly.
+ *
+ * @param {SwitchHelper} sw
+ * @param {string} containerName
+ * @returns {Promise<string>}
+ */
+async function resolveBlobName(sw, containerName) {
+    const usePrivateData = (await sw.getPropertyStringValue('tagBlobPathSource', 'No')) === 'Yes';
+    if (usePrivateData) {
+        const privateDataField = await sw.getPropertyStringValue('tagPrivateDataName', 'fpAzureUpload');
+        const storedUrl = await sw.getPrivateData(privateDataField);
+        if (!storedUrl) throw new Error(`Private data field "${privateDataField}" is empty — cannot resolve blob path`);
+        return extractBlobNameFromUrl(storedUrl, containerName);
+    }
+    const blobName = await sw.getPropertyStringValue('tagBlobPath');
+    if (!blobName) throw new Error('Blob path is empty — check the "Blob path" property or private data field');
+    return blobName;
+}
+
+/**
+ * Handles the Switch getLibraryForProperty callback.
+ * Supports the tagContainer property by listing available Azure containers.
+ * Import and call this inside each script's getLibraryForProperty entry point.
+ *
+ * @param {SwitchHelper} sw
+ * @param {string} tag
+ * @returns {Promise<string[]>}
+ */
+async function handleLibraryProperty(sw, tag) {
+    switch (tag) {
+        case 'tagContainer': {
+            await sw.logDebug('getLibraryForProperty called for tagContainer, fetching containers from Azure...');
+            const authParams = await getAuthParams(sw);
+            const blobServiceClient = createBlobServiceClient(authParams);
+            return await listContainers(blobServiceClient);
+        }
+        default:
+            await sw.logError('getLibraryForProperty called with an invalid property tag (%1)', [tag]);
+            return [];
+    }
+}
+
+module.exports = {
+    getAuthParams,
+    createBlobServiceClient,
+    listContainers,
+    normalizeBlobPath,
+    extractBlobNameFromUrl,
+    resolveBlobName,
+    handleLibraryProperty,
+};

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "ms_azure_helper",
+  "version": "1.0.1",
+  "description": "Shared Azure Blob Storage utilities for Enfocus Switch scripts",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "upload": "npm version patch && npm publish"
+  },
+  "dependencies": {
+    "@azure/identity": "^4.0.0",
+    "@azure/storage-blob": "^12.27.0",
+    "lodash": "^4.17.21"
+  }
+}