feat: rejected and expired recipient filters (#2889)

packages/trpc/server/document-router/find-documents-internal.ts

@@ -23,6 +23,7 @@ export const findDocumentsInternalRoute = authenticatedProcedure
       orderByColumn,
       source,
       status,
+      hasExpiredRecipients,
       period,
       senderIds,
       folderId,
@@ -49,6 +50,7 @@ export const findDocumentsInternalRoute = authenticatedProcedure
         period,
         senderIds,
         folderId,
+        hasExpiredRecipients,
         orderBy: orderByColumn ? { column: orderByColumn, direction: orderByDirection } : undefined,
       }),
     ]);

packages/trpc/server/document-router/find-documents-internal.types.ts

@@ -20,6 +20,7 @@ export const ZFindDocumentsInternalResponseSchema = ZFindResultResponse.extend({
     [ExtendedDocumentStatus.COMPLETED]: z.number(),
     [ExtendedDocumentStatus.REJECTED]: z.number(),
     [ExtendedDocumentStatus.CANCELLED]: z.number(),
+    [ExtendedDocumentStatus.EXPIRED]: z.number(),
     [ExtendedDocumentStatus.INBOX]: z.number(),
     [ExtendedDocumentStatus.ALL]: z.number(),
   }),

packages/trpc/server/document-router/find-documents.ts

@@ -11,7 +11,18 @@ export const findDocumentsRoute = authenticatedProcedure
   .query(async ({ input, ctx }) => {
     const { user, teamId } = ctx;
 
-    const { query, templateId, page, perPage, orderByDirection, orderByColumn, source, status, folderId } = input;
+    const {
+      query,
+      templateId,
+      page,
+      perPage,
+      orderByDirection,
+      orderByColumn,
+      source,
+      status,
+      hasExpiredRecipients,
+      folderId,
+    } = input;
 
     const documents = await findDocuments({
       userId: user.id,
@@ -20,6 +31,7 @@ export const findDocumentsRoute = authenticatedProcedure
       query,
       source,
       status,
+      hasExpiredRecipients,
       page,
       perPage,
       folderId,

packages/trpc/server/document-router/find-documents.types.ts

@@ -21,6 +21,11 @@ export const ZFindDocumentsRequestSchema = ZFindSearchParamsSchema.extend({
   templateId: z.number().describe('Filter documents by the template ID used to create it.').optional(),
   source: z.nativeEnum(DocumentSource).describe('Filter documents by how it was created.').optional(),
   status: z.nativeEnum(DocumentStatus).describe('Filter documents by the current status').optional(),
+  hasExpiredRecipients: z
+    .enum(['true', 'false'])
+    .describe('Filter for documents that have at least one recipient whose signing link has expired.')
+    .transform((value) => value === 'true')
+    .optional(),
   folderId: z.string().describe('Filter documents by folder ID').optional(),
   orderByColumn: z.enum(['createdAt']).optional(),
   orderByDirection: z.enum(['asc', 'desc']).describe('').default('desc'),

packages/trpc/server/document-router/redistribute-document.types.ts

@@ -9,7 +9,7 @@ export const redistributeDocumentMeta: TrpcRouteMeta = {
     path: '/document/redistribute',
     summary: 'Redistribute document',
     description:
-      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document',
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.',
     tags: ['Document'],
     deprecated: true,
   },

packages/trpc/server/envelope-router/find-envelopes.ts

@@ -10,7 +10,19 @@ export const findEnvelopesRoute = authenticatedProcedure
   .query(async ({ input, ctx }) => {
     const { user, teamId } = ctx;
 
-    const { query, type, templateId, page, perPage, orderByDirection, orderByColumn, source, status, folderId } = input;
+    const {
+      query,
+      type,
+      templateId,
+      page,
+      perPage,
+      orderByDirection,
+      orderByColumn,
+      source,
+      status,
+      hasExpiredRecipients,
+      folderId,
+    } = input;
 
     ctx.logger.info({
       input: {
@@ -19,6 +31,7 @@ export const findEnvelopesRoute = authenticatedProcedure
         templateId,
         source,
         status,
+        hasExpiredRecipients,
         folderId,
         page,
         perPage,
@@ -33,6 +46,7 @@ export const findEnvelopesRoute = authenticatedProcedure
       query,
       source,
       status,
+      hasExpiredRecipients,
       page,
       perPage,
       folderId,

packages/trpc/server/envelope-router/find-envelopes.types.ts

@@ -20,6 +20,11 @@ export const ZFindEnvelopesRequestSchema = ZFindSearchParamsSchema.extend({
   templateId: z.number().describe('Filter envelopes by the template ID used to create it.').optional(),
   source: z.nativeEnum(DocumentSource).describe('Filter envelopes by how it was created.').optional(),
   status: z.nativeEnum(DocumentStatus).describe('Filter envelopes by the current status.').optional(),
+  hasExpiredRecipients: z
+    .enum(['true', 'false'])
+    .describe('Filter for envelopes that have at least one recipient whose signing link has expired.')
+    .transform((value) => value === 'true')
+    .optional(),
   folderId: z.string().describe('Filter envelopes by folder ID.').optional(),
   orderByColumn: z.enum(['createdAt']).optional(),
   orderByDirection: z.enum(['asc', 'desc']).describe('Sort direction.').default('desc'),

packages/trpc/server/envelope-router/redistribute-envelope.types.ts

@@ -10,7 +10,7 @@ export const redistributeEnvelopeMeta: TrpcRouteMeta = {
     path: '/envelope/redistribute',
     summary: 'Redistribute envelope',
     description:
-      'Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope',
+      'Redistribute the envelope to the provided recipients who have not actioned the envelope. Will use the distribution method set in the envelope. This also refreshes the signing-link expiration for the targeted unsigned recipients, renewing any expired links.',
     tags: ['Envelope'],
   },
 };