Skip to content

Commit f18b2c6

Browse files
matus-tomleinmatus-tomlein
committed
Fix api-extractor config
1 parent e1f7b97 commit f18b2c6

19 files changed

+30
-108
lines changed

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.deeplinkreceivedprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ DeepLinkReceived event properties schema: iglu:com.snowplowanalytics.mobile/deep
99
<b>Signature:</b>
1010

1111
```typescript
12-
type DeepLinkReceivedProps = {
12+
export declare type DeepLinkReceivedProps = {
1313
url: string;
1414
referrer?: string;
1515
};

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventcontext.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ EventContext type
99
<b>Signature:</b>
1010

1111
```typescript
12-
type EventContext = SelfDescribingJson;
12+
export declare type EventContext = SelfDescribingJson;
1313
```

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventstoreconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configuration for the event store
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface EventStoreConfiguration
12+
export interface EventStoreConfiguration
1313
```
1414

1515
## Properties

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.listitemviewprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Schema: `iglu:com.snowplowanalytics.mobile/list_item_view/jsonschema/1-0-0`
1111
<b>Signature:</b>
1212

1313
```typescript
14-
type ListItemViewProps = {
14+
export declare type ListItemViewProps = {
1515
index: number;
1616
itemsCount?: number;
1717
};

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.messagenotificationattachmentprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Attachment object that identify an attachment in the MessageNotification.
99
<b>Signature:</b>
1010

1111
```typescript
12-
type MessageNotificationAttachmentProps = {
12+
export declare type MessageNotificationAttachmentProps = {
1313
identifier: string;
1414
type: string;
1515
url: string;

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.messagenotificationprops.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,10 @@ MessageNotification event properties schema: iglu:com.snowplowanalytics.mobile/m
99
<b>Signature:</b>
1010

1111
```typescript
12-
type MessageNotificationProps = {
12+
export declare type MessageNotificationProps = {
1313
action?: string;
14-
/*
15-
* Attachments added to the notification (they can be part of the data object).
16-
*/
1714
attachments?: MessageNotificationAttachmentProps[];
1815
body: string;
19-
/*
20-
* Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.
21-
*/
2216
bodyLocArgs?: string[];
2317
bodyLocKey?: string;
2418
category?: string;
@@ -37,3 +31,5 @@ type MessageNotificationProps = {
3731
trigger: Trigger;
3832
};
3933
```
34+
<b>References:</b> [MessageNotificationAttachmentProps](./react-native-tracker.messagenotificationattachmentprops.md)<!-- -->, [Trigger](./react-native-tracker.trigger.md)
35+

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.newtracker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@ Creates a new tracker instance with the given configuration
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration): Promise<ReactNativeTracker>;
12+
export declare function newTracker(configuration: TrackerConfiguration & EmitterConfiguration & SessionConfiguration & SubjectConfiguration & EventStoreConfiguration): Promise<ReactNativeTracker>;
1313
```
1414

1515
## Parameters
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| configuration | TrackerConfiguration &amp; EmitterConfiguration &amp; SessionConfiguration &amp; SubjectConfiguration &amp; EventStoreConfiguration | Configuration for the tracker |
19+
| configuration | [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) &amp; EmitterConfiguration &amp; [SessionConfiguration](./react-native-tracker.sessionconfiguration.md) &amp; [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) &amp; [EventStoreConfiguration](./react-native-tracker.eventstoreconfiguration.md) | Configuration for the tracker |
2020

2121
<b>Returns:</b>
2222

23-
Promise&lt;ReactNativeTracker&gt;
23+
Promise&lt;[ReactNativeTracker](./react-native-tracker.reactnativetracker.md)<!-- -->&gt;
2424

2525
Tracker instance
2626

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.reactnativetracker.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,11 @@ The ReactNativeTracker type
99
<b>Signature:</b>
1010

1111
```typescript
12-
type ReactNativeTracker = {
12+
export declare type ReactNativeTracker = {
1313
readonly trackSelfDescribingEvent: <T extends Record<string, unknown> = Record<string, unknown>>(argmap: SelfDescribingJson<T>, contexts?: EventContext[]) => void;
14-
// TODO:
15-
// /**
16-
// * Tracks a screen-view event
17-
// *
18-
// * @param argmap - The screen-view event's properties
19-
// * @param contexts - The array of event contexts
20-
// */
21-
// readonly trackScreenViewEvent: (argmap: ScreenViewProps, contexts?: EventContext[]) => string | undefined;
22-
// TODO:
23-
// /**
24-
// * Tracks a scroll changed event
25-
// *
26-
// * @param argmap - The scroll changed event's properties
27-
// * @param contexts - The array of event contexts
28-
// */
29-
// readonly trackScrollChangedEvent: (argmap: ScrollChangedProps, contexts?: EventContext[]) => string | undefined;
30-
// TODO:
31-
// /**
32-
// * Tracks a list item view event
33-
// *
34-
// * @param argmap - The list item view event's properties
35-
// * @param contexts - The array of event contexts
36-
// */
37-
// readonly trackListItemViewEvent: (argmap: ListItemViewProps, contexts?: EventContext[]) => string | undefined;
3814
readonly trackStructuredEvent: (argmap: StructuredEvent, contexts?: EventContext[]) => void;
3915
readonly trackPageViewEvent: (argmap: PageViewEvent, contexts?: EventContext[]) => void;
4016
readonly trackTimingEvent: (argmap: TimingProps, contexts?: EventContext[]) => void;
41-
// TODO:
42-
// /**
43-
// * Tracks a deep link received event
44-
// *
45-
// * @param argmap - The deep link received event properties
46-
// * @param contexts - The array of event contexts
47-
// */
48-
// readonly trackDeepLinkReceivedEvent: (argmap: DeepLinkReceivedProps, contexts?: EventContext[]) => void;
4917
readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => void;
5018
addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive> | Record<string, ConditionalContextProvider | ContextPrimitive>): void;
5119
clearGlobalContexts(): void;
@@ -67,3 +35,5 @@ type ReactNativeTracker = {
6735
readonly setSubjectData: (config: SubjectConfiguration) => void;
6836
};
6937
```
38+
<b>References:</b> [EventContext](./react-native-tracker.eventcontext.md)<!-- -->, [TimingProps](./react-native-tracker.timingprops.md)<!-- -->, [MessageNotificationProps](./react-native-tracker.messagenotificationprops.md)<!-- -->, [ScreenSize](./react-native-tracker.screensize.md)<!-- -->, [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md)
39+

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.screensize.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,5 @@ Screen size in pixels
99
<b>Signature:</b>
1010

1111
```typescript
12-
type ScreenSize = [
13-
number,
14-
number
15-
];
12+
export declare type ScreenSize = [number, number];
1613
```

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.screenviewprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ScreenView event properties schema: iglu:com.snowplowanalytics.mobile/screen\_vi
99
<b>Signature:</b>
1010

1111
```typescript
12-
type ScreenViewProps = {
12+
export declare type ScreenViewProps = {
1313
name: string;
1414
id?: string;
1515
type?: string;

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.scrollchangedprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Schema: `iglu:com.snowplowanalytics.mobile/scroll_changed/jsonschema/1-0-0`
1111
<b>Signature:</b>
1212

1313
```typescript
14-
type ScrollChangedProps = {
14+
export declare type ScrollChangedProps = {
1515
yOffset?: number;
1616
xOffset?: number;
1717
viewHeight?: number;

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configuration for session tracking
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface SessionConfiguration
12+
export interface SessionConfiguration
1313
```
1414

1515
## Properties

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configuration of subject properties tracked with events
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface SubjectConfiguration
12+
export interface SubjectConfiguration
1313
```
1414

1515
## Properties
@@ -21,8 +21,8 @@ interface SubjectConfiguration
2121
| [ipAddress?](./react-native-tracker.subjectconfiguration.ipaddress.md) | string | <i>(Optional)</i> Override the IP address of the device |
2222
| [language?](./react-native-tracker.subjectconfiguration.language.md) | string | <i>(Optional)</i> The language set in the device |
2323
| [networkUserId?](./react-native-tracker.subjectconfiguration.networkuserid.md) | string | <i>(Optional)</i> Override the network user id (UUIDv4) that is assigned by the collector and stored in cookies |
24-
| [screenResolution?](./react-native-tracker.subjectconfiguration.screenresolution.md) | ScreenSize | <i>(Optional)</i> The screen resolution |
25-
| [screenViewport?](./react-native-tracker.subjectconfiguration.screenviewport.md) | ScreenSize | <i>(Optional)</i> The screen viewport size |
24+
| [screenResolution?](./react-native-tracker.subjectconfiguration.screenresolution.md) | [ScreenSize](./react-native-tracker.screensize.md) | <i>(Optional)</i> The screen resolution |
25+
| [screenViewport?](./react-native-tracker.subjectconfiguration.screenviewport.md) | [ScreenSize](./react-native-tracker.screensize.md) | <i>(Optional)</i> The screen viewport size |
2626
| [timezone?](./react-native-tracker.subjectconfiguration.timezone.md) | string | <i>(Optional)</i> The timezone label |
2727
| [useragent?](./react-native-tracker.subjectconfiguration.useragent.md) | string | <i>(Optional)</i> The custom user-agent. It overrides the user-agent used by default. |
2828
| [userId?](./react-native-tracker.subjectconfiguration.userid.md) | string | <i>(Optional)</i> Business-defined user ID for this user |

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.timingprops.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Timing event properties
99
<b>Signature:</b>
1010

1111
```typescript
12-
type TimingProps = {
12+
export declare type TimingProps = {
1313
category: string;
1414
variable: string;
1515
timing: number;

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The configuration object for initialising the tracker
99
<b>Signature:</b>
1010

1111
```typescript
12-
interface TrackerConfiguration
12+
export interface TrackerConfiguration
1313
```
1414

1515
## Properties

‎api-docs/docs/react-native-tracker/markdown/react-native-tracker.trigger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Trigger for MessageNotification event
99
<b>Signature:</b>
1010

1111
```typescript
12-
type Trigger = "push" | "location" | "calendar" | "timeInterval" | "other";
12+
export declare type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other';
1313
```

‎api-docs/docs/react-native-tracker/react-native-tracker.api.md

Lines changed: 4 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
// @public
88
export type ConditionalContextProvider = FilterProvider | RuleSetProvider;
99

10-
// Warning: (ae-forgotten-export) The symbol "ContextEvent" needs to be exported by the entry point index.module.d.ts
10+
// Warning: (ae-forgotten-export) The symbol "ContextEvent" needs to be exported by the entry point index.d.ts
1111
//
1212
// @public
1313
export type ContextFilter = (args?: ContextEvent) => boolean;
@@ -152,7 +152,7 @@ export interface EventStoreConfiguration {
152152

153153
// @public
154154
export interface EventStoreIterator {
155-
// Warning: (ae-forgotten-export) The symbol "EventStoreIteratorNextResult" needs to be exported by the entry point index.module.d.ts
155+
// Warning: (ae-forgotten-export) The symbol "EventStoreIteratorNextResult" needs to be exported by the entry point index.d.ts
156156
next: () => Promise<EventStoreIteratorNextResult>;
157157
}
158158

@@ -226,14 +226,8 @@ export type MessageNotificationAttachmentProps = {
226226
// @public
227227
export type MessageNotificationProps = {
228228
action?: string;
229-
/*
230-
* Attachments added to the notification (they can be part of the data object).
231-
*/
232229
attachments?: MessageNotificationAttachmentProps[];
233230
body: string;
234-
/*
235-
* Variable string values to be used in place of the format specifiers in bodyLocArgs to use to localize the body text to the user's current localization.
236-
*/
237231
bodyLocArgs?: string[];
238232
bodyLocKey?: string;
239233
category?: string;
@@ -280,41 +274,9 @@ export interface PayloadBuilder {
280274
// @public
281275
export type ReactNativeTracker = {
282276
readonly trackSelfDescribingEvent: <T extends Record<string, unknown> = Record<string, unknown>>(argmap: SelfDescribingJson<T>, contexts?: EventContext[]) => void;
283-
// TODO:
284-
// /**
285-
// * Tracks a screen-view event
286-
// *
287-
// * @param argmap - The screen-view event's properties
288-
// * @param contexts - The array of event contexts
289-
// */
290-
// readonly trackScreenViewEvent: (argmap: ScreenViewProps, contexts?: EventContext[]) => string | undefined;
291-
// TODO:
292-
// /**
293-
// * Tracks a scroll changed event
294-
// *
295-
// * @param argmap - The scroll changed event's properties
296-
// * @param contexts - The array of event contexts
297-
// */
298-
// readonly trackScrollChangedEvent: (argmap: ScrollChangedProps, contexts?: EventContext[]) => string | undefined;
299-
// TODO:
300-
// /**
301-
// * Tracks a list item view event
302-
// *
303-
// * @param argmap - The list item view event's properties
304-
// * @param contexts - The array of event contexts
305-
// */
306-
// readonly trackListItemViewEvent: (argmap: ListItemViewProps, contexts?: EventContext[]) => string | undefined;
307277
readonly trackStructuredEvent: (argmap: StructuredEvent, contexts?: EventContext[]) => void;
308278
readonly trackPageViewEvent: (argmap: PageViewEvent, contexts?: EventContext[]) => void;
309279
readonly trackTimingEvent: (argmap: TimingProps, contexts?: EventContext[]) => void;
310-
// TODO:
311-
// /**
312-
// * Tracks a deep link received event
313-
// *
314-
// * @param argmap - The deep link received event properties
315-
// * @param contexts - The array of event contexts
316-
// */
317-
// readonly trackDeepLinkReceivedEvent: (argmap: DeepLinkReceivedProps, contexts?: EventContext[]) => void;
318280
readonly trackMessageNotificationEvent: (argmap: MessageNotificationProps, contexts?: EventContext[]) => void;
319281
addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive> | Record<string, ConditionalContextProvider | ContextPrimitive>): void;
320282
clearGlobalContexts(): void;
@@ -359,10 +321,7 @@ Array<ContextPrimitive> | ContextPrimitive
359321
];
360322

361323
// @public
362-
export type ScreenSize = [
363-
number,
364-
number
365-
];
324+
export type ScreenSize = [number, number];
366325

367326
// @public
368327
export type ScreenViewProps = {
@@ -470,7 +429,7 @@ export interface TrackerCore {
470429
}
471430

472431
// @public
473-
export type Trigger = "push" | "location" | "calendar" | "timeInterval" | "other";
432+
export type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other';
474433

475434
// @public
476435
export interface TrueTimestamp {

‎trackers/react-native-tracker/api-extractor.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
*
4646
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
4747
*/
48-
"mainEntryPointFilePath": "<projectFolder>/dist/index.module.d.ts",
48+
"mainEntryPointFilePath": "<projectFolder>/dist/typescript/module/src/index.d.ts",
4949

5050
/**
5151
* A list of NPM package names whose exports should be treated as part of this package.

‎trackers/react-native-tracker/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"esModuleInterop": true,
1010
"forceConsistentCasingInFileNames": true,
1111
"jsx": "react-jsx",
12-
"lib": ["ESNext"],
12+
"lib": ["ESNext", "DOM"],
1313
"module": "ESNext",
1414
"moduleResolution": "node",
1515
"noEmit": true,

0 commit comments

Comments
 (0)