@rowsncolumns/functions 15.0.2 → 15.1.1

package/Readme.md

@@ -1,5 +1,23 @@
-# Functions
+# @rowsncolumns/functions
 
-Contains function descriptions and custom functions used by calculator
+The function catalog (`functionDescriptions`: name, syntax, description, parameters, category) that
+drives autocomplete and Insert Function, plus the custom functions (`functions`) the legacy
+JavaScript calculator registers.
 
-TODO
+## Entries
+
+| Import | Contents |
+| --- | --- |
+| `@rowsncolumns/functions/descriptions` | `functionDescriptions` only. Pure data, no runtime imports — what a host on `@rowsncolumns/rnc-engine` / `rnc-yrs-store` should use. |
+| `@rowsncolumns/functions` | The catalog **and** `functions`, the custom-function implementations for the JavaScript calculator (pulls in `@rowsncolumns/calculator`, `fast-formula-parser`, `toolkit`). |
+| `@rowsncolumns/functions/server` | The catalog and the server-safe `functions` for the calculation worker. |
+
+```ts
+import { functionDescriptions } from "@rowsncolumns/functions/descriptions";
+
+<CanvasGrid functionDescriptions={functionDescriptions} … />
+```
+
+The package is declared `"sideEffects": false`; `__tests__/descriptions-subpath.spec.ts` holds the
+`descriptions` entry to the catalog alone, and `__tests__/engine-description-coverage.spec.ts` holds
+the catalog to every function the rnc-engine wasm registers.

package/dist/cjs/descriptions.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `@rowsncolumns/functions/descriptions` — the function catalog on its own.
+ *
+ * The root entry also re-exports the legacy JavaScript calculator's implementations (`functions`),
+ * which pull in `@rowsncolumns/calculator`, `@rowsncolumns/fast-formula-parser` and
+ * `@rowsncolumns/toolkit`. A host on the Rust engine only needs the catalog (autocomplete, Insert
+ * Function, the conditional-format / data-validation editors), so this entry must stay a pure data
+ * module: nothing here may import from `./formulas` or any `@rowsncolumns/*` runtime package.
+ * `__tests__/descriptions-subpath.spec.ts` walks the built import graph to hold that (#1135).
+ *
+ * The specifier carries its `.js` extension so the emitted `dist/esm/descriptions.js` also loads
+ * under Node's own ESM resolver (no bundler), not only under bundlers that resolve bare paths.
+ */
+export { functionDescriptions } from "./function-descriptions.js";
+export type { CalculatorFunction, FunctionParameter } from "./types";
+//# sourceMappingURL=descriptions.d.ts.map

package/dist/cjs/descriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"descriptions.d.ts","sourceRoot":"","sources":["../../descriptions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC"}

package/dist/cjs/descriptions.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.functionDescriptions = void 0;
+/**
+ * `@rowsncolumns/functions/descriptions` — the function catalog on its own.
+ *
+ * The root entry also re-exports the legacy JavaScript calculator's implementations (`functions`),
+ * which pull in `@rowsncolumns/calculator`, `@rowsncolumns/fast-formula-parser` and
+ * `@rowsncolumns/toolkit`. A host on the Rust engine only needs the catalog (autocomplete, Insert
+ * Function, the conditional-format / data-validation editors), so this entry must stay a pure data
+ * module: nothing here may import from `./formulas` or any `@rowsncolumns/*` runtime package.
+ * `__tests__/descriptions-subpath.spec.ts` walks the built import graph to hold that (#1135).
+ *
+ * The specifier carries its `.js` extension so the emitted `dist/esm/descriptions.js` also loads
+ * under Node's own ESM resolver (no bundler), not only under bundlers that resolve bare paths.
+ */
+var function_descriptions_js_1 = require("./function-descriptions.js");
+Object.defineProperty(exports, "functionDescriptions", { enumerable: true, get: function () { return function_descriptions_js_1.functionDescriptions; } });

package/dist/cjs/function-descriptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,EA8iVpD,CAAC"}
+{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,EAklXpD,CAAC"}