@thi.ng/proctext 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+- **Last updated**: 2024-07-19T14:56:21Z
+- **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org/) for commit guidelines.
+
+**Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
+and/or version bumps of transitive dependencies.
+
+## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/proctext@0.1.0) (2024-07-19)
+
+#### 🚀 Features
+
+- import as new pkg ([1f96e4d](https://github.com/thi-ng/umbrella/commit/1f96e4d))
+- update grammar, case-sensitive var names ([059bffb](https://github.com/thi-ng/umbrella/commit/059bffb))

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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,337 @@
+<!-- This file is generated - DO NOT EDIT! -->
+<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
+# ![@thi.ng/proctext](https://media.thi.ng/umbrella/banners-20230807/thing-proctext.svg?de076745)
+
+[![npm version](https://img.shields.io/npm/v/@thi.ng/proctext.svg)](https://www.npmjs.com/package/@thi.ng/proctext)
+![npm downloads](https://img.shields.io/npm/dm/@thi.ng/proctext.svg)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
+
+> [!NOTE]
+> This is one of 189 standalone projects, maintained as part
+> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
+> and anti-framework.
+>
+> 🚀 Please help me to work full-time on these projects by [sponsoring me on
+> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️
+
+- [About](#about)
+- [Features](#features)
+  - [Line comments](#line-comments)
+  - [Multi-value variables](#multi-value-variables)
+  - [Recursive variable expansion](#recursive-variable-expansion)
+  - [Variable assignments](#variable-assignments)
+  - [Hidden assignments](#hidden-assignments)
+  - [Dynamic, indirect variable references](#dynamic-indirect-variable-references)
+  - [Controlled randomness](#controlled-randomness)
+- [Status](#status)
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [Usage examples](#usage-examples)
+- [API](#api)
+- [Authors](#authors)
+- [License](#license)
+
+## About
+
+Extensible procedural text generation engine with dynamic, mutable state, indirection, randomizable & recursive variable expansions.
+
+## Features
+
+The generator works with a simple plain text format, supporting the following
+features:
+
+### Line comments
+
+Lines starting with `#` are comments and completely ignored, and invisible in
+the output. No block comments are available.
+
+### Multi-value variables
+
+Text generation and expansion relies on variables, which are defined inline
+(inside the text given to the generator). New variables can be defined as
+follows and each variable can define one or more possible values (one value per
+line!):
+
+```text
+[name]
+alice
+bob
+ciara
+```
+
+If more than a single value is given, a [semi-random
+choice](#controlled-randomness) will be made for each instance/occurrence of the
+var...
+
+Variables are case-sensitive (i.e. `NAME` is a different var than `name`) and
+can also be re-defined overridden in different parts of the document.
+
+Variables are referenced via: `<name>`:
+
+```ts tangle:export/readme-intro.ts
+import { generate } from "@thi.ng/proctext";
+
+const { result } = await generate(`
+[name]
+alice
+bob
+
+[action]
+walked
+cycled
+ran
+swam
+
+[place]
+office
+shop
+cafe
+lake
+
+[time]
+this morning
+last night
+a week ago
+
+# The actual generated text...
+<time> <name> <action> to the <place>.
+`);
+
+console.log(result);
+
+// last night alice cycled to the cafe.
+```
+
+### Recursive variable expansion
+
+Variable values can contain cyclic references and/or references to other
+variables.
+
+> [!IMPORTANT]
+> In the case of cyclic refs, you MUST provide at least one non-cyclic option
+> to avoid infinite recursion!
+
+```ts tangle:export/readme-var-recursion.ts
+import { generate } from "@thi.ng/proctext";
+
+const { result } = await generate(`
+[activity]
+walking and <activity_alt>
+hiking and <activity_alt>
+# the next option is cyclic...
+cycling, <activity>
+
+[activity_alt]
+sleeping
+coding
+
+I enjoy <activity>.
+`);
+
+console.log(result);
+
+// I enjoy cycling, walking and coding.
+```
+
+### Variable assignments
+
+New variables can be declared & initialized via `<varname=existing>`. This will
+create a new variable `varname` with a choice value of variable `existing`
+(which must already be defined).
+
+```ts tangle:export/readme-var-assign.ts
+import { generate } from "@thi.ng/proctext";
+
+const { result } = await generate(`
+[name]
+Alice
+Bob
+Charlie
+Dora
+
+Let's pick some random names: <hero1=name> and <hero2=name>.
+
+But now we can use them as constants:
+<hero1>, <hero1>, <hero1> & <hero2>, <hero2>, <hero2>
+`);
+
+console.log(result);
+
+// Let's pick some random names: Dora and Bob.
+//
+// But now we can use them as constants:
+// Dora, Dora, Dora & Bob, Bob, Bob
+```
+
+### Hidden assignments
+
+Normally, variable assignments are also causing the chosen value to be emitted
+as part of the generated text. Sometimes it is useful to _not_ do so and
+emission can be surpressed/hidden by using the prefix `!` as part of the
+assignment, like so:
+
+```ts tangle:export/readme-hidden-var.ts
+import { generate } from "@thi.ng/proctext";
+
+const { result } = await generate(`
+[name]
+Asterix
+Obelix
+
+# hidden assignment
+<!hero=name>
+My name is <hero>.`);
+
+console.log(result);
+
+// My name is Asterix.
+```
+
+### Dynamic, indirect variable references
+
+Given a variable assignment like `<hero=name>`, we can use dots in the name to
+lookup derived variables with their name based on current value(s).
+
+For the following example:
+
+- assume the assignment of `<hero=name>` picked value `a`
+- now the var lookup `<hero.job>` will look for a var called `a.job`
+- there's only one option for `a.job`, i.e. `astronaut`
+- the lookup `hero.job.desc` will then look for `astronaut.desc`
+
+```ts tangle:export/readme-indirect.ts
+import { generate } from "@thi.ng/proctext";
+
+const { result } = await generate(`
+[name]
+A
+B
+
+[A.job]
+astronaut
+
+[B.job]
+baker
+
+[astronaut.desc]
+shooting for the stars
+flying to the moon
+
+[baker.desc]
+baking bread
+
+<hero=name> is a <hero.job>, <hero.job.desc>.`);
+
+console.log(result);
+
+```
+
+### Controlled randomness
+
+The selection of variable choices is determined by the configured [PRNG
+instance](https://thi.ng/random), the number of recent values selected/memorized
+and the number of attempts made to pick a new unique choice. All of these can be
+configured via options given to `generate()`:
+
+```ts
+import { generate } from "@thi.ng/proctext";
+import { SYSTEM } from "@thi.ng/random";
+
+// here we show default options used
+generate(`...`, {
+    rnd: SYSTEM,
+    maxHist: 1,
+    maxTrials: 10
+});
+```
+
+The `maxHist = 1` means that for each variable only the last value picked will
+be memorized. If more than 1 value options exists for a variable, successive var
+expansions will not result in duplicates, e.g.
+
+```text
+[name]
+a
+b
+
+<name> <name> <name>
+```
+
+...will only ever result in one of these two sequences: `a b a` or `b a b`.
+
+## Status
+
+**ALPHA** - bleeding edge / work-in-progress
+
+[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bproctext%5D+in%3Atitle)
+
+## Installation
+
+```bash
+yarn add @thi.ng/proctext
+```
+
+ESM import:
+
+```ts
+import * as pro from "@thi.ng/proctext";
+```
+
+Browser ESM import:
+
+```html
+<script type="module" src="https://esm.run/@thi.ng/proctext"></script>
+```
+
+[JSDelivr documentation](https://www.jsdelivr.com/)
+
+For Node.js REPL:
+
+```js
+const pro = await import("@thi.ng/proctext");
+```
+
+Package sizes (brotli'd, pre-treeshake): ESM: 1.14 KB
+
+## Dependencies
+
+- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+- [@thi.ng/arrays](https://github.com/thi-ng/umbrella/tree/develop/packages/arrays)
+- [@thi.ng/associative](https://github.com/thi-ng/umbrella/tree/develop/packages/associative)
+- [@thi.ng/defmulti](https://github.com/thi-ng/umbrella/tree/develop/packages/defmulti)
+- [@thi.ng/parse](https://github.com/thi-ng/umbrella/tree/develop/packages/parse)
+- [@thi.ng/random](https://github.com/thi-ng/umbrella/tree/develop/packages/random)
+- [@thi.ng/strings](https://github.com/thi-ng/umbrella/tree/develop/packages/strings)
+
+## Usage examples
+
+One project in this repo's
+[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples)
+directory is using this package:
+
+| Screenshot                                                                                                             | Description                                                                              | Live demo                                             | Source                                                                             |
+|:-----------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/procedural-text.jpg" width="240"/> | Procedural stochastic text generation via custom DSL, parse grammar & AST transformation | [Demo](https://demo.thi.ng/umbrella/procedural-text/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/procedural-text) |
+
+## API
+
+[Generated API docs](https://docs.thi.ng/umbrella/proctext/)
+
+## Authors
+
+- [Karsten Schmidt](https://thi.ng)
+
+If this project contributes to an academic publication, please cite it as:
+
+```bibtex
+@misc{thing-proctext,
+  title = "@thi.ng/proctext",
+  author = "Karsten Schmidt",
+  note = "https://thi.ng/proctext",
+  year = 2023
+}
+```
+
+## License
+
+&copy; 2023 - 2024 Karsten Schmidt // Apache License 2.0

package/api.d.ts

@@ -0,0 +1,36 @@
+import type { Fn, MaybePromise } from "@thi.ng/api";
+import type { IRandom } from "@thi.ng/random";
+export interface Var {
+    opts: string[];
+    history: string[];
+}
+export interface GeneratorContext {
+    /**
+     * Object of variables and their possible expansions (value options).
+     */
+    vars: Record<string, Var>;
+    /**
+     * Object of modifier functions to transform.
+     */
+    mods: Record<string, Fn<string, MaybePromise<string>>>;
+    /**
+     * PRNG to use for selection variable options (see {@link Var.opts}).
+     */
+    rnd: IRandom;
+    /**
+     * Max number of choices to record per variable. When picking a possible
+     * value for resolving a variable, the generator attempts to pick values
+     * which are different than the last N choices.
+     *
+     * @defaultValue 1
+     */
+    maxHist: number;
+    /**
+     * Max attempts to find a new unique choice for variable
+     * expansions/resolution
+     *
+     * @defaultValue 10
+     */
+    maxTrials: number;
+}
+//# sourceMappingURL=api.d.ts.map

package/generate.d.ts

@@ -0,0 +1,39 @@
+import type { GeneratorContext } from "./api.js";
+/**
+ * Default variable modifiers (capitalize, uppercase, lowercase)
+ */
+export declare const DEFAULT_MODIFIERS: GeneratorContext["mods"];
+/**
+ * Parser grammar rules for the custom text/DSL format used for this text
+ * generator. These rules were created with & exported from this playground URL:
+ *
+ * Source:
+ * https://demo.thi.ng/umbrella/parse-playground/#l9oCWyMgbWFpbiBwYXJzZXIgcnVsZQptYWluOiA8U1RBUlQ-ICggPGRlZj4gfCA8Y29tbWVudD4gfCA8YmluZGluZz4gfCA8d29yZD4gKSogPEVORD4gPT4gaG9pc3QgOwoKIyB2YXJpYWJsZSBkZWZpbml0aW9uCmRlZjogPFdTMD4gPExTVEFSVD4gJ1snISA8aWQ-ICddJyEgPEROTD4gKDxjb21tZW50PiB8IDx2YWx1ZT4pKyA8RE5MPiA7CmlkOiAoIDxBTFBIQV9OVU0-IHwgWy5cdTAwMmRdICkrID0-IGpvaW4gOwp2YWx1ZTogLig_KzxETkw-KSA9PiBqb2luIDsKCiMgdmFyaWFibGUgYmluZGluZ3MKYmluZGluZzogJzwnISAoPHNldHZhcj4gfCA8dmFyPikgJz4nISA9PiBob2lzdCA7CnZhcjogPGlkPiA8bW9kaWZpZXI-PyA7Cm1vZGlmaWVyOiA8bW9kaWQ-KyA7Cm1vZGlkOiAnOychIDxBTFBIQV9OVU0-KyA9PiBqb2luIDsKc2V0dmFyOiAnISc_IDxpZD4gJz0nISA8dmFyPiA7CgojIGxpbmUgY29tbWVudApjb21tZW50OiA8TFNUQVJUPiAnIycgLig_KzxETkw-KSA9PiBkaXNjYXJkIDsKCiMgdmVyYmF0aW0gdGV4dAp3b3JkOiAoIDxBTFBIQV9OVU0-IHwgWyA_IS4sJyJAIyQlJigpe307Oi8qPStcdTAwMmRcdTAwNWJcdTAwNWRcdTAwMGFdICkrID0-IGpvaW4gO6RtYWlu2gETW25hbWVdCkFsaWNlCiMgY29tbWVudCBpbnNpZGUgbGlzdApCb2IKCltwbGFjZV0KdG93bgp0aGUgd29vZHMKCiMgQ29tbWVudCBsaW5lClthY3Rpdml0eV0KY3ljbGluZyBhbmQgPGFjdC5hbHQ-Cmhpa2luZwoKT25jZSB1cG9uIGEgdGltZSwgPGhlcm8xPW5hbWU-IGFuZCA8aGVybzI9bmFtZT4gd2VudCB0byA8cGxhY2U-LiA8aGVybzE-IHRoZW4gZGlkIHNvbWUgPGFjdGl2aXR5PiwgYnV0IDxoZXJvMj4gY2hvc2UgdG8gZG8gPGFjdGl2aXR5O3VjPiBpbnN0ZWFkLgoKVGhlIGVuZC6goKCg
+ */
+export declare const GRAMMAR: import("@thi.ng/parse").Language | undefined;
+/**
+ * Main text generation function. First parses input string, then (if there were
+ * no parse errors) traverses the document AST and generates text according to
+ * the rules and provided options (e.g. predefined vars, modifiers etc). Returns
+ * promise to an object with resulting text and processing status/error.
+ *
+ * @remarks
+ * If the generation was successful, the result object will also contain the
+ * update {@link GeneratorContext}, which can then be re-used for future
+ * invocations (i.e. to retain state between multiple generations).
+ *
+ * @param src
+ * @param ctx
+ */
+export declare const generate: (src: string, ctx?: Partial<GeneratorContext>) => Promise<{
+    type: string;
+    result: string;
+    ctx: GeneratorContext;
+    err?: undefined;
+} | {
+    type: string;
+    err: Error;
+    result?: undefined;
+    ctx?: undefined;
+}>;
+//# sourceMappingURL=generate.d.ts.map

package/generate.js

@@ -0,0 +1,145 @@
+import { peek } from "@thi.ng/arrays/peek";
+import { mergeDeepObj } from "@thi.ng/associative/merge-deep";
+import { DEFAULT, defmulti } from "@thi.ng/defmulti/defmulti";
+import { defContext } from "@thi.ng/parse/context";
+import { defGrammar } from "@thi.ng/parse/grammar";
+import { SYSTEM } from "@thi.ng/random/system";
+import { pickRandomUnique } from "@thi.ng/random/unique-indices";
+import { capitalize, lower, upper } from "@thi.ng/strings/case";
+const DEFAULT_MODIFIERS = {
+  cap: capitalize,
+  uc: upper,
+  lc: lower
+};
+const GRAMMAR = defGrammar(`
+# main parser rule
+main: <START> ( <def> | <comment> | <binding> | <word> )* <END> => hoist ;
+
+# variable definition
+def: <WS0> <LSTART> '['! <id> ']'! <DNL> (<comment> | <value>)+ <DNL> ;
+id: ( <ALPHA_NUM> | [.\\u002d] )+ => join ;
+value: .(?+<DNL>) => join ;
+
+# variable bindings
+binding: '<'! (<setvar> | <var>) '>'! => hoist ;
+var: <id> <modifier>? ;
+modifier: <modid>+ ;
+modid: ';'! <ALPHA_NUM>+ => join ;
+setvar: '!'? <id> '='! <var> ;
+
+# line comment
+comment: <LSTART> '#' .(?+<DNL>) => discard ;
+
+# verbatim text
+word: ( <ALPHA_NUM> | [ ?!.,'"@#$%&(){};:/*=+\\u002d\\u005b\\u005d\\u000a] )+ => join ;
+`);
+const __parse = (src, opts) => {
+  const ctx = defContext(src, opts);
+  return { result: GRAMMAR.rules.main(ctx), ctx };
+};
+const generate = async (src, ctx) => {
+  try {
+    const { result, ctx: parseCtx } = __parse(src.trim());
+    if (result) {
+      const $ctx = mergeDeepObj(
+        {
+          vars: {},
+          mods: DEFAULT_MODIFIERS,
+          rnd: SYSTEM,
+          maxTrials: 10
+        },
+        ctx
+      );
+      const acc = [];
+      await __transformScope(parseCtx.root, $ctx, acc);
+      return {
+        type: parseCtx.done ? "success" : "partial",
+        result: acc.join(""),
+        ctx: $ctx
+      };
+    } else {
+      return { type: "error", err: new Error(`parse error`) };
+    }
+  } catch (e) {
+    return { type: "error", err: e };
+  }
+};
+const __transformScope = defmulti(
+  (x) => x.id,
+  {},
+  {
+    // fallback handler for unknown tree nodes (usually a grammar error)
+    [DEFAULT]: async (scope) => {
+      throw new Error(`missing impl for scope ID: ${scope.id}`);
+    },
+    // handler for processing the root node (just traverses children)
+    root: async ({ children }, ctx, acc) => {
+      if (!children) return;
+      for (let x of children[0].children)
+        await __transformScope(x, ctx, acc);
+    },
+    // handler for a new variable definition and its possible values
+    def: async ({ children }, ctx) => {
+      ctx.vars[children[0].result] = {
+        opts: children[1].children.map((x) => x.result),
+        history: []
+      };
+    },
+    // handler for variable lookups
+    var: async (scope, ctx, acc) => {
+      acc.push(await __expandVar(scope, ctx));
+    },
+    // handler for variable assignments
+    setvar: async ({ children }, ctx, acc) => {
+      const choice = await __expandVar(children[2], ctx);
+      ctx.vars[children[1].result] = {
+        opts: [choice],
+        history: [choice]
+      };
+      if (!children[0].result) acc.push(choice);
+    },
+    // handler for verbatim text
+    word: async ({ result }, _, acc) => {
+      acc.push(result);
+    }
+  }
+);
+const __resolveVarName = (name, ctx) => {
+  if (name.indexOf(".") == -1) return name;
+  let resolved = "";
+  for (let x of name.split(".")) {
+    const $name = resolved + "." + x;
+    const $var = resolved ? ctx.vars[$name] : ctx.vars[x];
+    if ($var)
+      resolved = ($var.history.length ? peek($var.history) : "") || $name;
+  }
+  return resolved;
+};
+const __expandVar = async ({ children }, ctx) => {
+  const id = __resolveVarName(children[0].result, ctx);
+  const $var = ctx.vars[id];
+  if (!$var) throw new Error(`unknown variable: ${id}`);
+  pickRandomUnique(1, $var.opts, $var.history, ctx.maxTrials, ctx.rnd);
+  if ($var.history.length > ctx.maxHist) $var.history.shift();
+  const choice = peek($var.history);
+  const result = await generate(choice, ctx);
+  if (result.err) {
+    throw new Error(
+      result.err.message.includes("recursion") ? `error expanding variable: ${id} (cycle detected)` : result.err.message
+    );
+  }
+  let value = result.result;
+  if (children[1].children) {
+    for (let mod of children[1].children) {
+      const modFn = ctx.mods[mod.result];
+      if (modFn) value = await modFn(value);
+      else throw new Error(`unknown modifier: ${mod.result}`);
+    }
+  }
+  return value;
+};
+export {
+  DEFAULT_MODIFIERS,
+  GRAMMAR,
+  generate
+};

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./api.js";
+export * from "./generate.js";
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,2 @@
+export * from "./api.js";
+export * from "./generate.js";

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@thi.ng/proctext",
+  "version": "0.1.0",
+  "description": "Extensible procedural text generation engine with dynamic, mutable state, indirection, randomizable & recursive variable expansions",
+  "type": "module",
+  "module": "./index.js",
+  "typings": "./index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thi-ng/umbrella.git"
+  },
+  "homepage": "https://thi.ng/proctext",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/postspectacular"
+    },
+    {
+      "type": "patreon",
+      "url": "https://patreon.com/thing_umbrella"
+    }
+  ],
+  "author": "Karsten Schmidt (https://thi.ng)",
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "yarn build:esbuild && yarn build:decl",
+    "build:decl": "tsc --declaration --emitDeclarationOnly",
+    "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts",
+    "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
+    "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
+    "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
+    "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
+    "pub": "yarn npm publish --access public",
+    "test": "bun test",
+    "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
+  },
+  "dependencies": {
+    "@thi.ng/api": "^8.11.6",
+    "@thi.ng/arrays": "^2.9.11",
+    "@thi.ng/associative": "^6.3.65",
+    "@thi.ng/defmulti": "^3.0.44",
+    "@thi.ng/parse": "^2.4.47",
+    "@thi.ng/random": "^3.8.5",
+    "@thi.ng/strings": "^3.8.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.47.0",
+    "esbuild": "^0.23.0",
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.3"
+  },
+  "keywords": [
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "browser": {
+    "process": false,
+    "setTimeout": false
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "./*.js",
+    "./*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "default": "./index.js"
+    },
+    "./api": {
+      "default": "./api.js"
+    },
+    "./generate": {
+      "default": "./generate.js"
+    }
+  },
+  "thi.ng": {
+    "status": "alpha",
+    "year": 2023
+  },
+  "gitHead": "c7aaa453b01a45e5235517db9d2a283b97abac96\n"
+}