change feed complies

Azure · May 28, 2020 · ab9e37f · ab9e37f
1 parent d0eca1e
commit ab9e37f
Show file tree

Hide file tree

Showing 29 changed files with 1,538 additions and 1 deletion.
diff --git a/rush.json b/rush.json
@@ -457,6 +457,11 @@
       "projectFolder": "sdk/storage/storage-blob",
       "versionPolicyName": "client"
     },
+    {
+      "packageName": "@azure/storage-blob-change-feed",
+      "projectFolder": "sdk/storage/storage-blob-change-feed",
+      "versionPolicyName": "client"
+    },
     {
       "packageName": "@azure/storage-file-share",
       "projectFolder": "sdk/storage/storage-file-share",
@@ -493,4 +498,4 @@
       "versionPolicyName": "utility"
     }
   ]
-}
+}
diff --git a/sdk/storage/storage-blob-change-feed/.vscode/extensions.json b/sdk/storage/storage-blob-change-feed/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}
diff --git a/sdk/storage/storage-blob-change-feed/.vscode/launch.json b/sdk/storage/storage-blob-change-feed/.vscode/launch.json
@@ -0,0 +1,59 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Javascript Samples",
+      "program": "${workspaceFolder}/samples/javascript/basic.js",
+      "preLaunchTask": "npm: build:js-samples"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Typescript Samples",
+      "program": "${workspaceFolder}/samples/typescript/basic.ts",
+      "preLaunchTask": "npm: build:ts-samples",
+      "outFiles": ["${workspaceFolder}/dist-esm/samples/typescript/*.js"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Mocha Test [Without Rollup]",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "args": [
+        "-r",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--colors",
+        "${workspaceFolder}/test/*.spec.ts",
+        "${workspaceFolder}/test/node/*.spec.ts"
+      ],
+      "env": { "TS_NODE_COMPILER_OPTIONS": "{\"module\": \"commonjs\"}" },
+      "envFile": "${workspaceFolder}/../.env",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "protocol": "inspector"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Unit Tests",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "args": [
+        "-u",
+        "tdd",
+        "--timeout",
+        "999999",
+        "--colors",
+        "${workspaceFolder}/dist-test/index.node.js"
+      ],
+      "internalConsoleOptions": "openOnSessionStart",
+      "preLaunchTask": "npm: build:test"
+    }
+  ]
+}
diff --git a/sdk/storage/storage-blob-change-feed/.vscode/settings.json b/sdk/storage/storage-blob-change-feed/.vscode/settings.json
@@ -0,0 +1,27 @@
+{
+    "files.exclude": {
+      "**/.git": true,
+      "**/.svn": true,
+      "**/.DS_Store": true
+    },
+    "[typescript]": {
+      "editor.formatOnSave": true,
+      "editor.tabSize": 2,
+      "editor.detectIndentation": false
+    },
+    "[json]": {
+      "editor.formatOnSave": true,
+      "editor.tabSize": 2,
+      "editor.detectIndentation": false
+    },
+    "[yaml]": {
+      "editor.formatOnSave": true,
+      "editor.tabSize": 2,
+      "editor.detectIndentation": false
+    },
+    "editor.rulers": [
+      100
+    ],
+    "typescript.preferences.quoteStyle": "double",
+    "javascript.preferences.quoteStyle": "double"
+  }
diff --git a/sdk/storage/storage-blob-change-feed/LICENSE b/sdk/storage/storage-blob-change-feed/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Microsoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/sdk/storage/storage-blob-change-feed/api-extractor.json b/sdk/storage/storage-blob-change-feed/api-extractor.json
@@ -0,0 +1,31 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "typings/latest/storage-blob-change-feed/src/index.d.ts",
+  "docModel": {
+    "enabled": false
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "./review"
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "",
+    "publicTrimmedFilePath": "./typings/latest/storage-blob-change-feed.d.ts"
+  },
+  "messages": {
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    },
+    "extractorMessageReporting": {
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+      "ae-unresolved-link": {
+        "logLevel": "none"
+      }
+    }
+  }
+}
diff --git a/sdk/storage/storage-blob-change-feed/package.json b/sdk/storage/storage-blob-change-feed/package.json
@@ -0,0 +1,159 @@
+{
+  "name": "@azure/storage-blob-change-feed",
+  "sdk-type": "client",
+  "version": "12.0.0-preview",
+  "description": "Microsoft Azure Storage SDK for JavaScript - Blob Change Feed",
+  "main": "./dist/index.js",
+  "module": "./dist-esm/storage-blob-change-feed/src/index.js",
+  "browser": {
+    "./dist-esm/storage-blob-change-feed/src/utils/utils.node.js": "./dist-esm/storage-blob-change-feed/src/utils/utils.browser.js",
+    "./dist-esm/storage-blob-change-feed/test/utils/index.js": "./dist-esm/storage-blob-change-feed/test/utils/index.browser.js",
+    "fs": false,
+    "os": false,
+    "process": false
+  },
+  "types": "./typings/latest/storage-blob-change-feed.d.ts",
+  "typesVersions": {
+    "<3.6": {
+      "*": [
+        "./typings/3.1/storage-blob-change-feed.d.ts"
+      ]
+    }
+  },
+  "engine": {
+    "node": ">=8.0.0"
+  },
+  "scripts": {
+    "build:es6": "tsc -p tsconfig.json",
+    "build:nodebrowser": "rollup -c 2>&1",
+    "build:samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1 && npm run build:prep-samples",
+    "build:prep-samples": "node ../../../common/scripts/prep-samples.js && cd samples && tsc",
+    "build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
+    "build:types": "downlevel-dts typings/latest typings/3.1",
+    "build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
+    "check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-esm dist-test typings temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
+    "extract-api": "tsc -p . && api-extractor run --local",
+    "execute:js-samples": "node ../../../common/scripts/run-samples.js samples/javascript/",
+    "execute:ts-samples": "node ../../../common/scripts/run-samples.js samples/typescript/dist/samples/typescript/src/",
+    "execute:samples": "npm run build:samples && npm run execute:js-samples && npm run execute:ts-samples",
+    "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "karma start --single-run",
+    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000  dist-esm/storage-blob-change-feed/test/*.spec.js dist-esm/storage-blob-change-feed/test/node/*.spec.js",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "pack": "npm pack 2>&1",
+    "prebuild": "npm run clean",
+    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
+    "test:node": "npm run clean && npm run build:test && npm run unit-test:node",
+    "test": "npm run clean && npm run build:test && npm run unit-test",
+    "unit-test:browser": "karma start --single-run",
+    "unit-test:node": "mocha --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 120000 dist-test/index.node.js",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "emulator-tests": "cross-env STORAGE_CONNECTION_STRING=UseDevelopmentStorage=true && npm run test:node"
+  },
+  "files": [
+    "BreakingChanges.md",
+    "types/",
+    "dist/",
+    "dist-browser/",
+    "dist-esm/storage-blob-change-feed/src/",
+    "dist-esm/storage-internal-avro/src/",
+    "typings/latest/storage-blob-change-feed.d.ts",
+    "typings/3.1/storage-blob-change-feed.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Azure/azure-sdk-for-js.git"
+  },
+  "keywords": [
+    "Azure",
+    "Storage",
+    "Blob",
+    "ChangeFeed",
+    "Node.js",
+    "TypeScript",
+    "JavaScript",
+    "Browser"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js#readme",
+  "sideEffects": false,
+  "//metadata": {
+    "constantPaths": [
+      {
+        "path": "src/utils/constants.ts",
+        "prefix": "SDK_VERSION"
+      }
+    ]
+  },
+  "dependencies": {
+    "@azure/storage-blob": "^12.1.2",
+    "@azure/abort-controller": "^1.0.0",
+    "@azure/core-http": "^1.1.1",
+    "@azure/core-lro": "^1.0.2",
+    "@azure/core-paging": "^1.1.1",
+    "@azure/core-tracing": "1.0.0-preview.8",
+    "@azure/logger": "^1.0.0",
+    "tslib": "^1.10.0"
+  },
+  "devDependencies": {
+    "@azure/identity": "^1.1.0-preview",
+    "@azure/test-utils-recorder": "^1.0.0",
+    "@microsoft/api-extractor": "7.7.11",
+    "@rollup/plugin-multi-entry": "^3.0.0",
+    "@rollup/plugin-replace": "^2.2.0",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^8.0.0",
+    "@typescript-eslint/eslint-plugin": "^2.0.0",
+    "@typescript-eslint/parser": "^2.0.0",
+    "assert": "^1.4.1",
+    "cross-env": "^6.0.3",
+    "dotenv": "^8.2.0",
+    "downlevel-dts": "~0.4.0",
+    "es6-promise": "^4.2.5",
+    "eslint": "^6.1.0",
+    "eslint-config-prettier": "^6.0.0",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-no-only-tests": "^2.3.0",
+    "eslint-plugin-promise": "^4.1.1",
+    "esm": "^3.2.18",
+    "inherits": "^2.0.3",
+    "karma": "^4.0.1",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-edge-launcher": "^0.4.2",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-ie-launcher": "^1.0.0",
+    "karma-json-preprocessor": "^0.3.3",
+    "karma-json-to-file-reporter": "^1.0.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^1.3.0",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-remap-istanbul": "^0.6.0",
+    "mocha": "^7.1.1",
+    "mocha-junit-reporter": "^1.18.0",
+    "nyc": "^14.0.0",
+    "prettier": "^1.16.4",
+    "puppeteer": "^2.0.0",
+    "rimraf": "^3.0.0",
+    "rollup": "^1.16.3",
+    "@rollup/plugin-commonjs": "11.0.2",
+    "@rollup/plugin-node-resolve": "^7.0.0",
+    "rollup-plugin-shim": "^1.0.0",
+    "rollup-plugin-sourcemaps": "^0.4.2",
+    "rollup-plugin-terser": "^5.1.1",
+    "rollup-plugin-visualizer": "^3.1.1",
+    "source-map-support": "^0.5.9",
+    "ts-node": "^8.3.0",
+    "typescript": "~3.8.3",
+    "util": "^0.12.1"
+  }
+}
diff --git a/sdk/storage/storage-blob-change-feed/review/storage-blob-change-feed.api.md b/sdk/storage/storage-blob-change-feed/review/storage-blob-change-feed.api.md
@@ -0,0 +1,61 @@
+## API Report File for "@azure/storage-blob-change-feed"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { BlobServiceClient } from '@azure/storage-blob';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public (undocumented)
+export class BlobChangeFeedClient {
+    constructor(blobServiceClient: BlobServiceClient);
+    // (undocumented)
+    getChanges(options?: ChangeFeedGetChangesOptions): PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage>;
+    }
+
+// @public (undocumented)
+export interface BlobChangeFeedEvent {
+    // Warning: (ae-forgotten-export) The symbol "BlobChangeFeedEventData" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    data: BlobChangeFeedEventData;
+    // (undocumented)
+    dataVersion?: string;
+    // (undocumented)
+    eventTime: string;
+    // Warning: (ae-forgotten-export) The symbol "BlobChangeFeedEventType" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    eventType: BlobChangeFeedEventType;
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    metadataVersion: string;
+    // (undocumented)
+    subject: string;
+    // (undocumented)
+    topic: string;
+}
+
+// @public (undocumented)
+export class BlobChangeFeedEventPage {
+    constructor();
+    // (undocumented)
+    continuationToken: string;
+    // (undocumented)
+    events: BlobChangeFeedEvent[];
+}
+
+// @public (undocumented)
+export interface ChangeFeedGetChangesOptions {
+    // (undocumented)
+    end?: Date;
+    // (undocumented)
+    start?: Date;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```