@microsoft/sp-diagnostics 1.22.0-beta.2 → 1.22.0-beta.4

package/lib/Diagnostics.d.ts

@@ -0,0 +1,47 @@
+import type IDiagnosticsSettings from './IDiagnosticsSettings';
+import type { IClearSettingsOptions, IExtraDiagnosticInfo } from './IDiagnosticsSettings';
+/**
+ * Diagnostics class initializes the diagnostics pipeline and connect to backend server.
+ * Diagnostics contains a set of internal APIs that collects data and reports data via
+ * the pipeline. The APIs consist of
+ *  -- TraceLogger - for logging diagnostic information
+ *
+ * @internal
+ */
+export default class Diagnostics {
+    private static _isInitialized;
+    /**
+     * Initializes the diagnostics pipelines
+     */
+    static initialize(settings: IDiagnosticsSettings): void;
+    /**
+     * Returns true if diagnostics has been already initialized.
+     */
+    static get isInitialized(): boolean;
+    /**
+     * Used to refresh the telemetry settings when they change from the application
+     * (i.e. when an in-place navigation to a different site happens)
+     * @param settings - the subset of the telemetry settings to be updated
+     */
+    static updateSettings(settings: Partial<IDiagnosticsSettings>): void;
+    /**
+     * Get the authoring session client count info from the extraDiagnosticsInfo from Diagnostics settings
+     * @deprecated - Read from @see getExtraDiagnosticInfo
+     * @returns the number of clients in the authoring session
+     */
+    static getAuthoringSessionClientCountInfo(): number | undefined;
+    /**
+     * Get the extra diagnostic info for logging purpose.
+     * @internal
+     * @returns @see IExtraDiagnosticInfo
+     */
+    static _getExtraDiagnosticInfo(): IExtraDiagnosticInfo | undefined;
+    /**
+     * Used to delete telemetry settings when they are no longer needed or need to be reset.
+     * The current updateSettings implementation does not support un-setting previously
+     * set settings values.
+     * @param settings - the subset of the telemetry settings to be cleared.
+     */
+    static clearSettings(settings: IClearSettingsOptions): void;
+}
+//# sourceMappingURL=Diagnostics.d.ts.map

package/lib/Diagnostics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diagnostics.d.ts","sourceRoot":"","sources":["../src/Diagnostics.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,oBAAoB,MAAM,wBAAwB,CAAC;AAG/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,MAAM,CAAC,cAAc,CAAkB;IAE/C;;OAEG;WACW,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI;IAoB9D;;OAEG;IACH,WAAkB,aAAa,IAAI,OAAO,CAEzC;IAED;;;;OAIG;WACW,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI;IAI3E;;;;OAIG;WACW,kCAAkC,IAAI,MAAM,GAAG,SAAS;IAItE;;;;OAIG;WACW,uBAAuB,IAAI,oBAAoB,GAAG,SAAS;IAIzE;;;;;OAKG;WACW,aAAa,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI;CAGnE"}

package/lib/Diagnostics.js

