@genesislcap/foundation-comms 14.427.1-TAM-8.26-patch.1 → 14.427.1-TAM.8.26-patch.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/dist/dts/analytics/analytics.d.ts +7 -14
  2. package/dist/dts/analytics/analytics.d.ts.map +1 -1
  3. package/dist/esm/analytics/analytics.js +7 -11
  4. package/dist/foundation-comms.api.json +2 -34
  5. package/dist/foundation-comms.d.ts +7 -14
  6. package/package.json +14 -15
package/dist/dts/analytics/analytics.d.ts CHANGED
@@ -54,23 +54,16 @@ export interface FoundationAnalytics {
54
54
  trackEvent(eventName: FoundationAnalyticsEventType, payload: {}): void;
55
55
  }
56
56
  /**
57
- * The default implementation for the FoundationAnalytics interface.
57
+ * The default no-op implementation for the FoundationAnalytics interface.
58
+ *
59
+ * @remarks
60
+ * The `analytics` npm package (v0.8.16) was removed after a security scan flagged its transitive
61
+ * for using `window.location.search.substring(1)` - no upstream fix is available.
62
+ * Replace this no-op when analytics tracking is needed.
63
+ *
58
64
  * @public
59
65
  */
60
66
  export declare class DefaultFoundationAnalytics implements FoundationAnalytics {
61
- private analytics;
62
- /**
63
- * TODO: Remove the static config.
64
- * We could register a config with the container at startup and have it injected here or remove the constructor and
65
- * define a method call.
66
- */
67
- constructor(config: {
68
- app: 'foundation-app';
69
- debug: true;
70
- });
71
- /**
72
- * Set typed overloads
73
- */
74
67
  trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
75
68
  trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
76
69
  }
package/dist/dts/analytics/analytics.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/analytics/analytics.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,cAAc,mBAAmB;IACjC,YAAY,iBAAiB;CAC9B;AAED;;GAEG;AACH,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,cAAc;QAC7B,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,UAAU,CACR,SAAS,EAAE,4BAA4B,CAAC,cAAc,EACtD,OAAO,EAAE,wBAAwB,CAAC,cAAc,GAC/C,IAAI,CAAC;IAER;;;;;OAKG;IACH,UAAU,CACR,SAAS,EAAE,4BAA4B,CAAC,YAAY,EACpD,OAAO,EAAE,wBAAwB,CAAC,YAAY,GAC7C,IAAI,CAAC;IAER;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,4BAA4B,EAAE,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC;CACxE;AAED;;;GAGG;AACH,qBAAa,0BAA2B,YAAW,mBAAmB;IACpE,OAAO,CAAC,SAAS,CAAoB;IAErC;;;;OAIG;gBACS,MAAM,EAAE;QAAE,GAAG,EAAE,gBAAgB,CAAC;QAAC,KAAK,EAAE,IAAI,CAAA;KAAE;IAI1D;;OAEG;IACI,UAAU,CACf,SAAS,EAAE,4BAA4B,CAAC,cAAc,EACtD,OAAO,EAAE,wBAAwB,CAAC,cAAc,GAC/C,IAAI;IACA,UAAU,CACf,SAAS,EAAE,4BAA4B,CAAC,YAAY,EACpD,OAAO,EAAE,wBAAwB,CAAC,YAAY,GAC7C,IAAI;CAKR;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,2EAE/B,CAAC;AAEF;;;;;;;;GAQG"}
1
+ {"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/analytics/analytics.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,cAAc,mBAAmB;IACjC,YAAY,iBAAiB;CAC9B;AAED;;GAEG;AACH,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,cAAc;QAC7B,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,UAAU,CACR,SAAS,EAAE,4BAA4B,CAAC,cAAc,EACtD,OAAO,EAAE,wBAAwB,CAAC,cAAc,GAC/C,IAAI,CAAC;IAER;;;;;OAKG;IACH,UAAU,CACR,SAAS,EAAE,4BAA4B,CAAC,YAAY,EACpD,OAAO,EAAE,wBAAwB,CAAC,YAAY,GAC7C,IAAI,CAAC;IAER;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,4BAA4B,EAAE,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC;CACxE;AAED;;;;;;;;;GASG;AACH,qBAAa,0BAA2B,YAAW,mBAAmB;IAC7D,UAAU,CACf,SAAS,EAAE,4BAA4B,CAAC,cAAc,EACtD,OAAO,EAAE,wBAAwB,CAAC,cAAc,GAC/C,IAAI;IACA,UAAU,CACf,SAAS,EAAE,4BAA4B,CAAC,YAAY,EACpD,OAAO,EAAE,wBAAwB,CAAC,YAAY,GAC7C,IAAI;CAIR;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,2EAE/B,CAAC;AAEF;;;;;;;;GAQG"}
package/dist/esm/analytics/analytics.js CHANGED
@@ -1,5 +1,4 @@
1
1
  import { DI } from '@microsoft/fast-foundation';
