apitally 0.25.8 → 1.0.0-beta.1

package/dist/config.d.ts

@@ -0,0 +1,45 @@
+import { ReadWriteLogRecord } from '@opentelemetry/sdk-logs';
+import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+
+type BodyMaskingCallback = (body: Buffer, span: ReadableSpan) => Buffer | null;
+type LogRecordMaskingCallback = (logRecord: ReadWriteLogRecord) => ReadWriteLogRecord | null | undefined;
+type SamplingCallback = (span: ReadableSpan) => number | boolean | undefined;
+interface ApitallyOptions {
+    writeToken?: string;
+    env?: string;
+    appVersion?: string;
+    disabled?: boolean;
+    captureLogs?: boolean;
+    captureRequestHeaders?: boolean;
+    captureRequestBody?: boolean;
+    captureResponseHeaders?: boolean;
+    captureResponseBody?: boolean;
+    maskQueryParams?: RegExp[];
+    maskHeaders?: RegExp[];
+    maskBodyFields?: RegExp[];
+    maskRequestBody?: BodyMaskingCallback;
+    maskResponseBody?: BodyMaskingCallback;
+    maskLogRecord?: LogRecordMaskingCallback;
+    excludePaths?: RegExp[];
+    sampleRate?: number;
+    sampleOnRequest?: SamplingCallback;
+    sampleOnResponse?: SamplingCallback;
+}
+type OptionalConfigKeys = "appVersion" | "maskRequestBody" | "maskResponseBody" | "maskLogRecord" | "sampleOnRequest" | "sampleOnResponse";
+type ApitallyConfig = Required<Omit<ApitallyOptions, OptionalConfigKeys>> & Pick<ApitallyOptions, OptionalConfigKeys> & {
+    otlpEndpoint: string;
+};
+declare const DEFAULT_ENV = "dev";
+declare const DEFAULT_MASK_QUERY_PARAMS: string[];
+declare const DEFAULT_MASK_HEADERS: string[];
+declare const DEFAULT_MASK_BODY_FIELDS: string[];
+declare const DEFAULT_EXCLUDE_PATHS: string[];
+declare const EXCLUDE_USER_AGENTS: string[];
+declare function setConfig(options?: ApitallyOptions): ApitallyConfig;
+declare function getConfig(): ApitallyConfig;
+declare function isValidWriteToken(value: string): boolean;
+declare function isApitallyDisabledViaEnv(): boolean;
+declare function matchesAny(patterns: RegExp[], value: string): boolean;
+declare function compilePatterns(defaults: string[], userPatterns?: RegExp[]): RegExp[];
+
+export { type ApitallyConfig, type ApitallyOptions, type BodyMaskingCallback, DEFAULT_ENV, DEFAULT_EXCLUDE_PATHS, DEFAULT_MASK_BODY_FIELDS, DEFAULT_MASK_HEADERS, DEFAULT_MASK_QUERY_PARAMS, EXCLUDE_USER_AGENTS, type LogRecordMaskingCallback, type SamplingCallback, compilePatterns, getConfig, isApitallyDisabledViaEnv, isValidWriteToken, matchesAny, setConfig };

package/dist/config.js

