workers-start 0.7.1 → 0.9.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.
@@ -0,0 +1,148 @@
1
+ /**
2
+ * Google APIs as a service account, on WebCrypto and `fetch` only: the signed
3
+ * JWT exchanged for an access token (cached per account and scope), the GA4
4
+ * Data API's `runReport` and `batchRunReports`, and Search Console's
5
+ * `searchAnalytics.query`. Runs in workerd and Node.
6
+ *
7
+ * The API helpers take a token rather than an account, so a token from
8
+ * anywhere (gcloud impersonation in a script, say) works with them too.
9
+ */
10
+ export declare const GOOGLE_TOKEN_URL = "https://oauth2.googleapis.com/token";
11
+ export declare const GA4_SCOPE = "https://www.googleapis.com/auth/analytics.readonly";
12
+ export declare const SEARCH_CONSOLE_SCOPE = "https://www.googleapis.com/auth/webmasters.readonly";
13
+ export interface ServiceAccount {
14
+ clientEmail: string;
15
+ /** The PKCS#8 PEM. Escaped `\n` sequences are fine. */
16
+ privateKey: string;
17
+ /** Sent as the JWT's `kid` when present. */
18
+ privateKeyId?: string | undefined;
19
+ /** Defaults to Google's token endpoint. */
20
+ tokenUri?: string | undefined;
21
+ }
22
+ /** A Google API answered with an error status. */
23
+ export declare class GoogleApiError extends Error {
24
+ readonly status: number;
25
+ /** Google's error body, when it sent JSON. */
26
+ readonly body?: unknown;
27
+ readonly name = "GoogleApiError";
28
+ constructor(message: string, status: number,
29
+ /** Google's error body, when it sent JSON. */
30
+ body?: unknown);
31
+ }
32
+ /** The key file JSON (`client_email`, `private_key`, ...) as an account, or null when it is not one. */
33
+ export declare function parseServiceAccount(raw: string | undefined | null): ServiceAccount | null;
34
+ /**
35
+ * Imports the account's private key for signing. Throws a clear error for a
36
+ * PKCS#1 key (`BEGIN RSA PRIVATE KEY`, which WebCrypto cannot import) or for
37
+ * a value that is not a PEM at all.
38
+ */
39
+ export declare function importServiceAccountKey(pem: string): Promise<CryptoKey>;
40
+ /** The signed RS256 assertion Google exchanges for an access token. */
41
+ export declare function serviceAccountJwt(account: ServiceAccount, scopes: string | readonly string[], nowMs?: number): Promise<string>;
42
+ type Fetch = (url: string, init?: RequestInit) => Promise<Response>;
43
+ export interface GoogleAuthOptions {
44
+ fetch?: Fetch;
45
+ /** Milliseconds since the epoch. */
46
+ now?: () => number;
47
+ /** Refresh this many seconds before the token expires. Default 300. */
48
+ marginSeconds?: number;
49
+ }
50
+ export type GoogleTokenSource = (account: ServiceAccount, scopes: string | readonly string[]) => Promise<string>;
51
+ /**
52
+ * A token source with its own cache. Tokens are kept per account and scope
53
+ * until `marginSeconds` before they expire. Concurrent calls share one
54
+ * exchange, and a failed exchange is not cached.
55
+ */
56
+ export declare function createGoogleAuth(options?: GoogleAuthOptions): GoogleTokenSource;
57
+ /** An access token from a token source shared by the whole isolate. */
58
+ export declare function googleAccessToken(account: ServiceAccount, scopes: string | readonly string[]): Promise<string>;
59
+ export interface GoogleCallOptions {
60
+ fetch?: Fetch;
61
+ /** Abort after this long. Default 10 seconds. */
62
+ timeoutMs?: number;
63
+ }
64
+ export interface Ga4DateRange {
65
+ startDate: string;
66
+ endDate: string;
67
+ name?: string;
68
+ }
69
+ /** A GA4 filter expression, passed through as Google defines it. */
70
+ export type Ga4FilterExpression = Record<string, unknown>;
71
+ export interface Ga4ReportRequest {
72
+ dimensions?: {
73
+ name: string;
74
+ }[];
75
+ metrics: {
76
+ name: string;
77
+ }[];
78
+ dateRanges: Ga4DateRange[];
79
+ dimensionFilter?: Ga4FilterExpression;
80
+ metricFilter?: Ga4FilterExpression;
81
+ orderBys?: Record<string, unknown>[];
82
+ limit?: number;
83
+ offset?: number;
84
+ metricAggregations?: ("TOTAL" | "MAXIMUM" | "MINIMUM" | "COUNT")[];
85
+ keepEmptyRows?: boolean;
86
+ }
87
+ interface Ga4Row {
88
+ dimensionValues?: {
89
+ value?: string;
90
+ }[];
91
+ metricValues?: {
92
+ value?: string;
93
+ }[];
94
+ }
95
+ export interface Ga4Report {
96
+ dimensionHeaders?: {
97
+ name: string;
98
+ }[];
99
+ metricHeaders?: {
100
+ name: string;
101
+ type?: string;
102
+ }[];
103
+ rows?: Ga4Row[];
104
+ totals?: Ga4Row[];
105
+ rowCount?: number;
106
+ }
107
+ /** One GA4 report. `propertyId` is the number, with or without `properties/`. */
108
+ export declare function ga4RunReport(token: string, propertyId: string, request: Ga4ReportRequest, options?: GoogleCallOptions): Promise<Ga4Report>;
109
+ /** Up to five GA4 reports in one call, in order. */
110
+ export declare function ga4BatchRunReports(token: string, propertyId: string, requests: readonly Ga4ReportRequest[], options?: GoogleCallOptions): Promise<Ga4Report[]>;
111
+ export type Ga4RowObject = Record<string, string | number>;
112
+ /**
113
+ * A report's rows as objects keyed by header name: dimensions as strings,
114
+ * metrics as numbers. `totals: true` reads the totals rows instead.
115
+ */
116
+ export declare function ga4Rows(report: Ga4Report, { totals }?: {
117
+ totals?: boolean;
118
+ }): Ga4RowObject[];
119
+ /** A filter matching a dimension against a list of values. */
120
+ export declare function inListFilter(fieldName: string, values: readonly string[]): Ga4FilterExpression;
121
+ export interface SearchAnalyticsQuery {
122
+ startDate: string;
123
+ endDate: string;
124
+ dimensions?: ("query" | "page" | "country" | "device" | "date" | "searchAppearance")[];
125
+ type?: "web" | "image" | "video" | "news" | "discover" | "googleNews";
126
+ dimensionFilterGroups?: Record<string, unknown>[];
127
+ aggregationType?: "auto" | "byPage" | "byProperty";
128
+ dataState?: "final" | "all";
129
+ rowLimit?: number;
130
+ startRow?: number;
131
+ }
132
+ export interface SearchAnalyticsRow {
133
+ keys: string[];
134
+ clicks: number;
135
+ impressions: number;
136
+ ctr: number;
137
+ position: number;
138
+ }
139
+ /**
140
+ * Search Console rows for `siteUrl` (`sc-domain:example.com` or a URL
141
+ * prefix). With `all: true` it pages with `startRow` until Google returns a
142
+ * short page.
143
+ */
144
+ export declare function searchConsoleQuery(token: string, siteUrl: string, query: SearchAnalyticsQuery, options?: GoogleCallOptions & {
145
+ all?: boolean;
146
+ }): Promise<SearchAnalyticsRow[]>;
147
+ export {};
148
+ //# sourceMappingURL=google.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"google.d.ts","sourceRoot":"","sources":["../src/google.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,eAAO,MAAM,gBAAgB,wCAAwC,CAAC;AACtE,eAAO,MAAM,SAAS,uDAAuD,CAAC;AAC9E,eAAO,MAAM,oBAAoB,wDACsB,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,kDAAkD;AAClD,qBAAa,cAAe,SAAQ,KAAK;IAIrC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO;IALzB,SAAkB,IAAI,oBAAoB;IAC1C,YACE,OAAO,EAAE,MAAM,EACN,MAAM,EAAE,MAAM;IACvB,8CAA8C;IACrC,IAAI,CAAC,EAAE,OAAO,EAGxB;CACF;AAED,wGAAwG;AACxG,wBAAgB,mBAAmB,CACjC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAC7B,cAAc,GAAG,IAAI,CAgBvB;AAMD;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAsB7E;AAUD,uEAAuE;AACvE,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,EAClC,KAAK,GAAE,MAAmB,GACzB,OAAO,CAAC,MAAM,CAAC,CAejB;AAED,KAAK,KAAK,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEpE,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAC9B,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,KAC/B,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,iBAAsB,GAC9B,iBAAiB,CAmDnB;AAID,uEAAuE;AACvE,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,cAAc,EACvB,MAAM,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GACjC,OAAO,CAAC,MAAM,CAAC,CAGjB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAqCD,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,oEAAoE;AACpE,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1D,MAAM,WAAW,gBAAgB;IAC/B,UAAU,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAChC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC5B,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kBAAkB,CAAC,EAAE,CAAC,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;IACnE,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,UAAU,MAAM;IACd,eAAe,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACvC,YAAY,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,gBAAgB,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACtC,aAAa,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAClD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD,iFAAiF;AACjF,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,gBAAgB,EACzB,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,SAAS,CAAC,CAQpB;AAED,oDAAoD;AACpD,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,SAAS,gBAAgB,EAAE,EACrC,OAAO,GAAE,iBAAsB,GAC9B,OAAO,CAAC,SAAS,EAAE,CAAC,CAWtB;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAE3D;;;GAGG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,SAAS,EACjB,EAAE,MAAc,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GAC5C,YAAY,EAAE,CAahB;AAED,8DAA8D;AAC9D,wBAAgB,YAAY,CAC1B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,SAAS,MAAM,EAAE,GACxB,mBAAmB,CAErB;AAID,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,CACT,OAAO,GACP,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,kBAAkB,CACrB,EAAE,CAAC;IACJ,IAAI,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC;IACtE,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAClD,eAAe,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;IACnD,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,oBAAoB,EAC3B,OAAO,GAAE,iBAAiB,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAA;CAAO,GAClD,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAwB/B"}
package/dist/google.js ADDED
@@ -0,0 +1,224 @@
1
+ /**
2
+ * Google APIs as a service account, on WebCrypto and `fetch` only: the signed
3
+ * JWT exchanged for an access token (cached per account and scope), the GA4
4
+ * Data API's `runReport` and `batchRunReports`, and Search Console's
5
+ * `searchAnalytics.query`. Runs in workerd and Node.
6
+ *
7
+ * The API helpers take a token rather than an account, so a token from
8
+ * anywhere (gcloud impersonation in a script, say) works with them too.
9
+ */
10
+ export const GOOGLE_TOKEN_URL = "https://oauth2.googleapis.com/token";
11
+ export const GA4_SCOPE = "https://www.googleapis.com/auth/analytics.readonly";
12
+ export const SEARCH_CONSOLE_SCOPE = "https://www.googleapis.com/auth/webmasters.readonly";
13
+ /** A Google API answered with an error status. */
14
+ export class GoogleApiError extends Error {
15
+ status;
16
+ body;
17
+ name = "GoogleApiError";
18
+ constructor(message, status,
19
+ /** Google's error body, when it sent JSON. */
20
+ body) {
21
+ super(message);
22
+ this.status = status;
23
+ this.body = body;
24
+ }
25
+ }
26
+ /** The key file JSON (`client_email`, `private_key`, ...) as an account, or null when it is not one. */
27
+ export function parseServiceAccount(raw) {
28
+ if (!raw)
29
+ return null;
30
+ try {
31
+ const v = JSON.parse(raw);
32
+ if (typeof v.client_email !== "string" || typeof v.private_key !== "string")
33
+ return null;
34
+ return {
35
+ clientEmail: v.client_email,
36
+ privateKey: v.private_key,
37
+ privateKeyId: typeof v.private_key_id === "string" ? v.private_key_id : undefined,
38
+ tokenUri: typeof v.token_uri === "string" ? v.token_uri : undefined,
39
+ };
40
+ }
41
+ catch {
42
+ return null;
43
+ }
44
+ }
45
+ const PKCS8_HEADER = "-----BEGIN PRIVATE KEY-----";
46
+ const PKCS8_FOOTER = "-----END PRIVATE KEY-----";
47
+ const RS256 = { name: "RSASSA-PKCS1-v1_5", hash: "SHA-256" };
48
+ /**
49
+ * Imports the account's private key for signing. Throws a clear error for a
50
+ * PKCS#1 key (`BEGIN RSA PRIVATE KEY`, which WebCrypto cannot import) or for
51
+ * a value that is not a PEM at all.
52
+ */
53
+ export async function importServiceAccountKey(pem) {
54
+ const text = pem.replace(/\\n/g, "\n").trim();
55
+ if (text.startsWith("-----BEGIN RSA PRIVATE KEY-----")) {
56
+ throw new Error("The private key is PKCS#1 (BEGIN RSA PRIVATE KEY). WebCrypto imports PKCS#8 only (BEGIN PRIVATE KEY), which is what a Google service account key file holds.");
57
+ }
58
+ const start = text.indexOf(PKCS8_HEADER);
59
+ const end = text.indexOf(PKCS8_FOOTER);
60
+ if (start === -1 || end === -1) {
61
+ throw new Error("The private key is not a PEM. Copy the private_key field from the service account JSON as it is.");
62
+ }
63
+ const body = text.slice(start + PKCS8_HEADER.length, end).replace(/\s+/g, "");
64
+ let der;
65
+ try {
66
+ der = Uint8Array.from(atob(body), (ch) => ch.charCodeAt(0));
67
+ }
68
+ catch {
69
+ throw new Error("The private key's body is not valid base64.");
70
+ }
71
+ return crypto.subtle.importKey("pkcs8", der, RS256, false, ["sign"]);
72
+ }
73
+ const encoder = new TextEncoder();
74
+ function b64url(data) {
75
+ const bytes = typeof data === "string" ? encoder.encode(data) : data;
76
+ let bin = "";
77
+ for (const b of bytes)
78
+ bin += String.fromCharCode(b);
79
+ return btoa(bin).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
80
+ }
81
+ /** The signed RS256 assertion Google exchanges for an access token. */
82
+ export async function serviceAccountJwt(account, scopes, nowMs = Date.now()) {
83
+ const iat = Math.floor(nowMs / 1000);
84
+ const header = { alg: "RS256", typ: "JWT" };
85
+ if (account.privateKeyId)
86
+ header.kid = account.privateKeyId;
87
+ const claims = {
88
+ iss: account.clientEmail,
89
+ scope: typeof scopes === "string" ? scopes : scopes.join(" "),
90
+ aud: account.tokenUri ?? GOOGLE_TOKEN_URL,
91
+ iat,
92
+ exp: iat + 3600,
93
+ };
94
+ const input = `${b64url(JSON.stringify(header))}.${b64url(JSON.stringify(claims))}`;
95
+ const key = await importServiceAccountKey(account.privateKey);
96
+ const sig = await crypto.subtle.sign(RS256, key, encoder.encode(input));
97
+ return `${input}.${b64url(new Uint8Array(sig))}`;
98
+ }
99
+ /**
100
+ * A token source with its own cache. Tokens are kept per account and scope
101
+ * until `marginSeconds` before they expire. Concurrent calls share one
102
+ * exchange, and a failed exchange is not cached.
103
+ */
104
+ export function createGoogleAuth(options = {}) {
105
+ const { fetch: fetcher = (url, init) => fetch(url, init), now = Date.now, marginSeconds = 300, } = options;
106
+ const cache = new Map();
107
+ return (account, scopes) => {
108
+ const scope = typeof scopes === "string" ? scopes : scopes.join(" ");
109
+ const key = `${account.clientEmail}\n${scope}`;
110
+ const hit = cache.get(key);
111
+ if (hit && hit.expiresAt > now())
112
+ return hit.token;
113
+ const entry = { token: Promise.resolve(""), expiresAt: Infinity };
114
+ entry.token = (async () => {
115
+ const assertion = await serviceAccountJwt(account, scope, now());
116
+ const res = await fetcher(account.tokenUri ?? GOOGLE_TOKEN_URL, {
117
+ method: "POST",
118
+ headers: { "content-type": "application/x-www-form-urlencoded" },
119
+ body: new URLSearchParams({
120
+ grant_type: "urn:ietf:params:oauth:grant-type:jwt-bearer",
121
+ assertion,
122
+ }).toString(),
123
+ });
124
+ const body = (await res.json().catch(() => null));
125
+ if (!res.ok || !body?.access_token) {
126
+ const why = body?.error_description ?? body?.error ?? "no access token";
127
+ throw new GoogleApiError(`Google token exchange failed (${res.status}): ${why}`, res.status, body);
128
+ }
129
+ entry.expiresAt =
130
+ now() + ((body.expires_in ?? 3600) - marginSeconds) * 1000;
131
+ return body.access_token;
132
+ })();
133
+ entry.token.catch(() => {
134
+ if (cache.get(key) === entry)
135
+ cache.delete(key);
136
+ });
137
+ cache.set(key, entry);
138
+ return entry.token;
139
+ };
140
+ }
141
+ let shared;
142
+ /** An access token from a token source shared by the whole isolate. */
143
+ export function googleAccessToken(account, scopes) {
144
+ shared ??= createGoogleAuth();
145
+ return shared(account, scopes);
146
+ }
147
+ async function googleJson(url, token, body, { fetch: fetcher = (u, i) => fetch(u, i), timeoutMs = 10_000, }, what) {
148
+ const res = await fetcher(url, {
149
+ method: "POST",
150
+ headers: {
151
+ authorization: `Bearer ${token}`,
152
+ "content-type": "application/json",
153
+ },
154
+ body: JSON.stringify(body),
155
+ signal: AbortSignal.timeout(timeoutMs),
156
+ });
157
+ const json = (await res.json().catch(() => null));
158
+ if (!res.ok) {
159
+ const message = json?.error?.message ??
160
+ res.statusText;
161
+ throw new GoogleApiError(`${what} failed (${res.status}): ${message}`, res.status, json);
162
+ }
163
+ return json;
164
+ }
165
+ const ga4Url = (propertyId, method) => `https://analyticsdata.googleapis.com/v1beta/properties/${encodeURIComponent(propertyId.replace(/^properties\//, ""))}:${method}`;
166
+ /** One GA4 report. `propertyId` is the number, with or without `properties/`. */
167
+ export function ga4RunReport(token, propertyId, request, options = {}) {
168
+ return googleJson(ga4Url(propertyId, "runReport"), token, request, options, "GA4 runReport");
169
+ }
170
+ /** Up to five GA4 reports in one call, in order. */
171
+ export async function ga4BatchRunReports(token, propertyId, requests, options = {}) {
172
+ if (requests.length > 5)
173
+ throw new Error("GA4 batchRunReports takes at most 5 reports.");
174
+ const res = await googleJson(ga4Url(propertyId, "batchRunReports"), token, { requests }, options, "GA4 batchRunReports");
175
+ return res.reports ?? [];
176
+ }
177
+ /**
178
+ * A report's rows as objects keyed by header name: dimensions as strings,
179
+ * metrics as numbers. `totals: true` reads the totals rows instead.
180
+ */
181
+ export function ga4Rows(report, { totals = false } = {}) {
182
+ const dims = report.dimensionHeaders?.map((h) => h.name) ?? [];
183
+ const mets = report.metricHeaders?.map((h) => h.name) ?? [];
184
+ return ((totals ? report.totals : report.rows) ?? []).map((row) => {
185
+ const out = {};
186
+ dims.forEach((name, i) => {
187
+ out[name] = row.dimensionValues?.[i]?.value ?? "";
188
+ });
189
+ mets.forEach((name, i) => {
190
+ out[name] = Number(row.metricValues?.[i]?.value ?? 0);
191
+ });
192
+ return out;
193
+ });
194
+ }
195
+ /** A filter matching a dimension against a list of values. */
196
+ export function inListFilter(fieldName, values) {
197
+ return { filter: { fieldName, inListFilter: { values: [...values] } } };
198
+ }
199
+ /**
200
+ * Search Console rows for `siteUrl` (`sc-domain:example.com` or a URL
201
+ * prefix). With `all: true` it pages with `startRow` until Google returns a
202
+ * short page.
203
+ */
204
+ export async function searchConsoleQuery(token, siteUrl, query, options = {}) {
205
+ const url = `https://www.googleapis.com/webmasters/v3/sites/${encodeURIComponent(siteUrl)}/searchAnalytics/query`;
206
+ const pageSize = query.rowLimit ?? (options.all ? 25_000 : 1_000);
207
+ const rows = [];
208
+ let startRow = query.startRow ?? 0;
209
+ for (;;) {
210
+ const res = await googleJson(url, token, { ...query, rowLimit: pageSize, startRow }, options, "Search Console query");
211
+ const page = (res.rows ?? []).map((r) => ({
212
+ keys: r.keys ?? [],
213
+ clicks: r.clicks ?? 0,
214
+ impressions: r.impressions ?? 0,
215
+ ctr: r.ctr ?? 0,
216
+ position: r.position ?? 0,
217
+ }));
218
+ rows.push(...page);
219
+ if (!options.all || page.length < pageSize)
220
+ return rows;
221
+ startRow += page.length;
222
+ }
223
+ }
224
+ //# sourceMappingURL=google.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"google.js","sourceRoot":"","sources":["../src/google.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,qCAAqC,CAAC;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,oDAAoD,CAAC;AAC9E,MAAM,CAAC,MAAM,oBAAoB,GAC/B,qDAAqD,CAAC;AAYxD,kDAAkD;AAClD,MAAM,OAAO,cAAe,SAAQ,KAAK;IAI5B,MAAM;IAEN,IAAI;IALG,IAAI,GAAG,gBAAgB,CAAC;IAC1C,YACE,OAAe,EACN,MAAc;IACvB,8CAA8C;IACrC,IAAc;QAEvB,KAAK,CAAC,OAAO,CAAC,CAAC;sBAJN,MAAM;oBAEN,IAAI;IAGf,CAAC;CACF;AAED,wGAAwG;AACxG,MAAM,UAAU,mBAAmB,CACjC,GAA8B;IAE9B,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAA4B,CAAC;QACrD,IAAI,OAAO,CAAC,CAAC,YAAY,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,WAAW,KAAK,QAAQ;YACzE,OAAO,IAAI,CAAC;QACd,OAAO;YACL,WAAW,EAAE,CAAC,CAAC,YAAY;YAC3B,UAAU,EAAE,CAAC,CAAC,WAAW;YACzB,YAAY,EACV,OAAO,CAAC,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;YACrE,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;SACpE,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,YAAY,GAAG,6BAA6B,CAAC;AACnD,MAAM,YAAY,GAAG,2BAA2B,CAAC;AACjD,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAW,CAAC;AAEtE;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,GAAW;IACvD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9C,IAAI,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CACb,8JAA8J,CAC/J,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACzC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,kGAAkG,CACnG,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9E,IAAI,GAA4B,CAAC;IACjC,IAAI,CAAC;QACH,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAClC,SAAS,MAAM,CAAC,IAAyB;IACvC,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrE,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,MAAM,CAAC,IAAI,KAAK;QAAE,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACrD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC9E,CAAC;AAED,uEAAuE;AACvE,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAuB,EACvB,MAAkC,EAClC,KAAK,GAAW,IAAI,CAAC,GAAG,EAAE;IAE1B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IACrC,MAAM,MAAM,GAA2B,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IACpE,IAAI,OAAO,CAAC,YAAY;QAAE,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC;IAC5D,MAAM,MAAM,GAAG;QACb,GAAG,EAAE,OAAO,CAAC,WAAW;QACxB,KAAK,EAAE,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QAC7D,GAAG,EAAE,OAAO,CAAC,QAAQ,IAAI,gBAAgB;QACzC,GAAG;QACH,GAAG,EAAE,GAAG,GAAG,IAAI;KAChB,CAAC;IACF,MAAM,KAAK,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,GAAG,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;AACnD,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAO,GAAsB,EAAE;IAE/B,MAAM,EACJ,KAAK,EAAE,OAAO,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,EAChD,GAAG,GAAG,IAAI,CAAC,GAAG,EACd,aAAa,GAAG,GAAG,GACpB,GAAG,OAAO,CAAC;IACZ,MAAM,KAAK,GAAG,IAAI,GAAG,EAGlB,CAAC;IAEJ,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,GAAG,GAAG,EAAE;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC;QACnD,MAAM,KAAK,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QAClE,KAAK,CAAC,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE;YACxB,MAAM,SAAS,GAAG,MAAM,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACjE,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,QAAQ,IAAI,gBAAgB,EAAE;gBAC9D,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,EAAE,cAAc,EAAE,mCAAmC,EAAE;gBAChE,IAAI,EAAE,IAAI,eAAe,CAAC;oBACxB,UAAU,EAAE,6CAA6C;oBACzD,SAAS;iBACV,CAAC,CAAC,QAAQ,EAAE;aACd,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAKxC,CAAC;YACT,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;gBACnC,MAAM,GAAG,GAAG,IAAI,EAAE,iBAAiB,IAAI,IAAI,EAAE,KAAK,IAAI,iBAAiB,CAAC;gBACxE,MAAM,IAAI,cAAc,CACtB,iCAAiC,GAAG,CAAC,MAAM,MAAM,GAAG,EAAE,EACtD,GAAG,CAAC,MAAM,EACV,IAAI,CACL,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,SAAS;gBACb,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC;YAC7D,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC,CAAC,EAAE,CAAC;QACL,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;YACrB,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,KAAK;gBAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC,CAAC;AACJ,CAAC;AAED,IAAI,MAAqC,CAAC;AAE1C,uEAAuE;AACvE,MAAM,UAAU,iBAAiB,CAC/B,OAAuB,EACvB,MAAkC;IAElC,MAAM,KAAK,gBAAgB,EAAE,CAAC;IAC9B,OAAO,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC;AAQD,KAAK,UAAU,UAAU,CACvB,GAAW,EACX,KAAa,EACb,IAAa,EACb,EACE,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EACtC,SAAS,GAAG,MAAM,GACA,EACpB,IAAY;IAEZ,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;QAC7B,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,KAAK,EAAE;YAChC,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAC1B,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;KACvC,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAY,CAAC;IAC7D,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,OAAO,GACV,IAAgD,EAAE,KAAK,EAAE,OAAO;YACjE,GAAG,CAAC,UAAU,CAAC;QACjB,MAAM,IAAI,cAAc,CACtB,GAAG,IAAI,YAAY,GAAG,CAAC,MAAM,MAAM,OAAO,EAAE,EAC5C,GAAG,CAAC,MAAM,EACV,IAAI,CACL,CAAC;IACJ,CAAC;IACD,OAAO,IAAS,CAAC;AACnB,CAAC;AAuCD,MAAM,MAAM,GAAG,CAAC,UAAkB,EAAE,MAAc,EAAE,EAAE,CACpD,0DAA0D,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;AAEpI,iFAAiF;AACjF,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,UAAkB,EAClB,OAAyB,EACzB,OAAO,GAAsB,EAAE;IAE/B,OAAO,UAAU,CACf,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,EAC/B,KAAK,EACL,OAAO,EACP,OAAO,EACP,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAa,EACb,UAAkB,EAClB,QAAqC,EACrC,OAAO,GAAsB,EAAE;IAE/B,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,MAAM,GAAG,GAAG,MAAM,UAAU,CAC1B,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,EACrC,KAAK,EACL,EAAE,QAAQ,EAAE,EACZ,OAAO,EACP,qBAAqB,CACtB,CAAC;IACF,OAAO,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;AAC3B,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,OAAO,CACrB,MAAiB,EACjB,EAAE,MAAM,GAAG,KAAK,EAAE,GAAyB,EAAE;IAE7C,MAAM,IAAI,GAAG,MAAM,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5D,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAChE,MAAM,GAAG,GAAiB,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACvB,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YACvB,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,YAAY,CAC1B,SAAiB,EACjB,MAAyB;IAEzB,OAAO,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC;AAC1E,CAAC;AA+BD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAa,EACb,OAAe,EACf,KAA2B,EAC3B,OAAO,GAA0C,EAAE;IAEnD,MAAM,GAAG,GAAG,kDAAkD,kBAAkB,CAAC,OAAO,CAAC,wBAAwB,CAAC;IAClH,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAClE,MAAM,IAAI,GAAyB,EAAE,CAAC;IACtC,IAAI,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC;IACnC,SAAS,CAAC;QACR,MAAM,GAAG,GAAG,MAAM,UAAU,CAC1B,GAAG,EACH,KAAK,EACL,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAC1C,OAAO,EACP,sBAAsB,CACvB,CAAC;QACF,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACxC,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE;YAClB,MAAM,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC;YACrB,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,CAAC;YAC/B,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;YACf,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,CAAC;SAC1B,CAAC,CAAC,CAAC;QACJ,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;YAAE,OAAO,IAAI,CAAC;QACxD,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC;IAC1B,CAAC;AACH,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,9 +1,13 @@
1
1
  export type { MediaRange } from "./accept.js";
