@tsplc/opcua 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# @tsplc/opcua
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Part of [tsPLC](https://github.com/livingforjesus/tsplc).
+
+Typed OPC UA access to a running tsPLC program: `createPlc` reads and writes its published globals by path, typed from the program's own declarations, and `createMachineClient` reads machine telemetry. The generated contract (`@tsplc/opcua/contract`) describes what a build published.
+
+See the [documentation](https://github.com/livingforjesus/tsplc/tree/main/docs). MIT licensed.

package/dist/contract.js

@@ -0,0 +1,32 @@
+// packages/opcua/src/contract.ts
+var contractVariables = (contract, published) => {
+  const selected = published && new Set(published);
+  return contract.symbols.filter((symbol) => !selected || selected.has(`${symbol.gvl}.${symbol.name}`)).flatMap((symbol) => {
+    const fields = contract.typeFields[symbol.type];
+    if (!fields && symbol.type.startsWith("ARRAY["))
+      return [
+        {
+          description: "",
+          device: symbol.name,
+          field: "",
+          path: `${symbol.gvl}.${symbol.name}`,
+          type: symbol.type
+        }
+      ];
+    if (!fields)
+      throw new Error(`Missing generated fields for ${symbol.type}.`);
+    return fields.map(({ field, type, description }) => ({
+      description,
+      device: symbol.name,
+      field,
+      path: `${symbol.gvl}.${symbol.name}${field.startsWith("[") ? "" : "."}${field}`,
+      type
+    }));
+  });
+};
+export {
+  contractVariables
+};
+
+//# debugId=080E88B866BC96AE64756E2164756E21
+//# sourceMappingURL=contract.js.map

package/dist/contract.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../src/contract.ts"],
+  "sourcesContent": [
+    "/** The generated symbol tables from `tsplc typegen` (`symbols` and `typeFields`). */\nexport interface PlcContract {\n  symbols: ReadonlyArray<{ name: string; gvl: string; type: string }>;\n  typeFields: Readonly<\n    Record<string, ReadonlyArray<{ field: string; type: string; description: string }>>\n  >;\n}\n\n/** Dotted leaf paths of a record, with `[${number}]` for record arrays. */\nexport type FieldPath<T> = {\n  [K in keyof T & string]: T[K] extends ReadonlyArray<infer Item>\n    ? Item extends object\n      ? `${K}[${number}].${FieldPath<Item>}`\n      : K\n    : T[K] extends object\n      ? `${K}.${FieldPath<T[K]>}`\n      : K;\n}[keyof T & string];\n\n/** Every leaf variable of the contract's symbols, optionally only the published symbols. */\nexport const contractVariables = (contract: PlcContract, published?: readonly string[]) => {\n  const selected = published && new Set(published);\n  return contract.symbols\n    .filter((symbol) => !selected || selected.has(`${symbol.gvl}.${symbol.name}`))\n    .flatMap((symbol) => {\n      const fields = contract.typeFields[symbol.type];\n      // An array global, such as a service channel's slots, is read and written whole.\n      if (!fields && symbol.type.startsWith(\"ARRAY[\"))\n        return [\n          {\n            description: \"\",\n            device: symbol.name,\n            field: \"\",\n            path: `${symbol.gvl}.${symbol.name}`,\n            type: symbol.type,\n          },\n        ];\n      if (!fields) throw new Error(`Missing generated fields for ${symbol.type}.`);\n      return fields.map(({ field, type, description }) => ({\n        description,\n        device: symbol.name,\n        field,\n        // An array type's fields start at an element, such as `[3].Enabled`.\n        path: `${symbol.gvl}.${symbol.name}${field.startsWith(\"[\") ? \"\" : \".\"}${field}`,\n        type,\n      }));\n    });\n};\n"
+  ],
+  "mappings": ";AAoBO,IAAM,oBAAoB,CAAC,UAAuB,cAAkC;AAAA,EACzF,MAAM,WAAW,aAAa,IAAI,IAAI,SAAS;AAAA,EAC/C,OAAO,SAAS,QACb,OAAO,CAAC,WAAW,CAAC,YAAY,SAAS,IAAI,GAAG,OAAO,OAAO,OAAO,MAAM,CAAC,EAC5E,QAAQ,CAAC,WAAW;AAAA,IACnB,MAAM,SAAS,SAAS,WAAW,OAAO;AAAA,IAE1C,IAAI,CAAC,UAAU,OAAO,KAAK,WAAW,QAAQ;AAAA,MAC5C,OAAO;AAAA,QACL;AAAA,UACE,aAAa;AAAA,UACb,QAAQ,OAAO;AAAA,UACf,OAAO;AAAA,UACP,MAAM,GAAG,OAAO,OAAO,OAAO;AAAA,UAC9B,MAAM,OAAO;AAAA,QACf;AAAA,MACF;AAAA,IACF,IAAI,CAAC;AAAA,MAAQ,MAAM,IAAI,MAAM,gCAAgC,OAAO,OAAO;AAAA,IAC3E,OAAO,OAAO,IAAI,GAAG,OAAO,MAAM,mBAAmB;AAAA,MACnD;AAAA,MACA,QAAQ,OAAO;AAAA,MACf;AAAA,MAEA,MAAM,GAAG,OAAO,OAAO,OAAO,OAAO,MAAM,WAAW,GAAG,IAAI,KAAK,MAAM;AAAA,MACxE;AAAA,IACF,EAAE;AAAA,GACH;AAAA;",
+  "debugId": "080E88B866BC96AE64756E2164756E21",
+  "names": []
+}