@@ -0,0 +1,192 @@
+import { logError, logWarning } from "./logger.js";
+const DEFAULT_OTLP_ENDPOINT = "https://otlp.apitally.io";
+const DEFAULT_ENV = "dev";
+const DEFAULT_MASK_QUERY_PARAMS = [
+  "auth",
+  "api[-_]?key",
+  "secret",
+  "token",
+  "password",
+  "pwd"
+];
+const DEFAULT_MASK_HEADERS = ["auth", "api[-_]?key", "secret", "token", "cookie"];
+const DEFAULT_MASK_BODY_FIELDS = [
+  "password",
+  "pwd",
+  "token",
+  "secret",
+  "auth",
+  "card[-_ ]?number",
+  "ccv",
+  "ssn"
+];
+const DEFAULT_EXCLUDE_PATHS = [
+  "/_?healthz?/?$",
+  "/_?health[-_]?checks?/?$",
+  "/_?heart[-_]?beats?/?$",
+  "/ping/?$",
+  "/ready/?$",
+  "/live/?$",
+  "/favicon(?:-[\\w-]+)?\\.(ico|png|svg)$",
+  "/apple-touch-icon(?:-[\\w-]+)?\\.png$",
+  "/robots\\.txt$",
+  "/sitemap\\.xml$",
+  "/manifest\\.json$",
+  "/site\\.webmanifest$",
+  "/service-worker\\.js$",
+  "/sw\\.js$",
+  "/\\.well-known/"
+];
+const EXCLUDE_USER_AGENTS = [
+  "health[-_ ]?check",
+  "microsoft-azure-application-lb",
+  "googlehc",
+  "kube-probe"
+];
+const WRITE_TOKEN_FORMAT = /^apt_[a-zA-Z0-9]{24}$/;
+const TRUE_VALUES = /* @__PURE__ */ new Set(["1", "true", "yes"]);
+const GLOBAL_CONFIG_KEY = /* @__PURE__ */ Symbol.for("apitally.config");
+const configHolder = globalThis;
+function setConfig(options = {}) {
+  const { config, error } = resolveConfig(options);
+  const currentConfig = configHolder[GLOBAL_CONFIG_KEY];
+  if (currentConfig) {
+    if (!isSameConfig(config, currentConfig)) {
+      logWarning(
+        "useApitally() was called again with different options; the first call's configuration stays in effect"
+      );
+    }
+    return currentConfig;
+  }
+  if (error) {
+    logError(error);
+  }
+  configHolder[GLOBAL_CONFIG_KEY] = config;
+  return config;
+}
+function getConfig() {
+  return configHolder[GLOBAL_CONFIG_KEY] ?? resolveConfig({}).config;
+}
+function isValidWriteToken(value) {
+  return WRITE_TOKEN_FORMAT.test(value);
+}
+function isApitallyDisabledViaEnv() {
+  return isTruthyEnvValue(process.env.APITALLY_DISABLED);
+}
+function matchesAny(patterns, value) {
+  return patterns.some((pattern) => {
+    pattern.lastIndex = 0;
+    return pattern.test(value);
+  });
+}
+function compilePatterns(defaults, userPatterns = []) {
+  return [
+    ...defaults.map((pattern) => new RegExp(pattern, "i")),
+    ...userPatterns.map((pattern) => new RegExp(pattern))
+  ];
+}
+function resolveConfig(options) {
+  const config = {
+    writeToken: options.writeToken ?? nonEmptyEnvVar("APITALLY_WRITE_TOKEN") ?? "",
+    env: options.env ?? nonEmptyEnvVar("APITALLY_ENV") ?? DEFAULT_ENV,
+    appVersion: options.appVersion,
+    disabled: options.disabled === true || isTruthyEnvValue(process.env.APITALLY_DISABLED) || isTruthyEnvValue(process.env.OTEL_SDK_DISABLED),
+    captureLogs: options.captureLogs ?? true,
+    captureRequestHeaders: options.captureRequestHeaders ?? false,
+    captureRequestBody: options.captureRequestBody ?? false,
+    captureResponseHeaders: options.captureResponseHeaders ?? true,
+    captureResponseBody: options.captureResponseBody ?? false,
+    maskQueryParams: dropNonRegExpPatterns("maskQueryParams", options.maskQueryParams),
+    maskHeaders: dropNonRegExpPatterns("maskHeaders", options.maskHeaders),
+    maskBodyFields: dropNonRegExpPatterns("maskBodyFields", options.maskBodyFields),
+    maskRequestBody: options.maskRequestBody,
+    maskResponseBody: options.maskResponseBody,
+    maskLogRecord: options.maskLogRecord,
+    excludePaths: dropNonRegExpPatterns("excludePaths", options.excludePaths),
+    // An invalid sampleRate resolves to capturing everything: no data is lost, so no warning.
+    sampleRate: typeof options.sampleRate === "number" && options.sampleRate >= 0 && options.sampleRate <= 1 ? options.sampleRate : 1,
+    sampleOnRequest: options.sampleOnRequest,
+    sampleOnResponse: options.sampleOnResponse,
+    otlpEndpoint: nonEmptyEnvVar("APITALLY_OTLP_ENDPOINT") ?? DEFAULT_OTLP_ENDPOINT
+  };
+  if (config.disabled) {
+    return { config };
+  }
+  if (!config.writeToken) {
+    config.disabled = true;
+    return {
+      config,
+      error: "Apitally write token is missing (set the writeToken option or the APITALLY_WRITE_TOKEN environment variable)"
+    };
+  }
+  if (!isValidWriteToken(config.writeToken)) {
+    config.disabled = true;
+    return {
+      config,
+      error: `Apitally write token has an invalid format: ${config.writeToken.slice(0, 8)}...`
+    };
+  }
+  if (!isHttpUrl(config.otlpEndpoint)) {
+    config.disabled = true;
+    return {
+      config,
+      error: `Apitally OTLP endpoint is not a valid HTTP or HTTPS URL: ${config.otlpEndpoint}`
+    };
+  }
+  return { config };
+}
+function isHttpUrl(value) {
+  let url;
+  try {
+    url = new URL(value);
+  } catch {
+    return false;
+  }
+  return url.protocol === "http:" || url.protocol === "https:";
+}
+function dropNonRegExpPatterns(optionName, patterns = []) {
+  return patterns.filter((pattern) => {
+    if (pattern instanceof RegExp) {
+      return true;
+    }
+    logError(`Pattern in ${optionName} ignored because it is not a RegExp: ${String(pattern)}`);
+    return false;
+  });
+}
+function isSameConfig(a, b) {
+  return Object.keys(a).every((key) => {
+    const left = a[key];
+    const right = b[key];
+    if (Array.isArray(left) && Array.isArray(right)) {
+      return left.length === right.length && left.every((item, index) => {
+        const other = right[index];
+        return item instanceof RegExp && other instanceof RegExp && item.source === other.source && item.flags === other.flags;
+      });
+    }
+    if (typeof left === "function" && typeof right === "function") {
+      return true;
+    }
+    return left === right;
+  });
+}
+function isTruthyEnvValue(value) {
+  return value !== void 0 && TRUE_VALUES.has(value.trim().toLowerCase());
+}
+function nonEmptyEnvVar(name) {
+  return process.env[name]?.trim() || void 0;
+}
+export {
+  DEFAULT_ENV,
+  DEFAULT_EXCLUDE_PATHS,
+  DEFAULT_MASK_BODY_FIELDS,
+  DEFAULT_MASK_HEADERS,
+  DEFAULT_MASK_QUERY_PARAMS,
+  EXCLUDE_USER_AGENTS,
+  compilePatterns,
+  getConfig,
+  isApitallyDisabledViaEnv,
+  isValidWriteToken,
+  matchesAny,
+  setConfig
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/config.ts"],"sourcesContent":["import type { ReadWriteLogRecord } from \"@opentelemetry/sdk-logs\";\nimport type { ReadableSpan } from \"@opentelemetry/sdk-trace-base\";\nimport { logError, logWarning } from \"./logger.js\";\n\nexport type BodyMaskingCallback = (body: Buffer, span: ReadableSpan) => Buffer | null;\nexport type LogRecordMaskingCallback = (\n  logRecord: ReadWriteLogRecord,\n) => ReadWriteLogRecord | null | undefined;\nexport type SamplingCallback = (span: ReadableSpan) => number | boolean | undefined;\n\nexport interface ApitallyOptions {\n  writeToken?: string;\n  env?: string;\n  appVersion?: string;\n  disabled?: boolean;\n  captureLogs?: boolean;\n  captureRequestHeaders?: boolean;\n  captureRequestBody?: boolean;\n  captureResponseHeaders?: boolean;\n  captureResponseBody?: boolean;\n  maskQueryParams?: RegExp[];\n  maskHeaders?: RegExp[];\n  maskBodyFields?: RegExp[];\n  maskRequestBody?: BodyMaskingCallback;\n  maskResponseBody?: BodyMaskingCallback;\n  maskLogRecord?: LogRecordMaskingCallback;\n  excludePaths?: RegExp[];\n  sampleRate?: number;\n  sampleOnRequest?: SamplingCallback;\n  sampleOnResponse?: SamplingCallback;\n}\n\ntype OptionalConfigKeys =\n  | \"appVersion\"\n  | \"maskRequestBody\"\n  | \"maskResponseBody\"\n  | \"maskLogRecord\"\n  | \"sampleOnRequest\"\n  | \"sampleOnResponse\";\n\nexport type ApitallyConfig = Required<Omit<ApitallyOptions, OptionalConfigKeys>> &\n  Pick<ApitallyOptions, OptionalConfigKeys> & { otlpEndpoint: string };\n\nconst DEFAULT_OTLP_ENDPOINT = \"https://otlp.apitally.io\";\nexport const DEFAULT_ENV = \"dev\";\n\n// User-supplied patterns extend these defaults, never replace them.\nexport const DEFAULT_MASK_QUERY_PARAMS = [\n  \"auth\",\n  \"api[-_]?key\",\n  \"secret\",\n  \"token\",\n  \"password\",\n  \"pwd\",\n];\nexport const DEFAULT_MASK_HEADERS = [\"auth\", \"api[-_]?key\", \"secret\", \"token\", \"cookie\"];\nexport const DEFAULT_MASK_BODY_FIELDS = [\n  \"password\",\n  \"pwd\",\n  \"token\",\n  \"secret\",\n  \"auth\",\n  \"card[-_ ]?number\",\n  \"ccv\",\n  \"ssn\",\n];\nexport const DEFAULT_EXCLUDE_PATHS = [\n  \"/_?healthz?/?$\",\n  \"/_?health[-_]?checks?/?$\",\n  \"/_?heart[-_]?beats?/?$\",\n  \"/ping/?$\",\n  \"/ready/?$\",\n  \"/live/?$\",\n  \"/favicon(?:-[\\\\w-]+)?\\\\.(ico|png|svg)$\",\n  \"/apple-touch-icon(?:-[\\\\w-]+)?\\\\.png$\",\n  \"/robots\\\\.txt$\",\n  \"/sitemap\\\\.xml$\",\n  \"/manifest\\\\.json$\",\n  \"/site\\\\.webmanifest$\",\n  \"/service-worker\\\\.js$\",\n  \"/sw\\\\.js$\",\n  \"/\\\\.well-known/\",\n];\nexport const EXCLUDE_USER_AGENTS = [\n  \"health[-_ ]?check\",\n  \"microsoft-azure-application-lb\",\n  \"googlehc\",\n  \"kube-probe\",\n];\n\nconst WRITE_TOKEN_FORMAT = /^apt_[a-zA-Z0-9]{24}$/;\nconst TRUE_VALUES = new Set([\"1\", \"true\", \"yes\"]);\n\n// The ESM and CJS builds can load together, so a Symbol.for key gives both\n// copies the same configuration.\nconst GLOBAL_CONFIG_KEY = Symbol.for(\"apitally.config\");\nconst configHolder = globalThis as Record<symbol, ApitallyConfig | undefined>;\n\nexport function setConfig(options: ApitallyOptions = {}): ApitallyConfig {\n  const { config, error } = resolveConfig(options);\n  const currentConfig = configHolder[GLOBAL_CONFIG_KEY];\n  if (currentConfig) {\n    if (!isSameConfig(config, currentConfig)) {\n      logWarning(\n        \"useApitally() was called again with different options; the first call's configuration stays in effect\",\n      );\n    }\n    return currentConfig;\n  }\n  if (error) {\n    logError(error);\n  }\n  configHolder[GLOBAL_CONFIG_KEY] = config;\n  return config;\n}\n\nexport function getConfig(): ApitallyConfig {\n  return configHolder[GLOBAL_CONFIG_KEY] ?? resolveConfig({}).config;\n}\n\nexport function isValidWriteToken(value: string): boolean {\n  return WRITE_TOKEN_FORMAT.test(value);\n}\n\n// The emergency kill switch, re-checked at the activation boundary so it wins\n// even over an explicit disabled: false option.\nexport function isApitallyDisabledViaEnv(): boolean {\n  return isTruthyEnvValue(process.env.APITALLY_DISABLED);\n}\n\nexport function matchesAny(patterns: RegExp[], value: string): boolean {\n  return patterns.some((pattern) => {\n    pattern.lastIndex = 0;\n    return pattern.test(value);\n  });\n}\n\nexport function compilePatterns(defaults: string[], userPatterns: RegExp[] = []): RegExp[] {\n  return [\n    ...defaults.map((pattern) => new RegExp(pattern, \"i\")),\n    ...userPatterns.map((pattern) => new RegExp(pattern)),\n  ];\n}\n\nfunction resolveConfig(options: ApitallyOptions): {\n  config: ApitallyConfig;\n  error?: string;\n} {\n  const config: ApitallyConfig = {\n    writeToken: options.writeToken ?? nonEmptyEnvVar(\"APITALLY_WRITE_TOKEN\") ?? \"\",\n    env: options.env ?? nonEmptyEnvVar(\"APITALLY_ENV\") ?? DEFAULT_ENV,\n    appVersion: options.appVersion,\n    disabled:\n      options.disabled === true ||\n      isTruthyEnvValue(process.env.APITALLY_DISABLED) ||\n      isTruthyEnvValue(process.env.OTEL_SDK_DISABLED),\n    captureLogs: options.captureLogs ?? true,\n    captureRequestHeaders: options.captureRequestHeaders ?? false,\n    captureRequestBody: options.captureRequestBody ?? false,\n    captureResponseHeaders: options.captureResponseHeaders ?? true,\n    captureResponseBody: options.captureResponseBody ?? false,\n    maskQueryParams: dropNonRegExpPatterns(\"maskQueryParams\", options.maskQueryParams),\n    maskHeaders: dropNonRegExpPatterns(\"maskHeaders\", options.maskHeaders),\n    maskBodyFields: dropNonRegExpPatterns(\"maskBodyFields\", options.maskBodyFields),\n    maskRequestBody: options.maskRequestBody,\n    maskResponseBody: options.maskResponseBody,\n    maskLogRecord: options.maskLogRecord,\n    excludePaths: dropNonRegExpPatterns(\"excludePaths\", options.excludePaths),\n    // An invalid sampleRate resolves to capturing everything: no data is lost, so no warning.\n    sampleRate:\n      typeof options.sampleRate === \"number\" && options.sampleRate >= 0 && options.sampleRate <= 1\n        ? options.sampleRate\n        : 1,\n    sampleOnRequest: options.sampleOnRequest,\n    sampleOnResponse: options.sampleOnResponse,\n    otlpEndpoint: nonEmptyEnvVar(\"APITALLY_OTLP_ENDPOINT\") ?? DEFAULT_OTLP_ENDPOINT,\n  };\n  if (config.disabled) {\n    return { config };\n  }\n  if (!config.writeToken) {\n    config.disabled = true;\n    return {\n      config,\n      error:\n        \"Apitally write token is missing (set the writeToken option or the APITALLY_WRITE_TOKEN environment variable)\",\n    };\n  }\n  if (!isValidWriteToken(config.writeToken)) {\n    config.disabled = true;\n    // The write token is a credential and must never appear unmasked in logs.\n    return {\n      config,\n      error: `Apitally write token has an invalid format: ${config.writeToken.slice(0, 8)}...`,\n    };\n  }\n  if (!isHttpUrl(config.otlpEndpoint)) {\n    config.disabled = true;\n    return {\n      config,\n      error: `Apitally OTLP endpoint is not a valid HTTP or HTTPS URL: ${config.otlpEndpoint}`,\n    };\n  }\n  return { config };\n}\n\nfunction isHttpUrl(value: string): boolean {\n  let url: URL;\n  try {\n    url = new URL(value);\n  } catch {\n    return false;\n  }\n  return url.protocol === \"http:\" || url.protocol === \"https:\";\n}\n\n// Invalid pattern values could leave data unredacted, so they are logged and omitted.\nfunction dropNonRegExpPatterns(optionName: string, patterns: RegExp[] = []): RegExp[] {\n  return patterns.filter((pattern) => {\n    if (pattern instanceof RegExp) {\n      return true;\n    }\n    logError(`Pattern in ${optionName} ignored because it is not a RegExp: ${String(pattern)}`);\n    return false;\n  });\n}\n\nfunction isSameConfig(a: ApitallyConfig, b: ApitallyConfig): boolean {\n  return (Object.keys(a) as (keyof ApitallyConfig)[]).every((key) => {\n    const left = a[key];\n    const right = b[key];\n    if (Array.isArray(left) && Array.isArray(right)) {\n      return (\n        left.length === right.length &&\n        left.every((item, index) => {\n          const other = right[index];\n          return (\n            item instanceof RegExp &&\n            other instanceof RegExp &&\n            item.source === other.source &&\n            item.flags === other.flags\n          );\n        })\n      );\n    }\n    // Callback identity says nothing about sameness; app factories create them inline.\n    if (typeof left === \"function\" && typeof right === \"function\") {\n      return true;\n    }\n    return left === right;\n  });\n}\n\nfunction isTruthyEnvValue(value: string | undefined): boolean {\n  return value !== undefined && TRUE_VALUES.has(value.trim().toLowerCase());\n}\n\nfunction nonEmptyEnvVar(name: string): string | undefined {\n  return process.env[name]?.trim() || undefined;\n}\n"],"mappings":"AAEA,SAAS,UAAU,kBAAkB;AAyCrC,MAAM,wBAAwB;AACvB,MAAM,cAAc;AAGpB,MAAM,4BAA4B;AAAA,EACvC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACO,MAAM,uBAAuB,CAAC,QAAQ,eAAe,UAAU,SAAS,QAAQ;AAChF,MAAM,2BAA2B;AAAA,EACtC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACO,MAAM,wBAAwB;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AACO,MAAM,sBAAsB;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEA,MAAM,qBAAqB;AAC3B,MAAM,cAAc,oBAAI,IAAI,CAAC,KAAK,QAAQ,KAAK,CAAC;AAIhD,MAAM,oBAAoB,uBAAO,IAAI,iBAAiB;AACtD,MAAM,eAAe;AAEd,SAAS,UAAU,UAA2B,CAAC,GAAmB;AACvE,QAAM,EAAE,QAAQ,MAAM,IAAI,cAAc,OAAO;AAC/C,QAAM,gBAAgB,aAAa,iBAAiB;AACpD,MAAI,eAAe;AACjB,QAAI,CAAC,aAAa,QAAQ,aAAa,GAAG;AACxC;AAAA,QACE;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACA,MAAI,OAAO;AACT,aAAS,KAAK;AAAA,EAChB;AACA,eAAa,iBAAiB,IAAI;AAClC,SAAO;AACT;AAEO,SAAS,YAA4B;AAC1C,SAAO,aAAa,iBAAiB,KAAK,cAAc,CAAC,CAAC,EAAE;AAC9D;AAEO,SAAS,kBAAkB,OAAwB;AACxD,SAAO,mBAAmB,KAAK,KAAK;AACtC;AAIO,SAAS,2BAAoC;AAClD,SAAO,iBAAiB,QAAQ,IAAI,iBAAiB;AACvD;AAEO,SAAS,WAAW,UAAoB,OAAwB;AACrE,SAAO,SAAS,KAAK,CAAC,YAAY;AAChC,YAAQ,YAAY;AACpB,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B,CAAC;AACH;AAEO,SAAS,gBAAgB,UAAoB,eAAyB,CAAC,GAAa;AACzF,SAAO;AAAA,IACL,GAAG,SAAS,IAAI,CAAC,YAAY,IAAI,OAAO,SAAS,GAAG,CAAC;AAAA,IACrD,GAAG,aAAa,IAAI,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC;AAAA,EACtD;AACF;AAEA,SAAS,cAAc,SAGrB;AACA,QAAM,SAAyB;AAAA,IAC7B,YAAY,QAAQ,cAAc,eAAe,sBAAsB,KAAK;AAAA,IAC5E,KAAK,QAAQ,OAAO,eAAe,cAAc,KAAK;AAAA,IACtD,YAAY,QAAQ;AAAA,IACpB,UACE,QAAQ,aAAa,QACrB,iBAAiB,QAAQ,IAAI,iBAAiB,KAC9C,iBAAiB,QAAQ,IAAI,iBAAiB;AAAA,IAChD,aAAa,QAAQ,eAAe;AAAA,IACpC,uBAAuB,QAAQ,yBAAyB;AAAA,IACxD,oBAAoB,QAAQ,sBAAsB;AAAA,IAClD,wBAAwB,QAAQ,0BAA0B;AAAA,IAC1D,qBAAqB,QAAQ,uBAAuB;AAAA,IACpD,iBAAiB,sBAAsB,mBAAmB,QAAQ,eAAe;AAAA,IACjF,aAAa,sBAAsB,eAAe,QAAQ,WAAW;AAAA,IACrE,gBAAgB,sBAAsB,kBAAkB,QAAQ,cAAc;AAAA,IAC9E,iBAAiB,QAAQ;AAAA,IACzB,kBAAkB,QAAQ;AAAA,IAC1B,eAAe,QAAQ;AAAA,IACvB,cAAc,sBAAsB,gBAAgB,QAAQ,YAAY;AAAA;AAAA,IAExE,YACE,OAAO,QAAQ,eAAe,YAAY,QAAQ,cAAc,KAAK,QAAQ,cAAc,IACvF,QAAQ,aACR;AAAA,IACN,iBAAiB,QAAQ;AAAA,IACzB,kBAAkB,QAAQ;AAAA,IAC1B,cAAc,eAAe,wBAAwB,KAAK;AAAA,EAC5D;AACA,MAAI,OAAO,UAAU;AACnB,WAAO,EAAE,OAAO;AAAA,EAClB;AACA,MAAI,CAAC,OAAO,YAAY;AACtB,WAAO,WAAW;AAClB,WAAO;AAAA,MACL;AAAA,MACA,OACE;AAAA,IACJ;AAAA,EACF;AACA,MAAI,CAAC,kBAAkB,OAAO,UAAU,GAAG;AACzC,WAAO,WAAW;AAElB,WAAO;AAAA,MACL;AAAA,MACA,OAAO,+CAA+C,OAAO,WAAW,MAAM,GAAG,CAAC,CAAC;AAAA,IACrF;AAAA,EACF;AACA,MAAI,CAAC,UAAU,OAAO,YAAY,GAAG;AACnC,WAAO,WAAW;AAClB,WAAO;AAAA,MACL;AAAA,MACA,OAAO,4DAA4D,OAAO,YAAY;AAAA,IACxF;AAAA,EACF;AACA,SAAO,EAAE,OAAO;AAClB;AAEA,SAAS,UAAU,OAAwB;AACzC,MAAI;AACJ,MAAI;AACF,UAAM,IAAI,IAAI,KAAK;AAAA,EACrB,QAAQ;AACN,WAAO;AAAA,EACT;AACA,SAAO,IAAI,aAAa,WAAW,IAAI,aAAa;AACtD;AAGA,SAAS,sBAAsB,YAAoB,WAAqB,CAAC,GAAa;AACpF,SAAO,SAAS,OAAO,CAAC,YAAY;AAClC,QAAI,mBAAmB,QAAQ;AAC7B,aAAO;AAAA,IACT;AACA,aAAS,cAAc,UAAU,wCAAwC,OAAO,OAAO,CAAC,EAAE;AAC1F,WAAO;AAAA,EACT,CAAC;AACH;AAEA,SAAS,aAAa,GAAmB,GAA4B;AACnE,SAAQ,OAAO,KAAK,CAAC,EAA+B,MAAM,CAAC,QAAQ;AACjE,UAAM,OAAO,EAAE,GAAG;AAClB,UAAM,QAAQ,EAAE,GAAG;AACnB,QAAI,MAAM,QAAQ,IAAI,KAAK,MAAM,QAAQ,KAAK,GAAG;AAC/C,aACE,KAAK,WAAW,MAAM,UACtB,KAAK,MAAM,CAAC,MAAM,UAAU;AAC1B,cAAM,QAAQ,MAAM,KAAK;AACzB,eACE,gBAAgB,UAChB,iBAAiB,UACjB,KAAK,WAAW,MAAM,UACtB,KAAK,UAAU,MAAM;AAAA,MAEzB,CAAC;AAAA,IAEL;AAEA,QAAI,OAAO,SAAS,cAAc,OAAO,UAAU,YAAY;AAC7D,aAAO;AAAA,IACT;AACA,WAAO,SAAS;AAAA,EAClB,CAAC;AACH;AAEA,SAAS,iBAAiB,OAAoC;AAC5D,SAAO,UAAU,UAAa,YAAY,IAAI,MAAM,KAAK,EAAE,YAAY,CAAC;AAC1E;AAEA,SAAS,eAAe,MAAkC;AACxD,SAAO,QAAQ,IAAI,IAAI,GAAG,KAAK,KAAK;AACtC;","names":[]}

