@veltdev/sdk-staging 5.0.2-beta.27 → 5.0.2-beta.28

package/app/models/data/activity-resolver.data.model.d.ts

@@ -0,0 +1,27 @@
+import { BaseMetadata } from './base-metadata.data.model';
+import { ActivityChanges } from './activity.data.model';
+import { ResolverConfig, ResolverResponse } from './resolver.data.model';
+export interface PartialActivityRecord {
+    id: string;
+    metadata?: BaseMetadata;
+    changes?: ActivityChanges;
+    entityData?: unknown;
+    entityTargetData?: unknown;
+    displayMessageTemplateData?: Record<string, unknown>;
+    [key: string]: any;
+}
+export interface ActivityAnnotationDataProvider {
+    get?: (request: GetActivityResolverRequest) => Promise<ResolverResponse<Record<string, PartialActivityRecord>>>;
+    save?: (request: SaveActivityResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+}
+export interface GetActivityResolverRequest {
+    activityIds?: string[];
+    documentIds?: string[];
+    organizationId?: string;
+}
+export interface SaveActivityResolverRequest {
+    activity: Record<string, PartialActivityRecord>;
+    event?: string;
+    metadata?: BaseMetadata;
+}

package/app/models/data/activity.data.model.d.ts

@@ -115,6 +115,8 @@ export declare class ActivityRecord<TEntity = unknown, TTarget = unknown> {
     actionIcon?: string;
     /** If true, this activity cannot be updated or deleted via REST API */
     immutable?: boolean;
+    /** If true, this activity was stripped by the activity resolver (for UI loading states) */
+    isActivityResolverUsed?: boolean;
 }
 /**
  * Configuration for subscribing to activities.

package/app/models/data/core-events.data.model.d.ts

@@ -9,6 +9,7 @@ export type CoreEventTypesMap = {
     [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
     [CoreEventTypes.RECORDER_RESOLVER]: RecorderResolverEvent;
     [CoreEventTypes.NOTIFICATION_RESOLVER]: NotificationResolverEvent;
+    [CoreEventTypes.ACTIVITY_RESOLVER]: ActivityResolverEvent;
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -198,6 +199,26 @@ export type NotificationResolverEventType = {
     NOTIFICATION_DELETE_ERROR: 'notificationDeleteError';
 };
 export type NotificationResolverEvent = BaseResolverEvent<NotificationResolverEventType, NotificationResolverSource, NotificationResolverModuleName>;
+export declare enum ActivityResolverSource {
+    RESOLVE_ACTIVITIES = "resolveActivities",
+    SAVE_ACTIVITY = "saveActivity",
+    FORMAT_RESPONSE = "formatResponse"
+}
+export declare enum ActivityResolverModuleName {
+    GET_ACTIVITIES = "getActivities"
+}
+export type ActivityResolverEventType = {
+    ACTIVITY_RESOLUTION_REQUEST_FORMED: 'activityResolutionRequestFormed';
+    ACTIVITY_RESOLUTION_REQUEST_TRIGGERED: 'activityResolutionRequestTriggered';
+    ACTIVITY_RESOLUTION_RESULT: 'activityResolutionResult';
+    ACTIVITY_RESOLUTION_ERROR: 'activityResolutionError';
+    ACTIVITY_RESOLUTION_RESULT_FROM_CACHE: 'activityResolutionResultFromCache';
+    ACTIVITY_SAVE_REQUEST_FORMED: 'activitySaveRequestFormed';
+    ACTIVITY_SAVE_REQUEST_TRIGGERED: 'activitySaveRequestTriggered';
+    ACTIVITY_SAVE_RESULT: 'activitySaveResult';
+    ACTIVITY_SAVE_ERROR: 'activitySaveError';
+};
+export type ActivityResolverEvent = BaseResolverEvent<ActivityResolverEventType, ActivityResolverSource, ActivityResolverModuleName>;
 export type ErrorEvent = {
     event?: string;
     sourceMethod?: string;

package/app/models/data/provider.data.model.d.ts

@@ -1,3 +1,4 @@
+import { ActivityAnnotationDataProvider } from "./activity-resolver.data.model";
 import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
 import { AttachmentDataProvider } from "./attachment-resolver.data.model";
 import { NotificationDataProvider } from "./notification-resolver.data.model";
@@ -12,4 +13,5 @@ export interface VeltDataProvider {
     anonymousUser?: AnonymousUserDataProvider;
     recorder?: RecorderAnnotationDataProvider;
     notification?: NotificationDataProvider;
+    activity?: ActivityAnnotationDataProvider;
 }

package/app/models/data/user-resolver.data.model.d.ts

@@ -33,6 +33,7 @@ export interface GetUserPermissionsResponse {
         folders?: {
             [folderId: string]: {
                 accessRole?: UserPermissionAccessRole;
+                accessType?: string;
                 expiresAt?: number;
                 error?: string;
                 errorCode?: UserPermissionAccessRoleResult;
@@ -49,6 +50,7 @@ export interface GetUserPermissionsResponse {
         documents?: {
             [documentId: string]: {
                 accessRole?: UserPermissionAccessRole;
+                accessType?: string;
                 expiresAt?: number;
                 error?: string;
                 errorCode?: UserPermissionAccessRoleResult;

package/app/models/data/user.data.model.d.ts

@@ -12,6 +12,8 @@ export declare class User {
      * Default: Random avatar name.
      */
     name?: string;
+    email_lowercase?: string;
+    name_lowercase?: string;
     clientUserName?: string;
     /**
     * Your user's display picture URL.

package/app/utils/enums.d.ts

@@ -28,7 +28,8 @@ export declare enum ResolverActions {
     ATTACHMENT_DELETE = "attachment.delete",
     RECORDER_ANNOTATION_ADD = "recorder_annotation.add",
     RECORDER_ANNOTATION_UPDATE = "recorder_annotation.update",
-    RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete"
+    RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete",
+    ACTIVITY_SAVE = "activity.save"
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
@@ -92,6 +93,7 @@ export declare const CoreEventTypes: {
     readonly REACTION_RESOLVER: "reactionResolver";
     readonly RECORDER_RESOLVER: "recorderResolver";
     readonly NOTIFICATION_RESOLVER: "notificationResolver";
+    readonly ACTIVITY_RESOLVER: "activityResolver";
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
     readonly USER_UPDATE: "userUpdate";
     readonly INIT_UPDATE: "initUpdate";

package/models.d.ts

@@ -75,6 +75,7 @@ export * from './app/models/data/reaction-annotation.data.model';
 export * from './app/models/data/reaction-resolver.data.model';
 export * from './app/models/data/recorder-resolver.data.model';
 export * from './app/models/data/attachment-resolver.data.model';
+export * from './app/models/data/activity-resolver.data.model';
 export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "5.0.2-beta.27",
+    "version": "5.0.2-beta.28",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [