@procore/saved-views 6.1.0 → 6.2.0

package/dist/legacy/transport/default.d.mts

@@ -0,0 +1,15 @@
+import { S as SavedViewsTransport } from '../types-BWhJ-on3.mjs';
+import 'react';
+
+/**
+ * The default transport. Preserves today's behavior bit-for-bit:
+ *  - HTTP via `requestJSON` from `@procore/core-http`.
+ *  - Caching via a module-singleton `QueryClient` (was previously declared in
+ *    `SavedViews.tsx`).
+ *  - URL sync via `useSearchParams` from `react-router-dom`.
+ *
+ * Consumers that omit the `transport` prop get this transport automatically.
+ */
+declare const defaultTransport: SavedViewsTransport;
+
+export { defaultTransport };

package/dist/legacy/transport/default.d.ts

@@ -0,0 +1,15 @@
+import { S as SavedViewsTransport } from '../types-BWhJ-on3.js';
+import 'react';
+
+/**
+ * The default transport. Preserves today's behavior bit-for-bit:
+ *  - HTTP via `requestJSON` from `@procore/core-http`.
+ *  - Caching via a module-singleton `QueryClient` (was previously declared in
+ *    `SavedViews.tsx`).
+ *  - URL sync via `useSearchParams` from `react-router-dom`.
+ *
+ * Consumers that omit the `transport` prop get this transport automatically.
+ */
+declare const defaultTransport: SavedViewsTransport;
+
+export { defaultTransport };

package/dist/legacy/transport/default.js

@@ -0,0 +1,104 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }require('../chunk-QGM4M3NI.js');
+
+// src/transport/default.tsx
+var _react = require('react'); var _react2 = _interopRequireDefault(_react);
+var _corehttp = require('@procore/core-http');
+
+
+
+
+
+
+var _reactquery = require('@tanstack/react-query');
+var _reactrouterdom = require('react-router-dom');
+var queryClient = new (0, _reactquery.QueryClient)();
+var DefaultCacheProvider = ({ children }) => /* @__PURE__ */ _react2.default.createElement(_reactquery.QueryClientProvider, { client: queryClient }, children);
+var useDefaultHttp = () => {
+  return async (req) => {
+    const init = {};
+    if (req.priority) {
+      init.priority = req.priority;
+    }
+    if (req.method !== "GET") {
+      init.method = req.method;
+    }
+    if (req.body !== void 0) {
+      init.body = typeof req.body === "string" ? req.body : JSON.stringify(req.body);
+    }
+    if (req.headers) {
+      init.headers = req.headers;
+    }
+    return _corehttp.requestJSON.call(void 0, req.url, init);
+  };
+};
+var useDefaultQueryAdapter = (args) => {
+  const { data, isLoading, isError, error } = _reactquery.useQuery.call(void 0, {
+    queryKey: args.queryKey,
+    queryFn: args.queryFn,
+    enabled: args.enabled
+  });
+  return { data, isLoading, isError, error };
+};
+var useDefaultMutationAdapter = (args) => {
+  const mutation = _reactquery.useMutation.call(void 0, {
+    mutationKey: args.mutationKey,
+    mutationFn: args.mutationFn,
+    onSuccess: args.onSuccess,
+    onError: args.onError
+  });
+  return {
+    mutate: (variables, options) => mutation.mutate(variables, {
+      onSuccess: options == null ? void 0 : options.onSuccess,
+      onError: options == null ? void 0 : options.onError
+    }),
+    isPending: mutation.isPending,
+    error: mutation.error,
+    reset: mutation.reset
+  };
+};
+var useDefaultCacheControl = () => {
+  const client = _reactquery.useQueryClient.call(void 0, );
+  return {
+    invalidate: (queryKey) => {
+      client.invalidateQueries({ queryKey: [...queryKey] });
+    },
+    setData: (queryKey, updater) => {
+      client.setQueryData([...queryKey], updater);
+    },
+    getData: (queryKey) => client.getQueryData([...queryKey])
+  };
+};
+var useDefaultUrlAdapter = () => {
+  const [searchParams, setSearchParams] = _reactrouterdom.useSearchParams.call(void 0, );
+  return {
+    getViewToken: () => searchParams.get("saved-view"),
+    setViewToken: (token) => {
+      setSearchParams(
+        (current) => {
+          const next = new URLSearchParams(current);
+          if (token === null) {
+            next.delete("saved-view");
+          } else {
+            next.set("saved-view", token);
+          }
+          return next;
+        },
+        { replace: true }
+      );
+    }
+  };
+};
+var defaultTransport = {
+  // The default transport owns the page URL via `react-router-dom`, so the
+  // `?saved-view=<token>` share link works — keep the copy-link affordance.
+  supportsUrlSharing: true,
+  CacheProvider: DefaultCacheProvider,
+  useHttp: useDefaultHttp,
+  useQueryAdapter: useDefaultQueryAdapter,
+  useMutationAdapter: useDefaultMutationAdapter,
+  useCacheControl: useDefaultCacheControl,
+  useUrlAdapter: useDefaultUrlAdapter
+};
+
+
+exports.defaultTransport = defaultTransport;

