Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(subscriptions): add AI credits display (#1383)

Corentin Thomasset2b110a4ce175
diff --git a/apps/papra-client/src/locales/en.dictionary.ts b/apps/papra-client/src/locales/en.dictionary.ts
index 93a628e8..916013bc 100644
--- a/apps/papra-client/src/locales/en.dictionary.ts
+++ b/apps/papra-client/src/locales/en.dictionary.ts
@@ -285,6 +285,8 @@ export const translations = {
'organization.usage.intake-emails.description': 'Number of intake email addresses',
'organization.usage.members.title': 'Members',
'organization.usage.members.description': 'Number of members in the organization',
+ 'organization.usage.ai-credits.title': 'AI credits',
+ 'organization.usage.ai-credits.description': 'AI credits consumed this month',
'organization.usage.unlimited': 'Unlimited',
'organizations.members.title': 'Members',
diff --git a/apps/papra-client/src/modules/demo/demo-api-mock.ts b/apps/papra-client/src/modules/demo/demo-api-mock.ts
index 67f8ae30..dd53b8df 100644
--- a/apps/papra-client/src/modules/demo/demo-api-mock.ts
+++ b/apps/papra-client/src/modules/demo/demo-api-mock.ts
@@ -1161,6 +1161,7 @@ const inMemoryApiMock: Record<string, { handler: any }> = {
maxIntakeEmailsCount: 1,
maxOrganizationsMembersCount: 3,
maxFileSize: 1024 * 1024 * 50, // 50 MiB
+ aiCreditsPerMonth: 1000,
},
},
};
@@ -1200,12 +1201,17 @@ const inMemoryApiMock: Record<string, { handler: any }> = {
used: 1,
limit: 3,
},
+ aiCredits: {
+ used: 0,
+ limit: 1000,
+ },
},
limits: {
maxDocumentStorageBytes: 1024 * 1024 * 500, // 500 MiB
maxIntakeEmailsCount: 1,
maxOrganizationsMembersCount: 3,
maxFileSize: 1024 * 1024 * 50, // 50 MiB
+ aiCreditsPerMonth: 1000,
},
};
},
diff --git a/apps/papra-client/src/modules/organizations/pages/organization-usage.page.tsx b/apps/papra-client/src/modules/organizations/pages/organization-usage.page.tsx
index 05732211..40ca7583 100644
--- a/apps/papra-client/src/modules/organizations/pages/organization-usage.page.tsx
+++ b/apps/papra-client/src/modules/organizations/pages/organization-usage.page.tsx
@@ -3,6 +3,7 @@ import { formatBytes } from '@corentinth/chisels';
import { useParams } from '@solidjs/router';
import { useQuery } from '@tanstack/solid-query';
import { Show, Suspense } from 'solid-js';
+import { useConfig } from '@/modules/config/config.provider';
import { useI18n } from '@/modules/i18n/i18n.provider';
import { fetchOrganizationUsage } from '@/modules/subscriptions/subscriptions.services';
import { Card, CardContent } from '@/modules/ui/components/card';
@@ -43,6 +44,7 @@ const UsageCardLine: Component<{
export const OrganizationUsagePage: Component = () => {
const params = useParams();
const { t } = useI18n();
+ const { config } = useConfig();
const query = useQuery(() => ({
queryKey: ['organizations', params.organizationId, 'usage'],
@@ -86,6 +88,18 @@ export const OrganizationUsagePage: Component = () => {
used={getData().usage.membersCount.used}
limit={getData().usage.membersCount.limit}
/>
+
+ <Show when={config.isSubscriptionsEnabled}>
+ <Separator />
+
+ <UsageCardLine
+ title={t('organization.usage.ai-credits.title')}
+ description={t('organization.usage.ai-credits.description')}
+ used={getData().usage.aiCredits.used}
+ limit={getData().usage.aiCredits.limit}
+ formatValue={(credits) => credits.toLocaleString()}
+ />
+ </Show>
</CardContent>
</Card>
</>
diff --git a/apps/papra-client/src/modules/plans/plans.types.ts b/apps/papra-client/src/modules/plans/plans.types.ts
index ccfeb395..9a087430 100644
--- a/apps/papra-client/src/modules/plans/plans.types.ts
+++ b/apps/papra-client/src/modules/plans/plans.types.ts
@@ -3,4 +3,5 @@ export type PlanLimits = {
maxIntakeEmailsCount: number | null;
maxOrganizationsMembersCount: number | null;
maxFileSize: number | null;
+ aiCreditsPerMonth: number | null;
};
diff --git a/apps/papra-client/src/modules/subscriptions/subscriptions.services.ts b/apps/papra-client/src/modules/subscriptions/subscriptions.services.ts
index 520adc82..de08e02e 100644
--- a/apps/papra-client/src/modules/subscriptions/subscriptions.services.ts
+++ b/apps/papra-client/src/modules/subscriptions/subscriptions.services.ts
@@ -58,6 +58,7 @@ export async function fetchOrganizationUsage({ organizationId }: { organizationI
documentsStorage: { used: number; deleted: number; limit: number | null };
intakeEmailsCount: { used: number; limit: number | null };
membersCount: { used: number; limit: number | null };
+ aiCredits: { used: number; limit: number | null };
};
limits: PlanLimits;
}>({
diff --git a/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts b/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
index 71c222c1..f5e1b7ad 100644
--- a/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
+++ b/apps/papra-server/src/modules/subscriptions/subscriptions.routes.ts
@@ -2,6 +2,7 @@ import type { RouteDefinitionContext } from '../app/server.types';
import * as v from 'valibot';
import { requireAuthentication } from '../app/auth/auth.middleware';
import { getUser } from '../app/auth/auth.models';
+import { createAiCreditsRepository } from '../ai-credits/ai-credits.repository';
import { createDocumentsRepository } from '../documents/documents.repository';
import { createIntakeEmailsRepository } from '../intake-emails/intake-emails.repository';
import { organizationIdSchema } from '../organizations/organization.schemas';
@@ -302,6 +303,7 @@ function setupGetOrganizationSubscriptionUsageRoute({
const plansRepository = createPlansRepository({ config });
const intakeEmailsRepository = createIntakeEmailsRepository({ db });
const planEntitlementsRepository = createPlanEntitlementsRepository({ db });
+ const aiCreditsRepository = createAiCreditsRepository({ db });
await ensureUserIsInOrganization({
userId,
@@ -314,6 +316,7 @@ function setupGetOrganizationSubscriptionUsageRoute({
{ totalDocumentsSize, deletedDocumentsSize },
{ intakeEmailCount },
{ membersCount },
+ { creditsConsumed },
] = await Promise.all([
getOrganizationPlan({
organizationId,
@@ -325,6 +328,7 @@ function setupGetOrganizationSubscriptionUsageRoute({
documentsRepository.getOrganizationStats({ organizationId }),
intakeEmailsRepository.getOrganizationIntakeEmailsCount({ organizationId }),
organizationsRepository.getOrganizationMembersCount({ organizationId }),
+ aiCreditsRepository.getCurrentPeriodOrganizationAiCreditsCount({ organizationId }),
]);
const nullifiedLimits = {
@@ -336,6 +340,7 @@ function setupGetOrganizationSubscriptionUsageRoute({
organizationPlan.limits.maxOrganizationsMembersCount,
),
maxFileSize: nullifyPositiveInfinity(organizationPlan.limits.maxFileSize),
+ aiCreditsPerMonth: nullifyPositiveInfinity(organizationPlan.limits.aiCreditsPerMonth),
};
return context.json({
@@ -353,6 +358,10 @@ function setupGetOrganizationSubscriptionUsageRoute({
used: membersCount,
limit: nullifiedLimits.maxOrganizationsMembersCount,
},
+ aiCredits: {
+ used: creditsConsumed,
+ limit: nullifiedLimits.aiCreditsPerMonth,
+ },
},
limits: nullifiedLimits,
});