@cullet/erp-core 1.2.0 → 1.4.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/KIT_CONTEXT.md +5 -3
- package/README.md +160 -0
- package/dist/abac/index.cjs +7 -0
- package/dist/abac/index.d.cts +2 -0
- package/dist/abac/index.d.ts +2 -0
- package/dist/abac/index.js +2 -0
- package/dist/app-error.cjs +193 -0
- package/dist/app-error.cjs.map +1 -0
- package/dist/app-error.d.cts +108 -0
- package/dist/app-error.js +170 -0
- package/dist/app-error.js.map +1 -0
- package/dist/application/index.cjs +27 -0
- package/dist/application/index.d.cts +3 -0
- package/dist/application/index.d.ts +2 -1
- package/dist/application/index.js +2 -1
- package/dist/authorization-error.cjs +157 -0
- package/dist/authorization-error.cjs.map +1 -0
- package/dist/authorization-error.d.cts +113 -0
- package/dist/authorization-error.d.ts +113 -0
- package/dist/authorization-error.js +152 -0
- package/dist/authorization-error.js.map +1 -0
- package/dist/authorizer.port.d.cts +130 -0
- package/dist/authorizer.port.d.ts +130 -0
- package/dist/composite-authorizer.d.cts +216 -0
- package/dist/composite-authorizer.d.ts +216 -0
- package/dist/condition-evaluator.cjs +565 -0
- package/dist/condition-evaluator.cjs.map +1 -0
- package/dist/condition-evaluator.js +536 -0
- package/dist/condition-evaluator.js.map +1 -0
- package/dist/core-config.d.cts +172 -0
- package/dist/{gate-types.d.ts → core-config.d.ts} +78 -77
- package/dist/domain/index.cjs +17 -0
- package/dist/domain/index.d.cts +4 -0
- package/dist/domain/index.d.ts +2 -1
- package/dist/domain/index.js +2 -1
- package/dist/domain-event-contracts.cjs +34 -0
- package/dist/domain-event-contracts.cjs.map +1 -0
- package/dist/domain-event-contracts.d.cts +27 -0
- package/dist/domain-event-contracts.js +2 -1
- package/dist/domain-event-contracts.js.map +1 -1
- package/dist/domain-exception.cjs +17 -0
- package/dist/domain-exception.cjs.map +1 -0
- package/dist/domain-exception.d.cts +7 -0
- package/dist/entity.cjs +126 -0
- package/dist/entity.cjs.map +1 -0
- package/dist/entity.js +115 -0
- package/dist/entity.js.map +1 -0
- package/dist/errors/index.cjs +43 -0
- package/dist/errors/index.d.cts +4 -0
- package/dist/errors/index.d.ts +2 -1
- package/dist/errors/index.js +4 -2
- package/dist/exceptions/index.cjs +17 -0
- package/dist/exceptions/index.d.cts +5 -0
- package/dist/exceptions/validation-field.cjs +3 -0
- package/dist/exceptions/validation-field.d.cts +2 -0
- package/dist/gate-engine-registry.cjs +309 -0
- package/dist/gate-engine-registry.cjs.map +1 -0
- package/dist/gate-engine-registry.d.cts +82 -0
- package/dist/gate-engine-registry.d.ts +3 -2
- package/dist/gate-engine-registry.js +2 -1
- package/dist/gate-engine-registry.js.map +1 -1
- package/dist/gate-v1-payload.schema.cjs +76 -0
- package/dist/gate-v1-payload.schema.cjs.map +1 -0
- package/dist/gate-v1-payload.schema.js +1 -533
- package/dist/gate-v1-payload.schema.js.map +1 -1
- package/dist/hashing.cjs +66 -0
- package/dist/hashing.cjs.map +1 -0
- package/dist/immutable.cjs +77 -0
- package/dist/immutable.cjs.map +1 -0
- package/dist/immutable.d.cts +6 -0
- package/dist/index.cjs +181 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +37 -0
- package/dist/index.d.ts +19 -12
- package/dist/index.js +15 -9
- package/dist/index.js.map +1 -1
- package/dist/invalid-state-transition-exception.cjs +47 -0
- package/dist/invalid-state-transition-exception.cjs.map +1 -0
- package/dist/invariant-violation-exception.cjs +16 -0
- package/dist/invariant-violation-exception.cjs.map +1 -0
- package/dist/not-found-error.cjs +65 -0
- package/dist/not-found-error.cjs.map +1 -0
- package/dist/not-found-error.js +1 -1
- package/dist/outcome.cjs +97 -0
- package/dist/outcome.cjs.map +1 -0
- package/dist/outcome.d.cts +58 -0
- package/dist/outcome.d.ts +1 -83
- package/dist/parse-gate-payload.d.cts +62 -0
- package/dist/parse-gate-payload.d.ts +2 -2
- package/dist/path.d.cts +90 -0
- package/dist/path.d.ts +2 -2
- package/dist/plugin.cjs +79 -0
- package/dist/plugin.cjs.map +1 -0
- package/dist/plugin.d.cts +85 -0
- package/dist/plugins/index.cjs +3 -0
- package/dist/plugins/index.d.cts +2 -0
- package/dist/policies/engines/index.cjs +10 -0
- package/dist/policies/engines/index.d.cts +4 -0
- package/dist/policies/engines/index.d.ts +1 -1
- package/dist/policies/engines/v1/gate/index.cjs +92 -0
- package/dist/policies/engines/v1/gate/index.cjs.map +1 -0
- package/dist/policies/engines/v1/gate/index.d.cts +121 -0
- package/dist/policies/engines/v1/gate/index.d.ts +2 -2
- package/dist/policies/engines/v1/gate/index.js +2 -1
- package/dist/policies/engines/v1/gate/index.js.map +1 -1
- package/dist/policies/index.cjs +41 -0
- package/dist/policies/index.d.cts +8 -0
- package/dist/policies/index.d.ts +3 -2
- package/dist/policies/index.js +2 -2
- package/dist/policy-bridge.cjs +437 -0
- package/dist/policy-bridge.cjs.map +1 -0
- package/dist/policy-bridge.d.cts +185 -0
- package/dist/policy-bridge.d.ts +185 -0
- package/dist/policy-bridge.js +396 -0
- package/dist/policy-bridge.js.map +1 -0
- package/dist/policy-service.cjs +1190 -0
- package/dist/policy-service.cjs.map +1 -0
- package/dist/policy-service.d.cts +559 -0
- package/dist/policy-service.d.ts +2 -2
- package/dist/policy-service.js +239 -239
- package/dist/policy-service.js.map +1 -1
- package/dist/rbac/index.cjs +9 -0
- package/dist/rbac/index.d.cts +3 -0
- package/dist/rbac/index.d.ts +3 -0
- package/dist/rbac/index.js +2 -0
- package/dist/requested-by.cjs +54 -0
- package/dist/requested-by.cjs.map +1 -0
- package/dist/requested-by.d.cts +25 -0
- package/dist/requested-by.d.ts +25 -0
- package/dist/requested-by.js +49 -0
- package/dist/requested-by.js.map +1 -0
- package/dist/result/index.cjs +7 -0
- package/dist/result/index.d.cts +3 -0
- package/dist/result/index.d.ts +2 -1
- package/dist/result.cjs +135 -0
- package/dist/result.cjs.map +1 -0
- package/dist/result.d.cts +84 -0
- package/dist/result.d.ts +84 -0
- package/dist/rule.cjs +327 -0
- package/dist/rule.cjs.map +1 -0
- package/dist/rule.js +298 -0
- package/dist/rule.js.map +1 -0
- package/dist/ruleset-registry.cjs +47 -0
- package/dist/ruleset-registry.cjs.map +1 -0
- package/dist/rulesets/index.cjs +3 -0
- package/dist/rulesets/index.d.cts +2 -0
- package/dist/temporal-guards.cjs +32 -0
- package/dist/temporal-guards.cjs.map +1 -0
- package/dist/temporal-use-case.cjs +139 -0
- package/dist/temporal-use-case.cjs.map +1 -0
- package/dist/temporal-use-case.d.cts +282 -0
- package/dist/temporal-use-case.d.ts +5 -27
- package/dist/temporal-use-case.js +2 -48
- package/dist/temporal-use-case.js.map +1 -1
- package/dist/unexpected-error.cjs +19 -0
- package/dist/unexpected-error.cjs.map +1 -0
- package/dist/unexpected-error.js +2 -167
- package/dist/unexpected-error.js.map +1 -1
- package/dist/use-case.cjs +96 -0
- package/dist/use-case.cjs.map +1 -0
- package/dist/uuid-identifier.cjs +65 -0
- package/dist/uuid-identifier.cjs.map +1 -0
- package/dist/uuid-identifier.d.cts +147 -0
- package/dist/uuid-identifier.d.ts +2 -85
- package/dist/validation-code.cjs +60 -0
- package/dist/validation-code.cjs.map +1 -0
- package/dist/validation-code.d.cts +23 -0
- package/dist/validation-error.cjs +887 -0
- package/dist/validation-error.cjs.map +1 -0
- package/dist/validation-error.d.cts +681 -0
- package/dist/validation-error.d.ts +2 -98
- package/dist/validation-error.js +7 -134
- package/dist/validation-error.js.map +1 -1
- package/dist/validation-exception.cjs +41 -0
- package/dist/validation-exception.cjs.map +1 -0
- package/dist/validation-exception.d.cts +50 -0
- package/dist/validation-field.cjs +28 -0
- package/dist/validation-field.cjs.map +1 -0
- package/dist/validation-field.d.cts +12 -0
- package/dist/value-object-ruleset.contracts.d.cts +36 -0
- package/dist/value-object.cjs +85 -0
- package/dist/value-object.cjs.map +1 -0
- package/dist/value-object.d.cts +89 -0
- package/dist/value-object.d.ts +89 -0
- package/dist/value-object.js +1 -112
- package/dist/value-object.js.map +1 -1
- package/dist/version.d.cts +10 -0
- package/dist/versioning/index.cjs +7 -0
- package/dist/versioning/index.d.cts +3 -0
- package/meta.json +19 -4
- package/package.json +173 -28
- package/src/abac/index.ts +1 -0
- package/src/core/abac/abac-request.ts +29 -0
- package/src/core/abac/attributes.ts +39 -0
- package/src/core/abac/authorizer.ts +108 -0
- package/src/core/abac/combining.ts +63 -0
- package/src/core/abac/composite-authorizer.ts +45 -0
- package/src/core/abac/domain/policy-set.ts +52 -0
- package/src/core/abac/domain/rule.ts +197 -0
- package/src/core/abac/index.ts +21 -0
- package/src/core/application/ports/abac-authorizer.port.ts +20 -0
- package/src/core/application/ports/authorizer.port.ts +22 -0
- package/src/core/errors/authorization-error.ts +26 -0
- package/src/core/errors/error-codes.ts +1 -0
- package/src/core/index.ts +7 -0
- package/src/core/rbac/access-request.ts +32 -0
- package/src/core/rbac/authorizer.ts +91 -0
- package/src/core/rbac/domain/grant.ts +96 -0
- package/src/core/rbac/domain/permission-set.ts +67 -0
- package/src/core/rbac/domain/permission.ts +119 -0
- package/src/core/rbac/domain/role.ts +101 -0
- package/src/core/rbac/domain/scope.ts +84 -0
- package/src/core/rbac/index.ts +15 -0
- package/src/core/rbac/policy-bridge.ts +44 -0
- package/src/examples/application/authorize-cancel-order-abac.example.ts +107 -0
- package/src/examples/application/authorize-cancel-order.example.ts +101 -0
- package/src/rbac/index.ts +1 -0
- package/src/version.ts +1 -1
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
//#region src/core/errors/error-codes.ts
|
|
2
|
+
const ErrorCodes = {
|
|
3
|
+
authentication: {
|
|
4
|
+
missingToken: "sec.authn.missing_token",
|
|
5
|
+
invalidToken: "sec.authn.invalid_token",
|
|
6
|
+
expiredToken: "sec.authn.expired_token",
|
|
7
|
+
invalidCredentials: "sec.authn.invalid_credentials"
|
|
8
|
+
},
|
|
9
|
+
authorization: {
|
|
10
|
+
forbidden: "sec.authz.forbidden",
|
|
11
|
+
policyDenied: "sec.authz.policy_denied",
|
|
12
|
+
missingRole: "sec.authz.missing_role",
|
|
13
|
+
missingCapability: "sec.authz.missing_capability",
|
|
14
|
+
outOfScope: "sec.authz.out_of_scope"
|
|
15
|
+
},
|
|
16
|
+
businessRuleViolation: "business_rule_violation",
|
|
17
|
+
conflict: {
|
|
18
|
+
alreadyExists: "conf.already_exists",
|
|
19
|
+
duplicate: "conf.duplicate",
|
|
20
|
+
uniqueViolation: "conf.unique_violation"
|
|
21
|
+
},
|
|
22
|
+
idempotency: {
|
|
23
|
+
keyMissing: "idemp.key_missing",
|
|
24
|
+
inProgress: "idemp.in_progress",
|
|
25
|
+
payloadMismatch: "idemp.payload_mismatch",
|
|
26
|
+
replayNotSupported: "idemp.replay_not_supported"
|
|
27
|
+
},
|
|
28
|
+
integration: {
|
|
29
|
+
timeout: "int.timeout",
|
|
30
|
+
unreachable: "int.unreachable",
|
|
31
|
+
badResponse: "int.bad_response"
|
|
32
|
+
},
|
|
33
|
+
legacyIncompatible: "legacy_incompatible",
|
|
34
|
+
notFound: "not_found",
|
|
35
|
+
serialization: {
|
|
36
|
+
deserializePrefix: "ser.des",
|
|
37
|
+
serializePrefix: "ser.ser"
|
|
38
|
+
},
|
|
39
|
+
temporal: {
|
|
40
|
+
expired: "tmp.expired",
|
|
41
|
+
notYetValid: "tmp.not_yet_valid"
|
|
42
|
+
},
|
|
43
|
+
unexpected: "unexpected",
|
|
44
|
+
validation: "validation_error"
|
|
45
|
+
};
|
|
46
|
+
function serializationErrorCode(direction, category) {
|
|
47
|
+
return `${direction === "deserialize" ? ErrorCodes.serialization.deserializePrefix : ErrorCodes.serialization.serializePrefix}.${category}`;
|
|
48
|
+
}
|
|
49
|
+
//#endregion
|
|
50
|
+
//#region src/core/errors/utils/json-safe.ts
|
|
51
|
+
const NON_SERIALIZABLE_PLACEHOLDER = "[NonSerializable]";
|
|
52
|
+
const CIRCULAR_REFERENCE_PLACEHOLDER = "[Circular]";
|
|
53
|
+
function isPlainObject(value) {
|
|
54
|
+
if (value === null || typeof value !== "object") return false;
|
|
55
|
+
const proto = Object.getPrototypeOf(value);
|
|
56
|
+
return proto === Object.prototype || proto === null;
|
|
57
|
+
}
|
|
58
|
+
function sanitizeValue(value, seen) {
|
|
59
|
+
if (value === null) return null;
|
|
60
|
+
const type = typeof value;
|
|
61
|
+
if (type === "string" || type === "number" || type === "boolean") return value;
|
|
62
|
+
if (type === "bigint" || type === "function" || type === "symbol" || value === void 0) return NON_SERIALIZABLE_PLACEHOLDER;
|
|
63
|
+
if (Array.isArray(value)) {
|
|
64
|
+
if (seen.has(value)) return CIRCULAR_REFERENCE_PLACEHOLDER;
|
|
65
|
+
seen.add(value);
|
|
66
|
+
const sanitized = value.map((item) => sanitizeValue(item, seen));
|
|
67
|
+
seen.delete(value);
|
|
68
|
+
return sanitized;
|
|
69
|
+
}
|
|
70
|
+
if (value instanceof Date) return NON_SERIALIZABLE_PLACEHOLDER;
|
|
71
|
+
if (!isPlainObject(value)) return NON_SERIALIZABLE_PLACEHOLDER;
|
|
72
|
+
if (seen.has(value)) return CIRCULAR_REFERENCE_PLACEHOLDER;
|
|
73
|
+
seen.add(value);
|
|
74
|
+
const result = {};
|
|
75
|
+
for (const [key, val] of Object.entries(value)) result[key] = sanitizeValue(val, seen);
|
|
76
|
+
seen.delete(value);
|
|
77
|
+
return result;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Ensures metadata is JSON-serializable.
|
|
81
|
+
*
|
|
82
|
+
* **Allowed:** string, number, boolean, null, arrays, and plain objects.
|
|
83
|
+
*
|
|
84
|
+
* **Converted to placeholder:** Date, BigInt, class instances, functions,
|
|
85
|
+
* symbols, undefined, and circular references (which would otherwise make
|
|
86
|
+
* `JSON.stringify` throw).
|
|
87
|
+
*
|
|
88
|
+
* @throws {TypeError} If `input` is not a plain object at the root level.
|
|
89
|
+
*/
|
|
90
|
+
function assertJsonSafeMetadata(input) {
|
|
91
|
+
if (input === void 0) return {};
|
|
92
|
+
if (!isPlainObject(input)) throw new TypeError("metadata must be a plain object (Record<string, unknown>).");
|
|
93
|
+
return sanitizeValue(input, /* @__PURE__ */ new WeakSet());
|
|
94
|
+
}
|
|
95
|
+
//#endregion
|
|
96
|
+
//#region src/core/errors/app-error.ts
|
|
97
|
+
/**
|
|
98
|
+
* Root of the application/domain error hierarchy. Every error the system raises
|
|
99
|
+
* on purpose extends `AppError`, which gives callers a single `instanceof` to
|
|
100
|
+
* catch and a uniform, serializable shape to log and transport.
|
|
101
|
+
*
|
|
102
|
+
* Beyond the native `Error` message it carries a stable `code` (the contract the
|
|
103
|
+
* outside world matches on), an optional non-leaking `publicMessage`, a
|
|
104
|
+
* severity, JSON-safe `metadata`, and the correlation/request/command ids that
|
|
105
|
+
* stitch an error back to the request that produced it. The metadata is
|
|
106
|
+
* validated as JSON-safe on construction, so a logger can serialize any
|
|
107
|
+
* `AppError` without hitting a circular reference or a non-serializable value.
|
|
108
|
+
*
|
|
109
|
+
* Abstract on purpose: callers should throw a specific subclass (e.g.
|
|
110
|
+
* {@link ValidationError}, {@link NotFoundError}) so the `code` and shape are
|
|
111
|
+
* meaningful, never a bare `AppError`.
|
|
112
|
+
*/
|
|
113
|
+
var AppError = class extends Error {
|
|
114
|
+
/**
|
|
115
|
+
* Builds the common error envelope shared by every subclass.
|
|
116
|
+
*
|
|
117
|
+
* `name` is taken from `new.target` so the thrown instance reports its
|
|
118
|
+
* concrete subclass name (not `"AppError"`), and the prototype is re-pinned
|
|
119
|
+
* via `setPrototypeOf` so `instanceof` keeps working after transpilation to
|
|
120
|
+
* older targets where extending built-ins breaks the chain. `createdAtIso`
|
|
121
|
+
* defaults to now, and `metadata` is validated as JSON-safe so the error is
|
|
122
|
+
* always serializable.
|
|
123
|
+
*
|
|
124
|
+
* Declared `protected`: instantiate a concrete subclass, never `AppError`.
|
|
125
|
+
*
|
|
126
|
+
* @param message - The internal, developer-facing message.
|
|
127
|
+
* @param code - The stable machine-readable code callers match on.
|
|
128
|
+
* @param options - Optional cause, metadata, severity, and correlation ids.
|
|
129
|
+
* @throws When `options.metadata` contains a value that is not JSON-safe.
|
|
130
|
+
*/
|
|
131
|
+
constructor(message, code, options) {
|
|
132
|
+
super(message);
|
|
133
|
+
this.name = new.target.name;
|
|
134
|
+
this.code = code;
|
|
135
|
+
this.cause = options?.cause;
|
|
136
|
+
this.type = options?.type;
|
|
137
|
+
this.severity = options?.severity;
|
|
138
|
+
this.correlationId = options?.correlationId;
|
|
139
|
+
this.requestId = options?.requestId;
|
|
140
|
+
this.commandId = options?.commandId;
|
|
141
|
+
this.createdAtIso = options?.createdAtIso ?? (/* @__PURE__ */ new Date()).toISOString();
|
|
142
|
+
this.publicMessage = options?.publicMessage;
|
|
143
|
+
this.metadata = options?.metadata ? assertJsonSafeMetadata(options.metadata) : void 0;
|
|
144
|
+
Object.setPrototypeOf(this, new.target.prototype);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Returns a JSON-safe representation of the error.
|
|
148
|
+
* Does NOT include `cause` by default (to avoid leaking internal details).
|
|
149
|
+
*/
|
|
150
|
+
toJSON() {
|
|
151
|
+
const payload = {
|
|
152
|
+
name: this.name,
|
|
153
|
+
code: this.code,
|
|
154
|
+
message: this.message,
|
|
155
|
+
createdAtIso: this.createdAtIso
|
|
156
|
+
};
|
|
157
|
+
if (this.type !== void 0) payload.type = this.type;
|
|
158
|
+
if (this.severity !== void 0) payload.severity = this.severity;
|
|
159
|
+
if (this.publicMessage !== void 0) payload.publicMessage = this.publicMessage;
|
|
160
|
+
if (this.metadata !== void 0) payload.metadata = this.metadata;
|
|
161
|
+
if (this.correlationId !== void 0) payload.correlationId = this.correlationId;
|
|
162
|
+
if (this.requestId !== void 0) payload.requestId = this.requestId;
|
|
163
|
+
if (this.commandId !== void 0) payload.commandId = this.commandId;
|
|
164
|
+
return payload;
|
|
165
|
+
}
|
|
166
|
+
};
|
|
167
|
+
//#endregion
|
|
168
|
+
export { serializationErrorCode as i, assertJsonSafeMetadata as n, ErrorCodes as r, AppError as t };
|
|
169
|
+
|
|
170
|
+
//# sourceMappingURL=app-error.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app-error.js","names":[],"sources":["../src/core/errors/error-codes.ts","../src/core/errors/utils/json-safe.ts","../src/core/errors/app-error.ts"],"sourcesContent":["const ErrorCodes = {\n authentication: {\n missingToken: \"sec.authn.missing_token\",\n invalidToken: \"sec.authn.invalid_token\",\n expiredToken: \"sec.authn.expired_token\",\n invalidCredentials: \"sec.authn.invalid_credentials\",\n },\n authorization: {\n forbidden: \"sec.authz.forbidden\",\n policyDenied: \"sec.authz.policy_denied\",\n missingRole: \"sec.authz.missing_role\",\n missingCapability: \"sec.authz.missing_capability\",\n outOfScope: \"sec.authz.out_of_scope\",\n },\n businessRuleViolation: \"business_rule_violation\",\n conflict: {\n alreadyExists: \"conf.already_exists\",\n duplicate: \"conf.duplicate\",\n uniqueViolation: \"conf.unique_violation\",\n },\n idempotency: {\n keyMissing: \"idemp.key_missing\",\n inProgress: \"idemp.in_progress\",\n payloadMismatch: \"idemp.payload_mismatch\",\n replayNotSupported: \"idemp.replay_not_supported\",\n },\n integration: {\n timeout: \"int.timeout\",\n unreachable: \"int.unreachable\",\n badResponse: \"int.bad_response\",\n },\n legacyIncompatible: \"legacy_incompatible\",\n notFound: \"not_found\",\n serialization: {\n deserializePrefix: \"ser.des\",\n serializePrefix: \"ser.ser\",\n },\n temporal: {\n expired: \"tmp.expired\",\n notYetValid: \"tmp.not_yet_valid\",\n },\n unexpected: \"unexpected\",\n validation: \"validation_error\",\n} as const;\n\ntype SerializationCodeDirection = \"deserialize\" | \"serialize\";\n\nfunction serializationErrorCode(\n direction: SerializationCodeDirection,\n category: string,\n): string {\n const prefix =\n direction === \"deserialize\"\n ? ErrorCodes.serialization.deserializePrefix\n : ErrorCodes.serialization.serializePrefix;\n\n return `${prefix}.${category}`;\n}\n\nexport { ErrorCodes, serializationErrorCode };\nexport type { SerializationCodeDirection };\n","// Utilities for ensuring metadata is JSON-serializable.\n\nimport type { JsonSafeRecord, JsonSafeValue } from \"../types.js\";\n\n// ─────────────────────────────────────────────────────────────────────────────\n// Constants\n// ─────────────────────────────────────────────────────────────────────────────\n\nconst NON_SERIALIZABLE_PLACEHOLDER = \"[NonSerializable]\";\nconst CIRCULAR_REFERENCE_PLACEHOLDER = \"[Circular]\";\n\n// ─────────────────────────────────────────────────────────────────────────────\n// Internal helpers\n// ─────────────────────────────────────────────────────────────────────────────\n\nfunction isPlainObject(value: unknown): value is Record<string, unknown> {\n if (value === null || typeof value !== \"object\") return false;\n const proto = Object.getPrototypeOf(value);\n return proto === Object.prototype || proto === null;\n}\n\n// `seen` tracks the ancestors on the current traversal branch (a DFS path), not\n// every object visited. This collapses true circular references to a placeholder\n// while still serializing the same object referenced more than once across\n// sibling branches (a DAG) — matching `JSON.stringify`, which only rejects\n// cycles, not shared references.\nfunction sanitizeValue(value: unknown, seen: WeakSet<object>): JsonSafeValue {\n // Null passthrough\n if (value === null) return null;\n\n const type = typeof value;\n\n // Primitives\n if (type === \"string\" || type === \"number\" || type === \"boolean\") {\n return value as JsonSafeValue;\n }\n\n // Non-serializable primitives\n if (\n type === \"bigint\" ||\n type === \"function\" ||\n type === \"symbol\" ||\n value === undefined\n ) {\n return NON_SERIALIZABLE_PLACEHOLDER;\n }\n\n // Arrays (recursive)\n if (Array.isArray(value)) {\n if (seen.has(value)) return CIRCULAR_REFERENCE_PLACEHOLDER;\n seen.add(value);\n const sanitized = value.map((item) => sanitizeValue(item, seen));\n seen.delete(value);\n return sanitized;\n }\n\n // Date → placeholder (could also use .toISOString() if preferred)\n if (value instanceof Date) {\n return NON_SERIALIZABLE_PLACEHOLDER;\n }\n\n // Class instances and non-plain objects → placeholder\n if (!isPlainObject(value)) {\n return NON_SERIALIZABLE_PLACEHOLDER;\n }\n\n // Plain object (recursive)\n if (seen.has(value)) return CIRCULAR_REFERENCE_PLACEHOLDER;\n seen.add(value);\n const result: Record<string, JsonSafeValue> = {};\n for (const [key, val] of Object.entries(value)) {\n result[key] = sanitizeValue(val, seen);\n }\n seen.delete(value);\n return result;\n}\n\n// ─────────────────────────────────────────────────────────────────────────────\n// Public API\n// ─────────────────────────────────────────────────────────────────────────────\n\n/**\n * Ensures metadata is JSON-serializable.\n *\n * **Allowed:** string, number, boolean, null, arrays, and plain objects.\n *\n * **Converted to placeholder:** Date, BigInt, class instances, functions,\n * symbols, undefined, and circular references (which would otherwise make\n * `JSON.stringify` throw).\n *\n * @throws {TypeError} If `input` is not a plain object at the root level.\n */\nfunction assertJsonSafeMetadata(input: unknown): JsonSafeRecord {\n if (input === undefined) {\n return {};\n }\n\n if (!isPlainObject(input)) {\n throw new TypeError(\n \"metadata must be a plain object (Record<string, unknown>).\",\n );\n }\n\n return sanitizeValue(input, new WeakSet<object>()) as JsonSafeRecord;\n}\n\nexport {\n assertJsonSafeMetadata,\n CIRCULAR_REFERENCE_PLACEHOLDER,\n NON_SERIALIZABLE_PLACEHOLDER,\n};\n","// Base application error for the domain/application layer.\n// Encapsulates a code, optional cause, and JSON-safe metadata.\n\nimport type {\n AppErrorOptions,\n ErrorSeverity,\n JsonSafeRecord,\n} from \"./types.js\";\nimport { assertJsonSafeMetadata } from \"./utils/index.js\";\n\n// ─────────────────────────────────────────────────────────────────────────────\n// AppError (abstract base class)\n// ─────────────────────────────────────────────────────────────────────────────\n\n/**\n * Root of the application/domain error hierarchy. Every error the system raises\n * on purpose extends `AppError`, which gives callers a single `instanceof` to\n * catch and a uniform, serializable shape to log and transport.\n *\n * Beyond the native `Error` message it carries a stable `code` (the contract the\n * outside world matches on), an optional non-leaking `publicMessage`, a\n * severity, JSON-safe `metadata`, and the correlation/request/command ids that\n * stitch an error back to the request that produced it. The metadata is\n * validated as JSON-safe on construction, so a logger can serialize any\n * `AppError` without hitting a circular reference or a non-serializable value.\n *\n * Abstract on purpose: callers should throw a specific subclass (e.g.\n * {@link ValidationError}, {@link NotFoundError}) so the `code` and shape are\n * meaningful, never a bare `AppError`.\n */\nabstract class AppError extends Error {\n public readonly code: string;\n public readonly cause?: unknown;\n public readonly metadata?: JsonSafeRecord;\n public readonly type?: string;\n public readonly severity?: ErrorSeverity;\n public readonly createdAtIso: string;\n public readonly publicMessage?: string;\n /**\n * Identifies a single execution \"story\" in the system. All operations\n * related to the same logical flow must share the same correlationId.\n */\n public readonly correlationId?: string;\n /**\n * Identifies a specific technical request attempt (each retry may produce\n * a new requestId), even when the correlationId stays the same.\n */\n public readonly requestId?: string;\n /**\n * Marks the business intent / idempotency key; stays the same across\n * technical retries and multiple requests that represent the same intent.\n */\n public readonly commandId?: string;\n\n /**\n * Builds the common error envelope shared by every subclass.\n *\n * `name` is taken from `new.target` so the thrown instance reports its\n * concrete subclass name (not `\"AppError\"`), and the prototype is re-pinned\n * via `setPrototypeOf` so `instanceof` keeps working after transpilation to\n * older targets where extending built-ins breaks the chain. `createdAtIso`\n * defaults to now, and `metadata` is validated as JSON-safe so the error is\n * always serializable.\n *\n * Declared `protected`: instantiate a concrete subclass, never `AppError`.\n *\n * @param message - The internal, developer-facing message.\n * @param code - The stable machine-readable code callers match on.\n * @param options - Optional cause, metadata, severity, and correlation ids.\n * @throws When `options.metadata` contains a value that is not JSON-safe.\n */\n protected constructor(\n message: string,\n code: string,\n options?: AppErrorOptions,\n ) {\n super(message);\n\n this.name = new.target.name;\n this.code = code;\n this.cause = options?.cause;\n this.type = options?.type;\n this.severity = options?.severity;\n this.correlationId = options?.correlationId;\n this.requestId = options?.requestId;\n this.commandId = options?.commandId;\n this.createdAtIso = options?.createdAtIso ?? new Date().toISOString();\n this.publicMessage = options?.publicMessage;\n\n this.metadata = options?.metadata\n ? assertJsonSafeMetadata(options.metadata)\n : undefined;\n\n Object.setPrototypeOf(this, new.target.prototype);\n }\n\n /**\n * Returns a JSON-safe representation of the error.\n * Does NOT include `cause` by default (to avoid leaking internal details).\n */\n public toJSON(): Record<string, unknown> {\n const payload: Record<string, unknown> = {\n name: this.name,\n code: this.code,\n message: this.message,\n createdAtIso: this.createdAtIso,\n };\n\n // Optional fields are emitted only when defined, so the serialized\n // shape never carries `undefined`-valued keys (consistent with how the\n // correlation/request/command ids are handled).\n if (this.type !== undefined) payload.type = this.type;\n if (this.severity !== undefined) payload.severity = this.severity;\n if (this.publicMessage !== undefined)\n payload.publicMessage = this.publicMessage;\n if (this.metadata !== undefined) payload.metadata = this.metadata;\n if (this.correlationId !== undefined)\n payload.correlationId = this.correlationId;\n if (this.requestId !== undefined) payload.requestId = this.requestId;\n if (this.commandId !== undefined) payload.commandId = this.commandId;\n\n return payload;\n }\n}\n\nexport { AppError };\n"],"mappings":";AAAA,MAAM,aAAa;CACf,gBAAgB;EACZ,cAAc;EACd,cAAc;EACd,cAAc;EACd,oBAAoB;CACxB;CACA,eAAe;EACX,WAAW;EACX,cAAc;EACd,aAAa;EACb,mBAAmB;EACnB,YAAY;CAChB;CACA,uBAAuB;CACvB,UAAU;EACN,eAAe;EACf,WAAW;EACX,iBAAiB;CACrB;CACA,aAAa;EACT,YAAY;EACZ,YAAY;EACZ,iBAAiB;EACjB,oBAAoB;CACxB;CACA,aAAa;EACT,SAAS;EACT,aAAa;EACb,aAAa;CACjB;CACA,oBAAoB;CACpB,UAAU;CACV,eAAe;EACX,mBAAmB;EACnB,iBAAiB;CACrB;CACA,UAAU;EACN,SAAS;EACT,aAAa;CACjB;CACA,YAAY;CACZ,YAAY;AAChB;AAIA,SAAS,uBACL,WACA,UACM;CAMN,OAAO,GAJH,cAAc,gBACR,WAAW,cAAc,oBACzB,WAAW,cAAc,gBAElB,GAAG;AACxB;;;ACjDA,MAAM,+BAA+B;AACrC,MAAM,iCAAiC;AAMvC,SAAS,cAAc,OAAkD;CACrE,IAAI,UAAU,QAAQ,OAAO,UAAU,UAAU,OAAO;CACxD,MAAM,QAAQ,OAAO,eAAe,KAAK;CACzC,OAAO,UAAU,OAAO,aAAa,UAAU;AACnD;AAOA,SAAS,cAAc,OAAgB,MAAsC;CAEzE,IAAI,UAAU,MAAM,OAAO;CAE3B,MAAM,OAAO,OAAO;CAGpB,IAAI,SAAS,YAAY,SAAS,YAAY,SAAS,WACnD,OAAO;CAIX,IACI,SAAS,YACT,SAAS,cACT,SAAS,YACT,UAAU,KAAA,GAEV,OAAO;CAIX,IAAI,MAAM,QAAQ,KAAK,GAAG;EACtB,IAAI,KAAK,IAAI,KAAK,GAAG,OAAO;EAC5B,KAAK,IAAI,KAAK;EACd,MAAM,YAAY,MAAM,KAAK,SAAS,cAAc,MAAM,IAAI,CAAC;EAC/D,KAAK,OAAO,KAAK;EACjB,OAAO;CACX;CAGA,IAAI,iBAAiB,MACjB,OAAO;CAIX,IAAI,CAAC,cAAc,KAAK,GACpB,OAAO;CAIX,IAAI,KAAK,IAAI,KAAK,GAAG,OAAO;CAC5B,KAAK,IAAI,KAAK;CACd,MAAM,SAAwC,CAAC;CAC/C,KAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,QAAQ,KAAK,GACzC,OAAO,OAAO,cAAc,KAAK,IAAI;CAEzC,KAAK,OAAO,KAAK;CACjB,OAAO;AACX;;;;;;;;;;;;AAiBA,SAAS,uBAAuB,OAAgC;CAC5D,IAAI,UAAU,KAAA,GACV,OAAO,CAAC;CAGZ,IAAI,CAAC,cAAc,KAAK,GACpB,MAAM,IAAI,UACN,4DACJ;CAGJ,OAAO,cAAc,uBAAO,IAAI,QAAgB,CAAC;AACrD;;;;;;;;;;;;;;;;;;;AC1EA,IAAe,WAAf,cAAgC,MAAM;;;;;;;;;;;;;;;;;;CAyClC,YACI,SACA,MACA,SACF;EACE,MAAM,OAAO;EAEb,KAAK,OAAO,IAAI,OAAO;EACvB,KAAK,OAAO;EACZ,KAAK,QAAQ,SAAS;EACtB,KAAK,OAAO,SAAS;EACrB,KAAK,WAAW,SAAS;EACzB,KAAK,gBAAgB,SAAS;EAC9B,KAAK,YAAY,SAAS;EAC1B,KAAK,YAAY,SAAS;EAC1B,KAAK,eAAe,SAAS,iCAAgB,IAAI,KAAK,GAAE,YAAY;EACpE,KAAK,gBAAgB,SAAS;EAE9B,KAAK,WAAW,SAAS,WACnB,uBAAuB,QAAQ,QAAQ,IACvC,KAAA;EAEN,OAAO,eAAe,MAAM,IAAI,OAAO,SAAS;CACpD;;;;;CAMA,SAAyC;EACrC,MAAM,UAAmC;GACrC,MAAM,KAAK;GACX,MAAM,KAAK;GACX,SAAS,KAAK;GACd,cAAc,KAAK;EACvB;EAKA,IAAI,KAAK,SAAS,KAAA,GAAW,QAAQ,OAAO,KAAK;EACjD,IAAI,KAAK,aAAa,KAAA,GAAW,QAAQ,WAAW,KAAK;EACzD,IAAI,KAAK,kBAAkB,KAAA,GACvB,QAAQ,gBAAgB,KAAK;EACjC,IAAI,KAAK,aAAa,KAAA,GAAW,QAAQ,WAAW,KAAK;EACzD,IAAI,KAAK,kBAAkB,KAAA,GACvB,QAAQ,gBAAgB,KAAK;EACjC,IAAI,KAAK,cAAc,KAAA,GAAW,QAAQ,YAAY,KAAK;EAC3D,IAAI,KAAK,cAAc,KAAA,GAAW,QAAQ,YAAY,KAAK;EAE3D,OAAO;CACX;AACJ"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
const require_use_case = require("../use-case.cjs");
|
|
3
|
+
const require_requested_by = require("../requested-by.cjs");
|
|
4
|
+
const require_temporal_use_case = require("../temporal-use-case.cjs");
|
|
5
|
+
Object.defineProperty(exports, "Command", {
|
|
6
|
+
enumerable: true,
|
|
7
|
+
get: function() {
|
|
8
|
+
return require_temporal_use_case.Command;
|
|
9
|
+
}
|
|
10
|
+
});
|
|
11
|
+
Object.defineProperty(exports, "Query", {
|
|
12
|
+
enumerable: true,
|
|
13
|
+
get: function() {
|
|
14
|
+
return require_temporal_use_case.Query;
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
exports.RequestedBy = require_requested_by.RequestedBy;
|
|
18
|
+
exports.TemporalUseCase = require_temporal_use_case.TemporalUseCase;
|
|
19
|
+
Object.defineProperty(exports, "UseCase", {
|
|
20
|
+
enumerable: true,
|
|
21
|
+
get: function() {
|
|
22
|
+
return require_use_case.UseCase;
|
|
23
|
+
}
|
|
24
|
+
});
|
|
25
|
+
exports.assertTemporalContext = require_temporal_use_case.assertTemporalContext;
|
|
26
|
+
exports.createTemporalContext = require_temporal_use_case.createTemporalContext;
|
|
27
|
+
exports.mapPolicyEvaluationError = require_temporal_use_case.mapPolicyEvaluationError;
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { n as RequestedByKind, t as RequestedBy } from "../requested-by.cjs";
|
|
2
|
+
import { A as LogPayload, C as UseCase, D as TracerPort, E as TraceSpan, O as MetricLabels, S as MaybePromise, T as TraceAttributeValue, _ as PolicyEvaluationOutput, a as TemporalContext, b as Command, c as CacheStrategy, d as mapPolicyEvaluationError, f as TemporalHistory, g as PolicyEvaluationInput, h as ResultRepository, i as CreateTemporalContextInput, j as LoggerPort, k as MetricsPort, l as Page, m as Repository, n as TemporalUseCaseInput, o as assertTemporalContext, p as TemporalRepository, r as TemporalizedContextSeed, s as createTemporalContext, t as TemporalUseCase, u as Query, v as PolicyPort, w as UseCaseObservability, x as CommandInput, y as PolicyPortError } from "../temporal-use-case.cjs";
|
|
3
|
+
export { CacheStrategy, Command, CommandInput, CreateTemporalContextInput, LogPayload, LoggerPort, MaybePromise, MetricLabels, MetricsPort, Page, PolicyEvaluationInput, PolicyEvaluationOutput, PolicyPort, PolicyPortError, Query, Repository, RequestedBy, RequestedByKind, ResultRepository, TemporalContext, TemporalHistory, TemporalRepository, TemporalUseCase, TemporalUseCaseInput, TemporalizedContextSeed, TraceAttributeValue, TraceSpan, TracerPort, UseCase, UseCaseObservability, assertTemporalContext, createTemporalContext, mapPolicyEvaluationError };
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { n as RequestedByKind, t as RequestedBy } from "../requested-by.js";
|
|
2
|
+
import { A as LogPayload, C as UseCase, D as TracerPort, E as TraceSpan, O as MetricLabels, S as MaybePromise, T as TraceAttributeValue, _ as PolicyEvaluationOutput, a as TemporalContext, b as Command, c as CacheStrategy, d as mapPolicyEvaluationError, f as TemporalHistory, g as PolicyEvaluationInput, h as ResultRepository, i as CreateTemporalContextInput, j as LoggerPort, k as MetricsPort, l as Page, m as Repository, n as TemporalUseCaseInput, o as assertTemporalContext, p as TemporalRepository, r as TemporalizedContextSeed, s as createTemporalContext, t as TemporalUseCase, u as Query, v as PolicyPort, w as UseCaseObservability, x as CommandInput, y as PolicyPortError } from "../temporal-use-case.js";
|
|
2
3
|
export { CacheStrategy, Command, CommandInput, CreateTemporalContextInput, LogPayload, LoggerPort, MaybePromise, MetricLabels, MetricsPort, Page, PolicyEvaluationInput, PolicyEvaluationOutput, PolicyPort, PolicyPortError, Query, Repository, RequestedBy, RequestedByKind, ResultRepository, TemporalContext, TemporalHistory, TemporalRepository, TemporalUseCase, TemporalUseCaseInput, TemporalizedContextSeed, TraceAttributeValue, TraceSpan, TracerPort, UseCase, UseCaseObservability, assertTemporalContext, createTemporalContext, mapPolicyEvaluationError };
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
import { t as UseCase } from "../use-case.js";
|
|
2
|
-
import {
|
|
2
|
+
import { t as RequestedBy } from "../requested-by.js";
|
|
3
|
+
import { a as mapPolicyEvaluationError, i as Query, n as assertTemporalContext, o as Command, r as createTemporalContext, t as TemporalUseCase } from "../temporal-use-case.js";
|
|
3
4
|
export { Command, Query, RequestedBy, TemporalUseCase, UseCase, assertTemporalContext, createTemporalContext, mapPolicyEvaluationError };
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
const require_app_error = require("./app-error.cjs");
|
|
2
|
+
//#region src/core/errors/authorization-error.ts
|
|
3
|
+
/**
|
|
4
|
+
* Raised when an authenticated actor is not allowed to perform a business
|
|
5
|
+
* action — the "you may not" error, distinct from authentication ("who are
|
|
6
|
+
* you"). Maps to an HTTP 403 at the edge.
|
|
7
|
+
*
|
|
8
|
+
* The discriminating {@link reason} records *why* access was denied (a flat
|
|
9
|
+
* forbid, a missing role/capability, an out-of-scope target, or a policy
|
|
10
|
+
* decision) so the boundary can shape the response without re-deriving it. The
|
|
11
|
+
* metadata is deliberately built around a stable business `action` and a
|
|
12
|
+
* type/id resource reference rather than an HTTP route or full payload, keeping
|
|
13
|
+
* sensitive data out of logs. Instances are frozen. Construct through the
|
|
14
|
+
* static factories, never directly.
|
|
15
|
+
*/
|
|
16
|
+
var AuthorizationError = class AuthorizationError extends require_app_error.AppError {
|
|
17
|
+
constructor(params) {
|
|
18
|
+
super(params.message, params.code, {
|
|
19
|
+
cause: params.cause,
|
|
20
|
+
metadata: params.metadata,
|
|
21
|
+
type: params.type,
|
|
22
|
+
severity: params.severity,
|
|
23
|
+
correlationId: params.correlationId,
|
|
24
|
+
requestId: params.requestId,
|
|
25
|
+
commandId: params.commandId,
|
|
26
|
+
createdAtIso: params.createdAtIso,
|
|
27
|
+
publicMessage: params.publicMessage
|
|
28
|
+
});
|
|
29
|
+
this.reason = params.reason;
|
|
30
|
+
Object.freeze(this);
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* A flat denial with no more specific reason — the actor simply may not
|
|
34
|
+
* perform this action. Reach for a more precise factory
|
|
35
|
+
* ({@link AuthorizationError.missingCapability}, {@link AuthorizationError.outOfScope},
|
|
36
|
+
* {@link AuthorizationError.policyDenied}) when the cause is known.
|
|
37
|
+
*/
|
|
38
|
+
static forbidden(input) {
|
|
39
|
+
return new AuthorizationError({
|
|
40
|
+
message: "Action not allowed",
|
|
41
|
+
code: require_app_error.ErrorCodes.authorization.forbidden,
|
|
42
|
+
reason: "forbidden",
|
|
43
|
+
metadata: {
|
|
44
|
+
reason: "forbidden",
|
|
45
|
+
...extractMetadataOnly(input)
|
|
46
|
+
},
|
|
47
|
+
...extractAppErrorOptions(input)
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* The action was denied by an evaluated policy. Captures the deciding
|
|
52
|
+
* policy's id, version, and evaluation instant into the metadata (with
|
|
53
|
+
* `decision: "deny"`) so the denial is auditable back to the exact policy
|
|
54
|
+
* that produced it.
|
|
55
|
+
*
|
|
56
|
+
* @param input - Factory options plus the required `policyId`,
|
|
57
|
+
* `policyVersion`, and `evaluatedAtIso` of the deciding policy.
|
|
58
|
+
*/
|
|
59
|
+
static policyDenied(input) {
|
|
60
|
+
return new AuthorizationError({
|
|
61
|
+
message: "Action denied by policy",
|
|
62
|
+
code: require_app_error.ErrorCodes.authorization.policyDenied,
|
|
63
|
+
reason: "policy_denied",
|
|
64
|
+
metadata: {
|
|
65
|
+
reason: "policy_denied",
|
|
66
|
+
...extractMetadataOnly(input),
|
|
67
|
+
decision: "deny"
|
|
68
|
+
},
|
|
69
|
+
...extractAppErrorOptions(input)
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* The actor holds no role at all that bears on the action — the most basic
|
|
74
|
+
* denial, distinct from {@link AuthorizationError.missingCapability} (which
|
|
75
|
+
* means the actor *has* roles, just none granting the required capability).
|
|
76
|
+
* The expected {@link AuthorizationRequirement} is recorded so the boundary
|
|
77
|
+
* can tell the caller what grant is missing.
|
|
78
|
+
*
|
|
79
|
+
* @param input - Factory options plus the `required` role/capability/scope.
|
|
80
|
+
*/
|
|
81
|
+
static missingRole(input) {
|
|
82
|
+
return new AuthorizationError({
|
|
83
|
+
message: "Missing required role to perform the action",
|
|
84
|
+
code: require_app_error.ErrorCodes.authorization.missingRole,
|
|
85
|
+
reason: "missing_role",
|
|
86
|
+
metadata: {
|
|
87
|
+
reason: "missing_role",
|
|
88
|
+
...extractMetadataOnly(input)
|
|
89
|
+
},
|
|
90
|
+
...extractAppErrorOptions(input)
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* The actor lacks a required role or capability. The expected
|
|
95
|
+
* {@link AuthorizationRequirement} is recorded so the boundary can tell the
|
|
96
|
+
* caller precisely what grant is missing.
|
|
97
|
+
*
|
|
98
|
+
* @param input - Factory options plus the `required` role/capability/scope.
|
|
99
|
+
*/
|
|
100
|
+
static missingCapability(input) {
|
|
101
|
+
return new AuthorizationError({
|
|
102
|
+
message: "Insufficient capability to perform the action",
|
|
103
|
+
code: require_app_error.ErrorCodes.authorization.missingCapability,
|
|
104
|
+
reason: "missing_capability",
|
|
105
|
+
metadata: {
|
|
106
|
+
reason: "missing_capability",
|
|
107
|
+
...extractMetadataOnly(input)
|
|
108
|
+
},
|
|
109
|
+
...extractAppErrorOptions(input)
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* The actor may perform the action in general, but not on *this* target —
|
|
114
|
+
* the resource falls outside the actor's permitted scope (e.g. a different
|
|
115
|
+
* school or tenant than the one they are bound to).
|
|
116
|
+
*
|
|
117
|
+
* @param input - Factory options plus the optional `required` scope that the
|
|
118
|
+
* target failed to satisfy.
|
|
119
|
+
*/
|
|
120
|
+
static outOfScope(input) {
|
|
121
|
+
return new AuthorizationError({
|
|
122
|
+
message: "Action outside the allowed scope",
|
|
123
|
+
code: require_app_error.ErrorCodes.authorization.outOfScope,
|
|
124
|
+
reason: "out_of_scope",
|
|
125
|
+
metadata: {
|
|
126
|
+
reason: "out_of_scope",
|
|
127
|
+
...extractMetadataOnly(input)
|
|
128
|
+
},
|
|
129
|
+
...extractAppErrorOptions(input)
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
};
|
|
133
|
+
function extractAppErrorOptions(options) {
|
|
134
|
+
return {
|
|
135
|
+
cause: options?.cause,
|
|
136
|
+
type: options?.type,
|
|
137
|
+
severity: options?.severity,
|
|
138
|
+
correlationId: options?.correlationId,
|
|
139
|
+
requestId: options?.requestId,
|
|
140
|
+
commandId: options?.commandId,
|
|
141
|
+
createdAtIso: options?.createdAtIso,
|
|
142
|
+
publicMessage: options?.publicMessage
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
function extractMetadataOnly(input) {
|
|
146
|
+
const { cause, type, severity, correlationId, requestId, commandId, createdAtIso, publicMessage, ...metadata } = input;
|
|
147
|
+
return metadata;
|
|
148
|
+
}
|
|
149
|
+
//#endregion
|
|
150
|
+
Object.defineProperty(exports, "AuthorizationError", {
|
|
151
|
+
enumerable: true,
|
|
152
|
+
get: function() {
|
|
153
|
+
return AuthorizationError;
|
|
154
|
+
}
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
//# sourceMappingURL=authorization-error.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authorization-error.cjs","names":["AppError","ErrorCodes"],"sources":["../src/core/errors/authorization-error.ts"],"sourcesContent":["import { AppError } from \"./app-error.js\";\nimport { ErrorCodes } from \"./error-codes.js\";\nimport type { AppErrorOptions, ErrorSeverity } from \"./types.js\";\n\n// ─────────────────────────────────────────────────────────────────────────────\n// Types\n// ─────────────────────────────────────────────────────────────────────────────\n\ntype AuthorizationErrorReason =\n | \"forbidden\"\n | \"missing_role\"\n | \"missing_capability\"\n | \"out_of_scope\"\n | \"outside_time_window\"\n | \"policy_denied\"\n | \"unknown\";\n\ntype AuthorizationRequirement = {\n role?: string;\n capability?: string;\n scope?: string; // e.g.: \"school:{id}\" or \"class:{id}\"\n};\n\ntype AuthorizationErrorMetadata = {\n reason: AuthorizationErrorReason;\n\n /** Stable action you evaluated (not an HTTP route — a \"business action\") */\n action: string;\n\n /** Resource identification (without leaking the full payload) */\n resource?: { type: string; id?: string };\n\n /** Optional: actor (do not include sensitive data) */\n actor?: { userId: string; role?: string };\n\n /** Optional: expected requirement */\n required?: AuthorizationRequirement;\n\n /** Optional: policy (when you already have PolicyEvaluation or similar) */\n policyId?: string;\n policyVersion?: number;\n evaluatedAtIso?: string;\n decision?: \"allow\" | \"deny\";\n reasonCode?: string;\n\n /** Optional: additional non-sensitive info */\n details?: string;\n};\n\n/**\n * Options for AuthorizationError factory methods.\n * Combines metadata fields (except 'reason') with common AppError options.\n */\ntype AuthorizationErrorFactoryOptions = Omit<\n AuthorizationErrorMetadata,\n \"reason\"\n> &\n Omit<AppErrorOptions, \"metadata\">;\n\n// ─────────────────────────────────────────────────────────────────────────────\n// AuthorizationError\n// ─────────────────────────────────────────────────────────────────────────────\n\n/**\n * Raised when an authenticated actor is not allowed to perform a business\n * action — the \"you may not\" error, distinct from authentication (\"who are\n * you\"). Maps to an HTTP 403 at the edge.\n *\n * The discriminating {@link reason} records *why* access was denied (a flat\n * forbid, a missing role/capability, an out-of-scope target, or a policy\n * decision) so the boundary can shape the response without re-deriving it. The\n * metadata is deliberately built around a stable business `action` and a\n * type/id resource reference rather than an HTTP route or full payload, keeping\n * sensitive data out of logs. Instances are frozen. Construct through the\n * static factories, never directly.\n */\nclass AuthorizationError extends AppError {\n public readonly reason: AuthorizationErrorReason;\n\n private constructor(params: {\n message: string;\n code: string;\n reason: AuthorizationErrorReason;\n metadata: AuthorizationErrorMetadata;\n cause?: unknown;\n type?: string;\n severity?: ErrorSeverity;\n correlationId?: string;\n requestId?: string;\n commandId?: string;\n createdAtIso?: string;\n publicMessage?: string;\n }) {\n super(params.message, params.code, {\n cause: params.cause,\n metadata: params.metadata,\n type: params.type,\n severity: params.severity,\n correlationId: params.correlationId,\n requestId: params.requestId,\n commandId: params.commandId,\n createdAtIso: params.createdAtIso,\n publicMessage: params.publicMessage,\n });\n\n this.reason = params.reason;\n Object.freeze(this);\n }\n\n // ─────────────────────────────────────────────────────────────────────────\n // Factories\n // ─────────────────────────────────────────────────────────────────────────\n\n /**\n * A flat denial with no more specific reason — the actor simply may not\n * perform this action. Reach for a more precise factory\n * ({@link AuthorizationError.missingCapability}, {@link AuthorizationError.outOfScope},\n * {@link AuthorizationError.policyDenied}) when the cause is known.\n */\n static forbidden(\n input: AuthorizationErrorFactoryOptions,\n ): AuthorizationError {\n return new AuthorizationError({\n message: \"Action not allowed\",\n code: ErrorCodes.authorization.forbidden,\n reason: \"forbidden\",\n metadata: { reason: \"forbidden\", ...extractMetadataOnly(input) },\n ...extractAppErrorOptions(input),\n });\n }\n\n /**\n * The action was denied by an evaluated policy. Captures the deciding\n * policy's id, version, and evaluation instant into the metadata (with\n * `decision: \"deny\"`) so the denial is auditable back to the exact policy\n * that produced it.\n *\n * @param input - Factory options plus the required `policyId`,\n * `policyVersion`, and `evaluatedAtIso` of the deciding policy.\n */\n static policyDenied(\n input: AuthorizationErrorFactoryOptions & {\n policyId: string;\n policyVersion: number;\n evaluatedAtIso: string;\n },\n ): AuthorizationError {\n return new AuthorizationError({\n message: \"Action denied by policy\",\n code: ErrorCodes.authorization.policyDenied,\n reason: \"policy_denied\",\n metadata: {\n reason: \"policy_denied\",\n ...extractMetadataOnly(input),\n decision: \"deny\",\n },\n ...extractAppErrorOptions(input),\n });\n }\n\n /**\n * The actor holds no role at all that bears on the action — the most basic\n * denial, distinct from {@link AuthorizationError.missingCapability} (which\n * means the actor *has* roles, just none granting the required capability).\n * The expected {@link AuthorizationRequirement} is recorded so the boundary\n * can tell the caller what grant is missing.\n *\n * @param input - Factory options plus the `required` role/capability/scope.\n */\n static missingRole(\n input: AuthorizationErrorFactoryOptions & {\n required: AuthorizationRequirement;\n },\n ): AuthorizationError {\n return new AuthorizationError({\n message: \"Missing required role to perform the action\",\n code: ErrorCodes.authorization.missingRole,\n reason: \"missing_role\",\n metadata: {\n reason: \"missing_role\",\n ...extractMetadataOnly(input),\n },\n ...extractAppErrorOptions(input),\n });\n }\n\n /**\n * The actor lacks a required role or capability. The expected\n * {@link AuthorizationRequirement} is recorded so the boundary can tell the\n * caller precisely what grant is missing.\n *\n * @param input - Factory options plus the `required` role/capability/scope.\n */\n static missingCapability(\n input: AuthorizationErrorFactoryOptions & {\n required: AuthorizationRequirement;\n },\n ): AuthorizationError {\n return new AuthorizationError({\n message: \"Insufficient capability to perform the action\",\n code: ErrorCodes.authorization.missingCapability,\n reason: \"missing_capability\",\n metadata: {\n reason: \"missing_capability\",\n ...extractMetadataOnly(input),\n },\n ...extractAppErrorOptions(input),\n });\n }\n\n /**\n * The actor may perform the action in general, but not on *this* target —\n * the resource falls outside the actor's permitted scope (e.g. a different\n * school or tenant than the one they are bound to).\n *\n * @param input - Factory options plus the optional `required` scope that the\n * target failed to satisfy.\n */\n static outOfScope(\n input: AuthorizationErrorFactoryOptions & {\n required?: AuthorizationRequirement;\n },\n ): AuthorizationError {\n return new AuthorizationError({\n message: \"Action outside the allowed scope\",\n code: ErrorCodes.authorization.outOfScope,\n reason: \"out_of_scope\",\n metadata: { reason: \"out_of_scope\", ...extractMetadataOnly(input) },\n ...extractAppErrorOptions(input),\n });\n }\n}\n\n// ─────────────────────────────────────────────────────────────────────────────\n// Helpers\n// ─────────────────────────────────────────────────────────────────────────────\n\nfunction extractAppErrorOptions(options?: Partial<AppErrorOptions>) {\n return {\n cause: options?.cause,\n type: options?.type,\n severity: options?.severity,\n correlationId: options?.correlationId,\n requestId: options?.requestId,\n commandId: options?.commandId,\n createdAtIso: options?.createdAtIso,\n publicMessage: options?.publicMessage,\n };\n}\n\nfunction extractMetadataOnly(\n input: AuthorizationErrorFactoryOptions,\n): Omit<AuthorizationErrorMetadata, \"reason\"> {\n const {\n cause,\n type,\n severity,\n correlationId,\n requestId,\n commandId,\n createdAtIso,\n publicMessage,\n ...metadata\n } = input;\n return metadata;\n}\n\nexport { AuthorizationError };\nexport type {\n AuthorizationErrorMetadata,\n AuthorizationErrorReason,\n AuthorizationRequirement,\n};\n"],"mappings":";;;;;;;;;;;;;;;AA4EA,IAAM,qBAAN,MAAM,2BAA2BA,kBAAAA,SAAS;CAGtC,YAAoB,QAajB;EACC,MAAM,OAAO,SAAS,OAAO,MAAM;GAC/B,OAAO,OAAO;GACd,UAAU,OAAO;GACjB,MAAM,OAAO;GACb,UAAU,OAAO;GACjB,eAAe,OAAO;GACtB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB,cAAc,OAAO;GACrB,eAAe,OAAO;EAC1B,CAAC;EAED,KAAK,SAAS,OAAO;EACrB,OAAO,OAAO,IAAI;CACtB;;;;;;;CAYA,OAAO,UACH,OACkB;EAClB,OAAO,IAAI,mBAAmB;GAC1B,SAAS;GACT,MAAMC,kBAAAA,WAAW,cAAc;GAC/B,QAAQ;GACR,UAAU;IAAE,QAAQ;IAAa,GAAG,oBAAoB,KAAK;GAAE;GAC/D,GAAG,uBAAuB,KAAK;EACnC,CAAC;CACL;;;;;;;;;;CAWA,OAAO,aACH,OAKkB;EAClB,OAAO,IAAI,mBAAmB;GAC1B,SAAS;GACT,MAAMA,kBAAAA,WAAW,cAAc;GAC/B,QAAQ;GACR,UAAU;IACN,QAAQ;IACR,GAAG,oBAAoB,KAAK;IAC5B,UAAU;GACd;GACA,GAAG,uBAAuB,KAAK;EACnC,CAAC;CACL;;;;;;;;;;CAWA,OAAO,YACH,OAGkB;EAClB,OAAO,IAAI,mBAAmB;GAC1B,SAAS;GACT,MAAMA,kBAAAA,WAAW,cAAc;GAC/B,QAAQ;GACR,UAAU;IACN,QAAQ;IACR,GAAG,oBAAoB,KAAK;GAChC;GACA,GAAG,uBAAuB,KAAK;EACnC,CAAC;CACL;;;;;;;;CASA,OAAO,kBACH,OAGkB;EAClB,OAAO,IAAI,mBAAmB;GAC1B,SAAS;GACT,MAAMA,kBAAAA,WAAW,cAAc;GAC/B,QAAQ;GACR,UAAU;IACN,QAAQ;IACR,GAAG,oBAAoB,KAAK;GAChC;GACA,GAAG,uBAAuB,KAAK;EACnC,CAAC;CACL;;;;;;;;;CAUA,OAAO,WACH,OAGkB;EAClB,OAAO,IAAI,mBAAmB;GAC1B,SAAS;GACT,MAAMA,kBAAAA,WAAW,cAAc;GAC/B,QAAQ;GACR,UAAU;IAAE,QAAQ;IAAgB,GAAG,oBAAoB,KAAK;GAAE;GAClE,GAAG,uBAAuB,KAAK;EACnC,CAAC;CACL;AACJ;AAMA,SAAS,uBAAuB,SAAoC;CAChE,OAAO;EACH,OAAO,SAAS;EAChB,MAAM,SAAS;EACf,UAAU,SAAS;EACnB,eAAe,SAAS;EACxB,WAAW,SAAS;EACpB,WAAW,SAAS;EACpB,cAAc,SAAS;EACvB,eAAe,SAAS;CAC5B;AACJ;AAEA,SAAS,oBACL,OAC0C;CAC1C,MAAM,EACF,OACA,MACA,UACA,eACA,WACA,WACA,cACA,eACA,GAAG,aACH;CACJ,OAAO;AACX"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { n as AppErrorOptions, t as AppError } from "./app-error.cjs";
|
|
2
|
+
|
|
3
|
+
//#region src/core/errors/authorization-error.d.ts
|
|
4
|
+
type AuthorizationErrorReason = "forbidden" | "missing_role" | "missing_capability" | "out_of_scope" | "outside_time_window" | "policy_denied" | "unknown";
|
|
5
|
+
type AuthorizationRequirement = {
|
|
6
|
+
role?: string;
|
|
7
|
+
capability?: string;
|
|
8
|
+
scope?: string;
|
|
9
|
+
};
|
|
10
|
+
type AuthorizationErrorMetadata = {
|
|
11
|
+
reason: AuthorizationErrorReason;
|
|
12
|
+
/** Stable action you evaluated (not an HTTP route — a "business action") */
|
|
13
|
+
action: string;
|
|
14
|
+
/** Resource identification (without leaking the full payload) */
|
|
15
|
+
resource?: {
|
|
16
|
+
type: string;
|
|
17
|
+
id?: string;
|
|
18
|
+
};
|
|
19
|
+
/** Optional: actor (do not include sensitive data) */
|
|
20
|
+
actor?: {
|
|
21
|
+
userId: string;
|
|
22
|
+
role?: string;
|
|
23
|
+
};
|
|
24
|
+
/** Optional: expected requirement */
|
|
25
|
+
required?: AuthorizationRequirement;
|
|
26
|
+
/** Optional: policy (when you already have PolicyEvaluation or similar) */
|
|
27
|
+
policyId?: string;
|
|
28
|
+
policyVersion?: number;
|
|
29
|
+
evaluatedAtIso?: string;
|
|
30
|
+
decision?: "allow" | "deny";
|
|
31
|
+
reasonCode?: string;
|
|
32
|
+
/** Optional: additional non-sensitive info */
|
|
33
|
+
details?: string;
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Options for AuthorizationError factory methods.
|
|
37
|
+
* Combines metadata fields (except 'reason') with common AppError options.
|
|
38
|
+
*/
|
|
39
|
+
type AuthorizationErrorFactoryOptions = Omit<AuthorizationErrorMetadata, "reason"> & Omit<AppErrorOptions, "metadata">;
|
|
40
|
+
/**
|
|
41
|
+
* Raised when an authenticated actor is not allowed to perform a business
|
|
42
|
+
* action — the "you may not" error, distinct from authentication ("who are
|
|
43
|
+
* you"). Maps to an HTTP 403 at the edge.
|
|
44
|
+
*
|
|
45
|
+
* The discriminating {@link reason} records *why* access was denied (a flat
|
|
46
|
+
* forbid, a missing role/capability, an out-of-scope target, or a policy
|
|
47
|
+
* decision) so the boundary can shape the response without re-deriving it. The
|
|
48
|
+
* metadata is deliberately built around a stable business `action` and a
|
|
49
|
+
* type/id resource reference rather than an HTTP route or full payload, keeping
|
|
50
|
+
* sensitive data out of logs. Instances are frozen. Construct through the
|
|
51
|
+
* static factories, never directly.
|
|
52
|
+
*/
|
|
53
|
+
declare class AuthorizationError extends AppError {
|
|
54
|
+
readonly reason: AuthorizationErrorReason;
|
|
55
|
+
private constructor();
|
|
56
|
+
/**
|
|
57
|
+
* A flat denial with no more specific reason — the actor simply may not
|
|
58
|
+
* perform this action. Reach for a more precise factory
|
|
59
|
+
* ({@link AuthorizationError.missingCapability}, {@link AuthorizationError.outOfScope},
|
|
60
|
+
* {@link AuthorizationError.policyDenied}) when the cause is known.
|
|
61
|
+
*/
|
|
62
|
+
static forbidden(input: AuthorizationErrorFactoryOptions): AuthorizationError;
|
|
63
|
+
/**
|
|
64
|
+
* The action was denied by an evaluated policy. Captures the deciding
|
|
65
|
+
* policy's id, version, and evaluation instant into the metadata (with
|
|
66
|
+
* `decision: "deny"`) so the denial is auditable back to the exact policy
|
|
67
|
+
* that produced it.
|
|
68
|
+
*
|
|
69
|
+
* @param input - Factory options plus the required `policyId`,
|
|
70
|
+
* `policyVersion`, and `evaluatedAtIso` of the deciding policy.
|
|
71
|
+
*/
|
|
72
|
+
static policyDenied(input: AuthorizationErrorFactoryOptions & {
|
|
73
|
+
policyId: string;
|
|
74
|
+
policyVersion: number;
|
|
75
|
+
evaluatedAtIso: string;
|
|
76
|
+
}): AuthorizationError;
|
|
77
|
+
/**
|
|
78
|
+
* The actor holds no role at all that bears on the action — the most basic
|
|
79
|
+
* denial, distinct from {@link AuthorizationError.missingCapability} (which
|
|
80
|
+
* means the actor *has* roles, just none granting the required capability).
|
|
81
|
+
* The expected {@link AuthorizationRequirement} is recorded so the boundary
|
|
82
|
+
* can tell the caller what grant is missing.
|
|
83
|
+
*
|
|
84
|
+
* @param input - Factory options plus the `required` role/capability/scope.
|
|
85
|
+
*/
|
|
86
|
+
static missingRole(input: AuthorizationErrorFactoryOptions & {
|
|
87
|
+
required: AuthorizationRequirement;
|
|
88
|
+
}): AuthorizationError;
|
|
89
|
+
/**
|
|
90
|
+
* The actor lacks a required role or capability. The expected
|
|
91
|
+
* {@link AuthorizationRequirement} is recorded so the boundary can tell the
|
|
92
|
+
* caller precisely what grant is missing.
|
|
93
|
+
*
|
|
94
|
+
* @param input - Factory options plus the `required` role/capability/scope.
|
|
95
|
+
*/
|
|
96
|
+
static missingCapability(input: AuthorizationErrorFactoryOptions & {
|
|
97
|
+
required: AuthorizationRequirement;
|
|
98
|
+
}): AuthorizationError;
|
|
99
|
+
/**
|
|
100
|
+
* The actor may perform the action in general, but not on *this* target —
|
|
101
|
+
* the resource falls outside the actor's permitted scope (e.g. a different
|
|
102
|
+
* school or tenant than the one they are bound to).
|
|
103
|
+
*
|
|
104
|
+
* @param input - Factory options plus the optional `required` scope that the
|
|
105
|
+
* target failed to satisfy.
|
|
106
|
+
*/
|
|
107
|
+
static outOfScope(input: AuthorizationErrorFactoryOptions & {
|
|
108
|
+
required?: AuthorizationRequirement;
|
|
109
|
+
}): AuthorizationError;
|
|
110
|
+
}
|
|
111
|
+
//#endregion
|
|
112
|
+
export { AuthorizationRequirement as i, AuthorizationErrorMetadata as n, AuthorizationErrorReason as r, AuthorizationError as t };
|
|
113
|
+
//# sourceMappingURL=authorization-error.d.cts.map
|