@geonosis/search 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,137 @@
+# @geonosis/search
+
+Full-text search as a domain. One door: the contract, and — as they land — the Postgres provider
+and the conformance kit. Nothing here opens a connection; the executor is injected.
+
+```bash
+pnpm add @geonosis/search
+```
+
+## The contract
+
+A `SearchIndex<Kind>` has four members:
+
+```ts
+type SearchIndex<Kind extends string = string> = {
+  index: (document: IndexedDocument<Kind>) => Promise<void>
+  query: (terms: string, options?: SearchOptions) => Promise<SearchPage>
+  retire: (document: DocumentAddress<Kind>) => Promise<void>
+  vocabulary: SearchVocabulary<Kind>
+}
+```
+
+### `index` derives its own projection
+
+An `IndexedDocument` is `{ fields, id, kind }` — its own values, addressed. There is no projection
+argument, and no projection field: how a kind becomes searchable text is a `SearchProjection`
+(`{ body, title }`, `DocumentFields → string`) declared ONCE, where the index is built, as a total
+`SearchProjections<Kind>` map. A half-filled record is unrepresentable rather than linted, because
+the field a caller could half-fill does not exist.
+
+This is the shape a source repo's defect argued for: two write paths derived the same searchable
+values by hand, and the one that forgot blanked a column on every document it wrote.
+
+### `query` answers inside a declared vocabulary
+
+`SearchVocabulary` publishes `filters` — each filter NAME with the VALUES it takes — and
+`orderings`. `readSearchQuery(vocabulary, terms, options)` reads a query against it and returns a
+`ReadQuery` (`{ after?, filters: ReadFilter[], limit, order, terms }`), or throws `SearchRefusal`
+naming what it could not answer. A filter nobody declared, a value that filter never takes and an
+undeclared ordering are all refusals — because the alternative is an empty answer read as a count
+of zero, and the refusal says so.
+
+`DEFAULT_LIMIT` is 50 when a query names no limit.
+
+### Pages are keyset, never offset
+
+`SearchOptions.after` is a `SearchCursor`: an opaque string minted by `encodeCursor` from the
+`SearchCursorKey` of the row a page ended on — `{ at, id, kind, order, rank, terms }`. `readCursor`
+reads one back and REFUSES a cursor minted for other terms or another ordering: a relevance rank
+means something only under the question that produced it, so the page that cursor would answer
+belongs to a different query.
+
+Time crosses the boundary as epoch milliseconds (`SearchHit.indexedAt`, `SearchCursorKey.at`).
+
+## The provider: `pgFtsSearchIndex`
+
+A dialect is an export NAME, never a subpath (D-056) — the executor is injected, so this provider's
+dependency footprint is the root's.
+
+```ts
+const index = pgFtsSearchIndex({
+  executor,                 // @geonosis/db's Executor, or anything with the same `execute`
+  nowMs: Date.now,          // injected, never ambient
+  projections: { note: { body: (f) => f.notes, title: (f) => f.heading } },
+})
+```
+
+`PgFtsOptions` is `{ executor, nowMs, projections }`. The vocabulary is DERIVED from the
+projections: the kinds it can index are the kinds it will filter by, so there is no second list to
+keep in step. It answers two orderings, `relevance` (rank) and `recent` (the instant the row was
+indexed).
+
+**Nothing in this provider names a tenant.** The row's tenant is the column's DEFAULT, read from the
+session, and the read carries no tenant predicate at all: the policies below are what answers that
+question, so a query that forgot its session sees nothing rather than everything.
+
+## The migrations
+
+The DDL ships as ordered `.sql` files under `migrations/` — a table whose `search` column is a
+`tsvector` the DATABASE generates from the projected `title` and `body`, a GIN index on it, an index
+for the `recent` ordering, and row level security ENABLED AND FORCED with a tenant-isolation and an
+ops-maintenance policy.
+
+The session variable names are the consumer's vocabulary and have no default (#168). The shipped
+files carry the `MIGRATION_PLACEHOLDERS` tokens — `{{tenantSetting}}` and `{{opsSetting}}` — for a
+migrator that templates. For one that does not, `searchIndexMigrations(settings)` returns the same
+DDL rendered, as `SearchMigration[]` (`{ name, statements }`), refusing a `SearchIndexSettings`
+whose names are not the `prefix.name` Postgres accepts. `DEFAULT_OPS_VALUE` is what the ops setting
+holds while the lever is pulled; `SEARCH_INDEX_TABLE` is the one table this domain owns.
+
+## One door, and what holds it
+
+`sideEffects: false`, and inside the package the provider may reach the contract while the contract
+may never reach the provider — a wall in this repo's own lint, with the breach planted through the
+real binary. What that buys is measured rather than asserted: a browser bundle of the built entry
+importing only the contract carries no SQL and no call to an executor, while the same door with
+`pgFtsSearchIndex` imported carries both.
+
+## The conformance kit
+
+What a consumer runs against THEIR OWN index — and the bar this package's provider is held to, on
+real Postgres 17 and 18, in this repo's own suite. The exports are runner-agnostic functions
+returning `SearchConformanceCase[]` (`{ name, run }`); a case fails by throwing
+`ConformanceFailure` from [`@geonosis/conformance`](../../foundations/conformance), which every
+runner already understands, so no test framework rides along.
+
+```ts
+for (const one of searchConformance(subject)) await one.run()
+```
+
+A `SearchSubject` is `{ examples, inTenant, outsideAnySession?, reset }`. Each `SearchExample` is a
+document plus two words: `findableBy`, which its projection derives, and `notFindableBy`, which the
+document CARRIES and no projection READS. That second word is the whole exam for a derived
+projection: an index that stored the record it was handed is found by it, and nothing else can tell
+the two apart from outside.
+
+The three sets, which can be run alone:
+
+- `vocabularyConformance` — a filter, a value or an ordering the index never declared is REFUSED,
+  every declared filter publishes its values, and — the control — a query inside the vocabulary is
+  answered, because an index that refused everything would pass the refusals;
+- `derivedProjectionConformance` — findable by what was derived, invisible to what was not, one row
+  per document however often it is indexed, and gone once retired;
+- `tenantIsolationConformance` — a tenant finds only its own, a read that names no tenant finds
+  nothing, and one tenant cannot retire another's document. It REFUSES a subject with no
+  `outsideAnySession` rather than passing a claim it could not test.
+
+**What it does not measure: retrieval semantics.** Which words match, how a rank is computed,
+whether a prefix or a stem or a synonym counts — those live in the DDL and in the dialect, and they
+differ by design between one index and the next. An index that passes this exam may still rank
+badly.
+
+## Types
+
+`DocumentFields`, `IndexedDocument`, `DocumentAddress`, `SearchProjection`, `SearchProjections`,
+`SearchVocabulary`, `SearchOptions`, `SearchHit`, `SearchPage`, `SearchCursor`, `SearchCursorKey`,
+`ReadQuery`, `ReadFilter`, `SearchIndex`.