package/dist/consumer.cjs

@@ -0,0 +1,98 @@
+"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 consumer_exports = {};
+__export(consumer_exports, {
+  setConsumer: () => setConsumer,
+  writeConsumerAttributesFromContext: () => writeConsumerAttributesFromContext
+});
+module.exports = __toCommonJS(consumer_exports);
+var import_context = require('./context.cjs');
+var import_logger = require('./logger.cjs');
+var import_requestAttributes = require('./requestAttributes.cjs');
+const CONSUMER_IDENTIFIER_ATTRIBUTE = "apitally.consumer.identifier";
+const CONSUMER_NAME_ATTRIBUTE = "apitally.consumer.name";
+const CONSUMER_GROUP_ATTRIBUTE = "apitally.consumer.group";
+function setConsumer(consumer) {
+  try {
+    const holder = (0, import_context.getConsumerHolder)();
+    const record = (0, import_context.getRequestRecord)();
+    const normalized = normalizeConsumer(consumer);
+    if (!holder && !record || !normalized) {
+      return;
+    }
+    if (holder) {
+      holder.identifier = normalized.identifier;
+      holder.name = normalized.name;
+      holder.group = normalized.group;
+    }
+    writeConsumerAttributes((0, import_context.getServerSpan)(), record, normalized);
+  } catch (error) {
+    (0, import_logger.logDebug)(`Error setting consumer: ${String(error)}`);
+  }
+}
+function writeConsumerAttributesFromContext(parentContext, span, record) {
+  const holder = parentContext.getValue(import_context.CONSUMER_HOLDER_KEY);
+  if (!holder?.identifier) {
+    return;
+  }
+  const consumer = normalizeConsumer({
+    identifier: holder.identifier,
+    name: holder.name,
+    group: holder.group
+  });
+  if (consumer) {
+    writeConsumerAttributes(span, record, consumer);
+  }
+}
+function writeConsumerAttributes(span, record, consumer) {
+  (0, import_requestAttributes.writeRequestAttribute)(span, record, CONSUMER_IDENTIFIER_ATTRIBUTE, consumer.identifier);
+  if (consumer.name) {
+    (0, import_requestAttributes.writeRequestAttribute)(span, record, CONSUMER_NAME_ATTRIBUTE, consumer.name);
+  }
+  if (consumer.group) {
+    (0, import_requestAttributes.writeRequestAttribute)(span, record, CONSUMER_GROUP_ATTRIBUTE, consumer.group);
+  }
+}
+function normalizeConsumer(consumer) {
+  if (typeof consumer === "object" && consumer !== null) {
+    const identifier2 = trimAndCap(consumer.identifier, 128);
+    if (!identifier2) {
+      return void 0;
+    }
+    return {
+      identifier: identifier2,
+      name: trimAndCap(consumer.name, 64),
+      group: trimAndCap(consumer.group, 64)
+    };
+  }
+  const identifier = trimAndCap(consumer, 128);
+  return identifier ? { identifier } : void 0;
+}
+function trimAndCap(value, maxLength) {
+  if (typeof value !== "string" && typeof value !== "number") {
+    return void 0;
+  }
+  return String(value).trim().slice(0, maxLength) || void 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setConsumer,
+  writeConsumerAttributesFromContext
+});
+//# sourceMappingURL=consumer.cjs.map

