@openedx/frontend-app-instructor-dashboard 1.0.0-alpha.4 → 1.0.0-alpha.41

package/dist/certificates/data/apiHook.js

@@ -0,0 +1,133 @@
+import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+import { getCertificateGenerationHistory, getInstructorTasks, getIssuedCertificates, grantBulkExceptions, invalidateCertificate, regenerateCertificates, removeException, removeInvalidation, toggleCertificateGeneration, uploadBulkExceptionsCsv, } from '../../certificates/data/api';
+import { certificatesQueryKeys } from '../../certificates/data/queryKeys';
+/**
+ * Hook to fetch issued certificates
+ */
+export const useIssuedCertificates = (courseId, params) => useQuery({
+    queryKey: certificatesQueryKeys.issued(courseId, params),
+    queryFn: () => getIssuedCertificates(courseId, params),
+    enabled: !!courseId,
+});
+/**
+ * Hook to fetch instructor tasks
+ */
+export const useInstructorTasks = (courseId, params) => useQuery({
+    queryKey: certificatesQueryKeys.tasks(courseId, params),
+    queryFn: () => getInstructorTasks(courseId, params),
+    enabled: !!courseId,
+});
+/**
+ * Hook to fetch certificate generation history
+ */
+export const useCertificateGenerationHistory = (courseId, params) => useQuery({
+    queryKey: certificatesQueryKeys.generationHistory(courseId, params),
+    queryFn: () => getCertificateGenerationHistory(courseId, params),
+    enabled: !!courseId,
+});
+/**
+ * Hook to grant bulk certificate exceptions
+ */
+export const useGrantBulkExceptions = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (request) => grantBulkExceptions(courseId, request),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to upload bulk certificate exceptions via CSV
+ */
+export const useUploadBulkExceptionsCsv = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (file) => uploadBulkExceptionsCsv(courseId, file),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to invalidate certificate
+ */
+export const useInvalidateCertificate = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (request) => invalidateCertificate(courseId, request),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to remove certificate exception
+ */
+export const useRemoveException = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (request) => removeException(courseId, request),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to remove certificate invalidation
+ */
+export const useRemoveInvalidation = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (request) => removeInvalidation(courseId, request),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to toggle certificate generation
+ */
+export const useToggleCertificateGeneration = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: (enable) => toggleCertificateGeneration(courseId, enable),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+/**
+ * Hook to regenerate certificates
+ */
+export const useRegenerateCertificates = (courseId) => {
+    const queryClient = useQueryClient();
+    return useMutation({
+        mutationFn: ({ filter, onlyWithoutCertificate }) => regenerateCertificates(courseId, filter, onlyWithoutCertificate),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: certificatesQueryKeys.byCourse(courseId),
+                exact: false,
+            });
+        },
+    });
+};
+//# sourceMappingURL=apiHook.js.map

