@nmnmcc/ability 0.1.0 → 0.3.0

package/dist/Policy.js

@@ -0,0 +1,162 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import { TypeId as TypeId$1, all as all$1, any as any$1, ceiling as ceiling$1, decide as decide$1, decideSync as decideSync$1, define as define$1, empty as empty$1, explain as explain$1, firstOf as firstOf$1, isPolicy as isPolicy$1, permittedFields as permittedFields$1, residual as residual$1, rules as rules$1, schema as schema$1 } from "./internal/policy.js";
+// src/Policy.ts
+var Policy_exports = /* @__PURE__ */ __exportAll({
+	TypeId: () => TypeId,
+	all: () => all,
+	any: () => any,
+	ceiling: () => ceiling,
+	decide: () => decide,
+	decideSync: () => decideSync,
+	define: () => define,
+	empty: () => empty,
+	explain: () => explain,
+	firstOf: () => firstOf,
+	isPolicy: () => isPolicy,
+	permittedFields: () => permittedFields,
+	residual: () => residual,
+	rules: () => rules,
+	schema: () => schema
+});
+/**
+* @stability stable
+* @category type IDs
+* @since 0.3.0
+*/
+const TypeId = TypeId$1;
+/**
+* Makes a policy from a generator function that gives rules. It is pure and it
+* gives its result at once.
+*
+* @example
+* ```ts
+* const policy = Policy.define(App)(function* (_) {
+*   yield* _.allow("read", Bot)
+*   yield* _.allow(["update", "delete"], Bot, {
+*     when: ($) => $.eq("ownerUserId", $.principal("userId")),
+*   })
+* })
+* ```
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const define = define$1;
+/**
+* Makes a policy from a list of rules.
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const rules = rules$1;
+/**
+* A policy with no rules. It is not applicable to any request.
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const empty = empty$1;
+/**
+* Every policy must allow, and one deny is enough to deny. With some policies
+* not applicable and none that deny, the result is not applicable.
+*
+* @stability stable
+* @category combinators
+* @since 0.3.0
+*/
+const all = all$1;
+/**
+* One allow is enough. Without an allow, one deny gives a deny.
+*
+* @stability stable
+* @category combinators
+* @since 0.3.0
+*/
+const any = any$1;
+/**
+* The first policy that allows or denies gives the answer.
+*
+* @stability stable
+* @category combinators
+* @since 0.3.0
+*/
+const firstOf = firstOf$1;
+/**
+* Puts a limit on a policy. A deny from `cap` always wins. An allow from `cap`
+* does nothing.
+*
+* @stability stable
+* @category combinators
+* @since 0.3.0
+*/
+const ceiling = ceiling$1;
+/**
+* Gives the decision of a policy for a request.
+*
+* @stability stable
+* @category evaluation
+* @since 0.3.0
+*/
+const decide = decide$1;
+/**
+* Gives the decision of a policy with no predicates, at once.
+*
+* @stability stable
+* @category evaluation
+* @since 0.3.0
+*/
+const decideSync = decideSync$1;
+/**
+* Gives the decision of a policy and the rules that were tested to make it.
+*
+* @stability stable
+* @category evaluation
+* @since 0.3.0
+*/
+const explain = explain$1;
+/**
+* Gives the condition on resource values for which the policy allows a
+* request. It has no principal fields and no `Under` nodes, so you can give it
+* to `Condition.fold`. It is `True` when the policy allows every value of the
+* kind, and `False` when it allows none.
+*
+* Predicates stay in the condition. They take the principal with them.
+*
+* @stability stable
+* @category evaluation
+* @since 0.3.0
+*/
+const residual = residual$1;
+/**
+* Gives the fields of a resource value that the policy lets a request use. It
+* tests each field of the resource Schema, with dots for nested fields.
+*
+* @stability stable
+* @category evaluation
+* @since 0.3.0
+*/
+const permittedFields = permittedFields$1;
+/**
+* The Schema of the policies of a domain with no predicates. Decoding checks
+* every kind, action, field and principal field against the domain, and the
+* `meta` of each rule against the `meta` Schema of the domain.
+*
+* @stability stable
+* @category schemas
+* @since 0.3.0
+*/
+const schema = schema$1;
+/**
+* Tests if a value is a policy.
+*
+* @stability stable
+* @category guards
+* @since 0.3.0
+*/
+const isPolicy = isPolicy$1;
+export { Policy_exports, TypeId, all, any, ceiling, decide, decideSync, define, empty, explain, firstOf, isPolicy, permittedFields, residual, rules, schema };
+
+//# sourceMappingURL=Policy.js.map

