import from 'webext-dynamic-content-scripts/utils.js' doesn't work

[aspiers]

The README says that this should work:

import {isContentScriptRegistered} from 'webext-dynamic-content-scripts/utils.js';

However, it refuses to import:

[commonjs--resolver] Missing "./utils.js" export in "webext-dynamic-content-scripts" package

As far as I can tell, this is due to the "exports" section of package.json not covering this file:

webext-dynamic-content-scripts/package.json

Lines 25 to 34 in d5ced5f

	"exports": {
	".": {
	"types": "./distribution/index.d.ts",
	"default": "./distribution/index.js"
	},
	"./including-active-tab.js": {
	"types": "./distribution/including-active-tab.d.ts",
	"default": "./distribution/including-active-tab.js"
	}
	},

I tried adding these lines to this section:

		"./utils.js": {
			"types": "./distribution/utils.d.ts",
			"default": "./distribution/utils.js"
		}

and then the import immediately worked.

I'm no Javascript expert, but it seems a bit odd to be declaring each of these files manually in "exports". Can't it be done with a wildcard? And is there any reason not to re-export isContentScriptRegistered from index.ts, so that it can be imported directly from 'webext-dynamic-content-scripts'?

[aspiers]

Tangential thought: it would be helpful if the docs explained in which context(s) this function can be used. Presumably not very useful from inside a content script, since if it runs then we already know that that particular content script is registered. Is it for running in the background worker, for instance? But I tried it there and got:

Top-level await is not available in the configured target environment ("chrome87", "edge88", "es2020", "firefox78", "safari13" + 2 overrides)

Wrapping the call inside an async function and calling that worked, but it would be nice if this was covered in the README.

[fregante]

As far as I can tell, this is due to the "exports" section of package.json

Yes. Can you open a PR?

Can't it be done with a wildcard?

It can, but I don't want to expose all those files because they're not part of the public API

it seems a bit odd to be declaring each of these files manually in "exports"

Yeah that's a new development: explicitly make available the files you expose, and hide the rest.

And is there any reason not to re-export isContentScriptRegistered from index.ts, so that it can be imported directly from 'webext-dynamic-content-scripts'?

The main file has side effects, so if you just wanted to use the util you cannot. That's why I made it available separately.

[fregante]

it would be helpful if the docs explained in which context(s) this function can be used.

Yes I try to do that in my webext-* modules but I rarely remember.

Is it for running in the background worker, for instance?

The util can be run anywhere that isn't the content script. The main import only in the background.

That error is due to your bundler, not a mistake in usage.

[aspiers]

Thanks for the illuminating responses; submitted #68.