@aws-amplify/geo 1.3.25-unstable.2 → 1.3.25

package/lib/Geo.d.ts

@@ -1,110 +0,0 @@
-import { Place, GeoConfig, Coordinates, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, MapStyle, GeofenceId, GeofenceInput, GeofenceOptions, SaveGeofencesResults, Geofence, ListGeofenceOptions, ListGeofenceResults, DeleteGeofencesResults, searchByPlaceIdOptions } from './types';
-export declare class GeoClass {
-    static MODULE: string;
-    /**
-     * @private
-     */
-    private _config;
-    private _pluggables;
-    constructor();
-    /**
-     * get the name of the module category
-     * @returns {string} name of the module category
-     */
-    getModuleName(): string;
-    /**
-     * add plugin into Geo category
-     * @param {Object} pluggable - an instance of the plugin
-     */
-    addPluggable(pluggable: GeoProvider): object;
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the plugin
-     */
-    getPluggable(providerName: string): GeoProvider;
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the plugin
-     */
-    removePluggable(providerName: string): void;
-    /**
-     * Configure Geo
-     * @param {Object} config - Configuration object for Geo
-     * @return {Object} - Current configuration
-     */
-    configure(config?: any): GeoConfig;
-    /**
-     * Get the map resources that are currently available through the provider
-     * @param {string} provider
-     * @returns - Array of available map resources
-     */
-    getAvailableMaps(provider?: string): MapStyle[];
-    /**
-     * Get the map resource set as default in amplify config
-     * @param {string} provider
-     * @returns - Map resource set as the default in amplify config
-     */
-    getDefaultMap(provider?: string): MapStyle;
-    /**
-     * Search by text input with optional parameters
-     * @param  {string} text - The text string that is to be searched for
-     * @param  {SearchByTextOptions} options? - Optional parameters to the search
-     * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
-     */
-    searchByText(text: string, options?: SearchByTextOptions): Promise<Place[]>;
-    /**
-     * Search for search term suggestions based on input text
-     * @param  {string} text - The text string that is to be search for
-     * @param  {SearchByTextOptions} options? - Optional parameters to the search
-     * @returns {Promise<SearchForSuggestionsResults>} - Resolves to an array of search suggestion strings
-     */
-    searchForSuggestions(text: string, options?: SearchByTextOptions): Promise<import("./types").SearchForSuggestionsResults>;
-    /**
-     * Search for location by unique ID
-     * @param  {string} placeId - Unique ID of the location that is to be searched for
-     * @param  {searchByPlaceIdOptions} options? - Optional parameters to the search
-     * @returns {Promise<Place>} - Resolves to a place with the given placeId
-     */
-    searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions): Promise<Place>;
-    /**
-     * Reverse geocoding search via a coordinate point on the map
-     * @param coordinates - Coordinates array for the search input
-     * @param options - Options parameters for the search
-     * @returns {Promise<Place>} - Promise that resolves to a place matching search coordinates
-     */
-    searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<Place>;
-    /**
-     * Create geofences
-     * @param geofences - Single or array of geofence objects to create
-     * @param options? - Optional parameters for creating geofences
-     * @returns {Promise<SaveGeofencesResults>} - Promise that resolves to an object with:
-     *   successes: list of geofences successfully created
-     *   errors: list of geofences that failed to create
-     */
-    saveGeofences(geofences: GeofenceInput | GeofenceInput[], options?: GeofenceOptions): Promise<SaveGeofencesResults>;
-    /**
-     * Get a single geofence by geofenceId
-     * @param geofenceId: GeofenceId - The string id of the geofence to get
-     * @param options?: GeofenceOptions - Optional parameters for getting a geofence
-     * @returns Promise<Geofence> - Promise that resolves to a geofence object
-     */
-    getGeofence(geofenceId: GeofenceId, options?: GeofenceOptions): Promise<Geofence>;
-    /**
-     * List geofences
-     * @param  options?: ListGeofenceOptions
-     * @returns {Promise<ListGeofencesResults>} - Promise that resolves to an object with:
-     *   entries: list of geofences - 100 geofences are listed per page
-     *   nextToken: token for next page of geofences
-     */
-    listGeofences(options?: ListGeofenceOptions): Promise<ListGeofenceResults>;
-    /**
-     * Delete geofences
-     * @param geofenceIds: string|string[]
-     * @param options?: GeofenceOptions
-     * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
-     *  successes: list of geofences successfully deleted
-     *  errors: list of geofences that failed to delete
-     */
-    deleteGeofences(geofenceIds: string | string[], options?: GeofenceOptions): Promise<DeleteGeofencesResults>;
-}
-export declare const Geo: GeoClass;

