@opencoredev/social-sdk 0.1.2 → 0.2.1

package/dist/platforms/instagram.d.ts

@@ -0,0 +1,129 @@
+import type { AdapterOperationContext, ConnectedAccountRef, DeliveryOutcome, JsonObject, Page } from "../core/types.js";
+export interface InstagramOptions {
+    /** Instagram Login by default. Facebook Login is required for business discovery and hashtags. */
+    readonly auth: {
+        readonly accessToken: string;
+        readonly accountId: string;
+        readonly flavor?: "instagram-login" | "facebook-login";
+    };
+    readonly fetch?: typeof globalThis.fetch;
+    readonly clock?: () => Date;
+    readonly workflowStore?: InstagramWorkflowStore;
+}
+export interface InstagramNative {
+    readonly moderateComment: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly commentId: string;
+        readonly hidden: boolean;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly deleteComment: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly commentId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly setCommentsEnabled: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly mediaId: string;
+        readonly enabled: boolean;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly listCommentReplies: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly commentId: string;
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<Page<JsonObject>>;
+    readonly listMentions: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<Page<JsonObject>>;
+    readonly mentionedMedia: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly mediaId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly mentionedComment: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly commentId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly listTaggedMedia: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<Page<JsonObject>>;
+    readonly hashtagMedia: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly hashtagId: string;
+        readonly kind: "top" | "recent";
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<Page<JsonObject>>;
+    readonly businessDiscovery: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly username: string;
+        readonly fields?: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly publishReel: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly videoUrl: string;
+        readonly caption?: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<DeliveryOutcome>;
+    readonly publishStory: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly mediaUrl: string;
+        readonly videoUrl?: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<DeliveryOutcome>;
+    readonly deletePost: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly postId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly hashtagSearch: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly hashtag: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly publishingLimit: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly mentions: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly cursor?: string;
+        readonly limit?: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<Page<JsonObject>>;
+    readonly publishContainer: (account: ConnectedAccountRef, containerId: string, context: AdapterOperationContext, workflowId?: string) => Promise<DeliveryOutcome>;
+    readonly publishCarousel: (account: ConnectedAccountRef, children: readonly string[], caption: string, context: AdapterOperationContext) => Promise<DeliveryOutcome>;
+    readonly resumePublication: (account: ConnectedAccountRef, workflowId: string, context: AdapterOperationContext) => Promise<DeliveryOutcome>;
+}
+export interface InstagramWorkflow {
+    readonly id: string;
+    readonly backend: string;
+    readonly accountId: string;
+    readonly childIds: readonly string[];
+    readonly parentId?: string;
+    readonly nativeId?: string;
+    readonly caption: string;
+    readonly stage: "children" | "parent" | "published" | "unknown" | "failed";
+}
+export interface InstagramWorkflowStore {
+    create(input: Omit<InstagramWorkflow, "id">): Promise<InstagramWorkflow>;
+    get(id: string): Promise<InstagramWorkflow | undefined>;
+    update(id: string, update: Partial<InstagramWorkflow>): Promise<InstagramWorkflow>;
+    /** Atomically claim a workflow for continuation. */
+    claim(id: string): Promise<boolean>;
+    /** Release a transient continuation claim after the operation settles. */
+    release?(id: string): Promise<void>;
+}
+export declare function instagram(options: InstagramOptions): import("../core/adapter.js").SocialAdapter<InstagramNative>;