@domandigital/gbp 0.3.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Doman Digital Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,145 @@
+# @domandigital/gbp
+
+A zero-dependency Google Business Profile client for Doman Digital / IDS
+client sites: OAuth refresh-token auth and a paginated reviews fetch,
+including the business's own reply to each review.
+
+## Why this exists
+
+Extracted from MMM Beauty's `packages/google-apis` (`business-profile.ts` +
+`oauth-client.ts`), which was already proven in production against the
+real GBP API's quirks -- star-rating enums, page-size caps, graceful
+degrade-to-empty when unconfigured. Six client sites need this, not one, so
+it moved out into its own package rather than being copy-pasted five more
+times. That's the exact drift `@domandigital/graph` already exists to
+prevent, one layer down: OAuth + pagination + enum-decoding logic
+independently reinvented per repo instead of fixed once.
+
+This package does **not** depend on `@domandigital/graph` and vice versa.
+`gbp` fetches review facts; `graph` turns facts into JSON-LD. A consuming
+site composes them at the call site:
+
+```ts
+import { getBusinessReviews } from "@domandigital/gbp";
+import { buildReview, createGraphIds } from "@domandigital/graph";
+
+const { reviews, averageRating, totalReviewCount } = await getBusinessReviews();
+const reviewNodes = reviews.map((r) =>
+  buildReview(
+    {
+      authorName: r.author,
+      reviewBody: r.comment,
+      ratingValue: r.rating,
+      datePublished: r.createdAt,
+      reply: r.reply ? { text: r.reply.text, dateCreated: r.reply.updatedAt } : null,
+    },
+    ids,
+  ),
+);
+```
+
+`averageRating` / `totalReviewCount` feed `OrganizationInput.aggregateRating`
+directly -- don't hardcode a rating/count literal in a site's settings file
+once this is wired in. That literal drifting from the real listing (a site
+claiming 7 reviews when Google has 6) is the bug this package exists to kill.
+
+## Why Business Profile API, not Places API
+
+Places API's `Review` object has no field for the business's reply, full
+stop -- and caps out at 5 reviews per place with no pagination. Neither
+limitation applies here: this uses the Business Profile API (the same one
+you already manage the listing through), which returns every review, paginated,
+with the reply attached, for free.
+
+## Install
+
+Not published to npm. Consumed as a git dependency pinned to a tag:
+
+```json
+{
+  "dependencies": {
+    "@domandigital/gbp": "github:Doman-Digital/dd-gbp#v0.1.0"
+  }
+}
+```
+
+`dist/` is committed to this repo (no CI build step runs on a git-dependency
+install), so no build step is required in the consuming project beyond a
+normal `pnpm install`.
+
+## Env
+
+| Var | Purpose |
+|---|---|
+| `GBP_CLIENT_ID` | Google Cloud OAuth client id |
+| `GBP_CLIENT_SECRET` | Google Cloud OAuth client secret |
+| `GBP_REFRESH_TOKEN` | User refresh token (service accounts are rejected by this API) |
+| `GOOGLE_BUSINESS_ACCOUNT_ID` | e.g. `accounts/1234567890` |
+| `GOOGLE_BUSINESS_LOCATION_ID` | e.g. `locations/9876543210` |
+
+Which actual Google Cloud OAuth client + refresh token you point at (the
+agency's shared credential, or a business's own dedicated one) is entirely a
+deployment-env decision, not a code-level one -- each app configures its own.
+
+## API
+
+### `getBusinessReviews(options?): Promise<BusinessReviewsResult>`
+
+Paginates through every review (GBP caps each page at 50) and returns:
+
+```ts
+interface BusinessReviewsResult {
+  averageRating: number | null;
+  totalReviewCount: number;
+  reviews: BusinessReview[];
+}
+
+interface BusinessReview {
+  id: string;
+  author: string;
+  authorPhoto?: string;
+  rating: number; // 1-5
+  comment: string;
+  createdAt: string; // ISO
+  reply?: { text: string; updatedAt: string }; // no author field -- see below
+}
+```
+
+Options:
+
+- `limit?: number` -- stop paginating once this many reviews are collected.
+  Omit to fetch all of them.
+- `filterMinStars?: number` -- drop reviews below this rating. Use for a
+  public testimonial feed; omit for an owner-facing surface where the point
+  is to see everything. `totalReviewCount` always reflects the location's
+  real total, never the filtered count.
+- `next?: { revalidate?: number; tags?: string[] }` -- passed straight through
+  to `fetch`'s Next.js cache-hint augmentation. A no-op outside Next.js.
+  Default: revalidate hourly.
+
+Never throws on missing configuration -- `isBusinessProfileConfigured()` gates
+internally and returns an empty result, so UI can render unconditionally.
+Does throw on a real API failure (non-OK response), so a calling route should
+catch and degrade explicitly if it wants zero-downtime behavior on a Google
+outage.
+
+### Why a reply has no author field
+
+A GBP review has exactly one reply slot, and it can only ever come from the
+business -- there is no third party to disambiguate, so the API returns
+`{ comment, updateTime, reviewReplyState }` with nothing else. Google's own
+listing UI renders every reply as "Response from the owner" for the same
+reason. Attribute it to the business's own Organization node in the
+consumer (see the `@domandigital/graph` composition example above) --
+don't go looking for an author field that doesn't exist.
+
+### `isBusinessProfileConfigured(): boolean`
+
+True once all five env vars above are set.
+
+### `hasGoogleOAuthCredentials()` / `getGoogleOAuthAccessToken()`
+
+Lower-level OAuth primitives, exported in case a consumer needs the raw
+access token for another Business Profile endpoint this package doesn't wrap
+(e.g. business hours, Q&A). The token is cached in-process and refreshed a
+minute before expiry.

