platform.model.ts•5.54 kB
import { Static, Type } from '@sinclair/typebox'
import { BaseModelSchema, Nullable } from '../common/base-model'
import { ApId } from '../common/id-generator'
import { FederatedAuthnProviderConfig, FederatedAuthnProviderConfigWithoutSensitiveData } from '../federated-authn'
export type PlatformId = ApId
export enum FilteredPieceBehavior {
ALLOWED = 'ALLOWED',
BLOCKED = 'BLOCKED',
}
export const SMTPInformation = Type.Object({
user: Type.String(),
senderEmail: Type.String(),
senderName: Type.String(),
password: Type.String(),
host: Type.String(),
port: Type.Number(),
})
export type SMTPInformation = Static<typeof SMTPInformation>
export enum PlatformUsageMetric {
AI_CREDITS = 'ai-credits',
ACTIVE_FLOWS = 'active-flows',
}
export const PlatformUsage = Type.Object({
aiCredits: Type.Number(),
activeFlows: Type.Number(),
})
export type PlatformUsage = Static<typeof PlatformUsage>
export enum AiOverageState {
NOT_ALLOWED = 'not_allowed',
ALLOWED_BUT_OFF = 'allowed_but_off',
ALLOWED_AND_ON = 'allowed_and_on',
}
export enum PlanName {
STANDARD = 'standard',
ENTERPRISE = 'enterprise',
APPSUMO_ACTIVEPIECES_TIER1 = 'appsumo_activepieces_tier1',
APPSUMO_ACTIVEPIECES_TIER2 = 'appsumo_activepieces_tier2',
APPSUMO_ACTIVEPIECES_TIER3 = 'appsumo_activepieces_tier3',
APPSUMO_ACTIVEPIECES_TIER4 = 'appsumo_activepieces_tier4',
APPSUMO_ACTIVEPIECES_TIER5 = 'appsumo_activepieces_tier5',
APPSUMO_ACTIVEPIECES_TIER6 = 'appsumo_activepieces_tier6',
}
export const PlatformPlan = Type.Object({
...BaseModelSchema,
// TODO: We have to use the enum when we finalize the plan names
plan: Type.Optional(Type.String()),
platformId: Type.String(),
includedAiCredits: Type.Number(),
aiCreditsOverageLimit: Type.Optional(Type.Number()),
aiCreditsOverageState: Type.Optional(Type.String()),
environmentsEnabled: Type.Boolean(),
analyticsEnabled: Type.Boolean(),
showPoweredBy: Type.Boolean(),
agentsEnabled: Type.Boolean(),
mcpsEnabled: Type.Boolean(),
tablesEnabled: Type.Boolean(),
todosEnabled: Type.Boolean(),
auditLogEnabled: Type.Boolean(),
embeddingEnabled: Type.Boolean(),
managePiecesEnabled: Type.Boolean(),
manageTemplatesEnabled: Type.Boolean(),
customAppearanceEnabled: Type.Boolean(),
manageProjectsEnabled: Type.Boolean(),
projectRolesEnabled: Type.Boolean(),
customDomainsEnabled: Type.Boolean(),
globalConnectionsEnabled: Type.Boolean(),
customRolesEnabled: Type.Boolean(),
apiKeysEnabled: Type.Boolean(),
ssoEnabled: Type.Boolean(),
licenseKey: Type.Optional(Type.String()),
licenseExpiresAt: Type.Optional(Type.String()),
stripeCustomerId: Type.Optional(Type.String()),
stripeSubscriptionId: Type.Optional(Type.String()),
stripeSubscriptionStatus: Type.Optional(Type.String()),
stripeSubscriptionStartDate: Type.Optional(Type.Number()),
stripeSubscriptionEndDate: Type.Optional(Type.Number()),
stripeSubscriptionCancelDate: Type.Optional(Type.Number()),
projectsLimit: Nullable(Type.Number()),
activeFlowsLimit: Nullable(Type.Number()),
dedicatedWorkers: Nullable(Type.Object({
trustedEnvironment: Type.Boolean(),
})),
})
export type PlatformPlan = Static<typeof PlatformPlan>
export const PlatformPlanLimits = Type.Omit(PlatformPlan, ['id', 'platformId', 'created', 'updated'])
export type PlatformPlanLimits = Static<typeof PlatformPlanLimits>
export type PlatformPlanWithOnlyLimits = Omit<PlatformPlanLimits, 'stripeSubscriptionStartDate' | 'stripeSubscriptionEndDate' | 'stripeBillingCycle'>
export const Platform = Type.Object({
...BaseModelSchema,
ownerId: ApId,
name: Type.String(),
primaryColor: Type.String(),
logoIconUrl: Type.String(),
fullLogoUrl: Type.String(),
favIconUrl: Type.String(),
/**
* @deprecated Use projects filter instead.
*/
filteredPieceNames: Type.Array(Type.String()),
/**
* @deprecated Use projects filter instead.
*/
filteredPieceBehavior: Type.Enum(FilteredPieceBehavior),
smtp: Nullable(SMTPInformation),
cloudAuthEnabled: Type.Boolean(),
enforceAllowedAuthDomains: Type.Boolean(),
allowedAuthDomains: Type.Array(Type.String()),
federatedAuthProviders: FederatedAuthnProviderConfig,
emailAuthEnabled: Type.Boolean(),
pinnedPieces: Type.Array(Type.String()),
})
export type Platform = Static<typeof Platform>
export const PlatformWithoutSensitiveData = Type.Composite([Type.Object({
federatedAuthProviders: Nullable(FederatedAuthnProviderConfigWithoutSensitiveData),
smtp: Nullable(Type.Object({})),
plan: PlatformPlanLimits,
usage: Type.Optional(PlatformUsage),
}), Type.Pick(Platform, [
'id',
'created',
'updated',
'ownerId',
'name',
'plan',
'primaryColor',
'logoIconUrl',
'fullLogoUrl',
'favIconUrl',
'filteredPieceNames',
'filteredPieceBehavior',
'cloudAuthEnabled',
'enforceAllowedAuthDomains',
'allowedAuthDomains',
'emailAuthEnabled',
'pinnedPieces',
])])
export type PlatformWithoutSensitiveData = Static<typeof PlatformWithoutSensitiveData>
export const PlatformBillingInformation = Type.Object({
plan: PlatformPlan,
usage: PlatformUsage,
nextBillingDate: Type.Number(),
nextBillingAmount: Type.Number(),
cancelAt: Type.Optional(Type.Number()),
})
export type PlatformBillingInformation = Static<typeof PlatformBillingInformation>