@bendyline/gilde 0.2.4 → 0.2.6

package/README.md

@@ -71,6 +71,17 @@ against the JSON Schemas in schemas/ (generated from gezel's
 
 canonical Zod schemas — do not edit them here).
 
+## Build a Gezel app
+
+An app is a project type composing a custom page, project settings, and any roles,
+craftbooks, scripts, and data it needs. Read the public
+[app authoring guide](https://github.com/bendyline/gezel/blob/main/docs/handboek/technical/building-ai-apps-inside-gezel.md),
+[page API guide](https://github.com/bendyline/gezel/blob/main/docs/handboek/technical/gezel-page-apis.md), and
+[page style guide](https://github.com/bendyline/gezel/blob/main/docs/handboek/technical/gezel-app-page-style-guide.md).
+For this repository's standalone demo requirements, use
+[Authoring type pages](docs/page-authoring.md). Hosted pages receive shared fonts;
+they use the same scoped APIs for files, renditions, and data queries.
+
 ## Try the project pages locally
 
 Run the standalone page gallery from the repository root:

package/authoring/LICENSE-HankenGrotesk-OFL-1.1.txt

@@ -0,0 +1,94 @@
+Copyright (c) 2020, Alfredo Marco Pradil (https://hanken.co),
+with Reserved Font Name "Hanken Grotesk".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical writer
+or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/authoring/LICENSE-PTSerif-OFL-1.1.txt

@@ -0,0 +1,94 @@
+Copyright (c) 2010, ParaType Ltd. (http://www.paratype.com/public),
+with Reserved Font Names "PT Sans", "PT Serif" and "ParaType".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical writer
+or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/authoring/knowledge-keywords/README.md

@@ -0,0 +1,100 @@
+# Knowledge catalog keywords
+
+Gezel suggests a knowledge catalog a person has not installed when what they
+type names something it covers: "angioplasty" for *Wikipedia: Medicine &
+Health*, "Seattle" for *Pacific Northwest*. The phrases live in
+`keywords.json` beside each catalog's identity manifest
+(`data/knowledge-catalogs/<shard>/<id>/keywords.json`), in the shape of
+`schemas/knowledge-catalog-keywords.schema.json`:
+
+```json
+{
+  "schemaVersion": 1,
+  "catalogId": "regional-pacific-northwest",
+  "sourceVersion": "2026.10.3",
+  "terms": ["Pacific Northwest", "PNW", "Cascadia"],
+  "articles": [
+    "Bend, Oregon | Bend",
+    "Spokane, Washington | Spokane | The Lilac City"
+  ],
+  "matchCase": ["Bend"]
+}
+```
+
+- `terms` are hand-written here, in `rules.json`, and are the only phrases
+  for catalogs without a Parquet companion (case law, Microsoft docs, how-to
+  books).
+- `articles` are generated: one line per article, its title first, then the
+  other phrases that name it, joined by ` | `.
+- `matchCase` phrases match only with this capitalization. A name made of
+  everyday words ("Bend", "Frozen", "The Office") would otherwise fire on
+  ordinary speech.
+
+Phrases match on word boundaries and ignore case otherwise (gezel core's
+`PhraseIndex`).
+
+## Regenerating
+
+```sh
+npm run build-knowledge-keywords -- --cache=/tmp/gilde-keywords
+npm run fix
+npm run check
+```
+
+Run it after adding a knowledge catalog, after a catalog's new version, or
+after changing `rules.json`; `--catalog=<id>` limits the run to some
+catalogs. It needs the DuckDB CLI (`duckdb` on `PATH`, or `--duckdb=<path>`)
+and network access to Hugging Face: it reads only the `title`, `aliases`,
+`topic_path`, `chunk_count` and `summary` columns of each catalog's pinned
+Parquet companion, about 3 MB per catalog. `--cache` keeps them between
+runs.
+
+## How articles are chosen
+
+Each catalog's articles are ranked by `ln(1 + chunks) × (1 + aliases)`, then
+filtered:
+
+- list, timeline, history-of and similar titles are skipped, and so is any
+  title with a year in it (seasons, editions, events);
+- a qualifier is stripped from what is matched ("Frozen (2013 film)"
+  matches "Frozen"), and regional catalogs also match the place before the
+  comma ("Spokane, Washington" matches "Spokane");
+- an alias is dropped when the article's other phrases already match it,
+  when it is all capitals ("PTA"), or when it is a code or a URL;
+- phrases shorter than four characters and phrases with a blocked word are
+  dropped.
+
+Whether a word is an everyday word comes from the catalogs' own summaries,
+which are written in sentence case: "water" and "bend" appear in lowercase,
+"Manchester" and "Seattle" do not. The system dictionary
+(`/usr/share/dict/words`) settles words the summaries rarely use; the
+committed files were built with the one macOS ships.
+
+- **Named catalogs** (`commonWords: "matchCase"`, the default) keep a short
+  name made only of everyday words, case-sensitively.
+- **Concept catalogs** (`commonWords: "drop"`) keep everyday words,
+  case-insensitively, because "asthma" and "gout" are what they are about.
+  They drop a single word that also appears in 250 or more article titles of
+  other catalogs: "heart", "water" and "pain" name too much to mean medicine.
+
+## rules.json
+
+`defaults`, then the first matching `families` prefix, then `catalogs.<id>`,
+each overriding the last:
+
+| Field | Meaning |
+|---|---|
+| `terms` | Hand-written phrases about the catalog as a whole. |
+| `maxArticles` | Most articles kept; the file is also held under 900 KB. |
+| `maxAliases` | Most aliases kept per article. |
+| `commonWords` | `"matchCase"` for named things, `"drop"` for concepts. |
+| `excludeTopics` | Second-level topic ids to skip (`"music-albums"`). |
+| `geographyOnly` | Keep only `*-geography` articles (regional catalogs). |
+| `placeNames` | Also match the place before a comma. |
+| `matchCase` | Extra phrases to match case-sensitively. |
+| `exclude` | Phrases never to emit. |
+| `blockedWords`, `blockedRoots` | Words, and word fragments, that drop any phrase containing them. |
+
+The generator warns about a term no title in the catalog mentions. Region
+names ("Pacific Northwest", "Cascadia") are expected there; a place the
+catalog has no articles about is a claim to remove.