@depup/sanity 5.17.1-depup.0

package/lib/_chunks-dts/types3.d.ts

@@ -0,0 +1,303 @@
+/**
+ * @public
+ */
+interface RouteSegment {
+  /**
+   * The name of the segment.
+   */
+  name: string;
+  /**
+   * The type of the segment.
+   * Can be either "dir" or "param".
+   */
+  type: 'dir' | 'param';
+}
+/**
+ * @public
+ */
+interface RouteTransform<T> {
+  /**
+   * Converts a path string to a state object.
+   */
+  toState: (value: string) => T;
+  /**
+   * Converts a state object to a path string.
+   */
+  toPath: (value: T) => string;
+}
+/**
+ * @public
+ */
+interface Route {
+  /**
+   * The raw string representation of the route.
+   */
+  raw: string;
+  /**
+   * An array of route segments that make up the route.
+   * See {@link RouteSegment}
+   */
+  segments: RouteSegment[];
+  /**
+   * An optional object containing route transforms.
+   * See {@link RouteTransform} and {@link RouterState}
+   */
+  transform?: {
+    [key: string]: RouteTransform<RouterState>;
+  };
+}
+/**
+ * @public
+ */
+type RouteChildren = RouterNode[] | ((state: RouterState) => Router | RouterNode | RouterNode[] | undefined | false);
+/**
+ * @public
+ */
+interface RouterNode {
+  /**
+   * The route information for this node. See {@link Route}
+   */
+  route: Route;
+  /**
+   * An optional scope for this node.
+   */
+  scope?: string;
+  /**
+   * Optionally disable scoping of search params
+   * Scoped search params will be represented as scope[param]=value in the url
+   * Disabling this will still scope search params based on any parent scope unless the parent scope also has disabled search params scoping
+   * Caution: enabling this can cause conflicts with multiple plugins defining search params with the same name
+   */
+  __unsafe_disableScopedSearchParams?: boolean;
+  /**
+   * An optional object containing transforms to apply to this node.
+   * See {@link RouteTransform} and {@link RouterState}
+   */
+  transform?: {
+    [key: string]: RouteTransform<RouterState>;
+  };
+  /**
+   * The child nodes of this node. See {@link RouteChildren}
+   */
+  children: RouteChildren;
+}
+/**
+ * @public
+ */
+interface Router extends RouterNode {
+  /**
+   * Indicates whether this router is a route.
+   * @internal
+   */
+  _isRoute: boolean;
+  /**
+   * Encodes the specified router state into a path string.
+   * See {@link RouterState}
+   *
+   */
+  encode: (state: RouterState) => string;
+  /**
+   * Decodes the specified path string into a router state.
+   * See {@link RouterState}
+   */
+  decode: (path: string) => RouterState | null;
+  /**
+   * Determines whether the specified path is not found.
+   */
+  isNotFound: (path: string) => boolean;
+  /**
+   * Gets the base path of this router.
+   */
+  getBasePath: () => string;
+  /**
+   * Gets the redirect base of this router.
+   */
+  getRedirectBase: (pathname: string) => string | null;
+  /**
+   * Determines whether the specified path is the root path.
+   */
+  isRoot: (path: string) => boolean;
+}
+/** @internal */
+type InternalSearchParam = [scopedPath: string[], value: string];
+/** @internal */
+interface MatchOk {
+  type: 'ok';
+  node: RouterNode;
+  matchedState: Record<string, string>;
+  searchParams: InternalSearchParam[];
+  child: MatchOk | undefined;
+}
+/** @internal */
+interface MatchError {
+  type: 'error';
+  node: RouterNode;
+  /**
+   * Parameters found in the route string but not provided as a key in the state object
+   */
+  missingKeys: string[];
+  /**
+   * These are keys found in the state object but not in the route definition (and can't be mapped to a child route)
+   */
+  unmappableStateKeys: string[];
+}
+/** @internal */
+type MatchResult = MatchError | MatchOk;
+/**
+ * @public
+ */
+interface NavigateBaseOptions {
+  replace?: boolean;
+}
+/**
+ * @public
+ */
+interface NavigateOptions extends NavigateBaseOptions {
+  stickyParams?: Record<string, string | undefined | null>;
+}
+/**
+ * @public
+ */
+interface NavigateOptionsWithState extends NavigateOptions {
+  state?: RouterState | null;
+}
+/**
+ * @public
+ */
+interface RouterContextValue {
+  /**
+   * Resolves the path from the given router state. See {@link RouterState}
+   *
+   * When state is null, it will resolve the path from the current state
+   * and navigate to the root path.
+   */
+  resolvePathFromState: (state: RouterState | null) => string;
+  /**
+   * Resolves the intent link for the given intent name and parameters.
+   * See {@link IntentParameters}
+   */
+  resolveIntentLink: (intentName: string, params?: IntentParameters, searchParams?: SearchParam[]) => string;
+  /**
+   * Navigates to the given URL.
+   * The function requires an object that has a path and an optional replace property.
+   */
+  navigateUrl: (opts: {
+    path: string;
+    replace?: boolean;
+  }) => void;
+  /**
+   * @deprecated Use `navigate({stickyParams: params, ...options})` instead
+   */
+  navigateStickyParams: (params: NavigateOptions['stickyParams'], options?: NavigateBaseOptions) => void;
+  /**
+   * Updates the router state and navigates to a new path.
+   * Allows specifying new state values and optionally merging sticky parameters.
+   *
+   * See {@link RouterState} and {@link NavigateOptions}
+   *
+   * @public
+   *
+   * @example Navigate with sticky params only, staying on the current path
+   * ```tsx
+   * router.navigate({stickyParams: {baz: 'qux'}})
+   * ```
+   * @remarks `null` sticky parameter value will remove the sticky parameter from the url
+   *
+   * @example Navigate with state and sticky params
+   * ```tsx
+   * router.navigate({stickyParams: {baz: 'qux'}, state: {foo: 'bar'}})
+   * ```
+   *
+   * @example Navigate to root path
+   * ```tsx
+   * router.navigate({stickyParams: {baz: 'qux'}, state: null})
+   * ```
+   */
+  navigate: {
+    (nextState: RouterState, options?: NavigateOptions): void;
+    (options: NavigateOptions & {
+      state?: RouterState | null;
+    }): void;
+  };
+  /**
+   * Navigates to the given intent.
+   * See {@link RouterState} and {@link NavigateBaseOptions}
+   */
+  navigateIntent: (intentName: string, params?: IntentParameters, options?: NavigateBaseOptions) => void;
+  /**
+   * The current router state. See {@link RouterState}
+   */
+  state: RouterState;
+  /**
+   * The current router state. See {@link RouterState}
+   */
+  stickyParams: Record<string, string | undefined | null>;
+}
+/**
+ * Base intent parameters
+ *
+ * @public
+ * @todo dedupe with core/structure
+ */
+interface BaseIntentParams {
+  /**
+   * Document schema type name to create/edit.
+   * Required for `create` intents, optional for `edit` (but encouraged, safer and faster)
+   */
+  type?: string;
+  /**
+   * ID of the document to create/edit.
+   * Required for `edit` intents, optional for `create`.
+   */
+  id?: string;
+  template?: string;
+  /**
+   * Experimental field path
+   *
+   * @beta
+   * @experimental
+   * @hidden
+   */
+  path?: string;
+  /**
+   * Optional "mode" to use for edit intent.
+   * Known modes are `structure` and `presentation`.
+   */
+  mode?: string;
+  /**
+   * Arbitrary/custom parameters are generally discouraged - try to keep them to a minimum,
+   * or use `payload` (arbitrary JSON-serializable object) instead.
+   */
+  [key: string]: string | undefined;
+}
+/**
+ * Intent parameters (json)
+ *
+ * @public
+ */
+type IntentJsonParams = {
+  [key: string]: any;
+};
+/**
+ * @public
+ * @todo dedupe with intent types in core
+ */
+type IntentParameters = BaseIntentParams | [BaseIntentParams, IntentJsonParams];
+/**
+ * @public
+ */
+type SearchParam = [key: string, value: string];
+/**
+ * @public
+ */
+type RouterState = Record<string, unknown> & {
+  _searchParams?: SearchParam[];
+};
+/**
+ * Type representing either a new router state or navigation options with an optional state.
+ * @internal
+ */
+type NextStateOrOptions = RouterState | (NavigateOptions & {
+  state?: RouterState | null;
+});
+export { RouterContextValue as _, MatchError as a, SearchParam as b, NavigateBaseOptions as c, NextStateOrOptions as d, Route as f, Router as g, RouteTransform as h, InternalSearchParam as i, NavigateOptions as l, RouteSegment as m, IntentJsonParams as n, MatchOk as o, RouteChildren as p, IntentParameters as r, MatchResult as s, BaseIntentParams as t, NavigateOptionsWithState as u, RouterNode as v, RouterState as y };

