@nextlytics/core 0.3.1 → 0.4.0-canary.101

package/dist/api-handler.d.ts

@@ -6,6 +6,7 @@ import 'next/dist/server/web/spec-extension/cookies';
 type DispatchEvent = (event: NextlyticsEvent, ctx: RequestContext, policyFilter?: PageViewDelivery | "client-actions") => DispatchResult;
 type UpdateEvent = (eventId: string, patch: Partial<NextlyticsEvent>, ctx: RequestContext) => Promise<void>;
 declare function getUserContext(config: NextlyticsConfigWithDefaults, ctx: RequestContext): Promise<UserContext | undefined>;
+declare function getEventProps(config: NextlyticsConfigWithDefaults, ctx: RequestContext, userContext?: UserContext): Promise<Record<string, unknown> | undefined>;
 declare function handleEventPost(request: NextRequest, config: NextlyticsConfigWithDefaults, dispatchEvent: DispatchEvent, updateEvent: UpdateEvent): Promise<Response>;
 
-export { type DispatchEvent, type UpdateEvent, getUserContext, handleEventPost };
+export { type DispatchEvent, type UpdateEvent, getEventProps, getUserContext, handleEventPost };

package/dist/api-handler.js

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var api_handler_exports = {};
 __export(api_handler_exports, {
+  getEventProps: () => getEventProps,
   getUserContext: () => getUserContext,
   handleEventPost: () => handleEventPost
 });
@@ -29,7 +30,8 @@ var import_anonymous_user = require("./anonymous-user");
 function createRequestContext(request) {
   return {
     headers: request.headers,
-    cookies: request.cookies
+    cookies: request.cookies,
+    path: request.nextUrl.pathname
   };
 }
 async function getUserContext(config, ctx) {
@@ -40,6 +42,14 @@ async function getUserContext(config, ctx) {
     return void 0;
   }
 }
+async function getEventProps(config, ctx, userContext) {
+  if (!config.callbacks.getProps) return void 0;
+  try {
+    return await config.callbacks.getProps({ ...ctx, user: userContext }) || void 0;
+  } catch {
+    return void 0;
+  }
+}
 function reconstructServerContext(apiCallContext, clientContext) {
   const searchParams = {};
   if (clientContext.search) {
@@ -78,6 +88,8 @@ async function handleClientInit(request, hctx) {
     serverContext,
     config
   });
+  const pageCtx = { ...ctx, path: serverContext.path };
+  const propsFromCallback = await getEventProps(config, pageCtx, userContext);
   const isSoftNavigation = hctx.isSoftNavigation;
   const eventId = isSoftNavigation ? (0, import_uitils.generateId)() : pageRenderId;
   const event = {
@@ -90,7 +102,7 @@ async function handleClientInit(request, hctx) {
     serverContext,
     clientContext,
     userContext,
-    properties: {}
+    properties: { ...propsFromCallback }
   };
   if (isSoftNavigation) {
     const { clientActions, completion: completion2 } = dispatchEvent(event, ctx);
@@ -115,6 +127,8 @@ async function handleClientEvent(request, hctx) {
     serverContext,
     config
   });
+  const pageCtx = { ...ctx, path: serverContext.path };
+  const propsFromCallback = await getEventProps(config, pageCtx, userContext);
   const event = {
     origin: "client",
     eventId: (0, import_uitils.generateId)(),
@@ -125,7 +139,7 @@ async function handleClientEvent(request, hctx) {
     serverContext,
     clientContext,
     userContext,
-    properties: props || {}
+    properties: { ...propsFromCallback, ...props }
   };
   const { clientActions, completion } = dispatchEvent(event, ctx);
   const actions = await clientActions;
@@ -177,6 +191,7 @@ async function handleEventPost(request, config, dispatchEvent, updateEvent) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getEventProps,
   getUserContext,
   handleEventPost
 });

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export { Nextlytics } from './server.js';
 export { getNextlyticsProps } from './pages-router.js';
 export { NextlyticsClient, NextlyticsContext, useNextlytics } from './client.js';
 export { loggingBackend } from './backends/logging.js';
+export { PathMatcherOptions, pathMatcher } from './path-matcher.js';
 export { AnonymousUserResult, BackendConfigEntry, BackendWithConfig, ClientAction, ClientContext, ClientRequest, JavascriptTemplate, NextlyticsBackend, NextlyticsBackendFactory, NextlyticsClientContext, NextlyticsConfig, NextlyticsEvent, NextlyticsPlugin, NextlyticsPluginFactory, NextlyticsResult, NextlyticsServerSide, PageViewDelivery, PagesRouterContext, RequestContext, ServerEventContext, UserContext } from './types.js';
 import 'react/jsx-runtime';
 import 'react';

package/dist/index.js

@@ -22,6 +22,7 @@ __export(index_exports, {
   NextlyticsClient: () => import_client.NextlyticsClient,
   getNextlyticsProps: () => import_pages_router.getNextlyticsProps,
   loggingBackend: () => import_logging.loggingBackend,
+  pathMatcher: () => import_path_matcher.pathMatcher,
   useNextlytics: () => import_client.useNextlytics
 });
 module.exports = __toCommonJS(index_exports);
@@ -29,11 +30,13 @@ var import_server = require("./server");
 var import_pages_router = require("./pages-router");
 var import_client = require("./client");
 var import_logging = require("./backends/logging");
+var import_path_matcher = require("./path-matcher");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Nextlytics,
   NextlyticsClient,
   getNextlyticsProps,
   loggingBackend,
+  pathMatcher,
   useNextlytics
 });