package/dist/consumer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/consumer.ts"],"sourcesContent":["import type { Context, Span } from \"@opentelemetry/api\";\nimport {\n  CONSUMER_HOLDER_KEY,\n  type ConsumerHolder,\n  getConsumerHolder,\n  getRequestRecord,\n  getServerSpan,\n  type RequestRecord,\n} from \"./context.js\";\nimport { logDebug } from \"./logger.js\";\nimport { writeRequestAttribute } from \"./requestAttributes.js\";\n\nexport interface ApitallyConsumer {\n  identifier: string;\n  name?: string | null;\n  group?: string | null;\n}\n\nconst CONSUMER_IDENTIFIER_ATTRIBUTE = \"apitally.consumer.identifier\";\nconst CONSUMER_NAME_ATTRIBUTE = \"apitally.consumer.name\";\nconst CONSUMER_GROUP_ATTRIBUTE = \"apitally.consumer.group\";\n\nexport function setConsumer(consumer: ApitallyConsumer | string | null | undefined): void {\n  try {\n    const holder = getConsumerHolder();\n    const record = getRequestRecord();\n    const normalized = normalizeConsumer(consumer);\n    if ((!holder && !record) || !normalized) {\n      return;\n    }\n    if (holder) {\n      holder.identifier = normalized.identifier;\n      holder.name = normalized.name;\n      holder.group = normalized.group;\n    }\n    writeConsumerAttributes(getServerSpan(), record, normalized);\n  } catch (error) {\n    logDebug(`Error setting consumer: ${String(error)}`);\n  }\n}\n\n// Applies a consumer inherited in the parent context when a SERVER span starts.\nexport function writeConsumerAttributesFromContext(\n  parentContext: Context,\n  span: Span,\n  record: RequestRecord | undefined,\n): void {\n  const holder = parentContext.getValue(CONSUMER_HOLDER_KEY) as ConsumerHolder | undefined;\n  if (!holder?.identifier) {\n    return;\n  }\n  const consumer = normalizeConsumer({\n    identifier: holder.identifier,\n    name: holder.name,\n    group: holder.group,\n  });\n  if (consumer) {\n    writeConsumerAttributes(span, record, consumer);\n  }\n}\n\nfunction writeConsumerAttributes(\n  span: Span | undefined,\n  record: RequestRecord | undefined,\n  consumer: ApitallyConsumer,\n): void {\n  writeRequestAttribute(span, record, CONSUMER_IDENTIFIER_ATTRIBUTE, consumer.identifier);\n  if (consumer.name) {\n    writeRequestAttribute(span, record, CONSUMER_NAME_ATTRIBUTE, consumer.name);\n  }\n  if (consumer.group) {\n    writeRequestAttribute(span, record, CONSUMER_GROUP_ATTRIBUTE, consumer.group);\n  }\n}\n\nfunction normalizeConsumer(consumer: ApitallyConsumer | string | number | null | undefined) {\n  if (typeof consumer === \"object\" && consumer !== null) {\n    const identifier = trimAndCap(consumer.identifier, 128);\n    if (!identifier) {\n      return undefined;\n    }\n    return {\n      identifier,\n      name: trimAndCap(consumer.name, 64),\n      group: trimAndCap(consumer.group, 64),\n    };\n  }\n  const identifier = trimAndCap(consumer, 128);\n  return identifier ? { identifier } : undefined;\n}\n\nfunction trimAndCap(value: unknown, maxLength: number): string | undefined {\n  if (typeof value !== \"string\" && typeof value !== \"number\") {\n    return undefined;\n  }\n  return String(value).trim().slice(0, maxLength) || undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,qBAOO;AACP,oBAAyB;AACzB,+BAAsC;AAQtC,MAAM,gCAAgC;AACtC,MAAM,0BAA0B;AAChC,MAAM,2BAA2B;AAE1B,SAAS,YAAY,UAA8D;AACxF,MAAI;AACF,UAAM,aAAS,kCAAkB;AACjC,UAAM,aAAS,iCAAiB;AAChC,UAAM,aAAa,kBAAkB,QAAQ;AAC7C,QAAK,CAAC,UAAU,CAAC,UAAW,CAAC,YAAY;AACvC;AAAA,IACF;AACA,QAAI,QAAQ;AACV,aAAO,aAAa,WAAW;AAC/B,aAAO,OAAO,WAAW;AACzB,aAAO,QAAQ,WAAW;AAAA,IAC5B;AACA,gCAAwB,8BAAc,GAAG,QAAQ,UAAU;AAAA,EAC7D,SAAS,OAAO;AACd,gCAAS,2BAA2B,OAAO,KAAK,CAAC,EAAE;AAAA,EACrD;AACF;AAGO,SAAS,mCACd,eACA,MACA,QACM;AACN,QAAM,SAAS,cAAc,SAAS,kCAAmB;AACzD,MAAI,CAAC,QAAQ,YAAY;AACvB;AAAA,EACF;AACA,QAAM,WAAW,kBAAkB;AAAA,IACjC,YAAY,OAAO;AAAA,IACnB,MAAM,OAAO;AAAA,IACb,OAAO,OAAO;AAAA,EAChB,CAAC;AACD,MAAI,UAAU;AACZ,4BAAwB,MAAM,QAAQ,QAAQ;AAAA,EAChD;AACF;AAEA,SAAS,wBACP,MACA,QACA,UACM;AACN,sDAAsB,MAAM,QAAQ,+BAA+B,SAAS,UAAU;AACtF,MAAI,SAAS,MAAM;AACjB,wDAAsB,MAAM,QAAQ,yBAAyB,SAAS,IAAI;AAAA,EAC5E;AACA,MAAI,SAAS,OAAO;AAClB,wDAAsB,MAAM,QAAQ,0BAA0B,SAAS,KAAK;AAAA,EAC9E;AACF;AAEA,SAAS,kBAAkB,UAAiE;AAC1F,MAAI,OAAO,aAAa,YAAY,aAAa,MAAM;AACrD,UAAMA,cAAa,WAAW,SAAS,YAAY,GAAG;AACtD,QAAI,CAACA,aAAY;AACf,aAAO;AAAA,IACT;AACA,WAAO;AAAA,MACL,YAAAA;AAAA,MACA,MAAM,WAAW,SAAS,MAAM,EAAE;AAAA,MAClC,OAAO,WAAW,SAAS,OAAO,EAAE;AAAA,IACtC;AAAA,EACF;AACA,QAAM,aAAa,WAAW,UAAU,GAAG;AAC3C,SAAO,aAAa,EAAE,WAAW,IAAI;AACvC;AAEA,SAAS,WAAW,OAAgB,WAAuC;AACzE,MAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAAU;AAC1D,WAAO;AAAA,EACT;AACA,SAAO,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,KAAK;AACrD;","names":["identifier"]}

