@jsonforms/core 3.0.0-beta.3 → 3.0.0-rc.0

package/docs/interfaces/statepropsofscopedrenderer.html

@@ -125,7 +125,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#cells">cells</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:313</li>
+							<li>Defined in packages/core/src/util/renderer.ts:316</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -141,7 +141,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#config">config</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:273</li>
+							<li>Defined in packages/core/src/util/renderer.ts:276</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -157,7 +157,7 @@
 					<aside class="tsd-sources">
 						<p>Overrides <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#data">data</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:331</li>
+							<li>Defined in packages/core/src/util/renderer.ts:334</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -173,7 +173,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#enabled">enabled</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:293</li>
+							<li>Defined in packages/core/src/util/renderer.ts:296</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -188,7 +188,7 @@
 					<div class="tsd-signature tsd-kind-icon">errors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:326</li>
+							<li>Defined in packages/core/src/util/renderer.ts:329</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -203,7 +203,7 @@
 					<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:341</li>
+							<li>Defined in packages/core/src/util/renderer.ts:344</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -219,7 +219,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#path">path</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:302</li>
+							<li>Defined in packages/core/src/util/renderer.ts:305</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -235,7 +235,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#renderers">renderers</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:307</li>
+							<li>Defined in packages/core/src/util/renderer.ts:310</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -250,7 +250,7 @@
 					<div class="tsd-signature tsd-kind-icon">root<wbr>Schema<span class="tsd-signature-symbol">:</span> <a href="../globals.html#jsonschema" class="tsd-signature-type">JsonSchema</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:336</li>
+							<li>Defined in packages/core/src/util/renderer.ts:339</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -266,7 +266,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#schema">schema</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:283</li>
+							<li>Defined in packages/core/src/util/renderer.ts:286</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -282,7 +282,7 @@
 					<aside class="tsd-sources">
 						<p>Overrides <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#uischema">uischema</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:321</li>
+							<li>Defined in packages/core/src/util/renderer.ts:324</li>
 						</ul>
 					</aside>
 				</section>
@@ -293,7 +293,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="statepropsofrenderer.html">StatePropsOfRenderer</a>.<a href="statepropsofrenderer.html#visible">visible</a></p>
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:297</li>
+							<li>Defined in packages/core/src/util/renderer.ts:300</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/testercontext.html

@@ -0,0 +1,184 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>TesterContext | JSON Forms Core</title>
+	<meta name="description" content="Documentation for JSON Forms Core">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</div>
+					<ul class="results">
+						<li class="state loading">Preparing search index...</li>
+						<li class="state failure">The search index is not available</li>
+					</ul>
+					<a href="../index.html" class="title">JSON Forms Core</a>
+				</div>
+				<div class="table-cell" id="tsd-widgets">
+					<div id="tsd-filter">
+						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
+						<div class="tsd-filter-group">
+							<div class="tsd-select" id="tsd-filter-visibility">
+								<span class="tsd-select-label">All</span>
+								<ul class="tsd-select-list">
+									<li data-value="public">Public</li>
+									<li data-value="protected">Public/Protected</li>
+									<li data-value="private" class="selected">All</li>
+								</ul>
+							</div>
+							<input type="checkbox" id="tsd-filter-inherited" checked />
+							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
+							<input type="checkbox" id="tsd-filter-only-exported" />
+							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
+						</div>
+					</div>
+					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
+				</div>
+			</div>
+		</div>
+	</div>
+	<div class="tsd-page-title">
+		<div class="container">
+			<ul class="tsd-breadcrumb">
+				<li>
+					<a href="../globals.html">Globals</a>
+				</li>
+				<li>
+					<a href="testercontext.html">TesterContext</a>
+				</li>
+			</ul>
+			<h1>Interface TesterContext</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-comment">
+				<div class="tsd-comment tsd-typography">
+					<div class="lead">
+						<p>Additional context given to a tester in addition to UISchema and JsonSchema.</p>
+					</div>
+				</div>
+			</section>
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">TesterContext</span>
+					</li>
+				</ul>
+			</section>
+			<section class="tsd-panel-group tsd-index-group">
+				<h2>Index</h2>
+				<section class="tsd-panel tsd-index-panel">
+					<div class="tsd-index-content">
+						<section class="tsd-index-section ">
+							<h3>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="testercontext.html#config" class="tsd-kind-icon">config</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="testercontext.html#rootschema" class="tsd-kind-icon">root<wbr>Schema</a></li>
+							</ul>
+						</section>
+					</div>
+				</section>
+			</section>
+			<section class="tsd-panel-group tsd-member-group ">
+				<h2>Properties</h2>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="config" class="tsd-anchor"></a>
+					<h3>config</h3>
+					<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in packages/core/src/testers/testers.ts:70</li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>The form wide configuration object given to JsonForms.</p>
+						</div>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="rootschema" class="tsd-anchor"></a>
+					<h3>root<wbr>Schema</h3>
+					<div class="tsd-signature tsd-kind-icon">root<wbr>Schema<span class="tsd-signature-symbol">:</span> <a href="../globals.html#jsonschema" class="tsd-signature-type">JsonSchema</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in packages/core/src/testers/testers.ts:68</li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>The root JsonSchema of the form. Can be used to resolve references.</p>
+						</div>
+					</div>
+				</section>
+			</section>
+		</div>
+		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
+			<nav class="tsd-navigation primary">
+				<ul>
+					<li class="globals  ">
+						<a href="../globals.html"><em>Globals</em></a>
+					</li>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface">
+						<a href="testercontext.html" class="tsd-kind-icon">Tester<wbr>Context</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="testercontext.html#config" class="tsd-kind-icon">config</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="testercontext.html#rootschema" class="tsd-kind-icon">root<wbr>Schema</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</ul>
+			</nav>
+		</div>
+	</div>
+</div>
+<footer class="with-border-bottom">
+	<div class="container">
+		<h2>Legend</h2>
+		<div class="tsd-legend-group">
+			<ul class="tsd-legend">
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
+				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
+			</ul>
+			<ul class="tsd-legend">
+				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
+				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
+			</ul>
+			<ul class="tsd-legend">
+				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
+			</ul>
+		</div>
+	</div>
+</footer>
+<div class="container tsd-generator">
+	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
+</div>
+<div class="overlay"></div>
+<script src="../assets/js/main.js"></script>
+</body>
+</html>

