Skip to content

feat(javascript): add workerd exports #3680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 10, 2024
Merged

feat(javascript): add workerd exports #3680

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
88e0825
feat(javascript): add workerd exports
shortcuts Sep 9, 2024
b9aaad2
feat: real fetch bundle
shortcuts Sep 9, 2024
4a76df0
Merge branch 'main' into feat/javascript-workerd-exports
shortcuts Sep 9, 2024
6f90501
Merge branch 'main' into feat/javascript-workerd-exports
shortcuts Sep 9, 2024
5308b3b
chore: assert with miniflare
shortcuts Sep 9, 2024
b6d31ce
chore: resolve from source
shortcuts Sep 9, 2024
b6ae0e8
Merge branch 'main' into feat/javascript-workerd-exports
shortcuts Sep 9, 2024
6afa97c
chore: revert unwanted changes
shortcuts Sep 9, 2024
5bfa333
chore: typo
shortcuts Sep 9, 2024
b731f5c
chore: no default
shortcuts Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions clients/algoliasearch-client-javascript/base.tsup.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable no-case-declarations */
import path from 'path';

import type { Options } from 'tsup';
Expand All @@ -7,6 +8,8 @@ type PKG = {
name: string;
};

type Requester = 'fetch' | 'http' | 'xhr';