package/dist/Policy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Policy.js","names":["internal.TypeId","internal.define","internal.rules","internal.empty","internal.all","internal.any","internal.firstOf","internal.ceiling","internal.decide","internal.decideSync","internal.explain","internal.residual","internal.permittedFields","internal.schema","internal.isPolicy"],"sources":["../src/Policy.ts"],"sourcesContent":["/**\n * A policy is a tree that gives a {@link Decision.Decision} for a request.\n *\n * The leaves of the tree are lists of rules. A combining algorithm decides\n * which rule gives the answer when more than one rule applies:\n * - `denyOverrides` (the default): a deny rule wins over every allow rule.\n * - `permitOverrides`: an allow rule wins over every deny rule.\n * - `firstApplicable`: the first rule that applies wins.\n * - `lastApplicable`: the last rule that applies wins.\n *\n * The branches put policies together:\n * - {@link all}: every policy must allow, and one deny is enough to deny. Use\n *   it when a user token may never do more than its user.\n * - {@link any}: one allow is enough.\n * - {@link firstOf}: the first policy that gives an answer wins. Use it for\n *   grants first, then rules.\n * - {@link ceiling}: the deny rules of a second policy are a limit for\n *   everyone. Its allow rules do nothing.\n *\n * A policy gives three kinds of answers:\n * - {@link decide}: the decision for one resource value.\n * - {@link residual}: a condition on resource values. A value passes when the\n *   policy allows the request for that value. Use it to make a database\n *   query, or to ask \"may this principal do this act on some resource of\n *   this kind?\"\n * - {@link permittedFields}: the fields that the policy lets a request use.\n *\n * A policy without predicates can become JSON with {@link schema}.\n *\n * @stability stable\n * @since 0.3.0\n */\nimport type * as Effect from \"effect/Effect\"\nimport type * as Equal from \"effect/Equal\"\nimport type * as Inspectable from \"effect/Inspectable\"\nimport type * as Pipeable from \"effect/Pipeable\"\nimport type * as Schema from \"effect/Schema\"\nimport type * as Condition from \"./Condition.ts\"\nimport type * as Decision from \"./Decision.ts\"\nimport type * as Domain from \"./Domain.ts\"\nimport * as internal from \"./internal/policy.ts\"\nimport type * as Rule from \"./Rule.ts\"\n\n/**\n * @stability stable\n * @category type IDs\n * @since 0.3.0\n */\nexport const TypeId: \"~@nmnmcc/ability/Policy\" = internal.TypeId\n\n/**\n * @stability stable\n * @category type IDs\n * @since 0.3.0\n */\nexport type TypeId = typeof TypeId\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Algorithm =\n\t\"denyOverrides\" | \"permitOverrides\" | \"firstApplicable\" | \"lastApplicable\"\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface RulesNode {\n\treadonly _tag: \"Rules\"\n\treadonly algorithm: Algorithm\n\treadonly rules: ReadonlyArray<Rule.Any>\n}\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface AllNode {\n\treadonly _tag: \"All\"\n\treadonly policies: ReadonlyArray<Node>\n}\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface AnyNode {\n\treadonly _tag: \"Any\"\n\treadonly policies: ReadonlyArray<Node>\n}\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface FirstOfNode {\n\treadonly _tag: \"FirstOf\"\n\treadonly policies: ReadonlyArray<Node>\n}\n\n/**\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface CeilingNode {\n\treadonly _tag: \"Ceiling\"\n\treadonly cap: Node\n\treadonly policy: Node\n}\n\n/**\n * The nodes of a policy tree.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Node = RulesNode | AllNode | AnyNode | FirstOfNode | CeilingNode\n\n/**\n * A policy for the domain `D`. `E`, `R` and `O` come from the conditions of\n * its rules. See `Condition.Condition`.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Policy<D extends Domain.Any, E = never, R = never, O = never>\n\textends Equal.Equal, Inspectable.Inspectable, Pipeable.Pipeable {\n\treadonly [TypeId]: TypeId\n\treadonly domain: D\n\treadonly node: Node\n\treadonly \"~Policy\"?: Condition.Variance<E, R, O>\n}\n\n/**\n * Any policy.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Any = Policy<any, any, any, any>\n\n/**\n * The domain of a policy.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type DomainOf<P> = P extends Policy<infer D, any, any, any> ? D : never\n\n/**\n * The error type of a policy.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Error<P> = P extends {\n\treadonly \"~Policy\"?: Condition.Variance<infer E, infer _R, infer _O>\n}\n\t? E\n\t: never\n\n/**\n * The service type of a policy.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Services<P> = P extends {\n\treadonly \"~Policy\"?: Condition.Variance<infer _E, infer R, infer _O>\n}\n\t? R\n\t: never\n\n/**\n * `Condition.Opaque` when a policy has a predicate.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type OpaqueOf<P> = P extends {\n\treadonly \"~Policy\"?: Condition.Variance<infer _E, infer _R, infer O>\n}\n\t? O\n\t: never\n\n/**\n * One act on one resource value, for each kind of the domain. The action must\n * be an action of the kind, and the field must be a field of the kind.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Target<D> = {\n\t[K in Domain.Kind<D>]: {\n\t\treadonly action: Domain.ActionOf<D, K>\n\t\treadonly resource: Domain.ValueOf<D, K>\n\t\treadonly field?: Condition.FieldPath<Domain.DataOf<D, K>>\n\t}\n}[Domain.Kind<D>]\n\n/**\n * One act on one kind of resource, with no value.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type KindTarget<D> = {\n\t[K in Domain.Kind<D>]: {\n\t\treadonly action: Domain.ActionOf<D, K>\n\t\treadonly kind: K\n\t\treadonly field?: Condition.FieldPath<Domain.DataOf<D, K>>\n\t}\n}[Domain.Kind<D>]\n\n/**\n * A request: a principal, an action, and a resource value.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Request<D> = Target<D> & { readonly principal: Domain.Principal<D> }\n\n/**\n * A request about a kind of resource, with no value.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type KindRequest<D> = KindTarget<D> & {\n\treadonly principal: Domain.Principal<D>\n}\n\n/**\n * A request with no types.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface AnyRequest {\n\treadonly principal: object\n\treadonly action: string\n\treadonly resource: object\n\treadonly field?: string | undefined\n}\n\n/**\n * One rule that a decision tested. `path` gives the place of the rule in the\n * policy tree: the index of each child, then the index of the rule.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Step {\n\treadonly path: ReadonlyArray<number>\n\treadonly rule: Rule.Any\n\treadonly applies: boolean\n}\n\n/**\n * A decision, and the rules that were tested to make it, in order. Keep it in\n * an audit log.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Explanation {\n\treadonly decision: Decision.Decision\n\treadonly steps: ReadonlyArray<Step>\n}\n\n/**\n * The options of a list of rules.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Options {\n\t/** The default is `denyOverrides`. */\n\treadonly algorithm?: Algorithm\n}\n\n/**\n * Makes a policy from a generator function that gives rules. It is pure and it\n * gives its result at once.\n *\n * @example\n * ```ts\n * const policy = Policy.define(App)(function* (_) {\n *   yield* _.allow(\"read\", Bot)\n *   yield* _.allow([\"update\", \"delete\"], Bot, {\n *     when: ($) => $.eq(\"ownerUserId\", $.principal(\"userId\")),\n *   })\n * })\n * ```\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const define: <D extends Domain.Any>(\n\tdomain: D,\n\toptions?: Options,\n) => <Rules extends Rule.Any, A>(\n\tbody: (builder: Rule.Builder<D>) => Generator<Rules, A, unknown>,\n) => Policy<D, Rule.Error<Rules>, Rule.Services<Rules>, Rule.OpaqueOf<Rules>> =\n\tinternal.define as never\n\n/**\n * Makes a policy from a list of rules.\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const rules: <D extends Domain.Any, Rules extends Rule.Any>(\n\tdomain: D,\n\trules: Iterable<Rules>,\n\toptions?: Options,\n) => Policy<D, Rule.Error<Rules>, Rule.Services<Rules>, Rule.OpaqueOf<Rules>> =\n\tinternal.rules\n\n/**\n * A policy with no rules. It is not applicable to any request.\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const empty: <D extends Domain.Any>(domain: D) => Policy<D> =\n\tinternal.empty\n\ntype Combined<D extends Domain.Any, Ps extends ReadonlyArray<Any>> = Policy<\n\tD,\n\tError<Ps[number]>,\n\tServices<Ps[number]>,\n\tOpaqueOf<Ps[number]>\n>\n\n/**\n * Every policy must allow, and one deny is enough to deny. With some policies\n * not applicable and none that deny, the result is not applicable.\n *\n * @stability stable\n * @category combinators\n * @since 0.3.0\n */\nexport const all: <\n\tconst Ps extends readonly [Policy<any, any, any, any>, ...Array<Any>],\n>(\n\tpolicies: Ps,\n) => Combined<DomainOf<Ps[0]>, Ps> = internal.all\n\n/**\n * One allow is enough. Without an allow, one deny gives a deny.\n *\n * @stability stable\n * @category combinators\n * @since 0.3.0\n */\nexport const any: <\n\tconst Ps extends readonly [Policy<any, any, any, any>, ...Array<Any>],\n>(\n\tpolicies: Ps,\n) => Combined<DomainOf<Ps[0]>, Ps> = internal.any\n\n/**\n * The first policy that allows or denies gives the answer.\n *\n * @stability stable\n * @category combinators\n * @since 0.3.0\n */\nexport const firstOf: <\n\tconst Ps extends readonly [Policy<any, any, any, any>, ...Array<Any>],\n>(\n\tpolicies: Ps,\n) => Combined<DomainOf<Ps[0]>, Ps> = internal.firstOf\n\n/**\n * Puts a limit on a policy. A deny from `cap` always wins. An allow from `cap`\n * does nothing.\n *\n * @stability stable\n * @category combinators\n * @since 0.3.0\n */\nexport const ceiling: {\n\t<D extends Domain.Any, E2, R2, O2>(\n\t\tcap: Policy<D, E2, R2, O2>,\n\t): <E, R, O>(policy: Policy<D, E, R, O>) => Policy<D, E | E2, R | R2, O | O2>\n\t<D extends Domain.Any, E, R, O, E2, R2, O2>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t\tcap: Policy<D, E2, R2, O2>,\n\t): Policy<D, E | E2, R | R2, O | O2>\n} = internal.ceiling\n\n/**\n * Gives the decision of a policy for a request.\n *\n * @stability stable\n * @category evaluation\n * @since 0.3.0\n */\nexport const decide: {\n\t<D extends Domain.Any>(\n\t\trequest: Request<D>,\n\t): <E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t) => Effect.Effect<Decision.Decision, E, R>\n\t<D extends Domain.Any, E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t\trequest: Request<NoInfer<D>>,\n\t): Effect.Effect<Decision.Decision, E, R>\n} = internal.decide as never\n\n/**\n * Gives the decision of a policy with no predicates, at once.\n *\n * @stability stable\n * @category evaluation\n * @since 0.3.0\n */\nexport const decideSync: {\n\t<D extends Domain.Any>(\n\t\trequest: Request<D>,\n\t): (policy: Policy<D>) => Decision.Decision\n\t<D extends Domain.Any>(\n\t\tpolicy: Policy<D>,\n\t\trequest: Request<NoInfer<D>>,\n\t): Decision.Decision\n} = internal.decideSync\n\n/**\n * Gives the decision of a policy and the rules that were tested to make it.\n *\n * @stability stable\n * @category evaluation\n * @since 0.3.0\n */\nexport const explain: {\n\t<D extends Domain.Any>(\n\t\trequest: Request<D>,\n\t): <E, R, O>(policy: Policy<D, E, R, O>) => Effect.Effect<Explanation, E, R>\n\t<D extends Domain.Any, E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t\trequest: Request<NoInfer<D>>,\n\t): Effect.Effect<Explanation, E, R>\n} = internal.explain as never\n\n/**\n * Gives the condition on resource values for which the policy allows a\n * request. It has no principal fields and no `Under` nodes, so you can give it\n * to `Condition.fold`. It is `True` when the policy allows every value of the\n * kind, and `False` when it allows none.\n *\n * Predicates stay in the condition. They take the principal with them.\n *\n * @stability stable\n * @category evaluation\n * @since 0.3.0\n */\nexport const residual: {\n\t<D extends Domain.Any>(\n\t\trequest: KindRequest<D>,\n\t): <E, R, O>(policy: Policy<D, E, R, O>) => Condition.Condition<E, R, O>\n\t<D extends Domain.Any, E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t\trequest: KindRequest<NoInfer<D>>,\n\t): Condition.Condition<E, R, O>\n} = internal.residual as never\n\n/**\n * Gives the fields of a resource value that the policy lets a request use. It\n * tests each field of the resource Schema, with dots for nested fields.\n *\n * @stability stable\n * @category evaluation\n * @since 0.3.0\n */\nexport const permittedFields: {\n\t<D extends Domain.Any>(\n\t\trequest: Omit<Request<D>, \"field\">,\n\t): <E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t) => Effect.Effect<ReadonlyArray<string>, E, R>\n\t<D extends Domain.Any, E, R, O>(\n\t\tpolicy: Policy<D, E, R, O>,\n\t\trequest: Omit<Request<NoInfer<D>>, \"field\">,\n\t): Effect.Effect<ReadonlyArray<string>, E, R>\n} = internal.permittedFields as never\n\n/**\n * The JSON form of a rule.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface EncodedRule {\n\treadonly _tag: \"Allow\" | \"Deny\"\n\treadonly actions: ReadonlyArray<string>\n\treadonly resources: ReadonlyArray<string>\n\treadonly when?: Condition.Encoded\n\treadonly fields?: ReadonlyArray<string>\n\treadonly reason?: string\n\treadonly id?: string\n\treadonly meta?: unknown\n}\n\n/**\n * The JSON form of a policy.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type EncodedNode =\n\t| {\n\t\t\treadonly _tag: \"Rules\"\n\t\t\treadonly algorithm: Algorithm\n\t\t\treadonly rules: ReadonlyArray<EncodedRule>\n\t  }\n\t| {\n\t\t\treadonly _tag: \"All\" | \"Any\" | \"FirstOf\"\n\t\t\treadonly policies: ReadonlyArray<EncodedNode>\n\t  }\n\t| {\n\t\t\treadonly _tag: \"Ceiling\"\n\t\t\treadonly cap: EncodedNode\n\t\t\treadonly policy: EncodedNode\n\t  }\n\n/**\n * The Schema of the policies of a domain with no predicates. Decoding checks\n * every kind, action, field and principal field against the domain, and the\n * `meta` of each rule against the `meta` Schema of the domain.\n *\n * @stability stable\n * @category schemas\n * @since 0.3.0\n */\nexport const schema: <D extends Domain.Any>(\n\tdomain: D,\n) => Schema.Codec<Policy<D>, EncodedNode> = internal.schema\n\n/**\n * Tests if a value is a policy.\n *\n * @stability stable\n * @category guards\n * @since 0.3.0\n */\nexport const isPolicy: (u: unknown) => u is Any = internal.isPolicy\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,MAAa,SAAoCA;;;;;;;;;;;;;;;;;;;AAiRjD,MAAa,SAMZC;;;;;;;;AASD,MAAa,QAKZC;;;;;;;;AASD,MAAa,QACZC;;;;;;;;;AAiBD,MAAa,MAIwBC;;;;;;;;AASrC,MAAa,MAIwBC;;;;;;;;AASrC,MAAa,UAIwBC;;;;;;;;;AAUrC,MAAa,UAQTC;;;;;;;;AASJ,MAAa,SAUTC;;;;;;;;AASJ,MAAa,aAQTC;;;;;;;;AASJ,MAAa,UAQTC;;;;;;;;;;;;;AAcJ,MAAa,WAQTC;;;;;;;;;AAUJ,MAAa,kBAUTC;;;;;;;;;;AAoDJ,MAAa,SAE+BC;;;;;;;;AAS5C,MAAa,WAAqCC"}

