@singi-labs/sifa-sdk 0.19.94 → 0.19.96

package/README.md

@@ -27,16 +27,17 @@ Published publicly so third-party developers can build their own AT Protocol cli
 
 ## What this package contains
 
-| Area        | What it provides                                                                      |
-| ----------- | ------------------------------------------------------------------------------------- |
-| Types       | TypeScript types for Sifa data structures, generated from `sifa-lexicons`             |
-| Schemas     | Zod schemas mirroring lexicon constraints for runtime validation                      |
-| Query layer | TanStack Query keys, fetchers, and React hooks for calling `sifa-api`                 |
-| ATproto     | Wrapper around `@atproto/api` that accepts an authenticated agent                     |
-| Format      | Pure formatters for dates, locations, profile completeness                            |
-| Logic       | Business-logic predicates (display-only; server-side trust logic lives in `sifa-api`) |
-| Taxonomy    | Constants and enums (continents, industries, skill categories, activity tiers)        |
-| Tokens      | Sifa-brand design tokens, exported via `@singi-labs/sifa-sdk/tokens` (optional)       |
+| Area        | What it provides                                                                                        |
+| ----------- | ------------------------------------------------------------------------------------------------------- |
+| Types       | TypeScript types for Sifa data structures, generated from `sifa-lexicons`                               |
+| Schemas     | Zod schemas mirroring lexicon constraints for runtime validation                                        |
+| Query layer | TanStack Query keys, fetchers, and React hooks for calling `sifa-api`                                   |
+| ATproto     | Wrapper around `@atproto/api` that accepts an authenticated agent                                       |
+| Format      | Pure formatters for dates, locations, profile completeness                                              |
+| Logic       | Business-logic predicates (display-only; server-side trust logic lives in `sifa-api`)                   |
+| Taxonomy    | Constants and enums (continents, industries, skill categories, activity tiers)                          |
+| Tokens      | Sifa-brand design tokens, exported via `@singi-labs/sifa-sdk/tokens` (optional)                         |
+| Testing     | Anonymized profile responses and sample export details, via `@singi-labs/sifa-sdk/testing` (tests only) |
 
 ---
 

package/dist/export-contact-D_krcTBH.d.cts

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+
+/**
+ * Private contact and personal details for exports: email, phone, postal
+ * address, driver's license, right to work and nationality.
+ *
+ * Sifa never stores these and never writes them to the owner's PDS, where they
+ * would be public. The owner types them on the export page, the browser keeps
+ * them, and they go only into the files the owner downloads. This module holds
+ * the shape, the limits and the pick rule, so the export page and the server
+ * that builds a funder CV agree on them.
+ */
+
+/** Longest value accepted per field. 254 is the longest valid email address. */
+declare const EXPORT_CONTACT_LIMITS: {
+    readonly email: 254;
+    readonly phone: 40;
+    readonly address: 500;
+    readonly driversLicense: 60;
+    readonly rightToWork: 200;
+    readonly nationality: 100;
+};
+/** The contact details that go into an export. Absent keys are left out. */
+interface ExportContact {
+    readonly email?: string;
+    readonly phone?: string;
+    /** Free text; lines are separated by `\n`. */
+    readonly address?: string;
+    /** License categories, e.g. "B, BE". */
+    readonly driversLicense?: string;
+    /** e.g. "EU citizen, no sponsorship needed". */
+    readonly rightToWork?: string;
+    readonly nationality?: string;
+}
+/** What the owner has typed, plus which fields they chose to include. */
+interface ExportContactDraft {
+    readonly email?: string;
+    readonly phone?: string;
+    readonly address?: string;
+    readonly driversLicense?: string;
+    readonly rightToWork?: string;
+    readonly nationality?: string;
+    readonly includeEmail?: boolean;
+    readonly includePhone?: boolean;
+    readonly includeAddress?: boolean;
+    readonly includeDriversLicense?: boolean;
+    readonly includeRightToWork?: boolean;
+    readonly includeNationality?: boolean;
+}
+/**
+ * Validates a picked contact. Only lengths are checked: phone numbers and
+ * addresses vary too much between countries, and a wrong-looking email is a
+ * warning for the owner, not a reason to refuse the export.
+ */
+declare const exportContactSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodString>;
+    driversLicense: z.ZodOptional<z.ZodString>;
+    rightToWork: z.ZodOptional<z.ZodString>;
+    nationality: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * The fields to put in an export: the included ones that are not blank, run
+ * through {@link normalizeExportContact}.
+ */
+declare function pickExportContact(draft: ExportContactDraft): ExportContact;
+/**
+ * Drops blank fields and tidies the rest. Every field but the address becomes
+ * one line with single spaces. An address keeps its line breaks but loses blank lines and the
+ * spaces around each line. Each field is cut at its {@link EXPORT_CONTACT_LIMITS}
+ * length. The emitters call this too, so a caller that skips
+ * {@link pickExportContact} and the schema gets the same bounded output.
+ */
+declare function normalizeExportContact(contact: ExportContact): ExportContact;
+/** A loose shape check for a non-blocking "check this address" hint. */
+declare function looksLikeEmail(value: string): boolean;
+
+export { type ExportContact as E, EXPORT_CONTACT_LIMITS as a, type ExportContactDraft as b, exportContactSchema as e, looksLikeEmail as l, normalizeExportContact as n, pickExportContact as p };