package/lib/Providers/AmazonLocationServiceProvider.d.ts

@@ -1,105 +0,0 @@
-import { GeoConfig, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, Place, AmazonLocationServiceMapStyle, Coordinates, SearchForSuggestionsResults, GeofenceId, GeofenceInput, AmazonLocationServiceGeofenceOptions, AmazonLocationServiceListGeofenceOptions, ListGeofenceResults, SaveGeofencesResults, AmazonLocationServiceGeofence, AmazonLocationServiceDeleteGeofencesResults, searchByPlaceIdOptions } from '../types';
-export declare class AmazonLocationServiceProvider implements GeoProvider {
-    static CATEGORY: string;
-    static PROVIDER_NAME: string;
-    /**
-     * @private
-     */
-    private _config;
-    /**
-     * Initialize Geo with AWS configurations
-     * @param {Object} config - Configuration object for Geo
-     */
-    constructor(config?: GeoConfig);
-    /**
-     * get the category of the plugin
-     * @returns {string} name of the category
-     */
-    getCategory(): string;
-    /**
-     * get provider name of the plugin
-     * @returns {string} name of the provider
-     */
-    getProviderName(): string;
-    /**
-     * Configure Geo part with aws configuration
-     * @param {Object} config - Configuration of the Geo
-     * @return {Object} - Current configuration
-     */
-    configure(config?: any): object;
-    /**
-     * Get the map resources that are currently available through the provider
-     * @returns {AmazonLocationServiceMapStyle[]}- Array of available map resources
-     */
-    getAvailableMaps(): AmazonLocationServiceMapStyle[];
-    /**
-     * Get the map resource set as default in amplify config
-     * @returns {AmazonLocationServiceMapStyle} - Map resource set as the default in amplify config
-     */
-    getDefaultMap(): AmazonLocationServiceMapStyle;
-    /**
-     * Search by text input with optional parameters
-     * @param  {string} text - The text string that is to be searched for
-     * @param  {SearchByTextOptions} options? - Optional parameters to the search
-     * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
-     */
-    searchByText(text: string, options?: SearchByTextOptions): Promise<Place[]>;
-    /**
-     * Search for suggestions based on the input text
-     * @param  {string} text - The text string that is to be searched for
-     * @param  {SearchByTextOptions} options? - Optional parameters to the search
-     * @returns {Promise<SearchForSuggestionsResults>} - Resolves to an array of search suggestion strings
-     */
-    searchForSuggestions(text: string, options?: SearchByTextOptions): Promise<SearchForSuggestionsResults>;
-    private _verifyPlaceId;
-    searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions): Promise<Place | undefined>;
-    /**
-     * Reverse geocoding search via a coordinate point on the map
-     * @param coordinates - Coordinates array for the search input
-     * @param options - Options parameters for the search
-     * @returns {Promise<Place>} - Promise that resolves to a place matching search coordinates
-     */
-    searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<Place>;
-    /**
-     * Create geofences inside of a geofence collection
-     * @param geofences - Array of geofence objects to create
-     * @param options? - Optional parameters for creating geofences
-     * @returns {Promise<AmazonLocationServiceSaveGeofencesResults>} - Promise that resolves to an object with:
-     *   successes: list of geofences successfully created
-     *   errors: list of geofences that failed to create
-     */
-    saveGeofences(geofences: GeofenceInput[], options?: AmazonLocationServiceGeofenceOptions): Promise<SaveGeofencesResults>;
-    /**
-     * Get geofence from a geofence collection
-     * @param geofenceId:string
-     * @param options?: Optional parameters for getGeofence
-     * @returns {Promise<AmazonLocationServiceGeofence>} - Promise that resolves to a geofence object
-     */
-    getGeofence(geofenceId: GeofenceId, options?: AmazonLocationServiceGeofenceOptions): Promise<AmazonLocationServiceGeofence>;
-    /**
-     * List geofences from a geofence collection
-     * @param  options?: ListGeofenceOptions
-     * @returns {Promise<ListGeofencesResults>} - Promise that resolves to an object with:
-     *   entries: list of geofences - 100 geofences are listed per page
-     *   nextToken: token for next page of geofences
-     */
-    listGeofences(options?: AmazonLocationServiceListGeofenceOptions): Promise<ListGeofenceResults>;
-    /**
-     * Delete geofences from a geofence collection
-     * @param geofenceIds: string|string[]
-     * @param options?: GeofenceOptions
-     * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
-     *  successes: list of geofences successfully deleted
-     *  errors: list of geofences that failed to delete
-     */
-    deleteGeofences(geofenceIds: string[], options?: AmazonLocationServiceGeofenceOptions): Promise<AmazonLocationServiceDeleteGeofencesResults>;
-    /**
-     * @private
-     */
-    private _ensureCredentials;
-    private _verifyMapResources;
-    private _verifySearchIndex;
-    private _verifyGeofenceCollections;
-    private _AmazonLocationServiceBatchPutGeofenceCall;
-    private _AmazonLocationServiceBatchDeleteGeofenceCall;
-}

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export { Geo } from './Geo';
-export * from './types';

