Improve subscription and logger output. (#456)

feat(logger): add standardized log output

Standardize information printed by logger and places where it is printed.

feat(logger): add configuration options to set loggers

Add `logLevel` and `loggers` configuration parameters to specify minimum log level and list of
custom `Logger` interface implementations (when own logger needed).

feat(subscription): add subscription / subscription set `cloneEmpty` function

Add the `cloneEmpty` function, which will let you make a “bare” copy of a
subscription / subscription set object, which will have shared state with the original but clear
list of event handlers.

feat(subscription): add `filter` subscription configuration

Add a parameter for subscription where closure can be provided and filter events which should be
delivered with listener.

feat(subscription): add old messages filtering

When a new subscription object is created, it won't notify about messages from the past (edge case
with active and inactive channel subscriptions).

Author: parfeon

.pubnub.yml

@@ -1,5 +1,18 @@
 ---
 changelog:
+  - date: 2025-06-04
+    version: v9.6.0
+    changes:
+      - type: feature
+        text: "Standardize information printed by logger and places where it is printed."
+      - type: feature
+        text: "Add `logLevel` and `loggers` configuration parameters to specify minimum log level and list of custom `Logger` interface implementations (when own logger needed)."
+      - type: feature
+        text: "Add the `cloneEmpty` function, which will let you make a “bare” copy of a subscription / subscription set object, which will have shared state with the original but clear list of event handlers."
+      - type: feature
+        text: "Add a parameter for subscription where closure can be provided and filter events which should be delivered with listener."
+      - type: feature
+        text: "When a new subscription object is created, it won't notify about messages from the past (edge case with active and inactive channel subscriptions)."
   - date: 2025-04-22
     version: v9.5.2
     changes:
@@ -1236,7 +1249,7 @@ supported-platforms:
       - 'Ubuntu 14.04 and up'
       - 'Windows 7 and up'
     version: 'Pubnub Javascript for Node'
-version: '9.5.2'
+version: '9.6.0'
 sdks:
   - full-name: PubNub Javascript SDK
     short-name: Javascript
@@ -1252,7 +1265,7 @@ sdks:
           - distribution-type: source
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.5.2.zip
+            location: https://github.com/pubnub/javascript/archive/refs/tags/v9.6.0.zip
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'
@@ -1923,7 +1936,7 @@ sdks:
           - distribution-type: library
             distribution-repository: GitHub release
             package-name: pubnub.js
-            location: https://github.com/pubnub/javascript/releases/download/v9.5.2/pubnub.9.5.2.js
+            location: https://github.com/pubnub/javascript/releases/download/v9.6.0/pubnub.9.6.0.js
             requires:
               - name: 'agentkeepalive'
                 min-version: '3.5.2'

.scripts/types-aggregate.ts

@@ -169,7 +169,7 @@ class Package {
         const internalModuleMatch = fileContent.match(/^\/\*\*[\s\S]*?@internal[\s\S]*?\*\//);
         if (internalModuleMatch && internalModuleMatch.index !== undefined && internalModuleMatch.index === 0) return;
 
-        this.files.push(new SourceFile(resourcePath, this.workingDirectory, this.tsConfiguration.options));
+        this.files.push(new SourceFile(resourcePath, this.workingDirectory, this.tsConfiguration.options, this));
       }
     });
 
@@ -202,16 +202,18 @@ class SourceFile {
   private readonly _types: TypeDefinition[] = [];
 
   /**
-   * Create source file from type definition file in the package.
+   * Create a source file from type definition file in the package.
    *
    * @param filePath - Path to the type definition file which will be analyzed.
    * @param workingDirectory - Root folder with subfolders which represent project structure and contains types definition files.
    * @param tsCompileOptions - Package's TS parsed configuration object.
+   * @param projectPackage - Project with processed files information.
    */
   constructor(
     public readonly filePath: string,
     private readonly workingDirectory: string,
     private readonly tsCompileOptions: ts.CompilerOptions,
+    readonly projectPackage: Package,
   ) {
     const source = this.tsSourceFile();
     this.processImports(source);
@@ -343,6 +345,7 @@ class SourceFile {
           node.name.getText(sourceFile),
           type,
           this.tsSourceFile(`${documentation}\n${node.getText(sourceFile)}`),
+          this,
         ),
       );
     });
@@ -382,6 +385,7 @@ class TypeDefinition {
     public readonly name: string,
     public type: 'class' | 'interface' | 'type' | 'enum',
     private readonly sourceFile: ts.SourceFile,
+    private readonly projectSourceFile: SourceFile,
   ) {
     if (type === 'class') {
       const match = sourceFile.getText(this.sourceFile).match(/class PubNub extends ([a-zA-Z]+)[\s|<]/) ?? [];
@@ -412,6 +416,23 @@ class TypeDefinition {
           if (namespace) {
             const reference = ts.factory.createQualifiedName(ts.factory.createIdentifier(namespace), typeName);
 
+            replacement = ts.factory.createTypeReferenceNode(
+              reference,
+              node.typeArguments
+                ?.map((typeArg) => ts.visitNode(typeArg, visit))
+                .filter((typeArg): typeArg is ts.TypeNode => typeArg !== undefined),
+            );
+          }
+        } else if (!namespace && ts.isTypeReferenceNode(node)) {
+          const typeName = node.typeName.getText(this.sourceFile);
+          let typeNamespace = namespace;
+          this.projectSourceFile.imports.forEach((importType) => {
+            if (importType.type === 'alias' && importType.alias === typeName && !typeNamespace)
+              typeNamespace = 'PubNub';
+          });
+          if (typeNamespace) {
+            const reference = ts.factory.createQualifiedName(ts.factory.createIdentifier(typeNamespace), typeName);
+
             replacement = ts.factory.createTypeReferenceNode(
               reference,
               node.typeArguments
@@ -458,7 +479,9 @@ class TypeDefinition {
 
     const aliasedTypeStrings: string[] = [];
     if (this.aliases.length > 0) {
-      const matches = this.sourceFile.getText(this.sourceFile).match(/^(\s*(export\s+)?(declare\s+)?(type|class)\s)/gm);
+      const matches = this.sourceFile
+        .getText(this.sourceFile)
+        .match(/^(\s*(export\s+)?(declare\s+)?(type|class|enum)\s)/gm);
       if (!matches) throw new Error(`Unable to match prefix for '${this.name}' ${this.type}`);
 
       this.aliases.forEach((alias) => {

CHANGELOG.md

@@ -1,3 +1,13 @@
+## v9.6.0
+June 04 2025
+
+#### Added
+- Standardize information printed by logger and places where it is printed.
+- Add `logLevel` and `loggers` configuration parameters to specify minimum log level and list of custom `Logger` interface implementations (when own logger needed).
+- Add the `cloneEmpty` function, which will let you make a “bare” copy of a subscription / subscription set object, which will have shared state with the original but clear list of event handlers.
+- Add a parameter for subscription where closure can be provided and filter events which should be delivered with listener.
+- When a new subscription object is created, it won't notify about messages from the past (edge case with active and inactive channel subscriptions).
+
 ## v9.5.2
 April 22 2025
 

README.md

@@ -27,8 +27,8 @@ Watch [Getting Started with PubNub JS SDK](https://app.dashcam.io/replay/64ee0d2
      npm install pubnub
      ```
    * or download one of our builds from our CDN: 
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.5.2.js
-     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.5.2.min.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.0.js
+     * https://cdn.pubnub.com/sdk/javascript/pubnub.9.6.0.min.js
 
 2. Configure your keys: