twenty-sdk 2.19.0-alpha.1 → 2.20.0

package/dist/define/index.d.ts

@@ -35,6 +35,19 @@ type AgentManifest = SyncableEntityOptions$1 & {
     responseFormat?: AgentResponseFormat;
 };
 
+declare const APPLICATION_CATEGORIES: readonly ["Communication", "Productivity", "Product management", "Sales", "Marketing", "Enrichment", "Data", "Search", "Other"];
+type KnownApplicationCategory = (typeof APPLICATION_CATEGORIES)[number];
+type ApplicationCategory = KnownApplicationCategory | (string & {});
+
+type PreInstallLogicFunctionApplicationManifest = SyncableEntityOptions$1 & {
+    universalIdentifier: string;
+    shouldRunOnVersionUpgrade?: boolean;
+};
+
+type PostInstallLogicFunctionApplicationManifest = PreInstallLogicFunctionApplicationManifest & {
+    shouldRunSynchronously?: boolean;
+};
+
 declare enum FieldMetadataType {
     ACTOR = "ACTOR",
     ADDRESS = "ADDRESS",
@@ -95,15 +108,6 @@ type ServerVariableSchema = {
 };
 type ServerVariables = Record<string, ServerVariableSchema>;
 
-type PreInstallLogicFunctionApplicationManifest = SyncableEntityOptions$1 & {
-    universalIdentifier: string;
-    shouldRunOnVersionUpgrade?: boolean;
-};
-
-type PostInstallLogicFunctionApplicationManifest = PreInstallLogicFunctionApplicationManifest & {
-    shouldRunSynchronously?: boolean;
-};
-
 type ApplicationManifest = SyncableEntityOptions$1 & {
     defaultRoleUniversalIdentifier: string;
     displayName: string;
@@ -111,9 +115,17 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     applicationVariables?: ApplicationVariables;
     serverVariables?: ServerVariables;
     author?: string;
-    category?: string;
+    category?: ApplicationCategory;
+    /**
+     * @deprecated Use `logo` instead.
+     */
     logoUrl?: string;
+    logo?: string;
+    /**
+     * @deprecated Use `galleryImages` instead.
+     */
     screenshots?: string[];
+    galleryImages?: string[];
     aboutDescription?: string;
     websiteUrl?: string;
     termsUrl?: string;
@@ -129,6 +141,7 @@ type ApplicationManifest = SyncableEntityOptions$1 & {
     settingsCustomTabFrontComponentUniversalIdentifier?: string;
     packageJsonChecksum: string | null;
     yarnLockChecksum: string | null;
+    requiredServerVersionRange?: string | null;
 };
 
 type OAuthProviderTokenRequestContentType = 'json' | 'form-urlencoded';
@@ -1186,7 +1199,7 @@ type ViewManifest = SyncableEntityOptions$1 & {
     sorts?: ViewSortManifest[];
 };
 
-type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
+type ApplicationConfig = Omit<ApplicationManifest, 'packageJsonChecksum' | 'yarnLockChecksum' | 'requiredServerVersionRange' | 'postInstallLogicFunction' | 'preInstallLogicFunction' | 'defaultRoleUniversalIdentifier' | 'aboutDescription'> & {
     /**
      * @deprecated Use `defineApplicationRole()` in your role file instead.
      */
@@ -1448,12 +1461,6 @@ declare const defineNavigationMenuItem: DefineEntity<NavigationMenuItemManifest>
 
 declare const defineObject: DefineEntity<ObjectConfig>;
 
-declare const generateDefaultFieldUniversalIdentifier: ({ applicationUniversalIdentifier, objectUniversalIdentifier, fieldName, }: {
-    applicationUniversalIdentifier: string;
-    objectUniversalIdentifier: string;
-    fieldName: string;
-}) => string;
-
 declare const STANDARD_OBJECTS: {
     readonly attachment: {
         readonly universalIdentifier: "20202020-bd3d-4c60-8dca-571c71d4447a";
@@ -5414,5 +5421,5 @@ declare const defineView: DefineEntity<ViewConfig>;
 
 declare const defineViewField: DefineEntity<StandaloneViewFieldManifest>;
 
-export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSkill, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, generateDefaultFieldUniversalIdentifier, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
+export { AggregateOperations, DateDisplayFormat, FieldMetadataSettingsOnClickAction, FieldMetadataType as FieldType, HTTPMethod, NavigationMenuItemType, NumberDataType, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordGroupByDateGranularity, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, RelationOnDeleteAction as OnDeleteAction, PageLayoutTabLayoutMode, PageLayoutType, RelationType, RowLevelPermissionPredicateGroupLogicalOperator, RowLevelPermissionPredicateOperand, STANDARD_OBJECTS as STANDARD_OBJECT, STANDARD_OBJECTS as STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS as STANDARD_PAGE_LAYOUT, STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS, SystemPermissionFlag, ViewCalendarLayout, ViewFilterGroupLogicalOperator, ViewFilterOperand, ViewKey, ViewOpenRecordIn, ViewSortDirection, ViewType, ViewVisibility, canAccessFullAdminPanel, canImpersonate, createValidationResult, defineAgent, defineApplication, defineApplicationRole, defineCommandMenuItem, defineConnectionProvider, defineField, defineFrontComponent, defineIndex, defineLogicFunction, defineNavigationMenuItem, defineObject, definePageLayout, definePageLayoutTab, definePermissionFlag, definePostInstallLogicFunction, definePreInstallLogicFunction, defineRole, defineSkill, defineView, defineViewField, every, everyDefined, everyEquals, favoriteRecordIds, featureFlags, hasAnySoftDeleteFilterOnView, includes, includesEvery, isDashboardPageLayoutInEditMode, isDefined, isInSidePanel, isLayoutCustomizationModeEnabled, isNonEmptyString, isSelectAll, none, noneDefined, noneEquals, numberOfSelectedRecords, objectMetadataItem, objectMetadataLabel, objectPermissions, pageType, selectedRecords, some, someDefined, someEquals, someNonEmptyString, targetObjectReadPermissions, targetObjectWritePermissions, validateFields };
 export type { ActorMetadata as ActorField, AddressMetadata as AddressField, ApplicationConfig, CommandMenuItemConfig, CommandMenuItemManifest, CronPayload, CurrencyMetadata as CurrencyField, DatabaseEventPayload, DefinableEntity, DefineEntity, EmailsMetadata as EmailsField, FrontComponentConfig, FrontComponentType, FullNameMetadata as FullNameField, GridPosition, IndexConfig, IndexFieldManifest, IndexManifest, InputJsonSchema, InstallHandler, InstallPayload, LinksMetadata as LinksField, LogicFunctionConfig, LogicFunctionHandler, ObjectRecordEvent, PageLayoutConfig, PageLayoutManifest, PageLayoutTabConfig, PageLayoutTabManifest, PageLayoutWidgetConditionalDisplay, PageLayoutWidgetManifest, PageLayoutWidgetUniversalConfiguration, PermissionFlagConfig, PermissionFlagManifest, PermissionFlagPermissionType, PhonesMetadata as PhonesField, RichTextMetadata as RichTextField, LogicFunctionEvent as RoutePayload, RowLevelPermissionPredicateGroupManifest, RowLevelPermissionPredicateManifest, StandaloneViewFieldManifest, SyncableEntityOptions, TwentyRecord, ValidationResult, ViewConfig, ViewFieldGroupManifest, ViewFieldManifest, ViewFilterGroupManifest, ViewFilterManifest, ViewGroupManifest, ViewManifestFilterValue, ViewSortManifest };