@singi-labs/sifa-sdk 0.12.59 → 0.12.61

package/dist/jsonld/index.d.cts

@@ -78,6 +78,13 @@ interface JsonLdOptions {
     readonly baseUrl?: string;
     /** Applied to every user-authored string. Defaults to identity. */
     readonly sanitize?: Sanitizer;
+    /**
+     * Absolute URL of the page this graph describes, used for `url` and `@id`.
+     * Defaults to `${baseUrl}/p/${handle}`. Personal sites can be served from an
+     * arbitrary host, including a self-hosted custom domain, where that default
+     * path is not where the page lives.
+     */
+    readonly canonicalUrl?: string;
 }
 /**
  * Structural input for the emitters.
@@ -117,6 +124,16 @@ interface JsonLdProfileInput {
     readonly publications?: readonly unknown[];
     readonly courses?: readonly unknown[];
     readonly externalAccounts?: readonly unknown[];
+    /**
+     * Dual-facet accounts: one DID presenting as both a person and a company.
+     * Only the opted-in case is emitted, see `buildPersonJsonLd`.
+     */
+    readonly org?: {
+        readonly personalProfileVisible?: boolean;
+        readonly orgProfile?: {
+            readonly name?: string;
+        } | null;
+    } | null;
 }
 interface Hideable {
     readonly hidden?: boolean;
@@ -192,7 +209,11 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
         '@type': "EducationalOrganization";
         name: string;
     }[] | undefined;
-    worksFor?: {
+    worksFor?: ({
+        '@type': "Organization";
+        '@id': string;
+        name: string;
+    } | {
         member?: {
             endDate?: string | undefined;
             startDate?: string | undefined;
@@ -201,7 +222,7 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
         } | undefined;
         '@type': "Organization";
         name: string;
-    }[] | undefined;
+    })[] | undefined;
     homeLocation?: {
         address?: {
             addressCountry?: string | undefined;
@@ -213,12 +234,14 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
     } | undefined;
     jobTitle: string | undefined;
     description: string | undefined;
+    alternateName: string;
     url: string;
     image: string | undefined;
     familyName?: string | undefined;
     givenName?: string | undefined;
     '@context': string;
     '@type': string;
+    '@id': string;
     name: string;
 };
 declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: JsonLdOptions): {
@@ -263,7 +286,11 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
             '@type': "EducationalOrganization";
             name: string;
         }[] | undefined;
-        worksFor?: {
+        worksFor?: ({
+            '@type': "Organization";
+            '@id': string;
+            name: string;
+        } | {
             member?: {
                 endDate?: string | undefined;
                 startDate?: string | undefined;
@@ -272,7 +299,7 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
             } | undefined;
             '@type': "Organization";
             name: string;
-        }[] | undefined;
+        })[] | undefined;
         homeLocation?: {
             address?: {
                 addressCountry?: string | undefined;
@@ -284,11 +311,13 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
         } | undefined;
         jobTitle: string | undefined;
         description: string | undefined;
+        alternateName: string;
         url: string;
         image: string | undefined;
         familyName?: string | undefined;
         givenName?: string | undefined;
         '@type': string;
+        '@id': string;
         name: string;
     };
     dateModified?: string | undefined;

package/dist/jsonld/index.d.ts

@@ -78,6 +78,13 @@ interface JsonLdOptions {
     readonly baseUrl?: string;
     /** Applied to every user-authored string. Defaults to identity. */
     readonly sanitize?: Sanitizer;
+    /**
+     * Absolute URL of the page this graph describes, used for `url` and `@id`.
+     * Defaults to `${baseUrl}/p/${handle}`. Personal sites can be served from an
+     * arbitrary host, including a self-hosted custom domain, where that default
+     * path is not where the page lives.
+     */
+    readonly canonicalUrl?: string;
 }
 /**
  * Structural input for the emitters.
@@ -117,6 +124,16 @@ interface JsonLdProfileInput {
     readonly publications?: readonly unknown[];
     readonly courses?: readonly unknown[];
     readonly externalAccounts?: readonly unknown[];
+    /**
+     * Dual-facet accounts: one DID presenting as both a person and a company.
+     * Only the opted-in case is emitted, see `buildPersonJsonLd`.
+     */
+    readonly org?: {
+        readonly personalProfileVisible?: boolean;
+        readonly orgProfile?: {
+            readonly name?: string;
+        } | null;
+    } | null;
 }
 interface Hideable {
     readonly hidden?: boolean;
@@ -192,7 +209,11 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
         '@type': "EducationalOrganization";
         name: string;
     }[] | undefined;
-    worksFor?: {
+    worksFor?: ({
+        '@type': "Organization";
+        '@id': string;
+        name: string;
+    } | {
         member?: {
             endDate?: string | undefined;
             startDate?: string | undefined;
@@ -201,7 +222,7 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
         } | undefined;
         '@type': "Organization";
         name: string;
-    }[] | undefined;
+    })[] | undefined;
     homeLocation?: {
         address?: {
             addressCountry?: string | undefined;
@@ -213,12 +234,14 @@ declare function buildPersonJsonLd(profile: JsonLdProfileInput, options?: JsonLd
     } | undefined;
     jobTitle: string | undefined;
     description: string | undefined;
+    alternateName: string;
     url: string;
     image: string | undefined;
     familyName?: string | undefined;
     givenName?: string | undefined;
     '@context': string;
     '@type': string;
+    '@id': string;
     name: string;
 };
 declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: JsonLdOptions): {
@@ -263,7 +286,11 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
             '@type': "EducationalOrganization";
             name: string;
         }[] | undefined;
