@opengeospatial/jsonld-ui-utils 0.2.0

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,221 @@
+# jsonld-ui-utils
+
+A JavaScript/TypeScript library that renders JSON-LD feature data as interactive HTML tables and enriches them with semantic metadata (labels, descriptions) fetched from RDF sources.
+
+## Features
+
+- Render JSON-LD objects as nested HTML tables
+- Resolve property names and values to their full URIs using JSON-LD contexts
+- Fetch RDF metadata (labels, descriptions) for resolved URIs
+- Multiple fallback mechanisms: direct fetch, [RAINBOW](https://github.com/ogcincubator/rainbow) proxy, SPARQL endpoint
+- Built-in caching to avoid redundant network requests
+
+## Installation
+
+This package is not published to npm. Install the latest release directly from GitHub:
+
+```bash
+npm install https://github.com/avillar/jsonld-ui-utils/releases/latest/download/jsonld-ui-utils.tgz
+# or
+yarn add https://github.com/avillar/jsonld-ui-utils/releases/latest/download/jsonld-ui-utils.tgz
+```
+
+To pin to a specific version, replace `latest/download` with `download/v0.1.6`:
+
+```bash
+npm install https://github.com/avillar/jsonld-ui-utils/releases/download/v0.1.6/jsonld-ui-utils.tgz
+```
+
+> **Note:** [`rdflib`](https://www.npmjs.com/package/rdflib) is a peer dependency and must be installed separately:
+> ```bash
+> npm install rdflib
+> ```
+
+### Browser (CDN)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/rdflib@2.3.0/dist/rdflib.min.js"></script>
+<script src="https://github.com/avillar/jsonld-ui-utils/releases/latest/download/jsonld-ui-utils.min.js"></script>
+```
+
+This exposes `jsonldUIUtils` as a global variable.
+
+## Usage
+
+### Quick start
+
+```javascript
+import jsonldUIUtils from 'jsonld-ui-utils';
+
+const { feature, context } = await jsonldUIUtils.loadFeature(
+  'https://example.org/features/my-feature.json'
+);
+
+const container = document.getElementById('feature');
+jsonldUIUtils.createPropertiesTable(feature, container);
+await jsonldUIUtils.augment(container, context);
+```
+
+### Step by step
+
+#### 1. Load a JSON-LD feature
+
+```javascript
+const { feature, context } = await jsonldUIUtils.loadFeature(featureUrl);
+```
+
+`loadFeature` fetches the document at `featureUrl`, extracts its `@context`, recursively loads and merges any referenced context URLs, and returns both the raw feature object and the resolved context.
+
+#### 2. Render the feature as an HTML table
+
+```javascript
+const container = document.getElementById('feature');
+jsonldUIUtils.createPropertiesTable(feature, container);
+```
+
+This builds a nested HTML table structure inside `container`. By default it reads from the `properties` field of the feature object. Pass `propertiesField: null` to use the entire feature object instead:
+
+```javascript
+jsonldUIUtils.createPropertiesTable(feature, container, { propertiesField: null });
+```
+
+The generated elements carry CSS classes you can style:
+
+| Class | Applied to |
+|---|---|
+| `.object-table` | `<table>` elements |
+| `.object-property` | Property name cells |
+| `.object-value` | Property value cells |
+| `.literal-value` | Scalar (non-object) values |
+| `.array-entry` | Entries within an array value |
+
+#### 3. Augment with semantic metadata
+
+```javascript
+await jsonldUIUtils.augment(container, context, {
+  fallbackSparqlEndpoint: 'https://example.org/sparql',
+});
+```
+
+`augment` walks the table, resolves each property name and value to its full URI via the JSON-LD context, fetches RDF data for those URIs, and updates the HTML elements with human-readable labels, descriptions, and links.
+
+During and after augmentation, elements receive additional CSS classes:
+
+| Class | Meaning |
+|---|---|
+| `.resource-loading` | Fetch in progress |
+| `.resource-resolved` | Label successfully retrieved |
+| `.resource-error` | Fetch failed |
+| `.resource-link` | `<a>` added with the resolved URI |
+
+### Options
+
+#### `createPropertiesTable(feature, container, options?)`
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `propertiesField` | `string \| null` | `'properties'` | Property on `feature` to use as the root object. Set to `null` to use the entire feature. |
+
+#### `augment(rootElem, context, options?)`
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `replaceElements` | `boolean` | `true` | Replace element text with the resolved label. |
+| `labelPredicates` | `(NamedNode \| string)[]` | SKOS prefLabel, DCT/DC title, SDO/FOAF name, RDFS label | RDF predicates checked when extracting a label. |
+| `descriptionPredicates` | `(NamedNode \| string)[]` | SKOS definition, DCT/DC description, RDFS comment | RDF predicates checked when extracting a description. |
+| `fallbackRainbowInstances` | `string \| string[]` | — | One or more RAINBOW proxy base URLs tried in order when a direct fetch returns no label. |
+| `fallbackSparqlEndpoints` | `string \| string[]` | — | One or more SPARQL endpoint URLs tried in order as a last resort (`DESCRIBE <uri>`). |
+| `acceptedContentTypes` | `object` | Turtle, N-Triples, RDF/XML, anot+Turtle | RDF content types to accept, mapped to `true` or a normalised type string. |
+
+> **Note:** The singular aliases `fallbackRainbowInstance` and `fallbackSparqlEndpoint` are still accepted for backward compatibility and behave as a single-element list appended after any values provided via the plural options.
+
+### Lower-level API
+
+#### `fetchResource(uri, options?)`
+
+Fetch RDF metadata for a single URI and return a `ResourceData` object:
+
+```typescript
+interface ResourceData {
+  uri: string;
+  label: string | null;
+  description?: string | null;
+}
+```
+
+```javascript
+const data = await jsonldUIUtils.fetchResource('https://example.org/vocab/MyTerm', {
+  fallbackSparqlEndpoint: 'https://example.org/sparql',
+});
+console.log(data.label); // e.g. "My Term"
+```
+
+#### `loadContext(context)`
+
+Load and merge one or more JSON-LD contexts. Accepts a context object, a URL string, or an array of either:
+
+```javascript
+const merged = await jsonldUIUtils.loadContext([
+  'https://example.org/context1.json',
+  'https://example.org/context2.json',
+]);
+```
+
+### Named exports
+
+In addition to the default export you can import individual functions:
+
+```javascript
+import {
+  createPropertiesTable,
+  augment,
+  fetchResource,
+  loadFeature,
+  loadContext,
+} from 'jsonld-ui-utils';
+```
+
+## Browser example
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <style>
+    .object-table { border-collapse: collapse; width: 100%; }
+    .object-property { font-weight: bold; padding: 4px 8px; vertical-align: top; }
+    .object-value { padding: 4px 8px; }
+    .resource-resolved { cursor: help; }
+  </style>
+</head>
+<body>
+  <div id="feature"></div>
+
+  <script src="https://cdn.jsdelivr.net/npm/rdflib@2.3.0/dist/rdflib.min.js"></script>
+  <script src="https://github.com/avillar/jsonld-ui-utils/releases/latest/download/jsonld-ui-utils.min.js"></script>
+  <script>
+    jsonldUIUtils
+      .loadFeature('https://example.org/features/sensor.json')
+      .then(({ feature, context }) => {
+        const root = document.getElementById('feature');
+        jsonldUIUtils.createPropertiesTable(feature, root);
+        return jsonldUIUtils.augment(root, context, {
+          fallbackSparqlEndpoint: 'https://example.org/sparql',
+        });
+      });
+  </script>
+</body>
+</html>
+```
+
+## Building from source
+
+```bash
+yarn install
+yarn build      # produces dist/
+yarn dev        # start dev server with live reload
+```
+
+## License
+
+See [LICENSE](LICENSE).

package/dist/augment.d.ts

@@ -0,0 +1,9 @@
+import { CreatePropertiesTableOptions, FetchResourceOptions } from "./resource";
+import { ContextDefinition } from "jsonld";
+export interface AugmentOptions extends FetchResourceOptions {
+    replaceElements: boolean;
+}
+export declare function createPropertiesTable(feature: {
+    [index: string]: any;
+}, container: HTMLElement, options?: CreatePropertiesTableOptions): void;
+export declare function augment(rootElem: HTMLElement, context: ContextDefinition, options?: Partial<AugmentOptions>): Promise<void>;

package/dist/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const SKOS: (local: string) => string;
+export declare const RDFS: (local: string) => string;
+export declare const RDF: (local: string) => string;
+export declare const DCT: (local: string) => string;
+export declare const DC: (local: string) => string;
+export declare const SDO: (local: string) => string;
+export declare const FOAF: (local: string) => string;
+export declare const labelPredicates: string[];
+export declare const descriptionPredicates: string[];