asfur 1.0.1

package/README.md

@@ -0,0 +1,40 @@
+# Taqila SDK
+
+A simple SDK for interacting with the Taqila API.
+
+## Installation
+
+```bash
+npm install Taqila
+# or
+yarn add Taqila
+```
+
+## Usage
+
+```typescript
+import { Taqila } from 'Taqila';
+
+const Taqila = new Taqila({
+  apiKey: 'your_api_key',
+});
+
+// Make API calls
+async function main() {
+  // Create a new Thread
+  const newThread = await Taqila.createThread();
+
+  // Get the Thread with all the messages
+  const getThread = await Taqila.getThread(newThread.id, {
+    limit: 20
+  });
+
+  // Add a message or messages to the thread
+  const addMessages = await Taqila.addMessages(newThread.id, [
+    {
+      role: 'user',
+      content: 'Hello, how are you?',
+    },
+  ]);
+}
+```

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export types for consumers
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,175 @@
+import { z } from 'zod';
+export declare const platformsList: readonly ["telegram", "facebook", "instagram", "tiktok", "website", "other"];
+export declare const sourceSchema: z.ZodObject<{
+    _id: z.ZodOptional<z.ZodString>;
+    platform: z.ZodEnum<["telegram", "facebook", "instagram", "tiktok", "website", "other"]>;
+    source_id: z.ZodString;
+    source_public_id: z.ZodOptional<z.ZodString>;
+    source_name: z.ZodString;
+    last_text_id: z.ZodOptional<z.ZodNumber>;
+    url: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    language: z.ZodOptional<z.ZodString>;
+    source_geo: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    status: z.ZodEnum<["approved", "pending", "rejected"]>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    created_at: z.ZodDate;
+    updated_at: z.ZodOptional<z.ZodDate>;
+}, "strip", z.ZodTypeAny, {
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website" | "other";
+    status: "approved" | "pending" | "rejected";
+    source_id: string;
+    source_name: string;
+    created_at: Date;
+    _id?: string | undefined;
+    source_public_id?: string | undefined;
+    last_text_id?: number | undefined;
+    url?: string | undefined;
+    description?: string | undefined;
+    language?: string | undefined;
+    source_geo?: string | undefined;
+    tags?: string[] | undefined;
+    metadata?: Record<string, any> | undefined;
+    updated_at?: Date | undefined;
+}, {
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website" | "other";
+    status: "approved" | "pending" | "rejected";
+    source_id: string;
+    source_name: string;
+    created_at: Date;
+    _id?: string | undefined;
+    source_public_id?: string | undefined;
+    last_text_id?: number | undefined;
+    url?: string | undefined;
+    description?: string | undefined;
+    language?: string | undefined;
+    source_geo?: string | undefined;
+    tags?: string[] | undefined;
+    metadata?: Record<string, any> | undefined;
+    updated_at?: Date | undefined;
+}>;
+/**
+ * ids:
+ * 1. _id: MongoDB ObjectId as string
+ * 2. source_id: reference to Source _id
+ * 3. platform_id: e.g., 'telegram:1234567890' (channel_id)
+ * 4. original_id: ID from the platform (e.g., message_id
+ *
+ * INDEXES:
+ * - source_id: reference to Source _id
+ * - timestamp: date in milliseconds (e.g., 1751210833000)
+ * - text_geo: array of strings (e.g., ["sinjil", "ramallah", "west bank"])
+ */
+export declare const textSchema: z.ZodObject<{
+    _id: z.ZodOptional<z.ZodString>;
+    source_id: z.ZodString;
+    source_name: z.ZodString;
+    platform_id: z.ZodString;
+    platform: z.ZodEnum<["telegram", "facebook", "instagram", "tiktok", "website", "other"]>;
+    original_text_id: z.ZodString;
+    original_text: z.ZodOptional<z.ZodString>;
+    translated_text: z.ZodOptional<z.ZodString>;
+    timestamp: z.ZodDate;
+    language: z.ZodOptional<z.ZodString>;
+    text_geo: z.ZodArray<z.ZodString, "many">;
+    source_geo: z.ZodOptional<z.ZodString>;
+    replied_to_post_id: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    created_at: z.ZodDate;
+    updated_at: z.ZodOptional<z.ZodDate>;
+    media: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["image", "video", "audio", "link"]>;
+        url: z.ZodString;
+        caption: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "image" | "video" | "audio" | "link";
+        url: string;
+        caption?: string | undefined;
+    }, {
+        type: "image" | "video" | "audio" | "link";
+        url: string;
+        caption?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website" | "other";
+    source_id: string;
+    source_name: string;
+    created_at: Date;
+    platform_id: string;
+    original_text_id: string;
+    timestamp: Date;
+    text_geo: string[];
+    _id?: string | undefined;
+    language?: string | undefined;
+    source_geo?: string | undefined;
+    metadata?: Record<string, any> | undefined;
+    updated_at?: Date | undefined;
+    original_text?: string | undefined;
+    translated_text?: string | undefined;
+    replied_to_post_id?: string | undefined;
+    media?: {
+        type: "image" | "video" | "audio" | "link";
+        url: string;
+        caption?: string | undefined;
+    }[] | undefined;
+}, {
+    platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website" | "other";
+    source_id: string;
+    source_name: string;
+    created_at: Date;
+    platform_id: string;
+    original_text_id: string;
+    timestamp: Date;
+    text_geo: string[];
+    _id?: string | undefined;
+    language?: string | undefined;
+    source_geo?: string | undefined;
+    metadata?: Record<string, any> | undefined;
+    updated_at?: Date | undefined;
+    original_text?: string | undefined;
+    translated_text?: string | undefined;
+    replied_to_post_id?: string | undefined;
+    media?: {
+        type: "image" | "video" | "audio" | "link";
+        url: string;
+        caption?: string | undefined;
+    }[] | undefined;
+}>;
+export declare const querySchema: z.ZodObject<{
+    sources: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    query: z.ZodOptional<z.ZodString>;
+    time_range: z.ZodOptional<z.ZodObject<{
+        start: z.ZodOptional<z.ZodDate>;
+        end: z.ZodOptional<z.ZodDate>;
+    }, "strip", z.ZodTypeAny, {
+        start?: Date | undefined;
+        end?: Date | undefined;
+    }, {
+        start?: Date | undefined;
+        end?: Date | undefined;
+    }>>;
+    user_id: z.ZodOptional<z.ZodString>;
+    thread_id: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    sources?: string[] | undefined;
+    query?: string | undefined;
+    time_range?: {
+        start?: Date | undefined;
+        end?: Date | undefined;
+    } | undefined;
+    user_id?: string | undefined;
+    thread_id?: string | undefined;
+}, {
+    sources?: string[] | undefined;
+    query?: string | undefined;
+    time_range?: {
+        start?: Date | undefined;
+        end?: Date | undefined;
+    } | undefined;
+    user_id?: string | undefined;
+    thread_id?: string | undefined;
+}>;
+export type SourceType = z.infer<typeof sourceSchema>;
+export type TextType = z.infer<typeof textSchema>;
+export type QueryType = z.infer<typeof querySchema>;

