@shivaedev/access 0.1.2 → 0.3.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.
- package/README.md +11 -6
- package/dist/permission.d.ts +7 -4
- package/dist/permission.d.ts.map +1 -1
- package/dist/permission.js +5 -0
- package/dist/permission.js.map +1 -1
- package/dist/refusal.d.ts +5 -0
- package/dist/refusal.d.ts.map +1 -0
- package/dist/refusal.js +8 -0
- package/dist/refusal.js.map +1 -0
- package/dist/requirePermission.d.ts +8 -0
- package/dist/requirePermission.d.ts.map +1 -0
- package/dist/requirePermission.js +7 -0
- package/dist/requirePermission.js.map +1 -0
- package/dist/roleSet.d.ts +18 -8
- package/dist/roleSet.d.ts.map +1 -1
- package/dist/roleSet.js +22 -19
- package/dist/roleSet.js.map +1 -1
- package/dist/roles.d.ts +16 -0
- package/dist/roles.d.ts.map +1 -0
- package/dist/roles.js +6 -0
- package/dist/roles.js.map +1 -0
- package/package.json +4 -4
- package/src/permission.ts +8 -4
- package/src/refusal.ts +10 -0
- package/src/requirePermission.ts +12 -0
- package/src/roleSet.ts +41 -27
- package/src/roles.ts +5 -0
package/README.md
CHANGED
|
@@ -26,16 +26,18 @@ Both checks return `true`: the member owns the first record, and the operator ho
|
|
|
26
26
|
|
|
27
27
|
### Permissions and roles
|
|
28
28
|
|
|
29
|
-
A permission names the domain and action, such as `users.read`, `roles.assign` or `jobs.read`. `permission(name)` declares the default strength and exposes a separate override value as `.any`. Each role receives an explicit list of grants. There are no wildcard
|
|
29
|
+
A permission names the domain and action, such as `users.read`, `roles.assign` or `jobs.read`. `permission(name)` declares the default strength and exposes a separate override value as `.any`. Each role receives an explicit list of grants. There are no wildcard or prefix grants. An `any` grant covers an `own` check for the same name; an `own` grant never covers an `any` check. The resolved list still contains only the explicitly declared grants.
|
|
30
30
|
|
|
31
31
|
```ts
|
|
32
|
-
|
|
32
|
+
import { AssignRoles } from "@shivaedev/access/roles.ts";
|
|
33
33
|
const ReadJobs = permission("jobs.read");
|
|
34
34
|
const Operator = role("operator", [ReadUsers.any, AssignRoles, ReadJobs]);
|
|
35
35
|
const Guest = role("guest", []);
|
|
36
36
|
const Access = roleSet(Member, Operator, Guest);
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
Each role name is declared once in a role set, and `roleSet` refuses a repeated literal name with a compile error. A name typed only as `string` escapes that check; when it repeats a declared name, every check and `resolve` use the first declaration's grants. Library code that takes an application's role set as a parameter types it as `AccessPolicy<TName>` from `@shivaedev/access/roleSet.ts`.
|
|
40
|
+
|
|
39
41
|
Keep these declarations in application code. The package provides no persistence or runtime role editor.
|
|
40
42
|
|
|
41
43
|
### Store and decode the role string
|
|
@@ -51,16 +53,19 @@ const decodeUser = Schema.decodeUnknownEffect(AppUser);
|
|
|
51
53
|
const decodeRole = Schema.decodeUnknownEffect(Access.Role);
|
|
52
54
|
```
|
|
53
55
|
|
|
54
|
-
`AppRole` is `"member" | "operator" | "guest"`. An unknown stored name fails in the typed `SchemaError` channel. `yield* Access.resolve(stored)` decodes the same Schema and returns `{ role, permissions }`, with only the grants declared for that role. `@shivaedev/identity` accepts the role set as the `roles` option of its session policy and its Better Auth mount.
|
|
56
|
+
`AppRole` is `"member" | "operator" | "guest"`. An unknown stored name fails in the typed `SchemaError` channel. `yield* Access.resolve(stored)` decodes the same Schema and returns `{ role, permissions }`, with only the grants declared for that role, decoded through the exported `Permission` Schema. `@shivaedev/identity` accepts the role set as the `roles` option of its session policy and its Better Auth mount.
|
|
55
57
|
|
|
56
58
|
### Check grants and enforce actions
|
|
57
59
|
|
|
58
|
-
`hasPermission(role, permission)`
|
|
60
|
+
`Access.hasPermission(role, permission)` evaluates the role's grants. The standalone `hasPermission(grants, permission)` from `@shivaedev/access/permission.ts` evaluates resolved grants with the same rule. `requirePermission(user, permission)` from `@shivaedev/access/requirePermission.ts` enforces it for a signed-in user carrying `permissions`; missing grants fail with `Forbidden`. The session boundary authenticates the user before this check. `forbidden(permission)` and `unauthorized()` from `@shivaedev/access/refusal.ts` construct these shared failures from `@shivaedev/errors/taxonomy.ts`.
|
|
59
61
|
|
|
60
62
|
```ts
|
|
63
|
+
import { requirePermission } from "@shivaedev/access/requirePermission.ts";
|
|
64
|
+
|
|
61
65
|
const user = { id: "alice", role: "operator" } as const;
|
|
66
|
+
const resolved = yield* Access.resolve(user.role);
|
|
62
67
|
const showAssignment = Access.hasPermission(user.role, AssignRoles);
|
|
63
|
-
const enforceAssignment =
|
|
68
|
+
const enforceAssignment = requirePermission(resolved, AssignRoles);
|
|
64
69
|
```
|
|
65
70
|
|
|
66
71
|
Use permissions in application decisions instead of comparing role names.
|
|
@@ -76,7 +81,7 @@ const canRead = Access.canAccess(user, ReadUsers, "bob");
|
|
|
76
81
|
const enforceRead = Access.requireAccess(user, ReadUsers, "bob");
|
|
77
82
|
```
|
|
78
83
|
|
|
79
|
-
Use the ownership APIs when an action targets a record; the
|
|
84
|
+
Use the ownership APIs when an action targets a record; the grant APIs do not check an owner.
|
|
80
85
|
|
|
81
86
|
### Install
|
|
82
87
|
|
package/dist/permission.d.ts
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
readonly
|
|
4
|
-
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
export declare const Permission: Schema.Struct<{
|
|
3
|
+
readonly name: Schema.String;
|
|
4
|
+
readonly strength: Schema.Literals<readonly ["own", "any"]>;
|
|
5
|
+
}>;
|
|
6
|
+
export type Permission = typeof Permission.Type;
|
|
5
7
|
export interface OwnPermission extends Permission {
|
|
6
8
|
readonly any: Permission;
|
|
7
9
|
readonly strength: "own";
|
|
@@ -14,4 +16,5 @@ export declare function permission<const TName extends `${string}.${string}`>(na
|
|
|
14
16
|
readonly name: TName;
|
|
15
17
|
readonly strength: "own";
|
|
16
18
|
};
|
|
19
|
+
export declare function hasPermission(grants: readonly Permission[] | undefined, required: Permission): boolean;
|
|
17
20
|
//# sourceMappingURL=permission.d.ts.map
|
package/dist/permission.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../src/permission.ts"],"names":[],"mappings":"AAAA,MAAM,
|
|
1
|
+
{"version":3,"file":"permission.d.ts","sourceRoot":"","sources":["../src/permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,eAAO,MAAM,UAAU;;;EAAoF,CAAC;AAC5G,MAAM,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,IAAI,CAAC;AAEhD,MAAM,WAAW,aAAc,SAAQ,UAAU;IAChD,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC;IACzB,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;CACzB;AAED,wBAAgB,UAAU,CAAC,KAAK,CAAC,KAAK,SAAS,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK;;;2BAChD,KAAK;;;uBAAoB,KAAK;EAC9D;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAEtG"}
|
package/dist/permission.js
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
export const Permission = Schema.Struct({ name: Schema.String, strength: Schema.Literals(["own", "any"]) });
|
|
1
3
|
export function permission(name) {
|
|
2
4
|
return { any: { name, strength: "any" }, name, strength: "own" };
|
|
3
5
|
}
|
|
6
|
+
export function hasPermission(grants, required) {
|
|
7
|
+
return grants?.some((grant) => grant.name === required.name && (grant.strength === "any" || grant.strength === required.strength)) ?? false;
|
|
8
|
+
}
|
|
4
9
|
//# sourceMappingURL=permission.js.map
|
package/dist/permission.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"permission.js","sourceRoot":"","sources":["../src/permission.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"permission.js","sourceRoot":"","sources":["../src/permission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;AAQ5G,MAAM,UAAU,UAAU,CAA4C,IAAW;IAChF,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAW,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAyC,EAAE,QAAoB;IAC5F,OAAO,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,CAAC;AAC7I,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
2
|
+
import type { Permission } from "./permission.ts";
|
|
3
|
+
export declare function forbidden(permission: Permission): Forbidden;
|
|
4
|
+
export declare function unauthorized(): Unauthorized;
|
|
5
|
+
//# sourceMappingURL=refusal.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"refusal.d.ts","sourceRoot":"","sources":["../src/refusal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,wBAAgB,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAE3D;AAED,wBAAgB,YAAY,IAAI,YAAY,CAE3C"}
|
package/dist/refusal.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
2
|
+
export function forbidden(permission) {
|
|
3
|
+
return new Forbidden({ message: `Permission required: ${permission.name} (${permission.strength})` });
|
|
4
|
+
}
|
|
5
|
+
export function unauthorized() {
|
|
6
|
+
return new Unauthorized({ message: "Sign in to continue" });
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=refusal.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"refusal.js","sourceRoot":"","sources":["../src/refusal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAGxE,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC/C,OAAO,IAAI,SAAS,CAAC,EAAE,OAAO,EAAE,wBAAwB,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC;AACvG,CAAC;AAED,MAAM,UAAU,YAAY;IAC3B,OAAO,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;AAC7D,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type { Forbidden } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
+
import { type Permission } from "./permission.ts";
|
|
4
|
+
export interface PermissionUser {
|
|
5
|
+
readonly permissions?: readonly Permission[];
|
|
6
|
+
}
|
|
7
|
+
export declare function requirePermission(user: PermissionUser, permission: Permission): Effect.Effect<void, Forbidden>;
|
|
8
|
+
//# sourceMappingURL=requirePermission.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requirePermission.d.ts","sourceRoot":"","sources":["../src/requirePermission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAGjE,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAC7C;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAE9G"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import { hasPermission } from "./permission.js";
|
|
3
|
+
import { forbidden } from "./refusal.js";
|
|
4
|
+
export function requirePermission(user, permission) {
|
|
5
|
+
return hasPermission(user.permissions, permission) ? Effect.void : Effect.fail(forbidden(permission));
|
|
6
|
+
}
|
|
7
|
+
//# sourceMappingURL=requirePermission.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"requirePermission.js","sourceRoot":"","sources":["../src/requirePermission.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAmB,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAMzC,MAAM,UAAU,iBAAiB,CAAC,IAAoB,EAAE,UAAsB;IAC7E,OAAO,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;AACvG,CAAC"}
|
package/dist/roleSet.d.ts
CHANGED
|
@@ -1,24 +1,34 @@
|
|
|
1
1
|
import { Effect, Schema } from "effect";
|
|
2
|
-
import { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
-
import type
|
|
2
|
+
import type { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
+
import { type OwnPermission, Permission } from "#permission.ts";
|
|
4
4
|
import type { Role as RoleDefinition } from "#role.ts";
|
|
5
5
|
export interface User<TName extends string> {
|
|
6
6
|
readonly id: string;
|
|
7
7
|
readonly role: TName;
|
|
8
8
|
}
|
|
9
|
-
|
|
9
|
+
type RoleList = readonly [RoleDefinition, ...RoleDefinition[]];
|
|
10
|
+
type RepeatedName<TRoles extends readonly RoleDefinition[], TSeen extends string = never> = TRoles extends readonly [
|
|
11
|
+
infer THead extends RoleDefinition,
|
|
12
|
+
...infer TTail extends readonly RoleDefinition[]
|
|
13
|
+
] ? (string extends THead["name"] ? never : THead["name"] extends TSeen ? THead["name"] : never) | RepeatedName<TTail, TSeen | THead["name"]> : never;
|
|
14
|
+
type DistinctNames<TRoles extends RoleList> = [RepeatedName<TRoles>] extends [never] ? unknown : {
|
|
15
|
+
readonly "each role name is declared once": RepeatedName<TRoles>;
|
|
16
|
+
};
|
|
17
|
+
export type AccessPolicy<TName extends string> = ReturnType<typeof accessPolicy<TName>>;
|
|
18
|
+
export declare function roleSet<const TRoles extends RoleList>(...roles: TRoles & DistinctNames<TRoles>): AccessPolicy<TRoles[number]["name"]>;
|
|
19
|
+
declare function accessPolicy<TName extends string>(roles: readonly RoleDefinition<TName>[]): {
|
|
10
20
|
canAccess: (user: User<TName> | null | undefined, permission: OwnPermission, ownerId: string) => boolean;
|
|
11
21
|
hasPermission: (name: TName, permission: Permission) => boolean;
|
|
12
22
|
Role: Schema.Literals<TName[]>;
|
|
13
23
|
requireAccess: (user: User<TName> | null | undefined, permission: OwnPermission, ownerId: string) => Effect.Effect<void, Forbidden | Unauthorized>;
|
|
14
|
-
requirePermission: (user: User<TName> | null | undefined, permission: Permission) => Effect.Effect<void, Forbidden | Unauthorized>;
|
|
15
24
|
resolve: (stored: unknown) => Effect.Effect<{
|
|
16
|
-
permissions: {
|
|
17
|
-
name: string;
|
|
18
|
-
strength: "any" | "own";
|
|
25
|
+
permissions: readonly {
|
|
26
|
+
readonly name: string;
|
|
27
|
+
readonly strength: "any" | "own";
|
|
19
28
|
}[];
|
|
20
29
|
role: TName;
|
|
21
30
|
}, Schema.SchemaError, never>;
|
|
22
31
|
};
|
|
23
|
-
export type RoleSet = Pick<
|
|
32
|
+
export type RoleSet = Pick<AccessPolicy<string>, "resolve">;
|
|
33
|
+
export {};
|
|
24
34
|
//# sourceMappingURL=roleSet.d.ts.map
|
package/dist/roleSet.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roleSet.d.ts","sourceRoot":"","sources":["../src/roleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;
|
|
1
|
+
{"version":3,"file":"roleSet.d.ts","sourceRoot":"","sources":["../src/roleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAkC,KAAK,aAAa,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEhG,OAAO,KAAK,EAAE,IAAI,IAAI,cAAc,EAAE,MAAM,UAAU,CAAC;AAEvD,MAAM,WAAW,IAAI,CAAC,KAAK,SAAS,MAAM;IACzC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACrB;AAED,KAAK,QAAQ,GAAG,SAAS,CAAC,cAAc,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;AAE/D,KAAK,YAAY,CAAC,MAAM,SAAS,SAAS,cAAc,EAAE,EAAE,KAAK,SAAS,MAAM,GAAG,KAAK,IAAI,MAAM,SAAS,SAAS;IACnH,MAAM,KAAK,SAAS,cAAc;IAClC,GAAG,MAAM,KAAK,SAAS,SAAS,cAAc,EAAE;CAChD,GACE,CAAC,MAAM,SAAS,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,SAAS,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GACzI,KAAK,CAAC;AAET,KAAK,aAAa,CAAC,MAAM,SAAS,QAAQ,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACjF,OAAO,GACP;IAAE,QAAQ,CAAC,iCAAiC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,YAAY,CAAC,KAAK,SAAS,MAAM,IAAI,UAAU,CAAC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;AAExF,wBAAgB,OAAO,CAAC,KAAK,CAAC,MAAM,SAAS,QAAQ,EAAE,GAAG,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAErI;AAED,iBAAS,YAAY,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,SAAS,cAAc,CAAC,KAAK,CAAC,EAAE;sBAczD,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,cAAc,aAAa,WAAW,MAAM,KAAG,OAAO;0BAHhF,KAAK,cAAc,UAAU,KAAG,OAAO;;0BAW7D,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,cACxB,aAAa,WAChB,MAAM,KACb,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC;sBAMvB,OAAO;;;;;;;EAchC;AAED,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC"}
|
package/dist/roleSet.js
CHANGED
|
@@ -1,43 +1,46 @@
|
|
|
1
1
|
import { Effect, Schema } from "effect";
|
|
2
|
-
import {
|
|
2
|
+
import { hasPermission as evaluateGrant, Permission } from "#permission.ts";
|
|
3
|
+
import { forbidden, unauthorized } from "#refusal.ts";
|
|
3
4
|
export function roleSet(...roles) {
|
|
5
|
+
return accessPolicy(roles);
|
|
6
|
+
}
|
|
7
|
+
function accessPolicy(roles) {
|
|
4
8
|
const Role = Schema.Literals(roles.map((role) => role.name));
|
|
9
|
+
const grantsByName = new Map();
|
|
10
|
+
for (const role of roles) {
|
|
11
|
+
if (!grantsByName.has(role.name)) {
|
|
12
|
+
grantsByName.set(role.name, role.permissions);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
function grantsOf(name) {
|
|
16
|
+
return grantsByName.get(name) ?? [];
|
|
17
|
+
}
|
|
5
18
|
function hasPermission(name, permission) {
|
|
6
|
-
return
|
|
19
|
+
return evaluateGrant(grantsOf(name), permission);
|
|
7
20
|
}
|
|
8
21
|
function canAccess(user, permission, ownerId) {
|
|
9
22
|
return (user !== null
|
|
10
23
|
&& user !== undefined
|
|
11
24
|
&& (hasPermission(user.role, permission.any) || (user.id === ownerId && hasPermission(user.role, permission))));
|
|
12
25
|
}
|
|
13
|
-
function requirePermission(user, permission) {
|
|
14
|
-
if (user === null || user === undefined) {
|
|
15
|
-
return Effect.fail(new Unauthorized({ message: "Sign in to continue" }));
|
|
16
|
-
}
|
|
17
|
-
return hasPermission(user.role, permission)
|
|
18
|
-
? Effect.void
|
|
19
|
-
: Effect.fail(new Forbidden({
|
|
20
|
-
message: `Permission required: ${permission.name} (${permission.strength})`,
|
|
21
|
-
}));
|
|
22
|
-
}
|
|
23
26
|
function requireAccess(user, permission, ownerId) {
|
|
24
27
|
if (user === null || user === undefined) {
|
|
25
|
-
return Effect.fail(
|
|
28
|
+
return Effect.fail(unauthorized());
|
|
26
29
|
}
|
|
27
|
-
return canAccess(user, permission, ownerId) ? Effect.void : Effect.fail(
|
|
30
|
+
return canAccess(user, permission, ownerId) ? Effect.void : Effect.fail(forbidden(permission));
|
|
28
31
|
}
|
|
29
32
|
function resolve(stored) {
|
|
30
|
-
return Effect.
|
|
31
|
-
|
|
32
|
-
role
|
|
33
|
-
|
|
33
|
+
return Effect.gen(function* () {
|
|
34
|
+
const role = yield* Schema.decodeUnknownEffect(Role)(stored);
|
|
35
|
+
const permissions = yield* Schema.decodeUnknownEffect(Schema.Array(Permission))(grantsOf(role));
|
|
36
|
+
return { permissions, role };
|
|
37
|
+
});
|
|
34
38
|
}
|
|
35
39
|
return {
|
|
36
40
|
canAccess,
|
|
37
41
|
hasPermission,
|
|
38
42
|
Role,
|
|
39
43
|
requireAccess,
|
|
40
|
-
requirePermission,
|
|
41
44
|
resolve,
|
|
42
45
|
};
|
|
43
46
|
}
|
package/dist/roleSet.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"roleSet.js","sourceRoot":"","sources":["../src/roleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"roleSet.js","sourceRoot":"","sources":["../src/roleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAExC,OAAO,EAAE,aAAa,IAAI,aAAa,EAAsB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAuBtD,MAAM,UAAU,OAAO,CAAgC,GAAG,KAAqC;IAC9F,OAAO,YAAY,CAAyB,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,YAAY,CAAuB,KAAuC;IAClF,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,MAAM,YAAY,GAAG,IAAI,GAAG,EAAiC,CAAC;IAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC/C,CAAC;IACF,CAAC;IACD,SAAS,QAAQ,CAAC,IAAW;QAC5B,OAAO,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IACD,SAAS,aAAa,CAAC,IAAW,EAAE,UAAsB;QACzD,OAAO,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IACD,SAAS,SAAS,CAAC,IAAoC,EAAE,UAAyB,EAAE,OAAe;QAClG,OAAO,CACN,IAAI,KAAK,IAAI;eACV,IAAI,KAAK,SAAS;eAClB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAC9G,CAAC;IACH,CAAC;IACD,SAAS,aAAa,CACrB,IAAoC,EACpC,UAAyB,EACzB,OAAe;QAEf,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACzC,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAChG,CAAC;IACD,SAAS,OAAO,CAAC,MAAe;QAC/B,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;YAC7D,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YAChG,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACJ,CAAC;IACD,OAAO;QACN,SAAS;QACT,aAAa;QACb,IAAI;QACJ,aAAa;QACb,OAAO;KACP,CAAC;AACH,CAAC"}
|
package/dist/roles.d.ts
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
export declare const AssignRoles: {
|
|
3
|
+
readonly any: {
|
|
4
|
+
readonly name: "roles.assign";
|
|
5
|
+
readonly strength: "any";
|
|
6
|
+
};
|
|
7
|
+
readonly name: "roles.assign";
|
|
8
|
+
readonly strength: "own";
|
|
9
|
+
};
|
|
10
|
+
declare const LastRoleAssigner_base: Schema.Class<LastRoleAssigner, Schema.TaggedStruct<"LastRoleAssigner", {
|
|
11
|
+
readonly userId: Schema.String;
|
|
12
|
+
}>, import("effect/Cause").YieldableError>;
|
|
13
|
+
export declare class LastRoleAssigner extends LastRoleAssigner_base {
|
|
14
|
+
}
|
|
15
|
+
export {};
|
|
16
|
+
//# sourceMappingURL=roles.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC,eAAO,MAAM,WAAW;;;;;;;CAA6B,CAAC;;;;AACtD,qBAAa,gBAAiB,SAAQ,qBAAqF;CAAG"}
|
package/dist/roles.js
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
import { permission } from "#permission.ts";
|
|
3
|
+
export const AssignRoles = permission("roles.assign");
|
|
4
|
+
export class LastRoleAssigner extends Schema.TaggedError()("LastRoleAssigner", { userId: Schema.String }) {
|
|
5
|
+
}
|
|
6
|
+
//# sourceMappingURL=roles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"roles.js","sourceRoot":"","sources":["../src/roles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;AACtD,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC;CAAG"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/access",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Browser-safe role declarations and permission checks for Effect applications",
|
|
5
5
|
"homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/access#readme",
|
|
6
6
|
"bugs": {
|
|
@@ -41,11 +41,11 @@
|
|
|
41
41
|
"README.md"
|
|
42
42
|
],
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@shivaedev/errors": "0.1.
|
|
44
|
+
"@shivaedev/errors": "0.1.2"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@shivaedev/quality": "0.
|
|
48
|
-
"@shivaedev/test-story": "0.
|
|
47
|
+
"@shivaedev/quality": "0.48.0",
|
|
48
|
+
"@shivaedev/test-story": "0.26.2",
|
|
49
49
|
"@types/node": "24.19.2",
|
|
50
50
|
"effect": "4.0.6",
|
|
51
51
|
"typescript": "7.0.2",
|
package/src/permission.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { Schema } from "effect";
|
|
2
|
+
|
|
3
|
+
export const Permission = Schema.Struct({ name: Schema.String, strength: Schema.Literals(["own", "any"]) });
|
|
4
|
+
export type Permission = typeof Permission.Type;
|
|
5
5
|
|
|
6
6
|
export interface OwnPermission extends Permission {
|
|
7
7
|
readonly any: Permission;
|
|
@@ -11,3 +11,7 @@ export interface OwnPermission extends Permission {
|
|
|
11
11
|
export function permission<const TName extends `${string}.${string}`>(name: TName) {
|
|
12
12
|
return { any: { name, strength: "any" }, name, strength: "own" } as const;
|
|
13
13
|
}
|
|
14
|
+
|
|
15
|
+
export function hasPermission(grants: readonly Permission[] | undefined, required: Permission): boolean {
|
|
16
|
+
return grants?.some((grant) => grant.name === required.name && (grant.strength === "any" || grant.strength === required.strength)) ?? false;
|
|
17
|
+
}
|
package/src/refusal.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
2
|
+
import type { Permission } from "./permission.ts";
|
|
3
|
+
|
|
4
|
+
export function forbidden(permission: Permission): Forbidden {
|
|
5
|
+
return new Forbidden({ message: `Permission required: ${permission.name} (${permission.strength})` });
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
export function unauthorized(): Unauthorized {
|
|
9
|
+
return new Unauthorized({ message: "Sign in to continue" });
|
|
10
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type { Forbidden } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
+
import { hasPermission, type Permission } from "./permission.ts";
|
|
4
|
+
import { forbidden } from "./refusal.ts";
|
|
5
|
+
|
|
6
|
+
export interface PermissionUser {
|
|
7
|
+
readonly permissions?: readonly Permission[];
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export function requirePermission(user: PermissionUser, permission: Permission): Effect.Effect<void, Forbidden> {
|
|
11
|
+
return hasPermission(user.permissions, permission) ? Effect.void : Effect.fail(forbidden(permission));
|
|
12
|
+
}
|
package/src/roleSet.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Effect, Schema } from "effect";
|
|
2
|
-
import { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
-
import type
|
|
2
|
+
import type { Forbidden, Unauthorized } from "@shivaedev/errors/taxonomy.ts";
|
|
3
|
+
import { hasPermission as evaluateGrant, type OwnPermission, Permission } from "#permission.ts";
|
|
4
|
+
import { forbidden, unauthorized } from "#refusal.ts";
|
|
4
5
|
import type { Role as RoleDefinition } from "#role.ts";
|
|
5
6
|
|
|
6
7
|
export interface User<TName extends string> {
|
|
@@ -8,13 +9,38 @@ export interface User<TName extends string> {
|
|
|
8
9
|
readonly role: TName;
|
|
9
10
|
}
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
type RoleList = readonly [RoleDefinition, ...RoleDefinition[]];
|
|
13
|
+
|
|
14
|
+
type RepeatedName<TRoles extends readonly RoleDefinition[], TSeen extends string = never> = TRoles extends readonly [
|
|
15
|
+
infer THead extends RoleDefinition,
|
|
16
|
+
...infer TTail extends readonly RoleDefinition[],
|
|
17
|
+
]
|
|
18
|
+
? (string extends THead["name"] ? never : THead["name"] extends TSeen ? THead["name"] : never) | RepeatedName<TTail, TSeen | THead["name"]>
|
|
19
|
+
: never;
|
|
20
|
+
|
|
21
|
+
type DistinctNames<TRoles extends RoleList> = [RepeatedName<TRoles>] extends [never]
|
|
22
|
+
? unknown
|
|
23
|
+
: { readonly "each role name is declared once": RepeatedName<TRoles> };
|
|
24
|
+
|
|
25
|
+
export type AccessPolicy<TName extends string> = ReturnType<typeof accessPolicy<TName>>;
|
|
26
|
+
|
|
27
|
+
export function roleSet<const TRoles extends RoleList>(...roles: TRoles & DistinctNames<TRoles>): AccessPolicy<TRoles[number]["name"]> {
|
|
28
|
+
return accessPolicy<TRoles[number]["name"]>(roles);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
function accessPolicy<TName extends string>(roles: readonly RoleDefinition<TName>[]) {
|
|
12
32
|
const Role = Schema.Literals(roles.map((role) => role.name));
|
|
33
|
+
const grantsByName = new Map<string, readonly Permission[]>();
|
|
34
|
+
for (const role of roles) {
|
|
35
|
+
if (!grantsByName.has(role.name)) {
|
|
36
|
+
grantsByName.set(role.name, role.permissions);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
function grantsOf(name: TName): readonly Permission[] {
|
|
40
|
+
return grantsByName.get(name) ?? [];
|
|
41
|
+
}
|
|
13
42
|
function hasPermission(name: TName, permission: Permission): boolean {
|
|
14
|
-
return
|
|
15
|
-
(role) =>
|
|
16
|
-
role.name === name && role.permissions.some((granted) => granted.name === permission.name && granted.strength === permission.strength),
|
|
17
|
-
);
|
|
43
|
+
return evaluateGrant(grantsOf(name), permission);
|
|
18
44
|
}
|
|
19
45
|
function canAccess(user: User<TName> | null | undefined, permission: OwnPermission, ownerId: string): boolean {
|
|
20
46
|
return (
|
|
@@ -23,42 +49,30 @@ export function roleSet<const TName extends string>(...roles: readonly [RoleDefi
|
|
|
23
49
|
&& (hasPermission(user.role, permission.any) || (user.id === ownerId && hasPermission(user.role, permission)))
|
|
24
50
|
);
|
|
25
51
|
}
|
|
26
|
-
function requirePermission(user: User<TName> | null | undefined, permission: Permission): Effect.Effect<void, Forbidden | Unauthorized> {
|
|
27
|
-
if (user === null || user === undefined) {
|
|
28
|
-
return Effect.fail(new Unauthorized({ message: "Sign in to continue" }));
|
|
29
|
-
}
|
|
30
|
-
return hasPermission(user.role, permission)
|
|
31
|
-
? Effect.void
|
|
32
|
-
: Effect.fail(
|
|
33
|
-
new Forbidden({
|
|
34
|
-
message: `Permission required: ${permission.name} (${permission.strength})`,
|
|
35
|
-
}),
|
|
36
|
-
);
|
|
37
|
-
}
|
|
38
52
|
function requireAccess(
|
|
39
53
|
user: User<TName> | null | undefined,
|
|
40
54
|
permission: OwnPermission,
|
|
41
55
|
ownerId: string,
|
|
42
56
|
): Effect.Effect<void, Forbidden | Unauthorized> {
|
|
43
57
|
if (user === null || user === undefined) {
|
|
44
|
-
return Effect.fail(
|
|
58
|
+
return Effect.fail(unauthorized());
|
|
45
59
|
}
|
|
46
|
-
return canAccess(user, permission, ownerId) ? Effect.void : Effect.fail(
|
|
60
|
+
return canAccess(user, permission, ownerId) ? Effect.void : Effect.fail(forbidden(permission));
|
|
47
61
|
}
|
|
48
62
|
function resolve(stored: unknown) {
|
|
49
|
-
return Effect.
|
|
50
|
-
|
|
51
|
-
role
|
|
52
|
-
|
|
63
|
+
return Effect.gen(function* () {
|
|
64
|
+
const role = yield* Schema.decodeUnknownEffect(Role)(stored);
|
|
65
|
+
const permissions = yield* Schema.decodeUnknownEffect(Schema.Array(Permission))(grantsOf(role));
|
|
66
|
+
return { permissions, role };
|
|
67
|
+
});
|
|
53
68
|
}
|
|
54
69
|
return {
|
|
55
70
|
canAccess,
|
|
56
71
|
hasPermission,
|
|
57
72
|
Role,
|
|
58
73
|
requireAccess,
|
|
59
|
-
requirePermission,
|
|
60
74
|
resolve,
|
|
61
75
|
};
|
|
62
76
|
}
|
|
63
77
|
|
|
64
|
-
export type RoleSet = Pick<
|
|
78
|
+
export type RoleSet = Pick<AccessPolicy<string>, "resolve">;
|
package/src/roles.ts
ADDED