-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[1.0.2] Added support for Facet Values & Insights
- Loading branch information
1 parent
e0c3db2
commit 9e60161
Showing
22 changed files
with
1,616 additions
and
1,268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| include: package:pedantic/analysis_options.1.11.0.yaml | ||
| include: package:lints/recommended.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| part of algolia; | ||
|
|
||
| enum AlgoliaEventType { | ||
| click, | ||
| conversion, | ||
| view, | ||
| } | ||
|
|
||
| extension AlgoliaEventTypeExtention on AlgoliaEventType { | ||
| String toMap() { | ||
| return toString().split('.').last; | ||
| } | ||
| } | ||
|
|
||
| class AlgoliaEvent { | ||
| AlgoliaEvent({ | ||
| required this.eventType, | ||
| required this.eventName, | ||
| required this.index, | ||
| required this.userToken, | ||
| this.queryId, | ||
| this.objectIds, | ||
| this.timestamp, | ||
| this.filters, | ||
| this.positions, | ||
| }) : assert( | ||
| eventName.isNotEmpty && eventName.length <= 64, | ||
| 'eventName - Format: any ASCII character, ' | ||
| 'except control points with a length between 1 and 64.', | ||
| ), | ||
| assert( | ||
| RegExp(r'[a-zA-Z0-9_-]{1,64}').hasMatch(eventName), | ||
| 'eventName - Format: [a-zA-Z0-9_-]{1,64}', | ||
| ), | ||
| assert( | ||
| (objectIds?.isEmpty ?? true) || (filters?.isEmpty ?? true), | ||
| 'An event can’t have both objectIds and filters at the same time.', | ||
| ), | ||
| assert( | ||
| !((queryId?.isNotEmpty ?? false) && | ||
| eventType == AlgoliaEventType.click) || | ||
| ((positions?.isNotEmpty ?? false) && | ||
| (objectIds?.isNotEmpty ?? false) && | ||
| positions?.length == objectIds?.length), | ||
| 'positions and objectIds field is required if a queryId is provided. ' | ||
| 'One position must be provided for each objectId. ' | ||
| 'Only include this parameter when sending click events.', | ||
| ); | ||
|
|
||
| /// An eventType can be a `click`, a `conversion`, or a `view`. | ||
| final AlgoliaEventType eventType; | ||
|
|
||
| /// A user-defined string used to categorize events. | ||
| /// | ||
| /// **Format:** | ||
| /// any ASCII character, except control points with a length between 1 and 64. | ||
| final String eventName; | ||
|
|
||
| /// Name of the targeted index. | ||
| /// | ||
| /// **Format:** | ||
| /// same as the index name used by the search engine. | ||
| final String index; | ||
|
|
||
| /// Name of the targeted index. | ||
| /// | ||
| /// **Format:** | ||
| /// same as the index name used by the search engine. | ||
| final String userToken; | ||
|
|
||
| /// Time of the event expressed in milliseconds since the Unix epoch. Default: now() | ||
| final DateTime? timestamp; | ||
|
|
||
| /// Algolia `queryId`. This is required when an event is tied to a search. | ||
| /// | ||
| /// It can be found in the Search API results response. | ||
| final String? queryId; | ||
|
|
||
| /// An array of index `objectId`. Limited to 20 objects. | ||
| /// | ||
| /// An event can’t have both `objectIds` and `filters` at the same time. | ||
| final List<String>? objectIds; | ||
|
|
||
| /// An array of filters. Limited to 10 filters. | ||
| /// | ||
| /// **Format:** | ||
| /// ${attribute}:${value}, like brand:apple. | ||
| /// | ||
| /// An event can’t have both `objectIds` and `filters` at the same time. | ||
| final List<String>? filters; | ||
|
|
||
| /// Position of the click in the list of Algolia search results. | ||
| /// | ||
| /// This field is | ||
| /// **required** | ||
| /// if a `queryId` is provided. One position must be provided for each | ||
| /// `objectId`. | ||
| /// | ||
| /// The position value must be absolute, not relative, to the result page. | ||
| /// For example, when clicking on the third record of the second results page, | ||
| /// assuming 10 results per page, the position should be 13. Since page starts | ||
| /// at 0, you can use the following formula: | ||
| /// ```$positionOnPage + $page * hitsPerPage``` | ||
| /// | ||
| /// Note: For InstantSearch implementations, this position is available | ||
| /// through the hit.__position attribute | ||
| /// | ||
| /// **Only** | ||
| /// include this parameter when sending click events. | ||
| final List<int>? positions; | ||
| Map<String, dynamic> toMap() { | ||
| var body = <String, dynamic>{ | ||
| 'eventType': eventType.toMap(), | ||
| 'eventName': eventName, | ||
| 'index': index, | ||
| 'userToken': userToken, | ||
| }; | ||
| if (timestamp != null) { | ||
| body['timestamp'] = timestamp!.millisecondsSinceEpoch; | ||
| } | ||
| if (queryId != null) body['queryId'] = queryId; | ||
| if (objectIds != null) body['objectIds'] = objectIds; | ||
| if (filters != null) body['filters'] = filters; | ||
| if (positions != null) body['positions'] = positions; | ||
| return body; | ||
| } | ||
| AlgoliaEvent copyWith({ | ||
| AlgoliaEventType? eventType, | ||
| String? eventName, | ||
| String? index, | ||
| String? userToken, | ||
| DateTime? timestamp, | ||
| String? queryId, | ||
| List<String>? objectIds, | ||
| List<String>? filters, | ||
| List<int>? positions, | ||
| }) { | ||
| return AlgoliaEvent( | ||
| eventType: eventType ?? this.eventType, | ||
| eventName: eventName ?? this.eventName, | ||
| index: index ?? this.index, | ||
| userToken: userToken ?? this.userToken, | ||
| timestamp: timestamp ?? this.timestamp, | ||
| queryId: queryId ?? this.queryId, | ||
| objectIds: objectIds ?? this.objectIds, | ||
| filters: filters ?? this.filters, | ||
| positions: positions ?? this.positions, | ||
| ); | ||
| } | ||
| @override | ||
| bool operator ==(Object other) { | ||
| if (identical(this, other)) return true; | ||
| return other is AlgoliaEvent && | ||
| other.eventType == eventType && | ||
| other.eventName == eventName && | ||
| other.index == index && | ||
| other.userToken == userToken && | ||
| other.timestamp == timestamp && | ||
| other.queryId == queryId && | ||
| other.objectIds.hashCode == objectIds.hashCode && | ||
| other.filters.hashCode == filters.hashCode && | ||
| other.positions.hashCode == positions.hashCode; | ||
| } | ||
| @override | ||
| int get hashCode { | ||
| return eventType.hashCode ^ | ||
| eventName.hashCode ^ | ||
| index.hashCode ^ | ||
| userToken.hashCode ^ | ||
| timestamp.hashCode ^ | ||
| queryId.hashCode ^ | ||
| objectIds.hashCode ^ | ||
| filters.hashCode ^ | ||
| positions.hashCode; | ||
| } | ||
| @override | ||
| String toString() { | ||
| return 'AlgoliaEvent(eventType: $eventType, eventName: $eventName, index: $index, userToken: $userToken, timestamp: $timestamp, queryId: $queryId, objectIds: $objectIds, filters: $filters, positions: $positions)'; | ||
| } | ||
| } |
Oops, something went wrong.