package/dist/index.cjs

@@ -0,0 +1,144 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  getBusinessReviews: () => getBusinessReviews,
+  getGoogleOAuthAccessToken: () => getGoogleOAuthAccessToken,
+  hasGoogleOAuthCredentials: () => hasGoogleOAuthCredentials,
+  isBusinessProfileConfigured: () => isBusinessProfileConfigured
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/oauth-client.ts
+var TOKEN_URI = "https://oauth2.googleapis.com/token";
+var EXPIRY_SKEW_MS = 60 * 1e3;
+var cached = null;
+function hasGoogleOAuthCredentials() {
+  return Boolean(
+    process.env.GBP_CLIENT_ID && process.env.GBP_CLIENT_SECRET && process.env.GBP_REFRESH_TOKEN
+  );
+}
+async function getGoogleOAuthAccessToken() {
+  if (cached && cached.expiresAt > Date.now()) {
+    return cached.accessToken;
+  }
+  if (!hasGoogleOAuthCredentials()) return null;
+  const res = await fetch(TOKEN_URI, {
+    method: "POST",
+    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+    body: new URLSearchParams({
+      client_id: process.env.GBP_CLIENT_ID,
+      client_secret: process.env.GBP_CLIENT_SECRET,
+      refresh_token: process.env.GBP_REFRESH_TOKEN,
+      grant_type: "refresh_token"
+    })
+  });
+  if (!res.ok) {
+    throw new Error(`Google OAuth token refresh failed: ${res.status} ${await res.text()}`);
+  }
+  const data = await res.json();
+  cached = {
+    accessToken: data.access_token,
+    expiresAt: Date.now() + (data.expires_in ?? 3600) * 1e3 - EXPIRY_SKEW_MS
+  };
+  return cached.accessToken;
+}
+
+// src/reviews.ts
+var STAR_VALUES = {
+  ONE: 1,
+  TWO: 2,
+  THREE: 3,
+  FOUR: 4,
+  FIVE: 5
+};
+var MAX_PAGE_SIZE = 50;
+function shuffleArray(arr) {
+  const copy = [...arr];
+  for (let i = copy.length - 1; i > 0; i--) {
+    const j = Math.floor(Math.random() * (i + 1));
+    [copy[i], copy[j]] = [copy[j], copy[i]];
+  }
+  return copy;
+}
+var EMPTY = {
+  averageRating: null,
+  totalReviewCount: 0,
+  reviews: []
+};
+function isBusinessProfileConfigured() {
+  return hasGoogleOAuthCredentials() && Boolean(process.env.GOOGLE_BUSINESS_ACCOUNT_ID) && Boolean(process.env.GOOGLE_BUSINESS_LOCATION_ID);
+}
+function toBusinessReview(r) {
+  const review = {
+    id: r.reviewId,
+    author: r.reviewer?.displayName ?? "Anonymous",
+    authorPhoto: r.reviewer?.profilePhotoUrl,
+    rating: STAR_VALUES[r.starRating ?? "FIVE"] ?? 5,
+    comment: r.comment ?? "",
+    createdAt: r.createTime ?? ""
+  };
+  if (r.reviewReply?.comment) {
+    review.reply = { text: r.reviewReply.comment, updatedAt: r.reviewReply.updateTime ?? "" };
+  }
+  return review;
+}
+async function getBusinessReviews(options = {}) {
+  const { limit, filterMinStars, next } = options;
+  if (!isBusinessProfileConfigured()) return EMPTY;
+  const token = await getGoogleOAuthAccessToken();
+  if (!token) return EMPTY;
+  const account = process.env.GOOGLE_BUSINESS_ACCOUNT_ID;
+  const location = process.env.GOOGLE_BUSINESS_LOCATION_ID;
+  const raw = [];
+  let averageRating;
+  let totalReviewCount;
+  let pageToken;
+  do {
+    const endpoint = `https://mybusiness.googleapis.com/v4/accounts/${account}/locations/${location}/reviews?orderBy=updateTime%20desc&pageSize=${MAX_PAGE_SIZE}` + (pageToken ? `&pageToken=${encodeURIComponent(pageToken)}` : "");
+    const fetchOptions = {
+      headers: { Authorization: `Bearer ${token}` },
+      next: next ?? { revalidate: 3600, tags: ["google-reviews"] }
+    };
+    const res = await fetch(endpoint, fetchOptions);
+    if (!res.ok) {
+      throw new Error(`Business Profile reviews failed: ${res.status} ${await res.text()}`);
+    }
+    const data = await res.json();
+    raw.push(...data.reviews ?? []);
+    averageRating = data.averageRating ?? averageRating;
+    totalReviewCount = data.totalReviewCount ?? totalReviewCount;
+    pageToken = data.nextPageToken;
+  } while (pageToken && (limit === void 0 || raw.length < limit));
+  const reviews = raw.filter((r) => r.comment && r.starRating).filter((r) => filterMinStars === void 0 || STAR_VALUES[r.starRating] >= filterMinStars).map(toBusinessReview).slice(0, limit);
+  return {
+    averageRating: averageRating ?? null,
+    totalReviewCount: totalReviewCount ?? reviews.length,
+    reviews: shuffleArray(reviews)
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getBusinessReviews,
+  getGoogleOAuthAccessToken,
+  hasGoogleOAuthCredentials,
+  isBusinessProfileConfigured
+});

