Skip to content

Commit df222d7

Browse files
authored
feat(javascript): use @algolia NPM namespace (#785)
1 parent e8e2731 commit df222d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+380
-372
lines changed

.github/workflows/check.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ jobs:
165165

166166
- name: Run tests for 'client-common'
167167
if: ${{ steps.cache.outputs.cache-hit != 'true' && matrix.client == 'client-common' }}
168-
run: cd clients/algoliasearch-client-javascript && yarn workspace @experimental-api-clients-automation/client-common test
168+
run: cd clients/algoliasearch-client-javascript && yarn workspace @algolia/client-common test
169169

170170
- name: Store '${{ matrix.client }}' JavaScript utils package
171171
uses: actions/upload-artifact@v3
@@ -243,7 +243,7 @@ jobs:
243243

244244
- name: Run JavaScript 'algoliasearch' client tests
245245
if: ${{ steps.cache.outputs.cache-hit != 'true' && matrix.client.language == 'javascript' }}
246-
run: cd ${{ matrix.client.path }} && yarn workspace @experimental-api-clients-automation/algoliasearch test
246+
run: cd ${{ matrix.client.path }} && yarn workspace algoliasearch test
247247

248248
- name: Clean CTS output before generate
249249
run: rm -rf ${{ matrix.client.testsToDelete }} || true

clients/algoliasearch-client-javascript/base.rollup.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import fs from 'fs';
22

33
// Org where the packages are pushed
4-
const NPM_ORG = '@experimental-api-clients-automation/';
4+
const NPM_ORG = '@algolia/';
55

66
// Output formats
77
const BROWSER_FORMATS = ['esm-browser', 'umd'];

clients/algoliasearch-client-javascript/bundlesize.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
},
77
{
88
"path": "packages/algoliasearch/dist/lite/lite.umd.js",
9-
"maxSize": "3.85KB"
9+
"maxSize": "3.90KB"
1010
},
1111
{
1212
"path": "packages/client-abtesting/dist/client-abtesting.umd.js",

clients/algoliasearch-client-javascript/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"build:all": "./scripts/build_all.sh",
1010
"build:utils": "yarn build utils",
1111
"clean": "rm -rf packages/*/dist || true",
12-
"clean:utils": "yarn workspace @experimental-api-clients-automation/client-common clean && yarn workspace @experimental-api-clients-automation/requester-node-http clean && yarn workspace @experimental-api-clients-automation/requester-browser-xhr clean",
12+
"clean:utils": "yarn workspace @algolia/client-common clean && yarn workspace @algolia/requester-node-http clean && yarn workspace @algolia/requester-browser-xhr clean",
1313
"release:bump": "lerna version ${0:-patch} --no-changelog --no-git-tag-version --no-push --exact --force-publish --yes",
1414
"release:publish": "ts-node --project tsconfig.script.json scripts/publish.ts",
1515
"test:lint": "eslint . --ext .js,.ts",

clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import type { EchoResponse } from '@experimental-api-clients-automation/client-common';
2-
import { echoRequester } from '@experimental-api-clients-automation/requester-node-http';
1+
import type { EchoResponse } from '@algolia/client-common';
2+
import { echoRequester } from '@algolia/requester-node-http';
33

44
import { algoliasearch, apiClientVersion } from '../builds/node';
55
import { liteClient } from '../lite/builds/node';

clients/algoliasearch-client-javascript/packages/client-common/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@experimental-api-clients-automation/client-common",
3-
"version": "0.8.0",
2+
"name": "@algolia/client-common",
3+
"version": "5.0.0-alpha.0",
44
"description": "Common package for the Algolia JavaScript API client.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",

clients/algoliasearch-client-javascript/packages/requester-browser-xhr/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@experimental-api-clients-automation/requester-browser-xhr",
3-
"version": "0.8.0",
2+
"name": "@algolia/requester-browser-xhr",
3+
"version": "5.0.0-alpha.0",
44
"description": "Promise-based request library for browser using xhr.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",
@@ -18,7 +18,7 @@
1818
"clean": "rm -rf dist/"
1919
},
2020
"dependencies": {
21-
"@experimental-api-clients-automation/client-common": "0.8.0"
21+
"@algolia/client-common": "5.0.0-alpha.0"
2222
},
2323
"devDependencies": {
2424
"@types/node": "16.11.43",

clients/algoliasearch-client-javascript/packages/requester-browser-xhr/src/createXhrRequester.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
import type {
2-
EndRequest,
3-
Requester,
4-
Response,
5-
} from '@experimental-api-clients-automation/client-common';
1+
import type { EndRequest, Requester, Response } from '@algolia/client-common';
62

73
type Timeout = ReturnType<typeof setTimeout>;
84

clients/algoliasearch-client-javascript/packages/requester-browser-xhr/src/echoRequester.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { createEchoRequester } from '@experimental-api-clients-automation/client-common';
2-
import type { EchoRequester } from '@experimental-api-clients-automation/client-common';
1+
import { createEchoRequester } from '@algolia/client-common';
2+
import type { EchoRequester } from '@algolia/client-common';
33

44
export function echoRequester(status: number = 200): EchoRequester {
55
return createEchoRequester({ getURL: (url: string) => new URL(url), status });

clients/algoliasearch-client-javascript/packages/requester-node-http/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "@experimental-api-clients-automation/requester-node-http",
3-
"version": "0.8.0",
2+
"name": "@algolia/requester-node-http",
3+
"version": "5.0.0-alpha.0",
44
"description": "Promise-based request library for node using the native http module.",
55
"repository": "algolia/algoliasearch-client-javascript",
66
"license": "MIT",
@@ -17,7 +17,7 @@
1717
"clean": "rm -rf dist/"
1818
},
1919
"dependencies": {
20-
"@experimental-api-clients-automation/client-common": "0.8.0"
20+
"@algolia/client-common": "5.0.0-alpha.0"
2121
},
2222
"devDependencies": {
2323
"@types/node": "16.11.43",

clients/algoliasearch-client-javascript/packages/requester-node-http/src/createHttpRequester.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@ import http from 'http';
22
import https from 'https';
33
import { URL } from 'url';
44

5-
import type {
6-
EndRequest,
7-
Requester,
8-
Response,
9-
} from '@experimental-api-clients-automation/client-common';
5+
import type { EndRequest, Requester, Response } from '@algolia/client-common';
106

117
// Global agents allow us to reuse the TCP protocol with multiple clients
128
const agentOptions = { keepAlive: true };

clients/algoliasearch-client-javascript/packages/requester-node-http/src/echoRequester.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { URL } from 'url';
22

3-
import { createEchoRequester } from '@experimental-api-clients-automation/client-common';
4-
import type { EchoRequester } from '@experimental-api-clients-automation/client-common';
3+
import { createEchoRequester } from '@algolia/client-common';
4+
import type { EchoRequester } from '@algolia/client-common';
55

66
export function echoRequester(status: number = 200): EchoRequester {
77
return createEchoRequester({ getURL: (url: string) => new URL(url), status });

clients/algoliasearch-client-javascript/yarn.lock

Lines changed: 51 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,39 @@ __metadata:
55
version: 6
66
cacheKey: 8
77

8+
"@algolia/[email protected], @algolia/client-common@workspace:packages/client-common":
9+
version: 0.0.0-use.local
10+
resolution: "@algolia/client-common@workspace:packages/client-common"
11+
dependencies:
12+
"@types/jest": 28.1.4
13+
"@types/node": 16.11.43
14+
jest: 28.1.2
15+
jest-environment-jsdom: 28.1.2
16+
ts-jest: 28.0.5
17+
typescript: 4.7.4
18+
languageName: unknown
19+
linkType: soft
20+
21+
"@algolia/requester-browser-xhr@workspace:packages/requester-browser-xhr":
22+
version: 0.0.0-use.local
23+
resolution: "@algolia/requester-browser-xhr@workspace:packages/requester-browser-xhr"
24+
dependencies:
25+
"@algolia/client-common": 5.0.0-alpha.0
26+
"@types/node": 16.11.43
27+
typescript: 4.7.4
28+
languageName: unknown
29+
linkType: soft
30+
31+
"@algolia/requester-node-http@workspace:packages/requester-node-http":
32+
version: 0.0.0-use.local
33+
resolution: "@algolia/requester-node-http@workspace:packages/requester-node-http"
34+
dependencies:
35+
"@algolia/client-common": 5.0.0-alpha.0
36+
"@types/node": 16.11.43
37+
typescript: 4.7.4
38+
languageName: unknown
39+
linkType: soft
40+
841
"@ampproject/remapping@npm:^2.1.0":
942
version: 2.2.0
1043
resolution: "@ampproject/remapping@npm:2.2.0"
@@ -1355,18 +1388,12 @@ __metadata:
13551388
languageName: unknown
13561389
linkType: soft
13571390

1358-
"@experimental-api-clients-automation/[email protected], @experimental-api-clients-automation/client-common@workspace:packages/client-common":
1359-
version: 0.0.0-use.local
1360-
resolution: "@experimental-api-clients-automation/client-common@workspace:packages/client-common"
1361-
dependencies:
1362-
"@types/jest": 28.1.4
1363-
"@types/node": 16.11.43
1364-
jest: 28.1.2
1365-
jest-environment-jsdom: 28.1.2
1366-
ts-jest: 28.0.5
1367-
typescript: 4.7.4
1368-
languageName: unknown
1369-
linkType: soft
1391+
"@experimental-api-clients-automation/client-common@npm:0.8.0":
1392+
version: 0.8.0
1393+
resolution: "@experimental-api-clients-automation/client-common@npm:0.8.0"
1394+
checksum: 407fab13629c2345c4771eaf1b404033b8a484ffec893f57f00c5a30ee973e4e288c0e842a122ac9e4c79a49d7b45bedebea55dfc599bedab617c66d52e0d842
1395+
languageName: node
1396+
linkType: hard
13701397

13711398
"@experimental-api-clients-automation/client-insights@workspace:packages/client-insights":
13721399
version: 0.0.0-use.local
@@ -1452,25 +1479,23 @@ __metadata:
14521479
languageName: unknown
14531480
linkType: soft
14541481

1455-
"@experimental-api-clients-automation/[email protected], @experimental-api-clients-automation/requester-browser-xhr@workspace:packages/requester-browser-xhr":
1456-
version: 0.0.0-use.local
1457-
resolution: "@experimental-api-clients-automation/requester-browser-xhr@workspace:packages/requester-browser-xhr"
1482+
"@experimental-api-clients-automation/requester-browser-xhr@npm:0.8.0":
1483+
version: 0.8.0
1484+
resolution: "@experimental-api-clients-automation/requester-browser-xhr@npm:0.8.0"
14581485
dependencies:
14591486
"@experimental-api-clients-automation/client-common": 0.8.0
1460-
"@types/node": 16.11.43
1461-
typescript: 4.7.4
1462-
languageName: unknown
1463-
linkType: soft
1487+
checksum: 8c241fc4d22d3454dca57c59ac9020b76dfffa1c697a247d8057999db67f2e70f7ca55f597ea56c1cb7cf6d5ecb9fa73d8de35bb75f97dc9d927df26fb7a2b06
1488+
languageName: node
1489+
linkType: hard
14641490

1465-
"@experimental-api-clients-automation/[email protected], @experimental-api-clients-automation/requester-node-http@workspace:packages/requester-node-http":
1466-
version: 0.0.0-use.local
1467-
resolution: "@experimental-api-clients-automation/requester-node-http@workspace:packages/requester-node-http"
1491+
"@experimental-api-clients-automation/requester-node-http@npm:0.8.0":
1492+
version: 0.8.0
1493+
resolution: "@experimental-api-clients-automation/requester-node-http@npm:0.8.0"
14681494
dependencies:
14691495
"@experimental-api-clients-automation/client-common": 0.8.0
1470-
"@types/node": 16.11.43
1471-
typescript: 4.7.4
1472-
languageName: unknown
1473-
linkType: soft
1496+
checksum: 1917e850b29aab3765a43f4666d4cb2c176538abf8fa6997349431de43bf05bf0f76fa4c80529db9d8fb121aec0573b26e15ebb561a802f9b435bc70c943c729
1497+
languageName: node
1498+
linkType: hard
14741499

14751500
"@gar/promisify@npm:^1.0.1, @gar/promisify@npm:^1.1.3":
14761501
version: 1.1.3

config/clients.config.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
},
1414
"javascript": {
1515
"folder": "clients/algoliasearch-client-javascript",
16-
"npmNamespace": "@experimental-api-clients-automation",
16+
"npmNamespace": "@algolia",
1717
"gitRepoId": "algoliasearch-client-javascript",
18-
"utilsPackageVersion": "0.8.0",
18+
"utilsPackageVersion": "5.0.0-alpha.0",
1919
"modelFolder": "model",
2020
"apiFolder": "src",
2121
"customGenerator": "algolia-javascript",

config/openapitools.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,63 +6,63 @@
66
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/algoliasearch",
77
"reservedWordsMappings": "queryParameters=queryParameters,requestOptions=requestOptions,delete=delete",
88
"additionalProperties": {
9-
"packageVersion": "0.8.0"
9+
"packageVersion": "5.0.0-alpha.0"
1010
}
1111
},
1212
"javascript-search": {
1313
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-search",
1414
"reservedWordsMappings": "queryParameters=queryParameters,requestOptions=requestOptions,delete=delete",
1515
"additionalProperties": {
16-
"packageVersion": "0.8.0"
16+
"packageVersion": "5.0.0-alpha.0"
1717
}
1818
},
1919
"javascript-recommend": {
2020
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/recommend",
2121
"reservedWordsMappings": "queryParameters=queryParameters,delete=delete",
2222
"additionalProperties": {
23-
"packageVersion": "0.8.0"
23+
"packageVersion": "5.0.0-alpha.0"
2424
}
2525
},
2626
"javascript-personalization": {
2727
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-personalization",
2828
"additionalProperties": {
29-
"packageVersion": "0.8.0"
29+
"packageVersion": "5.0.0-alpha.0"
3030
}
3131
},
3232
"javascript-analytics": {
3333
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-analytics",
3434
"additionalProperties": {
35-
"packageVersion": "0.8.0"
35+
"packageVersion": "5.0.0-alpha.0"
3636
}
3737
},
3838
"javascript-insights": {
3939
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-insights",
4040
"additionalProperties": {
41-
"packageVersion": "0.8.0"
41+
"packageVersion": "5.0.0-alpha.0"
4242
}
4343
},
4444
"javascript-abtesting": {
4545
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-abtesting",
4646
"additionalProperties": {
47-
"packageVersion": "0.8.0"
47+
"packageVersion": "5.0.0-alpha.0"
4848
}
4949
},
5050
"javascript-query-suggestions": {
5151
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-query-suggestions",
5252
"additionalProperties": {
53-
"packageVersion": "0.8.0"
53+
"packageVersion": "5.0.0-alpha.0"
5454
}
5555
},
5656
"javascript-sources": {
5757
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-sources",
5858
"additionalProperties": {
59-
"packageVersion": "0.8.0"
59+
"packageVersion": "1.0.0-alpha.0"
6060
}
6161
},
6262
"javascript-predict": {
6363
"output": "#{cwd}/clients/algoliasearch-client-javascript/packages/client-predict",
6464
"additionalProperties": {
65-
"packageVersion": "0.8.0"
65+
"packageVersion": "1.0.0-alpha.0"
6666
}
6767
},
6868
"java-search": {

generators/src/main/java/com/algolia/codegen/cts/manager/JavaScriptCTSManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
2929
String npmNamespace = Utils.getClientConfigField("javascript", "npmNamespace");
3030

3131
if (clientName.equals("algoliasearch")) {
32-
bundle.put("import", npmNamespace + "/" + "algoliasearch/lite");
32+
bundle.put("import", "algoliasearch/lite");
3333
} else {
3434
bundle.put("import", npmNamespace + "/" + clientName);
3535
}

playground/javascript/browser/app.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { searchClient } from '@experimental-api-clients-automation/client-search';
2-
import { liteClient } from '@experimental-api-clients-automation/algoliasearch/lite';
1+
import { searchClient } from '@algolia/client-search';
2+
import { liteClient } from 'algoliasearch/lite';
33

44
import './app.css';
55

playground/javascript/browser/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
"start": "parcel index.html"
77
},
88
"dependencies": {
9-
"@experimental-api-clients-automation/algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch",
10-
"@experimental-api-clients-automation/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",
11-
"@experimental-api-clients-automation/client-search": "link:../../../clients/algoliasearch-client-javascript/packages/client-search",
12-
"@experimental-api-clients-automation/requester-browser-xhr": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http"
9+
"@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",
10+
"@algolia/client-search": "link:../../../clients/algoliasearch-client-javascript/packages/client-search",
11+
"@algolia/requester-browser-xhr": "link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http",
12+
"algoliasearch": "link:../../../clients/algoliasearch-client-javascript/packages/algoliasearch"
1313
},
1414
"devDependencies": {
1515
"parcel": "2.6.2",

playground/javascript/node/abtesting.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { abtestingClient } from '@experimental-api-clients-automation/client-abtesting';
2-
import { ApiError } from '@experimental-api-clients-automation/client-common';
1+
import { abtestingClient } from '@algolia/client-abtesting';
2+
import { ApiError } from '@algolia/client-common';
33
import dotenv from 'dotenv';
44

55
dotenv.config({ path: '../../.env' });

playground/javascript/node/algoliasearch.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { algoliasearch } from '@experimental-api-clients-automation/algoliasearch';
2-
import { liteClient } from '@experimental-api-clients-automation/algoliasearch/lite';
3-
import { ApiError } from '@experimental-api-clients-automation/client-common';
1+
import { algoliasearch } from 'algoliasearch';
2+
import { liteClient } from 'algoliasearch/lite';
3+
import { ApiError } from '@algolia/client-common';
44
import dotenv from 'dotenv';
55

6-
import type { SearchResponses } from '@experimental-api-clients-automation/algoliasearch';
6+
import type { SearchResponses } from 'algoliasearch';
77

88
dotenv.config({ path: '../../.env' });
99

playground/javascript/node/analytics.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { analyticsClient } from '@experimental-api-clients-automation/client-analytics';
2-
import { ApiError } from '@experimental-api-clients-automation/client-common';
1+
import { analyticsClient } from '@algolia/client-analytics';
2+
import { ApiError } from '@algolia/client-common';
33
import dotenv from 'dotenv';
44

55
dotenv.config({ path: '../../.env' });

playground/javascript/node/insights.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { insightsClient } from '@experimental-api-clients-automation/client-insights';
2-
import { ApiError } from '@experimental-api-clients-automation/client-common';
1+
import { insightsClient } from '@algolia/client-insights';
2+
import { ApiError } from '@algolia/client-common';
33
import dotenv from 'dotenv';
44

55
dotenv.config({ path: '../../.env' });

0 commit comments

Comments
 (0)