@sanity/sdk 2.8.0 → 2.10.0

package/dist/_chunks-es/_internal.js

@@ -0,0 +1,129 @@
+import { createLogger } from "./createGroqSearchFilter.js";
+import { defineEvent } from "@sanity/telemetry";
+function isLocalUrl(win) {
+  const url = win.location?.href;
+  return url ? url.startsWith("http://localhost") || url.startsWith("https://localhost") || url.startsWith("http://127.0.0.1") || url.startsWith("https://127.0.0.1") : !1;
+}
+function isDevMode() {
+  return typeof process < "u" && process.env?.NODE_ENV === "production" ? !1 : typeof window < "u" ? isLocalUrl(window) : typeof process < "u" && process.env?.NODE_ENV === "development";
+}
+const SDKDevSessionStarted = defineEvent({
+  name: "SDK Dev Session Started",
+  version: 1,
+  description: "SDK instance created in development mode"
+}), SDKHookMounted = defineEvent({
+  name: "SDK Hook Mounted",
+  version: 1,
+  description: "An SDK hook was mounted for the first time in this session"
+}), SDKDevSessionEnded = defineEvent({
+  name: "SDK Dev Session Ended",
+  version: 1,
+  description: "SDK instance disposed in development mode"
+}), SDKDevError = defineEvent({
+  name: "SDK Dev Error",
+  version: 1,
+  description: "Runtime error caught during SDK development"
+}), DEFAULT_TELEMETRY_API_VERSION = "2024-11-12", logger = createLogger("telemetry"), telemetryManagers = /* @__PURE__ */ new WeakMap(), pendingHooks = /* @__PURE__ */ new WeakMap(), initInFlight = /* @__PURE__ */ new WeakSet();
+function initTelemetry(instance, projectId) {
+  if (!isDevMode()) {
+    logger.trace("initTelemetry skipped: not dev mode", { internal: !0 });
+    return;
+  }
+  if (!projectId) {
+    logger.trace("initTelemetry skipped: no projectId", { internal: !0 });
+    return;
+  }
+  telemetryManagers.has(instance) || initInFlight.has(instance) || (initInFlight.add(instance), logger.debug("initializing telemetry", { projectId }), Promise.all([
+    import("./telemetryManager.js"),
+    import("./createGroqSearchFilter.js").then(function(n) {
+      return n.clientStore;
+    }),
+    import("./createGroqSearchFilter.js").then(function(n) {
+      return n.authStore$1;
+    })
+  ]).then(async ([{ createTelemetryManager }, { getClient }, { getTokenState }]) => {
+    if (instance.isDisposed()) {
+      initInFlight.delete(instance), logger.debug("telemetry skipped: instance disposed before imports resolved");
+      return;
+    }
+    const token = getTokenState(instance).getCurrent();
+    if (logger.trace("auth token check", { tokenPresent: !!token, internal: !0 }), !token && (logger.debug("waiting for auth token"), !await new Promise((resolve) => {
+      if (instance.isDisposed()) return resolve(!1);
+      const cleanup = { unsubscribe: () => {
+      } }, unsub = instance.onDispose(() => {
+        cleanup.unsubscribe(), resolve(!1);
+      }), sub = getTokenState(instance).observable.subscribe((t) => {
+        t && (logger.debug("auth token received"), sub.unsubscribe(), unsub(), resolve(!0));
+      });
+      cleanup.unsubscribe = () => sub.unsubscribe();
+    }) || instance.isDisposed())) {
+      initInFlight.delete(instance), logger.debug("telemetry skipped: no token resolved or instance disposed");
+      return;
+    }
+    const manager = createTelemetryManager({
+      sessionId: instance.instanceId,
+      getClient: () => getClient(instance, { apiVersion: DEFAULT_TELEMETRY_API_VERSION }),
+      projectId
+    }), consented = await manager.checkConsent();
+    if (logger.debug("consent check complete", { consented }), !consented || instance.isDisposed()) {
+      initInFlight.delete(instance), manager.dispose();
+      return;
+    }
+    initInFlight.delete(instance), telemetryManagers.set(instance, manager);
+    const buffered = pendingHooks.get(instance);
+    if (buffered) {
+      logger.debug("flushing buffered hooks", { hooks: Array.from(buffered) });
+      for (const hookName of buffered)
+        manager.logHookFirstUsed(hookName);
+      pendingHooks.delete(instance);
+    }
+    const config = instance.config, perspective = typeof config.perspective == "string" ? config.perspective : "published", authMethod = config.auth?.token ? "token" : config.studio?.auth?.token ? "studio" : "default";
+    logger.info("telemetry session started", { projectId, perspective, authMethod }), manager.logSessionStarted({
+      projectId,
+      perspective,
+      authMethod
+    }), instance.onDispose(() => {
+      manager.endSession(), telemetryManagers.delete(instance), logger.debug("telemetry session ended");
+    });
+  }).catch((err) => {
+    initInFlight.delete(instance), logger.warn("telemetry init failed", { error: err });
+  }));
+}
+function getTelemetryManager(instance) {
+  return telemetryManagers.get(instance);
+}
+function trackHookMounted(instance, hookName) {
+  if (!isDevMode()) return;
+  const manager = findManager(instance);
+  if (manager) {
+    logger.trace("hook mounted (logged)", { hookName, internal: !0 }), manager.logHookFirstUsed(hookName);
+    return;
+  }
+  const root = getRootInstance(instance);
+  let hooks = pendingHooks.get(root);
+  hooks || (hooks = /* @__PURE__ */ new Set(), pendingHooks.set(root, hooks)), hooks.has(hookName) || logger.trace("hook mounted (buffered)", { hookName, internal: !0 }), hooks.add(hookName);
+}
+function findManager(instance) {
+  let current = instance;
+  for (; current; ) {
+    const manager = telemetryManagers.get(current);
+    if (manager) return manager;
+    current = typeof current.getParent == "function" ? current.getParent() : void 0;
+  }
+}
+function getRootInstance(instance) {
+  let current = instance;
+  for (; typeof current.getParent == "function" && current.getParent(); )
+    current = current.getParent();
+  return current;
+}
+export {
+  SDKDevError,
+  SDKDevSessionEnded,
+  SDKDevSessionStarted,
+  SDKHookMounted,
+  getTelemetryManager,
+  initTelemetry,
+  trackHookMounted
+};
+//# sourceMappingURL=_internal.js.map

