Skip to content

feat(javascript): use beta npm org #226

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.

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 7 commits into from
Mar 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"node": "16",
"packages": ["clients/algoliasearch-client-javascript/packages/*/"],
"sandboxes": [
"algolia-algoliasearch-for-javascript-jc82hd",
"algolia-client-search-for-javascript-10pix9",
"algolia-client-predict-for-javascript-4e31t3",
"algolia-client-sources-for-javascript-7qdk7n",
"algolia-recommend-for-javascript-j04foe",
"algolia-client-abtesting-for-javascript-8wthkc",
"algolia-client-query-suggestions-for-javascrip-h8rwl4",
"algolia-client-insights-for-javascript-ij075w",
"algolia-client-personalization-for-javascrip-fkeyc0",
"algolia-client-analytics-for-javascript-0rknde"
]
}
2 changes: 1 addition & 1 deletion clients/algoliasearch-client-javascript
Submodule algoliasearch-client-javascript updated 49 files
+1 −1 package.json
+7 −7 packages/algoliasearch/builds/browser.ts
+7 −7 packages/algoliasearch/builds/node.ts
+8 −8 packages/algoliasearch/package.json
+5 −2 packages/client-abtesting/builds/browser.ts
+5 −2 packages/client-abtesting/builds/node.ts
+12 −6 packages/client-abtesting/package.json
+3 −3 packages/client-abtesting/src/abtestingApi.ts
+5 −2 packages/client-analytics/builds/browser.ts
+5 −2 packages/client-analytics/builds/node.ts
+12 −6 packages/client-analytics/package.json
+3 −3 packages/client-analytics/src/analyticsApi.ts
+2 −2 packages/client-common/package.json
+5 −2 packages/client-insights/builds/browser.ts
+5 −2 packages/client-insights/builds/node.ts
+12 −6 packages/client-insights/package.json
+3 −3 packages/client-insights/src/insightsApi.ts
+5 −2 packages/client-personalization/builds/browser.ts
+5 −2 packages/client-personalization/builds/node.ts
+12 −6 packages/client-personalization/package.json
+3 −3 packages/client-personalization/src/personalizationApi.ts
+5 −2 packages/client-predict/builds/browser.ts
+5 −2 packages/client-predict/builds/node.ts
+12 −6 packages/client-predict/package.json
+3 −3 packages/client-predict/src/predictApi.ts
+5 −2 packages/client-query-suggestions/builds/browser.ts
+5 −2 packages/client-query-suggestions/builds/node.ts
+12 −6 packages/client-query-suggestions/package.json
+3 −3 packages/client-query-suggestions/src/querySuggestionsApi.ts
+5 −2 packages/client-search/builds/browser.ts
+5 −2 packages/client-search/builds/node.ts
+12 −6 packages/client-search/package.json
+3 −3 packages/client-search/src/searchApi.ts
+5 −2 packages/client-sources/builds/browser.ts
+5 −2 packages/client-sources/builds/node.ts
+12 −6 packages/client-sources/package.json
+3 −3 packages/client-sources/src/sourcesApi.ts
+5 −2 packages/recommend/builds/browser.ts
+5 −2 packages/recommend/builds/node.ts
+12 −6 packages/recommend/package.json
+3 −3 packages/recommend/src/recommendApi.ts
+8 −3 packages/requester-browser-xhr/package.json
+5 −1 packages/requester-browser-xhr/src/createXhrRequester.ts
+2 −2 packages/requester-browser-xhr/src/echoRequester.ts
+8 −3 packages/requester-node-http/package.json
+5 −1 packages/requester-node-http/src/createHttpRequester.ts
+2 −2 packages/requester-node-http/src/echoRequester.ts
+19 −14 rollup.config.js
+1 −1 version.js
56 changes: 28 additions & 28 deletions openapitools.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-search",
"npmName": "@experimental-api-clients-automation/client-search",
"buildFile": "client-search",
"apiName": "search",
"capitalizedApiName": "Search",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-search"
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-search"
}
},
"javascript-recommend": {
Expand All @@ -39,12 +39,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/recommend",
"npmName": "@experimental-api-clients-automation/recommend",
"buildFile": "recommend",
"apiName": "recommend",
"capitalizedApiName": "Recommend",
"packageVersion": "5.0.0",
"packageName": "@algolia/recommend"
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/recommend"
}
},
"javascript-personalization": {
Expand All @@ -60,12 +60,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-personalization",
"npmName": "@experimental-api-clients-automation/client-personalization",
"buildFile": "client-personalization",
"apiName": "personalization",
"capitalizedApiName": "Personalization",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-personalization",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-personalization",
"hasRegionalHost": true,
"isEuHost": true,
"host": "personalization",
Expand All @@ -85,12 +85,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-analytics",
"npmName": "@experimental-api-clients-automation/client-analytics",
"buildFile": "client-analytics",
"apiName": "analytics",
"capitalizedApiName": "Analytics",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-analytics",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-analytics",
"fallbackToAliasHost": true,
"hasRegionalHost": true,
"isDeHost": true,
Expand All @@ -111,12 +111,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-insights",
"npmName": "@experimental-api-clients-automation/client-insights",
"buildFile": "client-insights",
"apiName": "insights",
"capitalizedApiName": "Insights",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-insights",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-insights",
"fallbackToAliasHost": true,
"hasRegionalHost": true,
"isDeHost": true,
Expand All @@ -137,12 +137,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-abtesting",
"npmName": "@experimental-api-clients-automation/client-abtesting",
"buildFile": "client-abtesting",
"apiName": "abtesting",
"capitalizedApiName": "Abtesting",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-abtesting",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-abtesting",
"hasRegionalHost": true,
"fallbackToAliasHost": true,
"isDeHost": true,
Expand All @@ -163,12 +163,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-query-suggestions",
"npmName": "@experimental-api-clients-automation/client-query-suggestions",
"buildFile": "client-query-suggestions",
"apiName": "querySuggestions",
"capitalizedApiName": "QuerySuggestions",
"packageVersion": "5.0.0",
"packageName": "@algolia/client-query-suggestions",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-query-suggestions",
"hasRegionalHost": true,
"isEuHost": true,
"host": "query-suggestions",
Expand All @@ -188,12 +188,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-sources",
"npmName": "@experimental-api-clients-automation/client-sources",
"buildFile": "client-sources",
"apiName": "sources",
"capitalizedApiName": "Sources",
"packageVersion": "0.0.1",
"packageName": "@algolia/client-sources",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-sources",
"hasRegionalHost": true,
"isDeHost": true,
"host": "data",
Expand All @@ -213,12 +213,12 @@
"additionalProperties": {
"modelPropertyNaming": "original",
"supportsES6": true,
"npmName": "@algolia/client-predict",
"npmName": "@experimental-api-clients-automation/client-predict",
"buildFile": "client-predict",
"apiName": "predict",
"capitalizedApiName": "Predict",
"packageVersion": "0.0.1",
"packageName": "@algolia/client-predict",
"packageVersion": "0.0.4",
"packageName": "@experimental-api-clients-automation/client-predict",
"experimentalHost": "predict-api-oslcbws3zq-ew.a.run.app"
}
},
Expand Down Expand Up @@ -403,4 +403,4 @@
}
}
}
}
}
2 changes: 1 addition & 1 deletion playground/javascript/browser/app.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { searchApi } from '@algolia/client-search';
import { searchApi } from '@experimental-api-clients-automation/client-search';

