Documentation Index

Fetch the complete documentation index at: https://docs.velt.dev/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

• Activity content (comment text embedded in change history), feature-specific entity snapshots, and custom fields can be stored on your own infrastructure, with only necessary identifiers on Velt servers.
• Velt components automatically re-hydrate activity data in the frontend by fetching from your configured data provider.
• This gives you full control over PII while maintaining all Velt activity log features.

​

How does it work?

1. The SDK uses your configured ActivityAnnotationDataProvider to handle storage and retrieval.
2. Your data provider implements two optional methods:
   • get: Fetches activity PII from your database and returns it for re-hydration
   • save: Stores PII fields stripped from the activity record before Velt writes to its backend

1. The SDK strips configured PII fields from the activity record.
2. Your save handler receives the stripped data and stores it in your backend.
3. Velt’s backend stores only the minimal identifiers.

1. The SDK fetches the activity records from Velt’s backend (with PII absent).
2. Your get handler is called with the activity IDs.
3. The SDK merges the returned PII back into the activity records before delivering them to your UI.
4. ActivityRecord.isActivityResolverUsed is set to true when PII was stripped by the resolver. Use this to show a loading state while re-hydration is pending.

​

Implementation

​

Function based DataProvider

​

get

• Param: GetActivityResolverRequest
• Return: Promise<ResolverResponse<Record<string, PartialActivityRecord>>>

const activityDataProvider = {
  get: async (request) => {
    const response = await fetch('/api/velt/activity/get', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(request),
    });
    return await response.json();
  },
};

client.setDataProviders({ activity: activityDataProvider });

const activityDataProvider = {
  get: async (request) => {
    const response = await fetch('/api/velt/activity/get', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(request),
    });
    return await response.json();
  },
};

Velt.setDataProviders({ activity: activityDataProvider });

​

save

• Param: SaveActivityResolverRequest
• Return: Promise<ResolverResponse<undefined>>

const activityDataProvider = {
  save: async (request) => {
    const response = await fetch('/api/velt/activity/save', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(request),
    });
    return await response.json();
  },
};

client.setDataProviders({ activity: activityDataProvider });

const activityDataProvider = {
  save: async (request) => {
    const response = await fetch('/api/velt/activity/save', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(request),
    });
    return await response.json();
  },
};

Velt.setDataProviders({ activity: activityDataProvider });

​

config

• Type: ResolverConfig. Relevant properties:
  • resolveTimeout: Timeout duration (in milliseconds) for resolver operations.
  • fieldsToRemove: string[]. Additional fields to strip from activity records before writing to Velt’s backend (e.g., ['customSensitiveField']).

const activityDataProvider = {
  config: {
    resolveTimeout: 60000,
    fieldsToRemove: ['customSensitiveField'],
  },
};

​

Complete Example

// Using API methods
client.setDataProviders({
  activity: {
    get: async (request) => {
      const response = await fetch('/api/velt/activity/get', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(request),
      });
      return await response.json();
    },
    save: async (request) => {
      const response = await fetch('/api/velt/activity/save', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(request),
      });
      return await response.json();
    },
    config: {
      resolveTimeout: 60000,
      fieldsToRemove: ['customSensitiveField'],
    },
  },
});

Velt.setDataProviders({
  activity: {
    get: async (request) => {
      const response = await fetch('/api/velt/activity/get', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(request),
      });
      return await response.json();
    },
    save: async (request) => {
      const response = await fetch('/api/velt/activity/save', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(request),
      });
      return await response.json();
    },
    config: {
      resolveTimeout: 60000,
      fieldsToRemove: ['customSensitiveField'],
    },
  },
});

​

Loading State

const activities = useAllActivities();

activities?.map((activity) => (
  activity.isActivityResolverUsed
    ? <ActivitySkeleton key={activity.id} />
    : <ActivityItem key={activity.id} activity={activity} />
));