@aglyn/tenant-feature-instance 1.0.0-beta.143

package/src/lib/hooks/use-user-photo.d.ts

@@ -0,0 +1,50 @@
+/** The avatar on the Firebase Auth record, and only that. */
+export declare function useUserPhotoUrl(): string;
+/**
+ * The avatar on the signed-in user's own profile document, `users/{uid}`
+ * (AGL-1961).
+ *
+ * `photoUrl`, lowercase `url` — that document's spelling deliberately differs
+ * from the roster's `photoURL`, and reading the roster's casing here would
+ * silently yield nothing forever. See `seedUserProfile`, which writes this
+ * field and says the same.
+ */
+export declare function useUserProfilePhotoUrl(): string | undefined;
+/**
+ * The signed-in user's own avatar URL, or nothing (AGL-1683, AGL-1961).
+ *
+ * This used to fall back to `gravatarUrlFromEmail(email)`, so every console
+ * page that showed the account chip sent gravatar.com an MD5 of the signed-in
+ * user's email address along with their IP and a `Referer` naming the console.
+ * An email MD5 is not an anonymisation — a gravatar hash is *designed* to be
+ * looked up by anyone who has seen the address — and Automattic is on no
+ * subprocessor register of ours.
+ *
+ * Worse than the leak itself: `gravatar.url(undefined)` still returns a URL
+ * (the MD5 of the string "undefined"), so this hook never returned a falsy
+ * value and the request fired even for a user with no email resolved yet.
+ * Callers that treat "no photo" as "draw the initial" were unreachable.
+ *
+ * Callers now render initials themselves when this is empty — see
+ * `MemberAvatar` in the console, which is the shared answer for a member's
+ * face. No options: there is nothing left to size.
+ *
+ * THE PROFILE DOCUMENT COMES FIRST, and used not to be read here at all
+ * (AGL-1961). `users/{uid}.photoUrl` is what `seedUserProfile` fills from the
+ * identity provider on EVERY sign-in, and what `user-profiles.ts` calls "the
+ * avatar the console shows for you" — but the app bar resolved the auth
+ * record's `photoURL` alone, and nothing mirrors the document onto the auth
+ * record except an interactive save on Manage Account. So a customer whose
+ * IdP maps a picture attribute had it stored on every sign-in and still saw a
+ * drawn initial in the header, while Manage Account's own card three inches
+ * below showed the photo — it already resolved `photoUrl ?? photoURL`. One
+ * user, two answers.
+ *
+ * Blank-not-null is the join, so a photo that exists in either place wins over
+ * an empty one in the other. That also heals the non-atomic save: Manage
+ * Account writes the document and then calls `updateProfile`, and a failure
+ * between the two used to leave the console showing no avatar for a photo it
+ * had successfully stored.
+ */
+export declare function useUserPhoto(): string | undefined;
+export default useUserPhoto;

package/src/lib/hooks/use-user-photo.js