2
2
  export { parseAccept, quality } from "./accept.js";
3
+ export type { AccessConfig, AccessEnv, AccessFailure, AccessResult, AccessVerifier, AccessVerifierOptions, } from "./access.js";
4
+ export { accessToken, createAccessVerifier, parseAccessConfig, verifyAccessToken, } from "./access.js";
3
5
  export type { EdgeCacheOptions } from "./cache.js";
4
6
  export { sharedMaxAge, withEdgeCache, withoutBrowserMaxAge, } from "./cache.js";
5
7
  export type { EntryOptions, FetchHandler, MarkdownPage, MarkdownResult, } from "./entry.js";
6
8
  export { acceptsHtml, createEntry, defaultIsPage, MARKDOWN_HEADERS, mergeVary, normalizePath, underPrefix, wantsMarkdown, withHeaders, } from "./entry.js";
9
+ export type { Ga4DateRange, Ga4FilterExpression, Ga4Report, Ga4ReportRequest, Ga4RowObject, GoogleAuthOptions, GoogleCallOptions, GoogleTokenSource, SearchAnalyticsQuery, SearchAnalyticsRow, ServiceAccount, } from "./google.js";
10
+ export { createGoogleAuth, GA4_SCOPE, GOOGLE_TOKEN_URL, GoogleApiError, ga4BatchRunReports, ga4Rows, ga4RunReport, googleAccessToken, importServiceAccountKey, inListFilter, parseServiceAccount, SEARCH_CONSOLE_SCOPE, searchConsoleQuery, serviceAccountJwt, } from "./google.js";
7
11
  export type { HeadLink, HeadScript, HeadTags, MetaTag, PageImage, PageSeo, SiteHead, } from "./head.js";