package/dist/certificates/data/apiHook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiHook.js","sourceRoot":"","sources":["../../../src/certificates/data/apiHook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAS9E,OAAO,EACL,+BAA+B,EAC/B,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAE,MAA8B,EAAE,EAAE,CACxF,QAAQ,CAAC;IACP,QAAQ,EAAE,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;IACxD,OAAO,EAAE,GAAG,EAAE,CAAC,qBAAqB,CAAC,QAAQ,EAAE,MAAM,CAAC;IACtD,OAAO,EAAE,CAAC,CAAC,QAAQ;CACpB,CAAC,CAAC;AAEL;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,MAAwB,EAAE,EAAE,CAC/E,QAAQ,CAAC;IACP,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC;IACvD,OAAO,EAAE,GAAG,EAAE,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,QAAQ;CACpB,CAAC,CAAC;AAEL;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,QAAgB,EAAE,MAAwB,EAAE,EAAE,CAC5F,QAAQ,CAAC;IACP,QAAQ,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC;IACnE,OAAO,EAAE,GAAG,EAAE,CAAC,+BAA+B,CAAC,QAAQ,EAAE,MAAM,CAAC;IAChE,OAAO,EAAE,CAAC,CAAC,QAAQ;CACpB,CAAC,CAAC;AAEL;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACzD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACtF,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC7D,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,IAAU,EAAE,EAAE,CAAC,uBAAuB,CAAC,QAAQ,EAAE,IAAI,CAAC;QACnE,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC3D,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,OAAqC,EAAE,EAAE,CAAC,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC;QAC/F,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACrD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,OAAO,CAAC;QACnF,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACxD,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,OAAkC,EAAE,EAAE,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC;QACzF,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,QAAgB,EAAE,EAAE;IACjE,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,2BAA2B,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC9E,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC5D,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC;QACjB,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAwD,EAAE,EAAE,CACvG,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,sBAAsB,CAAC;QAClE,SAAS,EAAE,GAAG,EAAE;YACd,WAAW,CAAC,iBAAiB,CAAC;gBAC5B,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAClD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';\nimport type { PaginationParams } from '@src/types';\nimport type {\n  CertificateQueryParams,\n  GrantExceptionRequest,\n  InvalidateCertificateRequest,\n  RemoveExceptionRequest,\n  RemoveInvalidationRequest,\n} from '@src/certificates/types';\nimport {\n  getCertificateGenerationHistory,\n  getInstructorTasks,\n  getIssuedCertificates,\n  grantBulkExceptions,\n  invalidateCertificate,\n  regenerateCertificates,\n  removeException,\n  removeInvalidation,\n  toggleCertificateGeneration,\n  uploadBulkExceptionsCsv,\n} from '@src/certificates/data/api';\nimport { certificatesQueryKeys } from '@src/certificates/data/queryKeys';\n\n/**\n * Hook to fetch issued certificates\n */\nexport const useIssuedCertificates = (courseId: string, params: CertificateQueryParams) =>\n  useQuery({\n    queryKey: certificatesQueryKeys.issued(courseId, params),\n    queryFn: () => getIssuedCertificates(courseId, params),\n    enabled: !!courseId,\n  });\n\n/**\n * Hook to fetch instructor tasks\n */\nexport const useInstructorTasks = (courseId: string, params: PaginationParams) =>\n  useQuery({\n    queryKey: certificatesQueryKeys.tasks(courseId, params),\n    queryFn: () => getInstructorTasks(courseId, params),\n    enabled: !!courseId,\n  });\n\n/**\n * Hook to fetch certificate generation history\n */\nexport const useCertificateGenerationHistory = (courseId: string, params: PaginationParams) =>\n  useQuery({\n    queryKey: certificatesQueryKeys.generationHistory(courseId, params),\n    queryFn: () => getCertificateGenerationHistory(courseId, params),\n    enabled: !!courseId,\n  });\n\n/**\n * Hook to grant bulk certificate exceptions\n */\nexport const useGrantBulkExceptions = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (request: GrantExceptionRequest) => grantBulkExceptions(courseId, request),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to upload bulk certificate exceptions via CSV\n */\nexport const useUploadBulkExceptionsCsv = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (file: File) => uploadBulkExceptionsCsv(courseId, file),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to invalidate certificate\n */\nexport const useInvalidateCertificate = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (request: InvalidateCertificateRequest) => invalidateCertificate(courseId, request),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to remove certificate exception\n */\nexport const useRemoveException = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (request: RemoveExceptionRequest) => removeException(courseId, request),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to remove certificate invalidation\n */\nexport const useRemoveInvalidation = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (request: RemoveInvalidationRequest) => removeInvalidation(courseId, request),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to toggle certificate generation\n */\nexport const useToggleCertificateGeneration = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: (enable: boolean) => toggleCertificateGeneration(courseId, enable),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n\n/**\n * Hook to regenerate certificates\n */\nexport const useRegenerateCertificates = (courseId: string) => {\n  const queryClient = useQueryClient();\n  return useMutation({\n    mutationFn: ({ filter, onlyWithoutCertificate }: { filter: string, onlyWithoutCertificate?: boolean }) =>\n      regenerateCertificates(courseId, filter, onlyWithoutCertificate),\n    onSuccess: () => {\n      queryClient.invalidateQueries({\n        queryKey: certificatesQueryKeys.byCourse(courseId),\n        exact: false,\n      });\n    },\n  });\n};\n"]}

