@use-tusk/drift-node-sdk 0.1.5 → 0.1.6

package/dist/index.d.cts

@@ -1,3 +1,85 @@
+import { NextConfig } from "next";
+
+//#region src/nextjs/types.d.ts
+
+/**
+ * Options for configuring Tusk Drift's Next.js integration.
+ */
+interface TuskDriftNextOptions {
+  /**
+   * Enable debug logging for Tusk Drift's Next.js integration.
+   * When enabled, logs information about configuration changes and version detection.
+   *
+   * @default false
+   */
+  debug?: boolean;
+  /**
+   * Disable automatic setting of `experimental.instrumentationHook`.
+   * Use this if you want to manually control the instrumentation hook setting.
+   *
+   * @default false
+   */
+  disableInstrumentationHook?: boolean;
+  /**
+   * Suppress all warnings from Tusk Drift's Next.js integration.
+   * Not recommended unless you know what you're doing.
+   *
+   * @default false
+   */
+  suppressWarnings?: boolean;
+}
+/**
+ * Type for Next.js config that can be an object or a function returning an object.
+ */
+
+//#endregion
+//#region src/nextjs/withTuskDrift.d.ts
+/**
+ * Wraps your Next.js configuration with Tusk Drift instrumentation setup.
+ *
+ * This function automatically configures Next.js to work with Tusk Drift by:
+ * - Enabling the Next.js instrumentation hook (for Next.js < 15.0.0-rc.1)
+ * - Configuring webpack externals to prevent bundling of core instrumentation packages
+ * - Preserving your existing Next.js configuration and webpack customizations
+ *
+ * @param nextConfig - Your existing Next.js configuration object (optional)
+ * @param options - Additional options to configure Tusk Drift's behavior (optional)
+ * @returns The wrapped Next.js configuration with Tusk Drift instrumentation enabled
+ *
+ * @example
+ * Basic usage:
+ * ```javascript
+ * // next.config.js
+ * const { withTuskDrift } = require('@use-tusk/drift-node-sdk');
+ *
+ * module.exports = withTuskDrift({
+ *   // Your Next.js config
+ * });
+ * ```
+ *
+ * @example
+ * With debug logging:
+ * ```javascript
+ * // next.config.js
+ * const { withTuskDrift } = require('@use-tusk/drift-node-sdk');
+ *
+ * module.exports = withTuskDrift(
+ *   {
+ *     // Your Next.js config
+ *   },
+ *   {
+ *     debug: true,
+ *   }
+ * );
+ * ```
+ *
+ * @remarks
+ * The following webpack externals are added for server-side builds:
+ * - `require-in-the-middle` - Required for CommonJS module interception
+ * - `jsonpath` - Required for schema manipulation
+ */
+declare function withTuskDrift(nextConfig?: NextConfig, options?: TuskDriftNextOptions): NextConfig;
+//#endregion
 //#region src/core/types.d.ts
 
 type OneOf<T extends object> = { [K in keyof T]: Required<Pick<T, K>> & Partial<Record<Exclude<keyof T, K>, null>> }[keyof T];
@@ -166,5 +248,5 @@ interface TuskDriftPublicAPI {
 }
 declare const TuskDrift: TuskDriftPublicAPI;
 //#endregion
-export { TuskDrift };
+export { TuskDrift, type TuskDriftNextOptions, withTuskDrift };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,7 +1,87 @@
 import { SpanKind } from "@opentelemetry/api";
 import { PackageType, StatusCode } from "@use-tusk/drift-schemas/core/span";
 import "@use-tusk/drift-schemas/core/json_schema";
+import { NextConfig } from "next";
 
+//#region src/nextjs/types.d.ts
+/**
+ * Options for configuring Tusk Drift's Next.js integration.
+ */
+interface TuskDriftNextOptions {
+  /**
+   * Enable debug logging for Tusk Drift's Next.js integration.
+   * When enabled, logs information about configuration changes and version detection.
+   *
+   * @default false
+   */
+  debug?: boolean;
+  /**
+   * Disable automatic setting of `experimental.instrumentationHook`.
+   * Use this if you want to manually control the instrumentation hook setting.
+   *
+   * @default false
+   */
+  disableInstrumentationHook?: boolean;
+  /**
+   * Suppress all warnings from Tusk Drift's Next.js integration.
+   * Not recommended unless you know what you're doing.
+   *
+   * @default false
+   */
+  suppressWarnings?: boolean;
+}
+/**
+ * Type for Next.js config that can be an object or a function returning an object.
+ */
+
+//#endregion
+//#region src/nextjs/withTuskDrift.d.ts
+/**
+ * Wraps your Next.js configuration with Tusk Drift instrumentation setup.
+ *
+ * This function automatically configures Next.js to work with Tusk Drift by:
+ * - Enabling the Next.js instrumentation hook (for Next.js < 15.0.0-rc.1)
+ * - Configuring webpack externals to prevent bundling of core instrumentation packages
+ * - Preserving your existing Next.js configuration and webpack customizations
+ *
+ * @param nextConfig - Your existing Next.js configuration object (optional)
+ * @param options - Additional options to configure Tusk Drift's behavior (optional)
+ * @returns The wrapped Next.js configuration with Tusk Drift instrumentation enabled
+ *
+ * @example
+ * Basic usage:
+ * ```javascript
+ * // next.config.js
+ * const { withTuskDrift } = require('@use-tusk/drift-node-sdk');
+ *
+ * module.exports = withTuskDrift({
+ *   // Your Next.js config
+ * });
+ * ```
+ *
+ * @example
+ * With debug logging:
+ * ```javascript
+ * // next.config.js
+ * const { withTuskDrift } = require('@use-tusk/drift-node-sdk');
+ *
+ * module.exports = withTuskDrift(
+ *   {
+ *     // Your Next.js config
+ *   },
+ *   {
+ *     debug: true,
+ *   }
+ * );
+ * ```
+ *
+ * @remarks
+ * The following webpack externals are added for server-side builds:
+ * - `require-in-the-middle` - Required for CommonJS module interception
+ * - `jsonpath` - Required for schema manipulation
+ */
+declare function withTuskDrift(nextConfig?: NextConfig, options?: TuskDriftNextOptions): NextConfig;
+//#endregion
 //#region src/core/types.d.ts
 
 type OneOf<T extends object> = { [K in keyof T]: Required<Pick<T, K>> & Partial<Record<Exclude<keyof T, K>, null>> }[keyof T];
@@ -170,5 +250,5 @@ interface TuskDriftPublicAPI {
 }
 declare const TuskDrift: TuskDriftPublicAPI;
 //#endregion
-export { TuskDrift };
+export { TuskDrift, type TuskDriftNextOptions, withTuskDrift };
 //# sourceMappingURL=index.d.ts.map