8
12
  export { createPageHead, jsonLdScript } from "./head.js";
9
13
  export type { AnalyticsScriptOptions, GaEventParams, TagManagerScriptOptions, ThemeScriptOptions, } from "./scripts.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnD,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,oBAAoB,GACrB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,WAAW,EACX,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACT,OAAO,EACP,QAAQ,GACT,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzD,YAAY,EACV,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,eAAe,EACf,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EACL,aAAa,EACb,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,gBAAgB,GACjB,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACnD,YAAY,EACV,YAAY,EACZ,SAAS,EACT,aAAa,EACb,YAAY,EACZ,cAAc,EACd,qBAAqB,GACtB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,oBAAoB,GACrB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,WAAW,EACX,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,OAAO,EACP,SAAS,EACT,OAAO,EACP,QAAQ,GACT,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzD,YAAY,EACV,sBAAsB,EACtB,aAAa,EACb,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,eAAe,EACf,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EACL,aAAa,EACb,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,gBAAgB,GACjB,MAAM,cAAc,CAAC"}
package/dist/index.js CHANGED
@@ -1,6 +1,8 @@
1
1
  export { parseAccept, quality } from "./accept.js";
2
+ export { accessToken, createAccessVerifier, parseAccessConfig, verifyAccessToken, } from "./access.js";
2
3
  export { sharedMaxAge, withEdgeCache, withoutBrowserMaxAge, } from "./cache.js";