-        worksFor?: {
+        worksFor?: ({
+            '@type': "Organization";
+            '@id': string;
+            name: string;
+        } | {
             member?: {
                 endDate?: string | undefined;
                 startDate?: string | undefined;
@@ -272,7 +299,7 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
             } | undefined;
             '@type': "Organization";
             name: string;
-        }[] | undefined;
+        })[] | undefined;
         homeLocation?: {
             address?: {
                 addressCountry?: string | undefined;
@@ -284,11 +311,13 @@ declare function buildProfilePageJsonLd(profile: JsonLdProfileInput, options?: J
         } | undefined;
         jobTitle: string | undefined;
         description: string | undefined;
+        alternateName: string;
         url: string;
         image: string | undefined;
         familyName?: string | undefined;
         givenName?: string | undefined;
         '@type': string;
+        '@id': string;
         name: string;
     };
     dateModified?: string | undefined;

package/dist/jsonld/index.js

@@ -561,6 +561,7 @@ function buildHomeLocation(location, s) {
 function buildPersonJsonLd(profile, options = {}) {
   const s = options.sanitize ?? identity;
   const baseUrl = normaliseBaseUrl(options.baseUrl);
+  const canonical = options.canonicalUrl ?? `${baseUrl}/p/${profile.handle}`;
   const positions = visible(profile.positions);
   const currentPosition = pickPrimaryPosition(positions);
   const knowsAbout = rankKnowsAbout(profile.skills, s);
@@ -589,33 +590,43 @@ function buildPersonJsonLd(profile, options = {}) {
   const givenTrimmed = profile.givenName?.trim();
   const familyTrimmed = profile.familyName?.trim();
   const structuredName = givenTrimmed && familyTrimmed ? `${givenTrimmed} ${familyTrimmed}` : void 0;
+  const ownCompany = profile.org?.personalProfileVisible && profile.org.orgProfile ? {
+    "@type": "Organization",
+    "@id": `${baseUrl}/c/${profile.handle}`,
+    name: s(profile.org.orgProfile.name ?? profile.handle)
+  } : null;
+  const worksFor = [
+    ...ownCompany ? [ownCompany] : [],
+    ...positions.filter((p) => p.company).map((p) => ({
+      "@type": "Organization",
+      name: s(p.company),
+      ...p.title && {
+        member: {
+          "@type": "OrganizationRole",
+          roleName: s(p.title),
+          ...p.startedAt && { startDate: p.startedAt },
+          ...p.endedAt && { endDate: p.endedAt }
+        }
+      }
+    }))
+  ];
   const awards = visible(profile.honors).filter((h) => h.title).map((h) => s(h.title));
   const languages = visible(profile.languages).filter((l) => l.language).map((l) => l.language);
   return {
     "@context": "https://schema.org",
     "@type": "Person",
+    // Stable identifier so a /c/ Organization's `founder` can point back here.
+    "@id": canonical,
     name: s(structuredName ?? profile.displayName ?? profile.handle),
     ...givenTrimmed && { givenName: s(givenTrimmed) },
     ...familyTrimmed && { familyName: s(familyTrimmed) },
     jobTitle: hasMeaningfulText(profile.headline) ? s(profile.headline) : currentPosition?.title ? s(currentPosition.title) : void 0,
     description: hasMeaningfulText(profile.about) ? s(profile.about) : void 0,
-    url: `${baseUrl}/p/${profile.handle}`,
+    alternateName: `@${profile.handle}`,
+    url: canonical,
     image: profile.avatar ?? void 0,
     ...profile.location && { homeLocation: buildHomeLocation(profile.location, s) },
-    ...positions.length > 0 && {
-      worksFor: positions.filter((p) => p.company).map((p) => ({
-        "@type": "Organization",
-        name: s(p.company),
-        ...p.title && {
-          member: {
-            "@type": "OrganizationRole",
-            roleName: s(p.title),
-            ...p.startedAt && { startDate: p.startedAt },
-            ...p.endedAt && { endDate: p.endedAt }
-          }
-        }
-      }))
-    },
+    ...worksFor.length > 0 && { worksFor },
     ...visible(profile.education).length > 0 && {
       alumniOf: visible(profile.education).filter((e) => e.institution).map((e) => ({ "@type": "EducationalOrganization", name: s(e.institution) }))
     },
@@ -667,7 +678,7 @@ var PROFILE_SECTION_HAS_PART = [
 function buildProfilePageJsonLd(profile, options = {}) {
   const person = buildPersonJsonLd(profile, options);
   const { "@context": _context, ...personWithoutContext } = person;
-  const url = `${normaliseBaseUrl(options.baseUrl)}/p/${profile.handle}`;
+  const url = options.canonicalUrl ?? `${normaliseBaseUrl(options.baseUrl)}/p/${profile.handle}`;
   const hasPart = PROFILE_SECTION_HAS_PART.filter((section) => section.populated(profile)).map(
     (section) => ({
       "@type": "WebPageElement",