package/lib/_chunks-es/BroadcastDisplayedDocument.js

@@ -0,0 +1,20 @@
+import { c } from "react/compiler-runtime";
+import { memo, useEffect } from "react";
+import { usePresentationParams } from "./presentation.js";
+import { useDisplayedDocumentBroadcaster } from "./DisplayedDocumentBroadcaster.js";
+function BroadcastDisplayedDocument(props) {
+  const $ = c(7), setDisplayedDocument = useDisplayedDocumentBroadcaster(), params = usePresentationParams(!1);
+  let t0;
+  $[0] !== props.value || $[1] !== setDisplayedDocument ? (t0 = () => {
+    const timeout = setTimeout(() => setDisplayedDocument?.(props.value), 10);
+    return () => clearTimeout(timeout);
+  }, $[0] = props.value, $[1] = setDisplayedDocument, $[2] = t0) : t0 = $[2];
+  const t1 = params?.perspective;
+  let t2;
+  return $[3] !== props.value || $[4] !== setDisplayedDocument || $[5] !== t1 ? (t2 = [t1, props.value, setDisplayedDocument], $[3] = props.value, $[4] = setDisplayedDocument, $[5] = t1, $[6] = t2) : t2 = $[6], useEffect(t0, t2), null;
+}
+var BroadcastDisplayedDocument_default = memo(BroadcastDisplayedDocument);
+export {
+  BroadcastDisplayedDocument_default as default
+};
+//# sourceMappingURL=BroadcastDisplayedDocument.js.map

