@shivaedev/admin 0.24.3 → 0.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +88 -76
  3. package/dist/Jobs.d.ts +71 -0
  4. package/dist/Jobs.d.ts.map +1 -0
  5. package/dist/Jobs.js +13 -0
  6. package/dist/Jobs.js.map +1 -0
  7. package/dist/JobsWithRetry.d.ts +92 -0
  8. package/dist/JobsWithRetry.d.ts.map +1 -0
  9. package/dist/JobsWithRetry.js +40 -0
  10. package/dist/JobsWithRetry.js.map +1 -0
  11. package/dist/Users.d.ts +35 -0
  12. package/dist/Users.d.ts.map +1 -0
  13. package/dist/Users.js +35 -0
  14. package/dist/Users.js.map +1 -0
  15. package/dist/client/adapters/SessionConfirmation.d.ts +1 -1
  16. package/dist/client/adapters/SessionConfirmation.d.ts.map +1 -1
  17. package/dist/client/adapters/SessionListView.d.ts +1 -1
  18. package/dist/client/adapters/SessionListView.d.ts.map +1 -1
  19. package/dist/client/adapters/SessionPagination.d.ts +2 -2
  20. package/dist/client/adapters/SessionPagination.d.ts.map +1 -1
  21. package/dist/client/adapters/SessionsView.d.ts +2 -2
  22. package/dist/client/adapters/SessionsView.d.ts.map +1 -1
  23. package/dist/client/adapters/UsersTable.d.ts +2 -2
  24. package/dist/client/adapters/UsersTable.d.ts.map +1 -1
  25. package/dist/client/adapters/UsersTable.js.map +1 -1
  26. package/dist/client/adapters/UsersView.d.ts +2 -2
  27. package/dist/client/adapters/UsersView.d.ts.map +1 -1
  28. package/dist/client/adapters/jobsTypes.d.ts +8 -8
  29. package/dist/client/adapters/jobsTypes.d.ts.map +1 -1
  30. package/dist/generated/Jobs.d.ts +144 -0
  31. package/dist/generated/Jobs.d.ts.map +1 -0
  32. package/dist/generated/Jobs.js +35 -0
  33. package/dist/generated/Jobs.js.map +1 -0
  34. package/dist/generated/JobsWithRetry.d.ts +182 -0
  35. package/dist/generated/JobsWithRetry.d.ts.map +1 -0
  36. package/dist/generated/JobsWithRetry.js +50 -0
  37. package/dist/generated/JobsWithRetry.js.map +1 -0
  38. package/dist/generated/Users.d.ts +65 -0
  39. package/dist/generated/Users.d.ts.map +1 -0
  40. package/dist/generated/Users.js +27 -0
  41. package/dist/generated/Users.js.map +1 -0
  42. package/dist/jobs/DeadLetter.d.ts +27 -0
  43. package/dist/jobs/DeadLetter.d.ts.map +1 -0
  44. package/dist/jobs/DeadLetter.js +11 -0
  45. package/dist/jobs/DeadLetter.js.map +1 -0
  46. package/dist/jobs/NotFailed.d.ts +9 -0
  47. package/dist/jobs/NotFailed.d.ts.map +1 -0
  48. package/dist/jobs/NotFailed.js +7 -0
  49. package/dist/jobs/NotFailed.js.map +1 -0
  50. package/dist/jobs/Page.d.ts +272 -0
  51. package/dist/jobs/Page.d.ts.map +1 -0
  52. package/dist/jobs/Page.js +10 -0
  53. package/dist/jobs/Page.js.map +1 -0
  54. package/dist/jobs/PageWithRetry.d.ts +296 -0
  55. package/dist/jobs/PageWithRetry.d.ts.map +1 -0
  56. package/dist/jobs/PageWithRetry.js +10 -0
  57. package/dist/jobs/PageWithRetry.js.map +1 -0
  58. package/dist/jobs/Row.d.ts +21 -0
  59. package/dist/jobs/Row.d.ts.map +1 -0
  60. package/dist/jobs/Row.js +5 -0
  61. package/dist/jobs/Row.js.map +1 -0
  62. package/dist/jobs/schemas.d.ts +2 -55
  63. package/dist/jobs/schemas.d.ts.map +1 -1
  64. package/dist/jobs/schemas.js +2 -19
  65. package/dist/jobs/schemas.js.map +1 -1
  66. package/dist/page.d.ts +4 -3
  67. package/dist/page.d.ts.map +1 -1
  68. package/dist/page.js.map +1 -1
  69. package/dist/server/RegisteredQueues.d.ts +21 -0
  70. package/dist/server/RegisteredQueues.d.ts.map +1 -0
  71. package/dist/server/RegisteredQueues.js +4 -0
  72. package/dist/server/RegisteredQueues.js.map +1 -0
  73. package/dist/server/adapters/pgBossQueues.d.ts +6 -0
  74. package/dist/server/adapters/pgBossQueues.d.ts.map +1 -0
  75. package/dist/server/adapters/pgBossQueues.js +57 -0
  76. package/dist/server/adapters/pgBossQueues.js.map +1 -0
  77. package/dist/server/jobsReads.d.ts +40 -0
  78. package/dist/server/jobsReads.d.ts.map +1 -0
  79. package/dist/server/jobsReads.js +65 -0
  80. package/dist/server/jobsReads.js.map +1 -0
  81. package/dist/sessions/Page.d.ts +29 -25
  82. package/dist/sessions/Page.d.ts.map +1 -1
  83. package/dist/sessions/Page.js +1 -1
  84. package/dist/sessions/Page.js.map +1 -1
  85. package/dist/users/List.d.ts +5 -0
  86. package/dist/users/List.d.ts.map +1 -0
  87. package/dist/users/List.js +2 -0
  88. package/dist/users/List.js.map +1 -0
  89. package/dist/users/Page.d.ts +104 -0
  90. package/dist/users/Page.d.ts.map +1 -0
  91. package/dist/users/Page.js +10 -0
  92. package/dist/users/Page.js.map +1 -0
  93. package/package.json +13 -11
  94. package/src/Jobs.ts +13 -0
  95. package/src/JobsWithRetry.ts +42 -0
  96. package/src/Users.ts +38 -0
  97. package/src/client/adapters/SessionConfirmation.tsx +1 -1
  98. package/src/client/adapters/SessionListView.tsx +1 -1
  99. package/src/client/adapters/SessionPagination.tsx +2 -2
  100. package/src/client/adapters/SessionsView.ts +2 -2
  101. package/src/client/adapters/UsersTable.tsx +3 -3
  102. package/src/client/adapters/UsersView.ts +2 -2
  103. package/src/client/adapters/jobsTypes.ts +8 -8
  104. package/src/generated/Jobs.ts +40 -0
  105. package/src/generated/JobsWithRetry.ts +55 -0
  106. package/src/generated/README.md +1 -0
  107. package/src/generated/Users.ts +32 -0
  108. package/src/jobs/DeadLetter.ts +10 -0
  109. package/src/jobs/NotFailed.ts +6 -0
  110. package/src/jobs/Page.ts +10 -0
  111. package/src/jobs/PageWithRetry.ts +10 -0
  112. package/src/jobs/Row.ts +4 -0
  113. package/src/jobs/schemas.ts +2 -23
  114. package/src/page.ts +8 -9
  115. package/src/server/RegisteredQueues.ts +22 -0
  116. package/src/server/adapters/pgBossQueues.ts +94 -0
  117. package/src/server/jobsReads.ts +72 -0
  118. package/src/sessions/Page.ts +1 -1
  119. package/src/users/List.ts +3 -0
  120. package/src/users/Page.ts +10 -0
  121. package/dist/jobs/page.d.ts +0 -425
  122. package/dist/jobs/page.d.ts.map +0 -1
  123. package/dist/jobs/page.js +0 -58
  124. package/dist/jobs/page.js.map +0 -1
  125. package/dist/jobs/retryPage.d.ts +0 -480
  126. package/dist/jobs/retryPage.d.ts.map +0 -1
  127. package/dist/jobs/retryPage.js +0 -50
  128. package/dist/jobs/retryPage.js.map +0 -1
  129. package/dist/server/jobsHandlers.d.ts +0 -62
  130. package/dist/server/jobsHandlers.d.ts.map +0 -1
  131. package/dist/server/jobsHandlers.js +0 -73
  132. package/dist/server/jobsHandlers.js.map +0 -1
  133. package/dist/server/jobsHandlersWithRetry.d.ts +0 -7
  134. package/dist/server/jobsHandlersWithRetry.d.ts.map +0 -1
  135. package/dist/server/jobsHandlersWithRetry.js +0 -43
  136. package/dist/server/jobsHandlersWithRetry.js.map +0 -1
  137. package/dist/server/usersHandlers.d.ts +0 -3
  138. package/dist/server/usersHandlers.d.ts.map +0 -1
  139. package/dist/server/usersHandlers.js +0 -15
  140. package/dist/server/usersHandlers.js.map +0 -1
  141. package/dist/users/page.d.ts +0 -115
  142. package/dist/users/page.d.ts.map +0 -1
  143. package/dist/users/page.js +0 -35
  144. package/dist/users/page.js.map +0 -1
  145. package/src/jobs/page.ts +0 -58
  146. package/src/jobs/retryPage.ts +0 -54
  147. package/src/server/jobsHandlers.ts +0 -95
  148. package/src/server/jobsHandlersWithRetry.ts +0 -59
  149. package/src/server/usersHandlers.ts +0 -17
  150. package/src/users/page.ts +0 -36
