@atlaspack/transformer-webextension 2.14.5-canary.16 → 2.14.5-canary.161

package/CHANGELOG.md

@@ -1,5 +1,162 @@
 # @atlaspack/transformer-webextension
 
+## 2.14.25
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.18.2
+  - @atlaspack/plugin@2.14.25
+
+## 2.14.24
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.18.1
+  - @atlaspack/plugin@2.14.24
+
+## 2.14.23
+
+### Patch Changes
+
+- Updated dependencies [[`23d561e`](https://github.com/atlassian-labs/atlaspack/commit/23d561e51e68b0c38fd1ff4e4fb173e5e7b01cf2)]:
+  - @atlaspack/utils@2.18.0
+  - @atlaspack/plugin@2.14.23
+
+## 2.14.22
+
+### 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
+
+- Updated dependencies [[`d2fd849`](https://github.com/atlassian-labs/atlaspack/commit/d2fd849770fe6305e9c694bd97b1bd905abd9d94)]:
+  - @atlaspack/diagnostic@2.14.2
+  - @atlaspack/plugin@2.14.22
+  - @atlaspack/utils@2.17.4
+
+## 2.14.21
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.17.3
+  - @atlaspack/plugin@2.14.21
+
+## 2.14.20
+
+### Patch Changes
+
+- [#702](https://github.com/atlassian-labs/atlaspack/pull/702) [`daaa768`](https://github.com/atlassian-labs/atlaspack/commit/daaa7688786772d7e3713b71c5bba6b89ec704aa) Thanks [@alshdavid](https://github.com/alshdavid)! - Fixes to Flow types
+
+- Updated dependencies [[`daaa768`](https://github.com/atlassian-labs/atlaspack/commit/daaa7688786772d7e3713b71c5bba6b89ec704aa)]:
+  - @atlaspack/plugin@2.14.20
+  - @atlaspack/utils@2.17.2
+
+## 2.14.19
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.17.1
+  - @atlaspack/plugin@2.14.19
+
+## 2.14.18
+
+### Patch Changes
+
+- Updated dependencies [[`dbb4072`](https://github.com/atlassian-labs/atlaspack/commit/dbb40721ebeb45990a14ba04e6b44e7f836fb32d), [`de23e0c`](https://github.com/atlassian-labs/atlaspack/commit/de23e0ce49d5504fe3947ac26640a3d951087da3), [`18a57cf`](https://github.com/atlassian-labs/atlaspack/commit/18a57cf8a4789b2de5ad8e2676f317a26cc91417), [`a5ed1b4`](https://github.com/atlassian-labs/atlaspack/commit/a5ed1b414498560f393ff491af4da25b6e8dde56)]:
+  - @atlaspack/utils@2.17.0
+  - @atlaspack/plugin@2.14.18
+
+## 2.14.17
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.16.1
+  - @atlaspack/plugin@2.14.17
+
+## 2.14.16
+
+### Patch Changes
+
+- Updated dependencies [[`30ee2cf`](https://github.com/atlassian-labs/atlaspack/commit/30ee2cfcd34cf2646ded0eda13fdb80a2a5de529)]:
+  - @atlaspack/utils@2.16.0
+  - @atlaspack/plugin@2.14.16
+
+## 2.14.15
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.15.3
+  - @atlaspack/plugin@2.14.15
+
+## 2.14.14
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.15.2
+  - @atlaspack/plugin@2.14.14
+
+## 2.14.13
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.15.1
+  - @atlaspack/plugin@2.14.13
+
+## 2.14.12
+
+### Patch Changes
+
+- Updated dependencies [[`e39c6cf`](https://github.com/atlassian-labs/atlaspack/commit/e39c6cf05f7e95ce5420dbcea66f401b1cbd397c)]:
+  - @atlaspack/utils@2.15.0
+  - @atlaspack/plugin@2.14.12
+
+## 2.14.11
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.14.11
+  - @atlaspack/plugin@2.14.11
+
+## 2.14.10
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/plugin@2.14.10
+  - @atlaspack/utils@2.14.10
+
+## 2.14.9
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.14.9
+  - @atlaspack/plugin@2.14.9
+
+## 2.14.8
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.14.8
+  - @atlaspack/plugin@2.14.8
+
+## 2.14.7
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @atlaspack/utils@2.14.7
+  - @atlaspack/plugin@2.14.7
+
 ## 2.14.6
 
 ### Patch Changes

package/lib/WebExtensionTransformer.js

@@ -70,6 +70,7 @@ async function collectDependencies(asset, program, ptrs, hmrOptions) {
           codeFrames: [{
             filePath,
             codeHighlights: [{
+              // @ts-expect-error TS2345
               ...(0, _diagnostic().getJSONHighlightLocation)(ptrs['/default_locale'], err),
               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/types/WebExtensionTransformer.d.ts

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

package/lib/types/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.5-canary.16+4b2b575b9",
+  "version": "2.14.5-canary.161+ee040bb64",
   "license": "(MIT OR Apache-2.0)",
   "publishConfig": {
     "access": "public"
@@ -9,16 +9,21 @@
     "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/types/WebExtensionTransformer.d.ts",
   "engines": {},
   "dependencies": {
-    "@atlaspack/diagnostic": "2.14.1-canary.84+4b2b575b9",
-    "@atlaspack/plugin": "2.14.5-canary.16+4b2b575b9",
-    "@atlaspack/utils": "2.14.5-canary.16+4b2b575b9",
+    "@atlaspack/diagnostic": "2.14.1-canary.229+ee040bb64",
+    "@atlaspack/plugin": "2.14.5-canary.161+ee040bb64",
+    "@atlaspack/utils": "2.14.5-canary.161+ee040bb64",
     "@mischnic/json-sourcemap": "^0.1.0",
     "content-security-policy-parser": "^0.3.0"
   },
   "type": "commonjs",
-  "gitHead": "4b2b575b98951f2dcf0c45ed8e94359b23b43815"
+  "scripts": {
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src",
+    "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
+  },
+  "gitHead": "ee040bb6428f29b57d892ddd8107e29077d08ffd"
 }

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,6 +69,7 @@ async function collectDependencies(
                 filePath,
                 codeHighlights: [
                   {
+                    // @ts-expect-error TS2345
                     ...getJSONHighlightLocation(ptrs['/default_locale'], err),
                     message: md`Localization ${
                       err == 'value'
@@ -151,7 +153,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 +183,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 +220,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 +349,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 +359,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 +386,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 +438,4 @@ export default (new Transformer({
     asset.meta.webextEntry = true;
     return [asset];
   },
-}): Transformer);
+}) 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"]
+}