@permaweb/libs 0.0.60 → 0.0.62

package/dist/types/helpers/config.d.ts

@@ -7,6 +7,7 @@ export declare const AO: {
         collection: string;
         collectionActivity: string;
         comments: string;
+        moderation: string;
         zone: {
             id: string;
             version: string;

package/dist/types/helpers/types.d.ts

@@ -132,6 +132,7 @@ export type CommentCreateArgType = {
     parentId?: string;
     rootId?: string;
     tags?: TagType[];
+    metadata?: object;
 };
 export type CollectionManifestType = {
     type: string;
@@ -217,6 +218,17 @@ export type DefaultGQLResponseType = {
 export type BatchAGQLResponseType = {
     [queryKey: string]: DefaultGQLResponseType;
 };
+export type ModerationStatusType = 'blocked' | 'allowed';
+export type ModerationTargetType = 'comment' | 'profile';
+export type ModerationEntryType = {
+    targetId: string;
+    status: ModerationStatusType;
+    targetContext?: string;
+    reason?: string;
+    moderator: string;
+    dateCreated: number;
+    metadata?: any;
+};
 export type TagType = {
     name: string;
     value: string;

package/dist/types/index.d.ts

@@ -7,6 +7,8 @@ declare function init(deps: Helpers.DependencyType): {
     createZone: (args: {
         data?: any;
         tags?: Helpers.TagType[];
+        spawnModeration?: boolean;
+        authUsers?: string[];
     }, callback?: (status: any) => void) => Promise<string | null>;
     updateZone: (args: object, zoneId: string) => Promise<string | null>;
     addToZone: (args: {
@@ -93,6 +95,29 @@ declare function init(deps: Helpers.DependencyType): {
     getCollections: (args: {
         creator?: string;
     }) => Promise<Helpers.CollectionType[] | null>;
+    addModerationEntry: (zoneId: string, targetType: Helpers.ModerationTargetType, entry: {
+        targetId: string;
+        status: Helpers.ModerationStatusType;
+        targetContext?: string;
+        moderator: string;
+        reason?: string;
+        metadata?: any;
+    }) => Promise<string | null>;
+    getModerationEntries: (zoneId: string, targetType: Helpers.ModerationTargetType, filters?: {
+        targetId?: string;
+        status?: Helpers.ModerationStatusType;
+        targetContext?: string;
+        moderator?: string;
+    }) => Promise<Helpers.ModerationEntryType[] | null>;
+    updateModerationEntry: (zoneId: string, targetType: Helpers.ModerationTargetType, targetId: string, update: {
+        status: Helpers.ModerationStatusType;
+        moderator: string;
+        reason?: string;
+    }) => Promise<string | null>;
+    removeModerationEntry: (zoneId: string, targetType: Helpers.ModerationTargetType, targetId: string) => Promise<string | null>;
+    addModerationSubscription: (zoneId: string, moderationId: string, subscriptionType?: string) => Promise<string | null>;
+    removeModerationSubscription: (zoneId: string, moderationId: string) => Promise<string | null>;
+    getModerationSubscriptions: (zoneId: string) => Promise<string[] | null>;
     resolveTransaction: (data: any) => Promise<any>;
     getGQLData: typeof Common.getGQLData;
     getAggregatedGQLData: typeof Common.getAggregatedGQLData;

package/dist/types/services/index.d.ts

@@ -1,5 +1,6 @@
 export * from './assets.ts';
 export * from './collections.ts';
 export * from './comments.ts';
+export * from './moderation.ts';
 export * from './profiles.ts';
 export * from './zones.ts';

package/dist/types/services/moderation.d.ts

@@ -0,0 +1,56 @@
+import { DependencyType, ModerationEntryType, ModerationStatusType, ModerationTargetType } from '../helpers/types.ts';
+/**
+ * Add a moderation entry to the moderation process
+ */
+export declare function addModerationEntryWith(deps: DependencyType): (zoneId: string, targetType: ModerationTargetType, entry: {
+    targetId: string;
+    status: ModerationStatusType;
+    targetContext?: string;
+    moderator: string;
+    reason?: string;
+    metadata?: any;
+}) => Promise<string | null>;
+/**
+ * Get moderation entries from the moderation process
+ */
+export declare function getModerationEntriesWith(deps: DependencyType): (zoneId: string, targetType: ModerationTargetType, filters?: {
+    targetId?: string;
+    status?: ModerationStatusType;
+    targetContext?: string;
+    moderator?: string;
+}) => Promise<ModerationEntryType[] | null>;
+/**
+ * Update a moderation entry in the moderation process
+ */
+export declare function updateModerationEntryWith(deps: DependencyType): (zoneId: string, targetType: ModerationTargetType, targetId: string, update: {
+    status: ModerationStatusType;
+    moderator: string;
+    reason?: string;
+}) => Promise<string | null>;
+/**
+ * Remove a moderation entry from the moderation process
+ */
+export declare function removeModerationEntryWith(deps: DependencyType): (zoneId: string, targetType: ModerationTargetType, targetId: string) => Promise<string | null>;
+/**
+ * Add a moderation subscription to the moderation process
+ */
+export declare function addModerationSubscriptionWith(deps: DependencyType): (zoneId: string, moderationId: string, subscriptionType?: string) => Promise<string | null>;
+/**
+ * Remove a moderation subscription from the moderation process
+ */
+export declare function removeModerationSubscriptionWith(deps: DependencyType): (zoneId: string, moderationId: string) => Promise<string | null>;
+/**
+ * Get moderation subscriptions from the moderation process
+ */
+export declare function getModerationSubscriptionsWith(deps: DependencyType): (zoneId: string) => Promise<string[] | null>;
+/**
+ * Bulk add moderation entries to the moderation process
+ */
+export declare function bulkAddModerationEntriesWith(deps: DependencyType): (zoneId: string, entries: Array<{
+    targetType: ModerationTargetType;
+    targetId: string;
+    status: ModerationStatusType;
+    targetContext?: string;
+    reason?: string;
+    metadata?: any;
+}>) => Promise<string | null>;

package/dist/types/services/zones.d.ts

@@ -2,6 +2,8 @@ import { DependencyType, TagType } from '../helpers/types.ts';
 export declare function createZoneWith(deps: DependencyType): (args: {
     data?: any;
     tags?: TagType[];
+    spawnModeration?: boolean;
+    authUsers?: string[];
 }, callback?: (status: any) => void) => Promise<string | null>;
 export declare function updateZoneWith(deps: DependencyType): (args: object, zoneId: string) => Promise<string | null>;
 export declare function addToZoneWith(deps: DependencyType): (args: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@permaweb/libs",
-	"version": "0.0.60",
+	"version": "0.0.62",
 	"type": "module",
 	"main": "./dist/index.cjs",
 	"module": "./dist/index.js",