package/lib/_chunks-es/BroadcastDisplayedDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BroadcastDisplayedDocument.js","sources":["../../src/presentation/loader/BroadcastDisplayedDocument.tsx"],"sourcesContent":["import {memo, useEffect} from 'react'\nimport {type SanityDocument} from 'sanity'\n\nimport {usePresentationParams} from '../usePresentationParams'\nimport {useDisplayedDocumentBroadcaster} from './DisplayedDocumentBroadcaster'\n\n/**\n * Sanity Form input component that reads the current form state and broadcasts it to\n * the live query store\n */\nfunction BroadcastDisplayedDocument(props: {\n  value: Partial<SanityDocument> | null | undefined\n}): React.JSX.Element | null {\n  const setDisplayedDocument = useDisplayedDocumentBroadcaster()\n  const params = usePresentationParams(false)\n\n  useEffect(() => {\n    const timeout = setTimeout(() => setDisplayedDocument?.(props.value), 10)\n    return () => clearTimeout(timeout)\n  }, [params?.perspective, props.value, setDisplayedDocument])\n\n  return null\n}\n\nexport default memo(BroadcastDisplayedDocument)\n"],"names":["BroadcastDisplayedDocument","props","$","_c","setDisplayedDocument","useDisplayedDocumentBroadcaster","params","usePresentationParams","t0","value","timeout","setTimeout","clearTimeout","t1","perspective","t2","useEffect","memo"],"mappings":";;;;AAUA,SAAAA,2BAAAC,OAAA;AAAA,QAAAC,IAAAC,EAAA,CAAA,GAGEC,uBAA6BC,mCAC7BC,SAAeC,sBAAsB,EAAK;AAAC,MAAAC;AAAAN,WAAAD,MAAAQ,SAAAP,SAAAE,wBAEjCI,KAAAA,MAAA;AACR,UAAAE,UAAgBC,WAAW,MAAMP,uBAAuBH,MAAKQ,KAAM,GAAG,EAAE;AAAC,WAClE,MAAMG,aAAaF,OAAO;AAAA,EAAC,GACnCR,EAAA,CAAA,IAAAD,MAAAQ,OAAAP,OAAAE,sBAAAF,OAAAM,MAAAA,KAAAN,EAAA,CAAA;AAAG,QAAAW,KAAAP,QAAMQ;AAAa,MAAAC;AAAA,SAAAb,EAAA,CAAA,MAAAD,MAAAQ,SAAAP,EAAA,CAAA,MAAAE,wBAAAF,EAAA,CAAA,MAAAW,MAApBE,KAAA,CAACF,IAAqBZ,MAAKQ,OAAQL,oBAAoB,GAACF,EAAA,CAAA,IAAAD,MAAAQ,OAAAP,OAAAE,sBAAAF,OAAAW,IAAAX,OAAAa,MAAAA,KAAAb,EAAA,CAAA,GAH3Dc,UAAUR,IAGPO,EAAwD,GAEpD;AAAI;AAGb,IAAA,qCAAeE,KAAKjB,0BAA0B;"}

