@tinta-lang/engine 0.1.0-dev.0 → 0.1.16

package/README.md

@@ -0,0 +1,25 @@
+# @tinta-lang/engine
+
+Compile and evaluate tinta documents. Create a session to change controls and receive a complete new document state after each valid change.
+
+```ts
+import { compile, createSession } from "@tinta-lang/engine";
+
+const compiled = compile({
+  uri: "tinta:example",
+  profile: "tinta",
+  text: "@slider people = 5\n@calc total = people * 19\n{{ total }}\n",
+});
+
+if (compiled.ok) {
+  const created = createSession(compiled.value);
+  if (created.ok) {
+    created.value.setControl("people", 6);
+    created.value.destroy();
+  }
+}
+```
+
+Check each result before using its value. An invalid control change leaves the previous state intact. This package does not mount a reader or access files.
+
+See the [engine API](https://github.com/planta7/tinta/blob/main/docs/11_ENGINE_API.md).

package/dist/registry.d.ts

@@ -93,10 +93,10 @@ export declare const registry: {
         readonly E_EXPRESSION_SYNTAX: "Invalid/unfinished expression token sequence.";
         readonly E_NAME_RESERVED: "Reserved or invalid identifier.";
         readonly E_NAME_DUPLICATE: "Document name declared more than once.";
-        readonly E_NAME_UNKNOWN: "Unresolved global name.";
+        readonly E_NAME_UNKNOWN: "This name has not been defined in the document.";
         readonly E_ROW_SCOPE: "row.field used outside a supported row context.";
         readonly E_COLUMN_UNKNOWN: "Referenced table column does not exist.";
-        readonly E_TYPE: "Types do not satisfy an operator/directive/function contract.";
+        readonly E_TYPE: "This value has the wrong type for this operation.";
         readonly E_FUNCTION_ARITY: "Incorrect number of function arguments.";
         readonly E_CONST_DEPENDENCY: "Constant depends on nonconstant state/data.";
         readonly E_CYCLE: "Dependency cycle detected.";
@@ -105,7 +105,7 @@ export declare const registry: {
         readonly E_DIGITS_RANGE: "Formatting/rounding digits are outside integer 0–10.";
         readonly E_EMPTY_MEAN: "Mean requested for an empty table/view.";
         readonly E_STATE_NAME: "Update names an unknown/non-control symbol.";
-        readonly E_STATE_DOMAIN: "Control update/default violates its allowed domain.";
+        readonly E_STATE_DOMAIN: "The control value is outside its allowed range or choices.";
         readonly E_DATA_HEADER: "Invalid or duplicate typed table header.";
         readonly E_DATA_ARITY: "Row cell count differs from the schema.";
         readonly E_DATA_VALUE: "Cell is not a valid scalar for its declared type.";
@@ -124,11 +124,11 @@ export declare const registry: {
         readonly E_ASSET_PATH: "Unsafe resource or ZIP entry path.";
         readonly E_BUNDLE: "Malformed bundle, duplicate keys/entries, CRC or manifest mismatch.";
         readonly E_HASH_MISMATCH: "Source/resource hash does not match its envelope.";
-        readonly E_SNAPSHOT: "State envelope does not match source/schema/controls.";
+        readonly E_SNAPSHOT: "The saved answers do not match this document and its controls.";
         readonly E_EXPORT_INVALID: "Export requested for invalid/stale source or an invalid state.";
         readonly E_OUTPUT_EXISTS: "Output already exists and replacement is not authorized.";
-        readonly E_IO: "Authorized filesystem operation failed.";
-        readonly E_WORKER_TIMEOUT: "Worker did not complete before the watchdog.";
+        readonly E_IO: "Could not read or write the selected file.";
+        readonly E_WORKER_TIMEOUT: "The document took too long to process.";
         readonly E_PROTOCOL: "Malformed or unauthorized host protocol message; stale valid results are ignored.";
         readonly E_INTERNAL: "Unexpected engine fault; not a document syntax diagnosis.";
     };
@@ -137,7 +137,7 @@ export declare const registry: {
         readonly W_HTML_INERT: "Raw author HTML displayed as text.";
         readonly W_LINK_LOCAL_UNSUPPORTED: "Local document navigation is not implemented.";
         readonly W_LINK_UNSAFE: "Unsafe/unsupported link disabled.";
-        readonly W_ASSET_UNAVAILABLE: "Preview image unavailable; export remains blocked.";
+        readonly W_ASSET_UNAVAILABLE: "A document image is unavailable. Exports require all images they include.";
         readonly W_RECOVERY_UNAVAILABLE: "Local browser recovery is unavailable.";
         readonly W_MARKDOWN_COLLISION: "Enrichment proposes escapes for Tinta-looking literal text.";
     };

package/dist/registry.js

@@ -149,10 +149,10 @@ export const registry = {
         E_EXPRESSION_SYNTAX: "Invalid/unfinished expression token sequence.",
         E_NAME_RESERVED: "Reserved or invalid identifier.",
         E_NAME_DUPLICATE: "Document name declared more than once.",
-        E_NAME_UNKNOWN: "Unresolved global name.",
+        E_NAME_UNKNOWN: "This name has not been defined in the document.",
         E_ROW_SCOPE: "row.field used outside a supported row context.",
         E_COLUMN_UNKNOWN: "Referenced table column does not exist.",
-        E_TYPE: "Types do not satisfy an operator/directive/function contract.",
+        E_TYPE: "This value has the wrong type for this operation.",
         E_FUNCTION_ARITY: "Incorrect number of function arguments.",
         E_CONST_DEPENDENCY: "Constant depends on nonconstant state/data.",
         E_CYCLE: "Dependency cycle detected.",
@@ -161,7 +161,7 @@ export const registry = {
         E_DIGITS_RANGE: "Formatting/rounding digits are outside integer 0\u201310.",
         E_EMPTY_MEAN: "Mean requested for an empty table/view.",
         E_STATE_NAME: "Update names an unknown/non-control symbol.",
-        E_STATE_DOMAIN: "Control update/default violates its allowed domain.",
+        E_STATE_DOMAIN: "The control value is outside its allowed range or choices.",
         E_DATA_HEADER: "Invalid or duplicate typed table header.",
         E_DATA_ARITY: "Row cell count differs from the schema.",
         E_DATA_VALUE: "Cell is not a valid scalar for its declared type.",
@@ -180,11 +180,11 @@ export const registry = {
         E_ASSET_PATH: "Unsafe resource or ZIP entry path.",
         E_BUNDLE: "Malformed bundle, duplicate keys/entries, CRC or manifest mismatch.",
         E_HASH_MISMATCH: "Source/resource hash does not match its envelope.",
-        E_SNAPSHOT: "State envelope does not match source/schema/controls.",
+        E_SNAPSHOT: "The saved answers do not match this document and its controls.",
         E_EXPORT_INVALID: "Export requested for invalid/stale source or an invalid state.",
         E_OUTPUT_EXISTS: "Output already exists and replacement is not authorized.",
-        E_IO: "Authorized filesystem operation failed.",
-        E_WORKER_TIMEOUT: "Worker did not complete before the watchdog.",
+        E_IO: "Could not read or write the selected file.",
+        E_WORKER_TIMEOUT: "The document took too long to process.",
         E_PROTOCOL: "Malformed or unauthorized host protocol message; stale valid results are ignored.",
         E_INTERNAL: "Unexpected engine fault; not a document syntax diagnosis.",
     },
@@ -193,7 +193,7 @@ export const registry = {
         W_HTML_INERT: "Raw author HTML displayed as text.",
         W_LINK_LOCAL_UNSUPPORTED: "Local document navigation is not implemented.",
         W_LINK_UNSAFE: "Unsafe/unsupported link disabled.",
-        W_ASSET_UNAVAILABLE: "Preview image unavailable; export remains blocked.",
+        W_ASSET_UNAVAILABLE: "A document image is unavailable. Exports require all images they include.",
         W_RECOVERY_UNAVAILABLE: "Local browser recovery is unavailable.",
         W_MARKDOWN_COLLISION: "Enrichment proposes escapes for Tinta-looking literal text.",
     },

package/package.json

@@ -1,6 +1,14 @@
 {
   "name": "@tinta-lang/engine",
-  "version": "0.1.0-dev.0",
+  "version": "0.1.16",
+  "description": "Compile and evaluate interactive tinta documents with transactional controls.",
+  "keywords": [
+    "tinta",
+    "markdown",
+    "expressions",
+    "documents"
+  ],
+  "homepage": "https://github.com/planta7/tinta/blob/main/packages/engine/README.md",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -9,7 +17,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "next"
+    "tag": "latest"
   },
   "exports": {
     ".": {
@@ -26,12 +34,13 @@
     }
   },
   "dependencies": {
-    "@tinta-lang/types": "0.1.0-dev.0",
-    "@tinta-lang/syntax": "0.1.0-dev.0",
+    "@tinta-lang/types": "0.1.16",
+    "@tinta-lang/syntax": "0.1.16",
     "@noble/hashes": "2.4.0"
   },
   "files": [
     "LICENSE",
+    "README.md",
     "THIRD_PARTY_NOTICES.txt",
     "dist/analysis.d.ts",
     "dist/analysis.js",