package/lib/types/AmazonLocationServiceProvider.d.ts

@@ -1,24 +0,0 @@
-import { MapStyle, GeofenceOptions, ListGeofenceOptions, Geofence, DeleteGeofencesResults, GeofenceError } from './Geo';
-export interface AmazonLocationServiceMapStyle extends MapStyle {
-    region: string;
-}
-export declare type AmazonLocationServiceGeofenceOptions = GeofenceOptions & {
-    collectionName?: string;
-};
-export declare type AmazonLocationServiceGeofenceStatus = 'ACTIVE' | 'PENDING' | 'FAILED' | 'DELETED' | 'DELETING';
-export declare type AmazonLocationServiceGeofence = Omit<Geofence, 'status'> & {
-    status: AmazonLocationServiceGeofenceStatus;
-};
-export declare type AmazonLocationServiceListGeofenceOptions = ListGeofenceOptions & {
-    collectionName?: string;
-};
-export declare type AmazonLocationServiceBatchGeofenceErrorMessages = 'AccessDeniedException' | 'InternalServerException' | 'ResourceNotFoundException' | 'ThrottlingException' | 'ValidationException';
-export declare type AmazonLocationServiceBatchGeofenceError = Omit<GeofenceError, 'error'> & {
-    error: {
-        code: string;
-        message: AmazonLocationServiceBatchGeofenceErrorMessages;
-    };
-};
-export declare type AmazonLocationServiceDeleteGeofencesResults = Omit<DeleteGeofencesResults, 'errors'> & {
-    errors: AmazonLocationServiceBatchGeofenceError[];
-};

package/lib/types/Geo.d.ts

