@everfur/sdk 0.12.1 → 0.14.0

package/dist/features.d-DrQxTw3-.d.cts

@@ -0,0 +1,108 @@
+/** Who a share link is for, while the server's audience switch is on (V819), in the order it offers them. */
+type RecordShareAudience = 'vet' | 'groomer' | 'boarding';
+/** Every audience this package can name, in the design's order. */
+declare const RECORD_SHARE_AUDIENCES: readonly RecordShareAudience[];
+/** Who an emailed record goes to: an audience, or `other` (the neutral email wording and no audience). */
+type RecordShareRecipientKind = RecordShareAudience | 'other';
+/**
+ * What a link minted for one audience carries (`ShareAudienceScope` on the wire): the content `sections` of the
+ * shared record and, for a care handoff that is not a vet, the only `entityTypes` it keeps (null: every type).
+ */
+interface RecordShareAudienceScope {
+    readonly audience: RecordShareAudience;
+    readonly sections: readonly string[];
+    readonly entityTypes: readonly string[] | null;
+}
+/** A freshly minted share link. `shareUrl` is shown once; the list read never repeats it. */
+interface RecordShareLink {
+    readonly shareId: string;
+    readonly shareUrl: string;
+    readonly expiresAt: string | null;
+    /**
+     * The audience the link was stamped with; null for a link minted without one (or with the switch off). Always
+     * set by this package's mapper; optional only so a value a host builds itself (a test double) still type-checks.
+     */
+    readonly audience?: RecordShareAudience | null;
+}
+/** One live share link as the list read reports it (no URL: the token was shown once, at creation). */
+interface RecordShare {
+    readonly shareId: string;
+    readonly expiresAt: string | null;
+    readonly createdAt: string | null;
+    readonly viewCount: number;
+    readonly lastViewedAt: string | null;
+    /**
+     * The audience the link was stamped with; null for none, an unknown one, or with the switch off. Always set by
+     * this package's mapper; optional only so a value a host builds itself (a test double) still type-checks.
+     */
+    readonly audience?: RecordShareAudience | null;
+}
+/** Email the record: the recipient's address and who they are (which picks the email's wording). */
+interface RecordShareEmailInput {
+    readonly recipientEmail: string;
+    readonly recipientKind: RecordShareRecipientKind;
+}
+/**
+ * The emailed link's receipt: the id to turn it off by and the date it dies. NO URL, by design: the server never
+ * returns the link for an email send, and this shape has nowhere to put one.
+ */
+interface RecordShareEmailReceipt {
+    readonly shareId: string;
+    readonly expiresAt: string | null;
+    readonly audience: RecordShareAudience | null;
+}
+/** The presigned PDF download. */
+interface RecordPdfLink {
+    readonly downloadUrl: string;
+    readonly expiresAt: string | null;
+}
+/** The longest address the email route accepts (`recipient_email: Field(max_length=254)`). */
+declare const SHARE_RECIPIENT_EMAIL_MAX = 254;
+/**
+ * The email route's own lenient address check (records_router.py `_EMAIL_RE`, which the widget route imports), so
+ * an address the server would refuse is refused here before a request is spent. Not an RFC 5322 parser.
+ */
+declare function isShareRecipientEmail(value: string): boolean;
+/**
+ * `share_audiences` off the features read, FAIL CLOSED: absent, not a list, or any entry off the documented shape
+ * is NO audiences, so a surface never claims a scope it cannot read. An audience this package cannot name (a
+ * newer server's) and a repeat are dropped; the rest keep the server's order.
+ */
+declare function mapShareAudiences(wire: unknown): readonly RecordShareAudienceScope[];
+/**
+ * The share link as an absolute https URL. The consumer route returns the RELATIVE form
+ * (`/api/v1/records/everfur_record/shared/<token>.pdf`), which is resolved against the API base URL the
+ * client was built for; an absolute value is kept as it is. A link that cannot be made absolute https (a
+ * relative path with no base URL, another scheme, a malformed value) is refused: it is never opened raw.
+ */
+declare function resolveShareUrl(shareUrl: string, apiBaseUrl: string | undefined): string | null;
+/** The mint response to a frozen link, or null when malformed (fail-closed: no link is better than a bad one). */
+declare function mapRecordShareLink(wire: unknown, apiBaseUrl?: string): RecordShareLink | null;
+/** The list response to frozen rows, or null when malformed. */
+declare function mapRecordShareList(wire: unknown): readonly RecordShare[] | null;
+/** The email send's answer to a frozen receipt, or null when malformed. Only the named keys survive: never a URL. */
+declare function mapRecordShareEmailReceipt(wire: unknown): RecordShareEmailReceipt | null;
+/** The PDF link response to a frozen link, or null when malformed or not https. */
+declare function mapRecordPdfLink(wire: unknown): RecordPdfLink | null;
+
+/** A photo type `uploads/initiate` accepts while photo upload is armed. */
+type RecordsPhotoContentType = 'image/jpeg' | 'image/png' | 'image/heic' | 'image/heif';
+/** A content type `uploads/initiate` can be asked for. */
+type RecordsUploadContentType = 'application/pdf' | RecordsPhotoContentType;
+
+/** The records features read, mapped. */
+interface RecordsFeatures {
+    /** Every feature the server named, by its wire name (`markers`, `sharing`, ...). Empty when the read failed. */
+    readonly features: Readonly<Record<string, boolean>>;
+    /** What an upload may declare. Always starts with `application/pdf`; photo types only while armed. */
+    readonly uploadContentTypes: readonly RecordsUploadContentType[];
+    /**
+     * Who a share link can be for, in the server's order, each with the scope its link carries. Served only while
+     * the audience switch is on; empty otherwise, and when the list is malformed.
+     */
+    readonly shareAudiences: readonly RecordShareAudienceScope[];
+}
+/** True when an upload may be a photo. An absent list (a host-built state) is PDF only. */
+declare function acceptsPhotos(types: readonly string[] | undefined): boolean;
+
+export { type RecordShareAudience as R, SHARE_RECIPIENT_EMAIL_MAX as S, type RecordsFeatures as a, type RecordsUploadContentType as b, type RecordShareLink as c, type RecordShareEmailInput as d, type RecordShareEmailReceipt as e, type RecordShare as f, type RecordPdfLink as g, RECORD_SHARE_AUDIENCES as h, type RecordShareAudienceScope as i, type RecordShareRecipientKind as j, isShareRecipientEmail as k, mapRecordShareEmailReceipt as l, mapRecordPdfLink as m, mapRecordShareLink as n, mapRecordShareList as o, mapShareAudiences as p, type RecordsPhotoContentType as q, resolveShareUrl as r, acceptsPhotos as s };