package/dist/middleware.js

@@ -29,7 +29,8 @@ var import_api_handler = require("./api-handler");
 function createRequestContext(request) {
   return {
     headers: request.headers,
-    cookies: request.cookies
+    cookies: request.cookies,
+    path: request.nextUrl.pathname
   };
 }
 function createNextlyticsMiddleware(config, dispatchEvent, updateEvent) {
@@ -71,10 +72,14 @@ function createNextlyticsMiddleware(config, dispatchEvent, updateEvent) {
       return Response.json({ error: "Method not allowed" }, { status: 405 });
     }
     if (reqInfo.isNextjsInternal || reqInfo.isPrefetch || reqInfo.isStaticFile) {
-      return import_server.NextResponse.next();
+      const response2 = import_server.NextResponse.next();
+      response2.headers.set(import_server_component_context.headerNames.active, "1");
+      return response2;
     }
     if (!reqInfo.isPageNavigation && !config.isApiPath(pathname)) {
-      return import_server.NextResponse.next();
+      const response2 = import_server.NextResponse.next();
+      response2.headers.set(import_server_component_context.headerNames.active, "1");
+      return response2;
     }
     const pageRenderId = (0, import_uitils.generateId)();
     const serverContext = (0, import_uitils.createServerContext)(request);
@@ -102,12 +107,14 @@ function createNextlyticsMiddleware(config, dispatchEvent, updateEvent) {
       return response;
     }
     const userContext = await (0, import_api_handler.getUserContext)(config, ctx);
+    const extraProps = await (0, import_api_handler.getEventProps)(config, ctx, userContext);
     const pageViewEvent = createPageViewEvent(
       pageRenderId,
       serverContext,
       isApiPath,
       userContext,
-      anonId
+      anonId,
+      extraProps
     );
     const { clientActions, completion } = dispatchEvent(pageViewEvent, ctx, "on-request");
     const actions = await clientActions;
@@ -124,7 +131,7 @@ function createNextlyticsMiddleware(config, dispatchEvent, updateEvent) {
     return response;
   };
 }
