@ampless/plugin-analytics-ga4 0.1.1-alpha.0 → 0.2.0-alpha.2

package/dist/index.d.ts

@@ -2,13 +2,19 @@ import { AmplessPlugin } from 'ampless';
 
 interface AnalyticsGa4Options {
     /**
-     * Google Analytics 4 measurement ID, e.g. `"G-XXXXXXXX"`. An empty
-     * string disables the plugin (descriptors return `[]`), which is
-     * the recommended way to keep the dependency wired up while
-     * temporarily turning analytics off — for example in staging or
-     * before consent is granted.
+     * Optional fallback Google Analytics 4 measurement ID, e.g.
+     * `"G-XXXXXXXX"`. Used only when no admin-stored value exists in
+     * `pk='siteconfig', sk='plugins.<instanceId>.measurementId'`. An
+     * empty string disables the plugin (descriptors return `[]`),
+     * which is the recommended way to keep the dependency wired up
+     * while temporarily turning analytics off — for example in
+     * staging or before consent is granted.
+     *
+     * The constructor argument will be removed in Phase 3. New
+     * deployments should leave it empty and configure the value from
+     * the admin UI.
      */
-    measurementId: string;
+    measurementId?: string;
     /**
      * Optional namespace for this instance. Defaults to
      * `'analytics-ga4'`. Set distinct values when registering the
@@ -23,6 +29,6 @@ interface AnalyticsGa4Options {
  * it does not need any AWS data permissions because everything
  * happens inside the public Next.js process at render time.
  */
-declare function analyticsGa4Plugin(options: AnalyticsGa4Options): AmplessPlugin;
+declare function analyticsGa4Plugin(options?: AnalyticsGa4Options): AmplessPlugin;
 
 export { type AnalyticsGa4Options, analyticsGa4Plugin as default };

package/dist/index.js

@@ -1,22 +1,46 @@
 // src/index.ts
 import { definePlugin } from "ampless";
-function analyticsGa4Plugin(options) {
-  const { measurementId, instanceId = "analytics-ga4" } = options;
+function analyticsGa4Plugin(options = {}) {
+  const { measurementId = "", instanceId = "analytics-ga4" } = options;
   return definePlugin({
     name: "analytics-ga4",
     instanceId,
     displayName: { en: "Google Analytics 4", ja: "Google Analytics 4" },
     apiVersion: 1,
     trust_level: "untrusted",
-    capabilities: ["publicHead"],
-    publicHead() {
-      if (!measurementId) return [];
+    capabilities: ["publicHead", "adminSettings"],
+    settings: {
+      public: [
+        {
+          type: "text",
+          key: "measurementId",
+          label: {
+            en: "Measurement ID",
+            ja: "\u6E2C\u5B9A ID"
+          },
+          description: {
+            en: "GA4 measurement ID (e.g. G-XXXXXXXX). Leave blank to disable the plugin without removing it from cms.config.",
+            ja: "GA4 \u306E\u6E2C\u5B9A ID (\u4F8B: G-XXXXXXXX)\u3002\u7A7A\u306B\u3059\u308B\u3068 cms.config \u304B\u3089\u524A\u9664\u305B\u305A\u306B\u30D7\u30E9\u30B0\u30A4\u30F3\u3092\u7121\u52B9\u5316\u3067\u304D\u307E\u3059\u3002"
+          },
+          // Accept either empty (disable) or a well-formed GA4
+          // measurement id. The runtime's `publicHead` reads the
+          // resolved value through ctx.setting and skips emitting
+          // descriptors when it's empty.
+          pattern: "^$|^G-[A-Z0-9]+$",
+          placeholder: "G-XXXXXXXX",
+          default: measurementId
+        }
+      ]
+    },
+    publicHead(ctx) {
+      const id = (ctx.setting("measurementId") ?? "").trim();
+      if (!id) return [];
       return [
         {
           type: "script",
           id: `ga4-loader-${instanceId}`,
           src: `https://www.googletagmanager.com/gtag/js?id=${encodeURIComponent(
-            measurementId
+            id
           )}`,
           strategy: "afterInteractive"
         },
@@ -32,7 +56,7 @@ function analyticsGa4Plugin(options) {
             "window.dataLayer = window.dataLayer || [];",
             "function gtag(){dataLayer.push(arguments);}",
             "gtag('js', new Date());",
-            `gtag('config', ${JSON.stringify(measurementId)});`
+            `gtag('config', ${JSON.stringify(id)});`
           ].join("\n")
         }
       ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampless/plugin-analytics-ga4",
-  "version": "0.1.1-alpha.0",
+  "version": "0.2.0-alpha.2",
   "description": "Google Analytics 4 plugin for ampless",
   "license": "MIT",
   "type": "module",
@@ -25,7 +25,7 @@
   "homepage": "https://github.com/heavymoons/ampless/tree/main/packages/plugin-analytics-ga4#readme",
   "bugs": "https://github.com/heavymoons/ampless/issues",
   "dependencies": {
-    "ampless": "1.0.0-alpha.17"
+    "ampless": "1.0.0-alpha.19"
   },
   "keywords": [
     "ampless",