package/dist/consumer.d.cts

@@ -0,0 +1,15 @@
+import { Context, Span } from '@opentelemetry/api';
+import { RequestRecord } from './context.cjs';
+import '@opentelemetry/core';
+import './validationErrors.cjs';
+import '@opentelemetry/api-logs';
+
+interface ApitallyConsumer {
+    identifier: string;
+    name?: string | null;
+    group?: string | null;
+}
+declare function setConsumer(consumer: ApitallyConsumer | string | null | undefined): void;
+declare function writeConsumerAttributesFromContext(parentContext: Context, span: Span, record: RequestRecord | undefined): void;
+
+export { type ApitallyConsumer, setConsumer, writeConsumerAttributesFromContext };

package/dist/consumer.d.ts

@@ -0,0 +1,15 @@
+import { Context, Span } from '@opentelemetry/api';
+import { RequestRecord } from './context.js';
+import '@opentelemetry/core';
+import './validationErrors.js';
+import '@opentelemetry/api-logs';
+
+interface ApitallyConsumer {
+    identifier: string;
+    name?: string | null;
+    group?: string | null;
+}
+declare function setConsumer(consumer: ApitallyConsumer | string | null | undefined): void;
+declare function writeConsumerAttributesFromContext(parentContext: Context, span: Span, record: RequestRecord | undefined): void;
+
+export { type ApitallyConsumer, setConsumer, writeConsumerAttributesFromContext };

