@atlaspack/transformer-webextension 2.14.21 → 2.14.22-typescript-17c3d1dec.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

package/lib/WebExtensionTransformer.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from '@atlaspack/plugin';
+declare const _default: Transformer<unknown>;
+export default _default;

package/lib/WebExtensionTransformer.js

@@ -70,7 +70,9 @@ async function collectDependencies(asset, program, ptrs, hmrOptions) {
           codeFrames: [{
             filePath,
             codeHighlights: [{
+              // @ts-expect-error TS2345
               ...(0, _diagnostic().getJSONHighlightLocation)(ptrs['/default_locale'], err),
+              // @ts-expect-error TS2345
               message: (0, _diagnostic().md)`Localization ${err == 'value' ? 'file for ' + program.default_locale : 'directory'} does not exist: ${_path().default.relative(assetDir, _path().default.join(locales, program.default_locale))}`
             }]
           }]

package/lib/schema.d.ts

@@ -0,0 +1,4 @@
+import type { SchemaEntity } from '@atlaspack/utils';
+export declare const MV3Schema: SchemaEntity;
+export declare const MV2Schema: SchemaEntity;
+export declare const VersionSchema: SchemaEntity;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaspack/transformer-webextension",
-  "version": "2.14.21",
+  "version": "2.14.22-typescript-17c3d1dec.0",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -9,15 +9,20 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/WebExtensionTransformer.js",
-  "source": "src/WebExtensionTransformer.js",
+  "main": "./lib/WebExtensionTransformer.js",
+  "source": "./src/WebExtensionTransformer.ts",
+  "types": "./lib/WebExtensionTransformer.d.ts",
   "engines": {},
   "dependencies": {
+    "@atlaspack/diagnostic": "2.14.2-typescript-17c3d1dec.0",
+    "@atlaspack/plugin": "2.14.22-typescript-17c3d1dec.0",
+    "@atlaspack/utils": "2.17.4-typescript-17c3d1dec.0",
     "@mischnic/json-sourcemap": "^0.1.0",
-    "@atlaspack/diagnostic": "2.14.1",
-    "@atlaspack/plugin": "2.14.21",
-    "@atlaspack/utils": "2.17.3",
     "content-security-policy-parser": "^0.3.0"
   },
-  "type": "commonjs"
-}
+  "type": "commonjs",
+  "scripts": {
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src"
+  },
+  "gitHead": "17c3d1decf641e688fcfe3ca985e80e9897b7573"
+}

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

@@ -1,4 +1,3 @@
-// @flow
 import type {MutableAsset, HMROptions} from '@atlaspack/types';
 
 import {Transformer} from '@atlaspack/plugin';
