opcjs-client 0.1.13 → 0.1.17-alpha

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, Encoder, Decoder } from 'opcjs-base';
+import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, ILoggerFactory, Encoder, Decoder } from 'opcjs-base';
 
 declare abstract class ServiceBase {
     private authToken;
@@ -9,6 +9,7 @@ declare abstract class ServiceBase {
 
 declare class SessionService extends ServiceBase {
     private configuration;
+    private logger;
     createSession(): Promise<{
         sessionId: number;
         authToken: NodeId;
@@ -19,6 +20,15 @@ declare class SessionService extends ServiceBase {
     constructor(authToken: NodeId, secureChannel: ISecureChannel, configuration: Configuration);
 }
 
+interface IssuerEndpointUrl {
+    'ua.resourceId': string;
+    'ua.authorityUrl': string;
+    'ua.authorityProfileUri': string;
+    'ua.tokenEndpoint': string;
+    'ua.authorizationEndpoint': string;
+    'ua.requestTypes': string[];
+    'ua.scopes': string[];
+}
 declare class IssuerConfiguration {
     resourceId: string;
     authorityUrl: string;
@@ -27,7 +37,7 @@ declare class IssuerConfiguration {
     authorizationEndpoint: string;
     requestTypes: string[];
     scopes: string[];
-    static newFrom(issuerEndpointUrl: any): IssuerConfiguration;
+    static newFrom(issuerEndpointUrl: IssuerEndpointUrl): IssuerConfiguration;
     constructor(resourceId: string, authorityUrl: string, authorityProfileUri: string, tokenEndpoint: string, authorizationEndpoint: string, requestTypes: string[], scopes: string[]);
 }
 
@@ -65,21 +75,147 @@ declare class ReadValueResult {
 }
 
 declare class ConfigurationClient extends Configuration {
-    static getSimple(name: string, company: string): ConfigurationClient;
-    constructor(applicationName: string, applicationUri: string, productName: string, productUri: string, encoder: Encoder, decoder: Decoder);
+    static getSimple(name: string, company: string, loggerFactory?: ILoggerFactory): ConfigurationClient;
+    constructor(applicationName: string, applicationUri: string, productName: string, productUri: string, encoder: Encoder, decoder: Decoder, loggerFactory: ILoggerFactory);
+}
+
+declare class CallMethodResult {
+    values: unknown[];
+    status: string;
+    constructor(values: unknown[], status: string);
 }
 
+/**
+ * Enumeration of variant types based on BuiltinType NodeIds.
+ */
+declare enum BuiltInType {
+    Null = 0,
+    Boolean = 1,
+    SByte = 2,
+    Byte = 3,
+    Int16 = 4,
+    UInt16 = 5,
+    Int32 = 6,
+    UInt32 = 7,
+    Int64 = 8,
+    UInt64 = 9,
+    Float = 10,
+    Double = 11,
+    String = 12,
+    DateTime = 13,
+    Guid = 14,
+    ByteString = 15,
+    XmlElement = 16,
+    NodeId = 17,
+    ExpandedNodeId = 18,
+    StatusCode = 19,
+    QualifiedName = 20,
+    LocalizedText = 21,
+    ExtensionObject = 22,
+    DataValue = 23,
+    Variant = 24,
+    DiagnosticInfo = 25
+}
+
+/**
+ * OPC UA Primitive Type Mappings
+ *
+ * We try to use the JS built in types wherever we can. But sometimes, often in the context
+ * where Variant is involved, we need to have a wrapper type that includes the BuiltInType
+ * for type checking and encoding purposes. In those cases, we define a wrapper type with a
+ * value and a type field. For simple cases like boolean, we can just use the native boolean
+ * type directly as UaBoolean.
+ * @module primitives
+ */
+
+type UaBoolean = boolean;
+/**
+ * OPC UA Builtin Type Numeric IDs
+ *
+ * These correspond to the NodeId numeric identifiers defined in OPC UA Part 6, Table 1.
+ */
+type UaSbyte = {
+    value: number;
+    readonly type: BuiltInType.SByte;
+};
+type UaByte = {
+    value: number;
+    readonly type: BuiltInType.Byte;
+};
+type UaInt16 = {
+    value: number;
+    readonly type: BuiltInType.Int16;
+};
+type UaUint16 = {
+    value: number;
+    readonly type: BuiltInType.UInt16;
+};
+type UaInt32 = {
+    value: number;
+    readonly type: BuiltInType.Int32;
+};
+type UaUint32 = {
+    value: number;
+    readonly type: BuiltInType.UInt32;
+};
+type UaInt64 = {
+    value: bigint;
+    readonly type: BuiltInType.Int64;
+};
+type UaUint64 = {
+    value: bigint;
+    readonly type: BuiltInType.UInt64;
+};
+type UaFloat = {
+    value: number;
+    readonly type: BuiltInType.Float;
+};
+type UaDouble = {
+    value: number;
+    readonly type: BuiltInType.Double;
+};
+/**
+ * OPC UA String primitive type.
+ *
+ * A String in OPC UA can be null (encoded as length -1 in binary).
+ * Using `string | null` instead of `string | undefined` aligns with the
+ * OPC UA specification where null is an explicit, valid value distinct
+ * from an empty string. Same is true for ByteString which can be null (length -1)
+ * or a Uint8Array.
+ */
+type UaString = string | null;
+type UaByteString = Uint8Array | null;
+type UaGuid = {
+    value: string;
+    readonly type: BuiltInType.Guid;
+};
+type UaDateTime = Date;
+/**
+ * Union of all OPC UA primitive types accepted by {@link Variant.newFrom}.
+ */
+type UaPrimitive = UaBoolean | UaSbyte | UaByte | UaInt16 | UaUint16 | UaInt32 | UaUint32 | UaInt64 | UaUint64 | UaFloat | UaDouble | UaString | UaDateTime | UaGuid | UaByteString;
+
 declare class Client {
     private configuration;
     private identity;
     private endpointUrl;
-    private channel?;
+    private attributeService?;
+    private methodService?;
     private session?;
     private subscriptionHandler?;
+    private logger;
     getSession(): Session;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     read(ids: NodeId[]): Promise<ReadValueResult[]>;
+    /**
+     * Method for calling a single method on the server.
+     * @param objectId - NodeId of the Object that owns the method.
+     * @param methodId - NodeId of the Method to invoke.
+     * @param inputArguments - Input argument Variants (default: empty).
+     * @returns The CallMethodResult for the invoked method.
+     */
+    callMethod(objectId: NodeId, methodId: NodeId, inputArguments?: UaPrimitive[]): Promise<CallMethodResult>;
     subscribe(ids: NodeId[], callback: (data: {
         id: NodeId;
         value: unknown;