package/docs/interfaces/uischemaelement.html

@@ -116,7 +116,7 @@
 					<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:141</li>
+							<li>Defined in packages/core/src/models/uischema.ts:178</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -139,7 +139,7 @@
 					<div class="tsd-signature tsd-kind-icon">rule<span class="tsd-signature-symbol">:</span> <a href="rule.html" class="tsd-signature-type">Rule</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:136</li>
+							<li>Defined in packages/core/src/models/uischema.ts:173</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@
 					<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:131</li>
+							<li>Defined in packages/core/src/models/uischema.ts:168</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/verticallayout.html

@@ -109,7 +109,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="layout.html">Layout</a>.<a href="layout.html#elements">elements</a></p>
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:152</li>
+							<li>Defined in packages/core/src/models/uischema.ts:189</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -125,7 +125,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="uischemaelement.html">UISchemaElement</a>.<a href="uischemaelement.html#options">options</a></p>
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:141</li>
+							<li>Defined in packages/core/src/models/uischema.ts:178</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -149,7 +149,7 @@
 					<aside class="tsd-sources">
 						<p>Inherited from <a href="uischemaelement.html">UISchemaElement</a>.<a href="uischemaelement.html#rule">rule</a></p>
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:136</li>
+							<li>Defined in packages/core/src/models/uischema.ts:173</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@
 					<aside class="tsd-sources">
 						<p>Overrides <a href="uischemaelement.html">UISchemaElement</a>.<a href="uischemaelement.html#type">type</a></p>
 						<ul>
-							<li>Defined in packages/core/src/models/uischema.ts:159</li>
+							<li>Defined in packages/core/src/models/uischema.ts:196</li>
 						</ul>
 					</aside>
 				</section>

package/docs/interfaces/withclassname.html

@@ -93,7 +93,7 @@
 					<div class="tsd-signature tsd-kind-icon">class<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in packages/core/src/util/renderer.ts:172</li>
+							<li>Defined in packages/core/src/util/renderer.ts:171</li>
 						</ul>
 					</aside>
 				</section>

package/lib/i18n/i18nUtil.d.ts

@@ -1,14 +1,14 @@
 import { ErrorObject } from 'ajv';
-import { UISchemaElement } from '../models';
+import { Labelable, UISchemaElement } from '../models';
 import { i18nJsonSchema, ErrorTranslator, Translator } from './i18nTypes';
-export declare const getI18nKeyPrefixBySchema: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined) => string | undefined;
+export declare const getI18nKeyPrefixBySchema: (schema: i18nJsonSchema | undefined, uischema: unknown | undefined) => string | undefined;
 /**
  * Transforms a given path to a prefix which can be used for i18n keys.
  * Returns 'root' for empty paths and removes array indices
  */
 export declare const transformPathToI18nPrefix: (path: string) => string;
-export declare const getI18nKeyPrefix: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined, path: string | undefined) => string | undefined;
-export declare const getI18nKey: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined, path: string | undefined, key: string) => string | undefined;
+export declare const getI18nKeyPrefix: (schema: i18nJsonSchema | undefined, uischema: unknown | undefined, path: string | undefined) => string;
+export declare const getI18nKey: (schema: i18nJsonSchema | undefined, uischema: unknown | undefined, path: string | undefined, key: string) => string;
 export declare const defaultTranslator: Translator;
 export declare const defaultErrorTranslator: ErrorTranslator;
 /**
@@ -16,3 +16,8 @@ export declare const defaultErrorTranslator: ErrorTranslator;
  * All errors must correspond to the given schema, uischema or path.
  */
 export declare const getCombinedErrorMessage: (errors: ErrorObject[], et: ErrorTranslator, t: Translator, schema?: i18nJsonSchema, uischema?: UISchemaElement, path?: string) => string;
+/**
+ * This can be used to internationalize the label of the given Labelable (e.g. UI Schema elements).
+ * This should not be used for controls as there we have additional context in the form of the JSON Schema available.
+ */
+export declare const deriveLabelForUISchemaElement: (uischema: Labelable<boolean>, t: Translator) => string | undefined;