@opencoredev/social-sdk 0.3.0 → 0.4.0

package/dist/core/idempotency.d.ts

@@ -22,8 +22,13 @@ export interface IdempotencyStore {
         readonly outcome: DeliveryOutcome;
     }): Promise<void>;
 }
-export declare function stableSerialize(value: unknown): string;
-export declare function fingerprint(value: unknown): Promise<string>;
+/**
+ * Serializes any caller value to canonical JSON. The input is parsed at runtime:
+ * non-finite numbers, bigints, symbols, functions, `Blob`s, and cycles throw a TypeError.
+ */
+export declare function stableSerialize<Payload>(value: Payload): string;
+/** SHA-256 hex digest of {@link stableSerialize}. */
+export declare function fingerprint<Payload>(value: Payload): Promise<string>;
 export declare function deriveTargetIdempotencyKey(input: {
     readonly logicalKey: string;
     readonly scope?: string;

package/dist/core/idempotency.js

@@ -1,43 +1,59 @@
+function isJsonScalar(value) {
+    return value === null || typeof value === "string" || typeof value === "boolean";
+}
+function isNumber(value) {
+    return typeof value === "number";
+}
+/** Arrays and plain or class objects; excludes bigints, symbols, and functions. */
+function isWalkableObject(value) {
+    return typeof value === "object" && value !== null;
+}
+/**
+ * Parses an arbitrary caller value into canonical JSON: object keys are sorted,
+ * undefined properties are dropped, and values JSON cannot represent throw a TypeError.
+ */
 function normalizeForJson(value, seen) {
-    if (value === null || typeof value === "string" || typeof value === "boolean")
+    if (isJsonScalar(value))
         return value;
-    if (typeof value === "number") {
+    if (isNumber(value)) {
         if (!Number.isFinite(value))
             throw new TypeError("Idempotency payload numbers must be finite");
         return value;
     }
-    if (typeof value === "undefined")
+    if (value === undefined)
         return undefined;
-    if (typeof value === "bigint" || typeof value === "symbol" || typeof value === "function") {
+    if (!isWalkableObject(value))
         throw new TypeError("Idempotency payload must be JSON-safe");
-    }
     if (Array.isArray(value)) {
         if (seen.has(value))
             throw new TypeError("Idempotency payload must not contain cycles");
         seen.add(value);
-        const result = value.map((entry) => normalizeForJson(entry, seen));
+        // JSON.stringify writes an undefined array entry as null, so mapping it here keeps the output identical.
+        const result = value.map((entry) => normalizeForJson(entry, seen) ?? null);
         seen.delete(value);
         return result;
     }
     if (typeof Blob !== "undefined" && value instanceof Blob) {
         throw new TypeError("Blob inputs require a caller-provided media fingerprint");
     }
-    if (typeof value === "object") {
-        if (seen.has(value))
-            throw new TypeError("Idempotency payload must not contain cycles");
-        seen.add(value);
-        const entries = Object.entries(value).sort(([left], [right]) => left.localeCompare(right));
-        const result = {};
-        for (const [key, entry] of entries) {
-            const normalized = normalizeForJson(entry, seen);
-            if (normalized !== undefined)
-                result[key] = normalized;
-        }
-        seen.delete(value);
-        return result;
+    if (seen.has(value))
+        throw new TypeError("Idempotency payload must not contain cycles");
+    seen.add(value);
+    const entries = Object.entries(value);
+    entries.sort(([left], [right]) => left.localeCompare(right));
+    const result = {};
+    for (const [key, entry] of entries) {
+        const normalized = normalizeForJson(entry, seen);
+        if (normalized !== undefined)
+            result[key] = normalized;
     }
-    throw new TypeError("Unsupported idempotency payload value");
+    seen.delete(value);
+    return result;
 }
+/**
+ * Serializes any caller value to canonical JSON. The input is parsed at runtime:
+ * non-finite numbers, bigints, symbols, functions, `Blob`s, and cycles throw a TypeError.
+ */
 export function stableSerialize(value) {
     return JSON.stringify(normalizeForJson(value, new Set()));
 }
@@ -47,6 +63,7 @@ function bytesToHex(bytes) {
         result += byte.toString(16).padStart(2, "0");
     return result;
 }
+/** SHA-256 hex digest of {@link stableSerialize}. */
 export async function fingerprint(value) {
     const bytes = new TextEncoder().encode(stableSerialize(value));
     const digest = await crypto.subtle.digest("SHA-256", bytes);

package/dist/core/pagination.js

@@ -56,18 +56,19 @@ export function encodeCursor(scope, value) {
         });
     return `social-v1.${encodeURIComponent(JSON.stringify([scope, value]))}`;
 }
+/** A decoded cursor body: `[scope, upstreamCursor]`. */
+function isCursorPayload(value) {
+    return (Array.isArray(value) &&
+        value.length === 2 &&
+        typeof value[0] === "string" &&
+        typeof value[1] === "string");
+}
 export function decodeCursor(scope, cursor) {
     try {
         if (!cursor.startsWith("social-v1.") || cursor.length > 100_000)
             throw new Error();
         const parsed = JSON.parse(decodeURIComponent(cursor.slice(10)));
-        if (!Array.isArray(parsed) ||
-            parsed.length !== 2 ||
-            parsed[0] !== scope ||
-            // oxlint-disable-next-line anti-slop/no-runtime-typeof -- Validate the untrusted decoded cursor tuple.
-            typeof parsed[1] !== "string" ||
-            !parsed[1] ||
-            parsed[1].length > 16_384)
+        if (!isCursorPayload(parsed) || parsed[0] !== scope || !parsed[1] || parsed[1].length > 16_384)
             throw new Error();
         return parsed[1];
     }

package/dist/core/types.d.ts

@@ -94,7 +94,8 @@ export type MediaInput = {
     readonly fingerprint: string;
 };
 export interface MediaAttachment {
-    readonly kind: "image" | "video";
+    /** `document` covers paged files such as PDF, PPTX or DOCX where a platform accepts them. */
+    readonly kind: "image" | "video" | "document";
     readonly source: MediaInput;
     readonly mimeType?: string;
     readonly filename?: string;
@@ -327,7 +328,7 @@ export interface CapabilityDeclaration {
     readonly operation: string;
     readonly platform: Platform | "*";
     readonly availability: CapabilityAvailability;
-    readonly formats?: readonly ("text" | "image" | "video" | "carousel" | "sequence")[];
+    readonly formats?: readonly ("text" | "image" | "video" | "carousel" | "sequence" | "document")[];
     readonly requiredScopes?: readonly string[];
     readonly notes?: string;
 }

package/dist/platforms/bluesky.d.ts

@@ -17,6 +17,36 @@ export interface BlueskyOptions {
         readonly did: string;
         readonly fetchHandler: (pathname: string, init?: RequestInit) => Promise<Response>;
     };
+    /** HTTPS origin of the Bluesky video service. Defaults to https://video.bsky.app. */
+    readonly videoService?: string;
+    /**
+     * Service DID of the account's PDS (for example `did:web:pds.example.com`). It is the
+     * audience of the service token that lets the video service store the processed blob.
+     * When omitted, `uploadVideo` reads the `#atproto_pds` endpoint from the DID document
+     * returned by `com.atproto.server.getSession`.
+     */
+    readonly pdsDid?: string;
+}
+/** A Bluesky video processing job (`app.bsky.video.defs#jobStatus`). */
+export interface BlueskyVideoJob {
+    readonly jobId: string;
+    readonly did: string;
+    /** `JOB_STATE_COMPLETED`, `JOB_STATE_FAILED`, or an in-progress state. */
+    readonly state: string;
+    readonly progress?: number;
+    /** The processed blob. Present once the video is stored on the PDS. */
+    readonly blob?: JsonObject;
+    readonly failureCode?: string;
+    readonly error?: string;
+    readonly message?: string;
+}
+/** Output of `app.bsky.video.getUploadLimits` for the configured account. */
+export interface BlueskyVideoUploadLimits {
+    readonly canUpload: boolean;
+    readonly remainingDailyVideos?: number;
+    readonly remainingDailyBytes?: number;
+    readonly message?: string;
+    readonly error?: string;
 }
 export interface BlueskyPostRef {
     readonly uri: string;
@@ -84,12 +114,29 @@ export interface BlueskyNative {
         readonly account: ConnectedAccountRef;
         readonly context?: AdapterOperationContext;
     }) => Promise<void>;
+    /**
+     * Sends one MP4 to the video service with a single upload request and returns the
+     * processing job. It does not wait for processing; poll `getVideoJobStatus` explicitly.
+     */
     readonly uploadVideo: (input: {
         readonly account: ConnectedAccountRef;
         readonly video: Blob;
         readonly mimeType?: string;
+        /** File name reported to the video service. Defaults to `video.mp4`. */
+        readonly name?: string;
         readonly context?: AdapterOperationContext;
-    }) => Promise<JsonObject>;
+    }) => Promise<BlueskyVideoJob>;
+    /** Reads a video processing job once. The caller decides when to check again. */
+    readonly getVideoJobStatus: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly jobId: string;
+        readonly context?: AdapterOperationContext;
+    }) => Promise<BlueskyVideoJob>;
+    /** Reads the account's daily video upload allowance from the video service. */
+    readonly getVideoUploadLimits: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly context?: AdapterOperationContext;
+    }) => Promise<BlueskyVideoUploadLimits>;
     readonly follow: (input: {
         readonly account: ConnectedAccountRef;
         readonly did: string;
@@ -186,6 +233,23 @@ export interface BlueskyNative {
         readonly text: string;
         readonly context?: AdapterOperationContext;
     }) => Promise<JsonObject>;
+    /**
+     * Hides or unhides a reply in a thread whose root post belongs to this account.
+     * Updates the root post's `app.bsky.feed.threadgate` record `hiddenReplies` list.
+     */
+    readonly hideReply: (input: BlueskyHideReplyInput) => Promise<BlueskyHideReplyResult>;
+}
+export interface BlueskyHideReplyInput {
+    readonly account: ConnectedAccountRef;
+    /** AT-URI of the reply post to hide or unhide. */
+    readonly replyUri: string;
+    readonly hidden: boolean;
+    readonly context?: AdapterOperationContext;
+}
+export interface BlueskyHideReplyResult {
+    readonly hidden: boolean;
+    /** The threadgate record after the change. Absent when no threadgate exists. */
+    readonly threadgate?: BlueskyPostRef;
 }
 export interface BlueskyPageInput {
     readonly account: ConnectedAccountRef;