2
- import Analytics from 'analytics';
3
2
  import { logger } from '../utils';
4
3
  /**
5
4
  * Analytics event types
@@ -11,21 +10,18 @@ export var FoundationAnalyticsEventType;
11
10
  FoundationAnalyticsEventType["routeChanged"] = "routeChanged";
12
11
  })(FoundationAnalyticsEventType || (FoundationAnalyticsEventType = {}));
13
12
  /**
14
- * The default implementation for the FoundationAnalytics interface.
13
+ * The default no-op implementation for the FoundationAnalytics interface.
14
+ *
15
+ * @remarks
16
+ * The `analytics` npm package (v0.8.16) was removed after a security scan flagged its transitive
17
+ * for using `window.location.search.substring(1)` - no upstream fix is available.
18
+ * Replace this no-op when analytics tracking is needed.
19
+ *
15
20
  * @public
16
21
  */
17
22
  export class DefaultFoundationAnalytics {
18
- /**
19
- * TODO: Remove the static config.
20
- * We could register a config with the container at startup and have it injected here or remove the constructor and
21
- * define a method call.
22
- */
23
- constructor(config) {
24
- this.analytics = Analytics(config);
25
- }
26
23
  trackEvent(eventName, payload) {
27
24
  logger.debug(`FoundationAnalytics.trackEvent ${eventName} : ${JSON.stringify(payload)}`);
28
- this.analytics.track(eventName, payload);
29
25
  }
30
26
  }