package/dist/export-contact-D_krcTBH.d.ts

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+
+/**
+ * Private contact and personal details for exports: email, phone, postal
+ * address, driver's license, right to work and nationality.
+ *
+ * Sifa never stores these and never writes them to the owner's PDS, where they
+ * would be public. The owner types them on the export page, the browser keeps
+ * them, and they go only into the files the owner downloads. This module holds
+ * the shape, the limits and the pick rule, so the export page and the server
+ * that builds a funder CV agree on them.
+ */
+
+/** Longest value accepted per field. 254 is the longest valid email address. */
+declare const EXPORT_CONTACT_LIMITS: {
+    readonly email: 254;
+    readonly phone: 40;
+    readonly address: 500;
+    readonly driversLicense: 60;
+    readonly rightToWork: 200;
+    readonly nationality: 100;
+};
+/** The contact details that go into an export. Absent keys are left out. */
+interface ExportContact {
+    readonly email?: string;
+    readonly phone?: string;
+    /** Free text; lines are separated by `\n`. */
+    readonly address?: string;
+    /** License categories, e.g. "B, BE". */
+    readonly driversLicense?: string;
+    /** e.g. "EU citizen, no sponsorship needed". */
+    readonly rightToWork?: string;
+    readonly nationality?: string;
+}
+/** What the owner has typed, plus which fields they chose to include. */
+interface ExportContactDraft {
+    readonly email?: string;
+    readonly phone?: string;
+    readonly address?: string;
+    readonly driversLicense?: string;
+    readonly rightToWork?: string;
+    readonly nationality?: string;
+    readonly includeEmail?: boolean;
+    readonly includePhone?: boolean;
+    readonly includeAddress?: boolean;
+    readonly includeDriversLicense?: boolean;
+    readonly includeRightToWork?: boolean;
+    readonly includeNationality?: boolean;
+}
+/**
+ * Validates a picked contact. Only lengths are checked: phone numbers and
+ * addresses vary too much between countries, and a wrong-looking email is a
+ * warning for the owner, not a reason to refuse the export.
+ */
+declare const exportContactSchema: z.ZodObject<{
+    email: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    address: z.ZodOptional<z.ZodString>;
+    driversLicense: z.ZodOptional<z.ZodString>;
+    rightToWork: z.ZodOptional<z.ZodString>;
+    nationality: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * The fields to put in an export: the included ones that are not blank, run
+ * through {@link normalizeExportContact}.
+ */
+declare function pickExportContact(draft: ExportContactDraft): ExportContact;
+/**
+ * Drops blank fields and tidies the rest. Every field but the address becomes
+ * one line with single spaces. An address keeps its line breaks but loses blank lines and the
+ * spaces around each line. Each field is cut at its {@link EXPORT_CONTACT_LIMITS}
+ * length. The emitters call this too, so a caller that skips
+ * {@link pickExportContact} and the schema gets the same bounded output.
+ */
+declare function normalizeExportContact(contact: ExportContact): ExportContact;
+/** A loose shape check for a non-blocking "check this address" hint. */
+declare function looksLikeEmail(value: string): boolean;
+
+export { type ExportContact as E, EXPORT_CONTACT_LIMITS as a, type ExportContactDraft as b, exportContactSchema as e, looksLikeEmail as l, normalizeExportContact as n, pickExportContact as p };

package/dist/index.cjs

@@ -6047,6 +6047,10 @@ function completenessScore(c) {
 function completenessPercent(c) {
   return Math.round(completenessScore(c) / COMPLETENESS_MAX_SCORE * 100);
 }
+var OPTIONAL_COMPLETENESS_SIGNALS = ["certification"];
+function isOptionalCompletenessSignal(signal) {
+  return OPTIONAL_COMPLETENESS_SIGNALS.some((optional) => optional === signal);
+}
 
 // src/logic/profile-dimensions.ts
 var DIMENSIONS_MAX_SCORE = 6;
@@ -7692,7 +7696,7 @@ function describeSifaRecord(collection, value) {
 }
 
 // src/index.ts
-var SIFA_SDK_VERSION = "0.19.94";
+var SIFA_SDK_VERSION = "0.19.96";
 
 exports.ACTIVITY_TIERS = ACTIVITY_TIERS;
 exports.ACTIVITY_VERBS = ACTIVITY_VERBS;
@@ -7774,6 +7778,7 @@ exports.OPEN_TO_TOKENS = OPEN_TO_TOKENS;
 exports.OPEN_TO_TOKEN_LABELS = OPEN_TO_TOKEN_LABELS;
 exports.OPEN_TO_TOKEN_TO_VALUE = OPEN_TO_TOKEN_TO_VALUE;
 exports.OPEN_TO_VALUE_TO_TOKEN = OPEN_TO_VALUE_TO_TOKEN;
+exports.OPTIONAL_COMPLETENESS_SIGNALS = OPTIONAL_COMPLETENESS_SIGNALS;
 exports.OrgEmploymentAttestationRecordSchema = OrgEmploymentAttestationRecordSchema;
 exports.OrgProfileRecordSchema = OrgProfileRecordSchema;
 exports.PLATFORM_LABELS = PLATFORM_LABELS;
@@ -7936,6 +7941,7 @@ exports.isKnownPlatform = isKnownPlatform;
 exports.isKnownVerificationProvider = isKnownVerificationProvider;
 exports.isLinked = isLinked;
 exports.isOnBehalfOfApplicable = isOnBehalfOfApplicable;
+exports.isOptionalCompletenessSignal = isOptionalCompletenessSignal;
 exports.isPseudoEmployer = isPseudoEmployer;
 exports.isRegistrableDomainHandle = isRegistrableDomainHandle;
 exports.isRelationalActivity = isRelationalActivity;