@xpert-ai/contracts 3.15.0 → 3.15.2

package/index.cjs.js

@@ -2181,6 +2181,30 @@ exports.AiFeatureEnum = void 0;
     AiFeatureEnum["FEATURE_XPERT_DATA_ONTOLOGY"] = "FEATURE_XPERT_DATA_ONTOLOGY";
 })(exports.AiFeatureEnum || (exports.AiFeatureEnum = {}));
 
+exports.MembershipPlanStatusEnum = void 0;
+(function(MembershipPlanStatusEnum) {
+    MembershipPlanStatusEnum["Active"] = "active";
+    MembershipPlanStatusEnum["Archived"] = "archived";
+})(exports.MembershipPlanStatusEnum || (exports.MembershipPlanStatusEnum = {}));
+exports.MembershipPeriodEnum = void 0;
+(function(MembershipPeriodEnum) {
+    MembershipPeriodEnum["Monthly"] = "monthly";
+})(exports.MembershipPeriodEnum || (exports.MembershipPeriodEnum = {}));
+exports.MembershipStatusEnum = void 0;
+(function(MembershipStatusEnum) {
+    MembershipStatusEnum["Active"] = "active";
+    MembershipStatusEnum["Paused"] = "paused";
+    MembershipStatusEnum["Expired"] = "expired";
+})(exports.MembershipStatusEnum || (exports.MembershipStatusEnum = {}));
+exports.MembershipLedgerSourceEnum = void 0;
+(function(MembershipLedgerSourceEnum) {
+    MembershipLedgerSourceEnum["Assignment"] = "assignment";
+    MembershipLedgerSourceEnum["Grant"] = "grant";
+    MembershipLedgerSourceEnum["Renew"] = "renew";
+    MembershipLedgerSourceEnum["Usage"] = "usage";
+    MembershipLedgerSourceEnum["Adjustment"] = "adjustment";
+})(exports.MembershipLedgerSourceEnum || (exports.MembershipLedgerSourceEnum = {}));
+
 exports.VectorTypeEnum = void 0;
 (function(VectorTypeEnum) {
     VectorTypeEnum["ANALYTICDB"] = "analyticdb";
@@ -3047,6 +3071,7 @@ exports.AIPermissionsEnum = void 0;
      */ AIPermissionsEnum["KNOWLEDGEBASE_EDIT"] = "KNOWLEDGEBASE_EDIT";
     AIPermissionsEnum["COPILOT_VIEW"] = "COPILOT_VIEW";
     AIPermissionsEnum["COPILOT_EDIT"] = "COPILOT_EDIT";
+    AIPermissionsEnum["MEMBERSHIP_EDIT"] = "MEMBERSHIP_EDIT";
     /**
      * Create or edit Xperts in organization.
      */ AIPermissionsEnum["XPERT_EDIT"] = "XPERT_EDIT";
@@ -4778,6 +4803,7 @@ var PermissionGroups = {
         exports.AIPermissionsEnum.KNOWLEDGEBASE_EDIT,
         exports.AIPermissionsEnum.COPILOT_VIEW,
         exports.AIPermissionsEnum.COPILOT_EDIT,
+        exports.AIPermissionsEnum.MEMBERSHIP_EDIT,
         exports.AIPermissionsEnum.XPERT_EDIT,
         exports.AIPermissionsEnum.CHAT_VIEW,
         // DataSource
@@ -4854,6 +4880,11 @@ var DEFAULT_SYSTEM_ROLES = [
     exports.RolesEnum.VIEWER
 ];
 
+var USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT = "clawxpert";
+function isUserOrganizationEntryGuideKey(value) {
+    return value === USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT;
+}
+
 exports.UserType = void 0;
 (function(UserType) {
     UserType["USER"] = "user";
@@ -5790,6 +5821,7 @@ exports.THREAD_GOAL_STATUS_VALUES = THREAD_GOAL_STATUS_VALUES;
 exports.TOOL_NAME_REGEX = TOOL_NAME_REGEX;
 exports.TranslationLanguageMap = TranslationLanguageMap;
 exports.USAGE_HOUR_FORMAT = USAGE_HOUR_FORMAT;
+exports.USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT = USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT;
 exports.VariableOperations = VariableOperations;
 exports.WORKBENCH_NAVIGATION_OPEN_COMMAND = WORKBENCH_NAVIGATION_OPEN_COMMAND;
 exports.WORKSPACE_PUBLIC_SKILL_REPOSITORY_NAME = WORKSPACE_PUBLIC_SKILL_REPOSITORY_NAME;
@@ -5885,6 +5917,7 @@ exports.isTenantSharedXpertWorkspace = isTenantSharedXpertWorkspace;
 exports.isToolEnabled = isToolEnabled;
 exports.isUserAddableAgentMiddleware = isUserAddableAgentMiddleware;
 exports.isUserManagedAssistant = isUserManagedAssistant;
+exports.isUserOrganizationEntryGuideKey = isUserOrganizationEntryGuideKey;
 exports.isVideoType = isVideoType;
 exports.isXpertNodeType = isXpertNodeType;
 exports.letterStartSUID = letterStartSUID;

package/index.esm.js

@@ -2179,6 +2179,30 @@ var AiFeatureEnum;
     AiFeatureEnum["FEATURE_XPERT_DATA_ONTOLOGY"] = "FEATURE_XPERT_DATA_ONTOLOGY";
 })(AiFeatureEnum || (AiFeatureEnum = {}));
 
+var MembershipPlanStatusEnum;
+(function(MembershipPlanStatusEnum) {
+    MembershipPlanStatusEnum["Active"] = "active";
+    MembershipPlanStatusEnum["Archived"] = "archived";
+})(MembershipPlanStatusEnum || (MembershipPlanStatusEnum = {}));
+var MembershipPeriodEnum;
+(function(MembershipPeriodEnum) {
+    MembershipPeriodEnum["Monthly"] = "monthly";
+})(MembershipPeriodEnum || (MembershipPeriodEnum = {}));
+var MembershipStatusEnum;
+(function(MembershipStatusEnum) {
+    MembershipStatusEnum["Active"] = "active";
+    MembershipStatusEnum["Paused"] = "paused";
+    MembershipStatusEnum["Expired"] = "expired";
+})(MembershipStatusEnum || (MembershipStatusEnum = {}));
+var MembershipLedgerSourceEnum;
+(function(MembershipLedgerSourceEnum) {
+    MembershipLedgerSourceEnum["Assignment"] = "assignment";
+    MembershipLedgerSourceEnum["Grant"] = "grant";
+    MembershipLedgerSourceEnum["Renew"] = "renew";
+    MembershipLedgerSourceEnum["Usage"] = "usage";
+    MembershipLedgerSourceEnum["Adjustment"] = "adjustment";
+})(MembershipLedgerSourceEnum || (MembershipLedgerSourceEnum = {}));
+
 var VectorTypeEnum;
 (function(VectorTypeEnum) {
     VectorTypeEnum["ANALYTICDB"] = "analyticdb";
@@ -3045,6 +3069,7 @@ var AIPermissionsEnum;
      */ AIPermissionsEnum["KNOWLEDGEBASE_EDIT"] = "KNOWLEDGEBASE_EDIT";
     AIPermissionsEnum["COPILOT_VIEW"] = "COPILOT_VIEW";
     AIPermissionsEnum["COPILOT_EDIT"] = "COPILOT_EDIT";
+    AIPermissionsEnum["MEMBERSHIP_EDIT"] = "MEMBERSHIP_EDIT";
     /**
      * Create or edit Xperts in organization.
      */ AIPermissionsEnum["XPERT_EDIT"] = "XPERT_EDIT";
@@ -4776,6 +4801,7 @@ var PermissionGroups = {
         AIPermissionsEnum.KNOWLEDGEBASE_EDIT,
         AIPermissionsEnum.COPILOT_VIEW,
         AIPermissionsEnum.COPILOT_EDIT,
+        AIPermissionsEnum.MEMBERSHIP_EDIT,
         AIPermissionsEnum.XPERT_EDIT,
         AIPermissionsEnum.CHAT_VIEW,
         // DataSource
@@ -4852,6 +4878,11 @@ var DEFAULT_SYSTEM_ROLES = [
     RolesEnum.VIEWER
 ];
 
+var USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT = "clawxpert";
+function isUserOrganizationEntryGuideKey(value) {
+    return value === USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT;
+}
+
 var UserType;
 (function(UserType) {
     UserType["USER"] = "user";
@@ -5692,4 +5723,4 @@ var WORKBENCH_NAVIGATION_OPEN_COMMAND = "workbench.navigation.open";
 var ASSISTANT_CITATION_OPEN_EVENT = "assistant.citation.open";
 var KNOWLEDGEBASE_OPEN_CITATION_EFFECT = "knowledgebase.open_citation";
 
-export { AIPermissionsEnum, AI_MODEL_TYPE_VARIABLE, API_PRINCIPAL_USER_ID_HEADER, ASSISTANT_CHAT_SEND_MESSAGE_COMMAND, ASSISTANT_CITATION_OPEN_EVENT, ASSISTANT_CONTEXT_SET_COMMAND, AccessEnum, AgentEventType, AgentType, AiBusinessRole, AiFeatureEnum, AiModelTypeEnum, AiProtocol, AiProvider, AiProviderRole, AlignmentOptions, AnalyticsFeatures, AnalyticsPermissionsEnum, ApiAuthType, ApiKeyBindingType, ApiProviderSchemaType, ApprovalPolicyTypesEnum, ApprovalPolicyTypesStringEnum, AssistantBindingScope, AssistantBindingSourceScope, AssistantCode, Attachment_Type_Options, AuthenticationEnum, BIInterruptMessageType, BonusTypeEnum, BusinessAreaRole, BusinessType, CHAT_EVENT_TYPE_CONVERSATION_TITLE_SUMMARY, CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED, CHAT_EVENT_TYPE_THREAD_CONTEXT_USAGE, CHAT_EVENT_TYPE_THREAD_GOAL_CLEARED, CHAT_EVENT_TYPE_THREAD_GOAL_UPDATED, CONTEXT_COMPRESSION_COMPONENT_TYPE, CONTEXT_COMPRESSION_MIDDLEWARE_NAME, CONTEXT_VARIABLE_CURRENTSTATE, COPILOT_CHECKPOINT_RETENTION_DAYS_SETTING, COPILOT_CHECKPOINT_RETENTION_ENABLED_SETTING, ChatDashboardMessageType, ChatGatewayEvent, ChatMessageEventTypeEnum, ChatMessageFeedbackRatingEnum, ChatMessageStepCategory, ChatMessageTypeEnum, ClientFocusEnum, ConfigurateMethod, ContactOrganizationInviteStatus, ContactType, CredentialFormTypeEnum, CredentialsType, CrudActionEnum, CurrenciesEnum, CurrencyPosition, DEFAULT_COPILOT_CHECKPOINT_RETENTION_DAYS, DEFAULT_CURRENCIES, DEFAULT_DATE_FORMATS, DEFAULT_INTEGRATION_PAID_FILTERS, DEFAULT_INVITE_EXPIRY_PERIOD, DEFAULT_PROFIT_BASED_BONUS, DEFAULT_REVENUE_BASED_BONUS, DEFAULT_SYSTEM_ROLES, DEFAULT_TENANT, DEFAULT_TIME_FORMATS, DEFAULT_TYPE, DEFAULT_XPERT_AGENT_RECURSION_LIMIT, DataSourceProtocolEnum, DataSourceSyntaxEnum, DataSourceTypeEnum, DefaultValueDateTypeEnum, DocumentSourceProviderCategoryEnum, DocumentTypeEnum, EmailTemplateEnum, EmailTemplateNameEnum, EmbeddingStatusEnum, FILE_VARIABLES, FeatureEnum, FeatureStatusEnum, FeedTypeEnum, FetchFrom, FileStorageProviderEnum, GRAPH_NODE_SUMMARIZE_CONVERSATION, GRAPH_NODE_TITLE_CONVERSATION, HttpStatus, IFeatureToggleTypeEnum, INTEGRATION_PROVIDERS, ImportHistoryStatusEnum, ImportTypeEnum, IndicatorDraftFields, IndicatorOptionFields, IndicatorStatusEnum, IndicatorTagEnum, IndicatorType, IntegrationEnum, IntegrationFeatureEnum, IntegrationFilterEnum, IntegrationGitHubProvider, IntegrationLarkProvider, InterruptMessageType, InvitationExpirationEnum, InvitationTypeEnum, InviteStatusEnum, IteratingIndexParameterName, IteratingItemParameterName, IteratorIndexParameterName, IteratorItemParameterName, KBDocumentCategoryEnum, KBDocumentStatusEnum, KDocumentSourceType, KDocumentWebTypeEnum, KDocumentWebTypeOptions, KNOWLEDGEBASE_OPEN_CITATION_EFFECT, KNOWLEDGE_DOCUMENTS_NAME, KNOWLEDGE_FOLDER_ID_NAME, KNOWLEDGE_SOURCES_NAME, KNOWLEDGE_STAGE_NAME, KnowledgeGraphIndexJobStatus, KnowledgeGraphStatus, KnowledgeProviderEnum, KnowledgeStructureEnum, KnowledgeTask, KnowledgebaseChannel, KnowledgebasePermission, KnowledgebaseStatusEnum, KnowledgebaseTypeEnum, LEGACY_SANDBOX_COMPRESSION_MIDDLEWARE_NAME, LanguagesEnum, LanguagesMap, ListsInputTypeEnum, LocalAgentType, LongTermMemoryTypeEnum, MAX_COPILOT_CHECKPOINT_RETENTION_DAYS, MCPServerType, MCP_APP_RESOURCE_MIME_TYPE, schema as MDX, MEMORY_PROFILE_PROMPT, MEMORY_QA_PROMPT, MIN_COPILOT_CHECKPOINT_RETENTION_DAYS, MinimumProjectSizeEnum, ModelEntityType, ModelFeature, ModelPropertyKey, ModelTypeEnum, OllamaEmbeddingsProviders, OpenAIEmbeddingsProviders, OrderTypeEnum, OrganizationContactBudgetTypeEnum, OrganizationDemoNetworkEnum, OrganizationPermissionsEnum, OrganizationProjectBudgetTypeEnum, OrganizationSelectInput, PLUGIN_COMPONENT_TYPE, PLUGIN_CONFIGURATION_STATUS, PLUGIN_LEVEL, PLUGIN_LOAD_STATUS, PLUGIN_MARKETPLACE_AUTHENTICATION_POLICY, PLUGIN_MARKETPLACE_INSTALLATION_POLICY, PLUGIN_MCP_TOOL_APPROVAL_MODE, PLUGIN_RESOURCE_INSTALLATION_STATUS, PLUGIN_RESOURCE_RUNTIME_TYPE, PLUGIN_SOURCE, ParameterType, ParameterTypeEnum, PayPeriodEnum, PermissionApprovalStatus, PermissionApprovalStatusTypesEnum, PermissionGroups, PermissionsEnum, PriceType, ProjectBillingEnum, ProjectOwnerEnum, ProjectStatusEnum, ProviderEnum, ProviderType, QueryStatusEnum, RegionsEnum, RequestMethodEnum, RequestScopeLevel, RoleTypeEnum, RolesEnum, SANDBOX_MANAGED_SERVICE_STATUSES, SANDBOX_MANAGED_SERVICE_TRANSPORT_MODES, SANDBOX_TERMINAL_NAMESPACE, SANDBOX_WORK_FOR_TYPES, SMTPSecureEnum, STANDARD_METADATA_FIELDS, STATE_SYS_AGENT_WORKSPACE_PATH, STATE_SYS_MEMORY_WORKSPACE_PATH, STATE_SYS_SESSION_WORKSPACE_PATH, STATE_SYS_SHARED_WORKSPACE_PATH, STATE_SYS_THREAD_ID, STATE_SYS_VOLUME, STATE_SYS_WORKSPACE_PATH, STATE_SYS_WORKSPACE_ROOT, STATE_SYS_WORKSPACE_URL, STATE_VARIABLE_FILES, STATE_VARIABLE_HUMAN, STATE_VARIABLE_INPUT, STATE_VARIABLE_SYS, STATE_VARIABLE_TITLE_CHANNEL, SandboxManagedServiceErrorCode, SandboxTerminalClientEvent, SandboxTerminalClosedReason, SandboxTerminalErrorCode, SandboxTerminalServerEvent, ScheduleTaskStatus, SecretTokenBindingType, SemanticModelStatusEnum, StoryStatusEnum, StoryTemplateType, SubscriptionType, TASK_DESCRIPTION_PREFIX, TASK_DESCRIPTION_SUFFIX, TENANT_AGENT_LOCAL_URL, THREAD_GOAL_STATUS_VALUES, TOOL_NAME_REGEX, TagCategoryEnum, TaskFrequency, TaskListTypeEnum, TimeGranularity, ToolParameterForm, ToolParameterType, ToolTagEnum, TranslationLanguageMap, USAGE_HOUR_FORMAT, UserType, VariableOperationEnum, VariableOperations, VectorTypeEnum, Visibility, VisitEntityEnum, VisitTypeEnum, WORKBENCH_NAVIGATION_OPEN_COMMAND, WORKSPACE_PUBLIC_SKILL_REPOSITORY_NAME, WORKSPACE_PUBLIC_SKILL_SOURCE_PROVIDER, WeekDaysEnum, WorkflowComparisonOperator, WorkflowLogicalOperator, WorkflowNodeTypeEnum, XPERT_TASK_SCHEDULE_IDEMPOTENCY_KEY, XPERT_TASK_SCHEDULE_PROPERTY_PREFIX, XpertAgentExecutionStatusEnum, XpertParameterTypeEnum, XpertTableStatus, XpertToolsetCategoryEnum, XpertTypeEnum, agentLabel, agentUniqueName, allChannels, appendMessageContent, appendMessagePlainText, buildChunkTree, channelName, classificateDocumentCategory, collectTreeLeaves, configurableStoreNamespace, convertToUrlPath, createAgentConnections, createConversationTitleSummaryEvent, createFollowUpConsumedEvent, createMessageAppendContextTracker, createThreadGoalClearedEvent, createThreadGoalUpdatedEvent, createXpertGraph, createXpertNodes, embeddingCubeCollectionName, ensureAssistantBindingSkillWorkspacePreference, extractSemanticModelDraft, figureOutXpert, filterAssistantBindingDisabledSkillIds, filterAssistantBindingDisabledTools, filterMessageText, findStartNodes, genJSONParseKey, genJSONStringifyKey, genListOperatorKey, genPipelineChunkerKey, genPipelineKnowledgeBaseKey, genPipelineProcessorKey, genPipelineSourceKey, genPipelineUnderstandingKey, genVariableAggregatorKey, genXpertDBDeleteKey, genXpertDBInsertKey, genXpertDBQueryKey, genXpertDBSqlKey, genXpertDBUpdateKey, genXpertIteratorKey, genXpertMiddlewareKey, genXpertSkillKey, genXpertStartKey, genXpertTriggerKey, generateCronExpression, getAgentMiddlewareNodes, getAgentVarGroup, getAssistantBindingDisabledSkillIds, getAssistantBindingDisabledTools, getAssistantManagement, getCurrentGraph, getEnabledTools, getStoreNamespace, getSwarmPartners, getToolCallFromConfig, getToolCallIdFromConfig, getToolLabel, getVariableSchema, getWorkflowTriggers, getWorkspaceFromRunnable, getXpertAgentRecursionLimit, getXpertWorkspaceVisibility, inferMessageAppendContext, isAgentKey, isAgentWorkflowNode, isAgentWorkflowNodeType, isAssistantBindingSkillEnabled, isAssistantBindingToolEnabled, isAssistantBindingToolPreferencesEmpty, isAudioType, isContextCompressionComponentData, isDocumentSheet, isEnableTool, isImageType, isInterruptMessage, isIteratingKey, isIteratorKey, isMessageGroup, isMiddlewareToolEnabled, isRequiredMiddleware, isRouterKey, isRunnableThreadGoalStatus, isSystemManagedAssistant, isTenantSharedXpertWorkspace, isToolEnabled, isUserAddableAgentMiddleware, isUserManagedAssistant, isVideoType, isXpertNodeType, letterStartSUID, locateNodes, mapTranslationLanguage, mergeMessageContentForDisplay, messageContentText, normalizeAssistantBindingToolPreferences, normalizeMiddlewareNode, normalizeMiddlewareNodes, normalizeMiddlewareProvider, normalizeXpertAgentConfig, omitXpertRelations, replaceAgentInDraft, resolveDraftPrimaryAgent, resolveDraftRuntimeGraph, resolveI18nText, resolveMessageAppendContext, resolveRuntimeXpert, setStateVariable, shortTitle, stringifyMessageContent, transformInstallation, updateAssistantBindingSkillPreferences, updateAssistantBindingToolPreferences, uuid, workflowNodeIdentifier, xpertLabel };
+export { AIPermissionsEnum, AI_MODEL_TYPE_VARIABLE, API_PRINCIPAL_USER_ID_HEADER, ASSISTANT_CHAT_SEND_MESSAGE_COMMAND, ASSISTANT_CITATION_OPEN_EVENT, ASSISTANT_CONTEXT_SET_COMMAND, AccessEnum, AgentEventType, AgentType, AiBusinessRole, AiFeatureEnum, AiModelTypeEnum, AiProtocol, AiProvider, AiProviderRole, AlignmentOptions, AnalyticsFeatures, AnalyticsPermissionsEnum, ApiAuthType, ApiKeyBindingType, ApiProviderSchemaType, ApprovalPolicyTypesEnum, ApprovalPolicyTypesStringEnum, AssistantBindingScope, AssistantBindingSourceScope, AssistantCode, Attachment_Type_Options, AuthenticationEnum, BIInterruptMessageType, BonusTypeEnum, BusinessAreaRole, BusinessType, CHAT_EVENT_TYPE_CONVERSATION_TITLE_SUMMARY, CHAT_EVENT_TYPE_FOLLOW_UP_CONSUMED, CHAT_EVENT_TYPE_THREAD_CONTEXT_USAGE, CHAT_EVENT_TYPE_THREAD_GOAL_CLEARED, CHAT_EVENT_TYPE_THREAD_GOAL_UPDATED, CONTEXT_COMPRESSION_COMPONENT_TYPE, CONTEXT_COMPRESSION_MIDDLEWARE_NAME, CONTEXT_VARIABLE_CURRENTSTATE, COPILOT_CHECKPOINT_RETENTION_DAYS_SETTING, COPILOT_CHECKPOINT_RETENTION_ENABLED_SETTING, ChatDashboardMessageType, ChatGatewayEvent, ChatMessageEventTypeEnum, ChatMessageFeedbackRatingEnum, ChatMessageStepCategory, ChatMessageTypeEnum, ClientFocusEnum, ConfigurateMethod, ContactOrganizationInviteStatus, ContactType, CredentialFormTypeEnum, CredentialsType, CrudActionEnum, CurrenciesEnum, CurrencyPosition, DEFAULT_COPILOT_CHECKPOINT_RETENTION_DAYS, DEFAULT_CURRENCIES, DEFAULT_DATE_FORMATS, DEFAULT_INTEGRATION_PAID_FILTERS, DEFAULT_INVITE_EXPIRY_PERIOD, DEFAULT_PROFIT_BASED_BONUS, DEFAULT_REVENUE_BASED_BONUS, DEFAULT_SYSTEM_ROLES, DEFAULT_TENANT, DEFAULT_TIME_FORMATS, DEFAULT_TYPE, DEFAULT_XPERT_AGENT_RECURSION_LIMIT, DataSourceProtocolEnum, DataSourceSyntaxEnum, DataSourceTypeEnum, DefaultValueDateTypeEnum, DocumentSourceProviderCategoryEnum, DocumentTypeEnum, EmailTemplateEnum, EmailTemplateNameEnum, EmbeddingStatusEnum, FILE_VARIABLES, FeatureEnum, FeatureStatusEnum, FeedTypeEnum, FetchFrom, FileStorageProviderEnum, GRAPH_NODE_SUMMARIZE_CONVERSATION, GRAPH_NODE_TITLE_CONVERSATION, HttpStatus, IFeatureToggleTypeEnum, INTEGRATION_PROVIDERS, ImportHistoryStatusEnum, ImportTypeEnum, IndicatorDraftFields, IndicatorOptionFields, IndicatorStatusEnum, IndicatorTagEnum, IndicatorType, IntegrationEnum, IntegrationFeatureEnum, IntegrationFilterEnum, IntegrationGitHubProvider, IntegrationLarkProvider, InterruptMessageType, InvitationExpirationEnum, InvitationTypeEnum, InviteStatusEnum, IteratingIndexParameterName, IteratingItemParameterName, IteratorIndexParameterName, IteratorItemParameterName, KBDocumentCategoryEnum, KBDocumentStatusEnum, KDocumentSourceType, KDocumentWebTypeEnum, KDocumentWebTypeOptions, KNOWLEDGEBASE_OPEN_CITATION_EFFECT, KNOWLEDGE_DOCUMENTS_NAME, KNOWLEDGE_FOLDER_ID_NAME, KNOWLEDGE_SOURCES_NAME, KNOWLEDGE_STAGE_NAME, KnowledgeGraphIndexJobStatus, KnowledgeGraphStatus, KnowledgeProviderEnum, KnowledgeStructureEnum, KnowledgeTask, KnowledgebaseChannel, KnowledgebasePermission, KnowledgebaseStatusEnum, KnowledgebaseTypeEnum, LEGACY_SANDBOX_COMPRESSION_MIDDLEWARE_NAME, LanguagesEnum, LanguagesMap, ListsInputTypeEnum, LocalAgentType, LongTermMemoryTypeEnum, MAX_COPILOT_CHECKPOINT_RETENTION_DAYS, MCPServerType, MCP_APP_RESOURCE_MIME_TYPE, schema as MDX, MEMORY_PROFILE_PROMPT, MEMORY_QA_PROMPT, MIN_COPILOT_CHECKPOINT_RETENTION_DAYS, MembershipLedgerSourceEnum, MembershipPeriodEnum, MembershipPlanStatusEnum, MembershipStatusEnum, MinimumProjectSizeEnum, ModelEntityType, ModelFeature, ModelPropertyKey, ModelTypeEnum, OllamaEmbeddingsProviders, OpenAIEmbeddingsProviders, OrderTypeEnum, OrganizationContactBudgetTypeEnum, OrganizationDemoNetworkEnum, OrganizationPermissionsEnum, OrganizationProjectBudgetTypeEnum, OrganizationSelectInput, PLUGIN_COMPONENT_TYPE, PLUGIN_CONFIGURATION_STATUS, PLUGIN_LEVEL, PLUGIN_LOAD_STATUS, PLUGIN_MARKETPLACE_AUTHENTICATION_POLICY, PLUGIN_MARKETPLACE_INSTALLATION_POLICY, PLUGIN_MCP_TOOL_APPROVAL_MODE, PLUGIN_RESOURCE_INSTALLATION_STATUS, PLUGIN_RESOURCE_RUNTIME_TYPE, PLUGIN_SOURCE, ParameterType, ParameterTypeEnum, PayPeriodEnum, PermissionApprovalStatus, PermissionApprovalStatusTypesEnum, PermissionGroups, PermissionsEnum, PriceType, ProjectBillingEnum, ProjectOwnerEnum, ProjectStatusEnum, ProviderEnum, ProviderType, QueryStatusEnum, RegionsEnum, RequestMethodEnum, RequestScopeLevel, RoleTypeEnum, RolesEnum, SANDBOX_MANAGED_SERVICE_STATUSES, SANDBOX_MANAGED_SERVICE_TRANSPORT_MODES, SANDBOX_TERMINAL_NAMESPACE, SANDBOX_WORK_FOR_TYPES, SMTPSecureEnum, STANDARD_METADATA_FIELDS, STATE_SYS_AGENT_WORKSPACE_PATH, STATE_SYS_MEMORY_WORKSPACE_PATH, STATE_SYS_SESSION_WORKSPACE_PATH, STATE_SYS_SHARED_WORKSPACE_PATH, STATE_SYS_THREAD_ID, STATE_SYS_VOLUME, STATE_SYS_WORKSPACE_PATH, STATE_SYS_WORKSPACE_ROOT, STATE_SYS_WORKSPACE_URL, STATE_VARIABLE_FILES, STATE_VARIABLE_HUMAN, STATE_VARIABLE_INPUT, STATE_VARIABLE_SYS, STATE_VARIABLE_TITLE_CHANNEL, SandboxManagedServiceErrorCode, SandboxTerminalClientEvent, SandboxTerminalClosedReason, SandboxTerminalErrorCode, SandboxTerminalServerEvent, ScheduleTaskStatus, SecretTokenBindingType, SemanticModelStatusEnum, StoryStatusEnum, StoryTemplateType, SubscriptionType, TASK_DESCRIPTION_PREFIX, TASK_DESCRIPTION_SUFFIX, TENANT_AGENT_LOCAL_URL, THREAD_GOAL_STATUS_VALUES, TOOL_NAME_REGEX, TagCategoryEnum, TaskFrequency, TaskListTypeEnum, TimeGranularity, ToolParameterForm, ToolParameterType, ToolTagEnum, TranslationLanguageMap, USAGE_HOUR_FORMAT, USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT, UserType, VariableOperationEnum, VariableOperations, VectorTypeEnum, Visibility, VisitEntityEnum, VisitTypeEnum, WORKBENCH_NAVIGATION_OPEN_COMMAND, WORKSPACE_PUBLIC_SKILL_REPOSITORY_NAME, WORKSPACE_PUBLIC_SKILL_SOURCE_PROVIDER, WeekDaysEnum, WorkflowComparisonOperator, WorkflowLogicalOperator, WorkflowNodeTypeEnum, XPERT_TASK_SCHEDULE_IDEMPOTENCY_KEY, XPERT_TASK_SCHEDULE_PROPERTY_PREFIX, XpertAgentExecutionStatusEnum, XpertParameterTypeEnum, XpertTableStatus, XpertToolsetCategoryEnum, XpertTypeEnum, agentLabel, agentUniqueName, allChannels, appendMessageContent, appendMessagePlainText, buildChunkTree, channelName, classificateDocumentCategory, collectTreeLeaves, configurableStoreNamespace, convertToUrlPath, createAgentConnections, createConversationTitleSummaryEvent, createFollowUpConsumedEvent, createMessageAppendContextTracker, createThreadGoalClearedEvent, createThreadGoalUpdatedEvent, createXpertGraph, createXpertNodes, embeddingCubeCollectionName, ensureAssistantBindingSkillWorkspacePreference, extractSemanticModelDraft, figureOutXpert, filterAssistantBindingDisabledSkillIds, filterAssistantBindingDisabledTools, filterMessageText, findStartNodes, genJSONParseKey, genJSONStringifyKey, genListOperatorKey, genPipelineChunkerKey, genPipelineKnowledgeBaseKey, genPipelineProcessorKey, genPipelineSourceKey, genPipelineUnderstandingKey, genVariableAggregatorKey, genXpertDBDeleteKey, genXpertDBInsertKey, genXpertDBQueryKey, genXpertDBSqlKey, genXpertDBUpdateKey, genXpertIteratorKey, genXpertMiddlewareKey, genXpertSkillKey, genXpertStartKey, genXpertTriggerKey, generateCronExpression, getAgentMiddlewareNodes, getAgentVarGroup, getAssistantBindingDisabledSkillIds, getAssistantBindingDisabledTools, getAssistantManagement, getCurrentGraph, getEnabledTools, getStoreNamespace, getSwarmPartners, getToolCallFromConfig, getToolCallIdFromConfig, getToolLabel, getVariableSchema, getWorkflowTriggers, getWorkspaceFromRunnable, getXpertAgentRecursionLimit, getXpertWorkspaceVisibility, inferMessageAppendContext, isAgentKey, isAgentWorkflowNode, isAgentWorkflowNodeType, isAssistantBindingSkillEnabled, isAssistantBindingToolEnabled, isAssistantBindingToolPreferencesEmpty, isAudioType, isContextCompressionComponentData, isDocumentSheet, isEnableTool, isImageType, isInterruptMessage, isIteratingKey, isIteratorKey, isMessageGroup, isMiddlewareToolEnabled, isRequiredMiddleware, isRouterKey, isRunnableThreadGoalStatus, isSystemManagedAssistant, isTenantSharedXpertWorkspace, isToolEnabled, isUserAddableAgentMiddleware, isUserManagedAssistant, isUserOrganizationEntryGuideKey, isVideoType, isXpertNodeType, letterStartSUID, locateNodes, mapTranslationLanguage, mergeMessageContentForDisplay, messageContentText, normalizeAssistantBindingToolPreferences, normalizeMiddlewareNode, normalizeMiddlewareNodes, normalizeMiddlewareProvider, normalizeXpertAgentConfig, omitXpertRelations, replaceAgentInDraft, resolveDraftPrimaryAgent, resolveDraftRuntimeGraph, resolveI18nText, resolveMessageAppendContext, resolveRuntimeXpert, setStateVariable, shortTitle, stringifyMessageContent, transformInstallation, updateAssistantBindingSkillPreferences, updateAssistantBindingToolPreferences, uuid, workflowNodeIdentifier, xpertLabel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpert-ai/contracts",
-  "version": "3.15.0",
+  "version": "3.15.2",
   "license": "AGPL-3.0",
   "repository": {
     "type": "git",
@@ -19,7 +19,7 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
-    "@xpert-ai/chatkit-types": "~0.4.4"
+    "@xpert-ai/chatkit-types": "~0.4.5"
   },
   "types": "./index.d.ts"
 }

package/src/ai/copilot-usage.model.d.ts

@@ -0,0 +1,74 @@
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { IOrganization } from '../organization.model';
+import { IUser } from '../user.model';
+import { AiProvider } from './ai.model';
+import { ICopilotUser } from './copilot-user.model';
+export type TCopilotUsageDimension = 'user' | 'organization' | 'model';
+export type TCopilotQuotaAdjustmentMode = 'set' | 'increase';
+export interface ICopilotUsageGroupKey {
+    dimension: TCopilotUsageDimension;
+    tenantId?: string;
+    organizationId?: string | null;
+    orgId?: string | null;
+    userId?: string | null;
+    provider?: AiProvider | string | null;
+    model?: string | null;
+    currency?: string | null;
+}
+export interface ICopilotUsageSummary extends IBasePerTenantAndOrganizationEntityModel {
+    dimension: TCopilotUsageDimension;
+    groupKey: ICopilotUsageGroupKey;
+    userId?: string | null;
+    user?: IUser;
+    organization?: IOrganization;
+    orgId?: string | null;
+    org?: IOrganization;
+    provider?: AiProvider | string | null;
+    model?: string | null;
+    currency?: string | null;
+    tokenUsed: number;
+    tokenLimit?: number | null;
+    tokenTotalUsed: number;
+    tokenGrandTotal: number;
+    priceUsed: number;
+    priceLimit?: number | null;
+    priceTotalUsed: number;
+    priceGrandTotal: number;
+    userCount?: number;
+    organizationCount?: number;
+    detailCount?: number;
+    updatedAt?: Date;
+    details?: ICopilotUser[];
+}
+export interface ICopilotUsageTotals {
+    currency?: string | null;
+    tokenUsed: number;
+    tokenTotalUsed: number;
+    tokenGrandTotal: number;
+    priceUsed: number;
+    priceTotalUsed: number;
+    priceGrandTotal: number;
+}
+export interface ICopilotUsageQuery {
+    dimension?: TCopilotUsageDimension;
+    start?: string;
+    end?: string;
+    provider?: string;
+    model?: string;
+    userId?: string;
+    organizationId?: string;
+    currency?: string;
+}
+export type TCopilotQuotaAdjustInput = {
+    dimension: Extract<TCopilotUsageDimension, 'user' | 'organization'>;
+    groupKey: ICopilotUsageGroupKey;
+    mode?: TCopilotQuotaAdjustmentMode;
+    tokenLimit?: number | null;
+    priceLimit?: number | null;
+};
+export type TCopilotQuotaRenewInput = {
+    dimension: Extract<TCopilotUsageDimension, 'user' | 'organization'>;
+    groupKey: ICopilotUsageGroupKey;
+    tokenLimit?: number | null;
+    priceLimit?: number | null;
+};

package/src/ai/index.d.ts

@@ -19,8 +19,10 @@ export * from './copilot-organization.model';
 export * from './copilot-provider.model';
 export * from './copilot-store.model';
 export * from './copilot-user.model';
+export * from './copilot-usage.model';
 export * from './copilot.model';
 export * from './feature.model';
+export * from './membership.model';
 export * from './rag';
 export * from './rag-web';
 export * from './knowledgebase.model';

package/src/ai/membership.model.d.ts

@@ -0,0 +1,150 @@
+import { IBasePerTenantEntityModel } from '../base-entity.model';
+import { IUser } from '../user.model';
+export declare enum MembershipPlanStatusEnum {
+    Active = "active",
+    Archived = "archived"
+}
+export declare enum MembershipPeriodEnum {
+    Monthly = "monthly"
+}
+export declare enum MembershipStatusEnum {
+    Active = "active",
+    Paused = "paused",
+    Expired = "expired"
+}
+export declare enum MembershipLedgerSourceEnum {
+    Assignment = "assignment",
+    Grant = "grant",
+    Renew = "renew",
+    Usage = "usage",
+    Adjustment = "adjustment"
+}
+export type TMembershipRateLimitPeriod = 'hour' | 'day' | 'week' | 'cycle';
+export interface IMembershipModelMultiplier {
+    provider?: string | null;
+    model?: string | null;
+    multiplier: number;
+}
+export interface IMembershipRateLimit {
+    provider?: string | null;
+    model?: string | null;
+    period: TMembershipRateLimitPeriod;
+    pointLimit: number;
+}
+export interface IMembershipPlan extends IBasePerTenantEntityModel {
+    code: string;
+    name: string;
+    description?: string | null;
+    status: MembershipPlanStatusEnum;
+    isDefault?: boolean;
+    period: MembershipPeriodEnum;
+    includedPoints: number;
+    tokensPerPoint: number;
+    priceAmount?: number | null;
+    priceCurrency?: string | null;
+    modelMultipliers?: IMembershipModelMultiplier[];
+    rateLimits?: IMembershipRateLimit[];
+}
+export interface IUserMembership extends IBasePerTenantEntityModel {
+    userId: string;
+    user?: IUser;
+    planId: string;
+    plan?: IMembershipPlan;
+    status: MembershipStatusEnum;
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+    pointsGranted: number;
+    pointsUsed: number;
+    pointsTotalUsed: number;
+    assignedById?: string | null;
+    assignedBy?: IUser;
+    note?: string | null;
+}
+export interface IMembershipPointLedger extends IBasePerTenantEntityModel {
+    userId: string;
+    user?: IUser;
+    membershipId: string;
+    membership?: IUserMembership;
+    planId?: string | null;
+    plan?: IMembershipPlan;
+    source: MembershipLedgerSourceEnum;
+    pointsDelta: number;
+    tokenUsed?: number | null;
+    provider?: string | null;
+    model?: string | null;
+    organizationId?: string | null;
+    xpertId?: string | null;
+    threadId?: string | null;
+    copilotId?: string | null;
+    usageHour?: string | null;
+    reason?: string | null;
+}
+export interface IMembershipMe {
+    membership: IUserMembership;
+    plan: IMembershipPlan;
+    pointsGranted: number;
+    pointsUsed: number;
+    pointsRemaining: number;
+    pointsTotalUsed: number;
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+}
+export interface IMembershipUsageBucket {
+    date: string;
+    pointsUsed: number;
+    tokenUsed: number;
+}
+export interface IMembershipUsageRank {
+    key: string;
+    label?: string | null;
+    pointsUsed: number;
+    tokenUsed: number;
+}
+export interface IMembershipUsageGroupKey {
+    usageHour?: string | null;
+    provider?: string | null;
+    model?: string | null;
+    organizationId?: string | null;
+    xpertId?: string | null;
+    threadId?: string | null;
+    copilotId?: string | null;
+}
+export interface IMembershipUsageSummary extends IMembershipUsageGroupKey {
+    groupKey: IMembershipUsageGroupKey;
+    callCount: number;
+    pointsDelta: number;
+    pointsUsed: number;
+    tokenUsed: number;
+    firstUsedAt?: Date | string | null;
+    lastUsedAt?: Date | string | null;
+}
+export interface IMembershipUsageOverview extends IMembershipMe {
+    totalTokens: number;
+    peakDailyTokens: number;
+    activeDays: number;
+    buckets: IMembershipUsageBucket[];
+    topModels: IMembershipUsageRank[];
+    topXperts: IMembershipUsageRank[];
+    topThreads: IMembershipUsageRank[];
+}
+export type TMembershipAssignInput = {
+    planId: string;
+    currentPeriodStart?: string | Date;
+    currentPeriodEnd?: string | Date;
+    note?: string | null;
+};
+export type TMembershipPointAdjustInput = {
+    pointDelta: number;
+    reason?: string | null;
+};
+export interface IMembershipUsageQuery {
+    start?: string;
+    end?: string;
+    provider?: string;
+    model?: string;
+    organizationId?: string;
+    xpertId?: string;
+    threadId?: string;
+    copilotId?: string;
+    usageHour?: string;
+}

package/src/ai/role-permissions.d.ts

@@ -5,6 +5,7 @@ export declare enum AIPermissionsEnum {
     KNOWLEDGEBASE_EDIT = "KNOWLEDGEBASE_EDIT",
     COPILOT_VIEW = "COPILOT_VIEW",
     COPILOT_EDIT = "COPILOT_EDIT",
+    MEMBERSHIP_EDIT = "MEMBERSHIP_EDIT",
     /**
      * Create or edit Xperts in organization.
      */

package/src/ai/skill.model.d.ts

@@ -44,6 +44,7 @@ export interface SkillMetadata {
     summary?: I18nObject;
     description?: I18nObject;
     icon?: IconDefinition;
+    color?: string;
     tags?: string[];
     author?: {
         name: string;

package/src/plugin.d.ts

@@ -78,7 +78,7 @@ export type PluginResourceInstallationStatus = (typeof PLUGIN_RESOURCE_INSTALLAT
 export type PluginScopeRelation = 'none' | 'overrides-global' | 'shadowed-by-organization';
 export type PluginTargetApp = 'xpert' | 'data-xpert' | (string & {});
 export type PluginSdkCompatibilityWarningCode = 'plugin-sdk-peer-dependency-missing' | 'plugin-sdk-peer-range-invalid' | 'plugin-sdk-peer-range-incompatible' | 'plugin-sdk-peer-range-spans-major';
-export type PluginMarketplaceContributionType = 'app' | 'view' | 'feature' | 'tool' | 'assistant-template' | (string & {});
+export type PluginMarketplaceContributionType = 'app' | 'view' | 'feature' | 'skill' | 'tool' | 'hook' | 'assistant-template' | (string & {});
 export type PluginMarketplaceOperationAccess = 'read' | 'write' | 'admin' | (string & {});
 export interface PluginMarketplaceOperation {
     name: string;
@@ -197,10 +197,18 @@ export interface PluginMarketplaceContribution {
     displayName?: string | I18nObject;
     description?: string | I18nObject;
     icon?: IconDefinition;
+    color?: string;
     operations?: PluginMarketplaceOperation[];
     tags?: string[];
     metadata?: Record<string, unknown>;
 }
+export interface PluginMarketplaceTrialShortcut {
+    id?: string;
+    label?: string | I18nObject;
+    prompt: string;
+    skillKey?: string;
+    icon?: IconDefinition;
+}
 export type PluginMarketplaceCategory = 'featured' | 'business-operations' | 'communication' | 'creativity' | 'data-analytics' | 'developer-tools' | 'education-research' | 'finance' | 'productivity' | 'research' | 'security' | 'travel' | 'sales' | 'other';
 export interface PluginTargetAppMarketplaceMetadata {
     contents?: PluginMarketplaceContribution[];
@@ -208,6 +216,7 @@ export interface PluginTargetAppMarketplaceMetadata {
     subcategory?: string;
     featured?: boolean;
     screenshots?: string[];
+    trialShortcuts?: PluginMarketplaceTrialShortcut[];
     readme?: string;
     updatedAt?: string;
 }
@@ -387,12 +396,15 @@ export interface PluginMarketplaceItem {
     author?: PluginMarketplaceAuthor | string | null;
     source?: PluginMarketplaceItemSource | null;
     keywords?: string[];
+    screenshots?: string[];
     downloads?: PluginMarketplaceDownloads | null;
     sourceId?: string | null;
     sourceName?: string | null;
     sourceNameI18nKey?: string | null;
     installed?: boolean;
     contributions?: PluginMarketplaceContribution[];
+    defaultPrompt?: string[];
+    trialShortcuts?: PluginMarketplaceTrialShortcut[];
     operationSummary?: PluginMarketplaceOperationSummary;
     targetApps?: PluginTargetApp[];
     targetAppMeta?: PluginTargetAppMeta | null;
@@ -426,6 +438,7 @@ export interface PluginMarketplaceResponse {
     }>;
 }
 export interface IPlugin extends IBasePerTenantAndOrganizationEntityModel {
+    scopeKey?: string | null;
     pluginName: string;
     packageName: string;
     version?: string;
@@ -456,6 +469,7 @@ export interface IPluginUpdateResult extends IPluginInstallResult {
     previousVersion?: string;
 }
 export interface IPluginDescriptor {
+    scopeKey?: string;
     organizationId?: string;
     name: PluginName;
     meta: PluginMeta;
@@ -509,6 +523,14 @@ export interface IPluginComponentDefinition {
     metadata?: JSONValue | null;
     definitionHash: string;
 }
+export interface IPluginComponentDocument {
+    pluginName: PluginName;
+    componentType: PluginComponentType;
+    componentKey: string;
+    sourcePath?: string | null;
+    fileName?: string | null;
+    content: string;
+}
 export interface IPluginResourceComponentState {
     componentType: PluginComponentType;
     componentKey: string;

package/src/user-organization.model.d.ts

@@ -2,7 +2,17 @@ import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
 import { LanguagesEnum, IUser } from './user.model';
 export interface IUserOrganizationPreferences {
     defaultWorkspaceId?: string | null;
+    entryGuides?: IUserOrganizationEntryGuidePreferences | null;
 }
+export declare const USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT = "clawxpert";
+export type IUserOrganizationEntryGuideKey = typeof USER_ORGANIZATION_ENTRY_GUIDE_CLAWXPERT;
+export interface IUserOrganizationEntryGuidePreference {
+    autoShownAt?: string | null;
+}
+export interface IUserOrganizationEntryGuidePreferences {
+    clawxpert?: IUserOrganizationEntryGuidePreference | null;
+}
+export declare function isUserOrganizationEntryGuideKey(value: string): value is IUserOrganizationEntryGuideKey;
 export interface IUserOrganization extends IBasePerTenantAndOrganizationEntityModel {
     userId: string;
     isDefault: boolean;