Skip to content
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

Jump to bottom

feat: bias and origin #42

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: bias and origin #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/long-dryers-itch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-loqate": minor
---

Implement Bias and Origin parameters for use with capture v4 key
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,19 @@ import 'react-loqate/dist/index.css';

### Props

| name | type | required | example | description |
| ---------- | ----------------------------------------------------- | -------- | ------------------------------------------------------------------- | ---------------------------------------- |
| apiKey | string | yes | "AA11-AA11-AA11-AA11" | Loqate API key |
| locale | string | yes | "en-GB" | Language to be used |
| onSelect | (address) => void | yes | address => console.log(address) | Callback with for Loqate response |
| countries | string[] | no | ["GB", "NL"] | Countries to search in |
| limit | number | no | 10 | Number of options to show |
| classes | `{ input?: string, list?: string, listItem?: string}` | no | { list: 'list' } | Classnames for the components |
| components | see [Customization](#Customization) | no | { Input: CustomInput, List: CustomList, ListItem: CustomListItem, } | Components to overwrite the default ones |
| inline | boolean | no | true | Render results inline with the input |
| debounce | number | no | 100 | Debounce the calls to the Loqate API |
| name | type | required | example | description |
| ---------- | ----------------------------------------------------- | -------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| apiKey | string | yes | "AA11-AA11-AA11-AA11" | Loqate API key |
| locale | string | yes | "en-GB" | Language to be used |
| onSelect | (address) => void | yes | address => console.log(address) | Callback with for Loqate response |
| countries | string[] | no | ["GB", "NL"] | Countries to search in |
| limit | number | no | 10 | Number of options to show |
| classes | `{ input?: string, list?: string, listItem?: string}` | no | { list: 'list' } | Classnames for the components |
| components | see [Customization](#Customization) | no | { Input: CustomInput, List: CustomList, ListItem: CustomListItem, } | Components to overwrite the default ones |
| inline | boolean | no | true | Render results inline with the input |
| debounce | number | no | 100 | Debounce the calls to the Loqate API |
| bias | boolean | no | true | Bias feature when using capture v4 enabled key.<br>Requires origin to be set. |
| origin | string | no | "93.184.216.34" | Name or ISO 2 or 3 character code of a country, WGS84 coordinates (comma separated) or IP address |

### Customization

Expand Down
21 changes: 21 additions & 0 deletions src/__tests__/serverHandlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,24 @@ export const errorHandler = http.get(
});
}
);

export const biasHandler = http.get(
`${LOQATE_BASE_URL}/${LOQATE_FIND_URL}`,
({ request }) => {
const url = new URL(request.url);
const bias = url.searchParams.get('Bias');
const origin = url.searchParams.get('Origin');
if (bias === 'true' && origin !== '') {
return HttpResponse.json({
Items: {
Id: 'GB|RM|ENG|TAMWORTH-PICCADILLY',
Type: 'Locality',
Text: 'Piccadilly, Tamworth, B78',
Highlight: '0-10',
Description: '174 Addresses',
},
});
}
throw new Error(`no bias`);
}
);
31 changes: 31 additions & 0 deletions src/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { selection } from './__tests__/__fixtures__/selection';
import { server } from './__tests__/server';
import { errorHandler } from './__tests__/serverHandlers';
import AddressSearch from './index';
import Loqate from './utils/Loqate';

global.fetch = fetch;

Expand Down Expand Up @@ -346,3 +347,33 @@ it('lets its errors be caught by an ErrorBoundary', async () => {

expect(baseElement).toMatchSnapshot();
});

it('accepts origin and bias options', async () => {
const findSpy = vi.spyOn(Loqate.prototype, 'find');

render(
<AddressSearch
locale="en-GB"
apiKey="some-key"
onSelect={vi.fn()}
limit={5}
inline
bias={true}
origin="GB"
/>
);

const input = screen.getByRole('textbox');
input.focus();
fireEvent.change(input, { target: { value: 'a' } });

expect(findSpy).toHaveBeenCalledWith({
bias: true,
containerId: undefined,
countries: undefined,
language: 'en',
limit: 5,
origin: 'GB',
text: 'a',
});
});
6 changes: 6 additions & 0 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ export interface Props {
inline?: boolean;
debounce?: number;
apiUrl?: string;
bias?: boolean;
origin?: string;
}

interface Components {
Expand Down Expand Up @@ -129,6 +131,8 @@ function AddressSearch(props: Props): JSX.Element {
inline,
debounce,
apiUrl,
bias,
origin,
} = props;
const loqate = useMemo(() => Loqate.create(apiKey, apiUrl), [apiKey]);

Expand All @@ -148,6 +152,8 @@ function AddressSearch(props: Props): JSX.Element {
text,
containerId,
language: loqateLanguage(locale),
origin,
bias,
});

if (res.Items) {
Expand Down
15 changes: 14 additions & 1 deletion src/utils/Loqate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ interface FindQuery {
countries?: string[];
limit?: number;
containerId?: string;
origin?: string;
bias?: boolean;
}

type LoqateResponse = { Items?: Item[] | LoqateErrorItem[] };
Expand Down Expand Up @@ -43,14 +45,25 @@ class Loqate {
}

public async find(query: FindQuery): Promise<LoqateNoErrorResponse> {
const { text, countries = [], containerId, language, limit } = query;
const {
text,
countries = [],
containerId,
language,
limit,
origin,
bias,
} = query;

const params = new URLSearchParams({
Text: text,
Countries: countries.join(','),
language,
Key: this.key,
Origin: origin ? origin : '',
Bias: bias ? 'true' : 'false',
});

if (containerId) {
params.set('Container', containerId);
}
Expand Down
27 changes: 26 additions & 1 deletion src/utils/__tests__/Loqate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { describe, expect, it } from 'vitest';
import { selection } from '../../__tests__/__fixtures__/selection';
import { suggestions } from '../../__tests__/__fixtures__/suggestions';
import { server } from '../../__tests__/server';
import { errorHandler } from '../../__tests__/serverHandlers';
import { biasHandler, errorHandler } from '../../__tests__/serverHandlers';
import Loqate from '../Loqate';

global.fetch = fetch;
Expand Down Expand Up @@ -41,6 +41,31 @@ describe('Loqate', () => {
expect({ Items }).toEqual(suggestions);
});

it('accepts bias and origin', async () => {
server.use(biasHandler);

const loqate = Loqate.create('some-key');
const { Items } = await loqate.find({
text: 'some-text',
language: 'some-language',
countries: ['GB', 'US'],
limit: 10,
containerId: 'some-container-id',
bias: true,
origin: '93.184.216.34',
});

expect({ Items }).toEqual({
Items: {
Id: 'GB|RM|ENG|TAMWORTH-PICCADILLY',
Type: 'Locality',
Text: 'Piccadilly, Tamworth, B78',
Highlight: '0-10',
Description: '174 Addresses',
},
});
});

it('should throw errors', async () => {
server.use(errorHandler);

Expand Down
Loading