package/dist/features.d-DrQxTw3-.d.ts

@@ -0,0 +1,108 @@
+/** Who a share link is for, while the server's audience switch is on (V819), in the order it offers them. */
+type RecordShareAudience = 'vet' | 'groomer' | 'boarding';
+/** Every audience this package can name, in the design's order. */
+declare const RECORD_SHARE_AUDIENCES: readonly RecordShareAudience[];
+/** Who an emailed record goes to: an audience, or `other` (the neutral email wording and no audience). */
+type RecordShareRecipientKind = RecordShareAudience | 'other';
+/**
+ * What a link minted for one audience carries (`ShareAudienceScope` on the wire): the content `sections` of the
+ * shared record and, for a care handoff that is not a vet, the only `entityTypes` it keeps (null: every type).
+ */
+interface RecordShareAudienceScope {
+    readonly audience: RecordShareAudience;
+    readonly sections: readonly string[];
+    readonly entityTypes: readonly string[] | null;
+}
+/** A freshly minted share link. `shareUrl` is shown once; the list read never repeats it. */
+interface RecordShareLink {
+    readonly shareId: string;
+    readonly shareUrl: string;
+    readonly expiresAt: string | null;
+    /**
+     * The audience the link was stamped with; null for a link minted without one (or with the switch off). Always
+     * set by this package's mapper; optional only so a value a host builds itself (a test double) still type-checks.
+     */
+    readonly audience?: RecordShareAudience | null;
+}
+/** One live share link as the list read reports it (no URL: the token was shown once, at creation). */
+interface RecordShare {
+    readonly shareId: string;
+    readonly expiresAt: string | null;
+    readonly createdAt: string | null;
+    readonly viewCount: number;
+    readonly lastViewedAt: string | null;
+    /**
+     * The audience the link was stamped with; null for none, an unknown one, or with the switch off. Always set by
+     * this package's mapper; optional only so a value a host builds itself (a test double) still type-checks.
+     */
+    readonly audience?: RecordShareAudience | null;
+}
+/** Email the record: the recipient's address and who they are (which picks the email's wording). */
+interface RecordShareEmailInput {
+    readonly recipientEmail: string;
+    readonly recipientKind: RecordShareRecipientKind;
+}
+/**
+ * The emailed link's receipt: the id to turn it off by and the date it dies. NO URL, by design: the server never
+ * returns the link for an email send, and this shape has nowhere to put one.
+ */
+interface RecordShareEmailReceipt {
+    readonly shareId: string;
+    readonly expiresAt: string | null;
+    readonly audience: RecordShareAudience | null;
+}
+/** The presigned PDF download. */
+interface RecordPdfLink {
+    readonly downloadUrl: string;
+    readonly expiresAt: string | null;
+}
+/** The longest address the email route accepts (`recipient_email: Field(max_length=254)`). */
+declare const SHARE_RECIPIENT_EMAIL_MAX = 254;
+/**
+ * The email route's own lenient address check (records_router.py `_EMAIL_RE`, which the widget route imports), so
+ * an address the server would refuse is refused here before a request is spent. Not an RFC 5322 parser.
+ */
+declare function isShareRecipientEmail(value: string): boolean;
+/**
+ * `share_audiences` off the features read, FAIL CLOSED: absent, not a list, or any entry off the documented shape
+ * is NO audiences, so a surface never claims a scope it cannot read. An audience this package cannot name (a
+ * newer server's) and a repeat are dropped; the rest keep the server's order.
+ */
+declare function mapShareAudiences(wire: unknown): readonly RecordShareAudienceScope[];
+/**
+ * The share link as an absolute https URL. The consumer route returns the RELATIVE form
+ * (`/api/v1/records/everfur_record/shared/<token>.pdf`), which is resolved against the API base URL the
+ * client was built for; an absolute value is kept as it is. A link that cannot be made absolute https (a
+ * relative path with no base URL, another scheme, a malformed value) is refused: it is never opened raw.
+ */
+declare function resolveShareUrl(shareUrl: string, apiBaseUrl: string | undefined): string | null;
+/** The mint response to a frozen link, or null when malformed (fail-closed: no link is better than a bad one). */
+declare function mapRecordShareLink(wire: unknown, apiBaseUrl?: string): RecordShareLink | null;
+/** The list response to frozen rows, or null when malformed. */
+declare function mapRecordShareList(wire: unknown): readonly RecordShare[] | null;
+/** The email send's answer to a frozen receipt, or null when malformed. Only the named keys survive: never a URL. */
+declare function mapRecordShareEmailReceipt(wire: unknown): RecordShareEmailReceipt | null;
+/** The PDF link response to a frozen link, or null when malformed or not https. */
+declare function mapRecordPdfLink(wire: unknown): RecordPdfLink | null;
+
+/** A photo type `uploads/initiate` accepts while photo upload is armed. */
+type RecordsPhotoContentType = 'image/jpeg' | 'image/png' | 'image/heic' | 'image/heif';
+/** A content type `uploads/initiate` can be asked for. */
+type RecordsUploadContentType = 'application/pdf' | RecordsPhotoContentType;
+
+/** The records features read, mapped. */
+interface RecordsFeatures {
+    /** Every feature the server named, by its wire name (`markers`, `sharing`, ...). Empty when the read failed. */
+    readonly features: Readonly<Record<string, boolean>>;
+    /** What an upload may declare. Always starts with `application/pdf`; photo types only while armed. */
+    readonly uploadContentTypes: readonly RecordsUploadContentType[];
+    /**
+     * Who a share link can be for, in the server's order, each with the scope its link carries. Served only while
+     * the audience switch is on; empty otherwise, and when the list is malformed.
+     */
+    readonly shareAudiences: readonly RecordShareAudienceScope[];
+}
+/** True when an upload may be a photo. An absent list (a host-built state) is PDF only. */
+declare function acceptsPhotos(types: readonly string[] | undefined): boolean;
+
+export { type RecordShareAudience as R, SHARE_RECIPIENT_EMAIL_MAX as S, type RecordsFeatures as a, type RecordsUploadContentType as b, type RecordShareLink as c, type RecordShareEmailInput as d, type RecordShareEmailReceipt as e, type RecordShare as f, type RecordPdfLink as g, RECORD_SHARE_AUDIENCES as h, type RecordShareAudienceScope as i, type RecordShareRecipientKind as j, isShareRecipientEmail as k, mapRecordShareEmailReceipt as l, mapRecordPdfLink as m, mapRecordShareLink as n, mapRecordShareList as o, mapShareAudiences as p, type RecordsPhotoContentType as q, resolveShareUrl as r, acceptsPhotos as s };