export function getBaseConfig(cwd: string): Options {
return {
clean: true,
Expand All @@ -16,35 +19,44 @@ export function getBaseConfig(cwd: string): Options {
};
}

export function getDependencies(pkg: PKG, env: 'browser' | 'node'): string[] {
export function getDependencies(pkg: PKG, requester: Requester): string[] {
const deps = Object.keys(pkg.dependencies || {}) || [];

if (pkg.name !== 'algoliasearch') {
return deps;
}

if (env === 'node') {
return deps.filter((dep) => dep !== '@algolia/requester-browser-xhr');
switch (requester) {
case 'http':
return deps.filter((dep) => dep !== '@algolia/requester-browser-xhr');
case 'xhr':
return deps.filter((dep) => dep !== '@algolia/requester-node-http');
case 'fetch':
const fetchDeps = deps.filter(
(dep) => dep !== '@algolia/requester-browser-xhr' && dep !== '@algolia/requester-node-http',
);
fetchDeps.push('@algolia/requester-fetch');
return fetchDeps;
default:
throw new Error('unknown requester', requester);
}

return deps.filter((dep) => dep !== '@algolia/requester-node-http');
}

export function getBaseNodeOptions(pkg: PKG, cwd: string): Options {
export function getBaseNodeOptions(pkg: PKG, cwd: string, requester: Requester = 'http'): Options {
return {
...getBaseConfig(cwd),
platform: 'node',
target: 'node14',
external: [...getDependencies(pkg, 'node'), 'node:crypto'],
external: [...getDependencies(pkg, requester), 'node:crypto'],
};
}

export function getBaseBrowserOptions(pkg: PKG, cwd: string): Options {
export function getBaseBrowserOptions(pkg: PKG, cwd: string, requester: Requester = 'xhr'): Options {
return {
...getBaseConfig(cwd),
platform: 'browser',
format: ['esm'],
target: ['chrome109', 'safari15.6', 'firefox115', 'edge126'],
external: [...getDependencies(pkg, 'browser'), 'dom'],
external: [...getDependencies(pkg, requester), 'dom'],
};
}
6 changes: 4 additions & 2 deletions clients/algoliasearch-client-javascript/packages/client-common/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
"types": {
"import": "./dist/common.d.ts",
"module": "./dist/common.d.ts",
"require": "./dist/common.d.cts"
"require": "./dist/common.d.cts",
"default": "./dist/common.d.cts"
},
"import": "./dist/common.esm.js",
"module": "./dist/common.esm.js",
"require": "./dist/common.cjs"
"require": "./dist/common.cjs",
"default": "./dist/common.cjs"
},
"./src/*": "./src/*.ts"
},
Expand Down
8 changes: 6 additions & 2 deletions clients/algoliasearch-client-javascript/packages/requester-fetch/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@
"types": {
"import": "./dist/requester.fetch.node.d.ts",
"module": "./dist/requester.fetch.node.d.ts",
"require": "./dist/requester.fetch.node.d.cts"
"workerd": "./dist/requester.fetch.node.d.ts",
"require": "./dist/requester.fetch.node.d.cts",
"default": "./dist/requester.fetch.node.d.cts"
},
"import": "./dist/requester.fetch.node.js",
"module": "./dist/requester.fetch.node.js",
"require": "./dist/requester.fetch.node.cjs"
"workerd": "./dist/requester.fetch.node.js",
"require": "./dist/requester.fetch.node.cjs",
"default": "./dist/requester.fetch.node.cjs"
},
"default": {
"types": "./dist/requester.fetch.browser.d.ts",
Expand Down
6 changes: 4 additions & 2 deletions clients/algoliasearch-client-javascript/packages/requester-node-http/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
"types": {
"import": "./dist/requester.http.d.ts",
"module": "./dist/requester.http.d.ts",
"require": "./dist/requester.http.d.cts"
"require": "./dist/requester.http.d.cts",
"default": "./dist/requester.http.d.cts"
},
"import": "./dist/requester.http.js",
"module": "./dist/requester.http.js",
"require": "./dist/requester.http.cjs"
"require": "./dist/requester.http.cjs",
"default": "./dist/requester.http.cjs"
},
"./src/*": "./src/*.ts"
},
Expand Down
22 changes: 16 additions & 6 deletions templates/javascript/clients/package.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@
"types": {
"import": "./dist/node.d.ts",
"module": "./dist/node.d.ts",
"require": "./dist/node.d.cts"
"require": "./dist/node.d.cts",
"workerd": "./dist/node.d.ts",
"default": "./dist/node.d.cts"
},
"import": "./dist/builds/node.js",
"module": "./dist/builds/node.js",
"require": "./dist/builds/node.cjs"
"require": "./dist/builds/node.cjs",
"workerd": "./dist/builds/node.fetch.js",
"default": "./dist/builds/node.cjs"
},
"default": {
"types": "./dist/browser.d.ts",
Expand Down Expand Up @@ -62,11 +66,15 @@
"types": {
"import": "./dist/node.d.ts",
"module": "./dist/node.d.ts",
"require": "./dist/node.d.cts"
"workerd": "./dist/node.d.ts",
"require": "./dist/node.d.cts",
"default": "./dist/node.d.cts"
},
"import": "./dist/node.js",
"module": "./dist/node.js",
"require": "./dist/node.cjs"
"workerd": "./dist/node.fetch.js",
"require": "./dist/node.cjs",
"default": "./dist/node.cjs"
},
"default": {
"types": "./dist/browser.d.ts",
Expand All @@ -80,11 +88,13 @@
"types": {
"import": "./dist/lite/node.d.ts",
"module": "./dist/lite/node.d.ts",
"require": "./dist/lite/node.d.cts"
"require": "./dist/lite/node.d.cts",
"default": "./dist/lite/node.d.cts"
},
"import": "./dist/lite/builds/node.js",
"module": "./dist/lite/builds/node.js",
"require": "./dist/lite/builds/node.cjs"
"require": "./dist/lite/builds/node.cjs",
"default": "./dist/lite/builds/node.cjs"
},
"default": {
"types": "./dist/lite/browser.d.ts",
Expand Down
37 changes: 27 additions & 10 deletions templates/javascript/clients/tsup.config.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ const nodeOptions: Options = {
...getBaseNodeOptions(pkg, __dirname),
dts: { entry: { 'node': '{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}builds/node.ts' } },
entry: ['{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}builds/node.ts', '{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}src/*.ts'],

{{#isAlgoliasearchClient}}
outDir: 'dist/lite',
{{/isAlgoliasearchClient}}
Expand All @@ -19,30 +18,49 @@ const nodeConfigs: Options[] = [
{
...nodeOptions,
format: 'cjs',
name: 'node{{#isAlgoliasearchClient}} lite{{/isAlgoliasearchClient}} cjs'
name: `node ${pkg.name} cjs`
},
{
...nodeOptions,
format: 'esm',
name: `node ${pkg.name} esm`
},
{{^isAlgoliasearchClient}}
{
...nodeOptions,
format: 'esm',
name: 'node{{#isAlgoliasearchClient}} lite{{/isAlgoliasearchClient}} esm'
name: `node ${pkg.name} fetch esm`,
dts: false,
external: getDependencies(pkg, 'fetch'),
entry: { 'builds/node.fetch': 'builds/node.ts' },
},
{{/isAlgoliasearchClient}}
{{#isAlgoliasearchClient}}
{
...nodeOptions,
format: 'cjs',
name: 'node cjs',
name: 'node algoliasearch cjs',
dts: { entry: { 'node': 'builds/node.ts' } },
entry: ['builds/node.ts'],
outDir: 'dist',
},
{
...nodeOptions,
format: 'esm',
name: 'node esm',
name: 'node algoliasearch esm',
dts: { entry: { 'node': 'builds/node.ts' } },
entry: ['builds/node.ts'],
outDir: 'dist',
},
{
...nodeOptions,
format: 'esm',
name: 'node algoliasearch fetch esm',
dts: false,
entry: { 'node.fetch': 'builds/node.ts' },
outDir: 'dist',
external: getDependencies(pkg, 'fetch'),
},
{{/isAlgoliasearchClient}}
];

Expand All @@ -51,7 +69,6 @@ const browserOptions: Options = {
{{^isAlgoliasearchClient}}
globalName: '{{apiName}}',
{{/isAlgoliasearchClient}}

{{#isAlgoliasearchClient}}
globalName: 'lite',
outDir: 'dist/lite',
Expand All @@ -62,7 +79,7 @@ const browserConfigs: Options[] = [
{
...browserOptions,
minify: false,
name: 'browser esm',
name: `browser ${pkg.name} esm`,
dts: { entry: { 'browser': '{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}builds/browser.ts' } },
entry: ['{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}builds/browser.ts', '{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}src/*.ts'],
{{#isAlgoliasearchClient}}
Expand All @@ -73,14 +90,14 @@ const browserConfigs: Options[] = [
...browserOptions,
dts: false,
minify: true,
name: 'browser min esm',
name: `browser ${pkg.name} min esm`,
entry: {'builds/browser.min': '{{#isAlgoliasearchClient}}lite/{{/isAlgoliasearchClient}}builds/browser.ts'},
external: [],
{{#isAlgoliasearchClient}}
noExternal: ['dom', '@algolia/client-common', '@algolia/requester-browser-xhr'],
{{/isAlgoliasearchClient}}
{{^isAlgoliasearchClient}}
noExternal: getDependencies(pkg, 'browser'),
noExternal: getDependencies(pkg, 'xhr'),
{{/isAlgoliasearchClient}}
},
{{#isAlgoliasearchClient}}
Expand All @@ -102,7 +119,7 @@ const browserConfigs: Options[] = [
entry: {'browser.min': 'builds/browser.ts'},
outDir: 'dist',
external: [],
noExternal: getDependencies(pkg, 'browser'),
noExternal: getDependencies(pkg, 'xhr'),
}
{{/isAlgoliasearchClient}}
];
Expand Down