3
4
  export { acceptsHtml, createEntry, defaultIsPage, MARKDOWN_HEADERS, mergeVary, normalizePath, underPrefix, wantsMarkdown, withHeaders, } from "./entry.js";
5
+ export { createGoogleAuth, GA4_SCOPE, GOOGLE_TOKEN_URL, GoogleApiError, ga4BatchRunReports, ga4Rows, ga4RunReport, googleAccessToken, importServiceAccountKey, inListFilter, parseServiceAccount, SEARCH_CONSOLE_SCOPE, searchConsoleQuery, serviceAccountJwt, } from "./google.js";
4
6
  export { createPageHead, jsonLdScript } from "./head.js";
5
7
  export { analyticsScript, gaEvent, inlineJson, tagManagerScript, themeScript, } from "./scripts.js";
6
8
  export { escapeXml, robotsTxt, sitemapXml } from "./seo.js";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAOpB,OAAO,EACL,WAAW,EACX,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AAUpB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAOzD,OAAO,EACL,eAAe,EACf,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,WAAW,GACZ,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EACL,aAAa,EACb,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,gBAAgB,GACjB,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AASnD,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,YAAY,EACZ,aAAa,EACb,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAOpB,OAAO,EACL,WAAW,EACX,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,EACb,WAAW,GACZ,MAAM,YAAY,CAAC;AAcpB,OAAO,EACL,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AAUrB,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAOzD,OAAO,EACL,eAAe,EACf,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,WAAW,GACZ,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EACL,aAAa,EACb,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,gBAAgB,GACjB,MAAM,cAAc,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "workers-start",
