sqllens 1.2.0 → 1.4.0

package/THIRD-PARTY-NOTICES.md

@@ -120,12 +120,16 @@ Forked from [antlr/grammars-v4](https://github.com/antlr/grammars-v4)
 Positive Technologies; (c) 2017 Ivan Khudyashev. Licensed under the MIT License
 (full text retained in the file headers).
 
-## Doc-derived function-signature tables (distributed in this repository)
+## Doc-derived function-signature and function-docs tables (distributed in this repository)
 
-The generated per-dialect function-signature tables (produced by
+The generated per-dialect function-signature tables and their per-name docs
+companions (`signatures.generated.ts` / `fn-docs.generated.ts`, produced by
 `tools/harvest-signatures.mjs`, committed under `src/`) carry factual API-surface
-data (function names, parameter names, arity, optionality) extracted from each
-dialect's reference documentation. Sources and their licenses:
+data (function names, parameter names, arity, optionality) and links to each
+dialect's reference documentation. For the permissively licensed sources listed
+below, the docs tables additionally reproduce one descriptive sentence per
+function, extracted verbatim from the source and marked `origin: "vendor-docs"`.
+Sources and their licenses:
 
 ### T-SQL signatures, from MicrosoftDocs/sql-docs (CC BY 4.0)
 
@@ -133,7 +137,9 @@ Derived from the Transact-SQL reference markdown in
 [MicrosoftDocs/sql-docs](https://github.com/MicrosoftDocs/sql-docs), (c) Microsoft
 Corporation, licensed [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
 Changes were made: the documented syntax notation was mechanically parsed and
-transformed into TypeScript signature tables; no documentation prose is reproduced.
+transformed into TypeScript signature tables, and the docs table reproduces each
+function page's first descriptive sentence (truncated to one sentence, whitespace
+collapsed); no other documentation prose is reproduced.
 
 ### DuckDB signatures, from duckdb/duckdb-web (MIT)
 
@@ -160,6 +166,21 @@ Derived from the function reference markdown in
 [google/googlesql](https://github.com/google/googlesql) `docs/`, (c) Google LLC,
 Apache License 2.0.
 
+### Databricks descriptions, from Apache Spark's Built-in Functions reference (Apache License 2.0)
+
+The databricks docs table's descriptions (origin `"spark-docs"`) are reproduced
+from [Apache Spark](https://spark.apache.org)'s generated SQL Built-in Functions
+reference (4.0.1), (c) The Apache Software Foundation, Apache License 2.0 —
+Spark-authored prose describing the Spark SQL surface Databricks shares.
+Databricks-only functions carry no Spark description.
+
+### SQLite signatures and descriptions, from the sqlite.org documentation (public domain)
+
+Derived from the [sqlite.org](https://sqlite.org) function-reference pages (doc
+bundle 3.53.3). SQLite's code and documentation are dedicated to the
+[public domain](https://sqlite.org/copyright.html); the docs table reproduces one
+descriptive sentence per function.
+
 ### Databricks and Snowflake signatures, from the vendors' public SQL references
 
 Derived from the Syntax sections of the public SQL language references at
@@ -168,7 +189,11 @@ Derived from the Syntax sections of the public SQL language references at
 publish no redistribution license; the tables reproduce only the factual call
 shape of each function (name, parameter names, arity, optionality), the same facts
 any SQL tool documents about a dialect's API surface, and no documentation prose.
-Credited here as sources with thanks.
+The docs tables link each function to its page on these sites; no page text is
+reproduced. The same applies to the Redshift
+([docs.aws.amazon.com](https://docs.aws.amazon.com), (c) Amazon Web Services) and
+MySQL ([dev.mysql.com](https://dev.mysql.com/doc/), (c) Oracle Corporation)
+references: links only, no prose. Credited here as sources with thanks.
 
 ## Runtime and build dependencies (not redistributed in source)
 

package/dist/api.d.ts

@@ -120,6 +120,8 @@ export { complete, completeAt, type Completion } from "./completion/complete.js"
 export { jinjaSlotAt, type JinjaSlot } from "./completion/jinja-slot.js";
 export { signatureAt, type SignatureHelpInfo, type SignatureLabel } from "./signature/signature.js";
 export { SIGNATURES, lookupSignature, hasSignature, type FnSignature, type ParamSig } from "./signature/signatures.js";
+export { renderSignature, type RenderSignatureOptions } from "./signature/render.js";
+export { FN_DOCS, lookupFnDoc, type FnDoc } from "./signature/docs.js";
 export { referencesAt, type Occurrence, type Occurrences } from "./references/references.js";
 export { dialectSymbols, type DialectSymbols } from "./dialect-symbols.js";
 export { CallbackSchema, type SchemaProvider, type TableResolver } from "./qualify/schema-provider.js";

package/dist/api.js

@@ -217,6 +217,8 @@ export { jinjaSlotAt } from "./completion/jinja-slot.js";
 // name-only fallback. A pure token scan; never throws.
 export { signatureAt } from "./signature/signature.js";
 export { SIGNATURES, lookupSignature, hasSignature } from "./signature/signatures.js";
+export { renderSignature } from "./signature/render.js";
+export { FN_DOCS, lookupFnDoc } from "./signature/docs.js";
 // References / occurrence engine — find the declaration + every occurrence of the symbol under a
 // cursor offset. The core primitive behind LSP references / documentHighlight / codeLens / rename.
 // Total: never throws; returns null off-symbol.

package/dist/bigquery/fn-docs.generated.d.ts

@@ -0,0 +1,2 @@
+import type { FnDoc } from "../signature/docs.js";
+export declare const BIGQUERY_FN_DOCS: Record<string, FnDoc>;