@sanity/sdk 2.8.0 → 2.10.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryManager.js","sources":["../../src/telemetry/telemetryManager.ts"],"sourcesContent":["import {type SanityClient} from '@sanity/client'\nimport {\n  type ConsentStatus,\n  createBatchedStore,\n  type SessionId,\n  type TelemetryEvent,\n  type TelemetryLogger,\n  type TelemetryStore,\n} from '@sanity/telemetry'\n\nimport {createLogger} from '../utils/logger'\nimport {CORE_SDK_VERSION} from '../version'\nimport {\n  SDKDevError,\n  SDKDevSessionEnded,\n  SDKDevSessionStarted,\n  SDKHookMounted,\n} from './__telemetry__/sdk.telemetry'\n\nconst FLUSH_INTERVAL_MS = 30_000\nconst CONSENT_TAG = 'telemetry-consent.sdk'\nconst BATCH_TAG = 'telemetry.batch'\n\nconst log = createLogger('telemetry')\n\n/**\n * Manages dev-mode telemetry for a single SDK instance.\n *\n * Wraps `@sanity/telemetry`'s batched store with SDK-specific concerns:\n * consent caching, session lifecycle events, and hook usage tracking.\n *\n * @internal\n */\nexport interface TelemetryManager {\n  /**\n   * Eagerly resolve and cache the user's consent status.\n   * Returns true only when the user has explicitly opted in (`granted`).\n   * Call this before logging any events to avoid buffering events that\n   * will be dropped on the first flush.\n   */\n  checkConsent(): Promise<boolean>\n\n  /** Log a \"SDK Dev Session Started\" event */\n  logSessionStarted(data: {projectId: string; perspective: string; authMethod: string}): void\n\n  /** Log a \"SDK Hook First Used\" event (deduplicated per hook name) */\n  logHookFirstUsed(hookName: string): void\n\n  /** Log a \"SDK Dev Error\" event */\n  logDevError(errorType: string, hookName: string): void\n\n  /** Log a \"SDK Dev Session Ended\" event and tear down the store */\n  endSession(): void\n\n  /** Tear down the store without logging a session-end event */\n  dispose(): void\n\n  /** The set of hook names used during this session */\n  readonly hooksUsed: ReadonlySet<string>\n}\n\ninterface TelemetryManagerOptions {\n  sessionId: string\n  getClient: () => SanityClient\n  projectId: string\n}\n\n/**\n * Creates a telemetry manager for a single SDK instance session.\n *\n * The manager initializes a `createBatchedStore` from `@sanity/telemetry`,\n * caches the consent check for the lifetime of the session, and provides\n * typed methods for each SDK telemetry event.\n *\n * @internal\n */\nexport function createTelemetryManager(options: TelemetryManagerOptions): TelemetryManager {\n  const {sessionId, getClient, projectId} = options\n  const startedAt = Date.now()\n  const emittedHooks = new Set<string>()\n\n  let cachedConsent: {status: ConsentStatus} | null = null\n\n  const resolveConsent = async (): Promise<{status: ConsentStatus}> => {\n    if (cachedConsent) return cachedConsent\n    try {\n      const client = getClient()\n      const result = await client.request<{status: ConsentStatus}>({\n        uri: '/intake/telemetry-status',\n        tag: CONSENT_TAG,\n      })\n      cachedConsent = result\n    } catch {\n      cachedConsent = {status: 'undetermined'}\n    }\n    return cachedConsent\n  }\n\n  const enrichBatch = (batch: TelemetryEvent[]) =>\n    batch.map((event) => ({\n      ...event,\n      context: {\n        version: CORE_SDK_VERSION,\n        environment: 'development' as const,\n        origin: typeof window !== 'undefined' ? window.location.origin : 'node',\n      },\n    }))\n\n  const sendEvents = async (batch: TelemetryEvent[]): Promise<unknown> => {\n    const client = getClient()\n    log.debug('sending event batch', {batchSize: batch.length})\n    return client.request({\n      uri: '/intake/batch',\n      method: 'POST',\n      body: {projectId, batch: enrichBatch(batch)},\n      tag: BATCH_TAG,\n    })\n  }\n\n  const store: TelemetryStore<Record<string, unknown>> = createBatchedStore(\n    sessionId as SessionId,\n    {\n      flushInterval: FLUSH_INTERVAL_MS,\n      resolveConsent,\n      sendEvents,\n    },\n  )\n\n  const logger: TelemetryLogger<Record<string, unknown>> = store.logger\n\n  return {\n    async checkConsent() {\n      const {status} = await resolveConsent()\n      return status === 'granted'\n    },\n\n    logSessionStarted(data) {\n      log.debug('event: SDK Dev Session Started', {\n        projectId: data.projectId,\n        perspective: data.perspective,\n        authMethod: data.authMethod,\n        version: CORE_SDK_VERSION,\n      })\n      logger.log(SDKDevSessionStarted, {\n        version: CORE_SDK_VERSION,\n        ...data,\n      })\n    },\n\n    logHookFirstUsed(hookName: string) {\n      if (emittedHooks.has(hookName)) return\n      emittedHooks.add(hookName)\n      log.debug('event: SDK Hook Mounted', {hookName})\n      logger.log(SDKHookMounted, {hookName})\n    },\n\n    logDevError(errorType: string, hookName: string) {\n      log.debug('event: SDK Dev Error', {errorType, hookName})\n      logger.log(SDKDevError, {errorType, hookName})\n    },\n\n    endSession() {\n      const durationSeconds = Math.round((Date.now() - startedAt) / 1000)\n      log.debug('event: SDK Dev Session Ended', {\n        durationSeconds,\n        hooksUsed: [...emittedHooks],\n      })\n      logger.log(SDKDevSessionEnded, {\n        durationSeconds,\n        hooksUsed: [...emittedHooks],\n      })\n\n      store.flush().catch(() => {\n        // Best-effort flush on dispose; swallow errors\n      })\n      store.end()\n    },\n\n    dispose() {\n      store.end()\n    },\n\n    get hooksUsed(): ReadonlySet<string> {\n      return emittedHooks\n    },\n  }\n}\n"],"names":[],"mappings":";;;;AAmBA,MAAM,oBAAoB,KACpB,cAAc,yBACd,YAAY,mBAEZ,MAAM,aAAa,WAAW;AAqD7B,SAAS,uBAAuB,SAAoD;AACzF,QAAM,EAAC,WAAW,WAAW,UAAA,IAAa,SACpC,YAAY,KAAK,IAAA,GACjB,eAAe,oBAAI,IAAA;AAEzB,MAAI,gBAAgD;AAEpD,QAAM,iBAAiB,YAA8C;AACnE,QAAI,cAAe,QAAO;AAC1B,QAAI;AAMF,sBAJe,MADA,UAAA,EACa,QAAiC;AAAA,QAC3D,KAAK;AAAA,QACL,KAAK;AAAA,MAAA,CACN;AAAA,IAEH,QAAQ;AACN,sBAAgB,EAAC,QAAQ,eAAA;AAAA,IAC3B;AACA,WAAO;AAAA,EACT,GAEM,cAAc,CAAC,UACnB,MAAM,IAAI,CAAC,WAAW;AAAA,IACpB,GAAG;AAAA,IACH,SAAS;AAAA,MACP,SAAS;AAAA,MACT,aAAa;AAAA,MACb,QAAQ,OAAO,SAAW,MAAc,OAAO,SAAS,SAAS;AAAA,IAAA;AAAA,EACnE,EACA,GAaE,QAAiD;AAAA,IACrD;AAAA,IACA;AAAA,MACE,eAAe;AAAA,MACf;AAAA,MACA,YAhBe,OAAO,UAA8C;AACtE,cAAM,SAAS,UAAA;AACf,eAAA,IAAI,MAAM,uBAAuB,EAAC,WAAW,MAAM,OAAA,CAAO,GACnD,OAAO,QAAQ;AAAA,UACpB,KAAK;AAAA,UACL,QAAQ;AAAA,UACR,MAAM,EAAC,WAAW,OAAO,YAAY,KAAK,EAAA;AAAA,UAC1C,KAAK;AAAA,QAAA,CACN;AAAA,MACH;AAAA,IAAA;AAAA,EAQE,GAGI,SAAmD,MAAM;AAE/D,SAAO;AAAA,IACL,MAAM,eAAe;AACnB,YAAM,EAAC,WAAU,MAAM,eAAA;AACvB,aAAO,WAAW;AAAA,IACpB;AAAA,IAEA,kBAAkB,MAAM;AACtB,UAAI,MAAM,kCAAkC;AAAA,QAC1C,WAAW,KAAK;AAAA,QAChB,aAAa,KAAK;AAAA,QAClB,YAAY,KAAK;AAAA,QACjB,SAAS;AAAA,MAAA,CACV,GACD,OAAO,IAAI,sBAAsB;AAAA,QAC/B,SAAS;AAAA,QACT,GAAG;AAAA,MAAA,CACJ;AAAA,IACH;AAAA,IAEA,iBAAiB,UAAkB;AAC7B,mBAAa,IAAI,QAAQ,MAC7B,aAAa,IAAI,QAAQ,GACzB,IAAI,MAAM,2BAA2B,EAAC,SAAA,CAAS,GAC/C,OAAO,IAAI,gBAAgB,EAAC,UAAS;AAAA,IACvC;AAAA,IAEA,YAAY,WAAmB,UAAkB;AAC/C,UAAI,MAAM,wBAAwB,EAAC,WAAW,SAAA,CAAS,GACvD,OAAO,IAAI,aAAa,EAAC,WAAW,UAAS;AAAA,IAC/C;AAAA,IAEA,aAAa;AACX,YAAM,kBAAkB,KAAK,OAAO,KAAK,IAAA,IAAQ,aAAa,GAAI;AAClE,UAAI,MAAM,gCAAgC;AAAA,QACxC;AAAA,QACA,WAAW,CAAC,GAAG,YAAY;AAAA,MAAA,CAC5B,GACD,OAAO,IAAI,oBAAoB;AAAA,QAC7B;AAAA,QACA,WAAW,CAAC,GAAG,YAAY;AAAA,MAAA,CAC5B,GAED,MAAM,MAAA,EAAQ,MAAM,MAAM;AAAA,MAE1B,CAAC,GACD,MAAM,IAAA;AAAA,IACR;AAAA,IAEA,UAAU;AACR,YAAM,IAAA;AAAA,IACR;AAAA,IAEA,IAAI,YAAiC;AACnC,aAAO;AAAA,IACT;AAAA,EAAA;AAEJ;"}

package/dist/_chunks-es/version.js

@@ -0,0 +1,7 @@
+import { getEnv } from "./createGroqSearchFilter.js";
+var version = "2.10.0";
+const CORE_SDK_VERSION = getEnv("PKG_VERSION") || `${version}-development`;
+export {
+  CORE_SDK_VERSION
+};
+//# sourceMappingURL=version.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sources":["../../src/version.ts"],"sourcesContent":["import {version} from '../package.json'\nimport {getEnv} from './utils/getEnv'\n\n/**\n * This version is provided by pkg-utils at build time\n * @internal\n */\nexport const CORE_SDK_VERSION = getEnv('PKG_VERSION') || `${version}-development`\n"],"names":[],"mappings":";;AAOO,MAAM,mBAAmB,OAAO,aAAa,KAAK,GAAG,OAAO;"}

package/dist/_exports/_internal.d.ts

@@ -0,0 +1,64 @@
+import { F as createGroqSearchFilter, Sr as isStudioConfig, U as getUsersKey, W as parseUsersKey, Y as getQueryKey, Z as parseQueryKey, a as isProjectUserNotFoundClientError, br as SanityInstance, ct as PREVIEW_PROJECTION, i as getClientErrorApiType, n as getClientErrorApiBody, r as getClientErrorApiDescription, st as transformProjectionToPreview, t as ApiErrorBody } from "../_chunks-dts/utils.js";
+import { SanityClient } from "@sanity/client";
+/**
+ * Manages dev-mode telemetry for a single SDK instance.
+ *
+ * Wraps `@sanity/telemetry`'s batched store with SDK-specific concerns:
+ * consent caching, session lifecycle events, and hook usage tracking.
+ *
+ * @internal
+ */
+interface TelemetryManager {
+  /**
+   * Eagerly resolve and cache the user's consent status.
+   * Returns true only when the user has explicitly opted in (`granted`).
+   * Call this before logging any events to avoid buffering events that
+   * will be dropped on the first flush.
+   */
+  checkConsent(): Promise<boolean>;
+  /** Log a "SDK Dev Session Started" event */
+  logSessionStarted(data: {
+    projectId: string;
+    perspective: string;
+    authMethod: string;
+  }): void;
+  /** Log a "SDK Hook First Used" event (deduplicated per hook name) */
+  logHookFirstUsed(hookName: string): void;
+  /** Log a "SDK Dev Error" event */
+  logDevError(errorType: string, hookName: string): void;
+  /** Log a "SDK Dev Session Ended" event and tear down the store */
+  endSession(): void;
+  /** Tear down the store without logging a session-end event */
+  dispose(): void;
+  /** The set of hook names used during this session */
+  readonly hooksUsed: ReadonlySet<string>;
+}
+/**
+ * Initializes dev-mode telemetry for a SDK instance if the environment
+ * qualifies. Both `telemetryManager` and `clientStore` are dynamically
+ * imported to avoid circular dependencies and to keep telemetry code
+ * out of production bundles via code splitting.
+ *
+ * The `projectId` must be passed explicitly because the resource
+ * configuration is typically set by the React layer after the
+ * instance has already been created.
+ *
+ * @internal
+ */
+declare function initTelemetry(instance: SanityInstance, projectId: string): void;
+/**
+ * Retrieves the telemetry manager for an instance, if one exists.
+ * Returns undefined when telemetry is disabled or not yet initialized.
+ *
+ * @internal
+ */
+declare function getTelemetryManager(instance: SanityInstance): TelemetryManager | undefined;
+/**
+ * Record a hook name for an instance. If the telemetry manager is
+ * already initialized the event is logged immediately. Otherwise
+ * the name is buffered and flushed when init completes.
+ *
+ * @internal
+ */
+declare function trackHookMounted(instance: SanityInstance, hookName: string): void;
+export { type ApiErrorBody, PREVIEW_PROJECTION, createGroqSearchFilter, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getQueryKey, getTelemetryManager, getUsersKey, initTelemetry, isProjectUserNotFoundClientError, isStudioConfig, parseQueryKey, parseUsersKey, trackHookMounted, transformProjectionToPreview };

package/dist/_exports/_internal.js

@@ -0,0 +1,20 @@
+import { PREVIEW_PROJECTION, createGroqSearchFilter, getClientErrorApiBody, getClientErrorApiDescription, getClientErrorApiType, getQueryKey, getUsersKey, isProjectUserNotFoundClientError, isStudioConfig, parseQueryKey, parseUsersKey, transformProjectionToPreview } from "../_chunks-es/createGroqSearchFilter.js";
+import { getTelemetryManager, initTelemetry, trackHookMounted } from "../_chunks-es/_internal.js";
+export {
+  PREVIEW_PROJECTION,
+  createGroqSearchFilter,
+  getClientErrorApiBody,
+  getClientErrorApiDescription,
+  getClientErrorApiType,
+  getQueryKey,
+  getTelemetryManager,
+  getUsersKey,
+  initTelemetry,
+  isProjectUserNotFoundClientError,
+  isStudioConfig,
+  parseQueryKey,
+  parseUsersKey,
+  trackHookMounted,
+  transformProjectionToPreview
+};
+//# sourceMappingURL=_internal.js.map

package/dist/_exports/_internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_internal.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}