Skip to content

Commit eae1a55

Browse files
raed667raed667
authored
fix: rename UMD files from CJS to JS (#33)
1 parent d08005d commit eae1a55

File tree

11 files changed

+108
-51
lines changed

11 files changed

+108
-51
lines changed

‎README.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ npm install @algolia/generative-experiences-react@0.0.0
4242

4343
```html
4444
// for the API Client
45-
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-api-client@0.0.0/dist/index.umd.cjs"></script>
45+
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-api-client@1.0.0/dist/index.umd.js"></script>
4646
<script>
4747
const { createClient } = window['@algolia/generative-experiences-api-client'];
4848
</script>
4949

5050
// for the JavaScript UI library
51-
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-js@0.0.0/dist/index.umd.cjs"></script>
51+
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-js@1.0.0/dist/index.umd.js"></script>
5252
<script>
5353
// TODO
5454
</script>
5555

5656
// for the React UI library
57-
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-react@0.0.0/dist/index.umd.cjs"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/@algolia/generative-experiences-react@1.0.0/dist/index.umd.js"></script>
5858
<script>
5959
// TODO
6060
</script>
@@ -68,46 +68,46 @@ npm install @algolia/generative-experiences-react@0.0.0
6868

6969
Displaying a shopping guide:
7070

71-
```JSX
71+
```JSX
7272
import React from 'react';
7373
import { createClient } from '@algolia/generative-experiences-api-client';
7474
import {
75-
ShoppingGuidesContent,
75+
ShoppingGuidesContent,
7676
} from '@algolia/generative-experiences-react';
7777

7878
const options = {
79-
appId: 'YourApplicationID',
80-
indexName: 'your_index_name',
81-
searchOnlyAPIKey: 'YourSearchOnlyAPIKey',
82-
writeAPIKey: 'YourWriteAPIKey',
79+
appId: 'YourApplicationID',
80+
indexName: 'your_index_name',
81+
searchOnlyAPIKey: 'YourSearchOnlyAPIKey',
82+
writeAPIKey: 'YourWriteAPIKey',
8383
};
8484

8585
const gseClient = createClient(options);
8686

8787
function App({ currentObjectID, userToken }) {
8888

89-
// ...
90-
91-
return (
92-
<ShoppingGuidesContent
93-
client={gseClient}
94-
showFeedback
95-
userToken={userToken}
96-
objectID={currentObjectID}
97-
onlyPublished
98-
itemComponent={({ hit }) => {
99-
return (
100-
<pre>
101-
<code>{JSON.stringify(hit)}</code>
102-
</pre>
103-
);
104-
}}
105-
/>
106-
)
89+
// ...
90+
91+
return (
92+
<ShoppingGuidesContent
93+
client={gseClient}
94+
showFeedback
95+
userToken={userToken}
96+
objectID={currentObjectID}
97+
onlyPublished
98+
itemComponent={({ hit }) => {
99+
return (
100+
<pre>
101+
<code>{JSON.stringify(hit)}</code>
102+
</pre>
103+
);
104+
}}
105+
/>
106+
)
107107
}
108108
```
109109

110-
You can find more examples and implementation details in the [Algolia Docs](https://www.algolia.com/doc/guides/algolia-ai/shopping-guides/) or in the [React package]((/packages/generative-experiences-react/README.md))
110+
You can find more examples and implementation details in the [Algolia Docs](https://www.algolia.com/doc/guides/algolia-ai/shopping-guides/) or in the [React package](<(/packages/generative-experiences-react/README.md)>)
111111

112112
## 🙋 FAQ
113113

‎bundlesize.config.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,31 @@
55
"maxSize": "27.46 kB"
66
},
77
{
8-
"path": "packages/generative-experiences-api-client/dist/index.umd.cjs",
8+
"path": "packages/generative-experiences-api-client/dist/index.umd.js",
99
"maxSize": "11.43 kB"
1010
},
1111
{
1212
"path": "packages/generative-experiences-vdom/dist/index.js",
1313
"maxSize": "18.3 kB"
1414
},
1515
{
16-
"path": "packages/generative-experiences-vdom/dist/index.umd.cjs",
16+
"path": "packages/generative-experiences-vdom/dist/index.umd.js",
1717
"maxSize": "14.9 kB"
1818
},
1919
{
2020
"path": "packages/generative-experiences-react/dist/index.js",
2121
"maxSize": "19.6 kB"
2222
},
2323
{
24-
"path": "packages/generative-experiences-react/dist/index.umd.cjs",
24+
"path": "packages/generative-experiences-react/dist/index.umd.js",
2525
"maxSize": "15.9 kB"
2626
},
2727
{
2828
"path": "packages/generative-experiences-js/dist/index.js",
2929
"maxSize": "19.6 kB"
3030
},
3131
{
32-
"path": "packages/generative-experiences-js/dist/index.umd.cjs",
32+
"path": "packages/generative-experiences-js/dist/index.umd.js",
3333
"maxSize": "15.9 kB"
3434
}
3535
]

‎packages/generative-experiences-api-client/package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
"source": "src/index.ts",
2020
"types": "dist/index.d.ts",
2121
"module": "dist/index.js",
22-
"main": "dist/index.umd.cjs",
23-
"umd:main": "dist/index.umd.cjs",
24-
"unpkg": "dist/index.umd.cjs",
25-
"jsdelivr": "dist/index.umd.cjs",
22+
"main": "dist/index.umd.js",
23+
"umd:main": "dist/index.umd.js",
24+
"unpkg": "dist/index.umd.js",
25+
"jsdelivr": "dist/index.umd.js",
2626
"sideEffects": false,
2727
"scripts": {
2828
"build": "tsc && vite build",

‎packages/generative-experiences-api-client/vite.config.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,20 @@ export default defineConfig({
1717
name: '@algolia/generative-experiences-api-client',
1818
fileName: 'index',
1919
},
20+
rollupOptions: {
21+
output: [
22+
{
23+
format: 'umd',
24+
dir: path.resolve(__dirname, 'dist/'),
25+
entryFileNames: 'index.umd.js',
26+
name: '@algolia/generative-experiences-api-client',
27+
},
28+
{
29+
format: 'esm',
30+
dir: path.resolve(__dirname, 'dist/'),
31+
entryFileNames: 'index.js',
32+
},
33+
],
34+
},
2035
},
2136
});

