anything-llm/server/models/communityHub.js
Sean Hatfield 05c530221b
Community hub integration ()
* wip hub connection page fe + backend

* lint

* implement backend for local hub items + placeholder endpoints to fetch hub app data

* fix hebrew translations

* revamp community integration flow

* change sidebar

* Auto import if id in URL param
remove preview in card screen and instead go to import flow

* get user's items + team items from hub + ui improvements to hub settings

* lint

* fix merge conflict

* refresh hook for community items

* add fallback for user items

* Disable bundle items by default on all instances

* remove translations (will complete later)

* loading skeleton

* Make community hub endpoints admin only
show visibility on items
combine import/apply for items to they are event logged for review

* improve middleware and import flow

* community hub ui updates

* Adjust importing process

* community hub to dev

* Add webscraper preload into imported plugins

* add runtime property to plugins

* Fix button status on imported skill change
show alert on skill change
Update markdown type and theme on import of agent skill

* update documentaion paths

* remove unused import

* linting

* review loading state

---------

Co-authored-by: Timothy Carambat <rambat1010@gmail.com>
2024-11-26 09:59:43 -08:00

177 lines
5.9 KiB
JavaScript

const ImportedPlugin = require("../utils/agents/imported");
/**
* An interface to the AnythingLLM Community Hub external API.
*/
const CommunityHub = {
importPrefix: "allm-community-id",
apiBase:
process.env.NODE_ENV === "development"
? "http://127.0.0.1:5001/anythingllm-hub/us-central1/external/v1"
: "https://hub.external.anythingllm.com/v1",
/**
* Validate an import ID and return the entity type and ID.
* @param {string} importId - The import ID to validate.
* @returns {{entityType: string | null, entityId: string | null}}
*/
validateImportId: function (importId) {
if (
!importId ||
!importId.startsWith(this.importPrefix) ||
importId.split(":").length !== 3
)
return { entityType: null, entityId: null };
const [_, entityType, entityId] = importId.split(":");
if (!entityType || !entityId) return { entityType: null, entityId: null };
return {
entityType: String(entityType).trim(),
entityId: String(entityId).trim(),
};
},
/**
* Fetch the explore items from the community hub that are publicly available.
* @returns {Promise<{agentSkills: {items: [], hasMore: boolean, totalCount: number}, systemPrompts: {items: [], hasMore: boolean, totalCount: number}, slashCommands: {items: [], hasMore: boolean, totalCount: number}}>}
*/
fetchExploreItems: async function () {
return await fetch(`${this.apiBase}/explore`, {
method: "GET",
})
.then((response) => response.json())
.catch((error) => {
console.error("Error fetching explore items:", error);
return {
agentSkills: {
items: [],
hasMore: false,
totalCount: 0,
},
systemPrompts: {
items: [],
hasMore: false,
totalCount: 0,
},
slashCommands: {
items: [],
hasMore: false,
totalCount: 0,
},
};
});
},
/**
* Fetch a bundle item from the community hub.
* Bundle items are entities that require a downloadURL to be fetched from the community hub.
* so we can unzip and import them to the AnythingLLM instance.
* @param {string} importId - The import ID of the item.
* @returns {Promise<{url: string | null, item: object | null, error: string | null}>}
*/
getBundleItem: async function (importId) {
const { entityType, entityId } = this.validateImportId(importId);
if (!entityType || !entityId)
return { item: null, error: "Invalid import ID" };
const { SystemSettings } = require("./systemSettings");
const { connectionKey } = await SystemSettings.hubSettings();
const { url, item, error } = await fetch(
`${this.apiBase}/${entityType}/${entityId}/pull`,
{
method: "GET",
headers: {
"Content-Type": "application/json",
...(connectionKey
? { Authorization: `Bearer ${connectionKey}` }
: {}),
},
}
)
.then((response) => response.json())
.catch((error) => {
console.error(
`Error fetching bundle item for import ID ${importId}:`,
error
);
return { url: null, item: null, error: error.message };
});
return { url, item, error };
},
/**
* Apply an item to the AnythingLLM instance. Used for simple items like slash commands and system prompts.
* @param {object} item - The item to apply.
* @param {object} options - Additional options for applying the item.
* @param {object|null} options.currentUser - The current user object.
* @returns {Promise<{success: boolean, error: string | null}>}
*/
applyItem: async function (item, options = {}) {
if (!item) return { success: false, error: "Item is required" };
if (item.itemType === "system-prompt") {
if (!options?.workspaceSlug)
return { success: false, error: "Workspace slug is required" };
const { Workspace } = require("./workspace");
const workspace = await Workspace.get({
slug: String(options.workspaceSlug),
});
if (!workspace) return { success: false, error: "Workspace not found" };
await Workspace.update(workspace.id, { openAiPrompt: item.prompt });
return { success: true, error: null };
}
if (item.itemType === "slash-command") {
const { SlashCommandPresets } = require("./slashCommandsPresets");
await SlashCommandPresets.create(options?.currentUser?.id, {
command: SlashCommandPresets.formatCommand(String(item.command)),
prompt: String(item.prompt),
description: String(item.description),
});
return { success: true, error: null };
}
return {
success: false,
error: "Unsupported item type. Nothing to apply.",
};
},
/**
* Import a bundle item to the AnythingLLM instance by downloading the zip file and importing it.
* or whatever the item type requires.
* @param {{url: string, item: object}} params
* @returns {Promise<{success: boolean, error: string | null}>}
*/
importBundleItem: async function ({ url, item }) {
if (item.itemType === "agent-skill") {
const { success, error } =
await ImportedPlugin.importCommunityItemFromUrl(url, item);
return { success, error };
}
return {
success: false,
error: "Unsupported item type. Nothing to import.",
};
},
fetchUserItems: async function (connectionKey) {
if (!connectionKey) return { createdByMe: {}, teamItems: [] };
return await fetch(`${this.apiBase}/items`, {
method: "GET",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${connectionKey}`,
},
})
.then((response) => response.json())
.catch((error) => {
console.error("Error fetching user items:", error);
return { createdByMe: {}, teamItems: [] };
});
},
};
module.exports = { CommunityHub };