@jsonforms/core 2.5.2-alpha.0 → 3.0.0-alpha.2

package/test/util/runtime.test.ts

@@ -27,6 +27,8 @@ import {
   AndCondition,
   ControlElement,
   createAjv,
+  isInherentlyEnabled,
+  JsonFormsCore,
   LeafCondition,
   OrCondition,
   RuleEffect,
@@ -221,8 +223,24 @@ test('evalVisibility show valid case based on schema condition and enum', t => {
     ruleValue: 'bar'
   };
   t.is(evalVisibility(uischema, data, undefined, createAjv()), true);
-  t.is(evalVisibility(uischema, { ...data, ruleValue: 'baz' }, undefined, createAjv()), true);
-  t.is(evalVisibility(uischema, { ...data, ruleValue: 'foo' }, undefined, createAjv()), false);
+  t.is(
+    evalVisibility(
+      uischema,
+      { ...data, ruleValue: 'baz' },
+      undefined,
+      createAjv()
+    ),
+    true
+  );
+  t.is(
+    evalVisibility(
+      uischema,
+      { ...data, ruleValue: 'foo' },
+      undefined,
+      createAjv()
+    ),
+    false
+  );
 });
 
 test('evalVisibility show invalid case', t => {
@@ -514,6 +532,248 @@ test('evalEnablement disable invalid case based on schema condition', t => {
     ruleValue: 'bar'
   };
   t.is(evalEnablement(uischema, data, undefined, createAjv()), false);
-  t.is(evalEnablement(uischema, { ...data, ruleValue: 'baz' }, undefined, createAjv()), false);
-  t.is(evalEnablement(uischema, { ...data, ruleValue: 'foo' }, undefined, createAjv()), true);
+  t.is(
+    evalEnablement(
+      uischema,
+      { ...data, ruleValue: 'baz' },
+      undefined,
+      createAjv()
+    ),
+    false
+  );
+  t.is(
+    evalEnablement(
+      uischema,
+      { ...data, ruleValue: 'foo' },
+      undefined,
+      createAjv()
+    ),
+    true
+  );
+});
+
+test('isInherentlyEnabled disabled globally', t => {
+  t.false(
+    isInherentlyEnabled(
+      { jsonforms: { readonly: true } },
+      null,
+      null,
+      null,
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by ownProps', t => {
+  t.false(
+    isInherentlyEnabled(null, { enabled: false }, null, null, null, null)
+  );
+});
+
+test('isInherentlyEnabled enabled by ownProps', t => {
+  t.true(isInherentlyEnabled(null, { enabled: true }, null, null, null, null));
+});
+
+test('isInherentlyEnabled disabled by uischema', t => {
+  t.false(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: true } } as unknown) as ControlElement,
+      null,
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by uischema over ownProps', t => {
+  t.false(
+    isInherentlyEnabled(
+      null,
+      { enabled: true },
+      ({ options: { readonly: true } } as unknown) as ControlElement,
+      null,
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled enabled by uischema over schema', t => {
+  t.true(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: false } } as unknown) as ControlElement,
+      { readOnly: true },
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by ownProps over schema enablement', t => {
+  t.false(
+    isInherentlyEnabled(
+      null,
+      { enabled: false},
+      null,
+      { readOnly: false },
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by uischema over schema', t => {
+  t.false(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: true } } as unknown) as ControlElement,
+      { readOnly: false },
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by schema', t => {
+  t.false(
+    isInherentlyEnabled(null, null, null, { readOnly: true }, null, null)
+  );
+});
+
+test('isInherentlyEnabled disabled by schema over ownProps', t => {
+  t.false(
+    isInherentlyEnabled(
+      null,
+      { enabled: true },
+      null,
+      { readOnly: true },
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by rule', t => {
+  const leafCondition: SchemaBasedCondition = {
+    scope: '#/properties/ruleValue',
+    schema: { type: 'string', pattern: 'bar' }
+  };
+  const uischema: ControlElement = {
+    type: 'Control',
+    scope: '#/properties/value',
+    rule: {
+      effect: RuleEffect.DISABLE,
+      condition: leafCondition
+    }
+  };
+  const data = {
+    value: 'foo',
+    ruleValue: 'bar'
+  };
+
+  t.false(
+    isInherentlyEnabled(
+      { jsonforms: { core: { ajv: createAjv() } as JsonFormsCore } },
+      null,
+      uischema,
+      null,
+      data,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by global over rule ', t => {
+  const leafCondition: SchemaBasedCondition = {
+    scope: '#/properties/ruleValue',
+    schema: { type: 'string', pattern: 'bar' }
+  };
+  const uischema: ControlElement = {
+    type: 'Control',
+    scope: '#/properties/value',
+    rule: {
+      effect: RuleEffect.ENABLE,
+      condition: leafCondition
+    }
+  };
+  const data = {
+    value: 'foo',
+    ruleValue: 'bar'
+  };
+
+  t.false(
+    isInherentlyEnabled(
+      {
+        jsonforms: {
+          readonly: true,
+          core: { ajv: createAjv() } as JsonFormsCore
+        }
+      },
+      null,
+      uischema,
+      null,
+      data,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled disabled by config', t => {
+  t.false(
+    isInherentlyEnabled(null, null, null, null, null, { readonly: true })
+  );
+});
+
+test('isInherentlyEnabled enabled by config over ownProps', t => {
+  t.true(
+    isInherentlyEnabled(null, { enabled: false }, null, null, null, {
+      readonly: false
+    })
+  );
+});
+
+test('isInherentlyEnabled enabled by uischema over config', t => {
+  t.true(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: false } } as unknown) as ControlElement,
+      null,
+      null,
+      { readonly: true }
+    )
+  );
+});
+
+test('isInherentlyEnabled prefer readonly over readOnly', t => {
+  t.true(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: false, readOnly: true } } as unknown) as ControlElement,
+      null,
+      null,
+      null
+    )
+  );
+  t.false(
+    isInherentlyEnabled(
+      null,
+      null,
+      ({ options: { readonly: true, readOnly: false } } as unknown) as ControlElement,
+      null,
+      null,
+      null
+    )
+  );
+});
+
+test('isInherentlyEnabled enabled', t => {
+  t.true(isInherentlyEnabled(null, null, null, null, null, null));
 });