package/dist/consumer.js

@@ -0,0 +1,78 @@
+import {
+  CONSUMER_HOLDER_KEY,
+  getConsumerHolder,
+  getRequestRecord,
+  getServerSpan
+} from "./context.js";
+import { logDebug } from "./logger.js";
+import { writeRequestAttribute } from "./requestAttributes.js";
+const CONSUMER_IDENTIFIER_ATTRIBUTE = "apitally.consumer.identifier";
+const CONSUMER_NAME_ATTRIBUTE = "apitally.consumer.name";
+const CONSUMER_GROUP_ATTRIBUTE = "apitally.consumer.group";
+function setConsumer(consumer) {
+  try {
+    const holder = getConsumerHolder();
+    const record = getRequestRecord();
+    const normalized = normalizeConsumer(consumer);
+    if (!holder && !record || !normalized) {
+      return;
+    }
+    if (holder) {
+      holder.identifier = normalized.identifier;
+      holder.name = normalized.name;
+      holder.group = normalized.group;
+    }
+    writeConsumerAttributes(getServerSpan(), record, normalized);
+  } catch (error) {
+    logDebug(`Error setting consumer: ${String(error)}`);
+  }
+}
+function writeConsumerAttributesFromContext(parentContext, span, record) {
+  const holder = parentContext.getValue(CONSUMER_HOLDER_KEY);
+  if (!holder?.identifier) {
+    return;
+  }
+  const consumer = normalizeConsumer({
+    identifier: holder.identifier,
+    name: holder.name,
+    group: holder.group
+  });
+  if (consumer) {
+    writeConsumerAttributes(span, record, consumer);
+  }
+}
+function writeConsumerAttributes(span, record, consumer) {
+  writeRequestAttribute(span, record, CONSUMER_IDENTIFIER_ATTRIBUTE, consumer.identifier);
+  if (consumer.name) {
+    writeRequestAttribute(span, record, CONSUMER_NAME_ATTRIBUTE, consumer.name);
+  }
+  if (consumer.group) {
+    writeRequestAttribute(span, record, CONSUMER_GROUP_ATTRIBUTE, consumer.group);
+  }
+}
+function normalizeConsumer(consumer) {
+  if (typeof consumer === "object" && consumer !== null) {
+    const identifier2 = trimAndCap(consumer.identifier, 128);
+    if (!identifier2) {
+      return void 0;
+    }
+    return {
+      identifier: identifier2,
+      name: trimAndCap(consumer.name, 64),
+      group: trimAndCap(consumer.group, 64)
+    };
+  }
+  const identifier = trimAndCap(consumer, 128);
+  return identifier ? { identifier } : void 0;
+}
+function trimAndCap(value, maxLength) {
+  if (typeof value !== "string" && typeof value !== "number") {
+    return void 0;
+  }
+  return String(value).trim().slice(0, maxLength) || void 0;
+}
+export {
+  setConsumer,
+  writeConsumerAttributesFromContext
+};
+//# sourceMappingURL=consumer.js.map

package/dist/consumer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/consumer.ts"],"sourcesContent":["import type { Context, Span } from \"@opentelemetry/api\";\nimport {\n  CONSUMER_HOLDER_KEY,\n  type ConsumerHolder,\n  getConsumerHolder,\n  getRequestRecord,\n  getServerSpan,\n  type RequestRecord,\n} from \"./context.js\";\nimport { logDebug } from \"./logger.js\";\nimport { writeRequestAttribute } from \"./requestAttributes.js\";\n\nexport interface ApitallyConsumer {\n  identifier: string;\n  name?: string | null;\n  group?: string | null;\n}\n\nconst CONSUMER_IDENTIFIER_ATTRIBUTE = \"apitally.consumer.identifier\";\nconst CONSUMER_NAME_ATTRIBUTE = \"apitally.consumer.name\";\nconst CONSUMER_GROUP_ATTRIBUTE = \"apitally.consumer.group\";\n\nexport function setConsumer(consumer: ApitallyConsumer | string | null | undefined): void {\n  try {\n    const holder = getConsumerHolder();\n    const record = getRequestRecord();\n    const normalized = normalizeConsumer(consumer);\n    if ((!holder && !record) || !normalized) {\n      return;\n    }\n    if (holder) {\n      holder.identifier = normalized.identifier;\n      holder.name = normalized.name;\n      holder.group = normalized.group;\n    }\n    writeConsumerAttributes(getServerSpan(), record, normalized);\n  } catch (error) {\n    logDebug(`Error setting consumer: ${String(error)}`);\n  }\n}\n\n// Applies a consumer inherited in the parent context when a SERVER span starts.\nexport function writeConsumerAttributesFromContext(\n  parentContext: Context,\n  span: Span,\n  record: RequestRecord | undefined,\n): void {\n  const holder = parentContext.getValue(CONSUMER_HOLDER_KEY) as ConsumerHolder | undefined;\n  if (!holder?.identifier) {\n    return;\n  }\n  const consumer = normalizeConsumer({\n    identifier: holder.identifier,\n    name: holder.name,\n    group: holder.group,\n  });\n  if (consumer) {\n    writeConsumerAttributes(span, record, consumer);\n  }\n}\n\nfunction writeConsumerAttributes(\n  span: Span | undefined,\n  record: RequestRecord | undefined,\n  consumer: ApitallyConsumer,\n): void {\n  writeRequestAttribute(span, record, CONSUMER_IDENTIFIER_ATTRIBUTE, consumer.identifier);\n  if (consumer.name) {\n    writeRequestAttribute(span, record, CONSUMER_NAME_ATTRIBUTE, consumer.name);\n  }\n  if (consumer.group) {\n    writeRequestAttribute(span, record, CONSUMER_GROUP_ATTRIBUTE, consumer.group);\n  }\n}\n\nfunction normalizeConsumer(consumer: ApitallyConsumer | string | number | null | undefined) {\n  if (typeof consumer === \"object\" && consumer !== null) {\n    const identifier = trimAndCap(consumer.identifier, 128);\n    if (!identifier) {\n      return undefined;\n    }\n    return {\n      identifier,\n      name: trimAndCap(consumer.name, 64),\n      group: trimAndCap(consumer.group, 64),\n    };\n  }\n  const identifier = trimAndCap(consumer, 128);\n  return identifier ? { identifier } : undefined;\n}\n\nfunction trimAndCap(value: unknown, maxLength: number): string | undefined {\n  if (typeof value !== \"string\" && typeof value !== \"number\") {\n    return undefined;\n  }\n  return String(value).trim().slice(0, maxLength) || undefined;\n}\n"],"mappings":"AACA;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,gBAAgB;AACzB,SAAS,6BAA6B;AAQtC,MAAM,gCAAgC;AACtC,MAAM,0BAA0B;AAChC,MAAM,2BAA2B;AAE1B,SAAS,YAAY,UAA8D;AACxF,MAAI;AACF,UAAM,SAAS,kBAAkB;AACjC,UAAM,SAAS,iBAAiB;AAChC,UAAM,aAAa,kBAAkB,QAAQ;AAC7C,QAAK,CAAC,UAAU,CAAC,UAAW,CAAC,YAAY;AACvC;AAAA,IACF;AACA,QAAI,QAAQ;AACV,aAAO,aAAa,WAAW;AAC/B,aAAO,OAAO,WAAW;AACzB,aAAO,QAAQ,WAAW;AAAA,IAC5B;AACA,4BAAwB,cAAc,GAAG,QAAQ,UAAU;AAAA,EAC7D,SAAS,OAAO;AACd,aAAS,2BAA2B,OAAO,KAAK,CAAC,EAAE;AAAA,EACrD;AACF;AAGO,SAAS,mCACd,eACA,MACA,QACM;AACN,QAAM,SAAS,cAAc,SAAS,mBAAmB;AACzD,MAAI,CAAC,QAAQ,YAAY;AACvB;AAAA,EACF;AACA,QAAM,WAAW,kBAAkB;AAAA,IACjC,YAAY,OAAO;AAAA,IACnB,MAAM,OAAO;AAAA,IACb,OAAO,OAAO;AAAA,EAChB,CAAC;AACD,MAAI,UAAU;AACZ,4BAAwB,MAAM,QAAQ,QAAQ;AAAA,EAChD;AACF;AAEA,SAAS,wBACP,MACA,QACA,UACM;AACN,wBAAsB,MAAM,QAAQ,+BAA+B,SAAS,UAAU;AACtF,MAAI,SAAS,MAAM;AACjB,0BAAsB,MAAM,QAAQ,yBAAyB,SAAS,IAAI;AAAA,EAC5E;AACA,MAAI,SAAS,OAAO;AAClB,0BAAsB,MAAM,QAAQ,0BAA0B,SAAS,KAAK;AAAA,EAC9E;AACF;AAEA,SAAS,kBAAkB,UAAiE;AAC1F,MAAI,OAAO,aAAa,YAAY,aAAa,MAAM;AACrD,UAAMA,cAAa,WAAW,SAAS,YAAY,GAAG;AACtD,QAAI,CAACA,aAAY;AACf,aAAO;AAAA,IACT;AACA,WAAO;AAAA,MACL,YAAAA;AAAA,MACA,MAAM,WAAW,SAAS,MAAM,EAAE;AAAA,MAClC,OAAO,WAAW,SAAS,OAAO,EAAE;AAAA,IACtC;AAAA,EACF;AACA,QAAM,aAAa,WAAW,UAAU,GAAG;AAC3C,SAAO,aAAa,EAAE,WAAW,IAAI;AACvC;AAEA,SAAS,WAAW,OAAgB,WAAuC;AACzE,MAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAAU;AAC1D,WAAO;AAAA,EACT;AACA,SAAO,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,KAAK;AACrD;","names":["identifier"]}

