@atlaspack/domain-sharding 2.14.2-unified-f92fba5b6.0 → 2.14.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaspack/domain-sharding
 
+## 2.14.2
+
+### Patch Changes
+
+- [#720](https://github.com/atlassian-labs/atlaspack/pull/720) [`d2fd849`](https://github.com/atlassian-labs/atlaspack/commit/d2fd849770fe6305e9c694bd97b1bd905abd9d94) Thanks [@alshdavid](https://github.com/alshdavid)! - Migrate to TypeScript
+
 ## 2.14.1
 
 ### Patch Changes

package/lib/index.d.ts

@@ -1,16 +1,12 @@
 /**
- * Takes an absolute URL and applies a shard to the top level subdomain.
- * The shard number is based on a hash of the file name, which is
- * the content after the last / in the URL.
- *
- * This function only applies the sharding if the
- * __ATLASPACK_ENABLE_DOMAIN_SHARDS global variable has been set to true
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
+ * Generates a bounded numeric hash in [0, maxShards)
+ */
+declare function getDomainShardIndex(str: string, maxShards: number): number;
+/**
+ * Given a shard number, inserts that shard in the expected pattern within the
+ * domain
  */
-export function shardUrl(url: string, maxShards: number): string;
+declare function applyShardToDomain(domain: string, shard: number): string;
 /**
  * Takes an absolute URL and applies a shard to the top level subdomain.
  * The shard number is based on a hash of the file name, which is
@@ -18,27 +14,16 @@ export function shardUrl(url: string, maxShards: number): string;
  *
  * Unlike `shardUrl`, this function will always apply sharding, without any
  * conditional logic.
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
- */
-export function shardUrlUnchecked(url: string, maxShards: number): string;
-/**
- * Generates a bounded numeric hash in [0, maxShards)
- *
- * @param {string} str
- * @param {number} maxShards
- * @returns {number}
  */
-export function getDomainShardIndex(str: string, maxShards: number): number;
+declare function shardUrlUnchecked(url: string, maxShards: number): string;
 /**
- * Given a shard number, inserts that shard in the expected pattern within the
- * domain
+ * Takes an absolute URL and applies a shard to the top level subdomain.
+ * The shard number is based on a hash of the file name, which is
+ * the content after the last / in the URL.
  *
- * @param {string} domain
- * @param {number} shard
+ * This function only applies the sharding if the
+ * __ATLASPACK_ENABLE_DOMAIN_SHARDS global variable has been set to true
  */
-export function applyShardToDomain(domain: string, shard: number): string;
-declare let globalKeyName: string;
-export { globalKeyName as domainShardingKey };
+declare function shardUrl(url: string, maxShards: number): string;
+export { shardUrl, shardUrlUnchecked, getDomainShardIndex, applyShardToDomain };
+export declare const domainShardingKey = "__ATLASPACK_ENABLE_DOMAIN_SHARDS";

package/lib/index.js

@@ -1,16 +1,21 @@
 "use strict";
 
-let globalKeyName = '__ATLASPACK_ENABLE_DOMAIN_SHARDS';
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.applyShardToDomain = applyShardToDomain;
+exports.domainShardingKey = void 0;
+exports.getDomainShardIndex = getDomainShardIndex;
+exports.shardUrl = shardUrl;
+exports.shardUrlUnchecked = shardUrlUnchecked;
+const globalKeyName = '__ATLASPACK_ENABLE_DOMAIN_SHARDS';
 
 /**
  * Extracts the file name from a static asset path.
  * Will throw if the path doesn't have segments or ends in a trailing slash.
- *
- * @param {string} pathname
- * @returns {string}
  */
 function getFilenameFromUrlPath(pathname) {
-  let lastSlashIdx = pathname.lastIndexOf('/');
+  const lastSlashIdx = pathname.lastIndexOf('/');
   if (lastSlashIdx === -1 || lastSlashIdx === pathname.length - 1) {
     throw new Error(`Expected an absolute URL with a file name, unable to apply sharding.`);
   }
@@ -21,17 +26,13 @@ function getFilenameFromUrlPath(pathname) {
 
 /**
  * Generates a bounded numeric hash in [0, maxShards)
- *
- * @param {string} str
- * @param {number} maxShards
- * @returns {number}
  */
 function getDomainShardIndex(str, maxShards) {
   // As we include the base domain as a shard option then we add 1 to maxShards
   // to account for that.
-  let totalShards = maxShards + 1;
+  const totalShards = maxShards + 1;
   let shard = str.split('').reduce((a, b) => {
-    let n = (a << totalShards) - a + b.charCodeAt(0);
+    const n = (a << totalShards) - a + b.charCodeAt(0);
 
     // The value returned by << is 64 bit, the & operator coerces to 32,
     // prevents overflow as we iterate.
@@ -45,31 +46,28 @@ function getDomainShardIndex(str, maxShards) {
   }
   return shard;
 }
-let trailingShardRegex = /-\d+$/;
+const trailingShardRegex = /-\d+$/;
 
 /**
- * @param {string} subdomain
+ * Removes trailing shard number from subdomain
  */
 function removeTrailingShard(subdomain) {
   if (!trailingShardRegex.test(subdomain)) {
     return subdomain;
   }
-  let shardIdx = subdomain.lastIndexOf('-');
+  const shardIdx = subdomain.lastIndexOf('-');
   return subdomain.slice(0, shardIdx);
 }
 
 /**
  * Given a shard number, inserts that shard in the expected pattern within the
  * domain
- *
- * @param {string} domain
- * @param {number} shard
  */
 function applyShardToDomain(domain, shard) {
-  let i = domain.indexOf('.');
+  const i = domain.indexOf('.');
   // If the shard is 0, then just use the base domain.
   // If the shard is > 0, then remove 1 as the shards domains index from 0
-  let shardSuffix = shard === 0 ? '' : `-${shard - 1}`;
+  const shardSuffix = shard === 0 ? '' : `-${shard - 1}`;
 
   // Domains like localhost have no . separators
   if (i === -1) {
@@ -78,7 +76,7 @@ function applyShardToDomain(domain, shard) {
 
   // If this domain already has a shard number in it, strip it
   // out before adding the new one
-  let firstSubdomain = removeTrailingShard(domain.slice(0, i));
+  const firstSubdomain = removeTrailingShard(domain.slice(0, i));
   return `${firstSubdomain}${shardSuffix}${domain.slice(i)}`;
 }
 
@@ -89,16 +87,11 @@ function applyShardToDomain(domain, shard) {
  *
  * Unlike `shardUrl`, this function will always apply sharding, without any
  * conditional logic.
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
  */
-
 function shardUrlUnchecked(url, maxShards) {
-  let parsedUrl = new URL(url);
-  let fileName = getFilenameFromUrlPath(parsedUrl.pathname);
-  let shardNumber = getDomainShardIndex(fileName, maxShards);
+  const parsedUrl = new URL(url);
+  const fileName = getFilenameFromUrlPath(parsedUrl.pathname);
+  const shardNumber = getDomainShardIndex(fileName, maxShards);
   parsedUrl.hostname = applyShardToDomain(parsedUrl.hostname, shardNumber);
   return parsedUrl.toString();
 }
@@ -110,10 +103,6 @@ function shardUrlUnchecked(url, maxShards) {
  *
  * This function only applies the sharding if the
  * __ATLASPACK_ENABLE_DOMAIN_SHARDS global variable has been set to true
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
  */
 function shardUrl(url, maxShards) {
   // Global variable is set by SSR servers when HTTP1.1 traffic is detected
@@ -122,10 +111,4 @@ function shardUrl(url, maxShards) {
   }
   return shardUrlUnchecked(url, maxShards);
 }
-
-// TODO: convert this file to ESM once HMR issues are resolved
-exports.shardUrl = shardUrl;
-exports.shardUrlUnchecked = shardUrlUnchecked;
-exports.getDomainShardIndex = getDomainShardIndex;
-exports.applyShardToDomain = applyShardToDomain;
-exports.domainShardingKey = globalKeyName;
+const domainShardingKey = exports.domainShardingKey = globalKeyName;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@atlaspack/domain-sharding",
-  "version": "2.14.2-unified-f92fba5b6.0",
+  "version": "2.14.2",
   "license": "(MIT OR Apache-2.0)",
-  "source": "src/index.js",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "./lib/index.js",
+  "source": "./src/index.ts",
+  "types": "./lib/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -13,14 +13,10 @@
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
   "scripts": {
-    "build-ts": "tsc src/index.js --allowJs --declaration --emitDeclarationOnly --outDir lib"
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src"
   },
   "engines": {
     "node": ">= 16.0.0"
   },
-  "devDependencies": {
-    "typescript": "^4.4.3"
-  },
-  "type": "commonjs",
-  "gitHead": "f92fba5b6216e1d94cbd23f3a5d61f7188d49199"
-}
+  "type": "commonjs"
+}

package/src/{index.js → index.ts}

@@ -1,14 +1,11 @@
-let globalKeyName = '__ATLASPACK_ENABLE_DOMAIN_SHARDS';
+const globalKeyName = '__ATLASPACK_ENABLE_DOMAIN_SHARDS';
 
 /**
  * Extracts the file name from a static asset path.
  * Will throw if the path doesn't have segments or ends in a trailing slash.
- *
- * @param {string} pathname
- * @returns {string}
  */
-function getFilenameFromUrlPath(pathname) {
-  let lastSlashIdx = pathname.lastIndexOf('/');
+function getFilenameFromUrlPath(pathname: string): string {
+  const lastSlashIdx = pathname.lastIndexOf('/');
 
   if (lastSlashIdx === -1 || lastSlashIdx === pathname.length - 1) {
     throw new Error(
@@ -22,17 +19,13 @@ function getFilenameFromUrlPath(pathname) {
 
 /**
  * Generates a bounded numeric hash in [0, maxShards)
- *
- * @param {string} str
- * @param {number} maxShards
- * @returns {number}
  */
-function getDomainShardIndex(str, maxShards) {
+function getDomainShardIndex(str: string, maxShards: number): number {
   // As we include the base domain as a shard option then we add 1 to maxShards
   // to account for that.
-  let totalShards = maxShards + 1;
+  const totalShards = maxShards + 1;
   let shard = str.split('').reduce((a, b) => {
-    let n = (a << totalShards) - a + b.charCodeAt(0);
+    const n = (a << totalShards) - a + b.charCodeAt(0);
 
     // The value returned by << is 64 bit, the & operator coerces to 32,
     // prevents overflow as we iterate.
@@ -49,32 +42,29 @@ function getDomainShardIndex(str, maxShards) {
   return shard;
 }
 
-let trailingShardRegex = /-\d+$/;
+const trailingShardRegex = /-\d+$/;
 
 /**
- * @param {string} subdomain
+ * Removes trailing shard number from subdomain
  */
-function removeTrailingShard(subdomain) {
+function removeTrailingShard(subdomain: string): string {
   if (!trailingShardRegex.test(subdomain)) {
     return subdomain;
   }
 
-  let shardIdx = subdomain.lastIndexOf('-');
+  const shardIdx = subdomain.lastIndexOf('-');
   return subdomain.slice(0, shardIdx);
 }
 
 /**
  * Given a shard number, inserts that shard in the expected pattern within the
  * domain
- *
- * @param {string} domain
- * @param {number} shard
  */
-function applyShardToDomain(domain, shard) {
-  let i = domain.indexOf('.');
+function applyShardToDomain(domain: string, shard: number): string {
+  const i = domain.indexOf('.');
   // If the shard is 0, then just use the base domain.
   // If the shard is > 0, then remove 1 as the shards domains index from 0
-  let shardSuffix = shard === 0 ? '' : `-${shard - 1}`;
+  const shardSuffix = shard === 0 ? '' : `-${shard - 1}`;
 
   // Domains like localhost have no . separators
   if (i === -1) {
@@ -83,7 +73,7 @@ function applyShardToDomain(domain, shard) {
 
   // If this domain already has a shard number in it, strip it
   // out before adding the new one
-  let firstSubdomain = removeTrailingShard(domain.slice(0, i));
+  const firstSubdomain = removeTrailingShard(domain.slice(0, i));
 
   return `${firstSubdomain}${shardSuffix}${domain.slice(i)}`;
 }
@@ -95,17 +85,12 @@ function applyShardToDomain(domain, shard) {
  *
  * Unlike `shardUrl`, this function will always apply sharding, without any
  * conditional logic.
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
  */
+function shardUrlUnchecked(url: string, maxShards: number): string {
+  const parsedUrl = new URL(url);
 
-function shardUrlUnchecked(url, maxShards) {
-  let parsedUrl = new URL(url);
-
-  let fileName = getFilenameFromUrlPath(parsedUrl.pathname);
-  let shardNumber = getDomainShardIndex(fileName, maxShards);
+  const fileName = getFilenameFromUrlPath(parsedUrl.pathname);
+  const shardNumber = getDomainShardIndex(fileName, maxShards);
 
   parsedUrl.hostname = applyShardToDomain(parsedUrl.hostname, shardNumber);
 
@@ -119,23 +104,15 @@ function shardUrlUnchecked(url, maxShards) {
  *
  * This function only applies the sharding if the
  * __ATLASPACK_ENABLE_DOMAIN_SHARDS global variable has been set to true
- *
- * @param {string} url
- * @param {number} maxShards
- * @returns {string}
  */
-function shardUrl(url, maxShards) {
+function shardUrl(url: string, maxShards: number): string {
   // Global variable is set by SSR servers when HTTP1.1 traffic is detected
-  if (!globalThis[globalKeyName]) {
+  if (!(globalThis as any)[globalKeyName]) {
     return url;
   }
 
   return shardUrlUnchecked(url, maxShards);
 }
 
-// TODO: convert this file to ESM once HMR issues are resolved
-exports.shardUrl = shardUrl;
-exports.shardUrlUnchecked = shardUrlUnchecked;
-exports.getDomainShardIndex = getDomainShardIndex;
-exports.applyShardToDomain = applyShardToDomain;
-exports.domainShardingKey = globalKeyName;
+export {shardUrl, shardUrlUnchecked, getDomainShardIndex, applyShardToDomain};
+export const domainShardingKey = globalKeyName;

package/test/{index.test.js → index.test.ts}

@@ -1,15 +1,14 @@
-// @flow
 import assert from 'assert';
 import {
   shardUrlUnchecked,
   shardUrl,
   domainShardingKey,
   applyShardToDomain,
-} from '../src/index.js';
+} from '../src/index.ts';
 
 describe('domain sharding helpers', () => {
   beforeEach(() => {
-    // $FlowFixMe
+    // @ts-expect-error - Element implicitly has an 'any' type because expression of type '"__ATLASPACK_ENABLE_DOMAIN_SHARDS"' can't be used to index type 'typeof globalThis'
     delete globalThis[domainShardingKey];
   });
 
@@ -110,6 +109,7 @@ describe('domain sharding helpers', () => {
 
   describe('shardUrl', () => {
     it('should add a shard if the window property is set', () => {
+      // @ts-expect-error - Element implicitly has an 'any' type because expression of type '"__ATLASPACK_ENABLE_DOMAIN_SHARDS"' can't be used to index type 'typeof globalThis'
       globalThis[domainShardingKey] = true;
       const testBundle =
         'https://bundle-shard.assets.example.com/assets/test-bundle.123abc.js';

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": ["src"]
+}

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright (c) 2024 Atlassian US., Inc.
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.