opcjs-client 0.1.34-alpha → 0.1.36-alpha

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, MessageSecurityModeEnum, ILoggerFactory, Encoder, Decoder, ExpandedNodeId, QualifiedName, LocalizedText, NodeClassEnum, UaPrimitive, XmlElement, ExtensionObject, DataValue, DiagnosticInfo, Variant } from 'opcjs-base';
+import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, MessageSecurityModeEnum, ILoggerFactory, Encoder, Decoder, ExpandedNodeId, QualifiedName, LocalizedText, NodeClassEnum, UaPrimitive, XmlElement, ExtensionObject, DataValue, DiagnosticInfo } from 'opcjs-base';
 
 declare abstract class ServiceBase {
     private authToken;
@@ -108,6 +108,20 @@ declare class ReadValueResult {
     constructor(value: unknown, statusCode: number);
 }
 
+/** Options for creating a subscription. All fields are optional; server will revise requested values. */
+interface CreateSubscriptionOptions {
+    /** Requested publishing interval in milliseconds. Default: 2000. */
+    requestedPublishingInterval?: number;
+    /** Requested lifetime count (number of publishing intervals before subscription times out). Default: 360000. */
+    requestedLifetimeCount?: number;
+    /** Requested max keep-alive count. Default: 60000. */
+    requestedMaxKeepAliveCount?: number;
+    /** Maximum number of notifications per publish response. 0 = no limit. Default: 200. */
+    maxNotificationsPerPublish?: number;
+    /** Subscription priority relative to other subscriptions. Default: 1. */
+    priority?: number;
+}
+
 /** URI for the SecurityPolicy None profile. */
 declare const SECURITY_POLICY_NONE_URI = "http://opcfoundation.org/UA/SecurityPolicy#None";
 /**
@@ -223,7 +237,23 @@ declare class BrowseNodeResult {
     constructor(referenceTypeId: NodeId, isForward: boolean, nodeId: ExpandedNodeId, browseName: QualifiedName, displayName: LocalizedText, nodeClass: NodeClassEnum, typeDefinition: ExpandedNodeId);
 }
 
-type CallMethodArgument = UaPrimitive | NodeId | ExpandedNodeId | QualifiedName | LocalizedText | XmlElement | ExtensionObject | DataValue | DiagnosticInfo | Variant;
+/**
+ * A single (scalar) value that may be passed as a method argument.
+ * `Variant` is intentionally excluded — callers work with concrete OPC UA types;
+ * the conversion to `Variant` is done internally by `callMethod`.
+ */
+type ScalarCallMethodArgument = UaPrimitive | NodeId | ExpandedNodeId | QualifiedName | LocalizedText | XmlElement | ExtensionObject | DataValue | DiagnosticInfo;
+/**
+ * A value (or homogeneous array of values) that may be passed as a method argument
+ * to {@link Client.callMethod}.
+ *
+ * Pass a plain array to create an array-rank Variant input argument, e.g.:
+ * ```ts
+ * client.callMethod(objId, methodId, [[uaDouble(1.0), uaDouble(2.0)]])
+ * ```
+ * Arrays must be homogeneous — all elements must be of the same OPC UA type.
+ */
+type CallMethodArgument = ScalarCallMethodArgument | ScalarCallMethodArgument[];
 
 declare class Client {
     private configuration;
@@ -322,7 +352,7 @@ declare class Client {
     subscribe(ids: NodeId[], callback: (data: {
         id: NodeId;
         value: unknown;
-    }[]) => void): Promise<void>;
+    }[]) => void, options?: CreateSubscriptionOptions): Promise<void>;
     constructor(endpointUrl: string, configuration: ConfigurationClient, identity: UserIdentity);
 }
 
@@ -342,4 +372,4 @@ declare class SessionInvalidError extends Error {
     constructor(statusCode: number);
 }
 