package/dist/context.cjs

@@ -0,0 +1,68 @@
+"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 context_exports = {};
+__export(context_exports, {
+  CONSUMER_HOLDER_KEY: () => CONSUMER_HOLDER_KEY,
+  REQUEST_RECORD_KEY: () => REQUEST_RECORD_KEY,
+  SPAN_HANDLE_KEY: () => SPAN_HANDLE_KEY,
+  attachRequestRecordToRpcMetadata: () => attachRequestRecordToRpcMetadata,
+  getConsumerHolder: () => getConsumerHolder,
+  getRequestRecord: () => getRequestRecord,
+  getServerSpan: () => getServerSpan,
+  withRequestHolders: () => withRequestHolders
+});
+module.exports = __toCommonJS(context_exports);
+var import_api = require("@opentelemetry/api");
+var import_core = require("@opentelemetry/core");
+const SPAN_HANDLE_KEY = (0, import_api.createContextKey)("apitally-span-handle");
+const REQUEST_RECORD_KEY = (0, import_api.createContextKey)("apitally-request-record");
+const CONSUMER_HOLDER_KEY = (0, import_api.createContextKey)("apitally-consumer-holder");
+const RPC_REQUEST_RECORD_KEY = /* @__PURE__ */ Symbol.for("apitally.rpcRequestRecord");
+function withRequestHolders(baseContext, spanHandle, record, consumerHolder) {
+  return baseContext.setValue(SPAN_HANDLE_KEY, spanHandle).setValue(REQUEST_RECORD_KEY, record).setValue(CONSUMER_HOLDER_KEY, consumerHolder);
+}
+function attachRequestRecordToRpcMetadata(rpcMetadata, record) {
+  if (rpcMetadata) {
+    rpcMetadata[RPC_REQUEST_RECORD_KEY] = record;
+  }
+}
+function getServerSpan(activeContext = import_api.context.active()) {
+  const spanHandle = activeContext.getValue(SPAN_HANDLE_KEY);
+  const rpcMetadata = (0, import_core.getRPCMetadata)(activeContext);
+  return spanHandle?.span ?? (rpcMetadata?.type === import_core.RPCType.HTTP && rpcMetadata[RPC_REQUEST_RECORD_KEY] ? rpcMetadata.span : void 0);
+}
+function getRequestRecord(activeContext = import_api.context.active()) {
+  const rpcMetadata = (0, import_core.getRPCMetadata)(activeContext);
+  return activeContext.getValue(REQUEST_RECORD_KEY) ?? rpcMetadata?.[RPC_REQUEST_RECORD_KEY];
+}
+function getConsumerHolder(activeContext = import_api.context.active()) {
+  return activeContext.getValue(CONSUMER_HOLDER_KEY);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CONSUMER_HOLDER_KEY,
+  REQUEST_RECORD_KEY,
+  SPAN_HANDLE_KEY,
+  attachRequestRecordToRpcMetadata,
+  getConsumerHolder,
+  getRequestRecord,
+  getServerSpan,
+  withRequestHolders
+});
+//# sourceMappingURL=context.cjs.map