@@ -39,8 +38,10 @@ const DEP_LOCS = [
 async function collectDependencies(
   asset: MutableAsset,
   program: any,
-  ptrs: {[key: string]: any, ...},
-  hmrOptions: ?HMROptions,
+  ptrs: {
+    [key: string]: any;
+  },
+  hmrOptions?: HMROptions | null,
 ) {
   const hot = Boolean(hmrOptions);
   const fs = asset.fs;
@@ -53,10 +54,10 @@ async function collectDependencies(
     let err = !(await fs.exists(locales))
       ? 'key'
       : !(await fs.exists(
-          path.join(locales, program.default_locale, 'messages.json'),
-        ))
-      ? 'value'
-      : null;
+            path.join(locales, program.default_locale, 'messages.json'),
+          ))
+        ? 'value'
+        : null;
     if (err) {
       throw new ThrowableDiagnostic({
         diagnostic: [
@@ -68,7 +69,9 @@ async function collectDependencies(
                 filePath,
                 codeHighlights: [
                   {
+                    // @ts-expect-error TS2345
                     ...getJSONHighlightLocation(ptrs['/default_locale'], err),
+                    // @ts-expect-error TS2345
                     message: md`Localization ${
                       err == 'value'
                         ? 'file for ' + program.default_locale
@@ -151,7 +154,7 @@ async function collectDependencies(
       const loc = {
         filePath,
         ...getJSONSourceLocation(ptrs[`/dictionaries/${dict}`], 'value'),
-      };
+      } as const;
       program.dictionaries[dict] = asset.addURLDependency(dictFile, {
         needsStableName: true,
         loc,
@@ -181,12 +184,12 @@ async function collectDependencies(
     }
   }
   if (program.web_accessible_resources) {
-    let war = [];
+    let war: Array<any> | Array<any | string> = [];
     for (let i = 0; i < program.web_accessible_resources.length; ++i) {
       // TODO: this doesn't support Atlaspack resolution
       const currentEntry = program.web_accessible_resources[i];
       const files = isMV2 ? [currentEntry] : currentEntry.resources;
-      let currentFiles = [];
+      let currentFiles: Array<any> | Array<any | string> = [];
       for (let j = 0; j < files.length; ++j) {
         const globFiles = (
           await glob(path.join(assetDir, files[j]), fs, {})
@@ -218,8 +221,11 @@ async function collectDependencies(
     program.web_accessible_resources = war;
   }
   if (program.declarative_net_request) {
-    const rrs: {|path: string, id: string, enabled: boolean|}[] =
-      program.declarative_net_request?.rule_resources ?? [];
+    const rrs: {
+      path: string;
+      id: string;
+      enabled: boolean;
+    }[] = program.declarative_net_request?.rule_resources ?? [];
     rrs.forEach((resources, i) => {
       resources.path = asset.addURLDependency(resources.path, {
         pipeline: 'raw',
@@ -344,7 +350,7 @@ async function collectDependencies(
       program.permissions.push('scripting');
     }
     const hostPerms = [
-      ...new Set(program.content_scripts?.flatMap((sc) => sc.matches)),
+      ...new Set(program.content_scripts?.flatMap((sc: any) => sc.matches)),
     ];
     if (isMV2) program.permissions = program.permissions.concat(hostPerms);
     else {
@@ -354,7 +360,7 @@ async function collectDependencies(
   }
 }
 
-function cspPatchHMR(policy: ?string, insert?: string) {
+function cspPatchHMR(policy?: string | null, insert?: string) {
   let defaultSrc = "'self'";
   if (insert == null) {
     insert = "'unsafe-eval'";
@@ -381,7 +387,7 @@ function cspPatchHMR(policy: ?string, insert?: string) {
   }
 }
 
-export default (new Transformer({
+export default new Transformer({
   async transform({asset, options}) {
     // Set environment to browser, since web extensions are always used in
     // browsers, and because it avoids delegating extra config to the user
@@ -433,4 +439,4 @@ export default (new Transformer({
     asset.meta.webextEntry = true;
     return [asset];
   },
-}): Transformer<mixed>);
+}) as Transformer<unknown>;

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

@@ -1,7 +1,6 @@
-// @flow strict-local
 import type {SchemaEntity} from '@atlaspack/utils';
 
-const validateVersion = (ver: string): ?string => {
+const validateVersion = (ver: string): string | null | undefined => {
   const parts = ver.split('.', 5);
   if (parts.length == 5) return 'Extension versions to have at most three dots';
   if (
@@ -33,12 +32,12 @@ const actionProps = {
   },
   default_popup: string,
   default_title: string,
-};
+} as const;
 
 const arrStr = {
   type: 'array',
   items: string,
-};
+} as const;
 
 const browserAction = {
   type: 'object',
@@ -64,7 +63,7 @@ const browserAction = {
     },
   },
   additionalProperties: false,
-};
+} as const;
 
 const warBase = {
   type: 'object',
@@ -75,7 +74,7 @@ const warBase = {
     use_dynamic_url: boolean,
   },
   additionalProperties: false,
-};
+} as const;
 
 const mv2Background = {
   type: 'object',
@@ -85,7 +84,7 @@ const mv2Background = {
     persistent: boolean,
   },
   additionalProperties: false,
-};
+} as const;
 
 const commonProps = {
   $schema: string,
@@ -145,7 +144,7 @@ const commonProps = {
     },
     additionalProperties: false,
   },
-  commands: ({
+  commands: {
     type: 'object',
     properties: {},
     additionalProperties: {
@@ -168,7 +167,7 @@ const commonProps = {
       },
       additionalProperties: false,
     },
-  }: SchemaEntity),
+  } as SchemaEntity,
   content_scripts: {
     type: 'array',
     items: {
@@ -195,7 +194,7 @@ const commonProps = {
       required: ['matches'],
     },
   },
-  declarative_net_request: ({
+  declarative_net_request: {
     type: 'object',
     properties: {
       rule_resources: {
@@ -214,14 +213,14 @@ const commonProps = {
     },
     additionalProperties: false,
     required: ['rule_resources'],
-  }: SchemaEntity),
+  } as SchemaEntity,
   devtools_page: string,
   // looks to be FF only
-  dictionaries: ({
+  dictionaries: {
     type: 'object',
     properties: {},
     additionalProperties: string,
-  }: SchemaEntity),
+  } as SchemaEntity,
   externally_connectable: {
     type: 'object',
     properties: {
@@ -280,11 +279,11 @@ const commonProps = {
     additionalProperties: false,
   },
   offline_enabled: boolean,
-  omnibox: ({
+  omnibox: {
     type: 'object',
     properties: {},
     additionalProperties: string,
-  }: SchemaEntity),
+  } as SchemaEntity,
   optional_host_permissions: arrStr,
   optional_permissions: arrStr,
   // options_page is deprecated
@@ -453,9 +452,9 @@ const commonProps = {
     additionalProperties: false,
   },
   version_name: string,
-};
+} as const;
 
-export const MV3Schema = ({
+export const MV3Schema = {
   type: 'object',
   properties: {
     ...commonProps,
@@ -525,9 +524,9 @@ export const MV3Schema = ({
     },
   },
   required: ['manifest_version', 'name', 'version'],
-}: SchemaEntity);
+} as SchemaEntity;
 
-export const MV2Schema = ({
+export const MV2Schema = {
   type: 'object',
   properties: {
     ...commonProps,
@@ -560,9 +559,9 @@ export const MV2Schema = ({
     web_accessible_resources: arrStr,
   },
   required: ['manifest_version', 'name', 'version'],
-}: SchemaEntity);
+} as SchemaEntity;
 
-export const VersionSchema = ({
+export const VersionSchema = {
   type: 'object',
   properties: {
     $schema: string,
@@ -572,4 +571,4 @@ export const VersionSchema = ({
     },
   },
   required: ['manifest_version'],
-}: SchemaEntity);
+} as SchemaEntity;

package/tsconfig.json

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