opcjs-client 0.1.35-alpha → 0.1.37-alpha

package/dist/index.d.cts

@@ -108,6 +108,24 @@ declare class ReadValueResult {
     constructor(value: unknown, statusCode: number);
 }
 
+/** Options for creating a subscription. All fields are optional; server will revise requested values. */
+interface SubscriptionOptions {
+    /** 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;
+    /** Requested sampling interval in milliseconds. -1 = use subscription publishing interval. */
+    samplingInterval?: number;
+    /** Requested queue size for each monitored item. */
+    queueSize?: number;
+}
+
 /** URI for the SecurityPolicy None profile. */
 declare const SECURITY_POLICY_NONE_URI = "http://opcfoundation.org/UA/SecurityPolicy#None";
 /**
@@ -338,7 +356,7 @@ declare class Client {
     subscribe(ids: NodeId[], callback: (data: {
         id: NodeId;
         value: unknown;
-    }[]) => void): Promise<void>;
+    }[]) => void, options?: SubscriptionOptions): Promise<void>;
     constructor(endpointUrl: string, configuration: ConfigurationClient, identity: UserIdentity);
 }
 
@@ -358,4 +376,4 @@ declare class SessionInvalidError extends Error {
     constructor(statusCode: number);
 }
 
-export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };
+export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type SubscriptionOptions, type UnknownCertificatePolicy, UserIdentity };

package/dist/index.d.ts

@@ -108,6 +108,24 @@ declare class ReadValueResult {
     constructor(value: unknown, statusCode: number);
 }
 
+/** Options for creating a subscription. All fields are optional; server will revise requested values. */
+interface SubscriptionOptions {
+    /** 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;
+    /** Requested sampling interval in milliseconds. -1 = use subscription publishing interval. */
+    samplingInterval?: number;
+    /** Requested queue size for each monitored item. */
+    queueSize?: number;
+}
+
 /** URI for the SecurityPolicy None profile. */
 declare const SECURITY_POLICY_NONE_URI = "http://opcfoundation.org/UA/SecurityPolicy#None";
 /**
@@ -338,7 +356,7 @@ declare class Client {
     subscribe(ids: NodeId[], callback: (data: {
         id: NodeId;
         value: unknown;
-    }[]) => void): Promise<void>;
+    }[]) => void, options?: SubscriptionOptions): Promise<void>;
     constructor(endpointUrl: string, configuration: ConfigurationClient, identity: UserIdentity);
 }
 
@@ -358,4 +376,4 @@ declare class SessionInvalidError extends Error {
     constructor(statusCode: number);
 }
 
-export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type UnknownCertificatePolicy, UserIdentity };
+export { BrowseNodeResult, type CallMethodArgument, CallMethodResult, Client, ConfigurationClient, SECURITY_POLICY_NONE_URI, type ScalarCallMethodArgument, type SecurityConfiguration, SessionInvalidError, type SubscriptionOptions, 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,18 +385,18 @@ 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);
       this.entries.push(entry);
       items.push({ id, handle: entry.handle });
     }
-    await this.monitoredItemService.createMonitoredItems(subscriptionId, items);
+    await this.monitoredItemService.createMonitoredItems(subscriptionId, items, options);
     this.isRunning = true;
     void this.publishLoop([]);
   }
@@ -510,10 +510,10 @@ var MonitoredItemService = class extends ServiceBase {
    * Creates monitored items within a subscription (OPC UA Part 4, Section 5.13.2).
    * @param subscriptionId - ID of the subscription to add monitored items to.
    * @param ids - Array of NodeIds and client handles identifying the items to monitor.
-   * @param samplingInterval - Requested sampling interval in milliseconds. -1 = use subscription publishing interval.
-   * @param queueSize - Requested queue size for each monitored item.
+   * @param options - Monitoring options (samplingInterval, queueSize).
    */
-  async createMonitoredItems(subscriptionId, ids, samplingInterval = 1e3, queueSize = 100) {
+  async createMonitoredItems(subscriptionId, ids, options = {}) {
+    const { samplingInterval = 1e3, queueSize = 100 } = options;
     const items = ids.map((ni) => {
       const readValueId = new ReadValueId();
       readValueId.nodeId = ni.id;
@@ -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 {