package/dist/legacy/transport/default.mjs

@@ -0,0 +1,104 @@
+import "../chunk-6DZX6EAA.mjs";
+
+// src/transport/default.tsx
+import React from "react";
+import { requestJSON } from "@procore/core-http";
+import {
+  QueryClient,
+  QueryClientProvider,
+  useMutation,
+  useQuery,
+  useQueryClient
+} from "@tanstack/react-query";
+import { useSearchParams } from "react-router-dom";
+var queryClient = new QueryClient();
+var DefaultCacheProvider = ({ children }) => /* @__PURE__ */ React.createElement(QueryClientProvider, { client: queryClient }, children);
+var useDefaultHttp = () => {
+  return async (req) => {
+    const init = {};
+    if (req.priority) {
+      init.priority = req.priority;
+    }
+    if (req.method !== "GET") {
+      init.method = req.method;
+    }
+    if (req.body !== void 0) {
+      init.body = typeof req.body === "string" ? req.body : JSON.stringify(req.body);
+    }
+    if (req.headers) {
+      init.headers = req.headers;
+    }
+    return requestJSON(req.url, init);
+  };
+};
+var useDefaultQueryAdapter = (args) => {
+  const { data, isLoading, isError, error } = useQuery({
+    queryKey: args.queryKey,
+    queryFn: args.queryFn,
+    enabled: args.enabled
+  });
+  return { data, isLoading, isError, error };
+};
+var useDefaultMutationAdapter = (args) => {
+  const mutation = useMutation({
+    mutationKey: args.mutationKey,
+    mutationFn: args.mutationFn,
+    onSuccess: args.onSuccess,
+    onError: args.onError
+  });
+  return {
+    mutate: (variables, options) => mutation.mutate(variables, {
+      onSuccess: options == null ? void 0 : options.onSuccess,
+      onError: options == null ? void 0 : options.onError
+    }),
+    isPending: mutation.isPending,
+    error: mutation.error,
+    reset: mutation.reset
+  };
+};
+var useDefaultCacheControl = () => {
+  const client = useQueryClient();
+  return {
+    invalidate: (queryKey) => {
+      client.invalidateQueries({ queryKey: [...queryKey] });
+    },
+    setData: (queryKey, updater) => {
+      client.setQueryData([...queryKey], updater);
+    },
+    getData: (queryKey) => client.getQueryData([...queryKey])
+  };
+};
+var useDefaultUrlAdapter = () => {
+  const [searchParams, setSearchParams] = useSearchParams();
+  return {
+    getViewToken: () => searchParams.get("saved-view"),
+    setViewToken: (token) => {
+      setSearchParams(
+        (current) => {
+          const next = new URLSearchParams(current);
+          if (token === null) {
+            next.delete("saved-view");
+          } else {
+            next.set("saved-view", token);
+          }
+          return next;
+        },
+        { replace: true }
+      );
+    }
+  };
+};
+var defaultTransport = {
+  // The default transport owns the page URL via `react-router-dom`, so the
+  // `?saved-view=<token>` share link works — keep the copy-link affordance.
+  supportsUrlSharing: true,
+  CacheProvider: DefaultCacheProvider,
+  useHttp: useDefaultHttp,
+  useQueryAdapter: useDefaultQueryAdapter,
+  useMutationAdapter: useDefaultMutationAdapter,
+  useCacheControl: useDefaultCacheControl,
+  useUrlAdapter: useDefaultUrlAdapter
+};
+export {
+  defaultTransport
+};

package/dist/legacy/types-BWhJ-on3.d.mts

