{"_id":"@akadenia/azure","_rev":"4-69af561519c3cdc3b61dcb3b6b6b9486","name":"@akadenia/azure","dist-tags":{"latest":"1.3.0"},"versions":{"1.2.0":{"name":"@akadenia/azure","version":"1.2.0","keywords":["Azure","BlobStorage","akadenia"],"author":{"name":"Akadenia"},"license":"MIT","_id":"@akadenia/azure@1.2.0","maintainers":[{"name":"guy-shahine","email":"guy@akadenia.com"}],"homepage":"https://github.com/akadenia/AkadeniaPackage#readme","bugs":{"url":"https://github.com/akadenia/AkadeniaPackage/issues"},"dist":{"shasum":"fd20f65dee8eee4523fd83635f94fceca76f2fe6","tarball":"https://registry.npmjs.org/@akadenia/azure/-/azure-1.2.0.tgz","fileCount":9,"integrity":"sha512-vT5YiV3Khxvy3bcPXlsQJ9xAj2IkVKbONR/AFY8bcsoCCt6IKx+vzOKW8FvJb0qfYsnm0Prn/wDKZQHK5RvVRg==","signatures":[{"sig":"MEYCIQD7lqIM13bmHI9Sgjb0TDCekaGGd+M7QxofQuxOVjwSpQIhANBIdhuHi+AELHIdufCWGf5tAuye2+IHxVX5iIjnapAf","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":20050},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"9f1d73ca724000aea097f696153149299f362f33","scripts":{"lint":"prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"","test":"jest","build":"rm -rf dist && tsc -p tsconfig.json","format":"prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"","prepare":"npm run build","version":"git add -A src","updateLink":"npm run build && npm rm @akadenia/azure -g && npm link"},"_npmUser":{"name":"guy-shahine","email":"guy@akadenia.com"},"repository":{"url":"git+https://github.com/akadenia/AkadeniaPackage.git","type":"git"},"_npmVersion":"10.2.3","description":"Akadenia package: Azure","directories":{},"_nodeVersion":"18.19.0","dependencies":{"@azure/logger":"^1.0.4","@azure/storage-blob":"^12.17.0","@azure/storage-queue":"^12.16.0"},"publishConfig":{"registry":"https://npm.pkg.github.com"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.1.1","prettier":"^3.1.0","typescript":"^5.2.2","@types/jest":"^29.5.8","@types/node":"^18.18.9","@jest/globals":"^29.7.0"},"_npmOperationalInternal":{"tmp":"tmp/azure_1.2.0_1707768896063_0.8314743253394274","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"1.2.3":{"name":"@akadenia/azure","version":"1.2.3","keywords":["Azure","BlobStorage","QueueStorage","akadenia"],"author":{"name":"Akadenia"},"license":"MIT","_id":"@akadenia/azure@1.2.3","maintainers":[{"name":"guy-shahine","email":"guy@akadenia.com"}],"homepage":"https://github.com/akadenia/AkadeniaAzure#readme","bugs":{"url":"https://github.com/akadenia/AkadeniaAzure/issues"},"dist":{"shasum":"8a417e5a5cec7e2f4cdf80b290823fa253ae5171","tarball":"https://registry.npmjs.org/@akadenia/azure/-/azure-1.2.3.tgz","fileCount":9,"integrity":"sha512-9EZERpWPiG0Ry8RT9zUqyMF4sxte+ISgqfZN+HUrpPbwKjVev1zxQquxEoqE1XK/r4CuBzrCAGPdSOk4Xp5yXA==","signatures":[{"sig":"MEYCIQCZRnhxAS1SE6w51OaEWKM3y4Q5+2/9NHOzeO9HCRR/uAIhAIKl6Q2ykkT4dxlK/Ctiih/yYjid4tlWINwAlii1WAy4","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25450},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"dc3fdc36607742dfb635600af213d7d98fc68b53","scripts":{"lint":"prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"","test":"jest","build":"rm -rf dist && tsc -p tsconfig.json","format":"prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"","prepare":"npm run build","version":"git add -A src","updateLink":"npm run build && npm rm @akadenia/azure -g && npm link","generate:docs":"jsdoc2md dist/*.js"},"_npmUser":{"name":"guy-shahine","email":"guy@akadenia.com"},"repository":{"url":"git+https://github.com/akadenia/AkadeniaAzure.git","type":"git"},"_npmVersion":"10.2.3","description":"Azure storage utility methods","directories":{},"_nodeVersion":"18.19.0","dependencies":{"@azure/logger":"^1.0.4","@azure/storage-blob":"^12.17.0","@azure/storage-queue":"^12.16.0"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","ts-jest":"^29.1.1","prettier":"^3.1.0","typescript":"^5.2.2","@types/node":"^18.18.9","@jest/globals":"^29.7.0","jsdoc-to-markdown":"^8.0.1"},"_npmOperationalInternal":{"tmp":"tmp/azure_1.2.3_1707934062558_0.4245123612487831","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"1.2.4":{"name":"@akadenia/azure","version":"1.2.4","keywords":["Azure","BlobStorage","QueueStorage","akadenia"],"author":{"name":"Akadenia"},"license":"MIT","_id":"@akadenia/azure@1.2.4","maintainers":[{"name":"guy-shahine","email":"guy@akadenia.com"}],"homepage":"https://github.com/akadenia/AkadeniaAzure#readme","bugs":{"url":"https://github.com/akadenia/AkadeniaAzure/issues"},"dist":{"shasum":"f9dee620b89c8bdfdf223d423e71ca7c2b5dd143","tarball":"https://registry.npmjs.org/@akadenia/azure/-/azure-1.2.4.tgz","fileCount":9,"integrity":"sha512-qCNf22pcHnXgK3f9sMiYDkeveFZnEyEdvzO/VTvUDQ0cZRPSuzRB7l7b9m+N6NqHS4owlkCgMvLpAwO4tC40iA==","signatures":[{"sig":"MEUCIQDv0kpc/ZM+pK7+WK9gkFdQBeyQCdoFNm17VZNpEFk/WQIgXPZBHx1EApupSNQjkdyJfiYa9AR3y54uB6/H4UHGKmY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":25682},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"7d9ab34e07b49859f7a42d6c779276b1433637ac","scripts":{"lint":"prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"","test":"jest","build":"rm -rf dist && tsc -p tsconfig.json","format":"prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"","prepare":"npm run build","version":"git add -A src","updateLink":"npm run build && npm rm @akadenia/azure -g && npm link","generate:docs":"jsdoc2md dist/*.js"},"_npmUser":{"name":"guy-shahine","email":"guy@akadenia.com"},"repository":{"url":"git+https://github.com/akadenia/AkadeniaAzure.git","type":"git"},"_npmVersion":"10.8.1","description":"Azure storage utility methods","directories":{},"_nodeVersion":"20.12.1","dependencies":{"@azure/logger":"^1.1.2","@azure/storage-blob":"^12.23.0","@azure/storage-queue":"^12.17.0"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","husky":"^9.0.11","ts-jest":"^29.1.4","prettier":"^3.3.0","typescript":"^5.4.5","@types/node":"^20.14.1","@jest/globals":"^29.7.0","@commitlint/cli":"^18.6.1","semantic-release":"22.0.12","jsdoc-to-markdown":"^8.0.1","@semantic-release/exec":"^6.0.3","@semantic-release/changelog":"^6.0.3","@commitlint/config-conventional":"^18.6.2"},"_npmOperationalInternal":{"tmp":"tmp/azure_1.2.4_1717790683045_0.5203498367757429","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"1.3.0":{"name":"@akadenia/azure","version":"1.3.0","keywords":["Azure","BlobStorage","QueueStorage","akadenia"],"author":{"name":"Akadenia"},"license":"MIT","_id":"@akadenia/azure@1.3.0","maintainers":[{"name":"guy-shahine","email":"guy@akadenia.com"}],"homepage":"https://github.com/akadenia/AkadeniaAzure#readme","bugs":{"url":"https://github.com/akadenia/AkadeniaAzure/issues"},"dist":{"shasum":"1da0892b80e0a749b024586ebab26f704df9db12","tarball":"https://registry.npmjs.org/@akadenia/azure/-/azure-1.3.0.tgz","fileCount":4,"integrity":"sha512-Y7v0HxNZvIPHCgqG3s2YGrkfrE9azsbbv5LcO6Ec3Y7pLg9WFZD27CkHipn+QJ8ulLjzPw0S0iShvsUrB3kvKg==","signatures":[{"sig":"MEUCIB0bo6LEYDjm0mOGq9BVDyVsj1h1A7AS6iijCCCqiP3PAiEAzHHKtlPI83J3u/2DsmAThTj73Z95PFl0fXzIKAOJDis=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9673},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"8a660d9db0ece491f1aa0ccf8ed9e7a1aeded9f5","scripts":{"lint":"prettier --check \"./**/*.{ts,tsx,js,jsx,json,yml}\"","test":"jest","build":"rm -rf dist && tsc -p tsconfig.json","format":"prettier --write \"./**/*.{ts,tsx,js,jsx,json,yml}\"","prepare":"husky","version":"git add -A src","updateLink":"npm run build && npm rm @akadenia/azure -g && npm link","generate:docs":"ts-node generate-docs.ts"},"_npmUser":{"name":"guy-shahine","email":"guy@akadenia.com"},"repository":{"url":"git+https://github.com/akadenia/AkadeniaAzure.git","type":"git"},"_npmVersion":"10.8.2","description":"Azure storage utility methods","directories":{},"_nodeVersion":"20.12.1","dependencies":{"@azure/logger":"^1.1.4","@azure/data-tables":"^13.2.2","@azure/storage-blob":"^12.24.0","@azure/storage-queue":"^12.23.0"},"publishConfig":{"registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.7.0","husky":"^9.1.4","ts-jest":"^29.2.4","ts-node":"^10.9.2","prettier":"^3.3.3","typescript":"^5.5.4","@types/node":"^20.14.15","@jest/globals":"^29.7.0","@commitlint/cli":"^18.6.1","semantic-release":"22.0.12","jsdoc-to-markdown":"^8.0.3","@semantic-release/exec":"^6.0.3","@types/jsdoc-to-markdown":"^7.0.6","@semantic-release/changelog":"^6.0.3","@commitlint/config-conventional":"^18.6.3"},"_npmOperationalInternal":{"tmp":"tmp/azure_1.3.0_1724950308780_0.7745557885494221","host":"s3://npm-registry-packages"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2024-02-12T20:14:55.992Z","modified":"2024-08-29T17:36:01.699Z","1.2.0":"2024-02-12T20:14:56.230Z","1.2.3":"2024-02-14T18:07:42.722Z","1.2.4":"2024-06-07T20:04:43.191Z","1.3.0":"2024-08-29T16:51:48.951Z"},"bugs":{"url":"https://github.com/akadenia/AkadeniaAzure/issues"},"author":{"name":"Akadenia"},"license":"MIT","homepage":"https://github.com/akadenia/AkadeniaAzure#readme","keywords":["Azure","BlobStorage","QueueStorage","akadenia"],"repository":{"url":"git+https://github.com/akadenia/AkadeniaAzure.git","type":"git"},"description":"Azure storage utility methods","maintainers":[{"name":"guy-shahine","email":"guy@akadenia.com"}],"readme":"\n## Installation\n```\nnpm install @akadenia/azure --save\n```\n\n\n\n## BlobStorage\nBlobStorage - A class that contains azure blob storage helpers\n\n**Kind**: global class  \n\n* BlobStorage\n    * .getBlobServiceUrl() ⇒ `BlobServiceClient`\n    * .listBlobs(containerName, blobNamePrefix) ⇒ `Promise<Array<BlobItem>>`\n    * .downloadBlob(containerName, blobName) ⇒ `Promise<Buffer>`\n    * .blobExists(containerName, blobName) ⇒ `Promise<boolean>`\n    * .upload(containerName, blobName, body, contentLength, contentType) ⇒ `Promise<boolean>`\n    * .uploadData(containerName, blobName, data, bufferSize) ⇒ `Promise<boolean>`\n    * .uploadStream(containerName, blobName, stream, bufferSize) ⇒ `Promise<boolean>`\n    * .generateSASUrl(containerName, blobName, sasOptions) ⇒ `string`\n\n\n\n### getBlobServiceUrl()\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `BlobServiceClient` - - A BlobServiceClient object  \n\n\n### listBlobs(containerName, blobNamePrefix)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<Array<BlobItem>>` - - An array of BlobItem objects  \n**Params**\n\n- containerName `string` - The name of the container to check\n- blobNamePrefix `string` - The prefix of the blob name\n\n\n\n### downloadBlob(containerName, blobName)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<Buffer>` - - A Buffer object  \n**Params**\n\n- containerName `string` - The name of the container to download from\n- blobName `string` - The name of the blob to download\n\n\n\n### blobExists(containerName, blobName)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<boolean>` - - A boolean indicating whether or not the blob exists  \n**Params**\n\n- containerName `string` - The name of the container to check\n- blobName `string` - The name of the blob to check\n\n\n\n### upload(containerName, blobName, body, contentLength, contentType)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<boolean>` - - A boolean indicating whether or not the blob was successfully uploaded  \n**Params**\n\n- containerName `string` - The name of the container to upload to\n- blobName `string` - The name of the blob to upload\n- body `HttpRequestBody` - The body of the blob\n- contentLength `string` - The content length\n- contentType `string` - The content type of the blob\n\n\n\n### uploadData(containerName, blobName, data, bufferSize)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<boolean>` - - A boolean indicating whether or not the blob was successfully uploaded  \n**Params**\n\n- containerName `string` - The name of the container to upload to\n- blobName `string` - The name of the blob to upload\n- data - Buffer | Blob | ArrayBuffer | ArrayBufferView\n- bufferSize - Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB\n\n\n\n### uploadStream(containerName, blobName, stream, bufferSize)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `Promise<boolean>` - - A boolean indicating whether or not the blob was successfully uploaded  \n**Params**\n\n- containerName `string` - The name of the container to upload to\n- blobName `string` - The name of the blob to upload\n- stream - Node.js Readable stream\n- bufferSize - Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB\n\n\n\n### generateSASUrl(containerName, blobName, sasOptions)\n**Kind**: instance method of `BlobStorage`  \n**Returns**: `string` - -The URL for the blob.  \n**Params**\n\n- containerName `string` - The name of the blob container.\n- blobName `string` - The name of the blob.\n- sasOptions `SASOptions` - The options used for generating the SAS query.\n\n\n\n## QueueStorage\nQueueStorage - A class that contains azure queue storage helpers\n\n**Kind**: global class  \n\n* QueueStorage\n    * .getQueueClient() ⇒ `QueueClient`\n    * .sendMessage(message) ⇒ `Promise<any>`\n\n\n\n### getQueueClient()\n**Kind**: instance method of `QueueStorage`  \n**Returns**: `QueueClient` - - A QueueClient object  \n\n\n### sendMessage(message)\n**Kind**: instance method of `QueueStorage`  \n**Returns**: `Promise<any>` - - The response from the queue  \n**Params**\n\n- message `string` - The message to send\n\n\n\n## TableStorage\nTableStorage - A class that contains azure table storage helpers\n\n**Kind**: global class  \n\n* TableStorage\n    * .getTableClient() ⇒ `TableClient`\n    * .createTable() ⇒ `Promise<void>` \\| `Promise<boolean>`\n    * .deleteTable() ⇒ `Promise<void>` \\| `Promise<boolean>`\n    * .insert(entity) ⇒ `Promise<boolean>`\n    * .update(entity) ⇒ `Promise<boolean>`\n    * .upsert(entity) ⇒ `Promise<boolean>`\n    * .delete(partitionKey, rowKey) ⇒ `Promise<ITableEntity>`\n    * .get(partitionKey, rowKey) ⇒ `Promise<ITableEntity>`\n\n\n\n### getTableClient()\n**Kind**: instance method of `TableStorage`  \n**Returns**: `TableClient` - - A TableClient object  \n\n\n### createTable()\nCreates a table in the storage account\n\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<void>` - - A promise that resolves when the table is created`Promise<boolean>` - - A promise that resolves to true if the table was created  \n\n\n### deleteTable()\nDeletes a table in the storage account\n\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<void>` - - A promise that resolves when the table is deleted`Promise<boolean>` - - A promise that resolves to true if the table was deleted  \n\n\n### insert(entity)\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<boolean>` - - A promise that resolves to true if the entity was inserted  \n**Params**\n\n- entity `ITableEntity` - The entity to insert\n\n\n\n### update(entity)\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<boolean>` - - A promise that resolves to true if the entity was updated  \n**Params**\n\n- entity `ITableEntity` - The entity to update\n\n\n\n### upsert(entity)\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<boolean>` - - A promise that resolves to true if the entity was upserted  \n**Params**\n\n- entity `ITableEntity` - The entity to upsert\n\n\n\n### delete(partitionKey, rowKey)\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<ITableEntity>` - - The deleted entity  \n**Params**\n\n- partitionKey `string` - The partition key\n- rowKey `string` - The row key\n\n\n\n### get(partitionKey, rowKey)\n**Kind**: instance method of `TableStorage`  \n**Returns**: `Promise<ITableEntity>` - - The retrieved entity  \n**Params**\n\n- partitionKey `string` - The partition key\n- rowKey `string` - The row key\n\n\n## License\n[MIT](https://github.com/akadenia/AkadeniaAzure/blob/main/LICENSE)\n\n","readmeFilename":"README.MD"}