@azure/core-paging 1.0.0-preview.1

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    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

package/README.md

@@ -0,0 +1,72 @@
+# Azure Core Paging client library for JS
+
+This library provides core types for paging async iterable iterators.
+
+## Getting started
+
+### Installation
+
+If using this as part of another project in the [azure-sdk-for-js](https://github.com/Azure/azure-sdk-for-js) repo,
+then run `rush install` after cloning the repo.
+
+Otherwise, use npm to install this package in your application as follows
+
+```javascript
+npm install @azure/core-paging
+```
+
+## Key concepts
+
+You can find an explanation of how this repository's code works by going to our [architecture overview](https://github.com/Azure/ms-rest-js/blob/master/docs/architectureOverview.md).
+
+## Examples
+
+Example of building with the types:
+
+```typescript
+  public listSecrets(
+    options?: ListSecretsOptions
+  ): PagedAsyncIterableIterator<SecretAttributes> {
+    const iter = this.listSecretsAll(options);
+    return {
+      async next() {
+        const item = (await iter.next()).value;
+        return item ? { done: false, value: item } : { done: true, value: undefined };
+      },
+      [Symbol.asyncIterator]() { return this; },
+      byPage: (settings: PageSettings = {}) => this.listSecretsPage(settings, options),
+    };
+  }
+```
+
+And using the types:
+
+```
+  for await (let page of client.listSecrets().byPage({ pageSize: 2 })) {
+    for (const secret of page) {
+      console.log("secret: ", secret);
+    }
+  }
+```
+
+## Next steps
+
+Try out this package in your application when dealing with async iterable iterators and provide feedback!
+
+## Troubleshooting
+
+Log an issue at https://github.com/Azure/azure-sdk-for-js/issues
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

package/ThirdPartyNotices.txt

@@ -0,0 +1,35 @@
+Third Party Notices for ms-rest-js
+
+This project incorporates material from the project(s) listed below (collectively, Third Party Code).
+Microsoft, Inc. Microsoft is not the original author of the Third Party Code.
+The original copyright notice and license, under which Microsoft received such Third Party Code,
+are set out below.  This Third Party Code is licensed to you under their original license terms set forth below.
+Microsoft reserves all other rights not expressly granted, whether by implication, estoppel or otherwise.
+
+1. uuid (https://github.com/kelektiv/node-uuid)
+
+%% uuid NOTICES AND INFORMATION BEGIN HERE
+=========================================
+The MIT License (MIT)
+
+Copyright (c) 2010-2016 Robert Kieffer and other contributors
+
+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.
+=========================================
+END OF uuid NOTICES AND INFORMATION

package/dist-esm/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@azure/core-asynciterator-polyfill");

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@azure/core-paging",
+  "author": {
+    "name": "Microsoft Corporation",
+    "email": "azsdkteam@microsoft.com",
+    "url": "https://github.com/Azure/azure-sdk-for-js"
+  },
+  "version": "1.0.0-preview.1",
+  "description": "Core types for paging async iterable iterators",
+  "tags": [
+    "microsoft",
+    "clientruntime"
+  ],
+  "keywords": [
+    "microsoft",
+    "clientruntime"
+  ],
+  "main": "./dist-esm/index.js",
+  "types": "./types/corePaging.d.ts",
+  "files": [
+    "types/*.d.ts",
+    "dist-esm/**/*.js",
+    "LICENSE",
+    "README.md",
+    "ThirdPartyNotices.txt"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/core/core-paging",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Azure/azure-sdk-for-js.git"
+  },
+  "bugs": {
+    "url": "http://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build": "tsc -p .",
+    "build:test": "echo skipped",
+    "check-format": "prettier --list-different --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "echo skipped",
+    "format": "prettier --write --config ../../.prettierrc.json \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint": "eslint -c ../../.eslintrc.json src test --ext .ts -f node_modules/eslint-detailed-reporter/lib/detailed.js -o template-lintReport.html || exit 0",
+    "lint:fix": "eslint \"src/**/*.ts\" \"test/**/*.ts\" -c ../../.eslintrc.json --fix --fix-type [problem,suggestion]",
+    "pack": "npm pack 2>&1",
+    "prebuild": "npm run clean",
+    "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
+    "test": "npm run build:test && npm run unit-test && npm run integration-test",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "echo skipped",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "sideEffects": true,
+  "private": false,
+  "dependencies": {
+    "@azure/core-asynciterator-polyfill": "^1.0.0-preview.1"
+  },
+  "devDependencies": {
+    "@types/node": "^8.0.0",
+    "@typescript-eslint/eslint-plugin": "~1.9.0",
+    "@typescript-eslint/parser": "^1.7.0",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.2.0",
+    "eslint-detailed-reporter": "^0.8.0",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-no-only-tests": "^2.3.0",
+    "eslint-plugin-promise": "^4.1.1",
+    "prettier": "^1.16.4",
+    "typescript": "^3.2.2"
+  }
+}

package/types/corePaging.d.ts

@@ -0,0 +1,36 @@
+import "@azure/core-asynciterator-polyfill";
+/**
+ * @interface
+ * An interface that tracks the settings for paged iteration
+ */
+export interface PageSettings {
+    /**
+     * @member {string} [continuationToken] The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+    /**
+     * @member {number} [pageSize] The size of the page during paged iteration
+     */
+    maxPageSize?: number;
+}
+/**
+* @interface
+* An interface that allows async iterable iteration both to completion and by page.
+*/
+export interface PagedAsyncIterableIterator<T, PageT = never> {
+    /**
+     * @member {Promise} [next] The next method, part of the iteration protocol
+     */
+    next(): Promise<{
+        done: boolean;
+        value: T;
+    }>;
+    /**
+     * @member {Symbol} [asyncIterator] The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<T, PageT>;
+    /**
+     * @member {Function} [byPage] Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: PageSettings) => AsyncIterableIterator<PageT extends never ? T[] : PageT>;
+}