package/dist/Principal.d.ts

@@ -0,0 +1,35 @@
+import * as Schema from "effect/Schema";
+declare namespace Principal_d_exports {
+  export { Any, Class };
+}
+/**
+ * Any Schema that can be a principal. Its type must be an object.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export type Any = Schema.Top & {
+  readonly Type: object;
+};
+/**
+ * Makes a principal as a Schema class. It is the same as `Schema.Class`.
+ *
+ * @example
+ * ```ts
+ * import { Schema } from "effect"
+ * import { Principal } from "@nmnmcc/ability"
+ *
+ * class Caller extends Principal.Class<Caller>("Caller")({
+ *   userId: Schema.String,
+ *   organizationId: Schema.String,
+ * }) {}
+ * ```
+ *
+ * @stability stable
+ * @category constructors
+ * @since 0.3.0
+ */
+export declare const Class: typeof Schema.Class;
+export { Principal_d_exports };
+//# sourceMappingURL=Principal.d.ts.map

package/dist/Principal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Principal.d.ts","names":[],"sources":["../src/Principal.ts"],"mappings":";;;;;;;;;;;YAoBY,MAAM,OAAO;WAAiB;;;;;;;;;;;;;;;;;;;;qBAoB7B,cAAc,OAAO"}

package/dist/Principal.js