3
- "version": "0.7.1",
3
+ "version": "0.9.0",
4
4
  "description": "The parts every TanStack Start app on Cloudflare Workers ends up writing: Markdown for agents on the same URL, a head helper that stops share cards leaking between pages, lazy Workers bindings, and a check that no local secret ships in the build.",
5
5
  "license": "MIT",
6
6
  "author": "Ryan Ghods",
@@ -21,7 +21,9 @@
21
21
  "vite",
22
22
  "seo",
23
23
  "markdown",
24
- "llms"
24
+ "llms",
25
+ "google-analytics",
26
+ "search-console"
25
27
  ],
26
28
  "type": "module",
27
29
  "sideEffects": false,
@@ -71,6 +73,21 @@
71
73
  "import": "./dist/accept.js",
72
74
  "default": "./dist/accept.js"
73
75
  },
76
+ "./access": {
77
+ "types": "./dist/access.d.ts",
78
+ "import": "./dist/access.js",
79
+ "default": "./dist/access.js"
80
+ },
81
+ "./access/testing": {
82
+ "types": "./dist/access-testing.d.ts",
83
+ "import": "./dist/access-testing.js",
84
+ "default": "./dist/access-testing.js"
85
+ },
86
+ "./google": {
87
+ "types": "./dist/google.d.ts",
88
+ "import": "./dist/google.js",
89
+ "default": "./dist/google.js"
90
+ },
74
91
  "./package.json": "./package.json"