‎packages/generative-experiences-js/package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
"source": "src/index.ts",
2020
"types": "dist/index.d.ts",
2121
"module": "dist/index.js",
22-
"main": "dist/index.umd.cjs",
23-
"umd:main": "dist/index.umd.cjs",
24-
"unpkg": "dist/index.umd.cjs",
25-
"jsdelivr": "dist/index.umd.cjs",
22+
"main": "dist/index.umd.js",
23+
"umd:main": "dist/index.umd.js",
24+
"unpkg": "dist/index.umd.js",
25+
"jsdelivr": "dist/index.umd.js",
2626
"sideEffects": false,
2727
"scripts": {
2828
"build": "tsc && vite build",

‎packages/generative-experiences-js/vite.config.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,22 @@ export default defineConfig({
1919
name: '@algolia/generative-experiences-js',
2020
fileName: 'index',
2121
},
22+
2223
rollupOptions: {
2324
external: ['react', 'react/jsx-runtime'],
25+
output: [
26+
{
27+
format: 'umd',
28+
dir: path.resolve(__dirname, 'dist/'),
29+
entryFileNames: 'index.umd.js',
30+
name: '@algolia/generative-experiences-js',
31+
},
32+
{
33+
format: 'esm',
34+
dir: path.resolve(__dirname, 'dist/'),
35+
entryFileNames: 'index.js',
36+
},
37+
],
2438
},
2539
},
2640
});

‎packages/generative-experiences-react/package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
"source": "src/index.ts",
2020
"types": "dist/index.d.ts",
2121
"module": "dist/index.js",
22-
"main": "dist/index.umd.cjs",
23-
"umd:main": "dist/index.umd.cjs",
24-
"unpkg": "dist/index.umd.cjs",
25-
"jsdelivr": "dist/index.umd.cjs",
22+
"main": "dist/index.umd.js",
23+
"umd:main": "dist/index.umd.js",
24+
"unpkg": "dist/index.umd.js",
25+
"jsdelivr": "dist/index.umd.js",
2626
"sideEffects": false,
2727
"scripts": {
2828
"build": "tsc && vite build",

‎packages/generative-experiences-react/vite.config.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ export default defineConfig({
2121
},
2222
rollupOptions: {
2323
external: ['react', 'react/jsx-runtime'],
24+
output: [
25+
{
26+
format: 'umd',
27+
dir: path.resolve(__dirname, 'dist/'),
28+
entryFileNames: 'index.umd.js',
29+
name: '@algolia/generative-experiences-react',
30+
},
31+
{
32+
format: 'esm',
33+
dir: path.resolve(__dirname, 'dist/'),
34+
entryFileNames: 'index.js',
35+
},
36+
],
2437
},
2538
},
2639
});

‎packages/generative-experiences-vdom/package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
"source": "src/index.ts",
2020
"types": "dist/index.d.ts",
2121
"module": "dist/index.js",
22-
"main": "dist/index.umd.cjs",
23-
"umd:main": "dist/index.umd.cjs",
24-
"unpkg": "dist/index.umd.cjs",
25-
"jsdelivr": "dist/index.umd.cjs",
22+
"main": "dist/index.umd.js",
23+
"umd:main": "dist/index.umd.js",
24+
"unpkg": "dist/index.umd.js",
25+
"jsdelivr": "dist/index.umd.js",
2626
"scripts": {
2727
"build": "tsc && vite build",
2828
"test": "yarn vitest --run"

‎packages/generative-experiences-vdom/vite.config.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,20 @@ export default defineConfig({
1717
name: '@algolia/generative-experiences-vdom',
1818
fileName: 'index',
1919
},
20+
rollupOptions: {
21+
output: [
22+
{
23+
format: 'umd',
24+
dir: path.resolve(__dirname, 'dist/'),
25+
entryFileNames: 'index.umd.js',
26+
name: '@algolia/generative-experiences-vdom',
27+
},
28+
{
29+
format: 'esm',
30+
dir: path.resolve(__dirname, 'dist/'),
31+
entryFileNames: 'index.js',
32+
},
33+
],
34+
},
2035
},
2136
});

0 commit comments

Comments
 (0)