@@ -0,0 +1,37 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import * as Schema from "effect/Schema";
+// src/Principal.ts
+/**
+* A principal is the one who asks to do an act. It may be a person, a user
+* token, or a Bot.
+*
+* A principal is a Schema. Make it with {@link Class}, in the same way as
+* `Schema.Class`, or use any `Schema.Struct`. Conditions can use the fields of
+* the principal. See `Condition.Builder.principal`.
+*
+* @stability stable
+* @since 0.3.0
+*/
+var Principal_exports = /* @__PURE__ */ __exportAll({ Class: () => Class });
+/**
+* Makes a principal as a Schema class. It is the same as `Schema.Class`.
+*
+* @example
+* ```ts
+* import { Schema } from "effect"
+* import { Principal } from "@nmnmcc/ability"
+*
+* class Caller extends Principal.Class<Caller>("Caller")({
+*   userId: Schema.String,
+*   organizationId: Schema.String,
+* }) {}
+* ```
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const Class = Schema.Class;
+export { Class, Principal_exports };
+
+//# sourceMappingURL=Principal.js.map

package/dist/Principal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Principal.js","names":[],"sources":["../src/Principal.ts"],"sourcesContent":["/**\n * A principal is the one who asks to do an act. It may be a person, a user\n * token, or a Bot.\n *\n * A principal is a Schema. Make it with {@link Class}, in the same way as\n * `Schema.Class`, or use any `Schema.Struct`. Conditions can use the fields of\n * the principal. See `Condition.Builder.principal`.\n *\n * @stability stable\n * @since 0.3.0\n */\nimport * as Schema from \"effect/Schema\"\n\n/**\n * Any Schema that can be a principal. Its type must be an object.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Any = Schema.Top & { readonly Type: object }\n\n/**\n * Makes a principal as a Schema class. It is the same as `Schema.Class`.\n *\n * @example\n * ```ts\n * import { Schema } from \"effect\"\n * import { Principal } from \"@nmnmcc/ability\"\n *\n * class Caller extends Principal.Class<Caller>(\"Caller\")({\n *   userId: Schema.String,\n *   organizationId: Schema.String,\n * }) {}\n * ```\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const Class: typeof Schema.Class = Schema.Class\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAa,QAA6B,OAAO"}