75
92
  },
76
93
  "bin": {
@@ -0,0 +1,121 @@
1
+ /**
2
+ * A stand-in for a Cloudflare Access team in tests: a key pair made on the
3
+ * spot, a `fetch` that serves its public key at the team's certs URL, and a
4
+ * signer for tokens shaped like the ones Access issues.
5
+ */
6
+ import type { AccessConfig } from "./access.js";
7
+
8
+ export interface TestAccessTeam {
9
+ /** Config for `createAccessVerifier`, with `emails` allowed. */
10
+ config: AccessConfig;
11
+ /** Serves the team's certs; pass it as the verifier's `fetch`. */
12
+ fetch: (url: string) => Promise<Response>;
13
+ /** A signed token for `email`, valid for an hour, with `claims` on top. */
14
+ token: (email: string, claims?: Record<string, unknown>) => Promise<string>;
15
+ /** A signed token for a service token's client id. */
16
+ serviceToken: (
17
+ clientId: string,
18
+ claims?: Record<string, unknown>,
19
+ ) => Promise<string>;
20
+ /** Signs any claims and header fields with the team's key. */
21
+ sign: (
22
+ claims: Record<string, unknown>,
23
+ header?: Record<string, unknown>,
24
+ ) => Promise<string>;
25
+ }
26
+
27
+ export interface TestAccessTeamOptions {
28
+ teamDomain?: string;
29
+ aud?: string;
30
+ emails?: string[];
31
+ serviceTokens?: string[];
32
+ kid?: string;
33
+ /** Milliseconds since the epoch, for `iat`, `nbf` and `exp`. */
34
+ now?: () => number;
35
+ }
36
+
37
+ export async function createTestAccessTeam(
38
+ options: TestAccessTeamOptions = {},
39
+ ): Promise<TestAccessTeam> {
40
+ const {
41
+ teamDomain = "test.cloudflareaccess.com",
42
+ aud = "test-aud",
43
+ emails = ["admin@example.com"],
44
+ serviceTokens = [],
45
+ kid = "test-key",
46
+ now = Date.now,
47
+ } = options;
48
+ const pair = (await crypto.subtle.generateKey(
49
+ {
50
+ name: "RSASSA-PKCS1-v1_5",
51
+ modulusLength: 2048,
52
+ publicExponent: new Uint8Array([1, 0, 1]),
53
+ hash: "SHA-256",
54
+ },
55
+ true,
56
+ ["sign", "verify"],
57
+ )) as { privateKey: CryptoKey; publicKey: CryptoKey };
58
+ const jwk = {
59
+ ...((await crypto.subtle.exportKey("jwk", pair.publicKey)) as object),
60
+ kid,
61
+ alg: "RS256",
62
+ use: "sig",
63
+ };
64
+ const certsUrl = `https://${teamDomain}/cdn-cgi/access/certs`;
65
+
66
+ const sign = async (
67
+ claims: Record<string, unknown>,
68
+ header: Record<string, unknown> = {},
69
+ ) => {
70
+ const head = encode(JSON.stringify({ alg: "RS256", kid, ...header }));
71
+ const body = encode(JSON.stringify(claims));
72
+ const sig = await crypto.subtle.sign(
73
+ "RSASSA-PKCS1-v1_5",
74
+ pair.privateKey,
75
+ new TextEncoder().encode(`${head}.${body}`),
76
+ );
77
+ return `${head}.${body}.${encode(new Uint8Array(sig))}`;
78
+ };
79
+ const base = () => {
80
+ const iat = Math.floor(now() / 1000);
81
+ return {
82
+ aud: [aud],
83
+ iss: `https://${teamDomain}`,
84
+ iat,
85
+ nbf: iat,
86
+ exp: iat + 3600,
87
+ };
88
+ };
89
+
90
+ return {
91
+ config: {
92
+ teamDomain,
93
+ aud,
94
+ emails: emails.map((e) => e.toLowerCase()),
95
+ serviceTokens,
96
+ },
97
+ fetch: async (url) =>
98
+ url === certsUrl
99
+ ? Response.json({ keys: [jwk] })
100
+ : new Response("not found", { status: 404 }),
101
+ token: (email, claims = {}) =>
102
+ sign({ ...base(), email, sub: "user-id", type: "app", ...claims }),
103
+ serviceToken: (clientId, claims = {}) =>
104
+ sign({
105
+ ...base(),
106
+ sub: "",
107
+ type: "app",
108
+ common_name: clientId,
109
+ ...claims,
110
+ }),
111
+ sign,
112
+ };
113
+ }
114
+
115
+ function encode(value: string | Uint8Array): string {
116
+ const bytes =
117
+ typeof value === "string" ? new TextEncoder().encode(value) : value;
118
+ let bin = "";
119
+ for (const b of bytes) bin += String.fromCharCode(b);
120
+ return btoa(bin).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, "");
121
+ }