package/dist/context.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/context.ts"],"sourcesContent":["import {\n  type Attributes,\n  type Context,\n  context,\n  createContextKey,\n  type Span,\n} from \"@opentelemetry/api\";\nimport { getRPCMetadata, type RPCMetadata, RPCType } from \"@opentelemetry/core\";\nimport type { ValidationErrorDetail } from \"./validationErrors.js\";\n\n// Write sites resolve the request's SERVER span through this handle: under a child\n// span, the active span is not the SERVER span, and OTel has no public upward walk.\nexport interface SpanHandle {\n  span?: Span;\n  // This set-once reference preserves lifecycle ownership if span later changes.\n  ownSpan?: Span;\n}\n\nexport interface ConsumerHolder {\n  identifier?: string;\n  name?: string;\n  group?: string;\n}\n\n// Requests dropped for these reasons are still counted in request metrics,\n// except preflight and websocket requests, which are never recorded.\nexport type RequestDropReason = \"excluded\" | \"method\" | \"scheme\" | \"sampled-out\";\n\n// Transport attributes are applied to exported spans last and used for metrics,\n// so transport values take precedence.\nexport interface RequestRecord {\n  attributes: Attributes;\n  serverSpanId?: string;\n  // Transport-measured request duration, set at completion; the duration\n  // histogram records it independent of span timing.\n  durationSeconds?: number;\n  dropReason?: RequestDropReason;\n  // Error state for the validation and server error events; it exists\n  // independently of the SERVER span and of the drop decision.\n  exception?: unknown;\n  validationErrors?: ValidationErrorDetail[];\n}\n\nexport const SPAN_HANDLE_KEY = createContextKey(\"apitally-span-handle\");\nexport const REQUEST_RECORD_KEY = createContextKey(\"apitally-request-record\");\nexport const CONSUMER_HOLDER_KEY = createContextKey(\"apitally-consumer-holder\");\n\nconst RPC_REQUEST_RECORD_KEY = Symbol.for(\"apitally.rpcRequestRecord\");\n\ntype RPCMetadataWithRequestRecord = RPCMetadata & {\n  [RPC_REQUEST_RECORD_KEY]?: RequestRecord;\n};\n\n// Mutable holders carry changing request state because OTel contexts are immutable.\nexport function withRequestHolders(\n  baseContext: Context,\n  spanHandle: SpanHandle,\n  record: RequestRecord,\n  consumerHolder: ConsumerHolder,\n): Context {\n  return baseContext\n    .setValue(SPAN_HANDLE_KEY, spanHandle)\n    .setValue(REQUEST_RECORD_KEY, record)\n    .setValue(CONSUMER_HOLDER_KEY, consumerHolder);\n}\n\nexport function attachRequestRecordToRpcMetadata(\n  rpcMetadata: RPCMetadata | undefined,\n  record: RequestRecord,\n): void {\n  if (rpcMetadata) {\n    (rpcMetadata as RPCMetadataWithRequestRecord)[RPC_REQUEST_RECORD_KEY] = record;\n  }\n}\n\nexport function getServerSpan(activeContext: Context = context.active()): Span | undefined {\n  const spanHandle = activeContext.getValue(SPAN_HANDLE_KEY) as SpanHandle | undefined;\n  const rpcMetadata = getRPCMetadata(activeContext) as RPCMetadataWithRequestRecord | undefined;\n  return (\n    spanHandle?.span ??\n    (rpcMetadata?.type === RPCType.HTTP && rpcMetadata[RPC_REQUEST_RECORD_KEY]\n      ? rpcMetadata.span\n      : undefined)\n  );\n}\n\nexport function getRequestRecord(\n  activeContext: Context = context.active(),\n): RequestRecord | undefined {\n  const rpcMetadata = getRPCMetadata(activeContext) as RPCMetadataWithRequestRecord | undefined;\n  return (\n    (activeContext.getValue(REQUEST_RECORD_KEY) as RequestRecord | undefined) ??\n    rpcMetadata?.[RPC_REQUEST_RECORD_KEY]\n  );\n}\n\nexport function getConsumerHolder(\n  activeContext: Context = context.active(),\n): ConsumerHolder | undefined {\n  return activeContext.getValue(CONSUMER_HOLDER_KEY) as ConsumerHolder | undefined;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAMO;AACP,kBAA0D;AAoCnD,MAAM,sBAAkB,6BAAiB,sBAAsB;AAC/D,MAAM,yBAAqB,6BAAiB,yBAAyB;AACrE,MAAM,0BAAsB,6BAAiB,0BAA0B;AAE9E,MAAM,yBAAyB,uBAAO,IAAI,2BAA2B;AAO9D,SAAS,mBACd,aACA,YACA,QACA,gBACS;AACT,SAAO,YACJ,SAAS,iBAAiB,UAAU,EACpC,SAAS,oBAAoB,MAAM,EACnC,SAAS,qBAAqB,cAAc;AACjD;AAEO,SAAS,iCACd,aACA,QACM;AACN,MAAI,aAAa;AACf,IAAC,YAA6C,sBAAsB,IAAI;AAAA,EAC1E;AACF;AAEO,SAAS,cAAc,gBAAyB,mBAAQ,OAAO,GAAqB;AACzF,QAAM,aAAa,cAAc,SAAS,eAAe;AACzD,QAAM,kBAAc,4BAAe,aAAa;AAChD,SACE,YAAY,SACX,aAAa,SAAS,oBAAQ,QAAQ,YAAY,sBAAsB,IACrE,YAAY,OACZ;AAER;AAEO,SAAS,iBACd,gBAAyB,mBAAQ,OAAO,GACb;AAC3B,QAAM,kBAAc,4BAAe,aAAa;AAChD,SACG,cAAc,SAAS,kBAAkB,KAC1C,cAAc,sBAAsB;AAExC;AAEO,SAAS,kBACd,gBAAyB,mBAAQ,OAAO,GACZ;AAC5B,SAAO,cAAc,SAAS,mBAAmB;AACnD;","names":[]}

package/dist/context.d.cts

@@ -0,0 +1,33 @@
+import { Attributes, Span, Context } from '@opentelemetry/api';
+import { RPCMetadata } from '@opentelemetry/core';
+import { ValidationErrorDetail } from './validationErrors.cjs';
+import '@opentelemetry/api-logs';
+
+interface SpanHandle {
+    span?: Span;
+    ownSpan?: Span;
+}
+interface ConsumerHolder {
+    identifier?: string;
+    name?: string;
+    group?: string;
+}
+type RequestDropReason = "excluded" | "method" | "scheme" | "sampled-out";
+interface RequestRecord {
+    attributes: Attributes;
+    serverSpanId?: string;
+    durationSeconds?: number;
+    dropReason?: RequestDropReason;
+    exception?: unknown;
+    validationErrors?: ValidationErrorDetail[];
+}
+declare const SPAN_HANDLE_KEY: symbol;
+declare const REQUEST_RECORD_KEY: symbol;
+declare const CONSUMER_HOLDER_KEY: symbol;
+declare function withRequestHolders(baseContext: Context, spanHandle: SpanHandle, record: RequestRecord, consumerHolder: ConsumerHolder): Context;
+declare function attachRequestRecordToRpcMetadata(rpcMetadata: RPCMetadata | undefined, record: RequestRecord): void;
+declare function getServerSpan(activeContext?: Context): Span | undefined;
+declare function getRequestRecord(activeContext?: Context): RequestRecord | undefined;
+declare function getConsumerHolder(activeContext?: Context): ConsumerHolder | undefined;
+
+export { CONSUMER_HOLDER_KEY, type ConsumerHolder, REQUEST_RECORD_KEY, type RequestDropReason, type RequestRecord, SPAN_HANDLE_KEY, type SpanHandle, attachRequestRecordToRpcMetadata, getConsumerHolder, getRequestRecord, getServerSpan, withRequestHolders };

package/dist/context.d.ts

@@ -0,0 +1,33 @@
+import { Attributes, Span, Context } from '@opentelemetry/api';
+import { RPCMetadata } from '@opentelemetry/core';
+import { ValidationErrorDetail } from './validationErrors.js';
+import '@opentelemetry/api-logs';
+
+interface SpanHandle {
+    span?: Span;
+    ownSpan?: Span;
+}
+interface ConsumerHolder {
+    identifier?: string;
+    name?: string;
+    group?: string;
+}
+type RequestDropReason = "excluded" | "method" | "scheme" | "sampled-out";
+interface RequestRecord {
+    attributes: Attributes;
+    serverSpanId?: string;
+    durationSeconds?: number;
+    dropReason?: RequestDropReason;
+    exception?: unknown;
+    validationErrors?: ValidationErrorDetail[];
+}
+declare const SPAN_HANDLE_KEY: symbol;
+declare const REQUEST_RECORD_KEY: symbol;
+declare const CONSUMER_HOLDER_KEY: symbol;
+declare function withRequestHolders(baseContext: Context, spanHandle: SpanHandle, record: RequestRecord, consumerHolder: ConsumerHolder): Context;
+declare function attachRequestRecordToRpcMetadata(rpcMetadata: RPCMetadata | undefined, record: RequestRecord): void;
+declare function getServerSpan(activeContext?: Context): Span | undefined;
+declare function getRequestRecord(activeContext?: Context): RequestRecord | undefined;
+declare function getConsumerHolder(activeContext?: Context): ConsumerHolder | undefined;
+
+export { CONSUMER_HOLDER_KEY, type ConsumerHolder, REQUEST_RECORD_KEY, type RequestDropReason, type RequestRecord, SPAN_HANDLE_KEY, type SpanHandle, attachRequestRecordToRpcMetadata, getConsumerHolder, getRequestRecord, getServerSpan, withRequestHolders };