package/dist/index.d.cts

@@ -0,0 +1,91 @@
+/**
+ * Google user OAuth (refresh-token) auth -- for APIs that reject service
+ * accounts, notably the Business Profile API (all scopes) and Search Console
+ * on domain-verified properties.
+ *
+ * This code is identity-agnostic: which actual Google Cloud OAuth client it
+ * talks to (the agency's shared client, or a business's own dedicated client)
+ * is entirely a function of which GBP_CLIENT_ID / GBP_CLIENT_SECRET /
+ * GBP_REFRESH_TOKEN values are set in the deploying app's environment -- not
+ * a code-level distinction. Each app/deployment configures its own.
+ *
+ * Env: GBP_CLIENT_ID, GBP_CLIENT_SECRET, GBP_REFRESH_TOKEN.
+ */
+/** True when the OAuth client + refresh token are present. */
+declare function hasGoogleOAuthCredentials(): boolean;
+/**
+ * Exchange the stored refresh token for a short-lived access token. Returns
+ * `null` when credentials aren't configured so callers can degrade
+ * gracefully. The token's actual scopes are whatever the refresh token was
+ * granted with -- not scoped per call.
+ */
+declare function getGoogleOAuthAccessToken(): Promise<string | null>;
+
+/**
+ * Google Business Profile -- fetch the business's own reviews, including the
+ * business's reply to each one. Free (no per-call billing, unlike Places
+ * API), and because these are your own reviews via the Business Profile API
+ * there are no Places display / caching restrictions.
+ *
+ * Auth is OAuth user refresh-token, not a service account -- service accounts
+ * are rejected by this API entirely. See ./oauth-client.ts.
+ *
+ * A review's reply has no author field of its own: GBP replies are 1:1 (one
+ * slot per review) and always from the business -- there's no third party to
+ * disambiguate. Google's own UI renders it as "Response from the owner" for
+ * the same reason. Attribute it to the business in the consumer, not here.
+ *
+ * Access caveat: the Business Profile APIs require a one-time access request
+ * / approval from Google, and reviews live on the legacy `mybusiness v4`
+ * endpoint which must be enabled on your Cloud project. Until that is
+ * granted, every function here degrades gracefully to empty results.
+ *
+ * Env: GBP_CLIENT_ID, GBP_CLIENT_SECRET, GBP_REFRESH_TOKEN,
+ * GOOGLE_BUSINESS_ACCOUNT_ID, GOOGLE_BUSINESS_LOCATION_ID.
+ */
+interface ReviewReply {
+    text: string;
+    /** ISO 8601, when the reply was last posted/edited. */
+    updatedAt: string;
+}
+interface BusinessReview {
+    id: string;
+    author: string;
+    authorPhoto?: string;
+    rating: number;
+    comment: string;
+    createdAt: string;
+    reply?: ReviewReply;
+}
+interface BusinessReviewsResult {
+    averageRating: number | null;
+    totalReviewCount: number;
+    reviews: BusinessReview[];
+}
+/** True when account + location + OAuth credentials are all configured. */
+declare function isBusinessProfileConfigured(): boolean;
+interface GetBusinessReviewsOptions {
+    /** Max reviews to return (default: all of them, paginated). */
+    limit?: number;
+    /**
+     * When set, only reviews at or above this star rating are returned -- for
+     * public-facing social proof (e.g. a marketing site's testimonial feed).
+     * Omit to return every review including low ratings, for an owner-facing
+     * surface where the point is to see and respond to everything.
+     */
+    filterMinStars?: number;
+    /** Cache-hint passed straight through to `fetch`'s Next.js augmentation.
+     * A no-op outside Next.js. Default: revalidate hourly. */
+    next?: {
+        revalidate?: number;
+        tags?: string[];
+    };
+}
+/**
+ * Fetch reviews for the configured location, paginating through all pages
+ * (GBP caps each page at 50). Returns empty results (never throws on missing
+ * config) so UI can render unconditionally.
+ */
+declare function getBusinessReviews(options?: GetBusinessReviewsOptions): Promise<BusinessReviewsResult>;
+
+export { type BusinessReview, type BusinessReviewsResult, type GetBusinessReviewsOptions, type ReviewReply, getBusinessReviews, getGoogleOAuthAccessToken, hasGoogleOAuthCredentials, isBusinessProfileConfigured };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Google user OAuth (refresh-token) auth -- for APIs that reject service
+ * accounts, notably the Business Profile API (all scopes) and Search Console
+ * on domain-verified properties.
+ *
+ * This code is identity-agnostic: which actual Google Cloud OAuth client it
+ * talks to (the agency's shared client, or a business's own dedicated client)
+ * is entirely a function of which GBP_CLIENT_ID / GBP_CLIENT_SECRET /
+ * GBP_REFRESH_TOKEN values are set in the deploying app's environment -- not
+ * a code-level distinction. Each app/deployment configures its own.
+ *
+ * Env: GBP_CLIENT_ID, GBP_CLIENT_SECRET, GBP_REFRESH_TOKEN.
+ */
+/** True when the OAuth client + refresh token are present. */
+declare function hasGoogleOAuthCredentials(): boolean;
+/**
+ * Exchange the stored refresh token for a short-lived access token. Returns
+ * `null` when credentials aren't configured so callers can degrade
+ * gracefully. The token's actual scopes are whatever the refresh token was
+ * granted with -- not scoped per call.
+ */
+declare function getGoogleOAuthAccessToken(): Promise<string | null>;
+
+/**
+ * Google Business Profile -- fetch the business's own reviews, including the
+ * business's reply to each one. Free (no per-call billing, unlike Places
+ * API), and because these are your own reviews via the Business Profile API
+ * there are no Places display / caching restrictions.
+ *
+ * Auth is OAuth user refresh-token, not a service account -- service accounts
+ * are rejected by this API entirely. See ./oauth-client.ts.
+ *
+ * A review's reply has no author field of its own: GBP replies are 1:1 (one
+ * slot per review) and always from the business -- there's no third party to
+ * disambiguate. Google's own UI renders it as "Response from the owner" for
+ * the same reason. Attribute it to the business in the consumer, not here.
+ *
+ * Access caveat: the Business Profile APIs require a one-time access request
+ * / approval from Google, and reviews live on the legacy `mybusiness v4`
+ * endpoint which must be enabled on your Cloud project. Until that is
+ * granted, every function here degrades gracefully to empty results.
+ *
+ * Env: GBP_CLIENT_ID, GBP_CLIENT_SECRET, GBP_REFRESH_TOKEN,
+ * GOOGLE_BUSINESS_ACCOUNT_ID, GOOGLE_BUSINESS_LOCATION_ID.
+ */
+interface ReviewReply {
+    text: string;
+    /** ISO 8601, when the reply was last posted/edited. */
+    updatedAt: string;
+}
+interface BusinessReview {
+    id: string;
+    author: string;
+    authorPhoto?: string;
+    rating: number;
+    comment: string;
+    createdAt: string;
+    reply?: ReviewReply;
+}
+interface BusinessReviewsResult {
+    averageRating: number | null;
+    totalReviewCount: number;
+    reviews: BusinessReview[];
+}
+/** True when account + location + OAuth credentials are all configured. */
+declare function isBusinessProfileConfigured(): boolean;
+interface GetBusinessReviewsOptions {
+    /** Max reviews to return (default: all of them, paginated). */
+    limit?: number;
+    /**
+     * When set, only reviews at or above this star rating are returned -- for
+     * public-facing social proof (e.g. a marketing site's testimonial feed).
+     * Omit to return every review including low ratings, for an owner-facing
+     * surface where the point is to see and respond to everything.
+     */
+    filterMinStars?: number;
+    /** Cache-hint passed straight through to `fetch`'s Next.js augmentation.
+     * A no-op outside Next.js. Default: revalidate hourly. */
+    next?: {
+        revalidate?: number;
+        tags?: string[];
+    };
+}
+/**
+ * Fetch reviews for the configured location, paginating through all pages
+ * (GBP caps each page at 50). Returns empty results (never throws on missing
+ * config) so UI can render unconditionally.
+ */
+declare function getBusinessReviews(options?: GetBusinessReviewsOptions): Promise<BusinessReviewsResult>;
+
+export { type BusinessReview, type BusinessReviewsResult, type GetBusinessReviewsOptions, type ReviewReply, getBusinessReviews, getGoogleOAuthAccessToken, hasGoogleOAuthCredentials, isBusinessProfileConfigured };