package/dist/Resource.d.ts

@@ -0,0 +1,213 @@
+import * as Schema from "effect/Schema";
+declare namespace Resource_d_exports {
+  export { Action, Any, Class, Data, Descriptor, FieldRef, Kind, Options, PathSegment, Resource, Struct, TypeId, Value, descriptor, isResource, make };
+}
+/**
+ * @stability stable
+ * @category type IDs
+ * @since 0.3.0
+ */
+export declare const TypeId: "~@nmnmcc/ability/Resource";
+/**
+ * @stability stable
+ * @category type IDs
+ * @since 0.3.0
+ */
+export type TypeId = typeof TypeId;
+/**
+ * One part of a resource path. A string is a fixed part. A field reference
+ * takes the part from a field of the value.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export type PathSegment = string | FieldRef<string>;
+/**
+ * A reference to a top-level field of a resource, used in a path.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export interface FieldRef<Name extends string> {
+  readonly _tag: "Field";
+  readonly field: Name;
+}
+/**
+ * The runtime data of a resource.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export interface Descriptor {
+  readonly kind: string;
+  readonly actions: ReadonlyArray<string>;
+  readonly path: ReadonlyArray<PathSegment> | undefined;
+  /** The paths of the data fields, with dots for nested fields. */
+  readonly fieldPaths: ReadonlyArray<string>;
+  /** The Schema of the values, with the `_tag` field. */
+  readonly schema: Schema.Top;
+}
+/**
+ * A resource. `Kind` is its name, `Action` is the union of its actions, `Data`
+ * is the type of its Schema fields, and `Value` is the type of its values.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export interface Resource<Kind extends string, Action extends string, Data extends object, Value extends {
+  readonly _tag: Kind;
+}> {
+  readonly [TypeId]: Descriptor;
+  readonly "~Resource"?: {
+    readonly Kind: Kind;
+    readonly Action: Action;
+    readonly Data: Data;
+    readonly Value: Value;
+  };
+}
+/**
+ * Any resource.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export type Any = Resource<string, string, object, {
+  readonly _tag: string;
+}>;
+/**
+ * The kind name of a resource.
+ *
+ * @stability stable
+ * @category utility types
+ * @since 0.3.0
+ */
+export type Kind<R> = R extends Resource<infer K, any, any, any> ? K : never;
+/**
+ * The actions of a resource.
+ *
+ * @stability stable
+ * @category utility types
+ * @since 0.3.0
+ */
+export type Action<R> = R extends Resource<any, infer A, any, any> ? A : never;
+/**
+ * The type of the Schema fields of a resource, without `_tag`.
+ *
+ * @stability stable
+ * @category utility types
+ * @since 0.3.0
+ */
+export type Data<R> = R extends Resource<any, any, infer D, any> ? D : never;
+/**
+ * The type of the values of a resource.
+ *
+ * @stability stable
+ * @category utility types
+ * @since 0.3.0
+ */
+export type Value<R> = R extends Resource<any, any, any, infer V> ? V : never;
+/**
+ * The options of a resource.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export interface Options<Actions extends ReadonlyArray<string>, Fields extends Schema.Struct.Fields> {
+  readonly actions: Actions;
+  readonly fields: Fields;
+  /**
+   * Gives the path of the resource. The function gets one reference for each
+   * top-level field.
+   */
+  readonly path?: (fields: { readonly [K in keyof Fields & string]: FieldRef<K>; }) => ReadonlyArray<PathSegment>;
+}
+/**
+ * The type of a class made by {@link Class}.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export type Class<Self, Kind extends string, Actions extends ReadonlyArray<string>, Fields extends Schema.Struct.Fields> = Schema.Class<Self, Schema.TaggedStruct<Kind, Fields>, {}> & Resource<Kind, Actions[number], Schema.Struct.Type<Fields>, Self & {
+  readonly _tag: Kind;
+}> & {
+  readonly kind: Kind;
+  readonly actions: Actions;
+};
+/**
+ * Makes a resource as a Schema class. Use it in the same way as
+ * `Schema.TaggedClass`.
+ *
+ * @example
+ * ```ts
+ * import { Schema } from "effect"
+ * import { Resource } from "@nmnmcc/ability"
+ *
+ * class Bot extends Resource.Class<Bot>()("Bot", {
+ *   actions: ["read", "update"],
+ *   fields: {
+ *     id: Schema.String,
+ *     ownerUserId: Schema.NullOr(Schema.String),
+ *   },
+ *   path: (f) => ["user", f.ownerUserId, "bot", f.id],
+ * }) {}
+ *
+ * const bot = new Bot({ id: "b1", ownerUserId: "u1" })
+ * ```
+ *
+ * @stability stable
+ * @category constructors
+ * @since 0.3.0
+ */
+export declare const Class: <Self = never>(identifier?: string) => <const Kind extends string, const Actions extends ReadonlyArray<string>, const Fields extends Schema.Struct.Fields>(kind: Kind, options: Options<Actions, Fields>) => [Self] extends [never] ? "Missing `Self` type: use Resource.Class<Self>()(...)" : Class<Self, Kind, Actions, Fields>;
+/**
+ * A resource made by {@link make}. Its values are plain objects.
+ *
+ * @stability stable
+ * @category models
+ * @since 0.3.0
+ */
+export interface Struct<Kind extends string, Actions extends ReadonlyArray<string>, Fields extends Schema.Struct.Fields> extends Resource<Kind, Actions[number], Schema.Struct.Type<Fields>, Schema.Struct.Type<Fields> & {
+  readonly _tag: Kind;
+}> {
+  readonly kind: Kind;
+  readonly actions: Actions;
+  readonly schema: Schema.TaggedStruct<Kind, Fields>;
+  /** Makes a value. It puts the `_tag` field on the value for you. */
+  readonly make: (input: Schema.Struct.Type<Fields>) => Schema.Struct.Type<Fields> & {
+    readonly _tag: Kind;
+  };
+}
+/**
+ * Makes a resource from plain fields. Its values are plain objects with a
+ * `_tag` field.
+ *
+ * @stability stable
+ * @category constructors
+ * @since 0.3.0
+ */
+export declare const make: <const Kind extends string, const Actions extends ReadonlyArray<string>, const Fields extends Schema.Struct.Fields>(kind: Kind, options: Options<Actions, Fields>) => Struct<Kind, Actions, Fields>;
+/**
+ * Tests if a value is a resource.
+ *
+ * @stability stable
+ * @category guards
+ * @since 0.3.0
+ */
+export declare const isResource: (u: unknown) => u is Any;
+/**
+ * Gets the runtime data of a resource.
+ *
+ * @stability stable
+ * @category getters
+ * @since 0.3.0
+ */
+export declare const descriptor: (resource: Any) => Descriptor;
+export { Resource_d_exports };
+//# sourceMappingURL=Resource.d.ts.map