package/dist/types.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.querySchema = exports.textSchema = exports.sourceSchema = exports.platformsList = void 0;
+const zod_1 = require("zod");
+exports.platformsList = [
+    'telegram',
+    'facebook',
+    'instagram',
+    'tiktok',
+    'website',
+    'other',
+];
+exports.sourceSchema = zod_1.z.object({
+    _id: zod_1.z.string().optional(),
+    platform: zod_1.z.enum(exports.platformsList),
+    source_id: zod_1.z.string(),
+    source_public_id: zod_1.z.string().optional(),
+    source_name: zod_1.z.string(),
+    last_text_id: zod_1.z.number().optional(),
+    url: zod_1.z.string().url().optional(),
+    description: zod_1.z.string().optional(),
+    language: zod_1.z.string().optional(),
+    source_geo: zod_1.z.string().optional(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    status: zod_1.z.enum(['approved', 'pending', 'rejected']),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    created_at: zod_1.z.coerce.date(),
+    updated_at: zod_1.z.coerce.date().optional(),
+});
+/**
+ * ids:
+ * 1. _id: MongoDB ObjectId as string
+ * 2. source_id: reference to Source _id
+ * 3. platform_id: e.g., 'telegram:1234567890' (channel_id)
+ * 4. original_id: ID from the platform (e.g., message_id
+ *
+ * INDEXES:
+ * - source_id: reference to Source _id
+ * - timestamp: date in milliseconds (e.g., 1751210833000)
+ * - text_geo: array of strings (e.g., ["sinjil", "ramallah", "west bank"])
+ */
+exports.textSchema = zod_1.z.object({
+    _id: zod_1.z.string().optional(),
+    source_id: zod_1.z.string(),
+    source_name: zod_1.z.string(),
+    platform_id: zod_1.z.string(),
+    platform: zod_1.z.enum(exports.platformsList),
+    original_text_id: zod_1.z.string(),
+    original_text: zod_1.z.string().optional(),
+    translated_text: zod_1.z.string().optional(),
+    timestamp: zod_1.z.coerce.date(),
+    language: zod_1.z.string().optional(),
+    text_geo: zod_1.z.array(zod_1.z.string()),
+    source_geo: zod_1.z.string().optional(),
+    replied_to_post_id: zod_1.z.string().optional(),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    created_at: zod_1.z.coerce.date(),
+    updated_at: zod_1.z.coerce.date().optional(),
+    media: zod_1.z
+        .array(zod_1.z.object({
+        type: zod_1.z.enum(['image', 'video', 'audio', 'link']),
+        url: zod_1.z.string().url(),
+        caption: zod_1.z.string().optional(),
+    }))
+        .optional(), // media attachments
+});
+exports.querySchema = zod_1.z.object({
+    sources: zod_1.z.array(zod_1.z.string()).optional(),
+    query: zod_1.z.string().optional(),
+    time_range: zod_1.z
+        .object({
+        start: zod_1.z.coerce.date().optional(),
+        end: zod_1.z.coerce.date().optional(), // end date
+    })
+        .optional(),
+    user_id: zod_1.z.string().optional(),
+    thread_id: zod_1.z.string().optional(), // optional thread identifier
+});

package/index.ts

@@ -0,0 +1,2 @@
+// Export types for consumers
+export * from './types';

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "asfur",
+  "version": "1.0.1",
+  "description": "SDK for interacting with the Asfur API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "url": "https://github.com/eretztzvi/asfur.sdk",
+    "type": "git"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prepublish": "npm run build"
+  },
+  "keywords": [
+    "asfur",
+    "sdk",
+    "api"
+  ],
+  "author": "deerland",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "jest": "^29.5.0",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "axios": "^1.9.0",
+    "zod": "^3.25.76"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["index.ts", "types.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/types.ts

@@ -0,0 +1,86 @@
+import { z } from 'zod';
+
+export const platformsList = [
+  'telegram',
+  'facebook',
+  'instagram',
+  'tiktok',
+  'website',
+  'other',
+] as const;
+
+export const sourceSchema = z.object({
+  _id: z.string().optional(),
+  platform: z.enum(platformsList), // e.g., 'telegram', 'facebook'
+  source_id: z.string(), // original channel_id
+  source_public_id: z.string().optional(), // e.g., '@telegram_channel_id'
+  source_name: z.string(), // e.g., 'Telegram Channel Name'
+  last_text_id: z.number().optional(), // last processed text ID
+  url: z.string().url().optional(), // e.g., 'https://t.me/telegram_channel_name'
+  description: z.string().optional(), // e.g., 'A channel about news and updates'
+  language: z.string().optional(),
+  source_geo: z.string().optional(), // e.g., country or region
+  tags: z.array(z.string()).optional(),
+  status: z.enum(['approved', 'pending', 'rejected']), // INDEX
+  metadata: z.record(z.string(), z.any()).optional(), // flexible per platform
+  created_at: z.coerce.date(),
+  updated_at: z.coerce.date().optional(),
+});
+
+/**
+ * ids:
+ * 1. _id: MongoDB ObjectId as string
+ * 2. source_id: reference to Source _id
+ * 3. platform_id: e.g., 'telegram:1234567890' (channel_id)
+ * 4. original_id: ID from the platform (e.g., message_id
+ *
+ * INDEXES:
+ * - source_id: reference to Source _id
+ * - timestamp: date in milliseconds (e.g., 1751210833000)
+ * - text_geo: array of strings (e.g., ["sinjil", "ramallah", "west bank"])
+ */
+
+export const textSchema = z.object({
+  _id: z.string().optional(),
+  source_id: z.string(), // INDEX - reference to Source _id (e.g., '60c72b2f9b1e8d3f4c8b4567')
+  source_name: z.string(), // e.g., 'Telegram Channel Name'
+  platform_id: z.string(), // channel_id reference to Source source_id
+  platform: z.enum(platformsList), // e.g., 'telegram', 'facebook'
+  original_text_id: z.string(), // message_id
+  original_text: z.string().optional(), // original text content
+  translated_text: z.string().optional(), // translated text if available - most of the time it will be translated to English
+  timestamp: z.coerce.date(), // INDEX - date in milliseconds - e.g., 1751210833000
+  language: z.string().optional(),
+  text_geo: z.array(z.string()), // INDEX - e.g., ["sinjil", "ramallah", "west bank"]
+  source_geo: z.string().optional(), // e.g., 'hebron'
+  replied_to_post_id: z.string().optional(),
+  metadata: z.record(z.string(), z.any()).optional(), // platform-specific fields
+  created_at: z.coerce.date(),
+  updated_at: z.coerce.date().optional(),
+  media: z
+    .array(
+      z.object({
+        type: z.enum(['image', 'video', 'audio', 'link']),
+        url: z.string().url(),
+        caption: z.string().optional(),
+      })
+    )
+    .optional(), // media attachments
+});
+
+export const querySchema = z.object({
+  sources: z.array(z.string()).optional(), // array of source _id strings
+  query: z.string().optional(), // search query includes geo information where it should be extracted with LLM
+  time_range: z
+    .object({
+      start: z.coerce.date().optional(), // start date
+      end: z.coerce.date().optional(), // end date
+    })
+    .optional(),
+  user_id: z.string().optional(), // optional user identifier
+  thread_id: z.string().optional(), // optional thread identifier
+});
+
+export type SourceType = z.infer<typeof sourceSchema>;
+export type TextType = z.infer<typeof textSchema>;
+export type QueryType = z.infer<typeof querySchema>;