@singi-labs/sifa-sdk 0.12.50 → 0.12.52

package/dist/{adult-content-BUgP8bpf.d.ts → types-CmS4Argp.d.ts}

@@ -333,6 +333,10 @@ interface ProfileInvolvement {
      */
     legacy?: boolean;
     hidden?: boolean;
+    /** Other people named on this involvement, hydrated from the stored DIDs. */
+    collaborators?: ProjectMemberCard[];
+    /** AT-URI of the same involvement as recorded on another person's profile. */
+    sameAs?: string;
 }
 type LanguageProficiency = 'elementary' | 'limited_working' | 'professional_working' | 'full_professional' | 'native';
 interface ProfileLanguage {
@@ -848,6 +852,10 @@ interface InvolvementView {
     endedAt?: string;
     links: InvolvementLinkView[];
     legacy: boolean;
+    /** Other people named on this involvement, hydrated from the stored DIDs. */
+    collaborators?: ProjectMemberView[];
+    /** AT-URI of the same involvement as recorded on another person's profile. */
+    sameAs?: string;
 }
 interface ContributorView {
     name: string;
@@ -1062,4 +1070,148 @@ declare function hasAdultContent(item: {
     labels?: ActivityLabel[];
 }): boolean;
 
-export { type ProfileInvolvementLink as $, type AdultContentLabel as A, type ExternalAccountKeytraceClaim as B, type CoSpeaker as C, type DurationView as D, type ExternalAccount as E, type ExternalAccountView as F, type FeedItem as G, type HonorView as H, type IndustryDomain as I, type InvolvementLinkView as J, type InvolvementView as K, type LocationValue as L, type LanguageProficiency as M, type LanguageView as N, type OrgAddressView as O, type ProfileView as P, type OrgFloorVerdict as Q, type OrgLinkView as R, type SkillSuggestion as S, type OrgProfileView as T, PROJECT_ROLES as U, type PositionView as V, type PresentationDeliveryView as W, type PresentationLinkView as X, type PresentationView as Y, type ProfileCourse as Z, type ProfileIndustry as _, type ActivityLabel as a, type ProfileLocation as a0, type ProfileLocationView as a1, type ProfileOverrideSource as a2, type ProfilePresentation as a3, type ProfileVolunteering as a4, type ProjectMemberCard as a5, type ProjectMemberView as a6, type ProjectRole as a7, type ProjectView as a8, type PublicationContributor as a9, type PublicationView as aa, type RecognizedEntity as ab, type SkillRef as ac, type SkillView as ad, type TrustStat as ae, type VerifiedAccount as af, type VolunteeringView as ag, hasAdultContent as ah, type ProfileSkill as b, type ProfilePresentationDelivery as c, type PdsProviderInfo as d, type Profile as e, type AccountFacetMode as f, type ProfilePosition as g, type ProfileCertification as h, type ProfileEducation as i, type ProfileHonor as j, type ProfileLanguage as k, type ProfileProject as l, type ProfilePublication as m, type ProfileInvolvement as n, ADULT_CONTENT_LABELS as o, type ActiveApp as p, type ActiveAppView as q, type ActorCard as r, type AtfundLinkView as s, type CertificationView as t, type CoSpeakerView as u, type ContributorView as v, type CourseView as w, type EducationView as x, type Endorsement as y, type EndorsementData as z };
+/**
+ * The buckets a repo data-management UI shows instead of raw collections.
+ *
+ * "id.sifa.profile.presentationDelivery" means nothing to someone who has never
+ * heard of a lexicon. Grouping is the whole difference between a developer tool
+ * and something a user can act on, so it lives here rather than in one app: the
+ * web settings page and a future native app must agree on what a bucket holds,
+ * or the same repo reads differently depending where you look at it.
+ *
+ * Ids only, no display strings -- copy is translated at the surface.
+ */
+type RepoGroupId = 'profile-basics' | 'work-history' | 'education' | 'skills-endorsements' | 'projects' | 'publications-talks' | 'connections' | 'consents-access' | 'other';
+interface RepoGroupDefinition {
+    id: RepoGroupId;
+    /** Collections this bucket claims, in the order a UI should list them. */
+    collections: readonly string[];
+}
+/**
+ * Ordered so the buckets a user recognises come first and the machinery they
+ * never think about (consents, access grants) comes last.
+ *
+ * `other` is deliberately absent: it is not a claim over a fixed set, it is
+ * where anything unmapped lands. See {@link repoGroupForCollection}.
+ */
+declare const SIFA_REPO_GROUPS: readonly RepoGroupDefinition[];
+/**
+ * Which bucket a collection belongs to, or `other` when we have not mapped it.
+ *
+ * Unmapped falls through to a visible bucket rather than being filtered out. A
+ * lexicon we mint later would otherwise be invisible on the one page whose job
+ * is to show everything in the repo -- the user would be told their data is
+ * accounted for while some of it was silently omitted.
+ */
+declare function repoGroupForCollection(collection: string): RepoGroupId;
+
+/**
+ * One line of text identifying a record to the person who wrote it.
+ *
+ * Split into parts rather than one joined string: joining needs a connective
+ * ("Senior Engineer at Acme") and a connective is copy, which is translated at
+ * the surface. Every value here comes straight from the user's own record, so
+ * the SDK contributes no language of its own.
+ */
+interface RepoRecordLabel {
+    /** The record's own identifying text, or the collection leaf when it has none. */
+    primary: string;
+    /** Employer, institution, event, or publisher, when the record names one. */
+    secondary?: string;
+    /** The date the record is about, not when it was written. May be partial ("2021-03"). */
+    date?: string;
+    /**
+     * The person a record is about, for records whose meaning is a relationship
+     * rather than text: endorsements, follows, confirmations, attestations.
+     *
+     * Kept out of {@link primary} so a surface can resolve it to a handle and
+     * avatar without parsing a DID back out of display text.
+     */
+    subjectDid?: string;
+}
+/**
+ * Describe one record from the user's repo in terms they will recognise.
+ *
+ * Never throws and never returns an empty primary. This runs over whatever is
+ * actually in the repo, including records written by older versions of Sifa and
+ * records hand-edited elsewhere. A page that crashes on one malformed record
+ * would hide the rest, which is exactly the data the user came to manage.
+ */
+declare function describeSifaRecord(collection: string, value: unknown): RepoRecordLabel;
+
+/** One record in the user's repo, reduced to what a management UI needs. */
+interface RepoRecordSummary {
+    /** Full AT-URI, the stable identity of the record. */
+    uri: string;
+    /** Record key, the part a delete request names. */
+    rkey: string;
+    collection: string;
+    label: RepoRecordLabel;
+    /** When the record was written, from its own `createdAt`. Absent if it has none. */
+    createdAt?: string;
+}
+/** One bucket of the inventory. Buckets the user has no records in are omitted. */
+interface RepoCollectionGroup {
+    id: RepoGroupId;
+    /** Collections in this bucket the user actually has records in. */
+    collections: string[];
+    recordCount: number;
+    records: RepoRecordSummary[];
+}
+/**
+ * What is in the user's repo under id.sifa.*, as their PDS reports it.
+ *
+ * Read from the PDS rather than the AppView. This is the one surface whose
+ * entire purpose is to say what the user owns, so an index that has drifted --
+ * lagging the firehose, or holding records deleted elsewhere -- would be
+ * lying about the thing the page exists to answer.
+ */
+interface RepoInventory {
+    did: string;
+    /** When the PDS was read, so a UI can say how fresh this is. */
+    fetchedAt: string;
+    groups: RepoCollectionGroup[];
+    totalRecords: number;
+    /**
+     * Collections found in the repo that could not be listed. Their records are
+     * missing from `groups`, so a UI must not present the inventory as complete.
+     */
+    unreadableCollections?: string[];
+}
+/** What happened to one record in a delete request. */
+type RepoDeleteOutcome = 
+/** The PDS confirmed the record is gone. */
+'deleted'
+/** The delete was attempted and the record is still there. */
+ | 'remaining'
+/** We could not establish either way. Not the same as `remaining`, and never success. */
+ | 'unknown';
+interface RepoDeleteRecordResult {
+    rkey: string;
+    outcome: RepoDeleteOutcome;
+}
+/**
+ * Result of a delete request.
+ *
+ * Carries no success flag of its own. The transport adds one meaning "the
+ * request was accepted", which is not the same question: a request can be
+ * accepted and still leave four of five records in place. What actually
+ * happened to the data is in `results`, per record, and callers report that.
+ */
+interface RepoDeleteResult {
+    collection: string;
+    results: RepoDeleteRecordResult[];
+    /**
+     * Set when the current OAuth grant cannot delete this collection, in which
+     * case nothing was attempted. `scope` is the value to request.
+     *
+     * Present instead of a failure so a UI sends the user to consent rather than
+     * telling them the delete failed for no stated reason.
+     */
+    needsScopeUpgrade?: {
+        scope: string;
+        collections: string[];
+    };
+}
+
+export { type ProfileCourse as $, type AdultContentLabel as A, type EndorsementData as B, type CoSpeaker as C, type DurationView as D, type ExternalAccount as E, type ExternalAccountKeytraceClaim as F, type ExternalAccountView as G, type FeedItem as H, type HonorView as I, type IndustryDomain as J, type InvolvementLinkView as K, type LocationValue as L, type InvolvementView as M, type LanguageProficiency as N, type LanguageView as O, type ProfileView as P, type OrgAddressView as Q, type RepoDeleteResult as R, type SkillSuggestion as S, type OrgFloorVerdict as T, type OrgLinkView as U, type OrgProfileView as V, PROJECT_ROLES as W, type PositionView as X, type PresentationDeliveryView as Y, type PresentationLinkView as Z, type PresentationView as _, type ActivityLabel as a, type ProfileIndustry as a0, type ProfileInvolvementLink as a1, type ProfileLocation as a2, type ProfileLocationView as a3, type ProfileOverrideSource as a4, type ProfilePresentation as a5, type ProfileVolunteering as a6, type ProjectMemberCard as a7, type ProjectMemberView as a8, type ProjectRole as a9, type ProjectView as aa, type PublicationContributor as ab, type PublicationView as ac, type RecognizedEntity as ad, type RepoCollectionGroup as ae, type RepoDeleteOutcome as af, type RepoDeleteRecordResult as ag, type RepoGroupDefinition as ah, type RepoGroupId as ai, type RepoRecordLabel as aj, type RepoRecordSummary as ak, SIFA_REPO_GROUPS as al, type SkillRef as am, type SkillView as an, type TrustStat as ao, type VerifiedAccount as ap, type VolunteeringView as aq, describeSifaRecord as ar, hasAdultContent as as, repoGroupForCollection as at, type RepoInventory as b, type ProfileSkill as c, type ProfilePresentationDelivery as d, type PdsProviderInfo as e, type Profile as f, type AccountFacetMode as g, type ProfilePosition as h, type ProfileCertification as i, type ProfileEducation as j, type ProfileHonor as k, type ProfileLanguage as l, type ProfileProject as m, type ProfilePublication as n, type ProfileInvolvement as o, ADULT_CONTENT_LABELS as p, type ActiveApp as q, type ActiveAppView as r, type ActorCard as s, type AtfundLinkView as t, type CertificationView as u, type CoSpeakerView as v, type ContributorView as w, type CourseView as x, type EducationView as y, type Endorsement as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singi-labs/sifa-sdk",
-  "version": "0.12.50",
+  "version": "0.12.52",
   "description": "Sifa SDK — public client library for the Sifa AppView on AT Protocol. Shared by sifa-web and sifa-app.",
   "license": "MIT",
   "type": "module",