@@ -0,0 +1,87 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * 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.
+ */ import { doc } from "firebase/firestore";
+import { useFirestore, useUser } from "./firebase/firebase-services.js";
+import { useFirestoreDoc } from "./use-firestore-doc.js";
+/** The avatar on the Firebase Auth record, and only that. */ export function useUserPhotoUrl() {
+    const { data } = useUser();
+    return data == null ? void 0 : data.photoURL;
+}
+/**
+ * The avatar on the signed-in user's own profile document, `users/{uid}`
+ * (AGL-1961).
+ *
+ * `photoUrl`, lowercase `url` — that document's spelling deliberately differs
+ * from the roster's `photoURL`, and reading the roster's casing here would
+ * silently yield nothing forever. See `seedUserProfile`, which writes this
+ * field and says the same.
+ */ export function useUserProfilePhotoUrl() {
+    var _ref;
+    const firestore = useFirestore();
+    const { data: user } = useUser();
+    const uid = user == null ? void 0 : user.uid;
+    const { data } = useFirestoreDoc(// Null ref until a uid exists, so a signed-out mount opens no listen at
+    // all rather than one the rules refuse.
+    ()=>uid ? doc(firestore, 'users', uid) : null, [
+        firestore,
+        uid
+    ]);
+    const stored = String((_ref = data == null ? void 0 : data.photoUrl) != null ? _ref : '').trim();
+    return stored || undefined;
+}
+/**
+ * The signed-in user's own avatar URL, or nothing (AGL-1683, AGL-1961).
+ *
+ * This used to fall back to `gravatarUrlFromEmail(email)`, so every console
+ * page that showed the account chip sent gravatar.com an MD5 of the signed-in
+ * user's email address along with their IP and a `Referer` naming the console.
+ * An email MD5 is not an anonymisation — a gravatar hash is *designed* to be
+ * looked up by anyone who has seen the address — and Automattic is on no
+ * subprocessor register of ours.
+ *
+ * Worse than the leak itself: `gravatar.url(undefined)` still returns a URL
+ * (the MD5 of the string "undefined"), so this hook never returned a falsy
+ * value and the request fired even for a user with no email resolved yet.
+ * Callers that treat "no photo" as "draw the initial" were unreachable.
+ *
+ * Callers now render initials themselves when this is empty — see
+ * `MemberAvatar` in the console, which is the shared answer for a member's
+ * face. No options: there is nothing left to size.
+ *
+ * THE PROFILE DOCUMENT COMES FIRST, and used not to be read here at all
+ * (AGL-1961). `users/{uid}.photoUrl` is what `seedUserProfile` fills from the
+ * identity provider on EVERY sign-in, and what `user-profiles.ts` calls "the
+ * avatar the console shows for you" — but the app bar resolved the auth
+ * record's `photoURL` alone, and nothing mirrors the document onto the auth
+ * record except an interactive save on Manage Account. So a customer whose
+ * IdP maps a picture attribute had it stored on every sign-in and still saw a
+ * drawn initial in the header, while Manage Account's own card three inches
+ * below showed the photo — it already resolved `photoUrl ?? photoURL`. One
+ * user, two answers.
+ *
+ * Blank-not-null is the join, so a photo that exists in either place wins over
+ * an empty one in the other. That also heals the non-atomic save: Manage
+ * Account writes the document and then calls `updateProfile`, and a failure
+ * between the two used to leave the console showing no avatar for a photo it
+ * had successfully stored.
+ */ export function useUserPhoto() {
+    const profilePhoto = useUserProfilePhotoUrl();
+    const authPhoto = useUserPhotoUrl();
+    return profilePhoto || String(authPhoto != null ? authPhoto : '').trim() || undefined;
+}
+export default useUserPhoto;
+
+//# sourceMappingURL=use-user-photo.js.map

