harvester_sdk 1.0.1

package/README.md

@@ -0,0 +1,16 @@
+# Asfur SDK
+
+A simple SDK for interacting with the Asfur API.
+
+## Installation
+
+```bash
+npm install asfur
+# or
+yarn add asfur
+```
+
+## Usage
+
+```typescript
+import { SourceType, TextType, QueryType } from 'asfur';

package/dist/index.d.ts

@@ -0,0 +1,627 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+export * from './types';
+import { Schema } from 'mongoose';
+export declare const MongoDataSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    timestamp: number;
+    text_geo: string[];
+    source_id: any;
+    source_name: string;
+    media: import("mongoose").Types.DocumentArray<{
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }> & {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }>;
+    language?: string | null | undefined;
+    metadata?: any;
+    source_region?: string | null | undefined;
+    source_public_id?: any;
+    platform_id?: any;
+    original_text_id?: any;
+    original_text?: string | null | undefined;
+    translated_text?: string | null | undefined;
+    is_reply?: boolean | null | undefined;
+    reply_to_message_id?: any;
+    author?: string | null | undefined;
+    replies?: any;
+    entities?: any;
+    author_username?: string | null | undefined;
+    author_id?: string | null | undefined;
+    source_geo?: string | null | undefined;
+    pipeline_name?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    timestamp: number;
+    text_geo: string[];
+    source_id: any;
+    source_name: string;
+    media: import("mongoose").Types.DocumentArray<{
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }> & {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }>;
+    language?: string | null | undefined;
+    metadata?: any;
+    source_region?: string | null | undefined;
+    source_public_id?: any;
+    platform_id?: any;
+    original_text_id?: any;
+    original_text?: string | null | undefined;
+    translated_text?: string | null | undefined;
+    is_reply?: boolean | null | undefined;
+    reply_to_message_id?: any;
+    author?: string | null | undefined;
+    replies?: any;
+    entities?: any;
+    author_username?: string | null | undefined;
+    author_id?: string | null | undefined;
+    source_geo?: string | null | undefined;
+    pipeline_name?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    timestamp: number;
+    text_geo: string[];
+    source_id: any;
+    source_name: string;
+    media: import("mongoose").Types.DocumentArray<{
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }, import("mongoose").Types.Subdocument<import("mongoose").Types.ObjectId, any, {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }> & {
+        type?: "image" | "video" | "audio" | "link" | null | undefined;
+        url?: string | null | undefined;
+        caption?: string | null | undefined;
+    }>;
+    language?: string | null | undefined;
+    metadata?: any;
+    source_region?: string | null | undefined;
+    source_public_id?: any;
+    platform_id?: any;
+    original_text_id?: any;
+    original_text?: string | null | undefined;
+    translated_text?: string | null | undefined;
+    is_reply?: boolean | null | undefined;
+    reply_to_message_id?: any;
+    author?: string | null | undefined;
+    replies?: any;
+    entities?: any;
+    author_username?: string | null | undefined;
+    author_id?: string | null | undefined;
+    source_geo?: string | null | undefined;
+    pipeline_name?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoInstructionsSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: number;
+    updated_at: number;
+    user_id: string;
+    prompt?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    user_id: string;
+    prompt?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    user_id: string;
+    prompt?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoRegionSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    name: string;
+    slug: string;
+    created_at: number;
+    updated_at: number;
+    legend?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    name: string;
+    slug: string;
+    created_at: number;
+    updated_at: number;
+    legend?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    name: string;
+    slug: string;
+    created_at: number;
+    updated_at: number;
+    legend?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoSourceGroupSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    name: string;
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    max_active_sources?: number | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    name: string;
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    max_active_sources?: number | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    name: string;
+    created_at: number;
+    updated_at: number;
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    max_active_sources?: number | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    name: string;
+    created_at: number;
+    updated_at: number;
+    status: "active" | "pending" | "inactive" | "requested";
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    entity: "website" | "profile" | "group" | "page" | "channel" | "hashtag";
+    tags: string[];
+    is_public: boolean;
+    metadata: any;
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    title?: string | null | undefined;
+    public_id?: any;
+    url?: string | null | undefined;
+    language?: string | null | undefined;
+    group_id?: string | null | undefined;
+    requested_by?: {
+        user_id?: string | null | undefined;
+        username?: string | null | undefined;
+        full_name?: string | null | undefined;
+        email?: string | null | undefined;
+        requested_at?: number | null | undefined;
+    } | null | undefined;
+    notes?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    name: string;
+    created_at: number;
+    updated_at: number;
+    status: "active" | "pending" | "inactive" | "requested";
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    entity: "website" | "profile" | "group" | "page" | "channel" | "hashtag";
+    tags: string[];
+    is_public: boolean;
+    metadata: any;
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    title?: string | null | undefined;
+    public_id?: any;
+    url?: string | null | undefined;
+    language?: string | null | undefined;
+    group_id?: string | null | undefined;
+    requested_by?: {
+        user_id?: string | null | undefined;
+        username?: string | null | undefined;
+        full_name?: string | null | undefined;
+        email?: string | null | undefined;
+        requested_at?: number | null | undefined;
+    } | null | undefined;
+    notes?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    name: string;
+    created_at: number;
+    updated_at: number;
+    status: "active" | "pending" | "inactive" | "requested";
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
+    entity: "website" | "profile" | "group" | "page" | "channel" | "hashtag";
+    tags: string[];
+    is_public: boolean;
+    metadata: any;
+    description?: string | null | undefined;
+    region_id?: string | null | undefined;
+    title?: string | null | undefined;
+    public_id?: any;
+    url?: string | null | undefined;
+    language?: string | null | undefined;
+    group_id?: string | null | undefined;
+    requested_by?: {
+        user_id?: string | null | undefined;
+        username?: string | null | undefined;
+        full_name?: string | null | undefined;
+        email?: string | null | undefined;
+        requested_at?: number | null | undefined;
+    } | null | undefined;
+    notes?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoQuerySchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    user_id: string;
+    timestamp: number;
+    geos: string[];
+    sources: string[];
+    geos_ids: string[];
+    time_range: any;
+    title?: string | null | undefined;
+    query?: string | null | undefined;
+    user_instructions?: string | null | undefined;
+    user_time_zone?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    user_id: string;
+    timestamp: number;
+    geos: string[];
+    sources: string[];
+    geos_ids: string[];
+    time_range: any;
+    title?: string | null | undefined;
+    query?: string | null | undefined;
+    user_instructions?: string | null | undefined;
+    user_time_zone?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    user_id: string;
+    timestamp: number;
+    geos: string[];
+    sources: string[];
+    geos_ids: string[];
+    time_range: any;
+    title?: string | null | undefined;
+    query?: string | null | undefined;
+    user_instructions?: string | null | undefined;
+    user_time_zone?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoUserSettingsSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    geos: string[];
+    sources: string[];
+    has_jobs_access: boolean;
+    active_jobs_limit: number;
+    time_range?: any;
+    thread_id?: string | null | undefined;
+    instructions?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    geos: string[];
+    sources: string[];
+    has_jobs_access: boolean;
+    active_jobs_limit: number;
+    time_range?: any;
+    thread_id?: string | null | undefined;
+    instructions?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    geos: string[];
+    sources: string[];
+    has_jobs_access: boolean;
+    active_jobs_limit: number;
+    time_range?: any;
+    thread_id?: string | null | undefined;
+    instructions?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoConversationSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    is_job: boolean;
+    title?: string | null | undefined;
+    thread_id?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    is_job: boolean;
+    title?: string | null | undefined;
+    thread_id?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: NativeDate;
+    updated_at: NativeDate;
+    status: "active" | "inactive";
+    user_id: string;
+    is_job: boolean;
+    title?: string | null | undefined;
+    thread_id?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoJobSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    query: any;
+    job_name: string;
+    thread_id?: string | null | undefined;
+    job_description?: string | null | undefined;
+    schedule?: string | null | undefined;
+    schedule_text?: string | null | undefined;
+    active_until?: number | null | undefined;
+    conversation_id?: string | null | undefined;
+    time_zone?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    query: any;
+    job_name: string;
+    thread_id?: string | null | undefined;
+    job_description?: string | null | undefined;
+    schedule?: string | null | undefined;
+    schedule_text?: string | null | undefined;
+    active_until?: number | null | undefined;
+    conversation_id?: string | null | undefined;
+    time_zone?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    query: any;
+    job_name: string;
+    thread_id?: string | null | undefined;
+    job_description?: string | null | undefined;
+    schedule?: string | null | undefined;
+    schedule_text?: string | null | undefined;
+    active_until?: number | null | undefined;
+    conversation_id?: string | null | undefined;
+    time_zone?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoGeoSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    subscribers: string[];
+    is_used: boolean;
+    geo_text?: string | null | undefined;
+    timestamp?: number | null | undefined;
+    count?: number | null | undefined;
+    region?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    subscribers: string[];
+    is_used: boolean;
+    geo_text?: string | null | undefined;
+    timestamp?: number | null | undefined;
+    count?: number | null | undefined;
+    region?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    subscribers: string[];
+    is_used: boolean;
+    geo_text?: string | null | undefined;
+    timestamp?: number | null | undefined;
+    count?: number | null | undefined;
+    region?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoGeoSelectionSchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    geos: string[];
+    created_at?: number | null | undefined;
+    updated_at?: number | null | undefined;
+    type?: string | null | undefined;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    region?: string | null | undefined;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    geos: string[];
+    created_at?: number | null | undefined;
+    updated_at?: number | null | undefined;
+    type?: string | null | undefined;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    region?: string | null | undefined;
+}>, {}> & import("mongoose").FlatRecord<{
+    geos: string[];
+    created_at?: number | null | undefined;
+    updated_at?: number | null | undefined;
+    type?: string | null | undefined;
+    description?: string | null | undefined;
+    title?: string | null | undefined;
+    region?: string | null | undefined;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare const MongoApiKeySchema: Schema<any, import("mongoose").Model<any, any, any, any, any, any>, {}, {}, {}, {}, {
+    versionKey: false;
+    toJSON: {
+        virtuals: true;
+    };
+    toObject: {
+        virtuals: true;
+    };
+}, {
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    api_key: string;
+}, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    api_key: string;
+}>, {}> & import("mongoose").FlatRecord<{
+    created_at: number;
+    updated_at: number;
+    status: "active" | "inactive";
+    user_id: string;
+    api_key: string;
+}> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;