package/lib/_chunks-es/DisplayedDocumentBroadcaster.js

@@ -0,0 +1,32 @@
+import { jsx } from "react/jsx-runtime";
+import { c } from "react/compiler-runtime";
+import isEqual from "fast-deep-equal";
+import { useContext, useEffect } from "react";
+import { PresentationDisplayedDocumentContext } from "sanity/_singletons";
+function DisplayedDocumentBroadcasterProvider(props) {
+  const $ = c(9), {
+    children,
+    setDisplayedDocument,
+    documentId
+  } = props;
+  let t0;
+  $[0] !== setDisplayedDocument ? (t0 = (next) => setDisplayedDocument((prev) => isEqual(prev, next) ? prev : next), $[0] = setDisplayedDocument, $[1] = t0) : t0 = $[1];
+  const context = t0;
+  let t1, t2;
+  $[2] !== documentId || $[3] !== setDisplayedDocument ? (t1 = () => {
+    if (documentId)
+      return;
+    const timeout = setTimeout(() => setDisplayedDocument(null));
+    return () => clearTimeout(timeout);
+  }, t2 = [documentId, setDisplayedDocument], $[2] = documentId, $[3] = setDisplayedDocument, $[4] = t1, $[5] = t2) : (t1 = $[4], t2 = $[5]), useEffect(t1, t2);
+  let t3;
+  return $[6] !== children || $[7] !== context ? (t3 = /* @__PURE__ */ jsx(PresentationDisplayedDocumentContext.Provider, { value: context, children }), $[6] = children, $[7] = context, $[8] = t3) : t3 = $[8], t3;
+}
+function useDisplayedDocumentBroadcaster() {
+  return useContext(PresentationDisplayedDocumentContext);
+}
+export {
+  DisplayedDocumentBroadcasterProvider,
+  useDisplayedDocumentBroadcaster
+};
+//# sourceMappingURL=DisplayedDocumentBroadcaster.js.map