package/dist/Resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.d.ts","names":[],"sources":["../src/Resource.ts"],"mappings":";;;;;;;;;qBA+Ba;;;;;;YAOD,gBAAgB;;;;;;;;;YAUhB,uBAAuB;;;;;;;;iBASlB,SAAS;WAChB;WACA,OAAO;;;;;;;;;iBAUA;WACP;WACA,SAAS;WACT,MAAM,cAAc;;WAEpB,YAAY;;WAEZ,QAAQ,OAAO;;;;;;;;;;iBAWR,SAChB,qBACA,uBACA,qBACA;WAAyB,MAAM;;YAErB,SAAS;WACV;aACC,MAAM;aACN,QAAQ;aACR,MAAM;aACN,OAAO;;;;;;;;;;YAWN,MAAM;WAA4C;;;;;;;;;YASlD,KAAK,KAAK,UAAU,eAAe,oBAAoB;;;;;;;;YASvD,OAAO,KAAK,UAAU,oBAAoB,eAAe;;;;;;;;YASzD,KAAK,KAAK,UAAU,yBAAyB,UAAU;;;;;;;;YASvD,MAAM,KAAK,UAAU,8BAA8B,KAAK;;;;;;;;iBASnD,QAChB,gBAAgB,uBAChB,eAAe,OAAO,OAAO;WAEpB,SAAS;WACT,QAAQ;;;;;WAKR,QAAQ,oBACN,WAAW,kBAAkB,SAAS,UAC3C,cAAc;;;;;;;;;YAUT,MACX,MACA,qBACA,gBAAgB,uBAChB,eAAe,OAAO,OAAO,UAC1B,OAAO,MAAM,MAAM,OAAO,aAAa,MAAM,eAChD,SACC,MACA,iBACA,OAAO,OAAO,KAAK,SACnB;WAAkB,MAAM;;WAEf,MAAM;WACN,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;qBA4BP,QAAQ,cACpB,+BAEM,2BACA,gBAAgB,6BAChB,eAAe,OAAO,OAAO,QAEnC,MAAM,MACN,SAAS,QAAQ,SAAS,aACrB,iFAEH,MAAM,MAAM,MAAM,SAAS;;;;;;;;iBASb,OAChB,qBACA,gBAAgB,uBAChB,eAAe,OAAO,OAAO,gBACpB,SACT,MACA,iBACA,OAAO,OAAO,KAAK,SACnB,OAAO,OAAO,KAAK;WAAqB,MAAM;;WAErC,MAAM;WACN,SAAS;WACT,QAAQ,OAAO,aAAa,MAAM;;WAElC,OACR,OAAO,OAAO,OAAO,KAAK,YACtB,OAAO,OAAO,KAAK;aAAqB,MAAM;;;;;;;;;;;qBAWvC,aACN,2BACA,gBAAgB,6BAChB,eAAe,OAAO,OAAO,QAEnC,MAAM,MACN,SAAS,QAAQ,SAAS,YACtB,OAAO,MAAM,SAAS;;;;;;;;qBASd,aAAa,eAAe,KAAK;;;;;;;;qBASjC,aAAa,UAAU,QAAQ"}

