@shivaedev/admin 0.9.0 → 0.10.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 (46) hide show
  1. package/README.md +3 -3
  2. package/dist/jobs/page.d.ts +42 -13
  3. package/dist/jobs/page.d.ts.map +1 -1
  4. package/dist/jobs/retryPage.d.ts +49 -17
  5. package/dist/jobs/retryPage.d.ts.map +1 -1
  6. package/dist/jobs/retryPage.js +2 -1
  7. package/dist/jobs/retryPage.js.map +1 -1
  8. package/dist/jobs/schemas.d.ts +18 -4
  9. package/dist/jobs/schemas.d.ts.map +1 -1
  10. package/dist/jobs/schemas.js +5 -3
  11. package/dist/jobs/schemas.js.map +1 -1
  12. package/dist/permissions.d.ts +16 -2
  13. package/dist/permissions.d.ts.map +1 -1
  14. package/dist/permissions.js +1 -0
  15. package/dist/permissions.js.map +1 -1
  16. package/dist/server/jobsHandlers.d.ts +28 -9
  17. package/dist/server/jobsHandlers.d.ts.map +1 -1
  18. package/dist/server/jobsHandlers.js +23 -6
  19. package/dist/server/jobsHandlers.js.map +1 -1
  20. package/dist/server/jobsHandlersWithRetry.d.ts +2 -1
  21. package/dist/server/jobsHandlersWithRetry.d.ts.map +1 -1
  22. package/dist/server/jobsHandlersWithRetry.js +4 -0
  23. package/dist/server/jobsHandlersWithRetry.js.map +1 -1
  24. package/dist/server/users.d.ts +9 -34
  25. package/dist/server/users.d.ts.map +1 -1
  26. package/dist/server/users.js +24 -27
  27. package/dist/server/users.js.map +1 -1
  28. package/dist/server/usersHandlers.d.ts +2 -2
  29. package/dist/server/usersHandlers.d.ts.map +1 -1
  30. package/dist/server/usersHandlers.js.map +1 -1
  31. package/dist/users/page.d.ts +5 -5
  32. package/dist/users/page.d.ts.map +1 -1
  33. package/dist/users/page.js.map +1 -1
  34. package/dist/users/roles.d.ts +2 -2
  35. package/dist/users/roles.js +1 -1
  36. package/dist/users/roles.js.map +1 -1
  37. package/package.json +12 -12
  38. package/src/jobs/retryPage.ts +2 -1
  39. package/src/jobs/schemas.ts +5 -3
  40. package/src/permissions.ts +1 -0
  41. package/src/server/jobsHandlers.ts +26 -9
  42. package/src/server/jobsHandlersWithRetry.ts +4 -0
  43. package/src/server/users.ts +27 -30
  44. package/src/server/usersHandlers.ts +2 -2
  45. package/src/users/page.ts +2 -2
  46. package/src/users/roles.ts +1 -1
@@ -1,4 +1,6 @@
1
1
  import { Schema } from "effect";
2
+ import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
+ import { JobFailure } from "@shivaedev/jobs/JobFailure.ts";
2
4
 
3
5
  export interface JobsQueue {
4
6
  readonly name: string;
@@ -17,7 +19,7 @@ export class JobsQueueUnregistered extends Schema.TaggedError<JobsQueueUnregiste
17
19
  queue: Schema.String,
18
20
  }) {}
19
21
 
20
- export const JobsFailures = { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable };
22
+ export const JobsFailures = { BadRequest, JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable };
21
23
 
