@wix/analytics-session 1.0.11 → 1.0.13

package/build/cjs/index.d.ts

@@ -1 +1,2 @@
-export * as analyticsSession from '@wix/analytics-session_analytics-session';
+import * as analyticsSession from '@wix/analytics-session_analytics-session';
+export { analyticsSession };

package/build/cjs/index.js

@@ -24,5 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.analyticsSession = void 0;
-exports.analyticsSession = __importStar(require("@wix/analytics-session_analytics-session"));
+const analyticsSession = __importStar(require("@wix/analytics-session_analytics-session"));
+exports.analyticsSession = analyticsSession;
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6FAA6E"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2FAA6E;AAEpE,4CAAgB"}

package/build/es/index.d.ts

@@ -1 +1,2 @@
-export * as analyticsSession from '@wix/analytics-session_analytics-session';
+import * as analyticsSession from '@wix/analytics-session_analytics-session';
+export { analyticsSession };

package/build/es/index.js

@@ -1,2 +1,3 @@
-export * as analyticsSession from '@wix/analytics-session_analytics-session';
+import * as analyticsSession from '@wix/analytics-session_analytics-session';
+export { analyticsSession };
 //# sourceMappingURL=index.js.map

package/build/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,0CAA0C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,0CAA0C,CAAC;AAE7E,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/analytics-session",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/analytics-session_analytics-session": "1.0.11"
+    "@wix/analytics-session_analytics-session": "1.0.13"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -27,8 +27,9 @@
     "typescript": "^5.3.2"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
+    "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
     "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
+    "build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
     "test": ":"
   },
   "wix": {
@@ -42,5 +43,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "24ea12da1427731b8d74b4bfa43f12863b9a1075f433a5279a3004cc"
+  "falconPackageHash": "32ac35d3f0adaa584181c62399ee6ed8ca0eac36d6ac1178195e76cf"
 }

package/type-bundles/context.bundle.d.ts

@@ -1,3 +1,37 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface Session {
     /** Session ID. */
     _id?: string;
@@ -268,45 +302,44 @@ interface GetListSessionsJobResultOptions {
     offset: number;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function listSessionsAsync$1(httpClient: HttpClient): ListSessionsAsyncSignature;
+interface ListSessionsAsyncSignature {
+    /**
+     * Start an async job to retrieve a list of session IDs, given the provided filters. The following filters **must** be passed:
+     * - Time period, either predefined or custom.
+     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
+     * @param - Filter options. The following filters **must** be passed:
+     *
+     * - Time period, either predefined or custom.
+     *
+     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
+     * @returns List sessions async response.
+     */
+    (options?: ListSessionsAsyncOptions | undefined): Promise<ListSessionsAsyncResponse & ListSessionsAsyncResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getListSessionsJobResult$1(httpClient: HttpClient): GetListSessionsJobResultSignature;
+interface GetListSessionsJobResultSignature {
+    /**
+     * Retrieves the job status and a list of session IDs, if ready.
+     * @param - List sessions job ID.
+     * @param - Field options. The `limit` and `offset` filters **must** be passed.
+     * @returns Get list sessions job result response.
+     */
+    (jobId: string, options: GetListSessionsJobResultOptions): Promise<GetListSessionsJobResultResponse & GetListSessionsJobResultResponseNonNullableFields>;
+}
+declare function markSessionAsRecorded$1(httpClient: HttpClient): MarkSessionAsRecordedSignature;
+interface MarkSessionAsRecordedSignature {
+    /**
+     * Marks a browser session as recorded.
+     * @param - Browser session ID.
+     * @returns Mark a browser session as recorded.
+     */
+    (sessionId: string): Promise<void>;
 }
 
-declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
-declare const listSessionsAsync: ReturnType<typeof createRESTModule<typeof publicListSessionsAsync>>;
-declare const getListSessionsJobResult: ReturnType<typeof createRESTModule<typeof publicGetListSessionsJobResult>>;
-declare const markSessionAsRecorded: ReturnType<typeof createRESTModule<typeof publicMarkSessionAsRecorded>>;
+declare const listSessionsAsync: BuildRESTFunction<typeof listSessionsAsync$1> & typeof listSessionsAsync$1;
+declare const getListSessionsJobResult: BuildRESTFunction<typeof getListSessionsJobResult$1> & typeof getListSessionsJobResult$1;
+declare const markSessionAsRecorded: BuildRESTFunction<typeof markSessionAsRecorded$1> & typeof markSessionAsRecorded$1;
 
 type context_ConversionFunnelSessionsParams = ConversionFunnelSessionsParams;
 type context_CountFunnelSessionsRequest = CountFunnelSessionsRequest;

package/type-bundles/index.bundle.d.ts

@@ -1,3 +1,37 @@
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
 interface Session {
     /** Session ID. */
     _id?: string;
@@ -268,45 +302,44 @@ interface GetListSessionsJobResultOptions {
     offset: number;
 }
 
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+declare function listSessionsAsync$1(httpClient: HttpClient): ListSessionsAsyncSignature;
+interface ListSessionsAsyncSignature {
+    /**
+     * Start an async job to retrieve a list of session IDs, given the provided filters. The following filters **must** be passed:
+     * - Time period, either predefined or custom.
+     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
+     * @param - Filter options. The following filters **must** be passed:
+     *
+     * - Time period, either predefined or custom.
+     *
+     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
+     * @returns List sessions async response.
+     */
+    (options?: ListSessionsAsyncOptions | undefined): Promise<ListSessionsAsyncResponse & ListSessionsAsyncResponseNonNullableFields>;
 }
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
+declare function getListSessionsJobResult$1(httpClient: HttpClient): GetListSessionsJobResultSignature;
+interface GetListSessionsJobResultSignature {
+    /**
+     * Retrieves the job status and a list of session IDs, if ready.
+     * @param - List sessions job ID.
+     * @param - Field options. The `limit` and `offset` filters **must** be passed.
+     * @returns Get list sessions job result response.
+     */
+    (jobId: string, options: GetListSessionsJobResultOptions): Promise<GetListSessionsJobResultResponse & GetListSessionsJobResultResponseNonNullableFields>;
+}
+declare function markSessionAsRecorded$1(httpClient: HttpClient): MarkSessionAsRecordedSignature;
+interface MarkSessionAsRecordedSignature {
+    /**
+     * Marks a browser session as recorded.
+     * @param - Browser session ID.
+     * @returns Mark a browser session as recorded.
+     */
+    (sessionId: string): Promise<void>;
 }
 
-declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
-
-declare const listSessionsAsync: ReturnType<typeof createRESTModule<typeof publicListSessionsAsync>>;
-declare const getListSessionsJobResult: ReturnType<typeof createRESTModule<typeof publicGetListSessionsJobResult>>;
-declare const markSessionAsRecorded: ReturnType<typeof createRESTModule<typeof publicMarkSessionAsRecorded>>;
+declare const listSessionsAsync: BuildRESTFunction<typeof listSessionsAsync$1> & typeof listSessionsAsync$1;
+declare const getListSessionsJobResult: BuildRESTFunction<typeof getListSessionsJobResult$1> & typeof getListSessionsJobResult$1;
+declare const markSessionAsRecorded: BuildRESTFunction<typeof markSessionAsRecorded$1> & typeof markSessionAsRecorded$1;
 
 type index_d_ConversionFunnelSessionsParams = ConversionFunnelSessionsParams;
 type index_d_CountFunnelSessionsRequest = CountFunnelSessionsRequest;