@l3dev/abac 0.1.0 → 0.2.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/build/abac.d.ts +8 -0
- package/build/abac.js +35 -0
- package/build/abac.js.map +1 -1
- package/build/action.d.ts +2 -1
- package/build/action.js.map +1 -1
- package/build/actionGroup.d.ts +2 -1
- package/build/actionGroup.js.map +1 -1
- package/build/actionVisitor.d.ts +6 -2
- package/build/actionVisitor.js +20 -11
- package/build/actionVisitor.js.map +1 -1
- package/build/internal/meta.d.ts +7 -0
- package/build/internal/meta.js +2 -0
- package/build/internal/meta.js.map +1 -0
- package/build/resource.d.ts +2 -1
- package/build/resource.js.map +1 -1
- package/package.json +5 -1
package/build/abac.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Action, type RuleCtx, type InferActionSubject } from "./action.js";
|
|
|
2
2
|
import { ActionGroup } from "./actionGroup.js";
|
|
3
3
|
import type { ResourceMap } from "./internal/collections.js";
|
|
4
4
|
import type { UnsetMarker } from "./internal/core.js";
|
|
5
|
+
import type { IMeta } from "./internal/meta.js";
|
|
5
6
|
import type { ActionFromPath, ActionPaths, FilterActionPaths } from "./internal/paths.js";
|
|
6
7
|
import { Permission, type PermissionOptions } from "./permission.js";
|
|
7
8
|
import { Policy } from "./policy.js";
|
|
@@ -12,6 +13,11 @@ export type ConfigurableAction = {
|
|
|
12
13
|
action: Action<any, any>;
|
|
13
14
|
own: boolean;
|
|
14
15
|
};
|
|
16
|
+
type ConfigurableActionGroup = {
|
|
17
|
+
meta: IMeta;
|
|
18
|
+
children: ConfigurableActionTreeNode[];
|
|
19
|
+
};
|
|
20
|
+
export type ConfigurableActionTreeNode = ConfigurableAction | ConfigurableActionGroup;
|
|
15
21
|
export declare class ABAC<TResources extends ResourceMap> {
|
|
16
22
|
private _resourceMap;
|
|
17
23
|
private _policies;
|
|
@@ -21,6 +27,7 @@ export declare class ABAC<TResources extends ResourceMap> {
|
|
|
21
27
|
$configurableActions: FilterActionPaths<TResources, any, true>;
|
|
22
28
|
$filterActions: <TCtx>() => FilterActionPaths<TResources, TCtx>;
|
|
23
29
|
getConfigurableActions(): ConfigurableAction[];
|
|
30
|
+
getConfigurableActionsTree(): ConfigurableActionTreeNode[];
|
|
24
31
|
can<TActionPath extends ActionPaths<TResources>>(subject: InferActionSubject<ActionFromPath<TResources, TActionPath>>, path: TActionPath, options?: PermissionOptions<TActionPath, ActionFromPath<TResources, TActionPath>>): Omit<Permission<TActionPath, ActionFromPath<TResources, TActionPath>>, "granted" | "filter"> & (import("./internal/core.js").IsOnlyEmptyObject<Omit<import("./action.js").InferActionRuleCtx<ActionFromPath<TResources, TActionPath>>, "subject">> extends true ? {
|
|
25
32
|
granted(): boolean;
|
|
26
33
|
test(): {
|
|
@@ -70,3 +77,4 @@ export declare class ABAC<TResources extends ResourceMap> {
|
|
|
70
77
|
static createPolicy<TResources extends ResourceMap>(): Policy<TResources>;
|
|
71
78
|
static Filter: typeof PolicyFilters;
|
|
72
79
|
}
|
|
80
|
+
export {};
|
package/build/abac.js
CHANGED
|
@@ -26,6 +26,41 @@ export class ABAC {
|
|
|
26
26
|
});
|
|
27
27
|
return actions;
|
|
28
28
|
}
|
|
29
|
+
getConfigurableActionsTree() {
|
|
30
|
+
const nodeMap = new Map();
|
|
31
|
+
const root = {
|
|
32
|
+
children: []
|
|
33
|
+
};
|
|
34
|
+
nodeMap.set("", root);
|
|
35
|
+
const visitor = new ActionVisitor(this._resourceMap);
|
|
36
|
+
visitor.traverse(({ action, resource, path, stack }) => {
|
|
37
|
+
if (!action.configurable) {
|
|
38
|
+
return;
|
|
39
|
+
}
|
|
40
|
+
let parent = root;
|
|
41
|
+
if (stack.length) {
|
|
42
|
+
let stackPath = "";
|
|
43
|
+
for (const item of stack) {
|
|
44
|
+
stackPath = `${stackPath}.${item.name}`;
|
|
45
|
+
if (!nodeMap.has(stackPath)) {
|
|
46
|
+
const node = {
|
|
47
|
+
meta: item,
|
|
48
|
+
children: []
|
|
49
|
+
};
|
|
50
|
+
parent.children.push(node);
|
|
51
|
+
nodeMap.set(stackPath, node);
|
|
52
|
+
}
|
|
53
|
+
parent = nodeMap.get(stackPath);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
parent.children.push({
|
|
57
|
+
path,
|
|
58
|
+
action,
|
|
59
|
+
own: resource.ownable && resource.ownConfigurable && !action.noObject
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
return root.children;
|
|
63
|
+
}
|
|
29
64
|
can(subject, path, options) {
|
|
30
65
|
const policies = this._policies.filter((policy) => policy.match({ subject }));
|
|
31
66
|
const visitor = new ActionVisitor(this._resourceMap);
|
package/build/abac.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"abac.js","sourceRoot":"","sources":["../src/abac.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAyC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"abac.js","sourceRoot":"","sources":["../src/abac.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAyC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAKnD,OAAO,EAAE,UAAU,EAA0B,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAezC,MAAM,OAAO,IAAI;IACR,YAAY,CAAa;IACzB,SAAS,GAAyB,EAAE,CAAC;IAE7C,YAAY,WAAuB;QAClC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACjC,CAAC;IAOM,sBAAsB;QAC5B,MAAM,OAAO,GAAyB,EAAE,CAAC;QAEzC,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrD,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;YAC/C,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC1B,OAAO;YACR,CAAC;YAED,OAAO,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ,MAAM;gBACN,GAAG,EAAE,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,QAAQ;aACrE,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IAChB,CAAC;IAEM,0BAA0B;QAChC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmC,CAAC;QAC3D,MAAM,IAAI,GAAG;YACZ,QAAQ,EAAE,EAAE;SAC0B,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAEtB,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrD,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YACtD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;gBAC1B,OAAO;YACR,CAAC;YAED,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBAClB,IAAI,SAAS,GAAG,EAAE,CAAC;gBACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBAC1B,SAAS,GAAG,GAAG,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACxC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC7B,MAAM,IAAI,GAAG;4BACZ,IAAI,EAAE,IAAI;4BACV,QAAQ,EAAE,EAAE;yBACZ,CAAC;wBACF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;wBAC3B,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;oBAC9B,CAAC;oBAED,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gBAClC,CAAC;YACF,CAAC;YAED,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACpB,IAAI;gBACJ,MAAM;gBACN,GAAG,EAAE,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,MAAM,CAAC,QAAQ;aACrE,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAEM,GAAG,CACT,OAAoE,EACpE,IAAiB,EACjB,OAAiF;QAEjF,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAE9E,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAErD,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpE,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,UAAyB,CAAC,CAAC;QAC7D,IAAI,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,cAAc,UAAU,8BAA8B,CAAC,CAAC;QACzE,CAAC;QAED,OAAO,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAEM,SAAS,CAAC,KAAyD;QACzE,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,MAAM,CAAuC,SAAsB;QAChF,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CACnC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;YACnB,GAAG,GAAG;YACN,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ;SACzB,CAAC,EACF,EAAmC,CACnC,CAAC;QAEF,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IAC9B,CAAC;IAEM,MAAM,CAAC,cAAc,CAAuB,IAAW;QAC7D,OAAO,IAAI,QAAQ,CAWjB,IAAI,CAAC,CAAC;IACT,CAAC;IAEM,MAAM,CAAC,YAAY,CAGxB,IAAW;QACZ,OAAO,IAAI,MAAM,CAA4C,IAAI,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAG7B,IAAW;QACZ,OAAO,IAAI,WAAW,CAMpB,IAAI,CAAC,CAAC;IACT,CAAC;IAEM,MAAM,CAAC,YAAY;QACzB,OAAO,IAAI,MAAM,EAAc,CAAC;IACjC,CAAC;IAEM,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC","sourcesContent":["import { Action, type RuleCtx, type InferActionSubject } from \"./action.js\";\nimport { ActionGroup } from \"./actionGroup.js\";\nimport { ActionVisitor } from \"./actionVisitor.js\";\nimport type { ResourceMap, UnionToResourceMap } from \"./internal/collections.js\";\nimport type { UnsetMarker } from \"./internal/core.js\";\nimport type { IMeta } from \"./internal/meta.js\";\nimport type { ActionFromPath, ActionPaths, FilterActionPaths } from \"./internal/paths.js\";\nimport { Permission, type PermissionOptions } from \"./permission.js\";\nimport { Policy } from \"./policy.js\";\nimport { PolicyFilters } from \"./policyFilters.js\";\nimport { Resource } from \"./resource.js\";\n\nexport type ConfigurableAction = {\n\tpath: string;\n\taction: Action<any, any>;\n\town: boolean;\n};\n\ntype ConfigurableActionGroup = {\n\tmeta: IMeta;\n\tchildren: ConfigurableActionTreeNode[];\n};\n\nexport type ConfigurableActionTreeNode = ConfigurableAction | ConfigurableActionGroup;\n\nexport class ABAC<TResources extends ResourceMap> {\n\tprivate _resourceMap: TResources;\n\tprivate _policies: Policy<TResources>[] = [];\n\n\tconstructor(resourceMap: TResources) {\n\t\tthis._resourceMap = resourceMap;\n\t}\n\n\tdeclare public $resources: TResources;\n\tdeclare public $actions: ActionPaths<TResources>;\n\tdeclare public $configurableActions: FilterActionPaths<TResources, any, true>;\n\tdeclare public $filterActions: <TCtx>() => FilterActionPaths<TResources, TCtx>;\n\n\tpublic getConfigurableActions() {\n\t\tconst actions: ConfigurableAction[] = [];\n\n\t\tconst visitor = new ActionVisitor(this._resourceMap);\n\t\tvisitor.traverse(({ action, resource, path }) => {\n\t\t\tif (!action.configurable) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tactions.push({\n\t\t\t\tpath,\n\t\t\t\taction,\n\t\t\t\town: resource.ownable && resource.ownConfigurable && !action.noObject\n\t\t\t});\n\t\t});\n\n\t\treturn actions;\n\t}\n\n\tpublic getConfigurableActionsTree() {\n\t\tconst nodeMap = new Map<string, ConfigurableActionGroup>();\n\t\tconst root = {\n\t\t\tchildren: []\n\t\t} as unknown as ConfigurableActionGroup;\n\t\tnodeMap.set(\"\", root);\n\n\t\tconst visitor = new ActionVisitor(this._resourceMap);\n\t\tvisitor.traverse(({ action, resource, path, stack }) => {\n\t\t\tif (!action.configurable) {\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tlet parent = root;\n\t\t\tif (stack.length) {\n\t\t\t\tlet stackPath = \"\";\n\t\t\t\tfor (const item of stack) {\n\t\t\t\t\tstackPath = `${stackPath}.${item.name}`;\n\t\t\t\t\tif (!nodeMap.has(stackPath)) {\n\t\t\t\t\t\tconst node = {\n\t\t\t\t\t\t\tmeta: item,\n\t\t\t\t\t\t\tchildren: []\n\t\t\t\t\t\t};\n\t\t\t\t\t\tparent.children.push(node);\n\t\t\t\t\t\tnodeMap.set(stackPath, node);\n\t\t\t\t\t}\n\n\t\t\t\t\tparent = nodeMap.get(stackPath)!;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tparent.children.push({\n\t\t\t\tpath,\n\t\t\t\taction,\n\t\t\t\town: resource.ownable && resource.ownConfigurable && !action.noObject\n\t\t\t});\n\t\t});\n\n\t\treturn root.children;\n\t}\n\n\tpublic can<TActionPath extends ActionPaths<TResources>>(\n\t\tsubject: InferActionSubject<ActionFromPath<TResources, TActionPath>>,\n\t\tpath: TActionPath,\n\t\toptions?: PermissionOptions<TActionPath, ActionFromPath<TResources, TActionPath>>\n\t) {\n\t\tconst policies = this._policies.filter((policy) => policy.match({ subject }));\n\n\t\tconst visitor = new ActionVisitor(this._resourceMap);\n\n\t\tconst actionPath = path.endsWith(\".own\") ? path.slice(0, -4) : path;\n\t\tconst result = visitor.findByPath(actionPath as TActionPath);\n\t\tif (!result) {\n\t\t\tthrow new Error(`No action '${actionPath}' found in ABAC resource map`);\n\t\t}\n\n\t\treturn Permission.create(subject, path, result.resource, result.action, policies, options);\n\t}\n\n\tpublic addPolicy(build: (policy: Policy<TResources>) => Policy<TResources>) {\n\t\tconst policy = build(ABAC.createPolicy());\n\t\tthis._policies.push(policy);\n\t\treturn this;\n\t}\n\n\tpublic static create<TResource extends Resource<any, any>>(resources: TResource[]) {\n\t\tconst resourceMap = resources.reduce(\n\t\t\t(map, resource) => ({\n\t\t\t\t...map,\n\t\t\t\t[resource.name]: resource\n\t\t\t}),\n\t\t\t{} as UnionToResourceMap<TResource>\n\t\t);\n\n\t\treturn new ABAC(resourceMap);\n\t}\n\n\tpublic static createResource<TName extends string>(name: TName) {\n\t\treturn new Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: {\n\t\t\t\t\tsubject: UnsetMarker;\n\t\t\t\t\tobject: UnsetMarker;\n\t\t\t\t};\n\t\t\t\tactions: UnsetMarker;\n\t\t\t\tsubResources: UnsetMarker;\n\t\t\t\townable: false;\n\t\t\t}\n\t\t>(name);\n\t}\n\n\tpublic static createAction<\n\t\tTName extends string,\n\t\tTCtx extends RuleCtx = { subject: UnsetMarker; object: UnsetMarker }\n\t>(name: TName) {\n\t\treturn new Action<TName, { ctx: TCtx; configurable: false }>(name);\n\t}\n\n\tpublic static createActionGroup<\n\t\tTName extends string,\n\t\tTCtx extends RuleCtx = { subject: UnsetMarker; object: UnsetMarker }\n\t>(name: TName) {\n\t\treturn new ActionGroup<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TCtx;\n\t\t\t\tactions: UnsetMarker;\n\t\t\t}\n\t\t>(name);\n\t}\n\n\tpublic static createPolicy<TResources extends ResourceMap>() {\n\t\treturn new Policy<TResources>();\n\t}\n\n\tpublic static Filter = PolicyFilters;\n}\n"]}
|
package/build/action.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { MakeOptional } from "./internal/core.js";
|
|
2
|
+
import type { IMeta } from "./internal/meta.js";
|
|
2
3
|
export type RuleCtx = {
|
|
3
4
|
subject: any;
|
|
4
5
|
object: any;
|
|
@@ -11,7 +12,7 @@ export type InferActionRuleCtx<TAction> = TAction extends Action<any, infer TCon
|
|
|
11
12
|
export type InferActionSubject<TAction> = Pick<InferActionRuleCtx<TAction>, "subject">["subject"];
|
|
12
13
|
export type InferActionObject<TAction> = Exclude<Pick<InferActionRuleCtx<TAction>, "object">["object"], void | undefined>;
|
|
13
14
|
export type InferActionAdditionalContext<TAction> = Omit<InferActionRuleCtx<TAction>, "subject" | "object">;
|
|
14
|
-
export declare class Action<TName extends string, TContext extends ActionContext> {
|
|
15
|
+
export declare class Action<TName extends string, TContext extends ActionContext> implements IMeta {
|
|
15
16
|
private _name;
|
|
16
17
|
private _title;
|
|
17
18
|
private _description;
|
package/build/action.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.js","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"action.js","sourceRoot":"","sources":["../src/action.ts"],"names":[],"mappings":"AA4BA,MAAM,OAAO,MAAM;IACV,KAAK,CAAQ;IACb,MAAM,GAAkB,IAAI,CAAC;IAC7B,YAAY,GAAkB,IAAI,CAAC;IACnC,aAAa,GAAY,KAAK,CAAC;IAC/B,SAAS,GAAY,KAAK,CAAC;IAEnC,YAAY,IAAW;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAEM,cAAc,CAAC,WAAmB;QACxC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAEM,eAAe,CAAgC,YAA2B;QAChF,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,OAAO,IAMN,CAAC;IACH,CAAC;IAEM,WAAW;QACjB,OAAO,IASN,CAAC;IACH,CAAC;IAEM,UAAU;QAChB,OAAO,IASN,CAAC;IACH,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAEM,aAAa;QACnB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,EAAQ,CAAC;IAChC,CAAC;IAEM,cAAc;QACpB,OAAO,IAAI,CAAC,UAAU,EAA2C,CAAC;IACnE,CAAC;IAEM,qBAAqB;QAC3B,OAAO,IAA+D,CAAC;IACxE,CAAC;CACD","sourcesContent":["import type { MakeOptional } from \"./internal/core.js\";\nimport type { IMeta } from \"./internal/meta.js\";\n\nexport type RuleCtx = {\n\tsubject: any;\n\tobject: any;\n};\n\nexport type ActionContext = {\n\tctx: RuleCtx;\n\tconfigurable: boolean;\n};\n\nexport type InferActionRuleCtx<TAction> =\n\tTAction extends Action<any, infer TContext> ? TContext[\"ctx\"] : never;\n\nexport type InferActionSubject<TAction> = Pick<InferActionRuleCtx<TAction>, \"subject\">[\"subject\"];\n\nexport type InferActionObject<TAction> = Exclude<\n\tPick<InferActionRuleCtx<TAction>, \"object\">[\"object\"],\n\tvoid | undefined\n>;\n\nexport type InferActionAdditionalContext<TAction> = Omit<\n\tInferActionRuleCtx<TAction>,\n\t\"subject\" | \"object\"\n>;\n\nexport class Action<TName extends string, TContext extends ActionContext> implements IMeta {\n\tprivate _name: TName;\n\tprivate _title: string | null = null;\n\tprivate _description: string | null = null;\n\tprivate _configurable: boolean = false;\n\tprivate _noObject: boolean = false;\n\n\tconstructor(name: TName) {\n\t\tthis._name = name;\n\t}\n\n\tpublic get name(): TName {\n\t\treturn this._name;\n\t}\n\n\tpublic get title(): string | null {\n\t\treturn this._title;\n\t}\n\n\tpublic setTitle(title: string) {\n\t\tthis._title = title;\n\t\treturn this;\n\t}\n\n\tpublic get description(): string | null {\n\t\treturn this._description;\n\t}\n\n\tpublic setDescription(description: string) {\n\t\tthis._description = description;\n\t\treturn this;\n\t}\n\n\tpublic get configurable(): boolean {\n\t\treturn this._configurable;\n\t}\n\n\tpublic setConfigurable<TConfigurable extends boolean>(configurable: TConfigurable) {\n\t\tthis._configurable = configurable;\n\t\treturn this as Action<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"];\n\t\t\t\tconfigurable: TConfigurable;\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withSubject<TOverrideSubject>() {\n\t\treturn this as Action<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: {\n\t\t\t\t\tsubject: TOverrideSubject;\n\t\t\t\t\tobject: TContext[\"ctx\"][\"object\"];\n\t\t\t\t};\n\t\t\t\tconfigurable: TContext[\"configurable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withObject<TOverrideObject>() {\n\t\treturn this as Action<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: {\n\t\t\t\t\tsubject: TContext[\"ctx\"][\"subject\"];\n\t\t\t\t\tobject: TOverrideObject;\n\t\t\t\t};\n\t\t\t\tconfigurable: TContext[\"configurable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic get noObject() {\n\t\treturn this._noObject;\n\t}\n\n\tpublic withoutObject() {\n\t\tthis._noObject = true;\n\t\treturn this.withObject<void>();\n\t}\n\n\tpublic optionalObject() {\n\t\treturn this.withObject<MakeOptional<TContext[\"ctx\"][\"object\"]>>();\n\t}\n\n\tpublic withAdditionalContext<TAdditionalContext extends object>() {\n\t\treturn this as unknown as Action<TName, TContext & TAdditionalContext>;\n\t}\n}\n"]}
|
package/build/actionGroup.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { type Action, type RuleCtx } from "./action.js";
|
|
2
2
|
import type { ActionMap, ToActionMap } from "./internal/collections.js";
|
|
3
3
|
import type { Expand, UnsetMarker } from "./internal/core.js";
|
|
4
|
+
import type { IMeta } from "./internal/meta.js";
|
|
4
5
|
export type ActionGroupContext = {
|
|
5
6
|
ctx: RuleCtx;
|
|
6
7
|
actions: ActionMap | UnsetMarker;
|
|
@@ -9,7 +10,7 @@ export type AnyActionGroupContext = {
|
|
|
9
10
|
ctx: RuleCtx;
|
|
10
11
|
actions: ActionMap;
|
|
11
12
|
};
|
|
12
|
-
export declare class ActionGroup<TName extends string, TContext extends ActionGroupContext = AnyActionGroupContext> {
|
|
13
|
+
export declare class ActionGroup<TName extends string, TContext extends ActionGroupContext = AnyActionGroupContext> implements IMeta {
|
|
13
14
|
private _name;
|
|
14
15
|
private _title;
|
|
15
16
|
private _description;
|
package/build/actionGroup.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actionGroup.js","sourceRoot":"","sources":["../src/actionGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"actionGroup.js","sourceRoot":"","sources":["../src/actionGroup.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,aAAa,CAAC;AAexD,MAAM,OAAO,WAAW;IAKf,KAAK,CAAQ;IACb,MAAM,GAAkB,IAAI,CAAC;IAC7B,YAAY,GAAkB,IAAI,CAAC;IACnC,QAAQ,GAAwB,EAAyB,CAAC;IAElE,YAAY,IAAW;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAEM,cAAc,CAAC,WAAmB;QACxC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,WAAW;QACjB,OAAO,IAUN,CAAC;IACH,CAAC;IAEM,UAAU;QAChB,OAAO,IAUN,CAAC;IACH,CAAC;IAEM,qBAAqB;QAC3B,OAAO,IAMN,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAEM,UAAU,CAChB,OAAmB;QAEnB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YACjB,GAAG,GAAG;YACN,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM;SACrB,CAAC,EACF,EAAE,CACF,CAAC;QACF,OAAO,IAMN,CAAC;IACH,CAAC;CACD","sourcesContent":["import { type Action, type RuleCtx } from \"./action.js\";\nimport type { ActionMap, ToActionMap } from \"./internal/collections.js\";\nimport type { Expand, UnsetMarker } from \"./internal/core.js\";\nimport type { IMeta } from \"./internal/meta.js\";\n\nexport type ActionGroupContext = {\n\tctx: RuleCtx;\n\tactions: ActionMap | UnsetMarker;\n};\n\nexport type AnyActionGroupContext = {\n\tctx: RuleCtx;\n\tactions: ActionMap;\n};\n\nexport class ActionGroup<\n\tTName extends string,\n\tTContext extends ActionGroupContext = AnyActionGroupContext\n> implements IMeta\n{\n\tprivate _name: TName;\n\tprivate _title: string | null = null;\n\tprivate _description: string | null = null;\n\tprivate _actions: TContext[\"actions\"] = {} as TContext[\"actions\"];\n\n\tconstructor(name: TName) {\n\t\tthis._name = name;\n\t}\n\n\tpublic get name(): TName {\n\t\treturn this._name;\n\t}\n\n\tpublic get title(): string | null {\n\t\treturn this._title;\n\t}\n\n\tpublic setTitle(title: string) {\n\t\tthis._title = title;\n\t\treturn this;\n\t}\n\n\tpublic get description(): string | null {\n\t\treturn this._description;\n\t}\n\n\tpublic setDescription(description: string) {\n\t\tthis._description = description;\n\t\treturn this;\n\t}\n\n\tpublic withSubject<TSubject>() {\n\t\treturn this as unknown as ActionGroup<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: Expand<\n\t\t\t\t\tOmit<TContext[\"ctx\"], \"subject\"> & {\n\t\t\t\t\t\tsubject: TSubject;\n\t\t\t\t\t}\n\t\t\t\t>;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withObject<TObject>() {\n\t\treturn this as unknown as ActionGroup<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: Expand<\n\t\t\t\t\tOmit<TContext[\"ctx\"], \"object\"> & {\n\t\t\t\t\t\tobject: TObject;\n\t\t\t\t\t}\n\t\t\t\t>;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withAdditionalContext<TAdditionalContext extends object>() {\n\t\treturn this as unknown as ActionGroup<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"] & TAdditionalContext;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tget actions(): TContext[\"actions\"] {\n\t\treturn this._actions;\n\t}\n\n\tpublic setActions<TActions extends Action<any, any> | ActionGroup<any, any>>(\n\t\tactions: TActions[]\n\t) {\n\t\tthis._actions = actions.reduce(\n\t\t\t(acc, action) => ({\n\t\t\t\t...acc,\n\t\t\t\t[action.name]: action\n\t\t\t}),\n\t\t\t{}\n\t\t);\n\t\treturn this as unknown as ActionGroup<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"];\n\t\t\t\tactions: Expand<ToActionMap<TActions>>;\n\t\t\t}\n\t\t>;\n\t}\n}\n"]}
|
package/build/actionVisitor.d.ts
CHANGED
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { Action } from "./action.js";
|
|
2
|
+
import type { ActionGroup } from "./actionGroup.js";
|
|
2
3
|
import type { ResourceMap } from "./internal/collections.js";
|
|
3
4
|
import type { ActionFromPath, ActionPaths } from "./internal/paths.js";
|
|
4
5
|
import type { Resource } from "./resource.js";
|
|
5
|
-
type
|
|
6
|
+
type TraverseContext = {
|
|
7
|
+
stack: (Resource<any, any> | ActionGroup<any, any>)[];
|
|
8
|
+
path: string;
|
|
9
|
+
};
|
|
10
|
+
type VisitContext = Readonly<TraverseContext> & {
|
|
6
11
|
action: Action<any, any>;
|
|
7
12
|
resource: Resource<any, any>;
|
|
8
|
-
path: string;
|
|
9
13
|
};
|
|
10
14
|
type Predicate = (ctx: VisitContext) => boolean;
|
|
11
15
|
type Visit = (ctx: VisitContext) => void;
|
package/build/actionVisitor.js
CHANGED
|
@@ -27,36 +27,45 @@ export class ActionVisitor {
|
|
|
27
27
|
start(callback) {
|
|
28
28
|
this.stop = false;
|
|
29
29
|
this.callback = callback;
|
|
30
|
-
this.traverseResources(this.resources
|
|
30
|
+
this.traverseResources(this.resources, {
|
|
31
|
+
stack: [],
|
|
32
|
+
path: ""
|
|
33
|
+
});
|
|
31
34
|
}
|
|
32
|
-
traverseResources(resources,
|
|
35
|
+
traverseResources(resources, ctx) {
|
|
33
36
|
for (const [name, resource] of Object.entries(resources)) {
|
|
34
37
|
if (this.stop) {
|
|
35
38
|
break;
|
|
36
39
|
}
|
|
37
|
-
this.traverseResource(resource,
|
|
40
|
+
this.traverseResource(resource, {
|
|
41
|
+
stack: [...ctx.stack, resource],
|
|
42
|
+
path: ctx.path ? `${ctx.path}.${name}` : name
|
|
43
|
+
});
|
|
38
44
|
}
|
|
39
45
|
}
|
|
40
|
-
traverseResource(resource,
|
|
41
|
-
this.traverseActions(resource, resource.actions,
|
|
42
|
-
this.traverseResources(resource.subResources,
|
|
46
|
+
traverseResource(resource, ctx) {
|
|
47
|
+
this.traverseActions(resource, resource.actions, ctx);
|
|
48
|
+
this.traverseResources(resource.subResources, ctx);
|
|
43
49
|
}
|
|
44
|
-
traverseActions(resource, actions,
|
|
50
|
+
traverseActions(resource, actions, ctx) {
|
|
45
51
|
for (const [name, action] of Object.entries(actions)) {
|
|
46
52
|
if (this.stop) {
|
|
47
53
|
break;
|
|
48
54
|
}
|
|
49
55
|
if (action instanceof Action) {
|
|
50
|
-
const
|
|
51
|
-
this.lastVisited =
|
|
52
|
-
const stop = this.callback(
|
|
56
|
+
const visited = { ...ctx, action, resource, path: `${ctx.path}:${name}` };
|
|
57
|
+
this.lastVisited = visited;
|
|
58
|
+
const stop = this.callback(visited);
|
|
53
59
|
if (stop) {
|
|
54
60
|
this.stop = true;
|
|
55
61
|
break;
|
|
56
62
|
}
|
|
57
63
|
}
|
|
58
64
|
else {
|
|
59
|
-
this.traverseActions(resource, action.actions,
|
|
65
|
+
this.traverseActions(resource, action.actions, {
|
|
66
|
+
stack: [...ctx.stack, action],
|
|
67
|
+
path: `${ctx.path}.${name}`
|
|
68
|
+
});
|
|
60
69
|
}
|
|
61
70
|
}
|
|
62
71
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"actionVisitor.js","sourceRoot":"","sources":["../src/actionVisitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"actionVisitor.js","sourceRoot":"","sources":["../src/actionVisitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAmBrC,MAAM,OAAO,aAAa;IACjB,SAAS,CAAa;IACtB,QAAQ,GAAa,GAAG,EAAE,GAAE,CAAC,CAAC;IAC9B,WAAW,GAAwB,IAAI,CAAC;IACxC,IAAI,GAAY,KAAK,CAAC;IAE9B,YAAY,SAAqB;QAChC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,IAAI,CAAC,SAAoB;QAC/B,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5C,CAAC;IAEM,UAAU,CAA8C,IAAiB;QAC/E,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,GAAG,EAAE,CAAC;YACV,OAAO,IAAI,CAAC;QACb,CAAC;QAED,OAAO;YACN,QAAQ,EAAE,GAAG,CAAC,QAAQ;YACtB,MAAM,EAAE,GAAG,CAAC,MAAiD;SAC7D,CAAC;IACH,CAAC;IAEM,QAAQ,CAAC,KAAY;QAC3B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,QAAkB;QAC/B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,EAAE;YACtC,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,EAAE;SACR,CAAC,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,SAAsB,EAAE,GAAoB;QACrE,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1D,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM;YACP,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC;gBAC/B,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;aAC7C,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAEO,gBAAgB,CAAC,QAA4B,EAAE,GAAoB;QAC1E,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IACpD,CAAC;IAEO,eAAe,CAAC,QAA4B,EAAE,OAAkB,EAAE,GAAoB;QAC7F,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACtD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACf,MAAM;YACP,CAAC;YAED,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;gBAC9B,MAAM,OAAO,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;gBAC1E,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;gBAE3B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpC,IAAI,IAAI,EAAE,CAAC;oBACV,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;oBACjB,MAAM;gBACP,CAAC;YACF,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE;oBAC9C,KAAK,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;oBAC7B,IAAI,EAAE,GAAG,GAAG,CAAC,IAAI,IAAI,IAAI,EAAE;iBAC3B,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC;CACD","sourcesContent":["import { Action } from \"./action.js\";\nimport type { ActionGroup } from \"./actionGroup.js\";\nimport type { ActionMap, ResourceMap } from \"./internal/collections.js\";\nimport type { ActionFromPath, ActionPaths } from \"./internal/paths.js\";\nimport type { Resource } from \"./resource.js\";\n\ntype TraverseContext = { stack: (Resource<any, any> | ActionGroup<any, any>)[]; path: string };\n\ntype VisitContext = Readonly<TraverseContext> & {\n\taction: Action<any, any>;\n\tresource: Resource<any, any>;\n};\n\ntype Callback = (ctx: VisitContext) => any;\n\ntype Predicate = (ctx: VisitContext) => boolean;\n\ntype Visit = (ctx: VisitContext) => void;\n\nexport class ActionVisitor<TResources extends ResourceMap> {\n\tprivate resources: TResources;\n\tprivate callback: Callback = () => {};\n\tprivate lastVisited: VisitContext | null = null;\n\tprivate stop: boolean = false;\n\n\tconstructor(resources: TResources) {\n\t\tthis.resources = resources;\n\t}\n\n\tpublic find(predicate: Predicate) {\n\t\tthis.start(predicate);\n\n\t\treturn this.stop ? this.lastVisited : null;\n\t}\n\n\tpublic findByPath<TActionPath extends ActionPaths<TResources>>(path: TActionPath) {\n\t\tconst ctx = this.find(({ path: ctxPath }) => path === ctxPath);\n\t\tif (!ctx) {\n\t\t\treturn null;\n\t\t}\n\n\t\treturn {\n\t\t\tresource: ctx.resource,\n\t\t\taction: ctx.action as ActionFromPath<TResources, TActionPath>\n\t\t};\n\t}\n\n\tpublic traverse(visit: Visit) {\n\t\tthis.start(visit);\n\t}\n\n\tprivate start(callback: Callback) {\n\t\tthis.stop = false;\n\t\tthis.callback = callback;\n\n\t\tthis.traverseResources(this.resources, {\n\t\t\tstack: [],\n\t\t\tpath: \"\"\n\t\t});\n\t}\n\n\tprivate traverseResources(resources: ResourceMap, ctx: TraverseContext) {\n\t\tfor (const [name, resource] of Object.entries(resources)) {\n\t\t\tif (this.stop) {\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tthis.traverseResource(resource, {\n\t\t\t\tstack: [...ctx.stack, resource],\n\t\t\t\tpath: ctx.path ? `${ctx.path}.${name}` : name\n\t\t\t});\n\t\t}\n\t}\n\n\tprivate traverseResource(resource: Resource<any, any>, ctx: TraverseContext) {\n\t\tthis.traverseActions(resource, resource.actions, ctx);\n\t\tthis.traverseResources(resource.subResources, ctx);\n\t}\n\n\tprivate traverseActions(resource: Resource<any, any>, actions: ActionMap, ctx: TraverseContext) {\n\t\tfor (const [name, action] of Object.entries(actions)) {\n\t\t\tif (this.stop) {\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tif (action instanceof Action) {\n\t\t\t\tconst visited = { ...ctx, action, resource, path: `${ctx.path}:${name}` };\n\t\t\t\tthis.lastVisited = visited;\n\n\t\t\t\tconst stop = this.callback(visited);\n\t\t\t\tif (stop) {\n\t\t\t\t\tthis.stop = true;\n\t\t\t\t\tbreak;\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tthis.traverseActions(resource, action.actions, {\n\t\t\t\t\tstack: [...ctx.stack, action],\n\t\t\t\t\tpath: `${ctx.path}.${name}`\n\t\t\t\t});\n\t\t\t}\n\t\t}\n\t}\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../src/internal/meta.ts"],"names":[],"mappings":"","sourcesContent":["export interface IMeta {\n\tname: string;\n\ttitle: string | null;\n\tdescription: string | null;\n\n\tsetTitle(title: string): this;\n\tsetDescription(description: string): this;\n}\n"]}
|
package/build/resource.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { type Action, type RuleCtx } from "./action.js";
|
|
|
2
2
|
import type { ActionGroup } from "./actionGroup.js";
|
|
3
3
|
import type { ActionMap, ResourceMap, ToActionMap, UnionToResourceMap } from "./internal/collections.js";
|
|
4
4
|
import type { Expand, UnsetMarker } from "./internal/core.js";
|
|
5
|
+
import type { IMeta } from "./internal/meta.js";
|
|
5
6
|
export type ResourceContext = {
|
|
6
7
|
ctx: RuleCtx;
|
|
7
8
|
actions: ActionMap | UnsetMarker;
|
|
@@ -14,7 +15,7 @@ export type AnyResourceContext = {
|
|
|
14
15
|
subResources: ResourceMap;
|
|
15
16
|
ownable: boolean;
|
|
16
17
|
};
|
|
17
|
-
export declare class Resource<TName extends string, TContext extends ResourceContext = AnyResourceContext> {
|
|
18
|
+
export declare class Resource<TName extends string, TContext extends ResourceContext = AnyResourceContext> implements IMeta {
|
|
18
19
|
private _name;
|
|
19
20
|
private _title;
|
|
20
21
|
private _description;
|
package/build/resource.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,MAAM,aAAa,CAAC;AAyBxD,MAAM,OAAO,QAAQ;IAGZ,KAAK,CAAQ;IACb,MAAM,GAAkB,IAAI,CAAC;IAC7B,YAAY,GAAkB,IAAI,CAAC;IACnC,QAAQ,GAAwB,KAAK,CAAC;IACtC,gBAAgB,GAAY,KAAK,CAAC;IAClC,QAAQ,GAAwB,EAAyB,CAAC;IAC1D,aAAa,GAA6B,EAA8B,CAAC;IAEjF,YAAY,IAAW;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,WAAW;QACrB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IAEM,cAAc,CAAC,WAAmB;QACxC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,IAAW,eAAe;QACzB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;IAEM,UAAU,CAA2B,OAAiB,EAAE,YAAY,GAAG,IAAI;QACjF,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,YAAY,CAAC;QACrC,OAAO,IAQN,CAAC;IACH,CAAC;IAEM,WAAW;QACjB,OAAO,IAYN,CAAC;IACH,CAAC;IAEM,UAAU;QAChB,OAAO,IAYN,CAAC;IACH,CAAC;IAEM,qBAAqB;QAC3B,OAAO,IAQN,CAAC;IACH,CAAC;IAED,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAEM,UAAU,CAChB,OAAmB;QAEnB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAC7B,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YACjB,GAAG,GAAG;YACN,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM;SACrB,CAAC,EACF,EAAE,CACF,CAAC;QACF,OAAO,IAQN,CAAC;IACH,CAAC;IAED,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAEM,eAAe,CAAwC,SAAuB;QACpF,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,MAAM,CACpC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;YACnB,GAAG,GAAG;YACN,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ;SACzB,CAAC,EACF,EAAE,CACF,CAAC;QACF,OAAO,IAQN,CAAC;IACH,CAAC;CACD","sourcesContent":["import { type Action, type RuleCtx } from \"./action.js\";\nimport type { ActionGroup } from \"./actionGroup.js\";\nimport type {\n\tActionMap,\n\tResourceMap,\n\tToActionMap,\n\tUnionToResourceMap\n} from \"./internal/collections.js\";\nimport type { Expand, UnsetMarker } from \"./internal/core.js\";\nimport type { IMeta } from \"./internal/meta.js\";\n\nexport type ResourceContext = {\n\tctx: RuleCtx;\n\tactions: ActionMap | UnsetMarker;\n\tsubResources: ResourceMap | UnsetMarker;\n\townable: boolean;\n};\n\nexport type AnyResourceContext = {\n\tctx: RuleCtx;\n\tactions: ActionMap;\n\tsubResources: ResourceMap;\n\townable: boolean;\n};\n\nexport class Resource<TName extends string, TContext extends ResourceContext = AnyResourceContext>\n\timplements IMeta\n{\n\tprivate _name: TName;\n\tprivate _title: string | null = null;\n\tprivate _description: string | null = null;\n\tprivate _ownable: TContext[\"ownable\"] = false;\n\tprivate _ownConfigurable: boolean = false;\n\tprivate _actions: TContext[\"actions\"] = {} as TContext[\"actions\"];\n\tprivate _subResources: TContext[\"subResources\"] = {} as TContext[\"subResources\"];\n\n\tconstructor(name: TName) {\n\t\tthis._name = name;\n\t}\n\n\tpublic get name(): TName {\n\t\treturn this._name;\n\t}\n\n\tpublic get title(): string | null {\n\t\treturn this._title;\n\t}\n\n\tpublic setTitle(title: string) {\n\t\tthis._title = title;\n\t\treturn this;\n\t}\n\n\tpublic get description(): string | null {\n\t\treturn this._description;\n\t}\n\n\tpublic setDescription(description: string) {\n\t\tthis._description = description;\n\t\treturn this;\n\t}\n\n\tpublic get ownable(): boolean {\n\t\treturn this._ownable;\n\t}\n\n\tpublic get ownConfigurable(): boolean {\n\t\treturn this._ownConfigurable;\n\t}\n\n\tpublic setOwnable<TOwnable extends boolean>(ownable: TOwnable, configurable = true) {\n\t\tthis._ownable = ownable;\n\t\tthis._ownConfigurable = configurable;\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"];\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t\tsubResources: TContext[\"subResources\"];\n\t\t\t\townable: TOwnable;\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withSubject<TSubject>() {\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: Expand<\n\t\t\t\t\tOmit<TContext[\"ctx\"], \"subject\"> & {\n\t\t\t\t\t\tsubject: TSubject;\n\t\t\t\t\t}\n\t\t\t\t>;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t\tsubResources: TContext[\"subResources\"];\n\t\t\t\townable: TContext[\"ownable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withObject<TObject>() {\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: Expand<\n\t\t\t\t\tOmit<TContext[\"ctx\"], \"object\"> & {\n\t\t\t\t\t\tobject: TObject;\n\t\t\t\t\t}\n\t\t\t\t>;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t\tsubResources: TContext[\"subResources\"];\n\t\t\t\townable: TContext[\"ownable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tpublic withAdditionalContext<TAdditionalContext extends object>() {\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"] & TAdditionalContext;\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t\tsubResources: TContext[\"subResources\"];\n\t\t\t\townable: TContext[\"ownable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tget actions(): TContext[\"actions\"] {\n\t\treturn this._actions;\n\t}\n\n\tpublic setActions<TActions extends Action<any, any> | ActionGroup<any, any>>(\n\t\tactions: TActions[]\n\t) {\n\t\tthis._actions = actions.reduce(\n\t\t\t(acc, action) => ({\n\t\t\t\t...acc,\n\t\t\t\t[action.name]: action\n\t\t\t}),\n\t\t\t{}\n\t\t);\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"];\n\t\t\t\tactions: Expand<ToActionMap<TActions>>;\n\t\t\t\tsubResources: TContext[\"subResources\"];\n\t\t\t\townable: TContext[\"ownable\"];\n\t\t\t}\n\t\t>;\n\t}\n\n\tget subResources(): TContext[\"subResources\"] {\n\t\treturn this._subResources;\n\t}\n\n\tpublic setSubResources<TResources extends Resource<any, any>>(resources: TResources[]) {\n\t\tthis._subResources = resources.reduce(\n\t\t\t(acc, resource) => ({\n\t\t\t\t...acc,\n\t\t\t\t[resource.name]: resource\n\t\t\t}),\n\t\t\t{}\n\t\t);\n\t\treturn this as unknown as Resource<\n\t\t\tTName,\n\t\t\t{\n\t\t\t\tctx: TContext[\"ctx\"];\n\t\t\t\tactions: TContext[\"actions\"];\n\t\t\t\tsubResources: Expand<UnionToResourceMap<TResources>>;\n\t\t\t\townable: TContext[\"ownable\"];\n\t\t\t}\n\t\t>;\n\t}\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@l3dev/abac",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Type-safe attribute-based access control library",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./build/index.js",
|
|
@@ -21,7 +21,11 @@
|
|
|
21
21
|
"type": "git",
|
|
22
22
|
"url": "https://github.com/l3dotdev/npm-packages.git"
|
|
23
23
|
},
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"vitest": "^4.0.15"
|
|
26
|
+
},
|
|
24
27
|
"scripts": {
|
|
28
|
+
"test": "vitest",
|
|
25
29
|
"build": "tsc -p tsconfig.json",
|
|
26
30
|
"package": "pnpm build"
|
|
27
31
|
}
|