31
27
  /**
package/dist/foundation-comms.api.json CHANGED
@@ -17020,7 +17020,7 @@
17020
17020
  {
17021
17021
  "kind": "Class",
17022
17022
  "canonicalReference": "@genesislcap/foundation-comms!DefaultFoundationAnalytics:class",
17023
- "docComment": "/**\n * The default implementation for the FoundationAnalytics interface.\n *\n * @public\n */\n",
17023
+ "docComment": "/**\n * The default no-op implementation for the FoundationAnalytics interface.\n *\n * @remarks\n *\n * The `analytics` npm package (v0.8.16) was removed after a security scan flagged its transitive for using `window.location.search.substring(1)` - no upstream fix is available. Replace this no-op when analytics tracking is needed.\n *\n * @public\n */\n",
17024
17024
  "excerptTokens": [
17025
17025
  {
17026
17026
  "kind": "Content",
@@ -17042,42 +17042,10 @@
17042
17042
  "name": "DefaultFoundationAnalytics",
17043
17043
  "preserveMemberOrder": false,
17044
17044
  "members": [
17045
- {
17046
- "kind": "Constructor",
17047
- "canonicalReference": "@genesislcap/foundation-comms!DefaultFoundationAnalytics:constructor(1)",
17048
- "docComment": "/**\n * TODO: Remove the static config. We could register a config with the container at startup and have it injected here or remove the constructor and define a method call.\n */\n",
17049
- "excerptTokens": [
17050
- {
17051
- "kind": "Content",
17052
- "text": "constructor(config: "
17053
- },
17054
- {
17055
- "kind": "Content",
17056
- "text": "{\n app: 'foundation-app';\n debug: true;\n }"
17057
- },
17058
- {
17059
- "kind": "Content",
17060
- "text": ");"
17061
- }
17062
- ],
17063
- "releaseTag": "Public",
17064
- "isProtected": false,
17065
- "overloadIndex": 1,
17066
- "parameters": [
17067
- {
17068
- "parameterName": "config",
17069
- "parameterTypeTokenRange": {
17070
- "startIndex": 1,
17071
- "endIndex": 2
17072
- },
17073
- "isOptional": false
17074
- }
17075
- ]
17076
- },
17077
17045
  {
17078
17046
  "kind": "Method",
17079
17047
  "canonicalReference": "@genesislcap/foundation-comms!DefaultFoundationAnalytics#trackEvent:member(1)",
17080
- "docComment": "/**\n * Set typed overloads\n */\n",
17048
+ "docComment": "",
17081
17049
  "excerptTokens": [
17082
17050
  {
17083
17051
  "kind": "Content",
package/dist/foundation-comms.d.ts CHANGED
@@ -2087,23 +2087,16 @@ export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatas
2087
2087
  }
2088
2088
 
2089
2089
  /**
2090
- * The default implementation for the FoundationAnalytics interface.
2090
+ * The default no-op implementation for the FoundationAnalytics interface.
2091
+ *
2092
+ * @remarks
2093
+ * The `analytics` npm package (v0.8.16) was removed after a security scan flagged its transitive
2094
+ * for using `window.location.search.substring(1)` - no upstream fix is available.
2095
+ * Replace this no-op when analytics tracking is needed.
2096
+ *
2091
2097
  * @public
2092
2098
  */
2093
2099
  export declare class DefaultFoundationAnalytics implements FoundationAnalytics {
2094
- private analytics;
2095
- /**
2096
- * TODO: Remove the static config.
2097
- * We could register a config with the container at startup and have it injected here or remove the constructor and
2098
- * define a method call.
2099
- */
2100
- constructor(config: {
2101
- app: 'foundation-app';
2102
- debug: true;
2103
- });
2104
- /**
2105
- * Set typed overloads
2106
- */
2107
2100
  trackEvent(eventName: FoundationAnalyticsEventType.controlClicked, payload: FoundationAnalyticsEvent.ControlClicked): void;
2108
2101
  trackEvent(eventName: FoundationAnalyticsEventType.routeChanged, payload: FoundationAnalyticsEvent.RouteChanged): void;
2109
2102
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.427.1-TAM-8.26-patch.1",
4
+ "version": "14.427.1-TAM.8.26-patch.2",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -77,27 +77,26 @@
77
77
  }
78
78
  },
79
79
  "devDependencies": {
80
- "@genesislcap/foundation-testing": "14.427.1-TAM-8.26-patch.1",
81
- "@genesislcap/genx": "14.427.1-TAM-8.26-patch.1",
82
- "@genesislcap/rollup-builder": "14.427.1-TAM-8.26-patch.1",
83
- "@genesislcap/ts-builder": "14.427.1-TAM-8.26-patch.1",
84
- "@genesislcap/uvu-playwright-builder": "14.427.1-TAM-8.26-patch.1",
85
- "@genesislcap/vite-builder": "14.427.1-TAM-8.26-patch.1",
86
- "@genesislcap/webpack-builder": "14.427.1-TAM-8.26-patch.1",
80
+ "@genesislcap/foundation-testing": "14.427.1-TAM.8.26-patch.2",
81
+ "@genesislcap/genx": "14.427.1-TAM.8.26-patch.2",
82
+ "@genesislcap/rollup-builder": "14.427.1-TAM.8.26-patch.2",
83
+ "@genesislcap/ts-builder": "14.427.1-TAM.8.26-patch.2",
84
+ "@genesislcap/uvu-playwright-builder": "14.427.1-TAM.8.26-patch.2",
85
+ "@genesislcap/vite-builder": "14.427.1-TAM.8.26-patch.2",
86
+ "@genesislcap/webpack-builder": "14.427.1-TAM.8.26-patch.2",
87
87
  "@types/js-cookie": "^3.0.2",
88
88
  "@types/json-schema": "^7.0.11",
89
89
  "@types/webappsec-credential-management": "^0.6.2",
90
90
  "sinon": "^17.0.1"
91
91
  },
92
92
  "dependencies": {
93
- "@genesislcap/foundation-broadcast-channel": "14.427.1-TAM-8.26-patch.1",
94
- "@genesislcap/foundation-logger": "14.427.1-TAM-8.26-patch.1",
95
- "@genesislcap/foundation-user": "14.427.1-TAM-8.26-patch.1",
96
- "@genesislcap/foundation-utils": "14.427.1-TAM-8.26-patch.1",
97
- "@genesislcap/web-core": "14.427.1-TAM-8.26-patch.1",
93
+ "@genesislcap/foundation-broadcast-channel": "14.427.1-TAM.8.26-patch.2",
94
+ "@genesislcap/foundation-logger": "14.427.1-TAM.8.26-patch.2",
95
+ "@genesislcap/foundation-user": "14.427.1-TAM.8.26-patch.2",
96
+ "@genesislcap/foundation-utils": "14.427.1-TAM.8.26-patch.2",
97
+ "@genesislcap/web-core": "14.427.1-TAM.8.26-patch.2",
98
98
  "@microsoft/fast-element": "1.14.0",
99
99
  "@microsoft/fast-foundation": "2.50.0",
100
- "analytics": "0.8.16",
101
100
  "bowser": "^2.11.0",
102
101
  "fast-safe-stringify": "^2.1.1",
103
102
  "http-status-codes": "^2.2.0",
@@ -113,5 +112,5 @@
113
112
  "publishConfig": {
114
113
  "access": "public"
115
114
  },
116
- "gitHead": "472a351543832bd7e1e7999f04360a134f50a92f"
115
+ "gitHead": "ae3baedb34d945eeeeeb0e83d2911897e05da0bc"
117
116
  }