@@ -0,0 +1,42 @@
1
+ import { Schema } from "effect";
2
+ import { requirePermission } from "@shivaedev/access/requirePermission.ts";
3
+ import { defineModule } from "@shivaedev/contract/defineModule.ts";
4
+ import { command } from "@shivaedev/contract/operation.ts";
5
+ import { SessionUser } from "@shivaedev/identity/identity.ts";
6
+ import { adminJobsWire } from "#generated/JobsWithRetry.ts";
7
+ import { jobsKeys } from "#jobs/keys.ts";
8
+ import { JobsPermission, RetryJobs } from "#permissions.ts";
9
+ import { Counts, DeadLettered, Detail, Failed, Health } from "#server/jobsReads.ts";
10
+ import { RegisteredQueues } from "#server/RegisteredQueues.ts";
11
+
12
+ const Retry = command("retry", {
13
+ invalidates: ({ queue, id }) => [
14
+ jobsKeys.health.list,
15
+ jobsKeys.counts.item(queue),
16
+ jobsKeys.failed.item(queue),
17
+ jobsKeys.deadLettered.item(queue),
18
+ jobsKeys.job(queue).item(id),
19
+ ],
20
+ payload: { id: Schema.String, queue: Schema.String },
21
+ *run({ id, queue }) {
22
+ yield* requirePermission(yield* SessionUser, RetryJobs);
23
+ yield* (yield* RegisteredQueues).retry(queue, id);
24
+ },
25
+ });
26
+
27
+ const RunScheduleNow = command("runScheduleNow", {
28
+ invalidates: ({ queue }) => [jobsKeys.health.list, jobsKeys.counts.item(queue), jobsKeys.failed.item(queue), jobsKeys.deadLettered.item(queue)],
29
+ payload: { queue: Schema.String },
30
+ *run({ queue }) {
31
+ yield* requirePermission(yield* SessionUser, RetryJobs);
32
+ return yield* (yield* RegisteredQueues).runScheduleNow(queue);
33
+ },
34
+ });
35
+
36
+ export const JobsWithRetry = defineModule({
37
+ middleware: JobsPermission,
38
+ name: "admin.jobs",
39
+ operations: [Health, Counts, Failed, DeadLettered, Detail, Retry, RunScheduleNow],
40
+ requires: [RegisteredQueues],
41
+ wire: adminJobsWire,
42
+ });
package/src/Users.ts ADDED
@@ -0,0 +1,38 @@
1
+ import { Schema } from "effect";
2
+ import { defineModule } from "@shivaedev/contract/defineModule.ts";
3
+ import { command, query } from "@shivaedev/contract/operation.ts";
4
+ import { SessionUser } from "@shivaedev/identity/identity.ts";
5
+ import { hasPermission } from "@shivaedev/identity/permission.ts";
6
+ import { AssignRoles } from "@shivaedev/identity/roles.ts";
7
+ import { UserDirectory } from "@shivaedev/identity/server/UserDirectory.ts";
8
+ import { UserListInput, userKeys } from "@shivaedev/identity/users.ts";
9
+ import { adminUsersWire } from "#generated/Users.ts";
10
+ import { UsersPermission } from "#permissions.ts";
11
+ import { changeUserRole, listUsers } from "#server/users.ts";
12
+ import type { UsersList } from "#users/List.ts";
13
+
14
+ const ListUsers = query("list", {
15
+ payload: UserListInput.fields,
16
+ reads: () => [userKeys.list],
17
+ *run(input) {
18
+ const user = yield* SessionUser;
19
+ const list: UsersList = { ...(yield* listUsers(input)), canChangeRoles: hasPermission(user, AssignRoles) };
20
+ return list;
21
+ },
22
+ });
23
+
24
+ const ChangeRole = command("changeRole", {
25
+ invalidates: () => [userKeys.list],
26
+ payload: { role: Schema.String, userId: Schema.String },
27
+ *run(input) {
28
+ yield* changeUserRole(input);
29
+ },
30
+ });
31
+
32
+ export const Users = defineModule({
33
+ middleware: UsersPermission,
34
+ name: "admin.users",
35
+ operations: [ListUsers, ChangeRole],
36
+ requires: [UserDirectory],
37
+ wire: adminUsersWire,
38
+ });
@@ -1,5 +1,5 @@
1
1
  import { useEffect, useRef } from "react";
