Skip to content

Commit 1f114a1

Browse files
authored
fix: type issues (#1663)
* fix: update consent management options types to make all fields optional * fix: update rudderanalytics type * fix: preloaded types * fix: type cast * fix: types for loading script module
1 parent 094ee96 commit 1f114a1

File tree

10 files changed

+14
-33
lines changed

10 files changed

+14
-33
lines changed

packages/analytics-js-common/src/types/Consent.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ export type ConsentResolutionStrategy = 'and' | 'or';
3131
export type Consents = string[];
3232

3333
export type ConsentManagementOptions = {
34-
enabled: boolean;
35-
provider: ConsentManagementProvider;
34+
enabled?: boolean;
35+
provider?: ConsentManagementProvider;
3636
allowedConsentIds?: Consents;
3737
deniedConsentIds?: Consents;
3838
};

packages/analytics-js-common/types/rudderanalytics.d.ts

-16
This file was deleted.

packages/analytics-js/src/app/RudderAnalytics.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
139139
*/
140140
triggerBufferedLoadEvent() {
141141
const preloadedEventsArray = Array.isArray((globalThis as typeof window).rudderanalytics)
142-
? ((globalThis as typeof window).rudderanalytics as PreloadedEventCall[])
142+
? ((globalThis as typeof window).rudderanalytics as unknown as PreloadedEventCall[])
143143
: ([] as PreloadedEventCall[]);
144144

145145
// The array will be mutated in the below method
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export type PreloadedEventCall = Array<string | any>;
22

33
export type RudderAnalyticsPreloader = {
4-
[index: string]: (...args: number[]) => any;
4+
[index: string]: (...args: any[]) => any;
55
};

packages/analytics-js/src/components/utilities/consent.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ const getConsentManagerInfo = (
9898
consentManagementOpts: ConsentManagementOptions,
9999
logger?: ILogger,
100100
) => {
101-
let { provider }: { provider: ConsentManagementProvider | undefined } = consentManagementOpts;
102-
const consentManagerPluginName = ConsentManagersToPluginNameMap[provider];
101+
let { provider }: { provider?: ConsentManagementProvider } = consentManagementOpts;
102+
const consentManagerPluginName = provider ? ConsentManagersToPluginNameMap[provider] : undefined;
103103
if (provider && !consentManagerPluginName) {
104104
logger?.error(
105105
UNSUPPORTED_CONSENT_MANAGER_ERROR(CONFIG_MANAGER, provider, ConsentManagersToPluginNameMap),

packages/analytics-js/src/index.ts

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
import type { RudderAnalytics } from './app/RudderAnalytics';
2-
import type {
3-
PreloadedEventCall,
4-
RudderAnalyticsPreloader,
5-
} from './components/preloadBuffer/types';
2+
import type { RudderAnalyticsPreloader } from './components/preloadBuffer/types';
63
import type { IRudderStackGlobals } from './app/IRudderStackGlobals';
74

85
export {
@@ -26,13 +23,13 @@ export { type IdentifyTraits } from '@rudderstack/analytics-js-common/types/trai
2623
export { RudderAnalytics } from './app/RudderAnalytics';
2724
export { type IRudderStackGlobals } from './app/IRudderStackGlobals';
2825
export {
29-
type PreloadedEventCall,
3026
type RudderAnalyticsPreloader,
27+
type PreloadedEventCall,
3128
} from './components/preloadBuffer/types';
3229

3330
declare global {
3431
interface Window {
35-
rudderanalytics: RudderAnalytics | PreloadedEventCall[] | RudderAnalyticsPreloader;
32+
rudderanalytics: RudderAnalytics | RudderAnalyticsPreloader | undefined;
3633
RudderStackGlobals: IRudderStackGlobals;
3734
rudderAnalyticsMount: () => void;
3835
rudderAnalyticsBuildType: 'legacy' | 'modern';

packages/analytics-js/src/types/rudderanalytics.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type {
77

88
declare global {
99
interface Window {
10-
rudderanalytics: RudderAnalytics | PreloadedEventCall[] | RudderAnalyticsPreloader;
10+
rudderanalytics: RudderAnalytics | RudderAnalyticsPreloader | undefined;
1111
RudderStackGlobals: IRudderStackGlobals;
1212
rudderAnalyticsMount: () => void;
1313
rudderAnalyticsBuildType: 'legacy' | 'modern';

packages/loading-scripts/src/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const sdkName = 'rsa.min.js';
1818
const asyncScript = true;
1919
window.rudderAnalyticsBuildType = 'legacy';
2020

21-
window.rudderanalytics = [];
21+
(window.rudderanalytics as unknown as PreloadedEventCall[]) = [];
2222
const methods: string[] = [
2323
'setDefaultInstanceKey',
2424
'load',
@@ -39,7 +39,7 @@ for (let i = 0; i < methods.length; i++) {
3939
const method = methods[i] as string;
4040
(window.rudderanalytics as unknown as RudderAnalyticsPreloader)[method] = (methodName =>
4141
function () {
42-
(window.rudderanalytics as PreloadedEventCall[]).push(
42+
(window.rudderanalytics as unknown as PreloadedEventCall[]).push(
4343
[methodName].concat(Array.prototype.slice.call(arguments) as PreloadedEventCall),
4444
);
4545
})(method);

packages/loading-scripts/src/types/rudderanalytics.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type {
77

88
declare global {
99
interface Window {
10-
rudderanalytics: RudderAnalytics | PreloadedEventCall[] | RudderAnalyticsPreloader;
10+
rudderanalytics: RudderAnalytics | RudderAnalyticsPreloader | undefined;
1111
RudderStackGlobals: IRudderStackGlobals;
1212
rudderAnalyticsMount: () => void;
1313
rudderAnalyticsBuildType: 'legacy' | 'modern';

packages/sanity-suite/src/types/rudderanalytics.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import type {
77

88
declare global {
99
interface Window {
10-
rudderanalytics: RudderAnalytics | PreloadedEventCall[] | RudderAnalyticsPreloader;
10+
rudderanalytics: RudderAnalytics | RudderAnalyticsPreloader | undefined;
1111
RudderStackGlobals: IRudderStackGlobals;
1212
rudderAnalyticsMount: () => void;
1313
rudderAnalyticsBuildType: 'legacy' | 'modern';

0 commit comments

Comments
 (0)