feat: initial commit

api/src/plugins/base-block-plugin.ts

@@ -0,0 +1,46 @@
+/*
+ * Copyright © 2024 Hexastack. All rights reserved.
+ *
+ * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
+ * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
+ * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
+ * 3. SaaS Restriction: This software, or any derivative of it, may not be used to offer a competing product or service (SaaS) without prior written consent from Hexastack. Offering the software as a service or using it in a commercial cloud environment without express permission is strictly prohibited.
+ */
+
+import { Injectable } from '@nestjs/common';
+
+import { Block, BlockFull } from '@/chat/schemas/block.schema';
+import { Context } from '@/chat/schemas/types/context';
+import { StdOutgoingEnvelope } from '@/chat/schemas/types/message';
+
+import { BasePlugin } from './base-plugin.service';
+import { PluginService } from './plugins.service';
+import {
+  PluginBlockTemplate,
+  PluginEffects,
+  PluginSetting,
+  PluginType,
+} from './types';
+
+@Injectable()
+export abstract class BaseBlockPlugin extends BasePlugin {
+  public readonly type: PluginType = PluginType.block;
+
+  constructor(id: string, pluginService: PluginService<BasePlugin>) {
+    super(id, pluginService);
+  }
+
+  title: string;
+
+  settings: PluginSetting[];
+
+  template: PluginBlockTemplate;
+
+  effects?: PluginEffects;
+
+  abstract process(
+    block: Block | BlockFull,
+    context: Context,
+    convId?: string,
+  ): Promise<StdOutgoingEnvelope>;
+}