package/dist/_chunks-es/_internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_internal.js","sources":["../../src/telemetry/devMode.ts","../../src/telemetry/__telemetry__/sdk.telemetry.ts","../../src/telemetry/initTelemetry.ts"],"sourcesContent":["/**\n * Checks whether the current URL points to a local development server.\n *\n * @param win - The window object to check\n * @returns True if running on localhost or 127.0.0.1\n * @internal\n */\nfunction isLocalUrl(win: Window): boolean {\n  const url = win.location?.href\n  if (!url) return false\n  return (\n    url.startsWith('http://localhost') ||\n    url.startsWith('https://localhost') ||\n    url.startsWith('http://127.0.0.1') ||\n    url.startsWith('https://127.0.0.1')\n  )\n}\n\n/**\n * Determines whether the SDK should enable dev-mode telemetry.\n *\n * Combines a browser URL check (localhost/127.0.0.1) with a Node.js\n * environment variable check (`NODE_ENV === 'development'`). Returns\n * false in production environments so bundlers can tree-shake the\n * telemetry code path entirely.\n *\n * @returns True if the SDK is running in a development environment\n * @internal\n */\nexport function isDevMode(): boolean {\n  if (typeof process !== 'undefined' && process.env?.['NODE_ENV'] === 'production') {\n    return false\n  }\n\n  if (typeof window !== 'undefined') {\n    return isLocalUrl(window)\n  }\n\n  return typeof process !== 'undefined' && process.env?.['NODE_ENV'] === 'development'\n}\n","import {defineEvent} from '@sanity/telemetry'\n\n/** @internal */\nexport const SDKDevSessionStarted = defineEvent<{\n  version: string\n  projectId: string\n  perspective: string\n  authMethod: string\n}>({\n  name: 'SDK Dev Session Started',\n  version: 1,\n  description: 'SDK instance created in development mode',\n})\n\n/** @internal */\nexport const SDKHookMounted = defineEvent<{\n  hookName: string\n}>({\n  name: 'SDK Hook Mounted',\n  version: 1,\n  description: 'An SDK hook was mounted for the first time in this session',\n})\n\n/** @internal */\nexport const SDKDevSessionEnded = defineEvent<{\n  durationSeconds: number\n  hooksUsed: string[]\n}>({\n  name: 'SDK Dev Session Ended',\n  version: 1,\n  description: 'SDK instance disposed in development mode',\n})\n\n/** @internal */\nexport const SDKDevError = defineEvent<{\n  errorType: string\n  hookName: string\n}>({\n  name: 'SDK Dev Error',\n  version: 1,\n  description: 'Runtime error caught during SDK development',\n})\n","import {type SanityInstance} from '../store/createSanityInstance'\nimport {createLogger} from '../utils/logger'\nimport {isDevMode} from './devMode'\nimport {type TelemetryManager} from './telemetryManager'\n\nconst DEFAULT_TELEMETRY_API_VERSION = '2024-11-12'\n\nconst logger = createLogger('telemetry')\n\n/**\n * Per-instance map of active telemetry managers. Allows the React\n * package (and other consumers) to look up the manager for a given\n * instance and log hook usage / errors without importing the full\n * telemetry module themselves.\n *\n * @internal\n */\nconst telemetryManagers = new WeakMap<SanityInstance, TelemetryManager>()\nconst pendingHooks = new WeakMap<SanityInstance, Set<string>>()\nconst initInFlight = new WeakSet<SanityInstance>()\n\n/**\n * Initializes dev-mode telemetry for a SDK instance if the environment\n * qualifies. Both `telemetryManager` and `clientStore` are dynamically\n * imported to avoid circular dependencies and to keep telemetry code\n * out of production bundles via code splitting.\n *\n * The `projectId` must be passed explicitly because the resource\n * configuration is typically set by the React layer after the\n * instance has already been created.\n *\n * @internal\n */\nexport function initTelemetry(instance: SanityInstance, projectId: string): void {\n  if (!isDevMode()) {\n    logger.trace('initTelemetry skipped: not dev mode', {internal: true})\n    return\n  }\n  if (!projectId) {\n    logger.trace('initTelemetry skipped: no projectId', {internal: true})\n    return\n  }\n  if (telemetryManagers.has(instance) || initInFlight.has(instance)) {\n    return\n  }\n  initInFlight.add(instance)\n\n  logger.debug('initializing telemetry', {projectId})\n\n  Promise.all([\n    import('./telemetryManager'),\n    import('../client/clientStore'),\n    import('../auth/authStore'),\n  ])\n    .then(async ([{createTelemetryManager}, {getClient}, {getTokenState}]) => {\n      if (instance.isDisposed()) {\n        initInFlight.delete(instance)\n        logger.debug('telemetry skipped: instance disposed before imports resolved')\n        return\n      }\n\n      // Wait for the auth store to resolve a token. The client needs a\n      // Bearer token for the consent check and batch POSTs. If the token\n      // is already available (e.g. static token config), this resolves\n      // immediately. For OAuth/localStorage discovery it waits for the\n      // first emission. For unauthenticated apps the promise never\n      // resolves, which is fine since telemetry requires auth anyway.\n      const token = getTokenState(instance).getCurrent()\n      logger.trace('auth token check', {tokenPresent: !!token, internal: true})\n\n      if (!token) {\n        logger.debug('waiting for auth token')\n        const hasToken = await new Promise<boolean>((resolve) => {\n          if (instance.isDisposed()) return resolve(false)\n          const cleanup = {unsubscribe: () => {}}\n          const unsub = instance.onDispose(() => {\n            cleanup.unsubscribe()\n            resolve(false)\n          })\n          const sub = getTokenState(instance).observable.subscribe((t) => {\n            if (t) {\n              logger.debug('auth token received')\n              sub.unsubscribe()\n              unsub()\n              resolve(true)\n            }\n          })\n          cleanup.unsubscribe = () => sub.unsubscribe()\n        })\n        if (!hasToken || instance.isDisposed()) {\n          initInFlight.delete(instance)\n          logger.debug('telemetry skipped: no token resolved or instance disposed')\n          return\n        }\n      }\n\n      const manager = createTelemetryManager({\n        sessionId: instance.instanceId,\n        getClient: () => getClient(instance, {apiVersion: DEFAULT_TELEMETRY_API_VERSION}),\n        projectId,\n      })\n\n      const consented = await manager.checkConsent()\n      logger.debug('consent check complete', {consented})\n      if (!consented || instance.isDisposed()) {\n        initInFlight.delete(instance)\n        manager.dispose()\n        return\n      }\n\n      initInFlight.delete(instance)\n      telemetryManagers.set(instance, manager)\n\n      const buffered = pendingHooks.get(instance)\n      if (buffered) {\n        logger.debug('flushing buffered hooks', {hooks: Array.from(buffered)})\n        for (const hookName of buffered) {\n          manager.logHookFirstUsed(hookName)\n        }\n        pendingHooks.delete(instance)\n      }\n\n      const config = instance.config\n      const perspective = typeof config.perspective === 'string' ? config.perspective : 'published'\n      const authMethod = config.auth?.token\n        ? 'token'\n        : config.studio?.auth?.token\n          ? 'studio'\n          : 'default'\n\n      logger.info('telemetry session started', {projectId, perspective, authMethod})\n      manager.logSessionStarted({\n        projectId,\n        perspective,\n        authMethod,\n      })\n\n      instance.onDispose(() => {\n        manager.endSession()\n        telemetryManagers.delete(instance)\n        logger.debug('telemetry session ended')\n      })\n    })\n    .catch((err) => {\n      initInFlight.delete(instance)\n      logger.warn('telemetry init failed', {error: err})\n    })\n}\n\n/**\n * Retrieves the telemetry manager for an instance, if one exists.\n * Returns undefined when telemetry is disabled or not yet initialized.\n *\n * @internal\n */\nexport function getTelemetryManager(instance: SanityInstance): TelemetryManager | undefined {\n  return telemetryManagers.get(instance)\n}\n\n/**\n * Record a hook name for an instance. If the telemetry manager is\n * already initialized the event is logged immediately. Otherwise\n * the name is buffered and flushed when init completes.\n *\n * @internal\n */\nexport function trackHookMounted(instance: SanityInstance, hookName: string): void {\n  if (!isDevMode()) return\n\n  const manager = findManager(instance)\n  if (manager) {\n    logger.trace('hook mounted (logged)', {hookName, internal: true})\n    manager.logHookFirstUsed(hookName)\n    return\n  }\n\n  const root = getRootInstance(instance)\n  let hooks = pendingHooks.get(root)\n  if (!hooks) {\n    hooks = new Set()\n    pendingHooks.set(root, hooks)\n  }\n  if (!hooks.has(hookName)) {\n    logger.trace('hook mounted (buffered)', {hookName, internal: true})\n  }\n  hooks.add(hookName)\n}\n\nfunction findManager(instance: SanityInstance): TelemetryManager | undefined {\n  let current: SanityInstance | undefined = instance\n  while (current) {\n    const manager = telemetryManagers.get(current)\n    if (manager) return manager\n    current = typeof current.getParent === 'function' ? current.getParent() : undefined\n  }\n  return undefined\n}\n\nfunction getRootInstance(instance: SanityInstance): SanityInstance {\n  let current = instance\n  while (typeof current.getParent === 'function' && current.getParent()) {\n    current = current.getParent()!\n  }\n  return current\n}\n"],"names":[],"mappings":";;AAOA,SAAS,WAAW,KAAsB;AACxC,QAAM,MAAM,IAAI,UAAU;AAC1B,SAAK,MAEH,IAAI,WAAW,kBAAkB,KACjC,IAAI,WAAW,mBAAmB,KAClC,IAAI,WAAW,kBAAkB,KACjC,IAAI,WAAW,mBAAmB,IALnB;AAOnB;AAaO,SAAS,YAAqB;AACnC,SAAI,OAAO,UAAY,OAAe,QAAQ,KAAM,aAAgB,eAC3D,KAGL,OAAO,SAAW,MACb,WAAW,MAAM,IAGnB,OAAO,UAAY,OAAe,QAAQ,KAAM,aAAgB;AACzE;ACpCO,MAAM,uBAAuB,YAKjC;AAAA,EACD,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GAGY,iBAAiB,YAE3B;AAAA,EACD,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GAGY,qBAAqB,YAG/B;AAAA,EACD,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GAGY,cAAc,YAGxB;AAAA,EACD,MAAM;AAAA,EACN,SAAS;AAAA,EACT,aAAa;AACf,CAAC,GCpCK,gCAAgC,cAEhC,SAAS,aAAa,WAAW,GAUjC,oBAAoB,oBAAI,QAAA,GACxB,eAAe,oBAAI,QAAA,GACnB,mCAAmB,QAAA;AAclB,SAAS,cAAc,UAA0B,WAAyB;AAC/E,MAAI,CAAC,aAAa;AAChB,WAAO,MAAM,uCAAuC,EAAC,UAAU,IAAK;AACpE;AAAA,EACF;AACA,MAAI,CAAC,WAAW;AACd,WAAO,MAAM,uCAAuC,EAAC,UAAU,IAAK;AACpE;AAAA,EACF;AACI,oBAAkB,IAAI,QAAQ,KAAK,aAAa,IAAI,QAAQ,MAGhE,aAAa,IAAI,QAAQ,GAEzB,OAAO,MAAM,0BAA0B,EAAC,WAAU,GAElD,QAAQ,IAAI;AAAA,IACV,OAAO,uBAAoB;AAAA,IAC3B,OAAO,6BAAuB,EAAA,KAAA,SAAA,GAAA;AAAA,aAAA,EAAA;AAAA,IAAA,CAAA;AAAA,IAC9B,OAAO,6BAAmB,EAAA,KAAA,SAAA,GAAA;AAAA,aAAA,EAAA;AAAA,IAAA,CAAA;AAAA,EAAA,CAC3B,EACE,KAAK,OAAO,CAAC,EAAC,uBAAA,GAAyB,EAAC,UAAA,GAAY,EAAC,cAAA,CAAc,MAAM;AACxE,QAAI,SAAS,cAAc;AACzB,mBAAa,OAAO,QAAQ,GAC5B,OAAO,MAAM,8DAA8D;AAC3E;AAAA,IACF;AAQA,UAAM,QAAQ,cAAc,QAAQ,EAAE,WAAA;AAGtC,QAFA,OAAO,MAAM,oBAAoB,EAAC,cAAc,CAAC,CAAC,OAAO,UAAU,GAAA,CAAK,GAEpE,CAAC,UACH,OAAO,MAAM,wBAAwB,GAkBjC,CAjBa,MAAM,IAAI,QAAiB,CAAC,YAAY;AACvD,UAAI,SAAS,WAAA,EAAc,QAAO,QAAQ,EAAK;AAC/C,YAAM,UAAU,EAAC,aAAa,MAAM;AAAA,MAAC,KAC/B,QAAQ,SAAS,UAAU,MAAM;AACrC,gBAAQ,YAAA,GACR,QAAQ,EAAK;AAAA,MACf,CAAC,GACK,MAAM,cAAc,QAAQ,EAAE,WAAW,UAAU,CAAC,MAAM;AAC1D,cACF,OAAO,MAAM,qBAAqB,GAClC,IAAI,YAAA,GACJ,MAAA,GACA,QAAQ,EAAI;AAAA,MAEhB,CAAC;AACD,cAAQ,cAAc,MAAM,IAAI,YAAA;AAAA,IAClC,CAAC,KACgB,SAAS,WAAA,IAAc;AACtC,mBAAa,OAAO,QAAQ,GAC5B,OAAO,MAAM,2DAA2D;AACxE;AAAA,IACF;AAGF,UAAM,UAAU,uBAAuB;AAAA,MACrC,WAAW,SAAS;AAAA,MACpB,WAAW,MAAM,UAAU,UAAU,EAAC,YAAY,+BAA8B;AAAA,MAChF;AAAA,IAAA,CACD,GAEK,YAAY,MAAM,QAAQ,aAAA;AAEhC,QADA,OAAO,MAAM,0BAA0B,EAAC,WAAU,GAC9C,CAAC,aAAa,SAAS,cAAc;AACvC,mBAAa,OAAO,QAAQ,GAC5B,QAAQ,QAAA;AACR;AAAA,IACF;AAEA,iBAAa,OAAO,QAAQ,GAC5B,kBAAkB,IAAI,UAAU,OAAO;AAEvC,UAAM,WAAW,aAAa,IAAI,QAAQ;AAC1C,QAAI,UAAU;AACZ,aAAO,MAAM,2BAA2B,EAAC,OAAO,MAAM,KAAK,QAAQ,GAAE;AACrE,iBAAW,YAAY;AACrB,gBAAQ,iBAAiB,QAAQ;AAEnC,mBAAa,OAAO,QAAQ;AAAA,IAC9B;AAEA,UAAM,SAAS,SAAS,QAClB,cAAc,OAAO,OAAO,eAAgB,WAAW,OAAO,cAAc,aAC5E,aAAa,OAAO,MAAM,QAC5B,UACA,OAAO,QAAQ,MAAM,QACnB,WACA;AAEN,WAAO,KAAK,6BAA6B,EAAC,WAAW,aAAa,WAAA,CAAW,GAC7E,QAAQ,kBAAkB;AAAA,MACxB;AAAA,MACA;AAAA,MACA;AAAA,IAAA,CACD,GAED,SAAS,UAAU,MAAM;AACvB,cAAQ,WAAA,GACR,kBAAkB,OAAO,QAAQ,GACjC,OAAO,MAAM,yBAAyB;AAAA,IACxC,CAAC;AAAA,EACH,CAAC,EACA,MAAM,CAAC,QAAQ;AACd,iBAAa,OAAO,QAAQ,GAC5B,OAAO,KAAK,yBAAyB,EAAC,OAAO,KAAI;AAAA,EACnD,CAAC;AACL;AAQO,SAAS,oBAAoB,UAAwD;AAC1F,SAAO,kBAAkB,IAAI,QAAQ;AACvC;AASO,SAAS,iBAAiB,UAA0B,UAAwB;AACjF,MAAI,CAAC,YAAa;AAElB,QAAM,UAAU,YAAY,QAAQ;AACpC,MAAI,SAAS;AACX,WAAO,MAAM,yBAAyB,EAAC,UAAU,UAAU,IAAK,GAChE,QAAQ,iBAAiB,QAAQ;AACjC;AAAA,EACF;AAEA,QAAM,OAAO,gBAAgB,QAAQ;AACrC,MAAI,QAAQ,aAAa,IAAI,IAAI;AAC5B,YACH,QAAQ,oBAAI,IAAA,GACZ,aAAa,IAAI,MAAM,KAAK,IAEzB,MAAM,IAAI,QAAQ,KACrB,OAAO,MAAM,2BAA2B,EAAC,UAAU,UAAU,IAAK,GAEpE,MAAM,IAAI,QAAQ;AACpB;AAEA,SAAS,YAAY,UAAwD;AAC3E,MAAI,UAAsC;AAC1C,SAAO,WAAS;AACd,UAAM,UAAU,kBAAkB,IAAI,OAAO;AAC7C,QAAI,QAAS,QAAO;AACpB,cAAU,OAAO,QAAQ,aAAc,aAAa,QAAQ,cAAc;AAAA,EAC5E;AAEF;AAEA,SAAS,gBAAgB,UAA0C;AACjE,MAAI,UAAU;AACd,SAAO,OAAO,QAAQ,aAAc,cAAc,QAAQ,UAAA;AACxD,cAAU,QAAQ,UAAA;AAEpB,SAAO;AACT;"}