2
- import type { SignedInSession } from "@shivaedev/identity/sessions.ts";
2
+ import type { SignedInSession } from "@shivaedev/identity/signedInSessions.ts";
3
3
 
4
4
  export function SessionConfirmation({
5
5
  selected,
@@ -1,5 +1,5 @@
1
1
  import { DateTime } from "effect";
2
- import type { SignedInSession } from "@shivaedev/identity/sessions.ts";
2
+ import type { SignedInSession } from "@shivaedev/identity/signedInSessions.ts";
3
3
 
4
4
  interface SessionControls {
5
5
  readonly currentSessionId: string | undefined;
@@ -1,5 +1,5 @@
1
1
  import { Option } from "effect";
2
- import type { SessionList, SessionListInput } from "@shivaedev/identity/sessions.ts";
2
+ import type { SessionList, SessionListInput } from "@shivaedev/identity/signedInSessions.ts";
3
3
 
4
4
  type Cursor = NonNullable<typeof SessionListInput.Type.cursor>;
5
5
 
@@ -9,7 +9,7 @@ export function SessionPagination({
9
9
  pending,
10
10
  go,
11
11
  }: {
12
- readonly data: typeof SessionList.Type | undefined;
12
+ readonly data: SessionList | undefined;
13
13
  readonly cursors: readonly Cursor[];
14
14
  readonly pending: boolean;
15
15
  readonly go: (cursors: readonly Cursor[]) => void;
@@ -2,7 +2,7 @@ import { Cause, type Effect, Option, Predicate } from "effect";
2
2
  import type * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import type * as Atom from "effect/reactivity/Atom";
4
4
  import { createElement, useState } from "react";
5
- import type { SessionList, SessionListInput, SignedInSession } from "@shivaedev/identity/sessions.ts";
5
+ import type { SessionList, SessionListInput, SignedInSession } from "@shivaedev/identity/signedInSessions.ts";
6
6
  import type { AtomServices } from "@shivaedev/react/AtomServices.ts";
7
7
  import { useAction, useQuery } from "@shivaedev/react/client/resultState.ts";
8
8
  import { SessionConfirmation } from "#client/adapters/SessionConfirmation.tsx";
@@ -11,7 +11,7 @@ import { SessionPagination } from "#client/adapters/SessionPagination.tsx";
11
11
 
12
12
  export interface SessionsViewProps<R, E> {
13
13
  readonly currentSessionId: string | undefined;
14
- readonly list: (input: typeof SessionListInput.Type) => Atom.Atom<AsyncResult.AsyncResult<typeof SessionList.Type, unknown>>;
14
+ readonly list: (input: typeof SessionListInput.Type) => Atom.Atom<AsyncResult.AsyncResult<SessionList, unknown>>;
15
15
  readonly onCurrentSessionRevoked: () => void;
16
16
  readonly revoke: (input: { readonly id: string }) => Effect.Effect<void, unknown, AtomServices<R>>;
17
17
  readonly runtime: Atom.AtomRuntime<R, E>;
@@ -2,7 +2,7 @@ import { DateTime } from "effect";
2
2
  import type { ReactNode } from "react";
3
3
  import type { DirectoryUser } from "@shivaedev/identity/users.ts";
4
4
  import type { ChangeRoleInput } from "#users/ChangeRoleInput.ts";
5
- import type { UsersList } from "#users/page.ts";
5
+ import type { UsersList } from "#users/List.ts";
6
6
 
7
7
  interface RoleControls<TRole extends string> {
8
8
  readonly dispatch: (input: ChangeRoleInput<TRole>) => void;
@@ -74,7 +74,7 @@ function UserCell({ label, children }: { readonly label: string; readonly childr
74
74
  );
75
75
  }
76
76
 
77
- function UserRows<TRole extends string>({ data, ...controls }: RoleControls<TRole> & { readonly data: typeof UsersList.Type }) {
77
+ function UserRows<TRole extends string>({ data, ...controls }: RoleControls<TRole> & { readonly data: UsersList }) {
78
78
  return (
79
79
  <div className="sm:overflow-x-auto sm:rounded-md sm:border">
80
80
  <table className="block w-full text-left text-sm sm:table">
@@ -91,7 +91,7 @@ function UserRows<TRole extends string>({ data, ...controls }: RoleControls<TRol
91
91
  </div>
92
92
  );
93
93
  }
94
- export function UsersTable<TRole extends string>({ data, ...controls }: RoleControls<TRole> & { readonly data: typeof UsersList.Type }) {
94
+ export function UsersTable<TRole extends string>({ data, ...controls }: RoleControls<TRole> & { readonly data: UsersList }) {
95
95
  const permission = !data.canChangeRoles && <p>Permission to assign roles is required to change roles.</p>;
96
96
  const users = data.users.length === 0 ? <p>No users.</p> : <UserRows {...controls} data={data} />;
97
97
  return (
@@ -6,11 +6,11 @@ import type { UserListInput } from "@shivaedev/identity/users.ts";
6
6
  import { useAction, useQuery } from "@shivaedev/react/client/resultState.ts";
7
7
  import { UsersTable } from "#client/adapters/UsersTable.tsx";
8
8
  import type { ChangeRoleInput } from "#users/ChangeRoleInput.ts";
9
- import type { UsersList } from "#users/page.ts";
9
+ import type { UsersList } from "#users/List.ts";
10
10
 
11
11
  export interface UsersViewProps<TRole extends string> {
12
12
  readonly changeRole: Atom.AtomResultFn<ChangeRoleInput<TRole>, void, unknown>;
13
- readonly list: (input: typeof UserListInput.Type) => Atom.Atom<AsyncResult.AsyncResult<typeof UsersList.Type, unknown>>;
13
+ readonly list: (input: typeof UserListInput.Type) => Atom.Atom<AsyncResult.AsyncResult<UsersList, unknown>>;
14
14
  readonly roles: readonly TRole[];
15
15
  }
16
16
 
@@ -1,11 +1,11 @@
1
- import type { Option, Schema } from "effect";
1
+ import type { Option } from "effect";
2
2
  import type * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import type * as Atom from "effect/reactivity/Atom";
4
- import type { deadLetteredSchema, JobsHealth, jobSchema, QueueCounts } from "#jobs/schemas.ts";
4
+ import type { JobsDeadLetter } from "#jobs/DeadLetter.ts";
5
+ import type { JobsRow } from "#jobs/Row.ts";
6
+ import type { JobsHealth, QueueCounts } from "#jobs/schemas.ts";
5
7
 
6
- type Job = ReturnType<typeof jobSchema<typeof Schema.Unknown>>["Type"];
7
- type DeadLetter = ReturnType<typeof deadLetteredSchema<typeof Schema.Unknown>>["Type"];
8
- export type AdminJob = Job | DeadLetter;
8
+ export type AdminJob = JobsRow | JobsDeadLetter;
9
9
  interface JobId {
10
10
  readonly id: string;
11
11
  readonly queue: string;
@@ -24,10 +24,10 @@ interface Query<TInput, A> {
24
24
  }
25
25
  export interface JobsViewClient {
26
26
  readonly counts: Query<{ readonly queue: string }, typeof QueueCounts.Type>;
27
- readonly deadLettered: Query<PageInput, Page<DeadLetter>>;
28
- readonly failed: Query<PageInput, Page<Job>>;
27
+ readonly deadLettered: Query<PageInput, Page<JobsDeadLetter>>;
28
+ readonly failed: Query<PageInput, Page<JobsRow>>;
29
29
  readonly health: Query<void, typeof JobsHealth.Type>;
30
- readonly job: Query<JobId, Option.Option<Job>>;
30
+ readonly job: Query<JobId, Option.Option<JobsRow>>;
31
31
  }
32
32
  export type RetryJob = Atom.AtomResultFn<JobId, void, unknown>;
33
33
 
@@ -0,0 +1,40 @@
1
+ // Generated by @shivaedev/build from src/Jobs.ts. Do not edit or commit this file; run `pnpm generate` to write it again.
2
+ import type { Jobs as JobsModule } from "#Jobs.ts";
3
+ import { JobsDeadLetter } from "#jobs/DeadLetter.ts";
4
+ import { JobsRow } from "#jobs/Row.ts";
5
+ import { jobsKeys } from "#jobs/keys.ts";
6
+ import { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable, PageFields } from "#jobs/schemas.ts";
7
+ import { JobsPermission } from "#permissions.ts";
8
+ import { clientContract } from "@shivaedev/contract/clientContract.ts";
9
+ import type { ClientMatchesModule } from "@shivaedev/contract/clientMatchesModule.ts";
10
+ import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
11
+ import { Schema } from "effect";
12
+
13
+ export const adminJobsWire = {
14
+ counts: { rejections: { JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ activeCount: Schema.Number, failedCount: Schema.Number, queuedCount: Schema.Number, totalCount: Schema.Number }) },
15
+ deadLettered: { rejections: { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ jobs: Schema.Array(JobsDeadLetter), next: Schema.Option(Schema.String) }) },
16
+ failed: { rejections: { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ jobs: Schema.Array(JobsRow), next: Schema.Option(Schema.String) }) },
17
+ health: { rejections: { JobsUnavailable }, success: Schema.Struct({ activeTotal: Schema.Number, deadLetteredTotal: Schema.Number, failedTotal: Schema.Number, jobs: Schema.Array(Schema.Struct({ activeCount: Schema.Number, deadLetteredCount: Schema.Number, failedCount: Schema.Number, name: Schema.String, queuedCount: Schema.Number, readyCount: Schema.Number })), queuedTotal: Schema.Number, readyTotal: Schema.Number }) },
18
+ job: { rejections: { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Option(JobsRow) },
19
+ } as const;
20
+
21
+ export const Jobs = clientContract({
22
+ middleware: JobsPermission,
23
+ name: "admin.jobs",
24
+ payloads: {
25
+ counts: { queue: Schema.String },
26
+ deadLettered: { ...PageFields, queue: Schema.String },
27
+ failed: { ...PageFields, queue: Schema.String },
28
+ job: { id: Schema.String, queue: Schema.String },
29
+ },
30
+ queries: {
31
+ counts: { reads: ({ queue }) => [jobsKeys.counts.item(queue)] },
32
+ deadLettered: { reads: ({ queue }) => [jobsKeys.deadLettered.item(queue)] },
33
+ failed: { reads: ({ queue }) => [jobsKeys.failed.item(queue)] },
34
+ health: { reads: () => [jobsKeys.health.list] },
35
+ job: { reads: ({ queue, id }) => [jobsKeys.job(queue).item(id)] },
36
+ },
37
+ wire: adminJobsWire,
38
+ });
39
+
40
+ export const adminJobsMatchModule: ClientMatchesModule<typeof Jobs, typeof JobsModule> = true;
@@ -0,0 +1,55 @@
1
+ // Generated by @shivaedev/build from src/JobsWithRetry.ts. Do not edit or commit this file; run `pnpm generate` to write it again.
2
+ import type { JobsWithRetry as JobsWithRetryModule } from "#JobsWithRetry.ts";
3
+ import { JobsDeadLetter } from "#jobs/DeadLetter.ts";
4
+ import { JobsNotFailed } from "#jobs/NotFailed.ts";
5
+ import { JobsRow } from "#jobs/Row.ts";
6
+ import { jobsKeys } from "#jobs/keys.ts";
7
+ import { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable, PageFields } from "#jobs/schemas.ts";
8
+ import { JobsPermission } from "#permissions.ts";
9
+ import { clientContract } from "@shivaedev/contract/clientContract.ts";
10
+ import type { ClientMatchesModule } from "@shivaedev/contract/clientMatchesModule.ts";
11
+ import { BadRequest, Forbidden } from "@shivaedev/errors/taxonomy.ts";
12
+ import { Schema } from "effect";
13
+
14
+ export const adminJobsWire = {
15
+ counts: { rejections: { JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ activeCount: Schema.Number, failedCount: Schema.Number, queuedCount: Schema.Number, totalCount: Schema.Number }) },
16
+ deadLettered: { rejections: { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ jobs: Schema.Array(JobsDeadLetter), next: Schema.Option(Schema.String) }) },
17
+ failed: { rejections: { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Struct({ jobs: Schema.Array(JobsRow), next: Schema.Option(Schema.String) }) },
18
+ health: { rejections: { JobsUnavailable }, success: Schema.Struct({ activeTotal: Schema.Number, deadLetteredTotal: Schema.Number, failedTotal: Schema.Number, jobs: Schema.Array(Schema.Struct({ activeCount: Schema.Number, deadLetteredCount: Schema.Number, failedCount: Schema.Number, name: Schema.String, queuedCount: Schema.Number, readyCount: Schema.Number })), queuedTotal: Schema.Number, readyTotal: Schema.Number }) },
19
+ job: { rejections: { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Option(JobsRow) },
20
+ retry: { rejections: { Forbidden, JobsNotFailed, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Void },
21
+ runScheduleNow: { rejections: { Forbidden, JobsQueueUnregistered, JobsUnavailable }, success: Schema.Option(Schema.String) },
22
+ } as const;
23
+
24
+ export const JobsWithRetry = clientContract({
25
+ commands: {
26
+ retry: { invalidates: ({ queue, id }) => [
27
+ jobsKeys.health.list,
28
+ jobsKeys.counts.item(queue),
29
+ jobsKeys.failed.item(queue),
30
+ jobsKeys.deadLettered.item(queue),
31
+ jobsKeys.job(queue).item(id),
32
+ ] },
33
+ runScheduleNow: { invalidates: ({ queue }) => [jobsKeys.health.list, jobsKeys.counts.item(queue), jobsKeys.failed.item(queue), jobsKeys.deadLettered.item(queue)] },
34
+ },
35
+ middleware: JobsPermission,
36
+ name: "admin.jobs",
37
+ payloads: {
38
+ counts: { queue: Schema.String },
39
+ deadLettered: { ...PageFields, queue: Schema.String },
40
+ failed: { ...PageFields, queue: Schema.String },
41
+ job: { id: Schema.String, queue: Schema.String },
42
+ retry: { id: Schema.String, queue: Schema.String },
43
+ runScheduleNow: { queue: Schema.String },
44
+ },
45
+ queries: {
46
+ counts: { reads: ({ queue }) => [jobsKeys.counts.item(queue)] },
47
+ deadLettered: { reads: ({ queue }) => [jobsKeys.deadLettered.item(queue)] },
48
+ failed: { reads: ({ queue }) => [jobsKeys.failed.item(queue)] },
49
+ health: { reads: () => [jobsKeys.health.list] },
50
+ job: { reads: ({ queue, id }) => [jobsKeys.job(queue).item(id)] },
51
+ },
52
+ wire: adminJobsWire,
53
+ });
54
+
55
+ export const adminJobsMatchModule: ClientMatchesModule<typeof JobsWithRetry, typeof JobsWithRetryModule> = true;
@@ -0,0 +1 @@
1
+ This folder is written by `pnpm generate`.
@@ -0,0 +1,32 @@
1
+ // Generated by @shivaedev/build from src/Users.ts. Do not edit or commit this file; run `pnpm generate` to write it again.
2
+ import type { Users as UsersModule } from "#Users.ts";
3
+ import { UsersPermission } from "#permissions.ts";
4
+ import { clientContract } from "@shivaedev/contract/clientContract.ts";
5
+ import type { ClientMatchesModule } from "@shivaedev/contract/clientMatchesModule.ts";
6
+ import { AuthUnavailable, Forbidden, NotFound } from "@shivaedev/errors/taxonomy.ts";
7
+ import { LastRoleAssigner } from "@shivaedev/identity/roles.ts";
8
+ import { UserListInput, userKeys } from "@shivaedev/identity/users.ts";
9
+ import { Schema } from "effect";
10
+
11
+ export const adminUsersWire = {
12
+ changeRole: { rejections: { AuthUnavailable, Forbidden, LastRoleAssigner, NotFound }, success: Schema.Void },
13
+ list: { rejections: { AuthUnavailable, Forbidden }, success: Schema.Struct({ next: Schema.Option(Schema.String), users: Schema.Array(Schema.Struct({ createdAt: Schema.DateTimeUtc, email: Schema.String, id: Schema.String, name: Schema.String, role: Schema.String })), canChangeRoles: Schema.Boolean }) },
14
+ } as const;
15
+
16
+ export const Users = clientContract({
17
+ commands: {
18
+ changeRole: { invalidates: () => [userKeys.list] },
19
+ },
20
+ middleware: UsersPermission,
21
+ name: "admin.users",
22
+ payloads: {
23
+ changeRole: { role: Schema.String, userId: Schema.String },
24
+ list: UserListInput.fields,
25
+ },
26
+ queries: {
27
+ list: { reads: () => [userKeys.list] },
28
+ },
29
+ wire: adminUsersWire,
30
+ });
31
+
32
+ export const adminUsersMatchModule: ClientMatchesModule<typeof Users, typeof UsersModule> = true;
@@ -0,0 +1,10 @@
1
+ import { Schema } from "effect";
2
+ import { JobFailure } from "@shivaedev/jobs/JobFailure.ts";
3
+ import { JobFields } from "#jobs/schemas.ts";
4
+
5
+ export class JobsDeadLetter extends Schema.Class<JobsDeadLetter>("JobsDeadLetter")({
6
+ ...JobFields,
7
+ sourceId: Schema.OptionFromNullOr(Schema.String),
8
+ sourceOutput: Schema.NullOr(JobFailure).annotate({ sensitive: true }),
9
+ sourceQueue: Schema.String,
10
+ }) {}
@@ -0,0 +1,6 @@
1
+ import { Schema } from "effect";
2
+
3
+ export class JobsNotFailed extends Schema.TaggedError<JobsNotFailed>()("JobsNotFailed", {
4
+ id: Schema.String,
5
+ queue: Schema.String,
6
+ }) {}
@@ -0,0 +1,10 @@
1
+ import { Jobs } from "#generated/Jobs.ts";
2
+ import { adminPage } from "#page.ts";
3
+ import { JobsPermission } from "#permissions.ts";
4
+
5
+ export const JobsPage = adminPage({
6
+ contract: Jobs,
7
+ id: "jobs",
8
+ permission: JobsPermission,
9
+ route: { path: "/admin/jobs", title: "Jobs" },
10
+ });
@@ -0,0 +1,10 @@
1
+ import { JobsWithRetry } from "#generated/JobsWithRetry.ts";
2
+ import { adminPage } from "#page.ts";
3
+ import { JobsPermission } from "#permissions.ts";
4
+
5
+ export const JobsPageWithRetry = adminPage({
6
+ contract: JobsWithRetry,
7
+ id: "jobs",
8
+ permission: JobsPermission,
9
+ route: { path: "/admin/jobs", title: "Jobs" },
10
+ });
@@ -0,0 +1,4 @@
1
+ import { Schema } from "effect";
2
+ import { JobFields } from "#jobs/schemas.ts";
3
+
4
+ export class JobsRow extends Schema.Class<JobsRow>("JobsRow")(JobFields) {}
@@ -1,5 +1,4 @@
1
1
  import { Schema } from "effect";
2
- import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
2
  import { JobFailure } from "@shivaedev/jobs/JobFailure.ts";
4
3
 
5
4
  export interface JobsQueue {
@@ -19,8 +18,6 @@ export class JobsQueueUnregistered extends Schema.TaggedError<JobsQueueUnregiste
19
18
  queue: Schema.String,
20
19
  }) {}
21
20
 
22
- export const JobsFailures = { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable };
23
-
24
21
  export const QueueCounts = Schema.Struct({
25
22
  activeCount: Schema.Number,
26
23
  failedCount: Schema.Number,
@@ -50,8 +47,10 @@ export const JobFields = {
50
47
  attempt: Schema.Number,
51
48
  completedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
52
49
  createdOn: Schema.DateTimeUtcFromString,
50
+ data: Schema.Unknown.annotate({ sensitive: true }),
53
51
  id: Schema.String,
54
52
  output: Schema.NullOr(JobFailure).annotate({ sensitive: true }),
53
+ queue: Schema.String,
55
54
  retryCount: Schema.Number,
56
55
  retryLimit: Schema.Number,
57
56
  startedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
@@ -59,23 +58,3 @@ export const JobFields = {
59
58
  };
60
59
 
61
60
  export const PageFields = { cursor: Schema.optionalKey(Schema.String), limit: Schema.Number };
62
-
63
- export function jobSchema<TPayload extends Schema.Top>(queue: { readonly name: string; readonly schema: TPayload }) {
64
- return Schema.Struct({ ...JobFields, data: Schema.Unknown.annotate({ sensitive: true }), queue: Schema.Literal(queue.name) });
65
- }
66
-
67
- export function deadLetteredSchema<TPayload extends Schema.Top>(queue: { readonly name: string; readonly schema: TPayload }) {
68
- const name: string = `${queue.name}-dlq`;
69
- return Schema.Struct({
70
- ...JobFields,
71
- data: Schema.Unknown.annotate({ sensitive: true }),
72
- queue: Schema.Literal(name),
73
- sourceId: Schema.OptionFromNullOr(Schema.String),
74
- sourceOutput: Schema.NullOr(JobFailure).annotate({ sensitive: true }),
75
- sourceQueue: Schema.Literal(queue.name),
76
- });
77
- }
78
-
79
- export function jobPage<TJob extends Schema.Top>(job: TJob) {
80
- return Schema.Struct({ jobs: Schema.Array(job), next: Schema.OptionFromNullOr(Schema.String) });
81
- }
package/src/page.ts CHANGED
@@ -38,15 +38,14 @@ interface PageGroup extends RpcGroup.Any {
38
38
  readonly requests: ReadonlyMap<string, Rpc.Any>;
39
39
  }
40
40
 
41
- type PageQueries<TQueries extends readonly QueryShape[]> = {
42
- readonly [TIndex in keyof TQueries]: Omit<TQueries[TIndex], "readPolicy"> & {
43
- readonly readPolicy: QueryReadPolicy<
44
- TQueries[TIndex]["payload"]["Type"],
45
- TQueries[TIndex]["error"]["Type"],
46
- QueryServices<TQueries[TIndex]> | SessionUser
47
- >;
48
- };
49
- };
41
+ // Distributes over a generated contract's queries, which arrive as one array of their union rather than a tuple.
42
+ type PageQuery<TQuery> = TQuery extends QueryShape
43
+ ? Omit<TQuery, "readPolicy"> & {
44
+ readonly readPolicy: QueryReadPolicy<TQuery["payload"]["Type"], TQuery["error"]["Type"], QueryServices<TQuery> | SessionUser>;
45
+ }
46
+ : never;
47
+
48
+ type PageQueries<TQueries extends readonly QueryShape[]> = { readonly [TIndex in keyof TQueries]: PageQuery<TQueries[TIndex]> };
50
49
 
51
50
  type PageRpcs<TRpc> =
52
51
  TRpc extends Rpc.Rpc<infer TTag, infer TPayload, infer TSuccess, infer TError, infer TMiddleware, infer R>
@@ -0,0 +1,22 @@
1
+ import { Context, type Effect, type Option } from "effect";
2
+ import type { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
+ import type { DeadLetteredJob, JobPage, JobPageOptions, JobsHealth, ListedJob, QueueCounts } from "@shivaedev/jobs/server/health.ts";
4
+ import type { Job } from "@shivaedev/jobs/server/job.ts";
5
+ import type { JobsNotFailed } from "#jobs/NotFailed.ts";
6
+ import type { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable } from "#jobs/schemas.ts";
7
+
8
+ type Read = JobsUnavailable | JobsQueueUnregistered;
9
+ type Listing = Read | JobsPayloadInvalid | BadRequest;
10
+
11
+ export class RegisteredQueues extends Context.Service<
12
+ RegisteredQueues,
13
+ {
14
+ readonly counts: (queue: string) => Effect.Effect<QueueCounts, Read>;
15
+ readonly deadLetteredJobs: (queue: string, options: JobPageOptions) => Effect.Effect<JobPage<DeadLetteredJob<unknown>>, Listing>;
16
+ readonly failedJobs: (queue: string, options: JobPageOptions) => Effect.Effect<JobPage<ListedJob<unknown>>, Listing>;
17
+ readonly getJob: (queue: string, id: string) => Effect.Effect<Option.Option<Job<unknown>>, Read | JobsPayloadInvalid>;
18
+ readonly health: () => Effect.Effect<JobsHealth, JobsUnavailable>;
19
+ readonly retry: (queue: string, id: string) => Effect.Effect<void, Read | JobsPayloadInvalid | JobsNotFailed>;
20
+ readonly runScheduleNow: (schedule: string) => Effect.Effect<Option.Option<string>, Read>;
21
+ }
22
+ >()("@shivaedev/admin/RegisteredQueues") {}
@@ -0,0 +1,94 @@
1
+ import { type Context, Effect, Layer, Option, type Schema } from "effect";
2
+ import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
+ import type { PgBossError, PgBossPayloadError } from "@shivaedev/jobs/server/error.ts";
4
+ import type { PgBossService } from "@shivaedev/jobs/server/service.ts";
5
+ import { type JobsEntry, type JobsPayload, jobsQueue } from "#jobs/entry.ts";
6
+ import { JobsNotFailed } from "#jobs/NotFailed.ts";
7
+ import { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable } from "#jobs/schemas.ts";
8
+ import { RegisteredQueues } from "#server/RegisteredQueues.ts";
9
+
10
+ type Declared<E> = E extends Schema.SchemaError
11
+ ? BadRequest
12
+ : E extends PgBossPayloadError
13
+ ? JobsPayloadInvalid
14
+ : E extends PgBossError
15
+ ? JobsUnavailable
16
+ : never;
17
+
18
+ function jobsFailures<A, E extends PgBossError | PgBossPayloadError | Schema.SchemaError, R>(
19
+ effect: Effect.Effect<A, E, R>,
20
+ ): Effect.Effect<A, Declared<E>, R>;
21
+ function jobsFailures<A, R>(
22
+ effect: Effect.Effect<A, PgBossError | PgBossPayloadError | Schema.SchemaError, R>,
23
+ ): Effect.Effect<A, BadRequest | JobsPayloadInvalid | JobsUnavailable, R> {
24
+ return effect.pipe(
25
+ Effect.mapError((error) => {
26
+ switch (error._tag) {
27
+ case "SchemaError":
28
+ return new BadRequest({ message: "Invalid job page options" });
29
+ case "PgBossPayloadError":
30
+ return new JobsPayloadInvalid({ queue: error.queue });
31
+ case "PgBossError":
32
+ return new JobsUnavailable({ operation: error.operation });
33
+ }
34
+ }),
35
+ );
36
+ }
37
+
38
+ // The Layer keeps the queue schemas' decoding services, so the page's operations require only RegisteredQueues.
39
+ export function pgBossQueues<const TQueues extends readonly JobsEntry[], TService>(
40
+ service: Context.Service<TService, PgBossService>,
41
+ ...queues: TQueues
42
+ ) {
43
+ return Layer.effect(
44
+ RegisteredQueues,
45
+ Effect.gen(function* () {
46
+ const runtime = yield* service;
47
+ const inspection = yield* runtime.inspection();
48
+ const decoding = yield* Effect.context<JobsPayload<TQueues[number]>["DecodingServices"]>();
49
+ const entries: readonly TQueues[number][] = queues;
50
+ function registered(name: string) {
51
+ const entry = entries.find((candidate) => candidate.name === name);
52
+ return entry === undefined ? Effect.fail(new JobsQueueUnregistered({ queue: name })) : Effect.succeed(jobsQueue(entry));
53
+ }
54
+ function decoded<A, E>(effect: Effect.Effect<A, E, JobsPayload<TQueues[number]>["DecodingServices"]>) {
55
+ return Effect.provideContext(effect, decoding);
56
+ }
57
+ return RegisteredQueues.of({
58
+ counts: (queue) => Effect.flatMap(registered(queue), (definition) => jobsFailures(inspection.counts(definition))),
59
+ deadLetteredJobs: (queue, options) =>
60
+ Effect.flatMap(registered(queue), (definition) =>
61
+ decoded(jobsFailures(inspection.deadLetteredJobs<string, JobsPayload<TQueues[number]>>(definition, options))),
62
+ ),
63
+ failedJobs: (queue, options) =>
64
+ Effect.flatMap(registered(queue), (definition) =>
65
+ decoded(jobsFailures(inspection.failedJobs<string, JobsPayload<TQueues[number]>>(definition, options))),
66
+ ),
67
+ getJob: (queue, id) =>
68
+ Effect.flatMap(registered(queue), (definition) =>
69
+ decoded(jobsFailures(inspection.getJob<string, JobsPayload<TQueues[number]>>(definition, id))),
70
+ ),
71
+ health: () => jobsFailures(inspection.health(queues)),
72
+ retry: (queue, id) =>
73
+ Effect.gen(function* () {
74
+ const definition = yield* registered(queue);
75
+ const job = yield* decoded(jobsFailures(inspection.getJob<string, JobsPayload<TQueues[number]>>(definition, id)));
76
+ if (Option.isNone(job) || job.value.state !== "failed") {
77
+ return yield* new JobsNotFailed({ id, queue });
78
+ }
79
+ yield* jobsFailures(runtime.retry(definition, id));
80
+ }),
81
+ runScheduleNow: (name) => {
82
+ const schedule = entries.find((candidate) => candidate.name === name && !("schema" in candidate));
83
+ if (schedule === undefined || "schema" in schedule) {
84
+ return Effect.fail(new JobsQueueUnregistered({ queue: name }));
85
+ }
86
+ return runtime.runScheduleNow({ name: schedule.name, scheduleOptions: schedule.scheduleOptions ?? {} }).pipe(
87
+ Effect.catchTag("PgBossNotFoundError", () => Effect.fail(new JobsQueueUnregistered({ queue: name }))),
88
+ Effect.catchTag("PgBossError", (error) => Effect.fail(new JobsUnavailable({ operation: error.operation }))),
89
+ );
90
+ },
91
+ });
92
+ }),
93
+ );
94
+ }