-export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };
+export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, type CreateSubscriptionOptions, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, MessageSecurityModeEnum, ILoggerFactory, Encoder, Decoder, ExpandedNodeId, QualifiedName, LocalizedText, NodeClassEnum, UaPrimitive, XmlElement, ExtensionObject, DataValue, DiagnosticInfo, Variant } from 'opcjs-base';
+import { ISecureChannel, RequestHeader, NodeId, EndpointDescription, UserIdentityToken, Configuration, UserTokenTypeEnum, MessageSecurityModeEnum, ILoggerFactory, Encoder, Decoder, ExpandedNodeId, QualifiedName, LocalizedText, NodeClassEnum, UaPrimitive, XmlElement, ExtensionObject, DataValue, DiagnosticInfo } from 'opcjs-base';
 
 declare abstract class ServiceBase {
     private authToken;
@@ -108,6 +108,20 @@ declare class ReadValueResult {
     constructor(value: unknown, statusCode: number);
 }
 
+/** Options for creating a subscription. All fields are optional; server will revise requested values. */
+interface CreateSubscriptionOptions {
+    /** Requested publishing interval in milliseconds. Default: 2000. */
+    requestedPublishingInterval?: number;
+    /** Requested lifetime count (number of publishing intervals before subscription times out). Default: 360000. */
+    requestedLifetimeCount?: number;
+    /** Requested max keep-alive count. Default: 60000. */
+    requestedMaxKeepAliveCount?: number;
+    /** Maximum number of notifications per publish response. 0 = no limit. Default: 200. */
+    maxNotificationsPerPublish?: number;
+    /** Subscription priority relative to other subscriptions. Default: 1. */
+    priority?: number;
+}
+
 /** URI for the SecurityPolicy None profile. */
 declare const SECURITY_POLICY_NONE_URI = "http://opcfoundation.org/UA/SecurityPolicy#None";
 /**
@@ -223,7 +237,23 @@ declare class BrowseNodeResult {
     constructor(referenceTypeId: NodeId, isForward: boolean, nodeId: ExpandedNodeId, browseName: QualifiedName, displayName: LocalizedText, nodeClass: NodeClassEnum, typeDefinition: ExpandedNodeId);
 }
 
-type CallMethodArgument = UaPrimitive | NodeId | ExpandedNodeId | QualifiedName | LocalizedText | XmlElement | ExtensionObject | DataValue | DiagnosticInfo | Variant;
+/**
+ * A single (scalar) value that may be passed as a method argument.
+ * `Variant` is intentionally excluded — callers work with concrete OPC UA types;
+ * the conversion to `Variant` is done internally by `callMethod`.
+ */
+type ScalarCallMethodArgument = UaPrimitive | NodeId | ExpandedNodeId | QualifiedName | LocalizedText | XmlElement | ExtensionObject | DataValue | DiagnosticInfo;
+/**
+ * A value (or homogeneous array of values) that may be passed as a method argument
+ * to {@link Client.callMethod}.
+ *
+ * Pass a plain array to create an array-rank Variant input argument, e.g.:
+ * ```ts
+ * client.callMethod(objId, methodId, [[uaDouble(1.0), uaDouble(2.0)]])
+ * ```
+ * Arrays must be homogeneous — all elements must be of the same OPC UA type.
+ */
+type CallMethodArgument = ScalarCallMethodArgument | ScalarCallMethodArgument[];
 
 declare class Client {
     private configuration;
@@ -322,7 +352,7 @@ declare class Client {
     subscribe(ids: NodeId[], callback: (data: {
         id: NodeId;
         value: unknown;
-    }[]) => void): Promise<void>;
+    }[]) => void, options?: CreateSubscriptionOptions): Promise<void>;
     constructor(endpointUrl: string, configuration: ConfigurationClient, identity: UserIdentity);
 }
 
@@ -342,4 +372,4 @@ declare class SessionInvalidError extends Error {
     constructor(statusCode: number);
 }
 
-export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };
+export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, type CreateSubscriptionOptions, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };

package/dist/index.js

@@ -160,7 +160,7 @@ var SessionService = class _SessionService extends ServiceBase {
   }
 };
 
-// src/issuerConfiguration.ts
+// src/configuration/issuerConfiguration.ts
 var IssuerConfiguration = class _IssuerConfiguration {
   constructor(resourceId, authorityUrl, authorityProfileUri, tokenEndpoint, authorizationEndpoint, requestTypes, scopes) {
     this.resourceId = resourceId;
@@ -359,7 +359,7 @@ var ReadValueResult = class {
   }
 };
 
-// src/subscriptionHandlerEntry.ts
+// src/subscription/subscriptionHandlerEntry.ts
 var SubscriptionHandlerEntry = class {
   constructor(subscriptionId, handle, id, callback) {
     this.subscriptionId = subscriptionId;
@@ -369,7 +369,7 @@ var SubscriptionHandlerEntry = class {
   }
 };
 
-// src/subscriptionHandler.ts
+// src/subscription/subscriptionHandler.ts
 var NODE_ID_DATA_CHANGE_NOTIFICATION = 811;
 var NODE_ID_STATUS_CHANGE_NOTIFICATION = 818;
 var SubscriptionHandler = class {
@@ -385,11 +385,11 @@ var SubscriptionHandler = class {
   hasActiveSubscription() {
     return this.isRunning && this.entries.length > 0;
   }
-  async subscribe(ids, callback) {
+  async subscribe(ids, callback, options) {
     if (this.entries.length > 0) {
       throw new Error("Subscribing more than once is not implemented");
     }
-    const subscriptionId = await this.subscriptionService.createSubscription();
+    const subscriptionId = await this.subscriptionService.createSubscription(options);
     const items = [];
     for (const id of ids) {
       const entry = new SubscriptionHandlerEntry(subscriptionId, this.nextHandle++, id, callback);
@@ -577,7 +577,7 @@ var MethodService = class extends ServiceBase {
   }
 };
 
-// src/callMethodResult.ts
+// src/method/callMethodResult.ts
 var CallMethodResult = class {
   constructor(values, statusCode) {
     this.values = values;
@@ -986,8 +986,8 @@ var Client = class {
     }
     return results;
   }
-  async subscribe(ids, callback) {
-    this.subscriptionHandler?.subscribe(ids, callback);
+  async subscribe(ids, callback, options) {
+    this.subscriptionHandler?.subscribe(ids, callback, options);
   }
 };
 var ConfigurationClient = class _ConfigurationClient extends Configuration {