package/dist/Resource.js

@@ -0,0 +1,71 @@
+import { __exportAll } from "./_virtual/_rolldown/runtime.js";
+import { Class as Class$1, TypeId as TypeId$1, descriptor as descriptor$1, isResource as isResource$1, make as make$1 } from "./internal/resource.js";
+import "effect/Schema";
+// src/Resource.ts
+var Resource_exports = /* @__PURE__ */ __exportAll({
+	Class: () => Class,
+	TypeId: () => TypeId,
+	descriptor: () => descriptor,
+	isResource: () => isResource,
+	make: () => make
+});
+/**
+* @stability stable
+* @category type IDs
+* @since 0.3.0
+*/
+const TypeId = TypeId$1;
+/**
+* Makes a resource as a Schema class. Use it in the same way as
+* `Schema.TaggedClass`.
+*
+* @example
+* ```ts
+* import { Schema } from "effect"
+* import { Resource } from "@nmnmcc/ability"
+*
+* class Bot extends Resource.Class<Bot>()("Bot", {
+*   actions: ["read", "update"],
+*   fields: {
+*     id: Schema.String,
+*     ownerUserId: Schema.NullOr(Schema.String),
+*   },
+*   path: (f) => ["user", f.ownerUserId, "bot", f.id],
+* }) {}
+*
+* const bot = new Bot({ id: "b1", ownerUserId: "u1" })
+* ```
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const Class = Class$1;
+/**
+* Makes a resource from plain fields. Its values are plain objects with a
+* `_tag` field.
+*
+* @stability stable
+* @category constructors
+* @since 0.3.0
+*/
+const make = make$1;
+/**
+* Tests if a value is a resource.
+*
+* @stability stable
+* @category guards
+* @since 0.3.0
+*/
+const isResource = isResource$1;
+/**
+* Gets the runtime data of a resource.
+*
+* @stability stable
+* @category getters
+* @since 0.3.0
+*/
+const descriptor = descriptor$1;
+export { Class, Resource_exports, TypeId, descriptor, isResource, make };
+
+//# sourceMappingURL=Resource.js.map

