@esri/telemetry-amazon 1.0.0-beta.2 → 1.0.0

package/dist/types/types.d.ts

@@ -0,0 +1,77 @@
+import { AnalyticsInstance } from 'analytics';
+import { UserSession } from '@esri/arcgis-rest-auth';
+export declare type GenericObject = {
+    [key: string]: any;
+};
+export interface IGetAccessPermissionsParams {
+    id: string;
+    authentication: UserSession;
+}
+export interface ISetAccessPermissionsParams extends IGetAccessPermissionsParams {
+    username: string;
+    accessChangeset: IAccessChangeset[];
+}
+export interface IGetAccessPermissionsParams {
+    id: string;
+    authentication: UserSession;
+}
+declare type AccessTargetProperties = 'public';
+export interface IAccessChangeset {
+    action: 'add' | 'remove';
+    targetProperty: AccessTargetProperties;
+    ids?: string[];
+}
+export interface IAmazon<D, M> {
+    analytics: AnalyticsInstance;
+    name: string;
+    previousPage: {
+        pageUrl?: string;
+        pageName?: string;
+    };
+    disabled: boolean;
+    dimensions: D;
+    metrics: M;
+    init(): Promise<void>;
+    logPageView: (page: string, options?: PageViewOptions) => void;
+    logEvent: (event?: EventOptions) => void;
+}
+export declare type Dimensions = GenericObject;
+export declare type Metrics = GenericObject;
+export declare type PageViewOptions = GenericObject;
+export declare type EventOptions = GenericObject;
+export declare type EventData = {
+    category?: string;
+    action?: string;
+    label?: string;
+    pathname?: string;
+    eventType?: string;
+};
+export declare type AmazonApp = {
+    name?: string;
+    id?: string;
+    version?: string;
+};
+export declare type AmazonTelemetryOptions = {
+    userPoolID: string;
+    app?: AmazonApp;
+    fips?: boolean;
+};
+export declare type LogPageViewPayload = {
+    name: string;
+    referrer: string;
+    hostname: string;
+    path: string;
+    pageUrl: string;
+    pageName: string;
+    previousPageUrl: string;
+    previousPageName: string;
+    attributes?: unknown;
+    metrics?: Metrics;
+};
+export declare type LogEventPayload = {
+    name: string;
+    referrer?: string;
+    hostname?: string;
+    path?: string;
+};
+export {};