@webiny/global-config 0.0.0-unstable.eb196ccd2f → 0.0.0-unstable.eb81deee7e

package/README.md

@@ -1 +1,11 @@
 # @webiny/global-config
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/index.d.ts

@@ -1,4 +1,10 @@
 export interface GlobalConfig {
+    /**
+     * Returns the whole config, creating it with defaults if it is missing or
+     * has no `id`. `isEnabled()` in @webiny/telemetry already calls it this way;
+     * the overload was just missing from these types.
+     */
+    get(): Record<string, any>;
     get(key: string): any;
     set(key: string, value: any): void;
 }

package/index.js

@@ -1,33 +1,48 @@
-const os = require("os");
-const path = require("path");
-const { v4: uuidv4 } = require("uuid");
-const readJson = require("load-json-file");
-const writeJson = require("write-json-file");
+import os from "os";
+import path from "path";
+import { randomUUID } from "crypto";
+import { loadJsonFileSync } from "load-json-file";
+import { writeJsonFileSync } from "write-json-file";
+import { isCI } from "ci-info";
 
 const GLOBAL_CONFIG_PATH = path.join(os.homedir(), ".webiny", "config");
 
-module.exports.globalConfig = {
+export const globalConfig = {
     __globalConfig: null,
     get(key) {
         try {
             if (!this.__globalConfig) {
-                this.__globalConfig = readJson.sync(GLOBAL_CONFIG_PATH);
+                this.__globalConfig = loadJsonFileSync(GLOBAL_CONFIG_PATH);
                 if (!this.__globalConfig.id) {
                     throw Error("Invalid Webiny config!");
                 }
             }
-        } catch (e) {
+        } catch {
             // A new config file is written if it doesn't exist or is invalid.
             this.__globalConfig = {
-                id: uuidv4(),
+                // Node's own v4 UUID. This used to come from `@webiny/stdlib`, whose root entry is
+                // about 30 modules, loaded on every CLI command just to generate this one ID.
+                id: randomUUID(),
                 telemetry: true,
 
                 // This flag is set to `false` the moment user successfully
                 // deploys a Webiny project for the first time. Once they do,
                 // they're considered no longer a "new user".
-                newUser: true
+                // Also, in CI environments, we always set this to `false`.
+                newUser: isCI ? false : true
             };
-            writeJson.sync(GLOBAL_CONFIG_PATH, this.__globalConfig);
+            writeJsonFileSync(GLOBAL_CONFIG_PATH, this.__globalConfig);
+        }
+
+        // Backfill `newUser` on configs that predate it, or that were written by something
+        // that didn't set it. Absent is not the same as `false`: the only thing that writes
+        // `false` is the first successful deploy, so a missing key means that never happened
+        // and the user is still new. Reading it as `Boolean(undefined)` reported every one of
+        // them as returning. Persisted so the state stops being ambiguous, and so every reader
+        // agrees without repeating this rule.
+        if (!("newUser" in this.__globalConfig)) {
+            this.__globalConfig.newUser = isCI ? false : true;
+            writeJsonFileSync(GLOBAL_CONFIG_PATH, this.__globalConfig);
         }
 
         return key ? this.__globalConfig[key] : this.__globalConfig;
@@ -35,7 +50,7 @@ module.exports.globalConfig = {
     set(key, value) {
         const globalConfig = this.get();
         globalConfig[key] = value;
-        writeJson.sync(GLOBAL_CONFIG_PATH, globalConfig);
+        writeJsonFileSync(GLOBAL_CONFIG_PATH, globalConfig);
         return globalConfig;
     }
 };

package/package.json

@@ -1,16 +1,18 @@
 {
 	"name": "@webiny/global-config",
-	"version": "0.0.0-unstable.eb196ccd2f",
-	"main": "index.js",
+	"version": "0.0.0-unstable.eb81deee7e",
+	"type": "module",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
 	"license": "MIT",
 	"dependencies": {
-		"load-json-file": "6.2.0",
-		"uuid": "9.0.1",
-		"write-json-file": "4.3.0"
+		"ci-info": "4.4.0",
+		"load-json-file": "7.0.1",
+		"write-json-file": "7.0.0"
 	},
 	"publishConfig": {
-		"access": "public",
-		"directory": "."
-	},
-	"gitHead": "eb196ccd2f32296e10f7add6dd7220d4e3abece4"
+		"access": "public"
+	}
 }