Merge pull request #1256 from danielpeintner/issue-1249

Remove AID tooling
eclipse-thingweb · Apr 11, 2024 · d2d7833 · d2d7833
2 parents fdc678b + b0d851d
commit d2d7833
Show file tree

Hide file tree

Showing 10 changed files with 3 additions and 7,924 deletions.
diff --git a/examples/browser/aid-tools.html b/examples/browser/aid-tools.html
diff --git a/examples/browser/aid-tools.js b/examples/browser/aid-tools.js
diff --git a/packages/td-tools/README.md b/packages/td-tools/README.md
@@ -6,6 +6,8 @@ Current Maintainer(s): [@danielpeintner](https://github.com/danielpeintner) [@re
 
 In the following example it is shown how td-tools of node-wot can be used.
 
+Note: Some additional tooling (e.g., AAS AID, TD to AsyncAPI Converter) can be found in its own repository (see https://github.com/eclipse-thingweb/td-tools).
+
 ### Prerequisites
 
 -   `npm install @node-wot/td-tools`

diff --git a/packages/td-tools/src/td-tools.ts b/packages/td-tools/src/td-tools.ts
@@ -20,7 +20,6 @@ export * from "./thing-description";
 export * from "./td-parser";
 export * from "./td-helpers";
 export * from "./thing-model-helpers";
-export * from "./util/asset-interface-description";
 type DeepPartial<T> = T extends Record<string, unknown>
     ? {
           [P in keyof T]?: T[P] extends Array<infer I> ? Array<DeepPartial<I>> : DeepPartial<T[P]>;

diff --git a/packages/td-tools/src/util/README.md b/packages/td-tools/src/util/README.md
@@ -2,105 +2,4 @@
 
 ## Asset Interface Description
 
-The [IDTA Asset Interface Description (AID) working group](https://github.com/admin-shell-io/submodel-templates/tree/main/development/Asset%20Interface%20Description/1/0) defines a submodel that can be used to describe the asset's service interface or asset's related service interfaces. The current AID working assumptions reuse existing definitions from [WoT Thing Descriptions](https://www.w3.org/TR/wot-thing-description11/) and hence it is possible to consume AAS with AID definitions with node-wot (e.g., read/subscribe live data of the asset and/or associated service).
-
-### Sample Applications
-
-#### Prerequisites
-
--   `npm install @node-wot/td-tools`
--   `npm install @node-wot/core`
--   `npm install @node-wot/binding-http`
-
-#### AAS/AID to WoT TD
-
-The file `counterHTTP.json` describes the counter sample in AAS/AID format for http binding. The `AssetInterfaceDescriptionUtil` utility class allows to transform the AID format to a valid WoT TD format which in the end can be properly consumed by node-wot.
-
-The example `aid-to-td.js` tries to transform an AID submodel (from an AAS file) into a regular WoT TD.
-Note: Besides converting the AID submodel it is also possible to convert a full AAS file (see `transformTD2AAS(...)`).
-
-```js
-// aid-to-td.js
-const fs = require("fs/promises"); // to read JSON file in AID format
-
-Servient = require("@node-wot/core").Servient;
-HttpClientFactory = require("@node-wot/binding-http").HttpClientFactory;
-
-// AID Util
-AssetInterfaceDescriptionUtil = require("@node-wot/td-tools").AssetInterfaceDescriptionUtil;
-
-// create Servient and add HTTP binding
-let servient = new Servient();
-servient.addClientFactory(new HttpClientFactory(null));
-
-let assetInterfaceDescriptionUtil = new AssetInterfaceDescriptionUtil();
-
-async function example() {
-    try {
-        const aas = await fs.readFile("counterHTTP.json", {
-            encoding: "utf8",
-        });
-        // pick AID submodel
-        const aid = JSON.stringify(JSON.parse(aas).submodels[0]);
-
-        // transform AID to WoT TD
-        const tdAID = assetInterfaceDescriptionUtil.transformSM2TD(aid, `{"title": "counter"}`);
-        // Note: transformSM2TD() may have up to 3 input parameters
-        // * aid (required):           AID submodel in JSON format
-        // * template (optional):      Initial TD template
-        // * submodelRegex (optional): Submodel filter based on regular expression
-        //                             e.g., filtering HTTP only by calling transformAAS2TD(aas, `{}`, "HTTP")
-
-        // do work as usual
-        const WoT = await servient.start();
-        const thing = await WoT.consume(JSON.parse(tdAID));
-
-        // read property count
-        const read1 = await thing.readProperty("count");
-        console.log("count value is: ", await read1.value());
-    } catch (err) {
-        console.log(err);
-    }
-}
-
-// launch example
-example();
-```
-
-#### WoT TD to AAS/AID
-
-The example `td-to-aid.js` tries to load the online counter TD and converts it to an AID submodel in JSON format.
-Note: Besides converting it into an AID submodel it is also possible to convert it into a full AAS form (see `transformTD2AAS(...)`).
-
-```js
-// td-to-aid.js
-AssetInterfaceDescriptionUtil = require("@node-wot/td-tools").AssetInterfaceDescriptionUtil;
-
-let assetInterfaceDescriptionUtil = new AssetInterfaceDescriptionUtil();
-
-async function example() {
-    try {
-        const response = await fetch("http://plugfest.thingweb.io:8083/counter");
-        const counterTD = await response.json();
-
-        const sm = assetInterfaceDescriptionUtil.transformTD2SM(JSON.stringify(counterTD), ["http", "coap"]);
-
-        // print JSON format of AID submodel
-        console.log(sm);
-    } catch (err) {
-        console.log(err);
-    }
-}
-
-// launch example
-example();
-```
-
-#### Run the sample scripts
-
-`node aid-to-td.js`
-... will show the counter value retrieved from http://plugfest.thingweb.io:8083/counter/properties/count
-Note: make sure that the file `counterHTTP.json` is in the same folder as the script.
-
-`node td-to-aid.js`
-... will show the online counter in AAS/AID JSON format (compliant with AAS V3.0 and can be imported by AASX Package Explorer).
+Note: The AID tooling has been moved to its own repository (see https://github.com/eclipse-thingweb/td-tools/tree/main/node/aas-aid).