grist-widget-sdk 0.5.0 → 0.6.0

package/dist/{chunk-MAPAWVQC.js → chunk-DKCRFNAW.js}

@@ -3,7 +3,10 @@ import {
   coerceGristDocApiRefRowId,
   decodeGristValue,
   encodeGristValue
-} from "./chunk-4ZGVKGDF.js";
+} from "./chunk-A4KFKOEQ.js";
+import {
+  grist_user_actions_exports
+} from "./chunk-YGQXH2P5.js";
 
 // src/sdk/helpers/grist-table-data.ts
 function computeRowCount(data) {
@@ -600,6 +603,27 @@ function mapAndCheck(record, columns, mappings, schema) {
 // src/sdk/use-grist.ts
 import { createContext, useCallback, useContext, useEffect, useMemo, useSyncExternalStore } from "react";
 
+// src/sdk/helpers/deprecate.ts
+function isDevelopment() {
+  try {
+    return process.env.NODE_ENV !== "production";
+  } catch {
+    return false;
+  }
+}
+var warned = /* @__PURE__ */ new Set();
+function warnDeprecated(name, instead) {
+  if (warned.has(name) || !isDevelopment()) return;
+  warned.add(name);
+  console.warn(`[grist-widget-sdk] ${name} is deprecated and goes in 1.0: ${instead}. https://gristwidgets.com/docs/sdk/api/deprecated`);
+}
+function deprecatedFunction(name, instead, fn) {
+  return ((...args) => {
+    warnDeprecated(name, instead);
+    return fn(...args);
+  });
+}
+
 // src/sdk/helpers/build-replica-document.ts
 var FORMULA_PREVIEW_MAX = 500;
 function readCellStr(table, key, rowIndex) {
@@ -862,15 +886,32 @@ function createGristApi(runtime) {
     destroy: (ids) => write(() => resolve().destroy(ids))
   });
   const tables = /* @__PURE__ */ new Map();
+  const selectedColumns = (options) => read(async () => {
+    const impl = docApi().fetchSelectedTable ?? grist.fetchSelectedTable;
+    if (!impl) throw new Error("fetchSelectedTable is not available in this Grist version");
+    return await impl({ keepEncoded: false, ...options });
+  });
+  const tableColumns = (tableId) => read(async () => await docApi().fetchTable(tableId));
+  const fetchRows = (async (a, b) => {
+    const tableId = typeof a === "string" ? a : null;
+    const { columnar, ...rowOptions } = (typeof a === "object" && a !== null ? a : b) ?? {};
+    if (tableId === null) {
+      const data = await selectedColumns(rowOptions.columns ? { keepEncoded: true } : void 0);
+      return columnar ? data : materializeGristRowsFromColumnar(data, { order: "none", ...rowOptions });
+    }
+    if (columnar) return tableColumns(tableId);
+    return read(() => fetchGristTableRows(docApi(), tableId, rowOptions));
+  });
   return {
     reload: () => runtime.reload(),
-    fetchSelectedTable: (options) => read(async () => {
-      const impl = docApi().fetchSelectedTable ?? grist.fetchSelectedTable;
-      if (!impl) throw new Error("fetchSelectedTable is not available in this Grist version");
-      return await impl({ keepEncoded: false, ...options });
-    }),
-    fetchTable: (tableId) => read(async () => await docApi().fetchTable(tableId)),
-    fetchTableRows: (tableId, options) => read(() => fetchGristTableRows(docApi(), tableId, options ?? {})),
+    fetchRows,
+    fetchSelectedTable: deprecatedFunction("useGrist().fetchSelectedTable()", "use fetchRows({ columnar: true }), or fetchRows() for rows", selectedColumns),
+    fetchTable: deprecatedFunction("useGrist().fetchTable()", "use fetchRows(tableId, { columnar: true }), or fetchRows(tableId) for rows", tableColumns),
+    fetchTableRows: deprecatedFunction(
+      "useGrist().fetchTableRows()",
+      "use fetchRows(tableId, options)",
+      (tableId, options) => read(() => fetchGristTableRows(docApi(), tableId, options ?? {}))
+    ),
     listTables: (options) => read(async () => {
       const all = [...await docApi().listTables()];
       return options?.includeSystem ? all : all.filter((t) => !t.startsWith("_grist") && !t.startsWith("GristHidden_"));
@@ -1392,11 +1433,9 @@ function buildResult(state, mapped, connection, mapBack, resolveMappedColumnId,
   const { runtime, api } = connection;
   const status = deriveStatus(state);
   const columns = runtime.options.columns;
-  return {
+  const result = {
     ...api,
     status,
-    isAvailable: state.connection === "connecting" ? null : state.connection !== "not-embedded" && state.connection !== "unavailable",
-    isReady: status === "ready",
     error: deriveError(state),
     theme: state.theme,
     record: state.record,
@@ -1416,6 +1455,22 @@ function buildResult(state, mapped, connection, mapBack, resolveMappedColumnId,
     actionError: state.actionError,
     widgetOptions: state.widgetOptions
   };
+  const isAvailable = state.connection === "connecting" ? null : state.connection !== "not-embedded" && state.connection !== "unavailable";
+  Object.defineProperties(result, {
+    isAvailable: {
+      get() {
+        warnDeprecated("useGrist().isAvailable", 'read status: "unavailable" outside Grist, "booting" while connecting');
+        return isAvailable;
+      }
+    },
+    isReady: {
+      get() {
+        warnDeprecated("useGrist().isReady", 'use status === "ready"');
+        return status === "ready";
+      }
+    }
+  });
+  return result;
 }
 var EMPTY_MAPPINGS = Object.freeze({});
 function useGristResult(connection) {
@@ -1458,6 +1513,7 @@ function useGristOptional() {
   return fromProvider ? result : null;
 }
 function useGristContext() {
+  warnDeprecated("useGristContext()", "use widget.useGrist() (or useGrist()): mountGristWidget() always renders the provider");
   if (!useContext(GristContext)) {
     throw new Error("useGristContext() must be used inside <GristWidgetProvider> (mountGristWidget renders one).");
   }
@@ -1700,9 +1756,9 @@ function useGristSchema(options) {
     onEditOptions: options?.onEditOptions
   });
   const connection = useGristRuntime();
-  const isAvailable = w.isAvailable;
+  const isAvailable = w.status === "booting" ? null : w.status !== "unavailable";
   const readyError = w.status === "error" || w.status === "unavailable" ? w.error : null;
-  const docApi = w.isReady && typeof grist !== "undefined" ? grist.docApi ?? null : null;
+  const docApi = w.status === "ready" && typeof grist !== "undefined" ? grist.docApi ?? null : null;
   const [document2, setDocument] = useState3(null);
   const [loading, setLoading] = useState3(false);
   const [error, setError] = useState3(null);
@@ -1818,8 +1874,7 @@ function useGristSchema(options) {
       return a.localeCompare(b);
     });
   }, []);
-  return {
-    isAvailable,
+  const result = {
     document: document2,
     replicaDocument: document2,
     table,
@@ -1835,6 +1890,13 @@ function useGristSchema(options) {
     error: readyError ?? error,
     reload: load
   };
+  Object.defineProperty(result, "isAvailable", {
+    get() {
+      warnDeprecated("useGristSchema().isAvailable", 'read useGrist().status: "unavailable" outside Grist, "booting" while connecting');
+      return isAvailable;
+    }
+  });
+  return result;
 }
 
 // src/sdk/use-widget-metadata.ts
@@ -1868,6 +1930,22 @@ function setMetaTag(key, value, content) {
   meta.setAttribute("content", content);
 }
 
+// src/sdk/deprecated-actions.ts
+var moved = (name) => deprecatedFunction(
+  `${name} from "grist-widget-sdk"`,
+  `import it from "grist-widget-sdk/actions"`,
+  grist_user_actions_exports[name]
+);
+var gristAddColumnAction = moved("gristAddColumnAction");
+var gristAddRecordAction = moved("gristAddRecordAction");
+var gristAddTableAction = moved("gristAddTableAction");
+var gristAddVisibleColumnAction = moved("gristAddVisibleColumnAction");
+var gristModifyColumnAction = moved("gristModifyColumnAction");
+var gristRemoveColumnAction = moved("gristRemoveColumnAction");
+var gristRemoveRecordAction = moved("gristRemoveRecordAction");
+var gristRenameColumnAction = moved("gristRenameColumnAction");
+var gristUpdateRecordAction = moved("gristUpdateRecordAction");
+
 export {
   tableDataToRows,
   resolveGristFormulaKind,
@@ -1893,6 +1971,15 @@ export {
   GristWidgetProvider,
   GristBoundary,
   useGristSchema,
-  useWidgetMetadata
+  useWidgetMetadata,
+  gristAddColumnAction,
+  gristAddRecordAction,
+  gristAddTableAction,
+  gristAddVisibleColumnAction,
+  gristModifyColumnAction,
+  gristRemoveColumnAction,
+  gristRemoveRecordAction,
+  gristRenameColumnAction,
+  gristUpdateRecordAction
 };
-//# sourceMappingURL=chunk-MAPAWVQC.js.map
+//# sourceMappingURL=chunk-DKCRFNAW.js.map