@use-tusk/drift-node-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,103 @@
+//#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];
+//#endregion
+//#region src/core/utils/logger.d.ts
+type LogLevel = "silent" | "error" | "warn" | "info" | "debug";
+//#endregion
+//#region src/instrumentation/libraries/http/HttpTransformEngine.d.ts
+interface TransformConfigs {
+  http: HttpTransform[];
+}
+interface HttpTransform {
+  matcher: HttpTransformMatcher;
+  action: HttpTransformAction;
+}
+/** A matcher config. An element is matched iff *all* conditions specified
+ * here are true. Only one target field is allowed, but any of the common
+ * fields may be provided.
+ * */
+type HttpTransformMatcher = {
+  /** Request direction, relative to this service. */
+  direction: "inbound" | "outbound";
+  /** HTTP method: array of methods like ["GET", "POST"]. Empty array matches all methods. */
+  method?: ("GET" | "POST" | "DELETE" | "PUT")[];
+  /** URL path pattern: "/api/user/*" */
+  pathPattern?: string;
+  /** Host pattern. e.g. "api.example.com" */
+  host?: string;
+} & OneOf<HttpTransformTarget>;
+type HttpTransformTarget = {
+  /** JSONPath expression: "$.user.password" */
+  jsonPath: string;
+  /** Query parameter name: "ssn" */
+  queryParam: string;
+  /** Header name: "Authorization" */
+  headerName: string;
+  /** Transform the entire URL path */
+  urlPath: string;
+  /** Transform the entire request/response body */
+  fullBody: string;
+};
+type HttpTransformAction = {
+  type: "redact";
+  /** Prefix for hash (default: "REDACTED_") */
+  hashPrefix?: string;
+} | {
+  type: "mask";
+  /** Character to use for masking (default: "*") */
+  maskChar?: string;
+} | {
+  type: "replace";
+  /** Static replacement value (required) */
+  replaceWith: string;
+} | {
+  type: "drop";
+};
+//#endregion
+//#region src/core/TuskDrift.d.ts
+interface InitParams {
+  apiKey?: string;
+  env: string;
+  logLevel?: LogLevel;
+  transforms?: TransformConfigs;
+}
+interface TuskDriftPublicAPI {
+  /**
+   * Initialize the TuskDrift SDK instance
+   *
+   * This is the main initialization function for TuskDrift that must be called before importing/requiring any other modules.
+   *
+   * @param initParams - The initialization parameters object containing:
+   *   - apiKey: string - Your TuskDrift API key (required)
+   *   - env: string - The environment name (e.g., 'development', 'staging', 'production') (required)
+   *   - logLevel?: LogLevel - Optional logging level ('silent' | 'error' | 'warn' | 'info' | 'debug'), defaults to 'info'
+   *
+   * @returns void - Initializes the SDK
+   *
+   * @example
+   * ```typescript
+   * import { TuskDrift } from 'tusk-drift-sdk';
+   *
+   * TuskDrift.initialize({
+   *   apiKey: 'your-api-key',
+   *   env: 'production',
+   *   logLevel: 'debug'
+   * });
+   *
+   * ```
+   */
+  initialize(initParams: InitParams): void;
+  /**
+   * Mark the application as ready for recording/replay
+   *
+   * This should be called after the application has completed initialization and is ready to serve requests.
+   *
+   * @returns void
+   */
+  markAppAsReady(): void;
+}
+declare const TuskDrift: TuskDriftPublicAPI;
+//#endregion
+export { TuskDrift };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+import { SpanKind } from "@opentelemetry/api";
+import { PackageType, StatusCode } from "@use-tusk/drift-schemas/core/span";
+
+//#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];
+//#endregion
+//#region src/core/utils/logger.d.ts
+type LogLevel = "silent" | "error" | "warn" | "info" | "debug";
+//#endregion
+//#region src/instrumentation/libraries/http/HttpTransformEngine.d.ts
+interface TransformConfigs {
+  http: HttpTransform[];
+}
+interface HttpTransform {
+  matcher: HttpTransformMatcher;
+  action: HttpTransformAction;
+}
+/** A matcher config. An element is matched iff *all* conditions specified
+ * here are true. Only one target field is allowed, but any of the common
+ * fields may be provided.
+ * */
+type HttpTransformMatcher = {
+  /** Request direction, relative to this service. */
+  direction: "inbound" | "outbound";
+  /** HTTP method: array of methods like ["GET", "POST"]. Empty array matches all methods. */
+  method?: ("GET" | "POST" | "DELETE" | "PUT")[];
+  /** URL path pattern: "/api/user/*" */
+  pathPattern?: string;
+  /** Host pattern. e.g. "api.example.com" */
+  host?: string;
+} & OneOf<HttpTransformTarget>;
+type HttpTransformTarget = {
+  /** JSONPath expression: "$.user.password" */
+  jsonPath: string;
+  /** Query parameter name: "ssn" */
+  queryParam: string;
+  /** Header name: "Authorization" */
+  headerName: string;
+  /** Transform the entire URL path */
+  urlPath: string;
+  /** Transform the entire request/response body */
+  fullBody: string;
+};
+type HttpTransformAction = {
+  type: "redact";
+  /** Prefix for hash (default: "REDACTED_") */
+  hashPrefix?: string;
+} | {
+  type: "mask";
+  /** Character to use for masking (default: "*") */
+  maskChar?: string;
+} | {
+  type: "replace";
+  /** Static replacement value (required) */
+  replaceWith: string;
+} | {
+  type: "drop";
+};
+//#endregion
+//#region src/core/TuskDrift.d.ts
+interface InitParams {
+  apiKey?: string;
+  env: string;
+  logLevel?: LogLevel;
+  transforms?: TransformConfigs;
+}
+interface TuskDriftPublicAPI {
+  /**
+   * Initialize the TuskDrift SDK instance
+   *
+   * This is the main initialization function for TuskDrift that must be called before importing/requiring any other modules.
+   *
+   * @param initParams - The initialization parameters object containing:
+   *   - apiKey: string - Your TuskDrift API key (required)
+   *   - env: string - The environment name (e.g., 'development', 'staging', 'production') (required)
+   *   - logLevel?: LogLevel - Optional logging level ('silent' | 'error' | 'warn' | 'info' | 'debug'), defaults to 'info'
+   *
+   * @returns void - Initializes the SDK
+   *
+   * @example
+   * ```typescript
+   * import { TuskDrift } from 'tusk-drift-sdk';
+   *
+   * TuskDrift.initialize({
+   *   apiKey: 'your-api-key',
+   *   env: 'production',
+   *   logLevel: 'debug'
+   * });
+   *
+   * ```
+   */
+  initialize(initParams: InitParams): void;
+  /**
+   * Mark the application as ready for recording/replay
+   *
+   * This should be called after the application has completed initialization and is ready to serve requests.
+   *
+   * @returns void
+   */
+  markAppAsReady(): void;
+}
+declare const TuskDrift: TuskDriftPublicAPI;
+//#endregion
+export { TuskDrift };
+//# sourceMappingURL=index.d.ts.map