@singi-labs/sifa-sdk 0.5.0 → 0.6.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,253 @@
1
+ interface LocationValue {
2
+ city?: string;
3
+ /** community.lexicon.location.address field -- preferred over `city`. */
4
+ locality?: string;
5
+ region?: string;
6
+ country: string;
7
+ countryCode?: string;
8
+ postalCode?: string;
9
+ geonameId?: number;
10
+ }
11
+ interface SkillRef {
12
+ uri: string;
13
+ }
14
+ interface ProfilePosition {
15
+ rkey: string;
16
+ company: string;
17
+ title: string;
18
+ description?: string;
19
+ startedAt: string;
20
+ endedAt?: string;
21
+ location?: LocationValue | null;
22
+ employmentType?: string;
23
+ workplaceType?: string;
24
+ skills?: SkillRef[];
25
+ linkedSkills?: ProfileSkill[];
26
+ primary?: boolean;
27
+ }
28
+ interface ProfileEducation {
29
+ rkey: string;
30
+ institution: string;
31
+ degree?: string;
32
+ fieldOfStudy?: string;
33
+ description?: string;
34
+ activities?: string;
35
+ startedAt?: string;
36
+ endedAt?: string;
37
+ }
38
+ interface ProfileSkill {
39
+ rkey: string;
40
+ name: string;
41
+ category?: string;
42
+ endorsementCount?: number;
43
+ endorsed?: boolean;
44
+ activityBacked?: boolean;
45
+ }
46
+ interface SkillSuggestion {
47
+ canonicalName: string;
48
+ slug: string;
49
+ category: string;
50
+ }
51
+ interface Endorsement {
52
+ endorserDid: string;
53
+ endorserHandle: string;
54
+ endorserDisplayName?: string;
55
+ endorserAvatar?: string;
56
+ comment?: string;
57
+ relationshipContext?: string;
58
+ createdAt: string;
59
+ }
60
+ interface EndorsementData {
61
+ skillRkey: string;
62
+ comment?: string;
63
+ relationshipContext?: string;
64
+ }
65
+ interface ProfileLocation {
66
+ rkey: string;
67
+ type: string;
68
+ label?: string | null;
69
+ isPrimary: boolean;
70
+ locationCountry?: string | null;
71
+ locationRegion?: string | null;
72
+ /** Legacy alias for `locationLocality`; emitted by sifa-api during the additive response window. */
73
+ locationCity?: string | null;
74
+ /** community.lexicon.location.address field name -- prefer over `locationCity`. */
75
+ locationLocality?: string | null;
76
+ countryCode?: string | null;
77
+ location?: string | null;
78
+ }
79
+ interface ProfileCertification {
80
+ rkey: string;
81
+ name: string;
82
+ issuingOrg: string;
83
+ issueDate?: string;
84
+ expiryDate?: string;
85
+ credentialUrl?: string;
86
+ }
87
+ interface ProfileProject {
88
+ rkey: string;
89
+ name: string;
90
+ description?: string;
91
+ url?: string;
92
+ startDate?: string;
93
+ endDate?: string;
94
+ }
95
+ interface PublicationContributor {
96
+ name: string;
97
+ orcidId?: string;
98
+ did?: string;
99
+ handle?: string;
100
+ }
101
+ interface ProfilePublication {
102
+ rkey: string;
103
+ title: string;
104
+ publisher?: string;
105
+ date?: string;
106
+ url?: string;
107
+ description?: string;
108
+ source?: 'sifa' | 'standard' | 'orcid';
109
+ doi?: string;
110
+ type?: string;
111
+ typeLabel?: string;
112
+ contributors?: PublicationContributor[];
113
+ verified?: boolean;
114
+ verifiedVia?: string;
115
+ orcidPutCode?: number;
116
+ hidden?: boolean;
117
+ orcidCorroborated?: boolean;
118
+ pendingVerification?: boolean;
119
+ appId?: string;
120
+ }
121
+ interface ProfileVolunteering {
122
+ rkey: string;
123
+ organization: string;
124
+ role?: string;
125
+ cause?: string;
126
+ startDate?: string;
127
+ endDate?: string;
128
+ description?: string;
129
+ }
130
+ interface ProfileHonor {
131
+ rkey: string;
132
+ title: string;
133
+ issuer?: string;
134
+ date?: string;
135
+ description?: string;
136
+ }
137
+ type LanguageProficiency = 'elementary' | 'limited_working' | 'professional_working' | 'full_professional' | 'native';
138
+ interface ProfileLanguage {
139
+ rkey: string;
140
+ language: string;
141
+ proficiency?: LanguageProficiency;
142
+ }
143
+ interface ProfileCourse {
144
+ rkey: string;
145
+ name: string;
146
+ institution?: string;
147
+ number?: string;
148
+ }
149
+ interface TrustStat {
150
+ key: string;
151
+ label: string;
152
+ value: number;
153
+ }
154
+ interface ActiveApp {
155
+ id: string;
156
+ name: string;
157
+ category: string;
158
+ recentCount: number;
159
+ latestRecordAt?: string | null;
160
+ }
161
+ interface VerifiedAccount {
162
+ platform: string;
163
+ identifier: string;
164
+ url?: string;
165
+ }
166
+ interface ExternalAccountKeytraceClaim {
167
+ rkey: string;
168
+ claimedAt: string;
169
+ }
170
+ interface ExternalAccount {
171
+ rkey: string;
172
+ platform: string;
173
+ url: string;
174
+ label?: string;
175
+ feedUrl?: string;
176
+ primary?: boolean;
177
+ verifiable: boolean;
178
+ verified: boolean;
179
+ verifiedVia?: string | null;
180
+ source?: 'sifa' | 'keytrace' | 'keyoxide';
181
+ hidden?: boolean;
182
+ keytraceVerified?: boolean;
183
+ keytraceClaim?: ExternalAccountKeytraceClaim;
184
+ }
185
+ interface FeedItem {
186
+ title: string;
187
+ excerpt: string;
188
+ url: string;
189
+ timestamp: string;
190
+ source: string;
191
+ }
192
+ interface PdsProviderInfo {
193
+ name: string;
194
+ host: string;
195
+ }
196
+ interface ProfileIndustry {
197
+ industry: string;
198
+ domain?: string;
199
+ }
200
+ interface ProfileOverrideSource {
201
+ headline?: string;
202
+ about?: string;
203
+ displayName?: string;
204
+ avatarUrl?: string;
205
+ }
206
+ interface Profile {
207
+ did: string;
208
+ handle: string;
209
+ displayName?: string;
210
+ avatar?: string;
211
+ pronouns?: string;
212
+ headline?: string;
213
+ about?: string;
214
+ hasHeadlineOverride?: boolean;
215
+ hasAboutOverride?: boolean;
216
+ hasDisplayNameOverride?: boolean;
217
+ hasAvatarUrlOverride?: boolean;
218
+ source?: ProfileOverrideSource;
219
+ industries?: ProfileIndustry[];
220
+ location?: LocationValue | null;
221
+ locations?: ProfileLocation[];
222
+ website?: string;
223
+ openTo?: string[];
224
+ preferredWorkplace?: string[];
225
+ availableFromUtc?: number;
226
+ availableToUtc?: number;
227
+ pdsProvider?: PdsProviderInfo | null;
228
+ claimed: boolean;
229
+ isOwnProfile?: boolean;
230
+ createdAt?: string;
231
+ trustStats?: TrustStat[];
232
+ verifiedAccounts?: VerifiedAccount[];
233
+ activeApps?: ActiveApp[];
234
+ blueskyVerified?: boolean;
235
+ blueskyVerifiedAt?: string | null;
236
+ followersCount: number;
237
+ followingCount: number;
238
+ connectionsCount: number;
239
+ atprotoFollowersCount?: number;
240
+ positions: ProfilePosition[];
241
+ education: ProfileEducation[];
242
+ skills: ProfileSkill[];
243
+ certifications?: ProfileCertification[];
244
+ projects?: ProfileProject[];
245
+ publications?: ProfilePublication[];
246
+ volunteering?: ProfileVolunteering[];
247
+ honors?: ProfileHonor[];
248
+ languages?: ProfileLanguage[];
249
+ courses?: ProfileCourse[];
250
+ externalAccounts?: ExternalAccount[];
251
+ }
252
+
253
+ export type { ActiveApp as A, Endorsement as E, FeedItem as F, LocationValue as L, Profile as P, SkillRef as S, TrustStat as T, VerifiedAccount as V, ProfileSkill as a, PdsProviderInfo as b, EndorsementData as c, ExternalAccount as d, ExternalAccountKeytraceClaim as e, LanguageProficiency as f, ProfileCertification as g, ProfileCourse as h, ProfileEducation as i, ProfileHonor as j, ProfileIndustry as k, ProfileLanguage as l, ProfileLocation as m, ProfileOverrideSource as n, ProfilePosition as o, ProfileProject as p, ProfilePublication as q, ProfileVolunteering as r, PublicationContributor as s, SkillSuggestion as t };
@@ -0,0 +1,253 @@
1
+ interface LocationValue {
2
+ city?: string;
3
+ /** community.lexicon.location.address field -- preferred over `city`. */
4
+ locality?: string;
5
+ region?: string;
6
+ country: string;
7
+ countryCode?: string;
8
+ postalCode?: string;
9
+ geonameId?: number;
10
+ }
11
+ interface SkillRef {
12
+ uri: string;
13
+ }
14
+ interface ProfilePosition {
15
+ rkey: string;
16
+ company: string;
17
+ title: string;
18
+ description?: string;
19
+ startedAt: string;
20
+ endedAt?: string;
21
+ location?: LocationValue | null;
22
+ employmentType?: string;
23
+ workplaceType?: string;
24
+ skills?: SkillRef[];
25
+ linkedSkills?: ProfileSkill[];
26
+ primary?: boolean;
27
+ }
28
+ interface ProfileEducation {
29
+ rkey: string;
30
+ institution: string;
31
+ degree?: string;
32
+ fieldOfStudy?: string;
33
+ description?: string;
34
+ activities?: string;
35
+ startedAt?: string;
36
+ endedAt?: string;
37
+ }
38
+ interface ProfileSkill {
39
+ rkey: string;
40
+ name: string;
41
+ category?: string;
42
+ endorsementCount?: number;
43
+ endorsed?: boolean;
44
+ activityBacked?: boolean;
45
+ }
46
+ interface SkillSuggestion {
47
+ canonicalName: string;
48
+ slug: string;
49
+ category: string;
50
+ }
51
+ interface Endorsement {
52
+ endorserDid: string;
53
+ endorserHandle: string;
54
+ endorserDisplayName?: string;
55
+ endorserAvatar?: string;
56
+ comment?: string;
57
+ relationshipContext?: string;
58
+ createdAt: string;
59
+ }
60
+ interface EndorsementData {
61
+ skillRkey: string;
62
+ comment?: string;
63
+ relationshipContext?: string;
64
+ }
65
+ interface ProfileLocation {
66
+ rkey: string;
67
+ type: string;
68
+ label?: string | null;
69
+ isPrimary: boolean;
70
+ locationCountry?: string | null;
71
+ locationRegion?: string | null;
72
+ /** Legacy alias for `locationLocality`; emitted by sifa-api during the additive response window. */
73
+ locationCity?: string | null;
74
+ /** community.lexicon.location.address field name -- prefer over `locationCity`. */
75
+ locationLocality?: string | null;
76
+ countryCode?: string | null;
77
+ location?: string | null;
78
+ }
79
+ interface ProfileCertification {
80
+ rkey: string;
81
+ name: string;
82
+ issuingOrg: string;
83
+ issueDate?: string;
84
+ expiryDate?: string;
85
+ credentialUrl?: string;
86
+ }
87
+ interface ProfileProject {
88
+ rkey: string;
89
+ name: string;
90
+ description?: string;
91
+ url?: string;
92
+ startDate?: string;
93
+ endDate?: string;
94
+ }
95
+ interface PublicationContributor {
96
+ name: string;
97
+ orcidId?: string;
98
+ did?: string;
99
+ handle?: string;
100
+ }
101
+ interface ProfilePublication {
102
+ rkey: string;
103
+ title: string;
104
+ publisher?: string;
105
+ date?: string;
106
+ url?: string;
107
+ description?: string;
108
+ source?: 'sifa' | 'standard' | 'orcid';
109
+ doi?: string;
110
+ type?: string;
111
+ typeLabel?: string;
112
+ contributors?: PublicationContributor[];
113
+ verified?: boolean;
114
+ verifiedVia?: string;
115
+ orcidPutCode?: number;
116
+ hidden?: boolean;
117
+ orcidCorroborated?: boolean;
118
+ pendingVerification?: boolean;
119
+ appId?: string;
120
+ }
121
+ interface ProfileVolunteering {
122
+ rkey: string;
123
+ organization: string;
124
+ role?: string;
125
+ cause?: string;
126
+ startDate?: string;
127
+ endDate?: string;
128
+ description?: string;
129
+ }
130
+ interface ProfileHonor {
131
+ rkey: string;
132
+ title: string;
133
+ issuer?: string;
134
+ date?: string;
135
+ description?: string;
136
+ }
137
+ type LanguageProficiency = 'elementary' | 'limited_working' | 'professional_working' | 'full_professional' | 'native';
138
+ interface ProfileLanguage {
139
+ rkey: string;
140
+ language: string;
141
+ proficiency?: LanguageProficiency;
142
+ }
143
+ interface ProfileCourse {
144
+ rkey: string;
145
+ name: string;
146
+ institution?: string;
147
+ number?: string;
148
+ }
149
+ interface TrustStat {
150
+ key: string;
151
+ label: string;
152
+ value: number;
153
+ }
154
+ interface ActiveApp {
155
+ id: string;
156
+ name: string;
157
+ category: string;
158
+ recentCount: number;
159
+ latestRecordAt?: string | null;
160
+ }
161
+ interface VerifiedAccount {
162
+ platform: string;
163
+ identifier: string;
164
+ url?: string;
165
+ }
166
+ interface ExternalAccountKeytraceClaim {
167
+ rkey: string;
168
+ claimedAt: string;
169
+ }
170
+ interface ExternalAccount {
171
+ rkey: string;
172
+ platform: string;
173
+ url: string;
174
+ label?: string;
175
+ feedUrl?: string;
176
+ primary?: boolean;
177
+ verifiable: boolean;
178
+ verified: boolean;
179
+ verifiedVia?: string | null;
180
+ source?: 'sifa' | 'keytrace' | 'keyoxide';
181
+ hidden?: boolean;
182
+ keytraceVerified?: boolean;
183
+ keytraceClaim?: ExternalAccountKeytraceClaim;
184
+ }
185
+ interface FeedItem {
186
+ title: string;
187
+ excerpt: string;
188
+ url: string;
189
+ timestamp: string;
190
+ source: string;
191
+ }
192
+ interface PdsProviderInfo {
193
+ name: string;
194
+ host: string;
195
+ }
196
+ interface ProfileIndustry {
197
+ industry: string;
198
+ domain?: string;
199
+ }
200
+ interface ProfileOverrideSource {
201
+ headline?: string;
202
+ about?: string;
203
+ displayName?: string;
204
+ avatarUrl?: string;
205
+ }
206
+ interface Profile {
207
+ did: string;
208
+ handle: string;
209
+ displayName?: string;
210
+ avatar?: string;
211
+ pronouns?: string;
212
+ headline?: string;
213
+ about?: string;
214
+ hasHeadlineOverride?: boolean;
215
+ hasAboutOverride?: boolean;
216
+ hasDisplayNameOverride?: boolean;
217
+ hasAvatarUrlOverride?: boolean;
218
+ source?: ProfileOverrideSource;
219
+ industries?: ProfileIndustry[];
220
+ location?: LocationValue | null;
221
+ locations?: ProfileLocation[];
222
+ website?: string;
223
+ openTo?: string[];
224
+ preferredWorkplace?: string[];
225
+ availableFromUtc?: number;
226
+ availableToUtc?: number;
227
+ pdsProvider?: PdsProviderInfo | null;
228
+ claimed: boolean;
229
+ isOwnProfile?: boolean;
230
+ createdAt?: string;
231
+ trustStats?: TrustStat[];
232
+ verifiedAccounts?: VerifiedAccount[];
233
+ activeApps?: ActiveApp[];
234
+ blueskyVerified?: boolean;
235
+ blueskyVerifiedAt?: string | null;
236
+ followersCount: number;
237
+ followingCount: number;
238
+ connectionsCount: number;
239
+ atprotoFollowersCount?: number;
240
+ positions: ProfilePosition[];
241
+ education: ProfileEducation[];
242
+ skills: ProfileSkill[];
243
+ certifications?: ProfileCertification[];
244
+ projects?: ProfileProject[];
245
+ publications?: ProfilePublication[];
246
+ volunteering?: ProfileVolunteering[];
247
+ honors?: ProfileHonor[];
248
+ languages?: ProfileLanguage[];
249
+ courses?: ProfileCourse[];
250
+ externalAccounts?: ExternalAccount[];
251
+ }
252
+
253
+ export type { ActiveApp as A, Endorsement as E, FeedItem as F, LocationValue as L, Profile as P, SkillRef as S, TrustStat as T, VerifiedAccount as V, ProfileSkill as a, PdsProviderInfo as b, EndorsementData as c, ExternalAccount as d, ExternalAccountKeytraceClaim as e, LanguageProficiency as f, ProfileCertification as g, ProfileCourse as h, ProfileEducation as i, ProfileHonor as j, ProfileIndustry as k, ProfileLanguage as l, ProfileLocation as m, ProfileOverrideSource as n, ProfilePosition as o, ProfileProject as p, ProfilePublication as q, ProfileVolunteering as r, PublicationContributor as s, SkillSuggestion as t };
package/dist/index.cjs CHANGED
@@ -1088,7 +1088,7 @@ var ProfileVolunteeringRecordSchema = zod.z.object({
1088
1088
  });
1089
1089
 
1090
1090
  // src/index.ts
1091
- var SIFA_SDK_VERSION = "0.5.0";
1091
+ var SIFA_SDK_VERSION = "0.6.0";
1092
1092
 
1093
1093
  exports.CATEGORY_LABELS = CATEGORY_LABELS;
1094
1094
  exports.CATEGORY_ORDER = CATEGORY_ORDER;