harvester_sdk 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -266,6 +266,7 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
     tags: string[];
     is_public: boolean;
     metadata: any;
+    notes?: string | null | undefined;
     description?: string | null | undefined;
     region_id?: string | null | undefined;
     title?: string | null | undefined;
@@ -280,7 +281,6 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
         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;
@@ -291,6 +291,7 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
     tags: string[];
     is_public: boolean;
     metadata: any;
+    notes?: string | null | undefined;
     description?: string | null | undefined;
     region_id?: string | null | undefined;
     title?: string | null | undefined;
@@ -305,7 +306,6 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
         email?: string | null | undefined;
         requested_at?: number | null | undefined;
     } | null | undefined;
-    notes?: string | null | undefined;
 }>, {}> & import("mongoose").FlatRecord<{
     name: string;
     created_at: number;
@@ -316,6 +316,7 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
     tags: string[];
     is_public: boolean;
     metadata: any;
+    notes?: string | null | undefined;
     description?: string | null | undefined;
     region_id?: string | null | undefined;
     title?: string | null | undefined;
@@ -330,7 +331,6 @@ export declare const MongoSourceSchema: Schema<any, import("mongoose").Model<any
         email?: string | null | undefined;
         requested_at?: number | null | undefined;
     } | null | undefined;
-    notes?: string | null | undefined;
 }> & {
     _id: import("mongoose").Types.ObjectId;
 } & {
@@ -393,7 +393,7 @@ export declare const MongoUserSettingsSchema: Schema<any, import("mongoose").Mod
 }, {
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     geos: string[];
     sources: string[];
@@ -405,7 +405,7 @@ export declare const MongoUserSettingsSchema: Schema<any, import("mongoose").Mod
 }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     geos: string[];
     sources: string[];
@@ -417,7 +417,7 @@ export declare const MongoUserSettingsSchema: Schema<any, import("mongoose").Mod
 }>, {}> & import("mongoose").FlatRecord<{
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     geos: string[];
     sources: string[];
@@ -442,7 +442,7 @@ export declare const MongoConversationSchema: Schema<any, import("mongoose").Mod
 }, {
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     is_job: boolean;
     title?: string | null | undefined;
@@ -450,7 +450,7 @@ export declare const MongoConversationSchema: Schema<any, import("mongoose").Mod
 }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     is_job: boolean;
     title?: string | null | undefined;
@@ -458,7 +458,7 @@ export declare const MongoConversationSchema: Schema<any, import("mongoose").Mod
 }>, {}> & import("mongoose").FlatRecord<{
     created_at: NativeDate;
     updated_at: NativeDate;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     is_job: boolean;
     title?: string | null | undefined;
@@ -479,7 +479,7 @@ export declare const MongoJobSchema: Schema<any, import("mongoose").Model<any, a
 }, {
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     query: any;
     job_name: string;
@@ -493,7 +493,7 @@ export declare const MongoJobSchema: Schema<any, import("mongoose").Model<any, a
 }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     query: any;
     job_name: string;