@@ -0,0 +1,109 @@
+import { ComponentType, ReactNode } from 'react';
+
+/**
+ * A normalized HTTP request descriptor that the saved-views package builds
+ * internally. The transport's `useHttp()` adapter is responsible for fulfilling
+ * the request against the consumer's preferred HTTP layer (`@procore/core-http`
+ * for the default transport, `@procore/web-sdk-hub-data-loader` for the Hub
+ * Card transport).
+ */
+interface SavedViewsHttpRequest {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    /**
+     * Absolute URL or path. The default transport passes this straight to
+     * `requestJSON`. The hub-data-loader transport parses out the path and query
+     * string to build a `DataOperationParams` payload.
+     */
+    url: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+    /**
+     * Browser fetch priority hint. Matches the native `RequestPriority` type so
+     * that the default transport can pass it straight to `requestJSON`.
+     */
+    priority?: 'high' | 'low' | 'auto';
+}
+/** Adapter shape mirroring TanStack Query's `useQuery` return contract. */
+interface SavedViewsQueryResult<T> {
+    data: T | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error?: unknown;
+}
+interface SavedViewsQueryArgs<T> {
+    queryKey: readonly unknown[];
+    queryFn: () => Promise<T>;
+    enabled?: boolean;
+}
+/** Adapter shape mirroring TanStack Query's `useMutation` return contract. */
+interface SavedViewsMutationResult<Variables, Result, Err = unknown> {
+    mutate: (variables: Variables, options?: {
+        onSuccess?: (result: Result, variables: Variables) => void;
+        onError?: (error: Err, variables: Variables) => void;
+    }) => void;
+    isPending: boolean;
+    error: Err | null;
+    reset: () => void;
+}
+interface SavedViewsMutationArgs<Variables, Result, Err = unknown> {
+    mutationKey: readonly unknown[];
+    mutationFn: (variables: Variables) => Promise<Result>;
+    onSuccess?: (result: Result, variables: Variables) => void;
+    onError?: (error: Err, variables: Variables) => void;
+}
+/**
+ * Imperative cache surgery — mirrors a tiny slice of TanStack's `QueryClient`.
+ * The default transport delegates to a real `QueryClient`; the hub-data-loader
+ * transport implements this against its own subscription-based local cache so
+ * the rename-in-place UX is preserved without a second `QueryClient` on the
+ * page.
+ */
+interface SavedViewsCacheControl {
+    invalidate: (queryKey: readonly unknown[]) => void;
+    setData: <T>(queryKey: readonly unknown[], updater: (old: T | undefined) => T) => void;
+    getData: <T>(queryKey: readonly unknown[]) => T | undefined;
+}
+/**
+ * Adapter for the `?saved-view=<token>` URL convention. The default transport
+ * wraps `react-router-dom`'s `useSearchParams`; the hub-data-loader transport
+ * is a no-op because Hub Cards cannot own the URL (see
+ * `routing-in-hub-cards.md` in the project-list-hub-card repo).
+ */
+interface SavedViewsUrlAdapter {
+    getViewToken: () => string | null;
+    setViewToken: (token: string | null) => void;
+}
+/**
+ * The full transport contract injected via the `transport` prop on
+ * `SavedViews` / `DataTableSavedViews` / `SmartGridSavedViews`. When the prop
+ * is omitted, the package falls back to `defaultTransport`, which preserves
+ * today's behavior bit-for-bit.
+ */
+interface SavedViewsTransport {
+    /**
+     * Whether this transport owns a shareable page URL. Drives URL-dependent UI
+     * such as the "Copy share link" action: the link only works when the consumer
+     * can read the `?saved-view=<token>` param back on load. The default transport
+     * sets this `true` (it owns the URL via `react-router-dom`); the hub-data-loader
+     * transport sets it `false` because Hub Cards cannot own the host URL, so the
+     * copy-link affordance is hidden there. Optional for backward compatibility —
+     * treated as `true` (shown) when omitted.
+     */
+    supportsUrlSharing?: boolean;
+    /**
+     * Wraps the saved-views subtree. The default transport mounts the
+     * package-owned `QueryClientProvider` here; the hub-data-loader transport
+     * mounts a small subscription cache provider that exists only to support
+     * `setData`.
+     */
+    CacheProvider: ComponentType<{
+        children: ReactNode;
+    }>;
+    useHttp: () => (req: SavedViewsHttpRequest) => Promise<unknown>;
+    useQueryAdapter: <T>(args: SavedViewsQueryArgs<T>) => SavedViewsQueryResult<T>;
+    useMutationAdapter: <Variables, Result, Err = unknown>(args: SavedViewsMutationArgs<Variables, Result, Err>) => SavedViewsMutationResult<Variables, Result, Err>;
+    useCacheControl: () => SavedViewsCacheControl;
+    useUrlAdapter: () => SavedViewsUrlAdapter;
+}
+
+export type { SavedViewsTransport as S, SavedViewsCacheControl as a, SavedViewsHttpRequest as b, SavedViewsMutationArgs as c, SavedViewsMutationResult as d, SavedViewsQueryArgs as e, SavedViewsQueryResult as f, SavedViewsUrlAdapter as g };