package/dist/Resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Resource.js","names":["internal.TypeId","internal.Class","internal.make","internal.isResource","internal.descriptor"],"sources":["../src/Resource.ts"],"sourcesContent":["/**\n * A resource is a kind of thing that a person may act on, such as a Bot or a\n * document. Each resource has a kind name, a list of actions, a Schema for its\n * data, and an optional path.\n *\n * Make a resource in one of two ways:\n * - {@link Class} makes a Schema class, in the same way as\n *   `Schema.TaggedClass`. The class is a Schema, a constructor, and a resource\n *   at the same time.\n * - {@link make} makes a resource from plain fields. Its values are plain\n *   objects with a `_tag` field.\n *\n * Every value of a resource has a `_tag` field with the kind name. The library\n * uses this field to find the resource of a value. It does not guess from the\n * constructor name.\n *\n * A path puts a resource inside a tree, such as\n * `[\"org\", organizationId, \"user\", ownerUserId, \"bot\", id]`. A condition can\n * then ask if a value is under a part of the tree. See `Condition.under`.\n *\n * @stability stable\n * @since 0.3.0\n */\nimport * as Schema from \"effect/Schema\"\nimport * as internal from \"./internal/resource.ts\"\n\n/**\n * @stability stable\n * @category type IDs\n * @since 0.3.0\n */\nexport const TypeId: \"~@nmnmcc/ability/Resource\" = internal.TypeId\n\n/**\n * @stability stable\n * @category type IDs\n * @since 0.3.0\n */\nexport type TypeId = typeof TypeId\n\n/**\n * One part of a resource path. A string is a fixed part. A field reference\n * takes the part from a field of the value.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type PathSegment = string | FieldRef<string>\n\n/**\n * A reference to a top-level field of a resource, used in a path.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface FieldRef<Name extends string> {\n\treadonly _tag: \"Field\"\n\treadonly field: Name\n}\n\n/**\n * The runtime data of a resource.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Descriptor {\n\treadonly kind: string\n\treadonly actions: ReadonlyArray<string>\n\treadonly path: ReadonlyArray<PathSegment> | undefined\n\t/** The paths of the data fields, with dots for nested fields. */\n\treadonly fieldPaths: ReadonlyArray<string>\n\t/** The Schema of the values, with the `_tag` field. */\n\treadonly schema: Schema.Top\n}\n\n/**\n * A resource. `Kind` is its name, `Action` is the union of its actions, `Data`\n * is the type of its Schema fields, and `Value` is the type of its values.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Resource<\n\tKind extends string,\n\tAction extends string,\n\tData extends object,\n\tValue extends { readonly _tag: Kind },\n> {\n\treadonly [TypeId]: Descriptor\n\treadonly \"~Resource\"?: {\n\t\treadonly Kind: Kind\n\t\treadonly Action: Action\n\t\treadonly Data: Data\n\t\treadonly Value: Value\n\t}\n}\n\n/**\n * Any resource.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Any = Resource<string, string, object, { readonly _tag: string }>\n\n/**\n * The kind name of a resource.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Kind<R> = R extends Resource<infer K, any, any, any> ? K : never\n\n/**\n * The actions of a resource.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Action<R> = R extends Resource<any, infer A, any, any> ? A : never\n\n/**\n * The type of the Schema fields of a resource, without `_tag`.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Data<R> = R extends Resource<any, any, infer D, any> ? D : never\n\n/**\n * The type of the values of a resource.\n *\n * @stability stable\n * @category utility types\n * @since 0.3.0\n */\nexport type Value<R> = R extends Resource<any, any, any, infer V> ? V : never\n\n/**\n * The options of a resource.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Options<\n\tActions extends ReadonlyArray<string>,\n\tFields extends Schema.Struct.Fields,\n> {\n\treadonly actions: Actions\n\treadonly fields: Fields\n\t/**\n\t * Gives the path of the resource. The function gets one reference for each\n\t * top-level field.\n\t */\n\treadonly path?: (fields: {\n\t\treadonly [K in keyof Fields & string]: FieldRef<K>\n\t}) => ReadonlyArray<PathSegment>\n}\n\n/**\n * The type of a class made by {@link Class}.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport type Class<\n\tSelf,\n\tKind extends string,\n\tActions extends ReadonlyArray<string>,\n\tFields extends Schema.Struct.Fields,\n> = Schema.Class<Self, Schema.TaggedStruct<Kind, Fields>, {}> &\n\tResource<\n\t\tKind,\n\t\tActions[number],\n\t\tSchema.Struct.Type<Fields>,\n\t\tSelf & { readonly _tag: Kind }\n\t> & {\n\t\treadonly kind: Kind\n\t\treadonly actions: Actions\n\t}\n\n/**\n * Makes a resource as a Schema class. Use it in the same way as\n * `Schema.TaggedClass`.\n *\n * @example\n * ```ts\n * import { Schema } from \"effect\"\n * import { Resource } from \"@nmnmcc/ability\"\n *\n * class Bot extends Resource.Class<Bot>()(\"Bot\", {\n *   actions: [\"read\", \"update\"],\n *   fields: {\n *     id: Schema.String,\n *     ownerUserId: Schema.NullOr(Schema.String),\n *   },\n *   path: (f) => [\"user\", f.ownerUserId, \"bot\", f.id],\n * }) {}\n *\n * const bot = new Bot({ id: \"b1\", ownerUserId: \"u1\" })\n * ```\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const Class: <Self = never>(\n\tidentifier?: string,\n) => <\n\tconst Kind extends string,\n\tconst Actions extends ReadonlyArray<string>,\n\tconst Fields extends Schema.Struct.Fields,\n>(\n\tkind: Kind,\n\toptions: Options<Actions, Fields>,\n) => [Self] extends [never]\n\t? \"Missing `Self` type: use Resource.Class<Self>()(...)\"\n\t: Class<Self, Kind, Actions, Fields> = internal.Class as never\n\n/**\n * A resource made by {@link make}. Its values are plain objects.\n *\n * @stability stable\n * @category models\n * @since 0.3.0\n */\nexport interface Struct<\n\tKind extends string,\n\tActions extends ReadonlyArray<string>,\n\tFields extends Schema.Struct.Fields,\n> extends Resource<\n\tKind,\n\tActions[number],\n\tSchema.Struct.Type<Fields>,\n\tSchema.Struct.Type<Fields> & { readonly _tag: Kind }\n> {\n\treadonly kind: Kind\n\treadonly actions: Actions\n\treadonly schema: Schema.TaggedStruct<Kind, Fields>\n\t/** Makes a value. It puts the `_tag` field on the value for you. */\n\treadonly make: (\n\t\tinput: Schema.Struct.Type<Fields>,\n\t) => Schema.Struct.Type<Fields> & { readonly _tag: Kind }\n}\n\n/**\n * Makes a resource from plain fields. Its values are plain objects with a\n * `_tag` field.\n *\n * @stability stable\n * @category constructors\n * @since 0.3.0\n */\nexport const make: <\n\tconst Kind extends string,\n\tconst Actions extends ReadonlyArray<string>,\n\tconst Fields extends Schema.Struct.Fields,\n>(\n\tkind: Kind,\n\toptions: Options<Actions, Fields>,\n) => Struct<Kind, Actions, Fields> = internal.make as never\n\n/**\n * Tests if a value is a resource.\n *\n * @stability stable\n * @category guards\n * @since 0.3.0\n */\nexport const isResource: (u: unknown) => u is Any = internal.isResource\n\n/**\n * Gets the runtime data of a resource.\n *\n * @stability stable\n * @category getters\n * @since 0.3.0\n */\nexport const descriptor: (resource: Any) => Descriptor = internal.descriptor\n"],"mappings":";;;;;;;;;;;;;;;;AA+BA,MAAa,SAAsCA;;;;;;;;;;;;;;;;;;;;;;;;;;AA0LnD,MAAa,QAW2BC;;;;;;;;;AAoCxC,MAAa,OAOwBC;;;;;;;;AASrC,MAAa,aAAuCC;;;;;;;;AASpD,MAAa,aAA4CC"}