@dynatrace-sdk/user-preferences - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

CHANGELOG.md

@@ -5,2 +5,8 @@ # User Preferences
 
+## 1.1.0
+
+### Minor Changes
+
+- Add getTimezone method to retrieve the user preferred timezone
+
 ## 1.0.1
@@ -7,0 +13,0 @@

cjs/index.js

@@ -40,3 +40,4 @@ /**
   getRegionalFormat: () => getRegionalFormat,
-  getTheme: () => getTheme
+  getTheme: () => getTheme,
+  getTimezone: () => getTimezone
 });
@@ -80,1 +81,12 @@ module.exports = __toCommonJS(src_exports);
 }
+
+// packages/platform/user-preferences/src/lib/get-timezone.ts
+function getTimezone() {
+  const runtimeFunc = getGlobalWithDtRuntime().dtRuntime?.userPreferences?.getTimezone;
+  if (typeof runtimeFunc === "function") {
+    return runtimeFunc();
+  } else {
+    console.warn("Missing getTimezone function from sdk-web-runtime.");
+    return "UTC";
+  }
+}

docs/DOCS.md

@@ -20,3 +20,3 @@ ---
   <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/user-preferences/v/1.0.1">v1.0.1</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/user-preferences/v/1.1.0">v1.1.0</a>
   </div>
@@ -87,1 +87,22 @@ </div>
 </div>
+
+### getTimezone
+
+<div class="padding-bottom--md">
+<strong>getTimezone(): <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a></strong>
+
+<div class="padding-left--md">
+
+Retrieves the user preferred timezone.
+
+Timezone can be either in ISO 8601 or tz database format.
+
+</div>
+
+<!-- no parameters -->
+
+#### Returns
+
+timezone defined in user preferences.
+
+</div>

esm/index.js

@@ -52,6 +52,18 @@ /**
 }
+
+// packages/platform/user-preferences/src/lib/get-timezone.ts
+function getTimezone() {
+  const runtimeFunc = getGlobalWithDtRuntime().dtRuntime?.userPreferences?.getTimezone;
+  if (typeof runtimeFunc === "function") {
+    return runtimeFunc();
+  } else {
+    console.warn("Missing getTimezone function from sdk-web-runtime.");
+    return "UTC";
+  }
+}
 export {
   getLanguage,
   getRegionalFormat,
-  getTheme
+  getTheme,
+  getTimezone
 };

package.json

 {
   "name": "@dynatrace-sdk/user-preferences",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Obtain the currently logged-in user preferences, like theme or language.",
@@ -5,0 +5,0 @@ "homepage": "https://developer.dynatrace.com/reference/sdks/user-preferences/",

testing/cjs/index.js

@@ -50,3 +50,4 @@ /**
   getTheme: () => currentSetup.getTheme(),
-  getRegionalFormat: () => currentSetup.getRegionalFormat()
+  getRegionalFormat: () => currentSetup.getRegionalFormat(),
+  getTimezone: () => currentSetup.getTimezone()
 };
@@ -78,2 +79,3 @@ var setupTestingEnv = () => {
   legacyDtSdk.dtSdk.getTheme = wrapper.getTheme;
+  legacyDtSdk.dtSdk.getTimezone = wrapper.getTimezone;
   currentSetup = getSetupWithDefaults(setup);
@@ -88,3 +90,4 @@ };
     getLanguage: setup.getLanguage || (() => "en"),
-    getRegionalFormat: setup.getRegionalFormat || (() => "en")
+    getRegionalFormat: setup.getRegionalFormat || (() => "en"),
+    getTimezone: setup.getTimezone || (() => "UTC")
   };
@@ -91,0 +94,0 @@ };

testing/esm/index.js

@@ -23,3 +23,4 @@ /**
   getTheme: () => currentSetup.getTheme(),
-  getRegionalFormat: () => currentSetup.getRegionalFormat()
+  getRegionalFormat: () => currentSetup.getRegionalFormat(),
+  getTimezone: () => currentSetup.getTimezone()
 };
@@ -51,2 +52,3 @@ var setupTestingEnv = () => {
   legacyDtSdk.dtSdk.getTheme = wrapper.getTheme;
+  legacyDtSdk.dtSdk.getTimezone = wrapper.getTimezone;
   currentSetup = getSetupWithDefaults(setup);
@@ -61,3 +63,4 @@ };
     getLanguage: setup.getLanguage || (() => "en"),
-    getRegionalFormat: setup.getRegionalFormat || (() => "en")
+    getRegionalFormat: setup.getRegionalFormat || (() => "en"),
+    getTimezone: setup.getTimezone || (() => "UTC")
   };
@@ -64,0 +67,0 @@ };

testing/types/packages/platform/user-preferences/testing/test-utils.d.ts

@@ -5,2 +5,3 @@ declare const wrapper: {
     getRegionalFormat: () => string;
+    getTimezone: () => string;
 };
@@ -7,0 +8,0 @@ export declare const setupTestingEnv: () => void;

types/packages/platform/user-preferences/src/index.d.ts

 export * from './lib/get-theme';
 export * from './lib/get-language';
 export * from './lib/get-regional-format';
+export * from './lib/get-timezone';
 export * from './lib/types/theme-type';
 export * from './lib/types/dt-runtime-user-preferences';

types/packages/platform/user-preferences/src/lib/types/dt-runtime-user-preferences.d.ts

@@ -7,2 +7,3 @@ import { ThemeType } from './theme-type';
     getRegionalFormat(): string;
+    getTimezone(): string;
 }

No alert changes

Improved metrics

Total package byte prevSize

28123

increased by7.1%

Number of package files

24

increased by4.35%

Lines of code

380

increased by11.44%

No dependency changes