@sanity/sdk 2.8.0 → 2.9.0

package/dist/_exports/_internal.d.ts

@@ -0,0 +1,64 @@
+import { H as getUsersKey, J as getQueryKey, P as createGroqSearchFilter, U as parseUsersKey, X as parseQueryKey, a as isProjectUserNotFoundClientError, i as getClientErrorApiType, n as getClientErrorApiBody, ot as transformProjectionToPreview, r as getClientErrorApiDescription, st as PREVIEW_PROJECTION, t as ApiErrorBody, xr as isStudioConfig, yr as SanityInstance } 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":";;"}