Do not export ./snippets module in browser mode

[Wauplin]

⚠️ PR opened on top of #1255

Related to this thread #1255 (comment).

@coyotte508 @SBrandeis @julien-c WDYT? 🙈

for the record, I'm looking for a solution where:

1. we keep this public/open-source
2. we keep the structure of jinja templates
3. ideally no new package in hf.js
4. ideally no new tooling (e.g. to translate jinja into TS code)

Solution here is simply to gracefully raise an error if environment not supported.
EDIT: based on #1259 (comment), goal is to not package the ./snippets module in browser mode.

[coyotte508]

hm you should go the @huggingface/hub way, for functions like download-file-to-cache-dir

They have this section:

huggingface.js/packages/hub/package.json

Lines 20 to 28 in 5cd51b9

	"browser": {
	"./src/utils/sha256-node.ts": false,
	"./src/utils/FileBlob.ts": false,
	"./src/lib/cache-management.ts": false,
	"./src/lib/download-file-to-cache-dir.ts": false,
	"./src/lib/snapshot-download.ts": false,
	"./dist/index.js": "./dist/browser/index.js",
	"./dist/index.mjs": "./dist/browser/index.mjs"
	},

and the tsup config https://github.com/huggingface/huggingface.js/blob/5cd51b9901f173d286148531a41cd1193f76b74a/packages/hub/tsup.config.ts#L1-L24

Then you can export snippets only for non-browser context

I think otherwise you'll still have issues importing node packages even if you don't use them, for versions of the lib released on the CDNs

[Wauplin]

I'll look into it, thanks @coyotte508 !

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[Wauplin]

@coyotte508 what would be the best way to do a conditional import here? I haven't found any convincing solution. In @huggingface/hub it's not really a problem as everything is included using export * from "./lib"; (here).

[coyotte508]

I'm not sure there's an issue? Is there an error when just keeping the code as before?

[Wauplin]

it felt weird to do import * as snippets from "./snippets/index.js"; when we know ./snippets/index.js might not be in the final package. But looks like tooling is done the correct way so perfect 😄

[Wauplin]

Thanks for fixing things @coyotte508 ! Ok to merge it now? (into #1255 I mean)

[coyotte508]

yes