Deprecate Notificatons and Stabilize GqlStatusObjects (#1285)

Author: MaxAake

packages/core/src/driver.ts

@@ -266,7 +266,7 @@ class SessionConfig {
     this.bookmarkManager = undefined
 
     /**
-     * Configure filter for {@link Notification} objects returned in {@link ResultSummary#notifications}.
+     * Configure filter for {@link gqlStatusObjects} notification returned in {@link ResultSummary#gqlStatusObjects}.
      *
      * This configuration enables filter notifications by:
      *

packages/core/src/index.ts

@@ -64,12 +64,12 @@ import ResultSummary, {
   QueryStatistics,
   Stats
 } from './result-summary'
-import Notification, {
+import GqlStatusObject, {
   NotificationPosition,
   NotificationSeverityLevel,
   NotificationClassification,
   NotificationCategory,
-  GqlStatusObject,
+  Notification,
   notificationCategory,
   notificationClassification,
   notificationSeverityLevel

packages/core/src/notification-filter.ts

@@ -61,13 +61,11 @@ Object.freeze(notificationFilterDisabledCategory)
 type NotificationFilterDisabledClassification = ExcludeUnknown<NotificationClassification>
 /**
  * @typedef {NotificationFilterDisabledCategory} NotificationFilterDisabledClassification
- * @experimental
  */
 /**
  * Constants that represents the disabled classifications in the {@link NotificationFilter}
  *
  * @type {notificationFilterDisabledCategory}
- * @experimental
  */
 const notificationFilterDisabledClassification: EnumRecord<NotificationFilterDisabledClassification> = notificationFilterDisabledCategory
 
@@ -115,7 +113,6 @@ class NotificationFilter {
      * and it must not be enabled at same time.
      *
      * @type {?NotificationFilterDisabledClassification[]}
-     * @experimental
      */
     this.disabledClassifications = undefined
 

packages/core/src/notification.ts

@@ -50,7 +50,7 @@ type NotificationSeverityLevel = 'WARNING' | 'INFORMATION' | 'UNKNOWN'
  * @typedef {'WARNING' | 'INFORMATION' | 'UNKNOWN'} NotificationSeverityLevel
  */
 /**
- * Constants that represents the Severity level in the {@link Notification}
+ * Constants that represents the Severity level in the {@link GqlStatusObject}
  */
 const notificationSeverityLevel: { [key in NotificationSeverityLevel]: key } = {
   WARNING: 'WARNING',
@@ -67,7 +67,7 @@ type NotificationCategory = 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMAN
  * @typedef {'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' |'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' } NotificationCategory
  */
 /**
- * Constants that represents the Category in the {@link Notification}
+ * Constants that represents the Category in the {@link GqlStatusObject}
  */
 const notificationCategory: { [key in NotificationCategory]: key } = {
   HINT: 'HINT',
@@ -88,18 +88,17 @@ const categories = Object.values(notificationCategory)
 type NotificationClassification = NotificationCategory
 /**
  * @typedef {NotificationCategory} NotificationClassification
- * @experimental
  */
 /**
  * Constants that represents the Classification in the {@link GqlStatusObject}
  * @type {notificationCategory}
- * @experimental
  */
 const notificationClassification = notificationCategory
 
 /**
  * Class for Cypher notifications
  * @access public
+ * @deprecated has been superceded by {@link GqlStatusObject}
  */
 class Notification {
   code: string
@@ -228,9 +227,7 @@ class Notification {
  * Representation for GqlStatusObject found when executing a query.
  * <p>
  * This object represents a status of query execution.
- * This status is a superset of {@link Notification}.
  *
- * @experimental
  * @public
  */
 class GqlStatusObject {
@@ -557,7 +554,7 @@ function _asEnumerableClassification (classification: any): NotificationClassifi
     : notificationClassification.UNKNOWN
 }
 
-export default Notification
+export default GqlStatusObject
 
 export {
   notificationSeverityLevel,

packages/core/src/result-summary.ts

@@ -18,7 +18,7 @@
 import Integer from './integer'
 import { NumberOrInteger } from './graph-types'
 import { util } from './internal'
-import Notification, { GqlStatusObject, buildGqlStatusObjectFromMetadata, buildNotificationsFromMetadata } from './notification'
+import GqlStatusObject, { Notification, buildGqlStatusObjectFromMetadata, buildNotificationsFromMetadata } from './notification'
 
 /**
  * A ResultSummary instance contains structured metadata for a {@link Result}.
@@ -107,6 +107,7 @@ class ResultSummary<T extends NumberOrInteger = Integer> {
      * or errors, notifications do not affect the execution of a query.
      * @type {Array<Notification>}
      * @public
+     * @deprecated has been superceded by {@link ResultSummary.gqlStatusObjects}
      */
     this.notifications = buildNotificationsFromMetadata(metadata)
 
@@ -129,7 +130,6 @@ class ResultSummary<T extends NumberOrInteger = Integer> {
      *
      * @type {Array<GqlStatusObject>}
      * @public
-     * @experimental
      */
     this.gqlStatusObjects = buildGqlStatusObjectFromMetadata(metadata)
 

packages/core/src/types.ts

@@ -298,7 +298,7 @@ export class Config {
     this.resolver = undefined
 
     /**
-     * Configure filter for Notification objects returned in {@link ResultSummary#notifications}.
+     * Configure filter for GqlStatusObject notifications returned in {@link ResultSummary#gqlStatusObjects}.
      *
      * See {@link SessionConfig#notificationFilter} for usage instructions.
      *