package/dist/legacy/types-BWhJ-on3.d.ts

@@ -0,0 +1,109 @@
+import { ComponentType, ReactNode } from 'react';
+
+/**
+ * A normalized HTTP request descriptor that the saved-views package builds
+ * internally. The transport's `useHttp()` adapter is responsible for fulfilling
+ * the request against the consumer's preferred HTTP layer (`@procore/core-http`
+ * for the default transport, `@procore/web-sdk-hub-data-loader` for the Hub
+ * Card transport).
+ */
+interface SavedViewsHttpRequest {
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    /**
+     * Absolute URL or path. The default transport passes this straight to
+     * `requestJSON`. The hub-data-loader transport parses out the path and query
+     * string to build a `DataOperationParams` payload.
+     */
+    url: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+    /**
+     * Browser fetch priority hint. Matches the native `RequestPriority` type so
+     * that the default transport can pass it straight to `requestJSON`.
+     */
+    priority?: 'high' | 'low' | 'auto';
+}
+/** Adapter shape mirroring TanStack Query's `useQuery` return contract. */
+interface SavedViewsQueryResult<T> {
+    data: T | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error?: unknown;
+}
+interface SavedViewsQueryArgs<T> {
+    queryKey: readonly unknown[];
+    queryFn: () => Promise<T>;
+    enabled?: boolean;
+}
+/** Adapter shape mirroring TanStack Query's `useMutation` return contract. */
+interface SavedViewsMutationResult<Variables, Result, Err = unknown> {
+    mutate: (variables: Variables, options?: {
+        onSuccess?: (result: Result, variables: Variables) => void;
+        onError?: (error: Err, variables: Variables) => void;
+    }) => void;
+    isPending: boolean;
+    error: Err | null;
+    reset: () => void;
+}
+interface SavedViewsMutationArgs<Variables, Result, Err = unknown> {
+    mutationKey: readonly unknown[];
+    mutationFn: (variables: Variables) => Promise<Result>;
+    onSuccess?: (result: Result, variables: Variables) => void;
+    onError?: (error: Err, variables: Variables) => void;
+}
+/**
+ * Imperative cache surgery — mirrors a tiny slice of TanStack's `QueryClient`.
+ * The default transport delegates to a real `QueryClient`; the hub-data-loader
+ * transport implements this against its own subscription-based local cache so
+ * the rename-in-place UX is preserved without a second `QueryClient` on the
+ * page.
+ */
+interface SavedViewsCacheControl {
+    invalidate: (queryKey: readonly unknown[]) => void;
+    setData: <T>(queryKey: readonly unknown[], updater: (old: T | undefined) => T) => void;
+    getData: <T>(queryKey: readonly unknown[]) => T | undefined;
+}
+/**
+ * Adapter for the `?saved-view=<token>` URL convention. The default transport
+ * wraps `react-router-dom`'s `useSearchParams`; the hub-data-loader transport
+ * is a no-op because Hub Cards cannot own the URL (see
+ * `routing-in-hub-cards.md` in the project-list-hub-card repo).
+ */
+interface SavedViewsUrlAdapter {
+    getViewToken: () => string | null;
+    setViewToken: (token: string | null) => void;
+}
+/**
+ * The full transport contract injected via the `transport` prop on
+ * `SavedViews` / `DataTableSavedViews` / `SmartGridSavedViews`. When the prop
+ * is omitted, the package falls back to `defaultTransport`, which preserves
+ * today's behavior bit-for-bit.
+ */
+interface SavedViewsTransport {
+    /**
+     * Whether this transport owns a shareable page URL. Drives URL-dependent UI
+     * such as the "Copy share link" action: the link only works when the consumer
+     * can read the `?saved-view=<token>` param back on load. The default transport
+     * sets this `true` (it owns the URL via `react-router-dom`); the hub-data-loader
+     * transport sets it `false` because Hub Cards cannot own the host URL, so the
+     * copy-link affordance is hidden there. Optional for backward compatibility —
+     * treated as `true` (shown) when omitted.
+     */
+    supportsUrlSharing?: boolean;
+    /**
+     * Wraps the saved-views subtree. The default transport mounts the
+     * package-owned `QueryClientProvider` here; the hub-data-loader transport
+     * mounts a small subscription cache provider that exists only to support
+     * `setData`.
+     */
+    CacheProvider: ComponentType<{
+        children: ReactNode;
+    }>;
+    useHttp: () => (req: SavedViewsHttpRequest) => Promise<unknown>;
+    useQueryAdapter: <T>(args: SavedViewsQueryArgs<T>) => SavedViewsQueryResult<T>;
+    useMutationAdapter: <Variables, Result, Err = unknown>(args: SavedViewsMutationArgs<Variables, Result, Err>) => SavedViewsMutationResult<Variables, Result, Err>;
+    useCacheControl: () => SavedViewsCacheControl;
+    useUrlAdapter: () => SavedViewsUrlAdapter;
+}
+
+export type { SavedViewsTransport as S, SavedViewsCacheControl as a, SavedViewsHttpRequest as b, SavedViewsMutationArgs as c, SavedViewsMutationResult as d, SavedViewsQueryArgs as e, SavedViewsQueryResult as f, SavedViewsUrlAdapter as g };