package/dist/certificates/data/queryKeys.d.ts

@@ -0,0 +1,9 @@
+import type { PaginationParams } from '../../types';
+import type { CertificateQueryParams } from '../../certificates/types';
+export declare const certificatesQueryKeys: {
+    all: readonly ["org.openedx.frontend.app.instructorDashboard", "certificates"];
+    byCourse: (courseId: string) => readonly ["org.openedx.frontend.app.instructorDashboard", "certificates", string];
+    issued: (courseId: string, params: CertificateQueryParams) => readonly ["org.openedx.frontend.app.instructorDashboard", "certificates", string, "issued", CertificateQueryParams];
+    tasks: (courseId: string, params: PaginationParams) => readonly ["org.openedx.frontend.app.instructorDashboard", "certificates", string, "tasks", PaginationParams];
+    generationHistory: (courseId: string, params: PaginationParams) => readonly ["org.openedx.frontend.app.instructorDashboard", "certificates", string, "generationHistory", PaginationParams];
+};

package/dist/certificates/data/queryKeys.js

@@ -0,0 +1,9 @@
+import { appId } from '../../constants';
+export const certificatesQueryKeys = {
+    all: [appId, 'certificates'],
+    byCourse: (courseId) => [...certificatesQueryKeys.all, courseId],
+    issued: (courseId, params) => [...certificatesQueryKeys.byCourse(courseId), 'issued', params],
+    tasks: (courseId, params) => [...certificatesQueryKeys.byCourse(courseId), 'tasks', params],
+    generationHistory: (courseId, params) => [...certificatesQueryKeys.byCourse(courseId), 'generationHistory', params],
+};
+//# sourceMappingURL=queryKeys.js.map

package/dist/certificates/data/queryKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryKeys.js","sourceRoot":"","sources":["../../../src/certificates/data/queryKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAIvC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,GAAG,EAAE,CAAC,KAAK,EAAE,cAAc,CAAU;IACrC,QAAQ,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,GAAG,EAAE,QAAQ,CAAU;IACjF,MAAM,EAAE,CAAC,QAAgB,EAAE,MAA8B,EAAE,EAAE,CAC3D,CAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAU;IAC1E,KAAK,EAAE,CAAC,QAAgB,EAAE,MAAwB,EAAE,EAAE,CACpD,CAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,MAAM,CAAU;IACzE,iBAAiB,EAAE,CAAC,QAAgB,EAAE,MAAwB,EAAE,EAAE,CAChE,CAAC,GAAG,qBAAqB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,mBAAmB,EAAE,MAAM,CAAU;CACtF,CAAC","sourcesContent":["import { appId } from '@src/constants';\nimport type { PaginationParams } from '@src/types';\nimport type { CertificateQueryParams } from '@src/certificates/types';\n\nexport const certificatesQueryKeys = {\n  all: [appId, 'certificates'] as const,\n  byCourse: (courseId: string) => [...certificatesQueryKeys.all, courseId] as const,\n  issued: (courseId: string, params: CertificateQueryParams) =>\n    [...certificatesQueryKeys.byCourse(courseId), 'issued', params] as const,\n  tasks: (courseId: string, params: PaginationParams) =>\n    [...certificatesQueryKeys.byCourse(courseId), 'tasks', params] as const,\n  generationHistory: (courseId: string, params: PaginationParams) =>\n    [...certificatesQueryKeys.byCourse(courseId), 'generationHistory', params] as const,\n};\n"]}