import './app.css';

Expand Down
6 changes: 3 additions & 3 deletions playground/javascript/browser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
"start": "parcel index.html"
},
"dependencies": {
"@algolia/client-common": "5.0.0",
"@algolia/client-search": "5.0.0",
"@algolia/requester-browser-xhr": "5.0.0"
"@experimental-api-clients-automation/client-common": "0.0.4",
"@experimental-api-clients-automation/client-search": "0.0.4",
"@experimental-api-clients-automation/requester-browser-xhr": "0.0.4"
},
"devDependencies": {
"parcel": "2.3.1",
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/abtesting.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { abtestingApi } from '@algolia/client-abtesting';
import { ApiError } from '@algolia/client-common';
import { abtestingApi } from '@experimental-api-clients-automation/client-abtesting';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/algoliasearch.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { algoliasearch } from 'algoliasearch';
import { ApiError } from '@algolia/client-common';
import { algoliasearch } from '@experimental-api-clients-automation/algoliasearch';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/analytics.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { analyticsApi } from '@algolia/client-analytics';
import { ApiError } from '@algolia/client-common';
import { analyticsApi } from '@experimental-api-clients-automation/client-analytics';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
30 changes: 30 additions & 0 deletions playground/javascript/node/insights.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import { insightsApi } from '@experimental-api-clients-automation/client-insights';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

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

const appId = process.env.ALGOLIA_APPLICATION_ID || '**** APP_ID *****';
const apiKey =
process.env.ALGOLIA_INSIGHTS_API_KEY || '**** INSIGHTS_API_KEY *****';

// Init client with appId and apiKey
const client = insightsApi(appId, apiKey);

async function testInsights() {
try {
const res = await client.pushEvents({
events: [],
});

console.log(`[OK]`, res);
} catch (e) {
if (e instanceof ApiError) {
return console.log(`[${e.status}] ${e.message}`, e.stackTrace);
}

console.log('[ERROR]', e);
}
}

testInsights();
25 changes: 14 additions & 11 deletions playground/javascript/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"start:algoliasearch": "yarn build && yarn test:algoliasearch",
"start:abtesting": "yarn build && yarn test:abtesting",
"start:analytics": "yarn build && yarn test:analytics",
"start:insights": "yarn build && yarn test:insights",
"start:personalization": "yarn build && yarn test:personalization",
"start:query-suggestions": "yarn build && yarn test:query-suggestions",
"start:recommend": "yarn build && yarn test:recommend",
Expand All @@ -16,6 +17,7 @@
"test:algoliasearch": "node dist/algoliasearch.js",
"test:abtesting": "node dist/analytics.js",
"test:analytics": "node dist/analytics.js",
"test:insights": "node dist/insights.js",
"test:personalization": "node dist/personalization.js",
"test:query-suggestions": "node dist/query-suggestions.js",
"test:recommend": "node dist/recommend.js",
Expand All @@ -24,17 +26,18 @@
"test:predict": "node dist/predict.js"
},
"dependencies": {
"@algolia/client-abtesting": "5.0.0",
"@algolia/client-analytics": "5.0.0",
"@algolia/client-common": "5.0.0",
"@algolia/client-personalization": "5.0.0",
"@algolia/client-predict": "0.0.1",
"@algolia/client-query-suggestions": "5.0.0",
"@algolia/client-search": "5.0.0",
"@algolia/client-sources": "0.0.1",
"@algolia/recommend": "5.0.0",
"@algolia/requester-node-http": "5.0.0",
"algoliasearch": "5.0.0"
"@experimental-api-clients-automation/algoliasearch": "0.0.4",
"@experimental-api-clients-automation/client-abtesting": "0.0.4",
"@experimental-api-clients-automation/client-analytics": "0.0.4",
"@experimental-api-clients-automation/client-common": "0.0.4",
"@experimental-api-clients-automation/client-insights": "0.0.4",
"@experimental-api-clients-automation/client-personalization": "0.0.4",
"@experimental-api-clients-automation/client-predict": "0.0.4",
"@experimental-api-clients-automation/client-query-suggestions": "0.0.4",
"@experimental-api-clients-automation/client-search": "0.0.4",
"@experimental-api-clients-automation/client-sources": "0.0.4",
"@experimental-api-clients-automation/recommend": "0.0.4",
"@experimental-api-clients-automation/requester-node-http": "0.0.4"
},
"devDependencies": {
"dotenv": "10.0.0",
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/personalization.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { personalizationApi } from '@algolia/client-personalization';
import { ApiError } from '@algolia/client-common';
import { personalizationApi } from '@experimental-api-clients-automation/client-personalization';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/predict.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { predictApi } from '@algolia/client-predict';
import { ApiError } from '@algolia/client-common';
import { predictApi } from '@experimental-api-clients-automation/client-predict';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
8 changes: 4 additions & 4 deletions playground/javascript/node/query-suggestions.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { querySuggestionsApi } from '@algolia/client-query-suggestions';
import { ApiError } from '@algolia/client-common';
import { querySuggestionsApi } from '@experimental-api-clients-automation/client-query-suggestions';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand All @@ -12,7 +12,7 @@ const apiKey =
// Init client with appId and apiKey
const client = querySuggestionsApi(appId, apiKey, 'us');

async function testABTesting() {
async function testQuerySuggestions() {
try {
const res = await client.getAllConfigs();

Expand All @@ -26,4 +26,4 @@ async function testABTesting() {
}
}

testABTesting();
testQuerySuggestions();
4 changes: 2 additions & 2 deletions playground/javascript/node/recommend.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { recommendApi } from '@algolia/recommend';
import { ApiError } from '@algolia/client-common';
import { recommendApi } from '@experimental-api-clients-automation/recommend';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/search.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { searchApi } from '@algolia/client-search';
import { ApiError } from '@algolia/client-common';
import { searchApi } from '@experimental-api-clients-automation/client-search';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
4 changes: 2 additions & 2 deletions playground/javascript/node/sources.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { sourcesApi } from '@algolia/client-sources';
import { ApiError } from '@algolia/client-common';
import { sourcesApi } from '@experimental-api-clients-automation/client-sources';
import { ApiError } from '@experimental-api-clients-automation/client-common';
import dotenv from 'dotenv';

dotenv.config({ path: '../../.env' });
Expand Down
5 changes: 4 additions & 1 deletion scripts/buildClients.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ export async function buildJSClientUtils(
verbose
).start();

await run(`yarn workspace @algolia/${client} clean`, { verbose });
await run(
`yarn workspace @experimental-api-clients-automation/${client} clean`,
{ verbose }
);
await run(`yarn workspace algoliasearch-client-javascript build ${client}`, {
verbose,
});
Expand Down
4 changes: 2 additions & 2 deletions scripts/common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ export const GENERATORS: Record<string, Generator> = {
client: 'algoliasearch',
key: 'javascript-algoliasearch',
additionalProperties: {
packageName: 'algoliasearch',
packageVersion: '0',
packageName: '@experimental-api-clients-automation/algoliasearch',
packageVersion: '0.0.4',
},
},
};
Expand Down
4 changes: 2 additions & 2 deletions templates/javascript/api-all.mustache
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{! This file will be renamed and moved to `builds/browser.ts` after generating the client }}

import type { Host, Requester } from '@algolia/client-common';
import { createXhrRequester } from '@algolia/requester-browser-xhr';
import type { Host, Requester } from '@experimental-api-clients-automation/client-common';
import { createXhrRequester } from '@experimental-api-clients-automation/requester-browser-xhr';

import { create{{capitalizedApiName}}Api } from '../src/{{apiName}}Api';
import type { {{capitalizedApiName}}Api } from '../src/{{apiName}}Api';
Expand Down
Loading