22
24
  export const QueueCounts = Schema.Struct({
23
25
  activeCount: Schema.Number,
@@ -49,7 +51,7 @@ export const JobFields = {
49
51
  completedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
50
52
  createdOn: Schema.DateTimeUtcFromString,
51
53
  id: Schema.String,
52
- output: Schema.Unknown,
54
+ output: Schema.NullOr(JobFailure),
53
55
  retryCount: Schema.Number,
54
56
  retryLimit: Schema.Number,
55
57
  startedOn: Schema.OptionFromNullOr(Schema.DateTimeUtcFromString),
@@ -69,7 +71,7 @@ export function deadLetteredSchema<TPayload extends Schema.Top>(queue: { readonl
69
71
  data: queue.schema,
70
72
  queue: Schema.Literal(name),
71
73
  sourceId: Schema.OptionFromNullOr(Schema.String),
72
- sourceOutput: Schema.Unknown,
74
+ sourceOutput: Schema.NullOr(JobFailure),
73
75
  });
74
76
  }
75
77
 
@@ -4,5 +4,6 @@ import { permissionMiddleware } from "@shivaedev/identity/permission.ts";
4
4
  export const ReadUsers = permission("users.read");
5
5
  export const AssignRoles = permission("roles.assign");
6
6
  export const ReadJobs = permission("jobs.read");
7
+ export const RetryJobs = permission("jobs.retry");
7
8
  export class UsersPermission extends permissionMiddleware<UsersPermission>()("@shivaedev/admin/UsersPermission", ReadUsers) {}
8
9
  export class JobsPermission extends permissionMiddleware<JobsPermission>()("@shivaedev/admin/JobsPermission", ReadJobs) {}
@@ -1,15 +1,24 @@
1
- import { type Context, DateTime, Effect, Option } from "effect";
1
+ import { type Context, DateTime, Effect, Option, Schema } from "effect";
2
+ import { BadRequest } from "@shivaedev/errors/taxonomy.ts";
3
+ import { JobFailure } from "@shivaedev/jobs/JobFailure.ts";
2
4
  import type { PgBossError, PgBossPayloadError } from "@shivaedev/jobs/server/error.ts";
3
5
  import type { PgBossService } from "@shivaedev/jobs/server/service.ts";
4
6
  import { type JobsEntry, type JobsPayload, jobsQueue } from "#jobs/entry.ts";
5
7
  import type { jobsPage } from "#jobs/page.ts";
6
8
  import { JobsPayloadInvalid, JobsQueueUnregistered, JobsUnavailable } from "#jobs/schemas.ts";
7
9
 
8
- export function jobsFailures<A, R>(effect: Effect.Effect<A, PgBossError | PgBossPayloadError, R>) {
10
+ export function jobsFailures<A, R>(effect: Effect.Effect<A, PgBossError | PgBossPayloadError | Schema.SchemaError, R>) {
9
11
  return effect.pipe(
10
- Effect.mapError((error) =>
11
- error._tag === "PgBossPayloadError" ? new JobsPayloadInvalid({ queue: error.queue }) : new JobsUnavailable({ operation: error.operation }),
12
- ),
12
+ Effect.mapError((error) => {
13
+ switch (error._tag) {
14
+ case "SchemaError":
15
+ return new BadRequest({ message: "Invalid job page options" });
16
+ case "PgBossPayloadError":
17
+ return new JobsPayloadInvalid({ queue: error.queue });
18
+ case "PgBossError":
19
+ return new JobsUnavailable({ operation: error.operation });
20
+ }
21
+ }),
13
22
  );
14
23
  }
15
24
 
@@ -44,7 +53,7 @@ export function jobsReadHandlers<const TQueues extends readonly JobsEntry[], TSe
44
53
  "admin.jobs.health": () =>
45
54
  Effect.gen(function* () {
46
55
  const jobs = yield* service;
47
- const health = yield* jobsFailures(jobs.health);
56
+ const health = yield* jobsFailures(jobs.health());
48
57
  const visible = health.jobs.filter((queue) => page.queues.some((candidate) => candidate.name === queue.name));
49
58
  return {
50
59
  activeTotal: visible.reduce((sum, queue) => sum + queue.activeCount, 0),
@@ -59,19 +68,27 @@ export function jobsReadHandlers<const TQueues extends readonly JobsEntry[], TSe
59
68
  Effect.gen(function* () {
60
69
  const definition = yield* registered(queue);
61
70
  const jobs = yield* service;
62
- return Option.map(yield* jobsFailures(jobs.getJob<string, JobsPayload<TQueues[number]>>(definition, id)), (job) => ({
71
+ const result = yield* jobsFailures(jobs.getJob<string, JobsPayload<TQueues[number]>>(definition, id));
72
+ if (Option.isNone(result)) {
73
+ return Option.none();
74
+ }
75
+ const job = result.value;
76
+ const output = yield* Schema.decodeUnknownEffect(Schema.NullOr(JobFailure))(job.output).pipe(
77
+ Effect.mapError(() => new JobsPayloadInvalid({ queue })),
78
+ );
79
+ return Option.some({
63
80
  attempt: job.startedOn === null ? 0 : job.retryCount + 1,
64
81
  completedOn: Option.map(Option.fromNullishOr(job.completedOn), DateTime.makeUnsafe),
65
82
  createdOn: DateTime.makeUnsafe(job.createdOn),
66
83
  data: job.data,
67
84
  id: job.id,
68
- output: job.output,
85
+ output,
69
86
  queue: job.name,
70
87
  retryCount: job.retryCount,
71
88
  retryLimit: job.retryLimit,
72
89
  startedOn: Option.map(Option.fromNullishOr(job.startedOn), DateTime.makeUnsafe),
73
90
  state: job.state,
74
- }));
91
+ });
75
92
  }),
76
93
  };
77
94
  }
@@ -1,8 +1,11 @@
1
1
  import { type Context, Effect, Option } from "effect";
2
+ import { requirePermission } from "@shivaedev/access/requirePermission.ts";
3
+ import { SessionUser } from "@shivaedev/identity/identity.ts";
2
4
  import type { PgBossService } from "@shivaedev/jobs/server/service.ts";
3
5
  import { type JobsEntry, type JobsPayload, jobsQueue } from "#jobs/entry.ts";
4
6
  import { JobsNotFailed, type jobsPageWithRetry } from "#jobs/retryPage.ts";
5
7
  import { JobsQueueUnregistered } from "#jobs/schemas.ts";
8
+ import { RetryJobs } from "#permissions.ts";
6
9
  import { jobsFailures, jobsReadHandlers } from "./jobsHandlers.ts";
7
10
 
8
11
  export function jobsHandlersWithRetry<const TQueues extends readonly JobsEntry[], TService>(
@@ -13,6 +16,7 @@ export function jobsHandlersWithRetry<const TQueues extends readonly JobsEntry[]
13
16
  ...jobsReadHandlers(page, service),
14
17
  "admin.jobs.retry": ({ queue, id }) =>
15
18
  Effect.gen(function* () {
19
+ yield* requirePermission(yield* SessionUser, RetryJobs);
16
20
  const entries: readonly TQueues[number][] = page.queues;
17
21
  const entry = entries.find((candidate) => candidate.name === queue);
18
22
  if (entry === undefined) {
@@ -1,71 +1,68 @@
1
1
  import { DateTime, Effect, Option, Schema } from "effect";
2
2
  import { SqlClient, SqlSchema } from "effect/sql";
3
- import type { roleSet } from "@shivaedev/access/roleSet.ts";
3
+ import { requirePermission } from "@shivaedev/access/requirePermission.ts";
4
+ import type { AccessPolicy } from "@shivaedev/access/roleSet.ts";
4
5
  import { AuthUnavailable, NotFound } from "@shivaedev/errors/taxonomy.ts";
5
6
  import { SessionUser } from "@shivaedev/identity/identity.ts";
6
- import { requirePermission } from "@shivaedev/identity/permission.ts";
7
7
  import { invalidateOnCommit, transact } from "@shivaedev/sql/transact.ts";
8
8
  import { AssignRoles, ReadUsers } from "#permissions.ts";
9
- import { type ChangeRoleInput, LastRoleAssigner, type UserListInput } from "#users/roles.ts";
9
+ import { AppUser, type ChangeRoleInput, LastRoleAssigner, type UserListInput } from "#users/roles.ts";
10
10
 
11
- const StoredUser = Schema.Struct({
12
- createdAt: Schema.Date,
13
- email: Schema.String,
14
- id: Schema.String,
15
- name: Schema.String,
16
- role: Schema.String,
17
- });
18
11
  function unavailable() {
19
12
  return new AuthUnavailable({ message: "Could not access app users" });
20
13
  }
21
14
 
22
- export const listUsers = Effect.fn("Platform.listUsers")(function* <TRole extends string>(
23
- access: Pick<ReturnType<typeof roleSet<TRole>>, "Role">,
15
+ export const listUsers = Effect.fn("Admin.listUsers")(function* <TRole extends string>(
16
+ access: Pick<AccessPolicy<TRole>, "Role">,
24
17
  input: typeof UserListInput.Type,
25
18
  ) {
26
- yield* requirePermission(ReadUsers);
19
+ yield* requirePermission(yield* SessionUser, ReadUsers);
27
20
  const sql = yield* SqlClient.SqlClient;
28
21
  const read = SqlSchema.findAll({
29
22
  execute: () => sql`select id, name, email, role, "createdAt" from "user"
30
23
  where id > ${input.cursor ?? ""} order by id limit ${input.limit + 1}`,
31
24
  Request: Schema.Void,
32
- Result: Schema.Struct({ ...StoredUser.fields, role: access.Role }),
25
+ Result: Schema.Struct({ ...AppUser.fields, role: access.Role }),
33
26
  });
34
27
  const rows = yield* read(undefined).pipe(Effect.mapError(unavailable));
35
- const users = rows.slice(0, input.limit).map(({ role, createdAt, ...user }) => ({
36
- ...user,
37
- createdAt: DateTime.makeUnsafe(createdAt),
38
- role,
39
- }));
28
+ const users = rows.slice(0, input.limit);
40
29
  return { next: rows.length > input.limit ? Option.fromUndefinedOr(users.at(-1)?.id) : Option.none<string>(), users };
41
30
  });
42
31
 
43
- export const changeUserRole = Effect.fn("Platform.changeUserRole")(function* <TRole extends string>(
44
- access: Pick<ReturnType<typeof roleSet<TRole>>, "Role" | "hasPermission">,
32
+ export const changeUserRole = Effect.fn("Admin.changeUserRole")(function* <TRole extends string>(
33
+ access: Pick<AccessPolicy<TRole>, "Role" | "hasPermission">,
45
34
  input: ChangeRoleInput<TRole>,
46
35
  ) {
47
36
  const actor = yield* SessionUser;
48
- yield* requirePermission(AssignRoles);
37
+ yield* requirePermission(actor, AssignRoles);
49
38
  const sql = yield* SqlClient.SqlClient;
50
39
  const changed = yield* Effect.gen(function* () {
51
40
  yield* sql`select pg_advisory_xact_lock(hashtext('platform.auth.user-roles'))`;
52
- const rows = yield* sql<{ readonly id: string; readonly role: string | null }>`select id, role from "user" where id = ${input.userId} for update`;
53
- const target = rows[0];
54
- if (target === undefined) {
41
+ const readTarget = SqlSchema.findOneOption({
42
+ execute: (id) => sql`select id, role from "user" where id = ${id} for update`,
43
+ Request: AppUser.fields.id,
44
+ Result: Schema.Struct({ id: AppUser.fields.id, role: Schema.NullOr(AppUser.fields.role) }),
45
+ });
46
+ const target = yield* readTarget(input.userId).pipe(Effect.mapError(unavailable));
47
+ if (Option.isNone(target)) {
55
48
  return yield* Effect.fail(new NotFound({ message: "User not found" }));
56
49
  }
57
- const next = yield* Schema.decodeUnknownEffect(access.Role)(input.role).pipe(Effect.mapError(unavailable));
58
- if (target.role === next) {
50
+ if (target.value.role === input.role) {
59
51
  return false;
60
52
  }
61
53
  const assigners = access.Role.literals.filter((role) => access.hasPermission(role, AssignRoles));
62
- if (assigners.some((role) => role === target.role) && !access.hasPermission(next, AssignRoles)) {
63
- const holders = yield* sql<{ readonly id: string }>`select id from "user" where role in ${sql.in(assigners)}`;
54
+ if (assigners.some((role) => role === target.value.role) && !access.hasPermission(input.role, AssignRoles)) {
55
+ const readHolders = SqlSchema.findAll({
56
+ execute: () => sql`select id from "user" where role in ${sql.in(assigners)}`,
57
+ Request: Schema.Void,
58
+ Result: Schema.Struct({ id: AppUser.fields.id }),
59
+ });
60
+ const holders = yield* readHolders(undefined).pipe(Effect.mapError(unavailable));
64
61
  if (holders.length === 1) {
65
62
  return yield* Effect.fail(new LastRoleAssigner({ userId: input.userId }));
66
63
  }
67
64
  }
68
- yield* sql`update "user" set role = ${next}, "updatedAt" = now() where id = ${input.userId}`;
65
+ yield* sql`update "user" set role = ${input.role}, "updatedAt" = now() where id = ${input.userId}`;
69
66
  yield* invalidateOnCommit(["admin.users"]);
70
67
  return true;
71
68
  }).pipe(transact({ onSqlError: unavailable }));
@@ -1,5 +1,5 @@
1
1
  import { Effect } from "effect";
2
- import type { roleSet } from "@shivaedev/access/roleSet.ts";
2
+ import type { AccessPolicy } from "@shivaedev/access/roleSet.ts";
3
3
  import { SessionUser } from "@shivaedev/identity/identity.ts";
4
4
  import { hasPermission } from "@shivaedev/identity/permission.ts";
5
5
  import { AssignRoles } from "#permissions.ts";
@@ -8,7 +8,7 @@ import type { usersPage } from "#users/page.ts";
8
8
 
9
9
  export function usersHandlers<const TRole extends string>(
10
10
  page: ReturnType<typeof usersPage<TRole>>,
11
- access: Pick<ReturnType<typeof roleSet<TRole>>, "Role" | "hasPermission">,
11
+ access: Pick<AccessPolicy<TRole>, "Role" | "hasPermission">,
12
12
  ) {
13
13
  return page.contract.application.toLayer({
14
14
  "admin.users.changeRole": (input) => changeUserRole(access, input),
package/src/users/page.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { Effect, Schema } from "effect";
2
- import type { roleSet } from "@shivaedev/access/roleSet.ts";
2
+ import type { AccessPolicy } from "@shivaedev/access/roleSet.ts";
3
3
  import { collection } from "@shivaedev/changes/keys.ts";
4
4
  import { contract } from "@shivaedev/contract/contract.ts";
5
5
  import { command, query } from "@shivaedev/contract/operation.ts";
@@ -13,7 +13,7 @@ import { LastRoleAssigner, UserList, UserListInput } from "#users/roles.ts";
13
13
  const users = collection("admin.users", Schema.String);
14
14
 
15
15
  export const UsersList = Schema.Struct({ ...UserList.fields, canChangeRoles: Schema.Boolean });
16
- export function usersPage<const TRole extends string>(access: Pick<ReturnType<typeof roleSet<TRole>>, "Role">) {
16
+ export function usersPage<const TRole extends string>(access: Pick<AccessPolicy<TRole>, "Role">) {
17
17
  return adminPage({
18
18
  contract: contract("admin.users", {
19
19
  commands: [
@@ -1,7 +1,7 @@
1
1
  import { Schema } from "effect";
2
2
 
3
3
  export const AppUser = Schema.Struct({
4
- createdAt: Schema.DateTimeUtcFromString,
4
+ createdAt: Schema.DateTimeUtcFromDate,
5
5
  email: Schema.String,
6
6
  id: Schema.String,
7
7
  name: Schema.String,