@@ -1,114 +0,0 @@
-export interface GeoConfig {
-    region?: string;
-    AmazonLocationService?: {
-        maps?: {
-            items: {};
-            default: string;
-        };
-        search_indices?: {
-            items: string[];
-            default: string;
-        };
-        geofenceCollections?: {
-            items: string[];
-            default: string;
-        };
-    };
-}
-export interface MapStyle {
-    mapName: string;
-    style: string;
-}
-export declare type Longitude = number;
-export declare type Latitude = number;
-export declare type Coordinates = [Longitude, Latitude];
-export declare type SWLongitude = Longitude;
-export declare type SWLatitude = Latitude;
-export declare type NELongitude = Longitude;
-export declare type NELatitude = Latitude;
-export declare type BoundingBox = [SWLongitude, SWLatitude, NELongitude, NELatitude];
-export interface SearchByTextOptionsBase {
-    countries?: string[];
-    maxResults?: number;
-    searchIndexName?: string;
-    providerName?: string;
-}
-export interface SearchByTextOptionsWithBiasPosition extends SearchByTextOptionsBase {
-    biasPosition?: Coordinates;
-}
-export interface SearchByTextOptionsWithSearchAreaConstraints extends SearchByTextOptionsBase {
-    searchAreaConstraints?: BoundingBox;
-}
-export declare type SearchByTextOptions = SearchByTextOptionsWithBiasPosition | SearchByTextOptionsWithSearchAreaConstraints;
-export declare type SearchByCoordinatesOptions = {
-    maxResults?: number;
-    searchIndexName?: string;
-    providerName?: string;
-};
-export declare type searchByPlaceIdOptions = {
-    searchIndexName?: string;
-};
-export declare type PlaceGeometry = {
-    point: Coordinates;
-};
-export interface Place {
-    addressNumber?: string;
-    country?: string;
-    geometry: PlaceGeometry | undefined;
-    label?: string;
-    municipality?: string;
-    neighborhood?: string;
-    postalCode?: string;
-    region?: string;
-    street?: string;
-    subRegion?: string;
-}
-export declare type LinearRing = Coordinates[];
-export declare type GeofencePolygon = LinearRing[];
-export declare type PolygonGeometry = {
-    polygon: GeofencePolygon;
-};
-export declare type GeofenceId = string;
-export declare type GeofenceInput = {
-    geofenceId: GeofenceId;
-    geometry: PolygonGeometry;
-};
-export declare type GeofenceOptions = {
-    providerName?: string;
-};
-export declare type GeofenceError = {
-    error: {
-        code: string;
-        message: string;
-    };
-    geofenceId: GeofenceId;
-};
-declare type GeofenceBase = {
-    geofenceId: GeofenceId;
-    createTime?: Date;
-    updateTime?: Date;
-};
-export declare type Geofence = GeofenceBase & {
-    geometry: PolygonGeometry;
-};
-export declare type SaveGeofencesResults = {
-    successes: GeofenceBase[];
-    errors: GeofenceError[];
-};
-export declare type ListGeofenceOptions = GeofenceOptions & {
-    nextToken?: string;
-};
-export declare type ListGeofenceResults = {
-    entries: Geofence[];
-    nextToken: string | undefined;
-};
-export declare type DeleteGeofencesResults = {
-    successes: GeofenceId[];
-    errors: GeofenceError[];
-};
-export declare type SearchForSuggestionsResults = SearchForSuggestionsResult[];
-export declare type SearchForSuggestionsResult = {
-    text: string;
-    placeId?: string;
-};
-export {};

package/lib/types/Provider.d.ts

@@ -1,16 +0,0 @@
-import { SearchByTextOptions, SearchByCoordinatesOptions, SearchForSuggestionsResults, Coordinates, Place, MapStyle, Geofence, GeofenceId, GeofenceInput, GeofenceOptions, ListGeofenceOptions, ListGeofenceResults, SaveGeofencesResults, DeleteGeofencesResults, searchByPlaceIdOptions } from './Geo';
-export interface GeoProvider {
-    getCategory(): string;
-    getProviderName(): string;
-    configure(config: object): object;
-    getAvailableMaps(): MapStyle[];
-    getDefaultMap(): MapStyle;
-    searchByText(text: string, options?: SearchByTextOptions): Promise<Place[]>;
-    searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<Place>;
-    searchForSuggestions(text: string, options?: SearchByTextOptions): Promise<SearchForSuggestionsResults>;
-    searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions): Promise<Place | undefined>;
-    saveGeofences(geofences: GeofenceInput[], options?: GeofenceOptions): Promise<SaveGeofencesResults>;
-    getGeofence(geofenceId: GeofenceId, options?: ListGeofenceOptions): Promise<Geofence>;
-    listGeofences(options?: ListGeofenceOptions): Promise<ListGeofenceResults>;
-    deleteGeofences(geofenceIds: string[], options?: GeofenceOptions): Promise<DeleteGeofencesResults>;
-}

package/lib/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './Geo';
-export * from './Provider';
-export * from './AmazonLocationServiceProvider';

package/lib/util.d.ts

@@ -1,7 +0,0 @@
-import { Longitude, Latitude, GeofenceId, GeofenceInput, GeofencePolygon, LinearRing } from './types';
-export declare function validateCoordinates(lng: Longitude, lat: Latitude): void;
-export declare function validateGeofenceId(geofenceId: GeofenceId): void;
-export declare function validateLinearRing(linearRing: LinearRing, geofenceId?: GeofenceId): void;
-export declare function validatePolygon(polygon: GeofencePolygon, geofenceId?: GeofenceId): void;
-export declare function validateGeofencesInput(geofences: GeofenceInput[]): void;
-export declare function mapSearchOptions(options: any, locationServiceInput: any): any;