package/src/lib/hooks/use-user-photo.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../../libs/tenant/feature/instance/src/lib/hooks/use-user-photo.tsx"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { doc } from 'firebase/firestore'\nimport { useFirestore, useUser } from './firebase/firebase-services'\nimport { useFirestoreDoc } from './use-firestore-doc'\n\n/** The avatar on the Firebase Auth record, and only that. */\nexport function useUserPhotoUrl() {\n  const { data } = useUser()\n  return data?.photoURL\n}\n\n/**\n * The avatar on the signed-in user's own profile document, `users/{uid}`\n * (AGL-1961).\n *\n * `photoUrl`, lowercase `url` — that document's spelling deliberately differs\n * from the roster's `photoURL`, and reading the roster's casing here would\n * silently yield nothing forever. See `seedUserProfile`, which writes this\n * field and says the same.\n */\nexport function useUserProfilePhotoUrl(): string | undefined {\n  const firestore = useFirestore()\n  const { data: user } = useUser()\n  const uid = user?.uid\n  const { data } = useFirestoreDoc<{ photoUrl?: string }>(\n    // Null ref until a uid exists, so a signed-out mount opens no listen at\n    // all rather than one the rules refuse.\n    () => (uid ? doc(firestore, 'users', uid) : null),\n    [firestore, uid],\n  )\n  const stored = String(data?.photoUrl ?? '').trim()\n  return stored || undefined\n}\n\n/**\n * The signed-in user's own avatar URL, or nothing (AGL-1683, AGL-1961).\n *\n * This used to fall back to `gravatarUrlFromEmail(email)`, so every console\n * page that showed the account chip sent gravatar.com an MD5 of the signed-in\n * user's email address along with their IP and a `Referer` naming the console.\n * An email MD5 is not an anonymisation — a gravatar hash is *designed* to be\n * looked up by anyone who has seen the address — and Automattic is on no\n * subprocessor register of ours.\n *\n * Worse than the leak itself: `gravatar.url(undefined)` still returns a URL\n * (the MD5 of the string \"undefined\"), so this hook never returned a falsy\n * value and the request fired even for a user with no email resolved yet.\n * Callers that treat \"no photo\" as \"draw the initial\" were unreachable.\n *\n * Callers now render initials themselves when this is empty — see\n * `MemberAvatar` in the console, which is the shared answer for a member's\n * face. No options: there is nothing left to size.\n *\n * THE PROFILE DOCUMENT COMES FIRST, and used not to be read here at all\n * (AGL-1961). `users/{uid}.photoUrl` is what `seedUserProfile` fills from the\n * identity provider on EVERY sign-in, and what `user-profiles.ts` calls \"the\n * avatar the console shows for you\" — but the app bar resolved the auth\n * record's `photoURL` alone, and nothing mirrors the document onto the auth\n * record except an interactive save on Manage Account. So a customer whose\n * IdP maps a picture attribute had it stored on every sign-in and still saw a\n * drawn initial in the header, while Manage Account's own card three inches\n * below showed the photo — it already resolved `photoUrl ?? photoURL`. One\n * user, two answers.\n *\n * Blank-not-null is the join, so a photo that exists in either place wins over\n * an empty one in the other. That also heals the non-atomic save: Manage\n * Account writes the document and then calls `updateProfile`, and a failure\n * between the two used to leave the console showing no avatar for a photo it\n * had successfully stored.\n */\nexport function useUserPhoto(): string | undefined {\n  const profilePhoto = useUserProfilePhotoUrl()\n  const authPhoto = useUserPhotoUrl()\n  return profilePhoto || String(authPhoto ?? '').trim() || undefined\n}\n\nexport default useUserPhoto\n"],"names":["doc","useFirestore","useUser","useFirestoreDoc","useUserPhotoUrl","data","photoURL","useUserProfilePhotoUrl","firestore","user","uid","stored","String","photoUrl","trim","undefined","useUserPhoto","profilePhoto","authPhoto"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GACD,SAASA,GAAG,QAAQ,qBAAoB;AACxC,SAASC,YAAY,EAAEC,OAAO,QAAQ,kCAA8B;AACpE,SAASC,eAAe,QAAQ,yBAAqB;AAErD,2DAA2D,GAC3D,OAAO,SAASC;IACd,MAAM,EAAEC,IAAI,EAAE,GAAGH;IACjB,OAAOG,wBAAAA,KAAMC,QAAQ;AACvB;AAEA;;;;;;;;CAQC,GACD,OAAO,SAASC;;IACd,MAAMC,YAAYP;IAClB,MAAM,EAAEI,MAAMI,IAAI,EAAE,GAAGP;IACvB,MAAMQ,MAAMD,wBAAAA,KAAMC,GAAG;IACrB,MAAM,EAAEL,IAAI,EAAE,GAAGF,gBACf,wEAAwE;IACxE,wCAAwC;IACxC,IAAOO,MAAMV,IAAIQ,WAAW,SAASE,OAAO,MAC5C;QAACF;QAAWE;KAAI;IAElB,MAAMC,SAASC,eAAOP,wBAAAA,KAAMQ,QAAQ,mBAAI,IAAIC,IAAI;IAChD,OAAOH,UAAUI;AACnB;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmCC,GACD,OAAO,SAASC;IACd,MAAMC,eAAeV;IACrB,MAAMW,YAAYd;IAClB,OAAOa,gBAAgBL,OAAOM,oBAAAA,YAAa,IAAIJ,IAAI,MAAMC;AAC3D;AAEA,eAAeC,aAAY"}

package/src/lib/tenant.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * 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.
+ */
+export * from './constants/mock-data';
+export * from './constants/site-paths';
+export * from './constants/firebase-config';
+export * from './constants/firebase-emulator-hosts';
+export * from './hooks/firebase/auth-persistence';
+export * from './hooks/firebase/firebase-services';
+export * from './hooks/firebase/firestore-cache';
+export * from './hooks/helpers/use-doc';
+export * from './hooks/helpers/use-modify-doc-callback';
+export * from './hooks/helpers/besigner-nodes-converter';
+export * from './hooks/helpers/guarded-nodes-save';
+export * from './hooks/helpers/guarded-seed-write';
+export * from './hooks/firestore-denial-reporter';
+export * from './hooks/use-firestore-collection';
+export * from './hooks/use-paged-collection';
+export * from './hooks/use-sorted-paged-collection';
+export * from './hooks/sorted-collection-window';
+export * from './hooks/host-collection-queries';
+export * from './hooks/list-filter-constraints';
+export * from './hooks/use-firestore-doc';
+export * from './hooks/use-switcher-collection';
+export * from './hooks/use-host-activity-logger';
+export * from './hooks/use-live-artifact-count';
+export * from './hooks/use-component';
+export * from './hooks/use-component-version';
+export * from './hooks/use-form-version';
+export * from './hooks/use-host-template';
+export * from './hooks/use-console-host-route';
+export * from './hooks/use-host-org-id';
+export * from './hooks/use-host-campaigns';
+export * from './hooks/use-org-member-options';
+export * from './hooks/use-org-plan';
+export * from './hooks/use-scope-tokens';
+export * from './hooks/use-host-resource-api';
+export * from './hooks/use-host-version-api';
+export * from './hooks/use-duplicate-resource-api';
+export * from './components/duplicate-resource-dialog';
+export * from './hooks/use-plugin-config';
+export * from './hooks/use-host';
+export * from './hooks/use-layout';
+export * from './hooks/use-layout-version';
+export * from './hooks/use-screen';
+export * from './hooks/use-screen-version';
+export * from './hooks/use-user-name';
+export * from './hooks/use-user-photo';

package/src/lib/tenant.js

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2022 Aglyn LLC
+ *
+ * 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.
+ */ export * from "./constants/mock-data.js";
+export * from "./constants/site-paths.js";
+export * from "./constants/firebase-config.js";
+export * from "./constants/firebase-emulator-hosts.js";
+export * from "./hooks/firebase/auth-persistence.js";
+export * from "./hooks/firebase/firebase-services.js";
+export * from "./hooks/firebase/firestore-cache.js";
+export * from "./hooks/helpers/use-doc.js";
+export * from "./hooks/helpers/use-modify-doc-callback.js";
+export * from "./hooks/helpers/besigner-nodes-converter.js";
+export * from "./hooks/helpers/guarded-nodes-save.js";
+export * from "./hooks/helpers/guarded-seed-write.js";
+export * from "./hooks/firestore-denial-reporter.js";
+export * from "./hooks/use-firestore-collection.js";
+export * from "./hooks/use-paged-collection.js";
+export * from "./hooks/use-sorted-paged-collection.js";
+export * from "./hooks/sorted-collection-window.js";
+export * from "./hooks/host-collection-queries.js";
+export * from "./hooks/list-filter-constraints.js";
+export * from "./hooks/use-firestore-doc.js";
+export * from "./hooks/use-switcher-collection.js";
+export * from "./hooks/use-host-activity-logger.js";
+export * from "./hooks/use-live-artifact-count.js";
+export * from "./hooks/use-component.js";
+export * from "./hooks/use-component-version.js";
+export * from "./hooks/use-form-version.js";
+export * from "./hooks/use-host-template.js";
+export * from "./hooks/use-console-host-route.js";
+export * from "./hooks/use-host-org-id.js";
+export * from "./hooks/use-host-campaigns.js";
+export * from "./hooks/use-org-member-options.js";
+export * from "./hooks/use-org-plan.js";
+export * from "./hooks/use-scope-tokens.js";
+export * from "./hooks/use-host-resource-api.js";
+export * from "./hooks/use-host-version-api.js";
+export * from "./hooks/use-duplicate-resource-api.js";
+export * from "./components/duplicate-resource-dialog.js";
+export * from "./hooks/use-plugin-config.js";
+export * from "./hooks/use-host.js";
+export * from "./hooks/use-layout.js";
+export * from "./hooks/use-layout-version.js";
+export * from "./hooks/use-screen.js";
+export * from "./hooks/use-screen-version.js";
+export * from "./hooks/use-user-name.js";
+export * from "./hooks/use-user-photo.js";
+
+//# sourceMappingURL=tenant.js.map

package/src/lib/tenant.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/tenant/feature/instance/src/lib/tenant.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2022 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nexport * from './constants/mock-data'\nexport * from './constants/site-paths'\nexport * from './constants/firebase-config'\nexport * from './constants/firebase-emulator-hosts'\n\nexport * from './hooks/firebase/auth-persistence'\nexport * from './hooks/firebase/firebase-services'\nexport * from './hooks/firebase/firestore-cache'\nexport * from './hooks/helpers/use-doc'\nexport * from './hooks/helpers/use-modify-doc-callback'\nexport * from './hooks/helpers/besigner-nodes-converter'\nexport * from './hooks/helpers/guarded-nodes-save'\nexport * from './hooks/helpers/guarded-seed-write'\n\nexport * from './hooks/firestore-denial-reporter'\nexport * from './hooks/use-firestore-collection'\nexport * from './hooks/use-paged-collection'\nexport * from './hooks/use-sorted-paged-collection'\nexport * from './hooks/sorted-collection-window'\nexport * from './hooks/host-collection-queries'\nexport * from './hooks/list-filter-constraints'\nexport * from './hooks/use-firestore-doc'\nexport * from './hooks/use-switcher-collection'\nexport * from './hooks/use-host-activity-logger'\nexport * from './hooks/use-live-artifact-count'\nexport * from './hooks/use-component'\nexport * from './hooks/use-component-version'\nexport * from './hooks/use-form-version'\nexport * from './hooks/use-host-template'\nexport * from './hooks/use-console-host-route'\nexport * from './hooks/use-host-org-id'\nexport * from './hooks/use-host-campaigns'\nexport * from './hooks/use-org-member-options'\nexport * from './hooks/use-org-plan'\nexport * from './hooks/use-scope-tokens'\nexport * from './hooks/use-host-resource-api'\nexport * from './hooks/use-host-version-api'\nexport * from './hooks/use-duplicate-resource-api'\nexport * from './components/duplicate-resource-dialog'\nexport * from './hooks/use-plugin-config'\nexport * from './hooks/use-host'\nexport * from './hooks/use-layout'\nexport * from './hooks/use-layout-version'\nexport * from './hooks/use-screen'\nexport * from './hooks/use-screen-version'\nexport * from './hooks/use-user-name'\nexport * from './hooks/use-user-photo'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,cAAc,2BAAuB;AACrC,cAAc,4BAAwB;AACtC,cAAc,iCAA6B;AAC3C,cAAc,yCAAqC;AAEnD,cAAc,uCAAmC;AACjD,cAAc,wCAAoC;AAClD,cAAc,sCAAkC;AAChD,cAAc,6BAAyB;AACvC,cAAc,6CAAyC;AACvD,cAAc,8CAA0C;AACxD,cAAc,wCAAoC;AAClD,cAAc,wCAAoC;AAElD,cAAc,uCAAmC;AACjD,cAAc,sCAAkC;AAChD,cAAc,kCAA8B;AAC5C,cAAc,yCAAqC;AACnD,cAAc,sCAAkC;AAChD,cAAc,qCAAiC;AAC/C,cAAc,qCAAiC;AAC/C,cAAc,+BAA2B;AACzC,cAAc,qCAAiC;AAC/C,cAAc,sCAAkC;AAChD,cAAc,qCAAiC;AAC/C,cAAc,2BAAuB;AACrC,cAAc,mCAA+B;AAC7C,cAAc,8BAA0B;AACxC,cAAc,+BAA2B;AACzC,cAAc,oCAAgC;AAC9C,cAAc,6BAAyB;AACvC,cAAc,gCAA4B;AAC1C,cAAc,oCAAgC;AAC9C,cAAc,0BAAsB;AACpC,cAAc,8BAA0B;AACxC,cAAc,mCAA+B;AAC7C,cAAc,kCAA8B;AAC5C,cAAc,wCAAoC;AAClD,cAAc,4CAAwC;AACtD,cAAc,+BAA2B;AACzC,cAAc,sBAAkB;AAChC,cAAc,wBAAoB;AAClC,cAAc,gCAA4B;AAC1C,cAAc,wBAAoB;AAClC,cAAc,gCAA4B;AAC1C,cAAc,2BAAuB;AACrC,cAAc,4BAAwB"}