package/dist/modern/adapters/hub-data-loader.d.mts

@@ -0,0 +1,22 @@
+import { SystemEvents } from '@procore/web-sdk-events';
+import { S as SavedViewsTransport } from '../types-BWhJ-on3.mjs';
+export { a as SavedViewsCacheControl, b as SavedViewsHttpRequest, c as SavedViewsMutationArgs, d as SavedViewsMutationResult, e as SavedViewsQueryArgs, f as SavedViewsQueryResult, g as SavedViewsUrlAdapter } from '../types-BWhJ-on3.mjs';
+import 'react';
+
+interface CreateHubDataLoaderTransportOptions {
+    /**
+     * Stable identifier of the Hub Card consuming saved-views. Forwarded to
+     * `useHubDataLoader(hubCardId, systemEvents)`. Use the same `HUB_CARD_ID`
+     * the card already uses elsewhere (e.g. for `system:request` events).
+     */
+    hubCardId: string;
+    /**
+     * The card's `SystemEvents` instance, initialized against the card's mount
+     * node. The Hub Card platform requires this to be scoped to the card, not
+     * `window`, so multiple cards on the same page don't cross-talk.
+     */
+    systemEvents: SystemEvents;
+}
+declare const createHubDataLoaderTransport: (options: CreateHubDataLoaderTransportOptions) => SavedViewsTransport;
+
+export { type CreateHubDataLoaderTransportOptions, SavedViewsTransport, createHubDataLoaderTransport };

package/dist/modern/adapters/hub-data-loader.d.ts

@@ -0,0 +1,22 @@
+import { SystemEvents } from '@procore/web-sdk-events';
+import { S as SavedViewsTransport } from '../types-BWhJ-on3.js';
+export { a as SavedViewsCacheControl, b as SavedViewsHttpRequest, c as SavedViewsMutationArgs, d as SavedViewsMutationResult, e as SavedViewsQueryArgs, f as SavedViewsQueryResult, g as SavedViewsUrlAdapter } from '../types-BWhJ-on3.js';
+import 'react';
+
+interface CreateHubDataLoaderTransportOptions {
+    /**
+     * Stable identifier of the Hub Card consuming saved-views. Forwarded to
+     * `useHubDataLoader(hubCardId, systemEvents)`. Use the same `HUB_CARD_ID`
+     * the card already uses elsewhere (e.g. for `system:request` events).
+     */
+    hubCardId: string;
+    /**
+     * The card's `SystemEvents` instance, initialized against the card's mount
+     * node. The Hub Card platform requires this to be scoped to the card, not
+     * `window`, so multiple cards on the same page don't cross-talk.
+     */
+    systemEvents: SystemEvents;
+}
+declare const createHubDataLoaderTransport: (options: CreateHubDataLoaderTransportOptions) => SavedViewsTransport;
+
+export { type CreateHubDataLoaderTransportOptions, SavedViewsTransport, createHubDataLoaderTransport };