@@ -507,7 +507,7 @@ export declare const MongoJobSchema: Schema<any, import("mongoose").Model<any, a
 }>, {}> & import("mongoose").FlatRecord<{
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     query: any;
     job_name: string;
@@ -605,19 +605,19 @@ export declare const MongoApiKeySchema: Schema<any, import("mongoose").Model<any
 }, {
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     api_key: string;
 }, import("mongoose").Document<unknown, {}, import("mongoose").FlatRecord<{
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     api_key: string;
 }>, {}> & import("mongoose").FlatRecord<{
     created_at: number;
     updated_at: number;
-    status: "active" | "inactive";
+    status: "active" | "inactive" | "deleted";
     user_id: string;
     api_key: string;
 }> & {

package/dist/types.d.ts

@@ -9,7 +9,7 @@ export declare const platformEntityMap: {
     readonly website: readonly ["website"];
 };
 export declare const zodSourceStatusList: readonly ["active", "pending", "inactive", "requested", "deleted"];
-export declare const generalStatusList: readonly ["active", "inactive"];
+export declare const generalStatusList: readonly ["active", "inactive", "deleted"];
 export declare const zodRegionSchema: z.ZodObject<{
     _id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
@@ -17,6 +17,8 @@ export declare const zodRegionSchema: z.ZodObject<{
     legend: z.ZodOptional<z.ZodString>;
     created_at: z.ZodOptional<z.ZodNumber>;
     updated_at: z.ZodOptional<z.ZodNumber>;
+    status: z.ZodOptional<z.ZodEnum<["active", "inactive", "deleted"]>>;
+    notes: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     slug: string;
@@ -24,6 +26,8 @@ export declare const zodRegionSchema: z.ZodObject<{
     legend?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    status?: "active" | "inactive" | "deleted" | undefined;
+    notes?: string | undefined;
 }, {
     name: string;
     slug: string;
@@ -31,6 +35,8 @@ export declare const zodRegionSchema: z.ZodObject<{
     legend?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    status?: "active" | "inactive" | "deleted" | undefined;
+    notes?: string | undefined;
 }>;
 export declare const zodSourceGroupSchema: z.ZodObject<{
     _id: z.ZodOptional<z.ZodString>;
@@ -41,12 +47,16 @@ export declare const zodSourceGroupSchema: z.ZodObject<{
     max_active_sources: z.ZodOptional<z.ZodNumber>;
     created_at: z.ZodOptional<z.ZodNumber>;
     updated_at: z.ZodOptional<z.ZodNumber>;
+    notes: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<["active", "inactive", "deleted"]>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     platform: "telegram" | "facebook" | "instagram" | "tiktok" | "website";
     _id?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    status?: "active" | "inactive" | "deleted" | undefined;
+    notes?: string | undefined;
     description?: string | undefined;
     region_id?: string | undefined;
     max_active_sources?: number | undefined;
@@ -56,6 +66,8 @@ export declare const zodSourceGroupSchema: z.ZodObject<{
     _id?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    status?: "active" | "inactive" | "deleted" | undefined;
+    notes?: string | undefined;
     description?: string | undefined;
     region_id?: string | undefined;
     max_active_sources?: number | undefined;
@@ -107,6 +119,7 @@ export declare const zodSourceSchema: z.ZodObject<{
     _id?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    notes?: string | undefined;
     description?: string | undefined;
     region_id?: string | undefined;
     title?: string | undefined;
@@ -123,7 +136,6 @@ export declare const zodSourceSchema: z.ZodObject<{
         email?: string | undefined;
         requested_at?: number | undefined;
     } | undefined;
-    notes?: string | undefined;
 }, {
     name: string;
     status: "active" | "pending" | "inactive" | "requested" | "deleted";
@@ -132,6 +144,7 @@ export declare const zodSourceSchema: z.ZodObject<{
     _id?: string | undefined;
     created_at?: number | undefined;
     updated_at?: number | undefined;
+    notes?: string | undefined;
     description?: string | undefined;
     region_id?: string | undefined;
     title?: string | undefined;
@@ -149,7 +162,6 @@ export declare const zodSourceSchema: z.ZodObject<{
         email?: string | undefined;
         requested_at?: number | undefined;
     } | undefined;
-    notes?: string | undefined;
 }>;
 export declare const zodGeoSchema: z.ZodObject<{
     _id: z.ZodOptional<z.ZodString>;
@@ -319,5 +331,5 @@ export type TimeRangeTypeLiteral = 'relative' | 'absolute';
 export type AddSourceToReviewType = Pick<SourceType, 'platform' | 'url' | 'description'> & Partial<Pick<SourceType, 'public_id'>>;
 export type GeoType = z.infer<typeof zodGeoSchema>;
 export type GeoSelectionType = z.infer<typeof zodGeoSelectionSchema>;
-export type PlatformEntityType<T extends typeof platformsList[number]> = typeof platformEntityMap[T][number];
+export type PlatformEntityType<T extends (typeof platformsList)[number]> = (typeof platformEntityMap)[T][number];
 export declare const getAllowedEntitiesForPlatform: (platform: (typeof platformsList)[number]) => readonly ["channel", "group"] | readonly ["profile", "page", "group"] | readonly ["profile", "hashtag"] | readonly ["website"];

package/dist/types.js

@@ -9,7 +9,14 @@ exports.platformsList = [
     'tiktok',
     'website',
 ];
-exports.entityTypesList = ['profile', 'group', 'page', 'channel', 'hashtag', 'website'];
+exports.entityTypesList = [
+    'profile',
+    'group',
+    'page',
+    'channel',
+    'hashtag',
+    'website',
+];
 // Platform-specific entity mappings
 exports.platformEntityMap = {
     telegram: ['channel', 'group'],
@@ -23,16 +30,18 @@ exports.zodSourceStatusList = [
     'pending',
     'inactive',
     'requested',
-    'deleted' // sources that have been deleted
+    'deleted', // sources that have been deleted
 ];
-exports.generalStatusList = ['active', 'inactive'];
+exports.generalStatusList = ['active', 'inactive', 'deleted'];
 exports.zodRegionSchema = zod_1.z.object({
     _id: zod_1.z.string().optional(),
     name: zod_1.z.string(),
     slug: zod_1.z.string(),
     legend: zod_1.z.string().optional(),
     created_at: zod_1.z.number().optional(),
-    updated_at: zod_1.z.number().optional(), // last update date
+    updated_at: zod_1.z.number().optional(),
+    status: zod_1.z.enum(exports.generalStatusList).optional(),
+    notes: zod_1.z.string().optional(), // internal notes about the region
 });
 exports.zodSourceGroupSchema = zod_1.z.object({
     _id: zod_1.z.string().optional(),
@@ -42,10 +51,11 @@ exports.zodSourceGroupSchema = zod_1.z.object({
     region_id: zod_1.z.string().optional(),
     max_active_sources: zod_1.z.number().optional(),
     created_at: zod_1.z.number().optional(),
-    updated_at: zod_1.z.number().optional(), // last update date
+    updated_at: zod_1.z.number().optional(),
+    notes: zod_1.z.string().optional(),
+    status: zod_1.z.enum(exports.generalStatusList).optional(),
 });
-exports.zodSourceSchema = zod_1.z
-    .object({
+exports.zodSourceSchema = zod_1.z.object({
     _id: zod_1.z.string().optional(),
     title: zod_1.z.string().optional(),
     platform: zod_1.z.enum(exports.platformsList),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "harvester_sdk",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "SDK for interacting with the Harvester API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/types.ts

@@ -8,7 +8,14 @@ export const platformsList = [
   'website',
 ] as const;
 
-export const entityTypesList = ['profile', 'group', 'page', 'channel', 'hashtag', 'website'] as const;
+export const entityTypesList = [
+  'profile',
+  'group',
+  'page',
+  'channel',
+  'hashtag',
+  'website',
+] as const;
 
 // Platform-specific entity mappings
 export const platformEntityMap = {
@@ -24,10 +31,10 @@ export const zodSourceStatusList = [
   'pending', // sources that are pending approval
   'inactive', // sources that are inactive
   'requested', // sources that are under review
-  'deleted' // sources that have been deleted
+  'deleted', // sources that have been deleted
 ] as const;
 
-export const generalStatusList = ['active', 'inactive'] as const;
+export const generalStatusList = ['active', 'inactive', 'deleted'] as const;
 
 export const zodRegionSchema = z.object({
   _id: z.string().optional(),
@@ -36,6 +43,8 @@ export const zodRegionSchema = z.object({
   legend: z.string().optional(), // e.g., legend for maps
   created_at: z.number().optional(), // creation date
   updated_at: z.number().optional(), // last update date
+  status: z.enum(generalStatusList).optional(),
+  notes: z.string().optional(), // internal notes about the region
 });
 
 export const zodSourceGroupSchema = z.object({
@@ -47,38 +56,39 @@ export const zodSourceGroupSchema = z.object({
   max_active_sources: z.number().optional(), // e.g., maximum number of active sources allowed
   created_at: z.number().optional(), // creation date
   updated_at: z.number().optional(), // last update date
+  notes: z.string().optional(), // internal notes about the source group
+  status: z.enum(generalStatusList).optional(),
 });
 
-export const zodSourceSchema = z
-  .object({
-    _id: z.string().optional(),
-    title: z.string().optional(), // e.g., 'Telegram Channel Name'
-    platform: z.enum(platformsList), // e.g., 'telegram', 'facebook'
-    entity: z.enum(entityTypesList), // e.g., 'channel', 'group', 'page', 'profile', 'hashtag'
-    public_id: z.string().or(z.number()).optional(), // e.g., '@telegram_channel_id'
-    name: z.string(), // e.g., 'Telegram Channel Name'
-    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(),
-    tags: z.array(z.string()).optional(),
-    status: z.enum(zodSourceStatusList), // INDEX
-    is_public: z.boolean().default(true), // true if the source is public
-    metadata: z.record(z.string(), z.any()).optional(), // flexible per platform
-    created_at: z.number().optional(),
-    updated_at: z.number().optional(),
-    region_id: z.string().optional(), // e.g., region ID
-    group_id: z.string().optional(), // e.g., source group ID
-    requested_by: z
-      .object({
-        user_id: z.string().optional(),
-        username: z.string().optional(),
-        full_name: z.string().optional(),
-        email: z.string().optional(),
-        requested_at: z.number().optional(),
-      })
-      .optional(), // user who requested this source
-    notes: z.string().optional(), // internal notes about the source
-  })
+export const zodSourceSchema = z.object({
+  _id: z.string().optional(),
+  title: z.string().optional(), // e.g., 'Telegram Channel Name'
+  platform: z.enum(platformsList), // e.g., 'telegram', 'facebook'
+  entity: z.enum(entityTypesList), // e.g., 'channel', 'group', 'page', 'profile', 'hashtag'
+  public_id: z.string().or(z.number()).optional(), // e.g., '@telegram_channel_id'
+  name: z.string(), // e.g., 'Telegram Channel Name'
+  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(),
+  tags: z.array(z.string()).optional(),
+  status: z.enum(zodSourceStatusList), // INDEX
+  is_public: z.boolean().default(true), // true if the source is public
+  metadata: z.record(z.string(), z.any()).optional(), // flexible per platform
+  created_at: z.number().optional(),
+  updated_at: z.number().optional(),
+  region_id: z.string().optional(), // e.g., region ID
+  group_id: z.string().optional(), // e.g., source group ID
+  requested_by: z
+    .object({
+      user_id: z.string().optional(),
+      username: z.string().optional(),
+      full_name: z.string().optional(),
+      email: z.string().optional(),
+      requested_at: z.number().optional(),
+    })
+    .optional(), // user who requested this source
+  notes: z.string().optional(), // internal notes about the source
+});
 
 export const zodGeoSchema = z.object({
   _id: z.string().optional(),
@@ -154,15 +164,19 @@ export type TimeRangeTypeLiteral = 'relative' | 'absolute';
 export type AddSourceToReviewType = Pick<
   SourceType,
   'platform' | 'url' | 'description'
-> & Partial<Pick<SourceType, 'public_id'>>;
+> &
+  Partial<Pick<SourceType, 'public_id'>>;
 
 export type GeoType = z.infer<typeof zodGeoSchema>;
 export type GeoSelectionType = z.infer<typeof zodGeoSelectionSchema>;
 
 // Helper type to get allowed entities for a specific platform
-export type PlatformEntityType<T extends typeof platformsList[number]> = typeof platformEntityMap[T][number];
+export type PlatformEntityType<T extends (typeof platformsList)[number]> =
+  (typeof platformEntityMap)[T][number];
 
 // Helper function to get allowed entities for a platform
-export const getAllowedEntitiesForPlatform = (platform: typeof platformsList[number]) => {
+export const getAllowedEntitiesForPlatform = (
+  platform: (typeof platformsList)[number]
+) => {
   return platformEntityMap[platform];
 };