@@ -0,0 +1,82 @@
+import { Log } from '@microsoft/sp-core-library';
+import DiagnosticsSettingsManager from './DiagnosticsSettingsManager';
+import TraceLogger from './Api/Trace/TraceLogger';
+/**
+ * Diagnostics class initializes the diagnostics pipeline and connect to backend server.
+ * Diagnostics contains a set of internal APIs that collects data and reports data via
+ * the pipeline. The APIs consist of
+ *  -- TraceLogger - for logging diagnostic information
+ *
+ * @internal
+ */
+var Diagnostics = /** @class */ (function () {
+    function Diagnostics() {
+    }
+    /**
+     * Initializes the diagnostics pipelines
+     */
+    Diagnostics.initialize = function (settings) {
+        if (!Diagnostics._isInitialized) {
+            DiagnosticsSettingsManager.initialize(settings);
+            TraceLogger.shouldWriteToConsole = settings.enableConsoleLog;
+            TraceLogger._addHandler({
+                log: function (traceEvent) {
+                    Log.info(traceEvent.eventName, "EventName:".concat(traceEvent.data.toString(), ", ResultCode: ").concat(traceEvent.resultCode));
+                },
+                verbose: function (traceEvent) {
+                    Log.verbose(traceEvent.eventName, traceEvent.data.toString());
+                }
+            });
+            Diagnostics._isInitialized = true;
+        }
+    };
+    Object.defineProperty(Diagnostics, "isInitialized", {
+        /**
+         * Returns true if diagnostics has been already initialized.
+         */
+        get: function () {
+            return this._isInitialized;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Used to refresh the telemetry settings when they change from the application
+     * (i.e. when an in-place navigation to a different site happens)
+     * @param settings - the subset of the telemetry settings to be updated
+     */
+    Diagnostics.updateSettings = function (settings) {
+        DiagnosticsSettingsManager.updateSettings(settings);
+    };
+    /**
+     * Get the authoring session client count info from the extraDiagnosticsInfo from Diagnostics settings
+     * @deprecated - Read from @see getExtraDiagnosticInfo
+     * @returns the number of clients in the authoring session
+     */
+    Diagnostics.getAuthoringSessionClientCountInfo = function () {
+        var _a, _b;
+        return (_b = (_a = DiagnosticsSettingsManager.settings) === null || _a === void 0 ? void 0 : _a.extraDiagnosticInfo) === null || _b === void 0 ? void 0 : _b.authoringSessionClientCount;
+    };
+    /**
+     * Get the extra diagnostic info for logging purpose.
+     * @internal
+     * @returns @see IExtraDiagnosticInfo
+     */
+    Diagnostics._getExtraDiagnosticInfo = function () {
+        var _a;
+        return (_a = DiagnosticsSettingsManager.settings) === null || _a === void 0 ? void 0 : _a.extraDiagnosticInfo;
+    };
+    /**
+     * Used to delete telemetry settings when they are no longer needed or need to be reset.
+     * The current updateSettings implementation does not support un-setting previously
+     * set settings values.
+     * @param settings - the subset of the telemetry settings to be cleared.
+     */
+    Diagnostics.clearSettings = function (settings) {
+        DiagnosticsSettingsManager.clearSettings(settings);
+    };
+    Diagnostics._isInitialized = false;
+    return Diagnostics;
+}());
+export default Diagnostics;
+//# sourceMappingURL=Diagnostics.js.map

package/lib/DiagnosticsSettingsManager.d.ts

@@ -0,0 +1,19 @@
+import type IDiagnosticsSettings from './IDiagnosticsSettings';
+import type { IClearSettingsOptions } from './IDiagnosticsSettings';
+/**
+ * TelemetrySettingsManager stores the configuration for Telemetry passed
+ * down by the calling application during bootstrapping.
+ *
+ * @internal
+ */
+export default class DiagnosticsSettingsManager {
+    static settings: IDiagnosticsSettings;
+    private static _initialized;
+    static initialize(settings: IDiagnosticsSettings): void;
+    static updateSettings(settings: Partial<IDiagnosticsSettings>): void;
+    static clearSettings(settings: IClearSettingsOptions): void;
+    static get isInitialized(): boolean;
+    private static _normalizeId;
+    private static _normalizeContextIds;
+}
+//# sourceMappingURL=DiagnosticsSettingsManager.d.ts.map

package/lib/DiagnosticsSettingsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DiagnosticsSettingsManager.d.ts","sourceRoot":"","sources":["../src/DiagnosticsSettingsManager.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,oBAAoB,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C,OAAc,QAAQ,EAAE,oBAAoB,CAAC;IAC7C,OAAO,CAAC,MAAM,CAAC,YAAY,CAAkB;WAE/B,UAAU,CAAC,QAAQ,EAAE,oBAAoB,GAAG,IAAI;WAMhD,cAAc,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,IAAI;WAK7D,aAAa,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI;IAgBlE,WAAkB,aAAa,IAAI,OAAO,CAEzC;IAED,OAAO,CAAC,MAAM,CAAC,YAAY;IAK3B,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAYpC"}

package/lib/DiagnosticsSettingsManager.js

@@ -0,0 +1,62 @@
+import { Guid } from '@microsoft/sp-core-library';
+import { cloneDeep, merge } from '@microsoft/sp-lodash-subset';
+/**
+ * TelemetrySettingsManager stores the configuration for Telemetry passed
+ * down by the calling application during bootstrapping.
+ *
+ * @internal
+ */
+var DiagnosticsSettingsManager = /** @class */ (function () {
+    function DiagnosticsSettingsManager() {
+    }
+    DiagnosticsSettingsManager.initialize = function (settings) {
+        this.settings = cloneDeep(settings);
+        this._initialized = true;
+        this._normalizeContextIds();
+    };
+    DiagnosticsSettingsManager.updateSettings = function (settings) {
+        this.settings = merge(this.settings, settings);
+        this._normalizeContextIds();
+    };
+    DiagnosticsSettingsManager.clearSettings = function (settings) {
+        var _this = this;
+        if (settings.diagnosticSettings) {
+            settings.diagnosticSettings.forEach(function (setting) {
+                delete _this.settings[setting];
+            });
+        }
+        if (settings.extraDiagnosticInfo) {
+            settings.extraDiagnosticInfo.forEach(function (info) {
+                if (_this.settings.extraDiagnosticInfo && _this.settings.extraDiagnosticInfo[info]) {
+                    delete _this.settings.extraDiagnosticInfo[info];
+                }
+            });
+        }
+    };
+    Object.defineProperty(DiagnosticsSettingsManager, "isInitialized", {
+        get: function () {
+            return this._initialized;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    DiagnosticsSettingsManager._normalizeId = function (id) {
+        var guid = Guid.tryParse(id);
+        return (guid === null || guid === void 0 ? void 0 : guid.toString()) || id;
+    };
+    DiagnosticsSettingsManager._normalizeContextIds = function () {
+        this.settings.siteId = this._normalizeId(this.settings.siteId);
+        this.settings.webId = this._normalizeId(this.settings.webId);
+        this.settings.correlationId = this._normalizeId(this.settings.correlationId);
+        if (this.settings.listId) {
+            this.settings.listId = this._normalizeId(this.settings.listId);
+            if (this.settings.listItemUniqueId) {
+                this.settings.listItemUniqueId = this._normalizeId(this.settings.listItemUniqueId);
+            }
+        }
+    };
+    DiagnosticsSettingsManager._initialized = false;
+    return DiagnosticsSettingsManager;
+}());
+export default DiagnosticsSettingsManager;
+//# sourceMappingURL=DiagnosticsSettingsManager.js.map

package/lib/IDiagnosticsSettings.d.ts

@@ -0,0 +1,87 @@
+import type { IDiagnosticContextInfo } from './extraData/IDiagnosticContextInfo';
+/**
+ * Diagnostics configuration
+ *
+ * @internal
+ */
+export interface IDiagnosticsSettings {
+    /**
+     * Flag to enable logging of Diagnostics to the console
+     */
+    enableConsoleLog: boolean;
+    /**
+     * The current site id (GUID)
+     * Example: `"{440067a7-8e96-4446-8e0e-fafef7a9e9d9}"`
+     */
+    siteId: string;
+    /**
+     * The current web id (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    webId: string;
+    /**
+     * The current list id (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    listId?: string;
+    /**
+     * The current list item unique id (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    listItemUniqueId?: string;
+    /**
+     * The current correlationId (GUID)
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    correlationId: string;
+    /**
+     * Page context info
+     */
+    contextInfo?: IDiagnosticContextInfo;
+    /**
+     * Extra diagnostic info
+     */
+    extraDiagnosticInfo?: IExtraDiagnosticInfo;
+}
+/**
+ * Extra diagnostic information not related to core configuration
+ *
+ * @internal
+ */
+export interface IExtraDiagnosticInfo {
+    /**
+     * The id of the authoring session if user is currently editing the page.
+     * Session id is same across all users collaborating on the same page.
+     * Example: `"{b29e6452-fe31-4967-872b-ea5d23dbfe07}"`
+     */
+    authoringSessionId?: string;
+    /**
+     * Only valid in authoring session, the id of the last op that has been received by the current client.
+     * This id is unique and is incremented globally across the authoring session so this can be used to align
+     * the timing of multiple users rather than relying on browser time from different devices.
+     * Example: `5`
+     */
+    authoringOpSequenceId?: number;
+    /**
+     * Only valid in authoring session. This represents the number of concurrent clients in an authoring session.
+     * It will be updated as and when users join and leave a page edit session.
+     */
+    authoringSessionClientCount?: number;
+    /**
+     * Indicating the current authoring phase of the page.
+     */
+    hasAuthoringStarted?: boolean;
+    /**
+     * Indicating if DDS (Distributed Data Structure) is used in authoring.
+     */
+    isAuthoringUsingDDS?: boolean;
+}
+/**
+ * Options for clearing telemetry settings including top level and nested properties
+ */
+export interface IClearSettingsOptions {
+    diagnosticSettings?: (keyof IDiagnosticsSettings)[];
+    extraDiagnosticInfo?: (keyof IExtraDiagnosticInfo)[];
+}
+export default IDiagnosticsSettings;
+//# sourceMappingURL=IDiagnosticsSettings.d.ts.map

package/lib/IDiagnosticsSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDiagnosticsSettings.d.ts","sourceRoot":"","sources":["../src/IDiagnosticsSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,sBAAsB,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;CAC5C;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,CAAC,EAAE,CAAC,MAAM,oBAAoB,CAAC,EAAE,CAAC;IACpD,mBAAmB,CAAC,EAAE,CAAC,MAAM,oBAAoB,CAAC,EAAE,CAAC;CACtD;AAED,eAAe,oBAAoB,CAAC"}

package/lib/IDiagnosticsSettings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDiagnosticsSettings.js.map

package/lib/common/Killswitches.d.ts

@@ -0,0 +1,3 @@
+export declare function isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive(): boolean;
+export declare function isTrackCopilotLicenseKSActivated(): boolean;
+//# sourceMappingURL=Killswitches.d.ts.map

package/lib/common/Killswitches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Killswitches.d.ts","sourceRoot":"","sources":["../../src/common/Killswitches.ts"],"names":[],"mappings":"AAGA,wBAAgB,qDAAqD,IAAI,OAAO,CAK/E;AAGD,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D"}

package/lib/common/Killswitches.js

@@ -0,0 +1,14 @@
+import { _SPKillSwitch } from '@microsoft/sp-core-library';
+// cross-project: also in sp-edit-customer-promise
+export function isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive() {
+    return _SPKillSwitch.isActivated('c125685f-83e7-44c8-b602-5c21f5b748ae'
+    /* '06/25/2025', 'atagle -appends the " (offline)" suffix to the ASHA error code name the browser is offline at the time of logging' */
+    );
+}
+// Cross-project KS
+export function isTrackCopilotLicenseKSActivated() {
+    return _SPKillSwitch.isActivated('2f310bfc-1afe-4707-88eb-b7e51292a330'
+    /* '10/08/2025', 'AntonLa - track copilot license usage across telemetry' */
+    );
+}
+//# sourceMappingURL=Killswitches.js.map

package/lib/extraData/DisplayApp.d.ts

@@ -0,0 +1,6 @@
+export declare const DisplayApp: {
+    readonly Sharepoint: "Sharepoint";
+    readonly Teams: "Teams";
+};
+export type DisplayApp = typeof DisplayApp[keyof typeof DisplayApp];
+//# sourceMappingURL=DisplayApp.d.ts.map

package/lib/extraData/DisplayApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayApp.d.ts","sourceRoot":"","sources":["../../src/extraData/DisplayApp.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC"}

package/lib/extraData/DisplayApp.js

@@ -0,0 +1,6 @@
+// eslint-disable-next-line @typescript-eslint/typedef
+export var DisplayApp = {
+    Sharepoint: 'Sharepoint',
+    Teams: 'Teams'
+};
+//# sourceMappingURL=DisplayApp.js.map

package/lib/extraData/IDiagnosticContextInfo.d.ts

@@ -0,0 +1,18 @@
+import type { PromotedState } from './PromotedState';
+import type { PageType } from './PageType';
+/**
+ * Diagnostics context info
+ *
+ * @internal
+ */
+export interface IDiagnosticContextInfo {
+    pageId: string | undefined;
+    isHubSite: boolean;
+    hubSiteId: string | undefined;
+    webTemplate: string;
+    pageType: PageType | undefined;
+    promotedState: PromotedState | undefined;
+    isEduClass: boolean | undefined;
+    hasCopilotLicense: boolean | undefined;
+}
+//# sourceMappingURL=IDiagnosticContextInfo.d.ts.map

package/lib/extraData/IDiagnosticContextInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDiagnosticContextInfo.d.ts","sourceRoot":"","sources":["../../src/extraData/IDiagnosticContextInfo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IACzC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC,iBAAiB,EAAE,OAAO,GAAG,SAAS,CAAC;CACxC"}

package/lib/extraData/IDiagnosticContextInfo.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDiagnosticContextInfo.js.map

package/lib/extraData/IPageExtraData.d.ts

@@ -0,0 +1,16 @@
+import type { DisplayApp } from './DisplayApp';
+import type { SiteType } from '../Api/Engagement/IEngagementHandler';
+import type { PageType } from './PageType';
+export interface IPageExtraData {
+    displayApp: DisplayApp;
+    hubSiteId: string | undefined;
+    isAssociatedSite: boolean;
+    isHub: boolean;
+    pageType: PageType;
+    pageId: string;
+    siteType: SiteType;
+    userAgent: string;
+    webTemplate: string;
+    isEduClass: boolean | undefined;
+}
+//# sourceMappingURL=IPageExtraData.d.ts.map

package/lib/extraData/IPageExtraData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPageExtraData.d.ts","sourceRoot":"","sources":["../../src/extraData/IPageExtraData.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC"}

package/lib/extraData/IPageExtraData.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IPageExtraData.js.map

package/lib/extraData/PageType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Page Type
+ *
+ * @internal
+ */
+export declare enum PageType {
+    News = "News",
+    Article = "Article",
+    Home = "Home",
+    Space = "Space",
+    NewsDigest = "NewsDigest"
+}
+//# sourceMappingURL=PageType.d.ts.map

package/lib/extraData/PageType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageType.d.ts","sourceRoot":"","sources":["../../src/extraData/PageType.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,oBAAY,QAAQ;IAClB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,UAAU,eAAe;CAC1B"}

package/lib/extraData/PageType.js

@@ -0,0 +1,16 @@
+/**
+ * Page Type
+ *
+ * @internal
+ */
+// This is quite similar to CurrentPage but these are simplified names that
+// we want to build dashboards with.
+export var PageType;
+(function (PageType) {
+    PageType["News"] = "News";
+    PageType["Article"] = "Article";
+    PageType["Home"] = "Home";
+    PageType["Space"] = "Space";
+    PageType["NewsDigest"] = "NewsDigest";
+})(PageType || (PageType = {}));
+//# sourceMappingURL=PageType.js.map

package/lib/extraData/PromotedState.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Promoted state
+ *
+ * @internal
+ */
+export declare enum PromotedState {
+    /**
+     * Regular page (can later be promoted to news)
+     */
+    NotPromoted = 0,
+    /**
+     * News post (a page with special notifications sent out upon publishing)
+     */
+    Promoted = 2
+}
+//# sourceMappingURL=PromotedState.d.ts.map

package/lib/extraData/PromotedState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PromotedState.d.ts","sourceRoot":"","sources":["../../src/extraData/PromotedState.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,WAAW,IAAI;IACf;;OAEG;IACH,QAAQ,IAAI;CACb"}

package/lib/extraData/PromotedState.js

@@ -0,0 +1,17 @@
+/**
+ * Promoted state
+ *
+ * @internal
+ */
+export var PromotedState;
+(function (PromotedState) {
+    /**
+     * Regular page (can later be promoted to news)
+     */
+    PromotedState[PromotedState["NotPromoted"] = 0] = "NotPromoted";
+    /**
+     * News post (a page with special notifications sent out upon publishing)
+     */
+    PromotedState[PromotedState["Promoted"] = 2] = "Promoted";
+})(PromotedState || (PromotedState = {}));
+//# sourceMappingURL=PromotedState.js.map

package/lib/extraData/WebTemplateId.d.ts

@@ -0,0 +1,8 @@
+export declare const WebTemplateId: {
+    readonly TeamSite: "1";
+    readonly MySite: "21";
+    readonly GroupSite: "64";
+    readonly SitePagePublishing: "68";
+};
+export type WebTemplateId = typeof WebTemplateId[keyof typeof WebTemplateId];
+//# sourceMappingURL=WebTemplateId.d.ts.map

package/lib/extraData/WebTemplateId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebTemplateId.d.ts","sourceRoot":"","sources":["../../src/extraData/WebTemplateId.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC"}

package/lib/extraData/WebTemplateId.js

@@ -0,0 +1,10 @@
+// One place to find the list is at
+// https://onedrive.visualstudio.com/SPIN/_git/FFTScripts?path=%2Fsrc%2FCreateDBScripts%2FFFTDashboard-WebTemplateNames.sql&version=GBmaster
+// eslint-disable-next-line @typescript-eslint/typedef
+export var WebTemplateId = {
+    TeamSite: '1',
+    MySite: '21',
+    GroupSite: '64',
+    SitePagePublishing: '68'
+};
+//# sourceMappingURL=WebTemplateId.js.map

package/lib/extraData/setPageExtraData.d.ts

@@ -0,0 +1,5 @@
+import type { IDiagnosticContextInfo } from './IDiagnosticContextInfo';
+export declare function setPageExtraData(contextInfo: IDiagnosticContextInfo, extraData: {
+    [key: string]: unknown;
+}): void;
+//# sourceMappingURL=setPageExtraData.d.ts.map

package/lib/extraData/setPageExtraData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setPageExtraData.d.ts","sourceRoot":"","sources":["../../src/extraData/setPageExtraData.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGvE,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,sBAAsB,EACnC,SAAS,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GACpC,IAAI,CAwDN"}

package/lib/extraData/setPageExtraData.js

@@ -0,0 +1,66 @@
+import { _BrowserUtilities } from '@microsoft/sp-core-library';
+import { DisplayApp } from './DisplayApp';
+import { WebTemplateId } from './WebTemplateId';
+import { PromotedState } from './PromotedState';
+import { PageType } from './PageType';
+import { isTrackCopilotLicenseKSActivated } from '../common/Killswitches';
+export function setPageExtraData(contextInfo, extraData) {
+    extraData.pageId = contextInfo.pageId;
+    extraData.isHub = contextInfo.isHubSite;
+    if (contextInfo.isHubSite) {
+        extraData.hubSiteId = contextInfo.hubSiteId;
+        extraData.isAssociatedSite = false;
+    }
+    else if (!contextInfo.isHubSite && contextInfo.hubSiteId) {
+        // If isHubSite is false, but hubSiteId is set, we call it associatedSite
+        extraData.isAssociatedSite = true;
+    }
+    else {
+        extraData.isAssociatedSite = false;
+    }
+    if (!extraData.displayApp) {
+        if (_BrowserUtilities.isTeamsHosted()) {
+            extraData.displayApp = DisplayApp.Teams;
+            if (contextInfo.isEduClass) {
+                extraData.isEduClass = true;
+            }
+        }
+        else {
+            extraData.displayApp = DisplayApp.Sharepoint;
+        }
+    }
+    extraData.userAgent = navigator.userAgent;
+    var webTemplate = contextInfo.webTemplate;
+    extraData.webTemplate = webTemplate;
+    var siteType;
+    if (webTemplate === WebTemplateId.TeamSite) {
+        siteType = 'TeamSite';
+    }
+    else if (webTemplate === WebTemplateId.GroupSite) {
+        siteType = 'GroupSite';
+    }
+    else if (webTemplate === WebTemplateId.SitePagePublishing) {
+        siteType = 'CommunicationSite';
+    }
+    else if (webTemplate === WebTemplateId.MySite) {
+        siteType = 'MySite';
+    }
+    var promotedState = contextInfo.promotedState;
+    var pageLayoutType = contextInfo.pageType;
+    var pageType = pageLayoutType;
+    if (pageLayoutType === PageType.Article) {
+        if (promotedState === PromotedState.NotPromoted || promotedState === undefined) {
+            pageType = PageType.Article;
+        }
+        else {
+            pageType = PageType.News;
+        }
+    }
+    extraData.siteType = siteType;
+    extraData.pageType = pageType;
+    extraData.isDebug = !!_BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
+    extraData.hasCopilotLicense = !isTrackCopilotLicenseKSActivated()
+        ? !!contextInfo.hasCopilotLicense
+        : undefined;
+}
+//# sourceMappingURL=setPageExtraData.js.map

package/lib/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This package defines the internal diagnostics tools for the SharePoint Framework,
+ * including monitoring, trace, user engagement and performance logging.
+ *
+ * @packagedocumentation
+ */
+export { default as _TraceLogger } from './Api/Trace/TraceLogger';
+export type { ITraceHandler as _ITraceHandler, ITraceLogEvent as _ITraceLogEvent, IVerboseTraceLogEvent as _IVerboseTraceLogEvent } from './Api/Trace/ITraceHandler';
+export type { default as _ILogData } from './Api/ILogData';
+export type { default as _ILogErrorData } from './Api/ILogErrorData';
+export type { default as _ILogVerboseData } from './Api/ILogVerboseData';
+export type { default as _ILogEntry } from './Api/ILogEntry';
+export type { default as _ILogSource } from './Api/ILogSource';
+export type { default as _ITraceLogger } from './Api/Trace/ITraceLogger';
+export { default as _LogEntry } from './Api/LogEntry';
+export { default as _LogFeature } from './Api/LogFeature';
+export { default as _LogSource, logSourceServiceKey as _logSourceServiceKey } from './Api/LogSource';
+export { default as _LogType } from './Api/LogType';
+export { default as _Diagnostics } from './Diagnostics';
+export type { IDiagnosticsSettings as _IDiagnosticsSettings, IExtraDiagnosticInfo as _IExtraDiagnosticInfo } from './IDiagnosticsSettings';
+export type { IDiagnosticContextInfo as _IDiagnosticContextInfo } from './extraData/IDiagnosticContextInfo';
+export { PromotedState as _PromotedState } from './extraData/PromotedState';
+export { PageType as _PageType } from './extraData/PageType';
+export { default as _LogEvent } from './Api/Trace/LogEvent';
+export { LogLevel as _LogLevel } from './Api/LogLevel';
+export { default as _CircularBuffer } from './Api/LogManager/CircularBuffer';
+export { default as _LogManager } from './Api/LogManager/LogManager';
+export { default as _EngagementLogger } from './Api/Engagement/EngagementLogger';
+export type { IEngagementHandler as _IEngagementHandler, IEngagementData as _IEngagementData, IABExperiment as _IABExperiment, SiteType as _SiteType, CurrentPage as _CurrentPage, Feature as _Feature, Component as _Component, UsageType as _UsageType } from './Api/Engagement/IEngagementHandler';
+export { default as _LogHandler } from './Api/Log/LogHandler';
+export { default as _QosMonitor } from './Api/Qos/QosMonitor';
+export { AutoAlertableQosMonitor as _AutoAlertableQosMonitor, AutoAlertableMonitorType as _AutoAlertableMonitorType } from './Api/Qos/AutoAlertableQosMonitor';
+export { QosMonitorShareFailureWithCP as _QosMonitorShareFailureWithCP } from './Api/Qos/QosMonitorShareFailureWithCP';
+export type { ICustomerPromiseErrorDetails as _ICustomerPromiseErrorDetails } from './Api/Qos/CustomerPromiseInterfaces/ICustomerPromiseErrorDetails';
+export type { IExtraDataForCustomerPromise as _IExtraDataForCustomerPromise } from './Api/Qos/CustomerPromiseInterfaces/IExtraDataForCustomerPromise';
+export { default as _QosLogger } from './Api/Qos/QosLogger';
+export type { IQosExtraData as _IQosExtraData } from './Api/Qos/IQosExtraData';
+export type { IQos as _IQos } from './Api/Qos/IQos';
+export type { IQosStartEvent as _IQosStartEvent } from './Api/Qos/IQosStartEvent';
+export { QosResultType as _QosResultType } from './Api/Qos/QosResultType';
+export { default as _ExecutionQueue } from './Api/ExecutionQueue';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAClE,YAAY,EACV,aAAa,IAAI,cAAc,EAC/B,cAAc,IAAI,eAAe,EACjC,qBAAqB,IAAI,sBAAsB,EAChD,MAAM,2BAA2B,CAAC;AACnC,YAAY,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3D,YAAY,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrE,YAAY,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzE,YAAY,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7D,YAAY,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/D,YAAY,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACrG,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,eAAe,CAAC;AACxD,YAAY,EACV,oBAAoB,IAAI,qBAAqB,EAC7C,oBAAoB,IAAI,qBAAqB,EAC9C,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,sBAAsB,IAAI,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAC5G,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAErE,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACjF,YAAY,EACV,kBAAkB,IAAI,mBAAmB,EACzC,eAAe,IAAI,gBAAgB,EACnC,aAAa,IAAI,cAAc,EAC/B,QAAQ,IAAI,SAAS,EACrB,WAAW,IAAI,YAAY,EAC3B,OAAO,IAAI,QAAQ,EACnB,SAAS,IAAI,UAAU,EACvB,SAAS,IAAI,UAAU,EACxB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EACL,uBAAuB,IAAI,wBAAwB,EACnD,wBAAwB,IAAI,yBAAyB,EACtD,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,4BAA4B,IAAI,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvH,YAAY,EAAE,4BAA4B,IAAI,6BAA6B,EAAE,MAAM,kEAAkE,CAAC;AACtJ,YAAY,EAAE,4BAA4B,IAAI,6BAA6B,EAAE,MAAM,kEAAkE,CAAC;AACtJ,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC5D,YAAY,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC/E,YAAY,EAAE,IAAI,IAAI,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACpD,YAAY,EAAE,cAAc,IAAI,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAClF,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE1E,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,sBAAsB,CAAC"}