@particle-academy/google-analytics-ui 0.1.0 → 0.3.0
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.
- package/CHANGELOG.md +61 -0
- package/README.md +52 -0
- package/dist/index.cjs +1 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,65 @@ The four packages share one version, because they are generated from one
|
|
|
8
8
|
`provider/` definition and a version that meant something different in each
|
|
9
9
|
would be a version nobody could reason about.
|
|
10
10
|
|
|
11
|
+
## [0.3.0] — 2026-08-24
|
|
12
|
+
|
|
13
|
+
### Added
|
|
14
|
+
|
|
15
|
+
- **The README now says how to SET THIS CONNECTOR UP**, in the package itself.
|
|
16
|
+
|
|
17
|
+
Until now it explained what the four packages are, what they cost and why the
|
|
18
|
+
repo is generated — and said nothing about credentials, scopes, sandboxes or
|
|
19
|
+
operations. Somebody who installed it could not learn from it which credentials
|
|
20
|
+
a connection needs, where a human GETS them, which scopes to request, or what
|
|
21
|
+
the connector can actually do. All of that was already in the definition; the
|
|
22
|
+
one document a consumer reads was the one that omitted everything actionable.
|
|
23
|
+
|
|
24
|
+
The new **Setting it up** section carries:
|
|
25
|
+
|
|
26
|
+
- every credential, with the text saying where the value comes from, whether it
|
|
27
|
+
is **per installation** or **per connected account**, and whether it is secret;
|
|
28
|
+
- the OAuth authorize and token URLs and the exact scopes, verbatim;
|
|
29
|
+
- the access-token lifetime, and where refresh tokens ROTATE, the two things a
|
|
30
|
+
host must not do — retry a failed refresh, or refresh concurrently — because a
|
|
31
|
+
replay revokes the entire grant and nothing in the failure says why;
|
|
32
|
+
- the estate in this provider's own terms, including the cases where a
|
|
33
|
+
successful-looking run reaches nobody, or reaches the real one;
|
|
34
|
+
- every action and trigger with its method, path, inputs, and whether it is safe
|
|
35
|
+
to replay;
|
|
36
|
+
- a trigger's provider-side setup, which nobody can derive from anything else.
|
|
37
|
+
|
|
38
|
+
It is **generated from `provider/manifest.json`**, so it cannot drift from what
|
|
39
|
+
the packages do — which is the point at a few hundred providers, where a
|
|
40
|
+
hand-written setup section is a few hundred documents going quietly stale.
|
|
41
|
+
|
|
42
|
+
No code changed. This release exists because a registry and an installing agent
|
|
43
|
+
read the PUBLISHED artifact, and the artifact carried the old README.
|
|
44
|
+
|
|
45
|
+
## [0.2.0] — 2026-08-24
|
|
46
|
+
|
|
47
|
+
### Changed
|
|
48
|
+
|
|
49
|
+
- **`@particle-academy/google-analytics-ui` is now an OPTIONAL PEER dependency of `@particle-academy/google-analytics-js`, not a hard one.**
|
|
50
|
+
|
|
51
|
+
`./flow` needs it; nothing else does. It was a hard dependency, and because
|
|
52
|
+
`@particle-academy/google-analytics-ui` itself peer-depends on `fancy-flow` — which npm 7+ installs
|
|
53
|
+
automatically — `npm install @particle-academy/google-analytics-js` pulled the **entire flow engine**
|
|
54
|
+
onto disk for a consumer who only wanted to call the API. Roughly **18 MB
|
|
55
|
+
became 874 KB**, and the package works exactly as before:
|
|
56
|
+
|
|
57
|
+
```js
|
|
58
|
+
import { googleAnalytics… } from "@particle-academy/google-analytics-js";
|
|
59
|
+
// an injected transport, no flow engine anywhere
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
**This is breaking if you use `@particle-academy/google-analytics-js/flow`.** Add `@particle-academy/google-analytics-ui` to your own
|
|
63
|
+
dependencies — it was always being installed for you, and now it is declared.
|
|
64
|
+
Everything importing only the main entry point is unaffected.
|
|
65
|
+
|
|
66
|
+
The fix is on this edge rather than on `@particle-academy/google-analytics-ui` → `fancy-flow`: the ui package
|
|
67
|
+
genuinely requires fancy-flow, since it calls `defineConnectorKind`, and marking
|
|
68
|
+
that peer optional would be a lie about what it needs.
|
|
69
|
+
|
|
11
70
|
## [0.1.0] — 2026-08-23
|
|
12
71
|
|
|
13
72
|
First release.
|
|
@@ -56,3 +115,5 @@ so, because a fixture that emitted numbers would let an author write arithmetic
|
|
|
56
115
|
that works against the fake and concatenates against the real thing.
|
|
57
116
|
|
|
58
117
|
[0.1.0]: https://github.com/Fancy-Friends/google-analytics/releases/tag/v0.1.0
|
|
118
|
+
[0.2.0]: https://github.com/Fancy-Friends/google-analytics/releases/tag/v0.2.0
|
|
119
|
+
[0.3.0]: https://github.com/Fancy-Friends/google-analytics/releases/tag/v0.3.0
|
package/README.md
CHANGED
|
@@ -27,6 +27,58 @@ dependencies.
|
|
|
27
27
|
subject to the kit's full approval bar, and one per provider is hundreds of
|
|
28
28
|
dependencies nobody is tracking.
|
|
29
29
|
|
|
30
|
+
## Setting it up
|
|
31
|
+
|
|
32
|
+
Everything below is generated from `provider/manifest.json`, so it cannot disagree with what the packages do.
|
|
33
|
+
|
|
34
|
+
### Credentials
|
|
35
|
+
|
|
36
|
+
A Google Analytics connection holds 4 values.
|
|
37
|
+
|
|
38
|
+
**Two kinds of value, and mixing them up matters.** A `provider` credential is ONE value for the whole installation — an OAuth app's client secret serves every connected account. An `account` credential is one per connected account. A host that stores the second where it stores the first lets one account's credentials reach another's.
|
|
39
|
+
|
|
40
|
+
| Field | Scope | Secret | Where it comes from |
|
|
41
|
+
|---|---|---|---|
|
|
42
|
+
| **OAuth client ID** | per installation | not secret | From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account. |
|
|
43
|
+
| **OAuth client secret** | per installation | **secret** | The client secret for the same OAuth app. One value for the whole installation. |
|
|
44
|
+
| **Access token** | per connected account | **secret** | Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token. |
|
|
45
|
+
| **Refresh token** | per connected account | **secret** | Per connected Google account. Google issues one only when the consent request asks for offline access. |
|
|
46
|
+
|
|
47
|
+
### Authorising
|
|
48
|
+
|
|
49
|
+
Google Analytics uses OAuth2 (authorization_code). The package DECLARES the exchange; the HOST performs it — a consent screen needs a browser, a redirect URI and somewhere to persist the result, and all three belong to the host.
|
|
50
|
+
|
|
51
|
+
- **Authorize URL** — https://accounts.google.com/o/oauth2/v2/auth
|
|
52
|
+
- **Token URL** — https://oauth2.googleapis.com/token
|
|
53
|
+
- **Scopes** — `https://www.googleapis.com/auth/analytics.readonly`
|
|
54
|
+
- **Access token lifetime** — 3600 seconds (1 hours). A host that never refreshes works all afternoon and is broken by morning.
|
|
55
|
+
|
|
56
|
+
The refresh tokens do **not** rotate: the same one is reusable, so a refresh may safely be retried and may run concurrently. Stated rather than assumed, because the opposite — a provider that spends the token and revokes the grant on a replay — looks identical until it happens.
|
|
57
|
+
|
|
58
|
+
### The estate
|
|
59
|
+
|
|
60
|
+
**Google Analytics has no test estate, and somebody checked.** Everything this connector does is real. Use the faker to build against it.
|
|
61
|
+
|
|
62
|
+
> Google Analytics has no sandbox. A report reads a real property's real data and spends real quota. The faker returns a plausibly-shaped report so a flow can be built without a Google account.
|
|
63
|
+
|
|
64
|
+
## What it can do
|
|
65
|
+
|
|
66
|
+
### Actions
|
|
67
|
+
|
|
68
|
+
#### `report_run` — Google Analytics report
|
|
69
|
+
|
|
70
|
+
Run a report against a Google Analytics 4 property.
|
|
71
|
+
|
|
72
|
+
`POST /v1beta/{+property}:runReport` · reads only — safe to replay
|
|
73
|
+
|
|
74
|
+
| Input | Required | What it is |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| `property` | yes | The GA4 property, written as `properties/1234567890`. The numeric id alone is not accepted. |
|
|
77
|
+
| `startDate` | yes | YYYY-MM-DD, or a relative form Google accepts such as `28daysAgo`, `yesterday` or `today`. |
|
|
78
|
+
| `endDate` | yes | YYYY-MM-DD, or a relative form such as `today`. |
|
|
79
|
+
| `metrics` | yes | Metric names, comma separated. For example activeUsers, sessions, screenPageViews. |
|
|
80
|
+
| `dimensions` | no | Dimension names, comma separated. For example date, country, pagePath. Leave empty for a single total row. |
|
|
81
|
+
|
|
30
82
|
## Run it before you have credentials
|
|
31
83
|
|
|
32
84
|
Every operation ships a **faker**, whether or not Google Analytics has a sandbox. Set a
|
package/dist/index.cjs
CHANGED
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/service.ts","../src/kinds/report-run.ts","../src/index.ts"],"names":["defineConnectorKind","summarize"],"mappings":";;;;;AAkCO,IAAM,qBAAA,GAAwB;AAG9B,IAAM,wBAAA,GAA2B;AAAA,EACtC,OAAA,EAAS,kBAAA;AAAA,EACT,YAAA,EAAc,kBAAA;AAAA,EACd,MAAA,EAAQ,WAAA;AAAA,EACR,OAAA,EAAS;AACX;AAGO,IAAM,4BAAA,GAA+B;AAAA,EAC1C;AAAA,IACE,KAAA,EAAO,UAAA;AAAA,IACP,OAAA,EAAS,iBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,KAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,qBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,aAAA;AAAA,IACP,OAAA,EAAS,cAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,eAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA;AAEZ;AAeO,IAAM,sBAAA,GAAyB;AAAA,EACpC,MAAA,EAAQ,oBAAA;AAAA,EACR,cAAA,EAAgB,8CAAA;AAAA,EAChB,UAAA,EAAY,qCAAA;AAAA,EACZ,QAAA,EAAU;AAAA,IACR;AAAA,GACF;AAAA,EACA,uBAAA,EAAyB,aAAA;AAAA,EACzB,wBAAA,EAA0B,cAAA;AAAA,EAC1B,uBAAA,EAAyB;AAC3B;AAGO,SAAS,mBAAA,CACd,IAAA,EACA,SAAA,EACA,IAAA,EACe;AACf,EAAA,OAAO,EAAE,GAAG,wBAAA,EAA0B,IAAA,EAAM,WAAW,IAAA,EAAK;AAC9D;ACtFO,IAAM,4BAAA,GAA+B;AACrC,IAAM,iCAAA,GAAoC;AAE1C,IAAM,4BAAA,GAA+B,mBAAA,CAAoB,QAAA,EAAU,cAAA,EAAgB,sGAAsG;AAUzL,IAAM,8BAAA,GAAgD;AAAA,EAC3D;AAAA,IACE,MAAA,EAAQ,WAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,eAAA;AAAA,IACR,MAAA,EAAQ,QAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,oBAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA;AAEnB;AAEO,IAAM,yBAAA,GAAgDA,+BAAoB,4BAAA,EAA8B;AAAA,EAC7G,IAAA,EAAM,4BAAA;AAAA,EACN,OAAA,EAAS,CAAC,yBAAyB,CAAA;AAAA,EACnC,KAAA,EAAO,yBAAA;AAAA,EACP,WAAA,EAAa,qDAAA;AAAA,EACb,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,MAAM,CAAA;AAAA,EACrB,OAAA,EAAS,CAAC,EAAE,EAAA,EAAI,OAAO,CAAA;AAAA,EACvB,WAAA,EAAa,MAAA;AAAA,EACb,WAAA,EAAa,8BAAA;AAAA,EACb,YAAA,EAAc;AAAA,IACZ;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,UAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,aAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,WAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,WAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,OAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,SAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,sBAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,SAAA,EAAW,MAAA;AAAA,MACX,aAAA,EAAe;AAAA;AACjB,GACF;AAAA,EACA,aAAA,EAAe;AAAA,IACb,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,UAAA,EAAY,CAAC,EAAE,MAAA,OACbC,oBAAA,CAAU,4BAAA,EAA8B,QAAmC,cAAc;AAC7F,CAAC;;;AClFM,IAAM,sBAAA,GAA+C;AAAA,EAC1D;AACF","file":"index.cjs","sourcesContent":["/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's identity on the authoring surface, shared by every Google\n * Analytics node.\n *\n * This file must import nothing from the js package: a PHP or Python project\n * installs the ui package and never that one, and the import would be a\n * dangling module the moment it did.\n *\n * ## The sandbox trap\n *\n * Google Analytics has no sandbox. A report reads a real property's real data\n * and spends real quota. The faker returns a plausibly-shaped report so a flow\n * can be built without a Google account.\n */\n\nimport type { ConnectorMeta } from \"@particle-academy/fancy-flow/connectors\";\n\n/**\n * The connector API version this package was GENERATED against.\n *\n * A literal, never imported — an imported constant lets an upgrade rewrite the\n * very claim it exists to detect.\n */\nexport const CONNECTOR_API_VERSION = 1;\n\n/** The parts of a connector's identity that belong to the SERVICE, not the node. */\nexport const GOOGLE_ANALYTICS_SERVICE = {\n service: \"google_analytics\",\n serviceTitle: \"Google Analytics\",\n domain: \"analytics\",\n sandbox: \"none\",\n} as const satisfies Pick<ConnectorMeta, \"service\" | \"serviceTitle\" | \"domain\" | \"sandbox\">;\n\n/** The credentials a Google Analytics connection holds. */\nexport const GOOGLE_ANALYTICS_CREDENTIALS = [\n {\n \"key\": \"clientId\",\n \"label\": \"OAuth client ID\",\n \"scope\": \"provider\",\n \"secret\": false,\n \"help\": \"From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.\"\n },\n {\n \"key\": \"clientSecret\",\n \"label\": \"OAuth client secret\",\n \"scope\": \"provider\",\n \"secret\": true,\n \"help\": \"The client secret for the same OAuth app. One value for the whole installation.\"\n },\n {\n \"key\": \"accessToken\",\n \"label\": \"Access token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.\"\n },\n {\n \"key\": \"refreshToken\",\n \"label\": \"Refresh token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account. Google issues one only when the consent request asks for offline access.\"\n }\n] as const;\n\n/**\n * The OAuth2 exchange Google Analytics requires — DECLARED here, performed by\n * the host.\n *\n * A consent screen needs a browser, a redirect URI and somewhere to persist\n * the result, and all three belong to the host; a package that ran the dance\n * itself would have to own a web server. So this says precisely enough for a\n * host to do it.\n *\n * The access token lasts 3600 seconds. A host that never refreshes will work\n * all afternoon and be broken by morning, which is why the lifetime is stated\n * rather than left to be discovered.\n */\nexport const GOOGLE_ANALYTICS_OAUTH = {\n \"flow\": \"authorization_code\",\n \"authorizeUrl\": \"https://accounts.google.com/o/oauth2/v2/auth\",\n \"tokenUrl\": \"https://oauth2.googleapis.com/token\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/analytics.readonly\"\n ],\n \"accessTokenCredential\": \"accessToken\",\n \"refreshTokenCredential\": \"refreshToken\",\n \"accessTokenTtlSeconds\": 3600\n} as const;\n\n/** Build a Google Analytics node's connector metadata from the operation it performs. */\nexport function googleAnalyticsMeta(\n role: ConnectorMeta[\"role\"],\n operation: string,\n docs: string,\n): ConnectorMeta {\n return { ...GOOGLE_ANALYTICS_SERVICE, role, operation, docs };\n}\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/actions/report-run.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/actions/report-run.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics report — Run a report against a Google Analytics 4\n * property.\n *\n * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\n */\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { defineConnectorKind, summarize, type OutputField } from \"@particle-academy/fancy-flow/connectors\";\nimport { googleAnalyticsMeta } from \"../service.js\";\n\nexport const GOOGLE_ANALYTICS_REPORT_KIND = \"@particle-academy/google_analytics_report\";\nexport const GOOGLE_ANALYTICS_REPORT_OPERATION = \"report_run\";\n\nexport const GOOGLE_ANALYTICS_REPORT_META = googleAnalyticsMeta(\"action\", \"run a report\", \"https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\");\n\n/**\n * What this node emits — the \"ingredients\" a downstream node can reference.\n *\n * fancy-flow reads `outputShape` off the kind and offers it in the variable\n * picker, so declaring it is the whole of the work: an author configuring the\n * next node picks `{{ $json.data.id }}` off a list instead of typing a path\n * and hoping.\n */\nexport const GOOGLE_ANALYTICS_REPORT_OUTPUT: OutputField[] = [\n {\n \"path\": \"data.rows\",\n \"type\": \"array\",\n \"description\": \"One entry per combination of dimension values. Each carries dimensionValues and metricValues, in the order requested.\"\n },\n {\n \"path\": \"data.rowCount\",\n \"type\": \"number\",\n \"description\": \"Total rows matching the query, which can exceed the rows returned.\"\n },\n {\n \"path\": \"data.metricHeaders\",\n \"type\": \"array\",\n \"description\": \"The metrics in the order their values appear in each row -- the only thing that says which number is which.\"\n }\n];\n\nexport const googleAnalyticsReportKind: NodeKindDefinition = defineConnectorKind(GOOGLE_ANALYTICS_REPORT_META, {\n name: GOOGLE_ANALYTICS_REPORT_KIND,\n aliases: [\"google_analytics_report\"],\n label: \"Google Analytics report\",\n description: \"Run a report against a Google Analytics 4 property.\",\n inputs: [{ id: \"in\" }],\n outputs: [{ id: \"out\" }],\n sideEffects: \"none\",\n outputShape: GOOGLE_ANALYTICS_REPORT_OUTPUT,\n configSchema: [\n {\n \"type\": \"text\",\n \"key\": \"property\",\n \"label\": \"Property\",\n \"required\": true,\n \"default\": \"properties/\",\n \"description\": \"The GA4 property, written as `properties/1234567890`. The numeric id alone is not accepted.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"startDate\",\n \"label\": \"Start date\",\n \"required\": true,\n \"default\": \"28daysAgo\",\n \"description\": \"YYYY-MM-DD, or a relative form Google accepts such as `28daysAgo`, `yesterday` or `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"endDate\",\n \"label\": \"End date\",\n \"required\": true,\n \"default\": \"today\",\n \"description\": \"YYYY-MM-DD, or a relative form such as `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"metrics\",\n \"label\": \"Metrics\",\n \"required\": true,\n \"default\": \"activeUsers,sessions\",\n \"description\": \"Metric names, comma separated. For example activeUsers, sessions, screenPageViews.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"dimensions\",\n \"label\": \"Dimensions\",\n \"default\": \"date\",\n \"description\": \"Dimension names, comma separated. For example date, country, pagePath. Leave empty for a single total row.\"\n }\n ],\n defaultConfig: {\n \"mode\": \"auto\"\n },\n renderBody: ({ config }) =>\n summarize(GOOGLE_ANALYTICS_REPORT_META, config as Record<string, unknown>, \"run a report\"),\n});\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's node kinds for fancy-flow.\n *\n * Install this on every host. The TypeScript executors live in the js\n * package's `./flow` subpath; PHP and Python hosts run their own and need only\n * this.\n */\n\nexport * from \"./service.js\";\nexport * from \"./kinds/report-run.js\";\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { googleAnalyticsReportKind } from \"./kinds/report-run.js\";\n\n/** Every Google Analytics kind, for a host that registers the lot. */\nexport const GOOGLE_ANALYTICS_KINDS: NodeKindDefinition[] = [\n googleAnalyticsReportKind,\n];\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/service.ts","../src/kinds/report-run.ts","../src/index.ts"],"names":["defineConnectorKind","summarize"],"mappings":";;;;;AAkCO,IAAM,qBAAA,GAAwB;AAG9B,IAAM,wBAAA,GAA2B;AAAA,EACtC,OAAA,EAAS,kBAAA;AAAA,EACT,YAAA,EAAc,kBAAA;AAAA,EACd,MAAA,EAAQ,WAAA;AAAA,EACR,OAAA,EAAS;AACX;AAGO,IAAM,4BAAA,GAA+B;AAAA,EAC1C;AAAA,IACE,KAAA,EAAO,UAAA;AAAA,IACP,OAAA,EAAS,iBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,KAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,qBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,aAAA;AAAA,IACP,OAAA,EAAS,cAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,eAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA;AAEZ;AAoBO,IAAM,sBAAA,GAAyB;AAAA,EACpC,MAAA,EAAQ,oBAAA;AAAA,EACR,cAAA,EAAgB,8CAAA;AAAA,EAChB,UAAA,EAAY,qCAAA;AAAA,EACZ,QAAA,EAAU;AAAA,IACR;AAAA,GACF;AAAA,EACA,uBAAA,EAAyB,aAAA;AAAA,EACzB,wBAAA,EAA0B,cAAA;AAAA,EAC1B,qBAAA,EAAuB,KAAA;AAAA,EACvB,uBAAA,EAAyB;AAC3B;AAGO,SAAS,mBAAA,CACd,IAAA,EACA,SAAA,EACA,IAAA,EACe;AACf,EAAA,OAAO,EAAE,GAAG,wBAAA,EAA0B,IAAA,EAAM,WAAW,IAAA,EAAK;AAC9D;AC5FO,IAAM,4BAAA,GAA+B;AACrC,IAAM,iCAAA,GAAoC;AAE1C,IAAM,4BAAA,GAA+B,mBAAA,CAAoB,QAAA,EAAU,cAAA,EAAgB,sGAAsG;AAUzL,IAAM,8BAAA,GAAgD;AAAA,EAC3D;AAAA,IACE,MAAA,EAAQ,WAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,eAAA;AAAA,IACR,MAAA,EAAQ,QAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,oBAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA;AAEnB;AAEO,IAAM,yBAAA,GAAgDA,+BAAoB,4BAAA,EAA8B;AAAA,EAC7G,IAAA,EAAM,4BAAA;AAAA,EACN,OAAA,EAAS,CAAC,yBAAyB,CAAA;AAAA,EACnC,KAAA,EAAO,yBAAA;AAAA,EACP,WAAA,EAAa,qDAAA;AAAA,EACb,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,MAAM,CAAA;AAAA,EACrB,OAAA,EAAS,CAAC,EAAE,EAAA,EAAI,OAAO,CAAA;AAAA,EACvB,WAAA,EAAa,MAAA;AAAA,EACb,WAAA,EAAa,8BAAA;AAAA,EACb,YAAA,EAAc;AAAA,IACZ;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,UAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,aAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,WAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,WAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,OAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,SAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,sBAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,SAAA,EAAW,MAAA;AAAA,MACX,aAAA,EAAe;AAAA;AACjB,GACF;AAAA,EACA,aAAA,EAAe;AAAA,IACb,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,UAAA,EAAY,CAAC,EAAE,MAAA,OACbC,oBAAA,CAAU,4BAAA,EAA8B,QAAmC,cAAc;AAC7F,CAAC;;;AClFM,IAAM,sBAAA,GAA+C;AAAA,EAC1D;AACF","file":"index.cjs","sourcesContent":["/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's identity on the authoring surface, shared by every Google\n * Analytics node.\n *\n * This file must import nothing from the js package: a PHP or Python project\n * installs the ui package and never that one, and the import would be a\n * dangling module the moment it did.\n *\n * ## The sandbox trap\n *\n * Google Analytics has no sandbox. A report reads a real property's real data\n * and spends real quota. The faker returns a plausibly-shaped report so a flow\n * can be built without a Google account.\n */\n\nimport type { ConnectorMeta } from \"@particle-academy/fancy-flow/connectors\";\n\n/**\n * The connector API version this package was GENERATED against.\n *\n * A literal, never imported — an imported constant lets an upgrade rewrite the\n * very claim it exists to detect.\n */\nexport const CONNECTOR_API_VERSION = 1;\n\n/** The parts of a connector's identity that belong to the SERVICE, not the node. */\nexport const GOOGLE_ANALYTICS_SERVICE = {\n service: \"google_analytics\",\n serviceTitle: \"Google Analytics\",\n domain: \"analytics\",\n sandbox: \"none\",\n} as const satisfies Pick<ConnectorMeta, \"service\" | \"serviceTitle\" | \"domain\" | \"sandbox\">;\n\n/** The credentials a Google Analytics connection holds. */\nexport const GOOGLE_ANALYTICS_CREDENTIALS = [\n {\n \"key\": \"clientId\",\n \"label\": \"OAuth client ID\",\n \"scope\": \"provider\",\n \"secret\": false,\n \"help\": \"From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.\"\n },\n {\n \"key\": \"clientSecret\",\n \"label\": \"OAuth client secret\",\n \"scope\": \"provider\",\n \"secret\": true,\n \"help\": \"The client secret for the same OAuth app. One value for the whole installation.\"\n },\n {\n \"key\": \"accessToken\",\n \"label\": \"Access token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.\"\n },\n {\n \"key\": \"refreshToken\",\n \"label\": \"Refresh token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account. Google issues one only when the consent request asks for offline access.\"\n }\n] as const;\n\n/**\n * The OAuth2 exchange Google Analytics requires — DECLARED here, performed by\n * the host.\n *\n * A consent screen needs a browser, a redirect URI and somewhere to persist\n * the result, and all three belong to the host; a package that ran the dance\n * itself would have to own a web server. So this says precisely enough for a\n * host to do it.\n *\n * The access token lasts 3600 seconds. A host that never refreshes will work\n * all afternoon and be broken by morning, which is why the lifetime is stated\n * rather than left to be discovered.\n *\n * Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may\n * safely be retried and may run concurrently. That is stated rather than\n * assumed because the opposite — a provider that spends the token and revokes\n * the grant on a replay — looks identical until it happens.\n */\nexport const GOOGLE_ANALYTICS_OAUTH = {\n \"flow\": \"authorization_code\",\n \"authorizeUrl\": \"https://accounts.google.com/o/oauth2/v2/auth\",\n \"tokenUrl\": \"https://oauth2.googleapis.com/token\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/analytics.readonly\"\n ],\n \"accessTokenCredential\": \"accessToken\",\n \"refreshTokenCredential\": \"refreshToken\",\n \"refreshTokenRotates\": false,\n \"accessTokenTtlSeconds\": 3600\n} as const;\n\n/** Build a Google Analytics node's connector metadata from the operation it performs. */\nexport function googleAnalyticsMeta(\n role: ConnectorMeta[\"role\"],\n operation: string,\n docs: string,\n): ConnectorMeta {\n return { ...GOOGLE_ANALYTICS_SERVICE, role, operation, docs };\n}\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/actions/report-run.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/actions/report-run.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics report — Run a report against a Google Analytics 4\n * property.\n *\n * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\n */\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { defineConnectorKind, summarize, type OutputField } from \"@particle-academy/fancy-flow/connectors\";\nimport { googleAnalyticsMeta } from \"../service.js\";\n\nexport const GOOGLE_ANALYTICS_REPORT_KIND = \"@particle-academy/google_analytics_report\";\nexport const GOOGLE_ANALYTICS_REPORT_OPERATION = \"report_run\";\n\nexport const GOOGLE_ANALYTICS_REPORT_META = googleAnalyticsMeta(\"action\", \"run a report\", \"https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\");\n\n/**\n * What this node emits — the \"ingredients\" a downstream node can reference.\n *\n * fancy-flow reads `outputShape` off the kind and offers it in the variable\n * picker, so declaring it is the whole of the work: an author configuring the\n * next node picks `{{ $json.data.id }}` off a list instead of typing a path\n * and hoping.\n */\nexport const GOOGLE_ANALYTICS_REPORT_OUTPUT: OutputField[] = [\n {\n \"path\": \"data.rows\",\n \"type\": \"array\",\n \"description\": \"One entry per combination of dimension values. Each carries dimensionValues and metricValues, in the order requested.\"\n },\n {\n \"path\": \"data.rowCount\",\n \"type\": \"number\",\n \"description\": \"Total rows matching the query, which can exceed the rows returned.\"\n },\n {\n \"path\": \"data.metricHeaders\",\n \"type\": \"array\",\n \"description\": \"The metrics in the order their values appear in each row -- the only thing that says which number is which.\"\n }\n];\n\nexport const googleAnalyticsReportKind: NodeKindDefinition = defineConnectorKind(GOOGLE_ANALYTICS_REPORT_META, {\n name: GOOGLE_ANALYTICS_REPORT_KIND,\n aliases: [\"google_analytics_report\"],\n label: \"Google Analytics report\",\n description: \"Run a report against a Google Analytics 4 property.\",\n inputs: [{ id: \"in\" }],\n outputs: [{ id: \"out\" }],\n sideEffects: \"none\",\n outputShape: GOOGLE_ANALYTICS_REPORT_OUTPUT,\n configSchema: [\n {\n \"type\": \"text\",\n \"key\": \"property\",\n \"label\": \"Property\",\n \"required\": true,\n \"default\": \"properties/\",\n \"description\": \"The GA4 property, written as `properties/1234567890`. The numeric id alone is not accepted.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"startDate\",\n \"label\": \"Start date\",\n \"required\": true,\n \"default\": \"28daysAgo\",\n \"description\": \"YYYY-MM-DD, or a relative form Google accepts such as `28daysAgo`, `yesterday` or `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"endDate\",\n \"label\": \"End date\",\n \"required\": true,\n \"default\": \"today\",\n \"description\": \"YYYY-MM-DD, or a relative form such as `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"metrics\",\n \"label\": \"Metrics\",\n \"required\": true,\n \"default\": \"activeUsers,sessions\",\n \"description\": \"Metric names, comma separated. For example activeUsers, sessions, screenPageViews.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"dimensions\",\n \"label\": \"Dimensions\",\n \"default\": \"date\",\n \"description\": \"Dimension names, comma separated. For example date, country, pagePath. Leave empty for a single total row.\"\n }\n ],\n defaultConfig: {\n \"mode\": \"auto\"\n },\n renderBody: ({ config }) =>\n summarize(GOOGLE_ANALYTICS_REPORT_META, config as Record<string, unknown>, \"run a report\"),\n});\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's node kinds for fancy-flow.\n *\n * Install this on every host. The TypeScript executors live in the js\n * package's `./flow` subpath; PHP and Python hosts run their own and need only\n * this.\n */\n\nexport * from \"./service.js\";\nexport * from \"./kinds/report-run.js\";\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { googleAnalyticsReportKind } from \"./kinds/report-run.js\";\n\n/** Every Google Analytics kind, for a host that registers the lot. */\nexport const GOOGLE_ANALYTICS_KINDS: NodeKindDefinition[] = [\n googleAnalyticsReportKind,\n];\n"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -79,6 +79,11 @@ declare const GOOGLE_ANALYTICS_CREDENTIALS: readonly [{
|
|
|
79
79
|
* The access token lasts 3600 seconds. A host that never refreshes will work
|
|
80
80
|
* all afternoon and be broken by morning, which is why the lifetime is stated
|
|
81
81
|
* rather than left to be discovered.
|
|
82
|
+
*
|
|
83
|
+
* Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may
|
|
84
|
+
* safely be retried and may run concurrently. That is stated rather than
|
|
85
|
+
* assumed because the opposite — a provider that spends the token and revokes
|
|
86
|
+
* the grant on a replay — looks identical until it happens.
|
|
82
87
|
*/
|
|
83
88
|
declare const GOOGLE_ANALYTICS_OAUTH: {
|
|
84
89
|
readonly flow: "authorization_code";
|
|
@@ -87,6 +92,7 @@ declare const GOOGLE_ANALYTICS_OAUTH: {
|
|
|
87
92
|
readonly scopes: readonly ["https://www.googleapis.com/auth/analytics.readonly"];
|
|
88
93
|
readonly accessTokenCredential: "accessToken";
|
|
89
94
|
readonly refreshTokenCredential: "refreshToken";
|
|
95
|
+
readonly refreshTokenRotates: false;
|
|
90
96
|
readonly accessTokenTtlSeconds: 3600;
|
|
91
97
|
};
|
|
92
98
|
/** Build a Google Analytics node's connector metadata from the operation it performs. */
|
package/dist/index.d.ts
CHANGED
|
@@ -79,6 +79,11 @@ declare const GOOGLE_ANALYTICS_CREDENTIALS: readonly [{
|
|
|
79
79
|
* The access token lasts 3600 seconds. A host that never refreshes will work
|
|
80
80
|
* all afternoon and be broken by morning, which is why the lifetime is stated
|
|
81
81
|
* rather than left to be discovered.
|
|
82
|
+
*
|
|
83
|
+
* Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may
|
|
84
|
+
* safely be retried and may run concurrently. That is stated rather than
|
|
85
|
+
* assumed because the opposite — a provider that spends the token and revokes
|
|
86
|
+
* the grant on a replay — looks identical until it happens.
|
|
82
87
|
*/
|
|
83
88
|
declare const GOOGLE_ANALYTICS_OAUTH: {
|
|
84
89
|
readonly flow: "authorization_code";
|
|
@@ -87,6 +92,7 @@ declare const GOOGLE_ANALYTICS_OAUTH: {
|
|
|
87
92
|
readonly scopes: readonly ["https://www.googleapis.com/auth/analytics.readonly"];
|
|
88
93
|
readonly accessTokenCredential: "accessToken";
|
|
89
94
|
readonly refreshTokenCredential: "refreshToken";
|
|
95
|
+
readonly refreshTokenRotates: false;
|
|
90
96
|
readonly accessTokenTtlSeconds: 3600;
|
|
91
97
|
};
|
|
92
98
|
/** Build a Google Analytics node's connector metadata from the operation it performs. */
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/service.ts","../src/kinds/report-run.ts","../src/index.ts"],"names":[],"mappings":";;;AAkCO,IAAM,qBAAA,GAAwB;AAG9B,IAAM,wBAAA,GAA2B;AAAA,EACtC,OAAA,EAAS,kBAAA;AAAA,EACT,YAAA,EAAc,kBAAA;AAAA,EACd,MAAA,EAAQ,WAAA;AAAA,EACR,OAAA,EAAS;AACX;AAGO,IAAM,4BAAA,GAA+B;AAAA,EAC1C;AAAA,IACE,KAAA,EAAO,UAAA;AAAA,IACP,OAAA,EAAS,iBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,KAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,qBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,aAAA;AAAA,IACP,OAAA,EAAS,cAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,eAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA;AAEZ;AAeO,IAAM,sBAAA,GAAyB;AAAA,EACpC,MAAA,EAAQ,oBAAA;AAAA,EACR,cAAA,EAAgB,8CAAA;AAAA,EAChB,UAAA,EAAY,qCAAA;AAAA,EACZ,QAAA,EAAU;AAAA,IACR;AAAA,GACF;AAAA,EACA,uBAAA,EAAyB,aAAA;AAAA,EACzB,wBAAA,EAA0B,cAAA;AAAA,EAC1B,uBAAA,EAAyB;AAC3B;AAGO,SAAS,mBAAA,CACd,IAAA,EACA,SAAA,EACA,IAAA,EACe;AACf,EAAA,OAAO,EAAE,GAAG,wBAAA,EAA0B,IAAA,EAAM,WAAW,IAAA,EAAK;AAC9D;ACtFO,IAAM,4BAAA,GAA+B;AACrC,IAAM,iCAAA,GAAoC;AAE1C,IAAM,4BAAA,GAA+B,mBAAA,CAAoB,QAAA,EAAU,cAAA,EAAgB,sGAAsG;AAUzL,IAAM,8BAAA,GAAgD;AAAA,EAC3D;AAAA,IACE,MAAA,EAAQ,WAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,eAAA;AAAA,IACR,MAAA,EAAQ,QAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,oBAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA;AAEnB;AAEO,IAAM,yBAAA,GAAgD,oBAAoB,4BAAA,EAA8B;AAAA,EAC7G,IAAA,EAAM,4BAAA;AAAA,EACN,OAAA,EAAS,CAAC,yBAAyB,CAAA;AAAA,EACnC,KAAA,EAAO,yBAAA;AAAA,EACP,WAAA,EAAa,qDAAA;AAAA,EACb,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,MAAM,CAAA;AAAA,EACrB,OAAA,EAAS,CAAC,EAAE,EAAA,EAAI,OAAO,CAAA;AAAA,EACvB,WAAA,EAAa,MAAA;AAAA,EACb,WAAA,EAAa,8BAAA;AAAA,EACb,YAAA,EAAc;AAAA,IACZ;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,UAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,aAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,WAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,WAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,OAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,SAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,sBAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,SAAA,EAAW,MAAA;AAAA,MACX,aAAA,EAAe;AAAA;AACjB,GACF;AAAA,EACA,aAAA,EAAe;AAAA,IACb,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,UAAA,EAAY,CAAC,EAAE,MAAA,OACb,SAAA,CAAU,4BAAA,EAA8B,QAAmC,cAAc;AAC7F,CAAC;;;AClFM,IAAM,sBAAA,GAA+C;AAAA,EAC1D;AACF","file":"index.js","sourcesContent":["/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's identity on the authoring surface, shared by every Google\n * Analytics node.\n *\n * This file must import nothing from the js package: a PHP or Python project\n * installs the ui package and never that one, and the import would be a\n * dangling module the moment it did.\n *\n * ## The sandbox trap\n *\n * Google Analytics has no sandbox. A report reads a real property's real data\n * and spends real quota. The faker returns a plausibly-shaped report so a flow\n * can be built without a Google account.\n */\n\nimport type { ConnectorMeta } from \"@particle-academy/fancy-flow/connectors\";\n\n/**\n * The connector API version this package was GENERATED against.\n *\n * A literal, never imported — an imported constant lets an upgrade rewrite the\n * very claim it exists to detect.\n */\nexport const CONNECTOR_API_VERSION = 1;\n\n/** The parts of a connector's identity that belong to the SERVICE, not the node. */\nexport const GOOGLE_ANALYTICS_SERVICE = {\n service: \"google_analytics\",\n serviceTitle: \"Google Analytics\",\n domain: \"analytics\",\n sandbox: \"none\",\n} as const satisfies Pick<ConnectorMeta, \"service\" | \"serviceTitle\" | \"domain\" | \"sandbox\">;\n\n/** The credentials a Google Analytics connection holds. */\nexport const GOOGLE_ANALYTICS_CREDENTIALS = [\n {\n \"key\": \"clientId\",\n \"label\": \"OAuth client ID\",\n \"scope\": \"provider\",\n \"secret\": false,\n \"help\": \"From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.\"\n },\n {\n \"key\": \"clientSecret\",\n \"label\": \"OAuth client secret\",\n \"scope\": \"provider\",\n \"secret\": true,\n \"help\": \"The client secret for the same OAuth app. One value for the whole installation.\"\n },\n {\n \"key\": \"accessToken\",\n \"label\": \"Access token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.\"\n },\n {\n \"key\": \"refreshToken\",\n \"label\": \"Refresh token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account. Google issues one only when the consent request asks for offline access.\"\n }\n] as const;\n\n/**\n * The OAuth2 exchange Google Analytics requires — DECLARED here, performed by\n * the host.\n *\n * A consent screen needs a browser, a redirect URI and somewhere to persist\n * the result, and all three belong to the host; a package that ran the dance\n * itself would have to own a web server. So this says precisely enough for a\n * host to do it.\n *\n * The access token lasts 3600 seconds. A host that never refreshes will work\n * all afternoon and be broken by morning, which is why the lifetime is stated\n * rather than left to be discovered.\n */\nexport const GOOGLE_ANALYTICS_OAUTH = {\n \"flow\": \"authorization_code\",\n \"authorizeUrl\": \"https://accounts.google.com/o/oauth2/v2/auth\",\n \"tokenUrl\": \"https://oauth2.googleapis.com/token\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/analytics.readonly\"\n ],\n \"accessTokenCredential\": \"accessToken\",\n \"refreshTokenCredential\": \"refreshToken\",\n \"accessTokenTtlSeconds\": 3600\n} as const;\n\n/** Build a Google Analytics node's connector metadata from the operation it performs. */\nexport function googleAnalyticsMeta(\n role: ConnectorMeta[\"role\"],\n operation: string,\n docs: string,\n): ConnectorMeta {\n return { ...GOOGLE_ANALYTICS_SERVICE, role, operation, docs };\n}\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/actions/report-run.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/actions/report-run.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics report — Run a report against a Google Analytics 4\n * property.\n *\n * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\n */\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { defineConnectorKind, summarize, type OutputField } from \"@particle-academy/fancy-flow/connectors\";\nimport { googleAnalyticsMeta } from \"../service.js\";\n\nexport const GOOGLE_ANALYTICS_REPORT_KIND = \"@particle-academy/google_analytics_report\";\nexport const GOOGLE_ANALYTICS_REPORT_OPERATION = \"report_run\";\n\nexport const GOOGLE_ANALYTICS_REPORT_META = googleAnalyticsMeta(\"action\", \"run a report\", \"https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\");\n\n/**\n * What this node emits — the \"ingredients\" a downstream node can reference.\n *\n * fancy-flow reads `outputShape` off the kind and offers it in the variable\n * picker, so declaring it is the whole of the work: an author configuring the\n * next node picks `{{ $json.data.id }}` off a list instead of typing a path\n * and hoping.\n */\nexport const GOOGLE_ANALYTICS_REPORT_OUTPUT: OutputField[] = [\n {\n \"path\": \"data.rows\",\n \"type\": \"array\",\n \"description\": \"One entry per combination of dimension values. Each carries dimensionValues and metricValues, in the order requested.\"\n },\n {\n \"path\": \"data.rowCount\",\n \"type\": \"number\",\n \"description\": \"Total rows matching the query, which can exceed the rows returned.\"\n },\n {\n \"path\": \"data.metricHeaders\",\n \"type\": \"array\",\n \"description\": \"The metrics in the order their values appear in each row -- the only thing that says which number is which.\"\n }\n];\n\nexport const googleAnalyticsReportKind: NodeKindDefinition = defineConnectorKind(GOOGLE_ANALYTICS_REPORT_META, {\n name: GOOGLE_ANALYTICS_REPORT_KIND,\n aliases: [\"google_analytics_report\"],\n label: \"Google Analytics report\",\n description: \"Run a report against a Google Analytics 4 property.\",\n inputs: [{ id: \"in\" }],\n outputs: [{ id: \"out\" }],\n sideEffects: \"none\",\n outputShape: GOOGLE_ANALYTICS_REPORT_OUTPUT,\n configSchema: [\n {\n \"type\": \"text\",\n \"key\": \"property\",\n \"label\": \"Property\",\n \"required\": true,\n \"default\": \"properties/\",\n \"description\": \"The GA4 property, written as `properties/1234567890`. The numeric id alone is not accepted.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"startDate\",\n \"label\": \"Start date\",\n \"required\": true,\n \"default\": \"28daysAgo\",\n \"description\": \"YYYY-MM-DD, or a relative form Google accepts such as `28daysAgo`, `yesterday` or `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"endDate\",\n \"label\": \"End date\",\n \"required\": true,\n \"default\": \"today\",\n \"description\": \"YYYY-MM-DD, or a relative form such as `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"metrics\",\n \"label\": \"Metrics\",\n \"required\": true,\n \"default\": \"activeUsers,sessions\",\n \"description\": \"Metric names, comma separated. For example activeUsers, sessions, screenPageViews.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"dimensions\",\n \"label\": \"Dimensions\",\n \"default\": \"date\",\n \"description\": \"Dimension names, comma separated. For example date, country, pagePath. Leave empty for a single total row.\"\n }\n ],\n defaultConfig: {\n \"mode\": \"auto\"\n },\n renderBody: ({ config }) =>\n summarize(GOOGLE_ANALYTICS_REPORT_META, config as Record<string, unknown>, \"run a report\"),\n});\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's node kinds for fancy-flow.\n *\n * Install this on every host. The TypeScript executors live in the js\n * package's `./flow` subpath; PHP and Python hosts run their own and need only\n * this.\n */\n\nexport * from \"./service.js\";\nexport * from \"./kinds/report-run.js\";\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { googleAnalyticsReportKind } from \"./kinds/report-run.js\";\n\n/** Every Google Analytics kind, for a host that registers the lot. */\nexport const GOOGLE_ANALYTICS_KINDS: NodeKindDefinition[] = [\n googleAnalyticsReportKind,\n];\n"]}
|
|
1
|
+
{"version":3,"sources":["../src/service.ts","../src/kinds/report-run.ts","../src/index.ts"],"names":[],"mappings":";;;AAkCO,IAAM,qBAAA,GAAwB;AAG9B,IAAM,wBAAA,GAA2B;AAAA,EACtC,OAAA,EAAS,kBAAA;AAAA,EACT,YAAA,EAAc,kBAAA;AAAA,EACd,MAAA,EAAQ,WAAA;AAAA,EACR,OAAA,EAAS;AACX;AAGO,IAAM,4BAAA,GAA+B;AAAA,EAC1C;AAAA,IACE,KAAA,EAAO,UAAA;AAAA,IACP,OAAA,EAAS,iBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,KAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,qBAAA;AAAA,IACT,OAAA,EAAS,UAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,aAAA;AAAA,IACP,OAAA,EAAS,cAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA,GACV;AAAA,EACA;AAAA,IACE,KAAA,EAAO,cAAA;AAAA,IACP,OAAA,EAAS,eAAA;AAAA,IACT,OAAA,EAAS,SAAA;AAAA,IACT,QAAA,EAAU,IAAA;AAAA,IACV,MAAA,EAAQ;AAAA;AAEZ;AAoBO,IAAM,sBAAA,GAAyB;AAAA,EACpC,MAAA,EAAQ,oBAAA;AAAA,EACR,cAAA,EAAgB,8CAAA;AAAA,EAChB,UAAA,EAAY,qCAAA;AAAA,EACZ,QAAA,EAAU;AAAA,IACR;AAAA,GACF;AAAA,EACA,uBAAA,EAAyB,aAAA;AAAA,EACzB,wBAAA,EAA0B,cAAA;AAAA,EAC1B,qBAAA,EAAuB,KAAA;AAAA,EACvB,uBAAA,EAAyB;AAC3B;AAGO,SAAS,mBAAA,CACd,IAAA,EACA,SAAA,EACA,IAAA,EACe;AACf,EAAA,OAAO,EAAE,GAAG,wBAAA,EAA0B,IAAA,EAAM,WAAW,IAAA,EAAK;AAC9D;AC5FO,IAAM,4BAAA,GAA+B;AACrC,IAAM,iCAAA,GAAoC;AAE1C,IAAM,4BAAA,GAA+B,mBAAA,CAAoB,QAAA,EAAU,cAAA,EAAgB,sGAAsG;AAUzL,IAAM,8BAAA,GAAgD;AAAA,EAC3D;AAAA,IACE,MAAA,EAAQ,WAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,eAAA;AAAA,IACR,MAAA,EAAQ,QAAA;AAAA,IACR,aAAA,EAAe;AAAA,GACjB;AAAA,EACA;AAAA,IACE,MAAA,EAAQ,oBAAA;AAAA,IACR,MAAA,EAAQ,OAAA;AAAA,IACR,aAAA,EAAe;AAAA;AAEnB;AAEO,IAAM,yBAAA,GAAgD,oBAAoB,4BAAA,EAA8B;AAAA,EAC7G,IAAA,EAAM,4BAAA;AAAA,EACN,OAAA,EAAS,CAAC,yBAAyB,CAAA;AAAA,EACnC,KAAA,EAAO,yBAAA;AAAA,EACP,WAAA,EAAa,qDAAA;AAAA,EACb,MAAA,EAAQ,CAAC,EAAE,EAAA,EAAI,MAAM,CAAA;AAAA,EACrB,OAAA,EAAS,CAAC,EAAE,EAAA,EAAI,OAAO,CAAA;AAAA,EACvB,WAAA,EAAa,MAAA;AAAA,EACb,WAAA,EAAa,8BAAA;AAAA,EACb,YAAA,EAAc;AAAA,IACZ;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,UAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,aAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,WAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,WAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,UAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,OAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,SAAA;AAAA,MACP,OAAA,EAAS,SAAA;AAAA,MACT,UAAA,EAAY,IAAA;AAAA,MACZ,SAAA,EAAW,sBAAA;AAAA,MACX,aAAA,EAAe;AAAA,KACjB;AAAA,IACA;AAAA,MACE,MAAA,EAAQ,MAAA;AAAA,MACR,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,YAAA;AAAA,MACT,SAAA,EAAW,MAAA;AAAA,MACX,aAAA,EAAe;AAAA;AACjB,GACF;AAAA,EACA,aAAA,EAAe;AAAA,IACb,MAAA,EAAQ;AAAA,GACV;AAAA,EACA,UAAA,EAAY,CAAC,EAAE,MAAA,OACb,SAAA,CAAU,4BAAA,EAA8B,QAAmC,cAAc;AAC7F,CAAC;;;AClFM,IAAM,sBAAA,GAA+C;AAAA,EAC1D;AACF","file":"index.js","sourcesContent":["/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's identity on the authoring surface, shared by every Google\n * Analytics node.\n *\n * This file must import nothing from the js package: a PHP or Python project\n * installs the ui package and never that one, and the import would be a\n * dangling module the moment it did.\n *\n * ## The sandbox trap\n *\n * Google Analytics has no sandbox. A report reads a real property's real data\n * and spends real quota. The faker returns a plausibly-shaped report so a flow\n * can be built without a Google account.\n */\n\nimport type { ConnectorMeta } from \"@particle-academy/fancy-flow/connectors\";\n\n/**\n * The connector API version this package was GENERATED against.\n *\n * A literal, never imported — an imported constant lets an upgrade rewrite the\n * very claim it exists to detect.\n */\nexport const CONNECTOR_API_VERSION = 1;\n\n/** The parts of a connector's identity that belong to the SERVICE, not the node. */\nexport const GOOGLE_ANALYTICS_SERVICE = {\n service: \"google_analytics\",\n serviceTitle: \"Google Analytics\",\n domain: \"analytics\",\n sandbox: \"none\",\n} as const satisfies Pick<ConnectorMeta, \"service\" | \"serviceTitle\" | \"domain\" | \"sandbox\">;\n\n/** The credentials a Google Analytics connection holds. */\nexport const GOOGLE_ANALYTICS_CREDENTIALS = [\n {\n \"key\": \"clientId\",\n \"label\": \"OAuth client ID\",\n \"scope\": \"provider\",\n \"secret\": false,\n \"help\": \"From Google Cloud Console -> APIs & Services -> Credentials. ONE value for the whole installation, not per connected account.\"\n },\n {\n \"key\": \"clientSecret\",\n \"label\": \"OAuth client secret\",\n \"scope\": \"provider\",\n \"secret\": true,\n \"help\": \"The client secret for the same OAuth app. One value for the whole installation.\"\n },\n {\n \"key\": \"accessToken\",\n \"label\": \"Access token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account, and it expires after ONE HOUR. The host refreshes it with the refresh token.\"\n },\n {\n \"key\": \"refreshToken\",\n \"label\": \"Refresh token\",\n \"scope\": \"account\",\n \"secret\": true,\n \"help\": \"Per connected Google account. Google issues one only when the consent request asks for offline access.\"\n }\n] as const;\n\n/**\n * The OAuth2 exchange Google Analytics requires — DECLARED here, performed by\n * the host.\n *\n * A consent screen needs a browser, a redirect URI and somewhere to persist\n * the result, and all three belong to the host; a package that ran the dance\n * itself would have to own a web server. So this says precisely enough for a\n * host to do it.\n *\n * The access token lasts 3600 seconds. A host that never refreshes will work\n * all afternoon and be broken by morning, which is why the lifetime is stated\n * rather than left to be discovered.\n *\n * Its refresh tokens do NOT rotate: the same one is reusable, so a refresh may\n * safely be retried and may run concurrently. That is stated rather than\n * assumed because the opposite — a provider that spends the token and revokes\n * the grant on a replay — looks identical until it happens.\n */\nexport const GOOGLE_ANALYTICS_OAUTH = {\n \"flow\": \"authorization_code\",\n \"authorizeUrl\": \"https://accounts.google.com/o/oauth2/v2/auth\",\n \"tokenUrl\": \"https://oauth2.googleapis.com/token\",\n \"scopes\": [\n \"https://www.googleapis.com/auth/analytics.readonly\"\n ],\n \"accessTokenCredential\": \"accessToken\",\n \"refreshTokenCredential\": \"refreshToken\",\n \"refreshTokenRotates\": false,\n \"accessTokenTtlSeconds\": 3600\n} as const;\n\n/** Build a Google Analytics node's connector metadata from the operation it performs. */\nexport function googleAnalyticsMeta(\n role: ConnectorMeta[\"role\"],\n operation: string,\n docs: string,\n): ConnectorMeta {\n return { ...GOOGLE_ANALYTICS_SERVICE, role, operation, docs };\n}\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/actions/report-run.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/actions/report-run.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics report — Run a report against a Google Analytics 4\n * property.\n *\n * https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\n */\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { defineConnectorKind, summarize, type OutputField } from \"@particle-academy/fancy-flow/connectors\";\nimport { googleAnalyticsMeta } from \"../service.js\";\n\nexport const GOOGLE_ANALYTICS_REPORT_KIND = \"@particle-academy/google_analytics_report\";\nexport const GOOGLE_ANALYTICS_REPORT_OPERATION = \"report_run\";\n\nexport const GOOGLE_ANALYTICS_REPORT_META = googleAnalyticsMeta(\"action\", \"run a report\", \"https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport\");\n\n/**\n * What this node emits — the \"ingredients\" a downstream node can reference.\n *\n * fancy-flow reads `outputShape` off the kind and offers it in the variable\n * picker, so declaring it is the whole of the work: an author configuring the\n * next node picks `{{ $json.data.id }}` off a list instead of typing a path\n * and hoping.\n */\nexport const GOOGLE_ANALYTICS_REPORT_OUTPUT: OutputField[] = [\n {\n \"path\": \"data.rows\",\n \"type\": \"array\",\n \"description\": \"One entry per combination of dimension values. Each carries dimensionValues and metricValues, in the order requested.\"\n },\n {\n \"path\": \"data.rowCount\",\n \"type\": \"number\",\n \"description\": \"Total rows matching the query, which can exceed the rows returned.\"\n },\n {\n \"path\": \"data.metricHeaders\",\n \"type\": \"array\",\n \"description\": \"The metrics in the order their values appear in each row -- the only thing that says which number is which.\"\n }\n];\n\nexport const googleAnalyticsReportKind: NodeKindDefinition = defineConnectorKind(GOOGLE_ANALYTICS_REPORT_META, {\n name: GOOGLE_ANALYTICS_REPORT_KIND,\n aliases: [\"google_analytics_report\"],\n label: \"Google Analytics report\",\n description: \"Run a report against a Google Analytics 4 property.\",\n inputs: [{ id: \"in\" }],\n outputs: [{ id: \"out\" }],\n sideEffects: \"none\",\n outputShape: GOOGLE_ANALYTICS_REPORT_OUTPUT,\n configSchema: [\n {\n \"type\": \"text\",\n \"key\": \"property\",\n \"label\": \"Property\",\n \"required\": true,\n \"default\": \"properties/\",\n \"description\": \"The GA4 property, written as `properties/1234567890`. The numeric id alone is not accepted.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"startDate\",\n \"label\": \"Start date\",\n \"required\": true,\n \"default\": \"28daysAgo\",\n \"description\": \"YYYY-MM-DD, or a relative form Google accepts such as `28daysAgo`, `yesterday` or `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"endDate\",\n \"label\": \"End date\",\n \"required\": true,\n \"default\": \"today\",\n \"description\": \"YYYY-MM-DD, or a relative form such as `today`.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"metrics\",\n \"label\": \"Metrics\",\n \"required\": true,\n \"default\": \"activeUsers,sessions\",\n \"description\": \"Metric names, comma separated. For example activeUsers, sessions, screenPageViews.\"\n },\n {\n \"type\": \"text\",\n \"key\": \"dimensions\",\n \"label\": \"Dimensions\",\n \"default\": \"date\",\n \"description\": \"Dimension names, comma separated. For example date, country, pagePath. Leave empty for a single total row.\"\n }\n ],\n defaultConfig: {\n \"mode\": \"auto\"\n },\n renderBody: ({ config }) =>\n summarize(GOOGLE_ANALYTICS_REPORT_META, config as Record<string, unknown>, \"run a report\"),\n});\n","/**\n * GENERATED FILE — do not edit.\n *\n * Emitted from provider/manifest.json by weaver's generator.\n * A hand-edit here is destroyed by the next protocol sync, which is worse than\n * being rejected, because it works until it silently does not. Fix\n * provider/manifest.json (or weaver's template/) and regenerate:\n *\n * npm run provider -- google_analytics\n */\n\n/**\n * Google Analytics's node kinds for fancy-flow.\n *\n * Install this on every host. The TypeScript executors live in the js\n * package's `./flow` subpath; PHP and Python hosts run their own and need only\n * this.\n */\n\nexport * from \"./service.js\";\nexport * from \"./kinds/report-run.js\";\n\nimport type { NodeKindDefinition } from \"@particle-academy/fancy-flow/engine\";\nimport { googleAnalyticsReportKind } from \"./kinds/report-run.js\";\n\n/** Every Google Analytics kind, for a host that registers the lot. */\nexport const GOOGLE_ANALYTICS_KINDS: NodeKindDefinition[] = [\n googleAnalyticsReportKind,\n];\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@particle-academy/google-analytics-ui",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Google Analytics's authoring surface for fancy-flow — the node kinds, their config schemas and their declared output shapes. React on every host; carries no executor.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|