package/lib/_chunks-es/DisplayedDocumentBroadcaster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayedDocumentBroadcaster.js","sources":["../../src/presentation/loader/DisplayedDocumentBroadcaster.tsx"],"sourcesContent":["/**\n * Report back up the document state being displayed in the document pane,\n * allowing Presentation Tool to patch the live queries with the same state.\n * This makes the Perspective switcher less confusing, as it applies to everything else on the page.\n * It's also why it's possible to select an older revision and see it in the preview,\n * effectively letting you preview a revert action you might be considering to perform.\n */\n\nimport isEqual from 'fast-deep-equal'\nimport {type PropsWithChildren, useCallback, useContext, useEffect} from 'react'\nimport {type SanityDocument} from 'sanity'\nimport {PresentationDisplayedDocumentContext} from 'sanity/_singletons'\n\nimport {type PresentationDisplayedDocumentContextValue} from './types'\n\nexport interface DisplayedDocumentBroadcasterProps extends PropsWithChildren {\n  setDisplayedDocument: React.Dispatch<\n    React.SetStateAction<Partial<SanityDocument> | null | undefined>\n  >\n  documentId: string | null | undefined\n}\n\nexport function DisplayedDocumentBroadcasterProvider(\n  props: DisplayedDocumentBroadcasterProps,\n): React.JSX.Element {\n  const {children, setDisplayedDocument, documentId} = props\n\n  const context = useCallback<PresentationDisplayedDocumentContextValue>(\n    (next) => setDisplayedDocument((prev) => (isEqual(prev, next) ? prev : next)),\n    [setDisplayedDocument],\n  )\n\n  useEffect(() => {\n    // If no document is currently being displayed then reset the state\n    if (documentId) {\n      return undefined\n    }\n    const timeout = setTimeout(() => setDisplayedDocument(null))\n    return () => clearTimeout(timeout)\n  }, [documentId, setDisplayedDocument])\n\n  return (\n    <PresentationDisplayedDocumentContext.Provider value={context}>\n      {children}\n    </PresentationDisplayedDocumentContext.Provider>\n  )\n}\n\nexport function useDisplayedDocumentBroadcaster(): PresentationDisplayedDocumentContextValue | null {\n  return useContext(PresentationDisplayedDocumentContext)\n}\n"],"names":["DisplayedDocumentBroadcasterProvider","props","$","_c","children","setDisplayedDocument","documentId","t0","next","prev","isEqual","context","t1","t2","timeout","setTimeout","clearTimeout","useEffect","t3","useDisplayedDocumentBroadcaster","useContext","PresentationDisplayedDocumentContext"],"mappings":";;;;;AAsBO,SAAAA,qCAAAC,OAAA;AAAA,QAAAC,IAAAC,EAAA,CAAA,GAGL;AAAA,IAAAC;AAAAA,IAAAC;AAAAA,IAAAC;AAAAA,EAAAA,IAAqDL;AAAK,MAAAM;AAAAL,WAAAG,wBAGxDE,KAAAC,UAAUH,qBAAqBI,CAAAA,SAAWC,QAAQD,MAAMD,IAAkB,IAAhCC,OAAAD,IAAkC,GAACN,OAAAG,sBAAAH,OAAAK,MAAAA,KAAAL,EAAA,CAAA;AAD/E,QAAAS,UAAgBJ;AAGf,MAAAK,IAAAC;AAAAX,IAAA,CAAA,MAAAI,cAAAJ,SAAAG,wBAESO,KAAAA,MAAA;AAER,QAAIN;AAAU;AAGd,UAAAQ,UAAgBC,WAAW,MAAMV,qBAAqB,IAAI,CAAC;AAAC,WACrD,MAAMW,aAAaF,OAAO;AAAA,EAAC,GACjCD,KAAA,CAACP,YAAYD,oBAAoB,GAACH,OAAAI,YAAAJ,OAAAG,sBAAAH,OAAAU,IAAAV,OAAAW,OAAAD,KAAAV,EAAA,CAAA,GAAAW,KAAAX,EAAA,CAAA,IAPrCe,UAAUL,IAOPC,EAAkC;AAAC,MAAAK;AAAA,SAAAhB,EAAA,CAAA,MAAAE,YAAAF,SAAAS,WAGpCO,KAAA,oBAAA,qCAAA,UAAA,EAAsDP,OAAAA,SACnDP,SAAAA,CACH,GAAgDF,OAAAE,UAAAF,OAAAS,SAAAT,OAAAgB,MAAAA,KAAAhB,EAAA,CAAA,GAFhDgB;AAEgD;AAI7C,SAAAC,kCAAA;AAAA,SACEC,WAAWC,oCAAoC;AAAC;"}