@sanity/sdk 2.5.0 → 2.6.0

package/dist/index.js

@@ -17,15 +17,14 @@ import { isKeySegment, isKeyedObject } from "@sanity/types";
 import { createDocumentLoaderFromClient } from "@sanity/mutate/_unstable_store";
 import { SDK_CHANNEL_NAME, SDK_NODE_NAME } from "@sanity/message-protocol";
 import { fromUrl } from "@sanity/bifur-client";
-const SOURCE_ID = "__sanity_internal_sourceId";
-function datasetSource(projectId, dataset) {
-  return { [SOURCE_ID]: { projectId, dataset } };
+function isDatasetSource(source) {
+  return "projectId" in source && "dataset" in source;
 }
-function mediaLibrarySource(id) {
-  return { [SOURCE_ID]: ["media-library", id] };
+function isMediaLibrarySource(source) {
+  return "mediaLibraryId" in source;
 }
-function canvasSource(id) {
-  return { [SOURCE_ID]: ["canvas", id] };
+function isCanvasSource(source) {
+  return "canvasId" in source;
 }
 function getPublishedId(id) {
   const draftsPrefix = "drafts.";
@@ -38,13 +37,152 @@ function getDraftId(id) {
 function insecureRandomId() {
   return Array.from({ length: 16 }, () => Math.floor(Math.random() * 16).toString(16)).join("");
 }
+const LOG_LEVEL_PRIORITY = {
+  error: 0,
+  warn: 1,
+  info: 2,
+  debug: 3,
+  trace: 4
+}, DEFAULT_CONFIG = {
+  level: "warn",
+  namespaces: [],
+  internal: !1,
+  timestamps: !0,
+  enableInProduction: !1,
+  handler: {
+    // eslint-disable-next-line no-console
+    error: console.error.bind(console),
+    // eslint-disable-next-line no-console
+    warn: console.warn.bind(console),
+    // eslint-disable-next-line no-console
+    info: console.info.bind(console),
+    // eslint-disable-next-line no-console
+    debug: console.debug.bind(console),
+    // eslint-disable-next-line no-console
+    trace: console.debug.bind(console)
+    // trace uses console.debug
+  }
+};
+function parseDebugEnvVar() {
+  if (typeof process > "u" || !process.env?.DEBUG)
+    return null;
+  const debug = process.env.DEBUG;
+  if (!debug.includes("sanity"))
+    return null;
+  const config = {}, levelMatch = debug.match(/sanity:(trace|debug|info|warn|error):/), hasLevelSpecifier = !!levelMatch;
+  if (levelMatch ? config.level = levelMatch[1] : config.level = "debug", debug === "sanity")
+    config.namespaces = ["*"];
+  else if (hasLevelSpecifier && debug.match(/sanity:(trace|debug|info|warn|error):\*/))
+    config.namespaces = ["*"];
+  else if (!hasLevelSpecifier && debug.includes("sanity:*"))
+    config.namespaces = ["*"];
+  else {
+    const namespaces = debug.split(",").filter((s) => s.includes("sanity:")).map((s) => {
+      const cleaned = s.replace(/^sanity:/, "");
+      return hasLevelSpecifier && cleaned.match(/^(trace|debug|info|warn|error):/) ? cleaned.split(":").slice(1).join(":") : cleaned.split(":")[0];
+    }).filter(Boolean).filter((ns) => ns !== "*");
+    namespaces.length > 0 && (config.namespaces = namespaces);
+  }
+  return debug.includes(":internal") && (config.internal = !0), config;
+}
+const envConfig = parseDebugEnvVar();
+let globalConfig = {
+  ...DEFAULT_CONFIG,
+  ...envConfig ?? {}
+};
+envConfig && (["info", "debug", "trace"].includes(globalConfig.level) || globalConfig.level === "warn") && console.info(
+  `[${(/* @__PURE__ */ new Date()).toISOString()}] [INFO] [sdk] Logging auto-configured from DEBUG environment variable`,
+  {
+    level: globalConfig.level,
+    namespaces: globalConfig.namespaces,
+    internal: globalConfig.internal,
+    source: "env:DEBUG",
+    value: typeof process < "u" ? process.env?.DEBUG : void 0
+  }
+);
+function configureLogging$1(config) {
+  globalConfig = {
+    ...globalConfig,
+    ...config,
+    handler: config.handler ?? globalConfig.handler
+  };
+}
+function isLoggingEnabled() {
+  return typeof process < "u" && process.env?.NODE_ENV === "production" ? globalConfig.enableInProduction : !0;
+}
+function isNamespaceEnabled(namespace) {
+  return isLoggingEnabled() ? globalConfig.namespaces.includes("*") ? !0 : globalConfig.namespaces.includes(namespace) : !1;
+}
+function isLevelEnabled(level) {
+  return isLoggingEnabled() ? LOG_LEVEL_PRIORITY[level] <= LOG_LEVEL_PRIORITY[globalConfig.level] : !1;
+}
+function formatMessage(namespace, level, message, context) {
+  const parts = [];
+  if (globalConfig.timestamps) {
+    const timestamp = (/* @__PURE__ */ new Date()).toISOString();
+    parts.push(`[${timestamp}]`);
+  }
+  parts.push(`[${level.toUpperCase()}]`), parts.push(`[${namespace}]`);
+  const instanceContext = context?.instanceContext;
+  return instanceContext && (instanceContext.projectId && parts.push(`[project:${instanceContext.projectId}]`), instanceContext.dataset && parts.push(`[dataset:${instanceContext.dataset}]`), instanceContext.instanceId && parts.push(`[instance:${instanceContext.instanceId.slice(0, 8)}]`)), parts.push(message), [parts.join(" "), context];
+}
+function sanitizeContext(context) {
+  if (!context || Object.keys(context).length === 0) return;
+  const sanitized = { ...context }, sensitiveKeys = ["token", "password", "secret", "apiKey", "authorization"];
+  for (const key of Object.keys(sanitized))
+    sensitiveKeys.some((sensitive) => key.toLowerCase().includes(sensitive)) && (sanitized[key] = "[REDACTED]");
+  return sanitized;
+}
+function createLogger(namespace, baseContext) {
+  const logAtLevel = (level, message, context) => {
+    if (!isNamespaceEnabled(namespace) || !isLevelEnabled(level) || context?.internal && !globalConfig.internal) return;
+    const mergedContext = { ...baseContext, ...context }, sanitized = sanitizeContext(mergedContext), [formatted, finalContext] = formatMessage(namespace, level, message, sanitized);
+    globalConfig.handler[level](formatted, finalContext);
+  };
+  return {
+    namespace,
+    error: (message, context) => logAtLevel("error", message, context),
+    warn: (message, context) => logAtLevel("warn", message, context),
+    info: (message, context) => logAtLevel("info", message, context),
+    debug: (message, context) => logAtLevel("debug", message, context),
+    trace: (message, context) => logAtLevel("trace", message, { ...context, internal: !0 }),
+    isLevelEnabled: (level) => isNamespaceEnabled(namespace) && isLevelEnabled(level),
+    child: (childContext) => createLogger(namespace, { ...baseContext, ...childContext }),
+    getInstanceContext: () => baseContext?.instanceContext
+  };
+}
 function createSanityInstance(config = {}) {
-  const instanceId = crypto.randomUUID(), disposeListeners = /* @__PURE__ */ new Map(), disposed = { current: !1 }, instance = {
+  const instanceId = crypto.randomUUID(), disposeListeners = /* @__PURE__ */ new Map(), disposed = { current: !1 }, instanceContext = {
+    instanceId,
+    projectId: config.projectId,
+    dataset: config.dataset
+  }, logger = createLogger("sdk", { instanceContext });
+  logger.info("Sanity instance created", {
+    hasProjectId: !!config.projectId,
+    hasDataset: !!config.dataset,
+    hasAuth: !!config.auth,
+    hasPerspective: !!config.perspective
+  }), logger.debug("Instance configuration", {
+    projectId: config.projectId,
+    dataset: config.dataset,
+    perspective: config.perspective,
+    studioMode: config.studioMode?.enabled,
+    hasAuthProviders: !!config.auth?.providers,
+    hasAuthToken: !!config.auth?.token
+  });
+  const instance = {
     instanceId,
     config,
     isDisposed: () => disposed.current,
     dispose: () => {
-      disposed.current || (disposed.current = !0, disposeListeners.forEach((listener) => listener()), disposeListeners.clear());
+      if (disposed.current) {
+        logger.trace("Dispose called on already disposed instance", { internal: !0 });
+        return;
+      }
+      logger.trace("Disposing instance", {
+        internal: !0,
+        listenerCount: disposeListeners.size
+      }), disposed.current = !0, disposeListeners.forEach((listener) => listener()), disposeListeners.clear(), logger.info("Instance disposed");
     },
     onDispose: (cb) => {
       const listenerId = insecureRandomId();
@@ -54,14 +192,26 @@ function createSanityInstance(config = {}) {
     },
     getParent: () => {
     },
-    createChild: (next) => Object.assign(
-      createSanityInstance({
-        ...config,
-        ...next,
-        ...config.auth === next.auth ? config.auth : config.auth && next.auth && { auth: { ...config.auth, ...next.auth } }
-      }),
-      { getParent: () => instance }
-    ),
+    createChild: (next) => {
+      logger.debug("Creating child instance", {
+        parentInstanceId: instanceId.slice(0, 8),
+        overridingProjectId: !!next.projectId,
+        overridingDataset: !!next.dataset,
+        overridingAuth: !!next.auth
+      });
+      const child = Object.assign(
+        createSanityInstance({
+          ...config,
+          ...next,
+          ...config.auth === next.auth ? config.auth : config.auth && next.auth && { auth: { ...config.auth, ...next.auth } }
+        }),
+        { getParent: () => instance }
+      );
+      return logger.trace("Child instance created", {
+        internal: !0,
+        childInstanceId: child.instanceId.slice(0, 8)
+      }), child;
+    },
     match: (targetConfig) => {
       if (Object.entries(pick(targetConfig, "auth", "projectId", "dataset")).every(
         ([key, value]) => config[key] === value
@@ -131,9 +281,9 @@ const bindActionByDataset = createActionBinder((instance, options) => {
   return { name: `${projectId}.${dataset}`, projectId, dataset };
 }), bindActionBySource = createActionBinder((instance, { source }) => {
   if (source) {
-    const id = source[SOURCE_ID];
-    if (!id) throw new Error("Invalid source (missing ID information)");
-    return Array.isArray(id) ? { name: id.join(":") } : { name: `${id.projectId}.${id.dataset}` };
+    let id;
+    if (isDatasetSource(source) ? id = `${source.projectId}.${source.dataset}` : isMediaLibrarySource(source) ? id = `media-library:${source.mediaLibraryId}` : isCanvasSource(source) && (id = `canvas:${source.canvasId}`), !id) throw new Error(`Received invalid source: ${JSON.stringify(source)}`);
+    return { name: id };
   }
   const { projectId, dataset } = instance.config;
   if (!projectId || !dataset)
@@ -673,12 +823,12 @@ const authStore = {
         `The client options provided contains unsupported properties: ${listFormatter.format(disallowedKeys)}. Allowed keys are: ${listFormatter.format(allowedKeys)}.`
       );
     }
-    const tokenFromState = state.get().token, { clients, authMethod } = state.get(), hasSource = !!options.source;
-    let sourceId = options.source?.[SOURCE_ID], resource;
-    Array.isArray(sourceId) && (resource = { type: sourceId[0], id: sourceId[1] }, sourceId = void 0);
+    const tokenFromState = state.get().token, { clients, authMethod } = state.get();
+    let resource;
+    options.source && (isDatasetSource(options.source) ? resource = { type: "dataset", id: `${options.source.projectId}.${options.source.dataset}` } : isMediaLibrarySource(options.source) ? resource = { type: "media-library", id: options.source.mediaLibraryId } : isCanvasSource(options.source) && (resource = { type: "canvas", id: options.source.canvasId }));
     const projectId = options.projectId ?? instance.config.projectId, dataset = options.dataset ?? instance.config.dataset, apiHost = options.apiHost ?? instance.config.auth?.apiHost, effectiveOptions = {
       ...DEFAULT_CLIENT_CONFIG,
-      ...(options.scope === "global" || !projectId || hasSource) && { useProjectHostname: !1 },
+      ...(options.scope === "global" || !projectId || resource) && { useProjectHostname: !1 },
       token: authMethod === "cookie" ? void 0 : tokenFromState ?? void 0,
       ...options,
       ...projectId && { projectId },
@@ -686,7 +836,7 @@ const authStore = {
       ...apiHost && { apiHost },
       ...resource && { "~experimental_resource": resource }
     };
-    hasSource && ((options.projectId || options.dataset) && console.warn(
+    resource && ((options.projectId || options.dataset) && console.warn(
       "Both source and explicit projectId/dataset are provided. The source will be used and projectId/dataset will be ignored."
     ), delete effectiveOptions.projectId, delete effectiveOptions.dataset), effectiveOptions.token === null || typeof effectiveOptions.token > "u" ? (delete effectiveOptions.token, authMethod === "cookie" && (effectiveOptions.withCredentials = !0)) : delete effectiveOptions.withCredentials;
     const key = getClientConfigKey(effectiveOptions);
@@ -1144,6 +1294,21 @@ function createProjectHandle(handle) {
 function createDatasetHandle(handle) {
   return handle;
 }
+function configureLogging(config) {
+  configureLogging$1(config);
+  const configLevel = config.level || "warn", shouldLog = ["info", "debug", "trace"].includes(configLevel) || configLevel === "warn";
+  shouldLog && config.handler?.info ? config.handler.info(`[${(/* @__PURE__ */ new Date()).toISOString()}] [INFO] [sdk] Logging configured`, {
+    level: configLevel,
+    namespaces: config.namespaces || [],
+    internal: config.internal || !1,
+    source: "programmatic"
+  }) : shouldLog && console.info(`[${(/* @__PURE__ */ new Date()).toISOString()}] [INFO] [sdk] Logging configured`, {
+    level: configLevel,
+    namespaces: config.namespaces || [],
+    internal: config.internal || !1,
+    source: "programmatic"
+  });
+}
 const API_VERSION$4 = "v2025-02-19", datasets = createFetcherStore({
   name: "Datasets",
   getKey: (instance, options) => {
@@ -4122,7 +4287,7 @@ function getCorsErrorProjectId(error) {
   const projMatch = (error.message || "").match(/manage\/project\/([^/?#]+)/);
   return projMatch ? projMatch[1] : null;
 }
-var version = "2.5.0";
+var version = "2.6.0";
 const CORE_SDK_VERSION = getEnv("PKG_VERSION") || `${version}-development`;
 export {
   AuthStateType,
@@ -4133,7 +4298,7 @@ export {
   agentTransform,
   agentTranslate,
   applyDocumentActions,
-  canvasSource,
+  configureLogging,
   createDatasetHandle,
   createDocument,
   createDocumentHandle,
@@ -4141,7 +4306,6 @@ export {
   createGroqSearchFilter,
   createProjectHandle,
   createSanityInstance,
-  datasetSource,
   defineIntent,
   deleteDocument,
   destroyController,
@@ -4183,12 +4347,14 @@ export {
   getUsersKey,
   getUsersState,
   handleAuthCallback,
+  isCanvasSource,
+  isDatasetSource,
+  isMediaLibrarySource,
   isProjectUserNotFoundClientError,
   joinPaths,
   jsonMatch2 as jsonMatch,
   loadMoreUsers,
   logout,
-  mediaLibrarySource,
   observeOrganizationVerificationState,
   parseQueryKey,
   parseUsersKey,