-function createPageViewEvent(pageRenderId, serverContext, isApiPath, userContext, anonymousUserId) {
+function createPageViewEvent(pageRenderId, serverContext, isApiPath, userContext, anonymousUserId, extraProps) {
   const eventType = isApiPath ? "apiCall" : "pageView";
   return {
     origin: "server",
@@ -134,7 +141,7 @@ function createPageViewEvent(pageRenderId, serverContext, isApiPath, userContext
     anonymousUserId,
     serverContext,
     userContext,
-    properties: {}
+    properties: { ...extraProps }
   };
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/path-matcher.d.ts

@@ -0,0 +1,20 @@
+type PathMatcherOptions = {
+    /** Paths to exclude. Matches exact path or path prefix (with `/` boundary). */
+    not?: string | string[];
+    /** Allow partial matches — path can have fewer segments than pattern. */
+    prefix?: boolean;
+};
+/**
+ * Match a URL path against a Next.js-style `[param]` pattern.
+ *
+ * Returns extracted params on match, or `null` on mismatch.
+ *
+ * @example
+ * ```ts
+ * pathMatcher("/[workspace]/[project]", "/acme/myproject")
+ * // => { workspace: "acme", project: "myproject" }
+ * ```
+ */
+declare function pathMatcher(pattern: string, path: string, opts?: PathMatcherOptions): Record<string, string> | null;
+
+export { type PathMatcherOptions, pathMatcher };

package/dist/path-matcher.js

@@ -0,0 +1,58 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var path_matcher_exports = {};
+__export(path_matcher_exports, {
+  pathMatcher: () => pathMatcher
+});
+module.exports = __toCommonJS(path_matcher_exports);
+function pathMatcher(pattern, path, opts) {
+  if (opts?.not) {
+    const exclusions = Array.isArray(opts.not) ? opts.not : [opts.not];
+    for (const excl of exclusions) {
+      if (path === excl || path.startsWith(excl + "/")) {
+        return null;
+      }
+    }
+  }
+  const patternSegments = pattern.split("/").filter(Boolean);
+  const pathSegments = path.split("/").filter(Boolean);
+  if (opts?.prefix) {
+    if (pathSegments.length === 0) return null;
+    if (pathSegments.length > patternSegments.length) return null;
+  } else {
+    if (pathSegments.length !== patternSegments.length) return null;
+  }
+  const params = {};
+  const segmentsToMatch = Math.min(patternSegments.length, pathSegments.length);
+  for (let i = 0; i < segmentsToMatch; i++) {
+    const pat = patternSegments[i];
+    const seg = pathSegments[i];
+    const paramMatch = pat.match(/^\[(\w+)]$/);
+    if (paramMatch) {
+      params[paramMatch[1]] = decodeURIComponent(seg);
+    } else if (pat !== seg) {
+      return null;
+    }
+  }
+  return params;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pathMatcher
+});

package/dist/plugins/vercel-geo.d.ts

@@ -14,7 +14,7 @@ type VercelGeoPluginOptions = {
  * ```ts
  * import { vercelGeoPlugin } from "@nextlytics/core/plugins/vercel-geo";
  *
- * export const { middleware, handlers } = Nextlytics({
+ * export const { middleware } = Nextlytics({
  *   plugins: [vercelGeoPlugin()],
  *   // ...
  * });

package/dist/server-component-context.d.ts

@@ -7,6 +7,7 @@ declare const headerNames: {
     readonly search: "x-nl-search";
     readonly pageRenderId: "x-nl-page-render-id";
     readonly isSoftNavigation: "x-nl-is-soft-nav";
+    readonly active: "x-nl-active";
     readonly scripts: "x-nl-scripts";
 };
 declare const LAST_PAGE_RENDER_ID_COOKIE = "last-page-render-id";

package/dist/server-component-context.js

@@ -30,6 +30,7 @@ const headerNames = {
   search: `${HEADER_PREFIX}search`,
   pageRenderId: `${HEADER_PREFIX}page-render-id`,
   isSoftNavigation: `${HEADER_PREFIX}is-soft-nav`,
+  active: `${HEADER_PREFIX}active`,
   scripts: `${HEADER_PREFIX}scripts`
 };
 const LAST_PAGE_RENDER_ID_COOKIE = "last-page-render-id";

package/dist/server.js

@@ -31,6 +31,7 @@ var import_client = require("./client");
 var import_config_helpers = require("./config-helpers");
 var import_middleware = require("./middleware");
 var import_uitils = require("./uitils");
+var import_api_handler = require("./api-handler");
 function isBackendWithConfig(entry) {
   return typeof entry === "object" && entry !== null && "backend" in entry;
 }
@@ -76,7 +77,8 @@ async function createRequestContext() {
   const [_cookies, _headers] = await Promise.all([(0, import_headers.cookies)(), (0, import_headers.headers)()]);
   return {
     cookies: _cookies,
-    headers: _headers
+    headers: _headers,
+    path: _headers.get("x-nl-pathname") || ""
   };
 }
 function collectTemplates(config, ctx) {
@@ -177,7 +179,9 @@ function Nextlytics(userConfig) {
     const headersList = await (0, import_headers.headers)();
     const ctx = (0, import_server_component_context.restoreServerComponentContext)(headersList);
     if (!ctx) {
-      console.warn("[Nextlytics] nextlyticsMiddleware should be added in order for Server to work");
+      if (!headersList.get(import_server_component_context.headerNames.active)) {
+        console.warn("[Nextlytics] nextlyticsMiddleware should be added in order for Server to work");
+      }
       return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(import_jsx_runtime.Fragment, { children });
     }
     const requestCtx = await createRequestContext();
@@ -189,7 +193,11 @@ function Nextlytics(userConfig) {
     const cookieStore = await (0, import_headers.cookies)();
     const pageRenderId = headersList.get(import_server_component_context.headerNames.pageRenderId);
     const serverContext = createServerContextFromHeaders(headersList);
-    const ctx = { headers: headersList, cookies: cookieStore };
+    const ctx = {
+      headers: headersList,
+      cookies: cookieStore,
+      path: headersList.get(import_server_component_context.headerNames.pathname) || ""
+    };
     const { anonId: anonymousUserId } = await (0, import_anonymous_user.resolveAnonymousUser)({ ctx, serverContext, config });
     let userContext;
     if (config.callbacks.getUser) {
@@ -198,6 +206,7 @@ function Nextlytics(userConfig) {
       } catch {
       }
     }
+    const propsFromCallback = await (0, import_api_handler.getEventProps)(config, ctx, userContext);
     return {
       sendEvent: async (eventName, opts) => {
         if (!pageRenderId) {
@@ -213,7 +222,7 @@ function Nextlytics(userConfig) {
           anonymousUserId,
           serverContext,
           userContext,
-          properties: opts?.props || {}
+          properties: { ...propsFromCallback, ...opts?.props }
         };
         await dispatchEventInternal(event, ctx);
         return { ok: true };

package/dist/types.d.ts

@@ -104,6 +104,7 @@ type AnonymousUserResult = {
 type RequestContext = {
     headers: Headers;
     cookies: Pick<RequestCookies, "get" | "getAll" | "has">;
+    path: string;
 };
 type NextlyticsPlugin = {
     /**
@@ -160,6 +161,14 @@ type NextlyticsConfig = {
             ctx: RequestContext;
             originalAnonymousUserId?: string;
         }) => Promise<AnonymousUserResult>;
+        /**
+         * Derive extra event properties from the request context.
+         * Called on every request; the returned object is merged into `event.properties`.
+         * User-provided properties (e.g. from `sendEvent` or client custom events) take priority.
+         */
+        getProps?: (ctx: RequestContext & {
+            user?: UserContext;
+        }) => Record<string, unknown> | undefined | Promise<Record<string, unknown> | undefined>;
     };
     /** Analytics backends to send events to */
     backends?: BackendConfigEntry[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextlytics/core",
-  "version": "0.3.1",
+  "version": "0.4.0-canary.101",
   "description": "Analytics library for Next.js",
   "license": "MIT",
   "repository": {