Module: Core¶
The core components of the Pack SDK. These functions and types are used to define your Pack, its building blocks, and their logic.
This module is imported using the following code:
import * as sdk from "@superhuman/plugins-sdk";
Namespaces¶
Enumerations¶
- AttributionNodeType
- AuthenticationType
- ConnectionRequirement
- ContextualTriggerAssistMode
- CurrencyFormat
- DataIndexing
- DefaultTriggerKind
- DurationUnit
- EmailDisplayType
- EventTriggerType
- FilterCombinator
- FilterOperator
- HttpStatusCode
- ImageCornerStyle
- ImageOutline
- ImageShapeStyle
- InvocationErrorType
- InvocationSource
KnowledgeToolSourceType- LinkDisplayType
- MailEventType
- MailFilterField
NetworkConnection- OptionsType
- ParameterType
- PermissionSyncMode
- PostSetupType
- PrecannedDateRange
- ScaleIconSet
ScreenAnnotationTypeSkillModel- SlackEventType
- TokenExchangeCredentialsLocation
- ToolType
- Type
- ValueHintType
- ValueType
Classes¶
- AgentDefinitionBuilder
- ConnectorDefinitionBuilder
- MissingScopesError
PackDefinitionBuilder- ResponseSizeTooLargeError
- StatusCodeError
- UserVisibleError
Interfaces¶
- AgentConnectorMcpTool
- AgentDefinition
- AgentRoutineDefinition
- AgentRoutineMetadata
- AgentToolsDef
- ArraySchema
- ArrayType
- AWSAccessKeyAuthentication
- AWSAssumeRoleAuthentication
- BaseAuthentication
- BaseDefaultTrigger
- BaseEventTrigger
- BaseFormulaDef
- BaseMailFilterCondition
- BooleanSchema
- CodaApiBearerTokenAuthentication
- CodaDocsAndTablesTool
- CommonFormulaDef
CommonPackFormulaDef- ComponentVersionDefinition
- ConnectorTool
ContactResolutionTool- Continuation
- CrawlStrategy
- CurrencySchema
- CustomAuthentication
- CustomAuthParameter
- CustomHeaderTokenAuthentication
- CustomIndexDefinition
- DurationSchema
- DynamicOptions
- DynamicSyncTableDef
- DynamicSyncTableOptions
- EmailSchema
- EmptyFormulaDef
- ExecutionContext
- Fetcher
- FetchRequest
- FetchResponse
- Format
- FormulaDef
- HeaderBearerTokenAuthentication
- Identity
- IdentityDefinition
- ImageAttributionNode
- ImageSchema
- InvalidParameterValidationResult
- InvocationLocation
KnowledgeTool- LinkAttributionNode
- LinkSchema
- MailAndCalendarTool
- MailEventFilters
- MailEventTriggerDefinition
- MailEventTriggerMetadata
- MCPServer
MCPTool- MetadataFormulaObjectResultType
- MultiHeaderTokenAuthentication
- MultiQueryParamTokenAuthentication
Network- NoAuthentication
- NumericDateSchema
- NumericDateTimeSchema
- NumericDurationSchema
- NumericSchema
- NumericTimeSchema
- OAuth2ClientCredentialsAuthentication
- OAuth2DynamicCodeAuthentication
- OAuth2StaticCodeAuthentication
- ObjectArrayFormulaDef
- ObjectSchemaDefinition
- ObjectSchemaProperty
- OptionalParamDef
PackDefinitionPackFormulaDefPackKnowledgeToolSourcePackToolPackVersionDefinition- ParamDef
- ParameterValidationDetail
- ProgressBarSchema
- PropertyIdentifierDetails
- PropertyOptionsExecutionContext
- PropertyWithOptions
- QueryParamTokenAuthentication
- RequestHandlerTemplate
- RequiredParamDef
- ResponseHandlerTemplate
RewriteScreenAnnotation- ScaleSchema
- ScheduleTriggerDefinition
ScreenAnnotationTool- SetEndpoint
- SimpleAutocompleteOption
- SimpleStringSchema
SkillSkillEntrypointConfigSkillEntrypointsSkillModelConfiguration- SlackEventTriggerDefinition
- SliderSchema
- StatusCodeErrorResponse
- StringDateSchema
- StringDateTimeSchema
- StringEmbedSchema
- StringTimeSchema
- StringWithOptionsSchema
- SuggestedPrompt
- SyncBase
- SyncCompletionMetadata
- SyncCompletionMetadataIncomplete
- SyncExecutionContext
- SyncFormulaDef
- SyncFormulaResult
- SyncFull
- SyncIncremental
- SyncTableDef
- SyncTableOptions
- SyncTableRelation
- SyncUpdate
- SyncUpdateResult
- TemporaryBlobStorage
- TextAttributionNode
- UpdateSync
- UpdateSyncExecutionContext
- ValidParameterValidationResult
- WebBasicAuthentication
- WebSearchTool
- WhileWritingTriggerDefinition
Type Aliases¶
- AddressFilterOperator
- AgentConnectorId
- AgentTool
- ArrayFormulaDef
- AttributionNode
- Authentication
- AuthenticationDef
- BaseFormula
- BasicComponentDefinition
- BasicIndexedProperty
BasicPackDefinition- BooleanFormula
- BooleanFormulaDef
- BooleanHintTypes
BooleanPackFormula- ContextProperties
- DefaultTriggerDefinition
- DefaultTriggerMetadata
- EventTriggerDefinition
- FetchMethodType
- FilterableProperty
- Formula
- FormulaDefinitionOptions
- FormulaOptions
- FormulaResult
- FormulaValue
- GenericDynamicSyncTable
- GenericSyncFormula
- GenericSyncFormulaResult
- GenericSyncTable
- GenericSyncUpdate
- GenericSyncUpdateSingleResult
- HttpStatusInvocationError
- IdFilterOperator
- IndexDefinition
- IndexedProperty
- InferrableTypes
- InvocationError
KnowledgeToolSource- LegacyDefaultMetadataReturnType
- MailAddressFilterCondition
- MailEventFilterCondition
- MailTextFilterCondition
- MetadataContext
- MetadataFormula
- MetadataFormulaDef
- MetadataFormulaResultType
- MetadataFunction
- NumberHintTypes
- NumberSchema
- NumericFilterOperator
- NumericFormula
- NumericFormulaDef
NumericPackFormula- OAuth2Authentication
- ObjectFormula
- ObjectFormulaDef
- ObjectHintTypes
ObjectPackFormula- ObjectSchemaProperties
PackFormulaResultPackFormulaValuePackId- ParamDefFromOptionsUnion
- ParamDefs
- ParameterOptions
- ParameterValidationResult
- ParamValues
PartialSkillDef- PostSetup
- PostSetupDef
- PropertyIdentifier
- PropertyOptionsMetadataFunction
- PropertyOptionsMetadataResult
- PropertySchemaOptions
- RateLimitExceededInvocationError
- ResponseTooLargeInvocationError
- Schema
- SchemaType
ScreenAnnotation- SetEndpointDef
- StringFormula
- StringFormulaDef
- StringHintTypes
StringPackFormula- StringSchema
- SuggestedValueType
- Sync
- SyncCompletionMetadataResult
- SyncFormula
- SyncTable
- SyncUpdateSingleResult
- SystemAuthentication
- SystemAuthenticationDef
- TextFilterOperator
- TimeoutInvocationError
- TypedFormula
TypedPackFormula- UnknownInvocationError
- UserAuthenticationDef
Variables¶
Functions¶
- assertCondition
- autocompleteSearchObjects
- ensureExists
- ensureNonEmptyString
- ensureUnreachable
- generateSchema
- getEffectivePropertyKeysFromSchema
- getQueryParams
- joinUrl
- makeAttributionNode
- makeDynamicSyncTable
- makeEmptyFormula
- makeFormula
- makeMetadataFormula
- makeObjectSchema
- makeParameter
- makeReferenceSchemaFromObjectSchema
- makeSchema
makeSimpleAutocompleteMetadataFormula- makeSyncTable
- makeTranslateObjectFormula
- newAgent
- newConnector
newPack- simpleAutocomplete
- withIdentity
- withQueryParams