package/dist/index.js

@@ -0,0 +1,114 @@
+// src/oauth-client.ts
+var TOKEN_URI = "https://oauth2.googleapis.com/token";
+var EXPIRY_SKEW_MS = 60 * 1e3;
+var cached = null;
+function hasGoogleOAuthCredentials() {
+  return Boolean(
+    process.env.GBP_CLIENT_ID && process.env.GBP_CLIENT_SECRET && process.env.GBP_REFRESH_TOKEN
+  );
+}
+async function getGoogleOAuthAccessToken() {
+  if (cached && cached.expiresAt > Date.now()) {
+    return cached.accessToken;
+  }
+  if (!hasGoogleOAuthCredentials()) return null;
+  const res = await fetch(TOKEN_URI, {
+    method: "POST",
+    headers: { "Content-Type": "application/x-www-form-urlencoded" },
+    body: new URLSearchParams({
+      client_id: process.env.GBP_CLIENT_ID,
+      client_secret: process.env.GBP_CLIENT_SECRET,
+      refresh_token: process.env.GBP_REFRESH_TOKEN,
+      grant_type: "refresh_token"
+    })
+  });
+  if (!res.ok) {
+    throw new Error(`Google OAuth token refresh failed: ${res.status} ${await res.text()}`);
+  }
+  const data = await res.json();
+  cached = {
+    accessToken: data.access_token,
+    expiresAt: Date.now() + (data.expires_in ?? 3600) * 1e3 - EXPIRY_SKEW_MS
+  };
+  return cached.accessToken;
+}
+
+// src/reviews.ts
+var STAR_VALUES = {
+  ONE: 1,
+  TWO: 2,
+  THREE: 3,
+  FOUR: 4,
+  FIVE: 5
+};
+var MAX_PAGE_SIZE = 50;
+function shuffleArray(arr) {
+  const copy = [...arr];
+  for (let i = copy.length - 1; i > 0; i--) {
+    const j = Math.floor(Math.random() * (i + 1));
+    [copy[i], copy[j]] = [copy[j], copy[i]];
+  }
+  return copy;
+}
+var EMPTY = {
+  averageRating: null,
+  totalReviewCount: 0,
+  reviews: []
+};
+function isBusinessProfileConfigured() {
+  return hasGoogleOAuthCredentials() && Boolean(process.env.GOOGLE_BUSINESS_ACCOUNT_ID) && Boolean(process.env.GOOGLE_BUSINESS_LOCATION_ID);
+}
+function toBusinessReview(r) {
+  const review = {
+    id: r.reviewId,
+    author: r.reviewer?.displayName ?? "Anonymous",
+    authorPhoto: r.reviewer?.profilePhotoUrl,
+    rating: STAR_VALUES[r.starRating ?? "FIVE"] ?? 5,
+    comment: r.comment ?? "",
+    createdAt: r.createTime ?? ""
+  };
+  if (r.reviewReply?.comment) {
+    review.reply = { text: r.reviewReply.comment, updatedAt: r.reviewReply.updateTime ?? "" };
+  }
+  return review;
+}
+async function getBusinessReviews(options = {}) {
+  const { limit, filterMinStars, next } = options;
+  if (!isBusinessProfileConfigured()) return EMPTY;
+  const token = await getGoogleOAuthAccessToken();
+  if (!token) return EMPTY;
+  const account = process.env.GOOGLE_BUSINESS_ACCOUNT_ID;
+  const location = process.env.GOOGLE_BUSINESS_LOCATION_ID;
+  const raw = [];
+  let averageRating;
+  let totalReviewCount;
+  let pageToken;
+  do {
+    const endpoint = `https://mybusiness.googleapis.com/v4/accounts/${account}/locations/${location}/reviews?orderBy=updateTime%20desc&pageSize=${MAX_PAGE_SIZE}` + (pageToken ? `&pageToken=${encodeURIComponent(pageToken)}` : "");
+    const fetchOptions = {
+      headers: { Authorization: `Bearer ${token}` },
+      next: next ?? { revalidate: 3600, tags: ["google-reviews"] }
+    };
+    const res = await fetch(endpoint, fetchOptions);
+    if (!res.ok) {
+      throw new Error(`Business Profile reviews failed: ${res.status} ${await res.text()}`);
+    }
+    const data = await res.json();
+    raw.push(...data.reviews ?? []);
+    averageRating = data.averageRating ?? averageRating;
+    totalReviewCount = data.totalReviewCount ?? totalReviewCount;
+    pageToken = data.nextPageToken;
+  } while (pageToken && (limit === void 0 || raw.length < limit));
+  const reviews = raw.filter((r) => r.comment && r.starRating).filter((r) => filterMinStars === void 0 || STAR_VALUES[r.starRating] >= filterMinStars).map(toBusinessReview).slice(0, limit);
+  return {
+    averageRating: averageRating ?? null,
+    totalReviewCount: totalReviewCount ?? reviews.length,
+    reviews: shuffleArray(reviews)
+  };
+}
+export {
+  getBusinessReviews,
+  getGoogleOAuthAccessToken,
+  hasGoogleOAuthCredentials,
+  isBusinessProfileConfigured
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@domandigital/gbp",
+  "version": "0.3.0",
+  "private": false,
+  "description": "Zero-dependency Google Business Profile client: OAuth refresh-token auth and a reviews (with owner replies) fetch, shared across Doman Digital / IDS client sites.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "prepublishOnly": "pnpm run build"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.9"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "packageManager": "pnpm@9.15.9",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Doman-Digital/dd-gbp.git"
+  },
+  "homepage": "https://github.com/Doman-Digital/dd-gbp#readme",
+  "bugs": {
+    "url": "https://github.com/Doman-Digital/dd-gbp/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}