package/docs/interfaces/labels.html

@@ -1,157 +0,0 @@
-<!doctype html>
-<html class="default no-js">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Labels | 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="labels.html">Labels</a>
-				</li>
-			</ul>
-			<h1>Interface Labels</h1>
-		</div>
-	</div>
-</header>
-<div class="container container-main">
-	<div class="row">
-		<div class="col-8 col-content">
-			<section class="tsd-panel tsd-hierarchy">
-				<h3>Hierarchy</h3>
-				<ul class="tsd-hierarchy">
-					<li>
-						<span class="target">Labels</span>
-					</li>
-				</ul>
-			</section>
-			<section class="tsd-panel tsd-kind-interface">
-				<h3 class="tsd-before-signature">Indexable</h3>
-				<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>additionalLabels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></div>
-			</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="labels.html#default" class="tsd-kind-icon">default</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="default" class="tsd-anchor"></a>
-					<h3>default</h3>
-					<div class="tsd-signature tsd-kind-icon">default<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:72</li>
-						</ul>
-					</aside>
-				</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="labels.html" class="tsd-kind-icon">Labels</a>
-						<ul>
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="labels.html#default" class="tsd-kind-icon">default</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/schemaref.html

@@ -1,160 +0,0 @@
-<!doctype html>
-<html class="default no-js">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>SchemaRef | 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="schemaref.html">SchemaRef</a>
-				</li>
-			</ul>
-			<h1>Interface SchemaRef</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>Interface for describing result of an extracted schema ref</p>
-					</div>
-				</div>
-			</section>
-			<section class="tsd-panel tsd-hierarchy">
-				<h3>Hierarchy</h3>
-				<ul class="tsd-hierarchy">
-					<li>
-						<span class="target">SchemaRef</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="schemaref.html#uri" class="tsd-kind-icon">uri</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="uri" class="tsd-anchor"></a>
-					<h3>uri</h3>
-					<div class="tsd-signature tsd-kind-icon">uri<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/resolvers.ts:204</li>
-						</ul>
-					</aside>
-				</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="schemaref.html" class="tsd-kind-icon">Schema<wbr>Ref</a>
-						<ul>
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="schemaref.html#uri" class="tsd-kind-icon">uri</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>