foldkit-guard 0.3.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -7
- package/dist/agent.d.mts +1 -3
- package/dist/agent.d.mts.map +1 -1
- package/dist/agent.mjs +2 -3
- package/dist/{attach-BVG6LsFf.d.mts → attach-BnP9_Uca.d.mts} +18 -15
- package/dist/attach-BnP9_Uca.d.mts.map +1 -0
- package/dist/{attach-BZyVvs7H.mjs → attach-CRCF5XHS.mjs} +16 -4
- package/dist/attach-CRCF5XHS.mjs.map +1 -0
- package/dist/{condition-Dunujvzy.mjs → condition-Bl1UgEpM.mjs} +6 -6
- package/dist/condition-Bl1UgEpM.mjs.map +1 -0
- package/dist/drizzle.d.mts +8 -5
- package/dist/drizzle.d.mts.map +1 -1
- package/dist/drizzle.mjs +11 -14
- package/dist/drizzle.mjs.map +1 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +12 -11
- package/dist/index.mjs.map +1 -1
- package/dist/{may-DK-2lomO.mjs → may-DzCAt_5M.mjs} +2 -3
- package/dist/{may-DK-2lomO.mjs.map → may-DzCAt_5M.mjs.map} +1 -1
- package/dist/{me-DeSZOGt3.mjs → me-BYpuVqJE.mjs} +4 -5
- package/dist/{me-DeSZOGt3.mjs.map → me-BYpuVqJE.mjs.map} +1 -1
- package/dist/media.d.mts +1 -3
- package/dist/media.d.mts.map +1 -1
- package/dist/media.mjs +1 -2
- package/dist/{origin-CN6ThFTp.mjs → origin-igJoiz74.mjs} +2 -3
- package/dist/{origin-CN6ThFTp.mjs.map → origin-igJoiz74.mjs.map} +1 -1
- package/dist/{placed-CkyMqxFw.mjs → placed-BvdNmZJu.mjs} +4 -5
- package/dist/{placed-CkyMqxFw.mjs.map → placed-BvdNmZJu.mjs.map} +1 -1
- package/dist/server.d.mts +12 -3
- package/dist/server.d.mts.map +1 -1
- package/dist/server.mjs +211 -67
- package/dist/server.mjs.map +1 -1
- package/dist/sync.d.mts +1 -3
- package/dist/sync.d.mts.map +1 -1
- package/dist/sync.mjs +4 -5
- package/dist/sync.mjs.map +1 -1
- package/package.json +14 -14
- package/dist/attach-BVG6LsFf.d.mts.map +0 -1
- package/dist/attach-BZyVvs7H.mjs.map +0 -1
- package/dist/condition-Dunujvzy.mjs.map +0 -1
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"condition-Dunujvzy.mjs","names":[],"sources":["../src/condition.ts"],"sourcesContent":["/**\n * What an attachment's read rules come to for one principal, once its\n * principal guards are decided: a condition over the row, which an\n * interpreter runs (`evaluate` in memory, SQL in a binding). Principal guards\n * never reach it, so their bodies stay on the server that decided them.\n */\nimport { Effect, Match, Option } from 'effect'\nimport { Query, evaluate, type AnyEntity } from 'foldkit-entity'\nimport { attached, defaultDeny, surfaceOf, type AnyRule, type Deny } from './attach.js'\nimport type { PrincipalGuard, RowGuard } from './index.js'\n\nexport type Condition =\n | { readonly _tag: 'Always' }\n | { readonly _tag: 'Never' }\n | { readonly _tag: 'Row'; readonly guard: RowGuard<any, AnyEntity> }\n /** The row its `one` relation points at is readable. */\n | { readonly _tag: 'Inherit'; readonly relation: string }\n | { readonly _tag: 'And'; readonly conditions: ReadonlyArray<Condition> }\n | { readonly _tag: 'Or'; readonly conditions: ReadonlyArray<Condition> }\n\nconst always: Condition = Object.freeze({ _tag: 'Always' })\nconst never: Condition = Object.freeze({ _tag: 'Never' })\n\n/** A conjunction, with what it settles already folded away. */\nconst and = (conditions: ReadonlyArray<Condition>): Condition => {\n const kept: Array<Condition> = []\n for (const condition of conditions) {\n if (condition._tag === 'Never') return never\n if (condition._tag !== 'Always') kept.push(condition)\n }\n if (kept.length === 0) return always\n if (kept.length === 1) return kept[0]!\n return Object.freeze({ _tag: 'And', conditions: Object.freeze(kept) })\n}\n\n/** A disjunction, with what it settles already folded away. */\nconst or = (conditions: ReadonlyArray<Condition>): Condition => {\n const kept: Array<Condition> = []\n for (const condition of conditions) {\n if (condition._tag === 'Always') return always\n if (condition._tag !== 'Never') kept.push(condition)\n }\n if (kept.length === 0) return never\n if (kept.length === 1) return kept[0]!\n return Object.freeze({ _tag: 'Or', conditions: Object.freeze(kept) })\n}\n\nexport const Condition = {\n always,\n never,\n and,\n or,\n\n /**\n * Whether a row's stored values meet `condition`, its row guards read with\n * `input` (the principal's, from `G.inputOf`). `inherit` answers whether the\n * row a relation points at is readable, which only the caller can look up.\n */\n holds: (\n condition: Condition,\n values: Readonly<Record<string, unknown>>,\n input: Readonly<Record<string, unknown>>,\n inherit: (relation: string) => boolean,\n ): boolean => {\n const holds = (each: Condition): boolean =>\n Match.valueTags(each, {\n Always: () => true,\n Never: () => false,\n Row: ({ guard }) => evaluate(guard.query, input, [values]).length === 1,\n Inherit: ({ relation }) => inherit(relation),\n And: ({ conditions }) => conditions.every(holds),\n Or: ({ conditions }) => conditions.some(holds),\n })\n return holds(condition)\n },\n\n /**\n * `condition` with every row guard that reads one of `unset`, and every\n * relation of them it follows, refused: a field a create leaves unset\n * matches no guard, `isNull` and `isNotNull` alike, since the create never\n * said what it holds.\n */\n unsetting: (condition: Condition, unset: ReadonlySet<string>): Condition => {\n const kept = (each: Condition): Condition =>\n Match.valueTags(each, {\n Always: () => each,\n Never: () => each,\n Row: ({ guard }) =>\n Query.dependencies(guard.query).predicate.some(field => unset.has(field.key))\n ? never\n : each,\n Inherit: ({ relation }) => (unset.has(relation) ? never : each),\n And: ({ conditions }) => and(conditions.map(kept)),\n Or: ({ conditions }) => or(conditions.map(kept)),\n })\n return kept(condition)\n },\n\n /** The members a condition reads: its row guards' fields, and each relation it follows. */\n members: (condition: Condition): ReadonlyArray<string> => {\n const read = (each: Condition): ReadonlyArray<string> =>\n Match.valueTags(each, {\n Always: () => [],\n Never: () => [],\n Row: ({ guard }) => Query.dependencies(guard.query).predicate.map(field => field.key),\n Inherit: ({ relation }) => [relation],\n And: ({ conditions }) => conditions.flatMap(read),\n Or: ({ conditions }) => conditions.flatMap(read),\n })\n return [...new Set(read(condition))]\n },\n}\n\n/** A member's read rule for one principal: the condition, and what a refusal shows. */\nexport interface MemberRead {\n readonly member: string\n readonly condition: Condition\n readonly deny: Deny\n}\n\n/**\n * Whether a row guard reads the principal's fields. A visitor has none, so\n * passes no guard that does; one over the row alone (`publishedAt` is set)\n * holds for a visitor as for anyone.\n */\nexport const readsPrincipal = (guard: RowGuard<any, AnyEntity>): boolean =>\n Query.dependencies(guard.query).inputs.length > 0\n\n/** Every principal guard the rules name, each once. */\nconst principalGuardsIn = (rules: ReadonlyArray<AnyRule>): ReadonlyArray<PrincipalGuard<any>> => {\n const found = new Map<string, PrincipalGuard<any>>()\n const visit = (rule: AnyRule): void =>\n Match.valueTags(rule, {\n PrincipalGuard: guard => void found.set(guard.name, guard),\n RowGuard: () => {},\n All: ({ rules }) => rules.forEach(visit),\n Inherit: () => {},\n })\n rules.forEach(visit)\n return [...found.values()]\n}\n\n/**\n * Turns `rules` into a condition for one principal. Each principal guard is\n * decided once, however many rules name it; a visitor passes no row guard\n * that reads the principal.\n */\nconst conditionsFor = <R>(\n rules: ReadonlyArray<AnyRule>,\n decide: (guard: PrincipalGuard<any>) => Effect.Effect<boolean, never, R>,\n visitor: boolean,\n): Effect.Effect<(rules: ReadonlyArray<AnyRule>, join: typeof and) => Condition, never, R> =>\n Effect.map(\n Effect.forEach(principalGuardsIn(rules), guard =>\n Effect.map(decide(guard), allowed => [guard.name, allowed] as const),\n ),\n decisions => {\n const allowed = new Map(decisions)\n const conditionOf = (rule: AnyRule): Condition =>\n Match.valueTags(rule, {\n PrincipalGuard: ({ name }) => (allowed.get(name) === true ? always : never),\n RowGuard: guard =>\n visitor && readsPrincipal(guard)\n ? never\n : Object.freeze({ _tag: 'Row' as const, guard }),\n All: ({ rules }) => and(rules.map(conditionOf)),\n Inherit: ({ relation }) => Object.freeze({ _tag: 'Inherit' as const, relation }),\n })\n return (rules, join) => join(rules.map(conditionOf))\n },\n )\n\n/** A row's rule for one interaction and principal: the condition, and what a refusal shows. */\nexport interface RowRule {\n readonly condition: Condition\n readonly deny: Deny\n}\n\n/**\n * How a Policy decides one interaction, given the set's principal guards as\n * decided for it.\n */\nexport const deciding = <R>(\n decide: (guard: PrincipalGuard<any>) => Effect.Effect<boolean, never, R>,\n visitor: boolean,\n interaction: string,\n) => ({\n /** Who may do it to which rows of `entity`: `always`, then the row's rules for it. */\n row: (entity: AnyEntity): Effect.Effect<RowRule, never, R> =>\n Option.match(attached(entity), {\n onNone: () =>\n Effect.succeed({ condition: always, deny: defaultDeny(rowTarget(interaction)) }),\n onSome: attachment => {\n const target = rowTarget(interaction)\n const row = surfaceOf(attachment, target)\n const rules = Option.match(row, {\n onNone: (): ReadonlyArray<AnyRule> => [],\n onSome: ({ rules }) => rules,\n })\n // An interaction left without rules falls to the set's default.\n const unguarded = attachment.unguarded === 'allow' ? always : never\n return Effect.map(\n conditionsFor([...attachment.always, ...rules], decide, visitor),\n condition => ({\n condition: and([\n condition(attachment.always, and),\n Option.isSome(row) ? condition(rules, or) : unguarded,\n ]),\n deny: Option.getOrElse(\n Option.flatMap(row, ({ deny }) => deny),\n () => defaultDeny(target),\n ),\n }),\n )\n },\n }),\n\n /**\n * The rule of each of `members` that has one for this interaction. One\n * without follows its row. A relation key's Read is its relation's, decided\n * over the parent row as a member's is.\n */\n members: (\n entity: AnyEntity,\n members: ReadonlyArray<string>,\n ): Effect.Effect<ReadonlyArray<MemberRead>, never, R> =>\n Option.match(attached(entity), {\n onNone: () => Effect.succeed([]),\n onSome: attachment => {\n const surfaces = members.flatMap(member => {\n const target = Object.hasOwn(entity.relations, member)\n ? ({ _tag: 'Relation', relation: member, interaction } as const)\n : ({ _tag: 'Member', member, interaction } as const)\n return Option.match(surfaceOf(attachment, target), {\n onNone: () => [],\n onSome: ({ rules, deny }) => [\n { member, rules, deny: Option.getOrElse(deny, () => defaultDeny(target)) },\n ],\n })\n })\n return Effect.map(\n conditionsFor(\n surfaces.flatMap(({ rules }) => rules),\n decide,\n visitor,\n ),\n condition =>\n surfaces.map(({ member, rules, deny }) => ({\n member,\n condition: condition(rules, or),\n deny,\n })),\n )\n },\n }),\n\n /** A relation's rule for this interaction (`Link`, `Unlink`), when it has one. */\n relation: (\n entity: AnyEntity,\n relation: string,\n ): Effect.Effect<Option.Option<RowRule>, never, R> => {\n const target = { _tag: 'Relation', relation, interaction } as const\n return Option.match(\n Option.flatMap(attached(entity), attachment => surfaceOf(attachment, target)),\n {\n onNone: () => Effect.succeed(Option.none()),\n onSome: ({ rules, deny }) =>\n Effect.map(conditionsFor(rules, decide, visitor), condition =>\n Option.some({\n condition: condition(rules, or),\n deny: Option.getOrElse(deny, () => defaultDeny(target)),\n }),\n ),\n },\n )\n },\n})\n\nconst rowTarget = (interaction: string) => ({ _tag: 'Row', interaction }) as const\n"],"mappings":";;;;;;;;;;AAoBA,MAAM,SAAoB,OAAO,OAAO,EAAE,MAAM,SAAS,CAAC;AAC1D,MAAM,QAAmB,OAAO,OAAO,EAAE,MAAM,QAAQ,CAAC;;AAGxD,MAAM,OAAO,eAAoD;CAC/D,MAAM,OAAyB,CAAC;CAChC,KAAK,MAAM,aAAa,YAAY;EAClC,IAAI,UAAU,SAAS,SAAS,OAAO;EACvC,IAAI,UAAU,SAAS,UAAU,KAAK,KAAK,SAAS;CACtD;CACA,IAAI,KAAK,WAAW,GAAG,OAAO;CAC9B,IAAI,KAAK,WAAW,GAAG,OAAO,KAAK;CACnC,OAAO,OAAO,OAAO;EAAE,MAAM;EAAO,YAAY,OAAO,OAAO,IAAI;CAAE,CAAC;AACvE;;AAGA,MAAM,MAAM,eAAoD;CAC9D,MAAM,OAAyB,CAAC;CAChC,KAAK,MAAM,aAAa,YAAY;EAClC,IAAI,UAAU,SAAS,UAAU,OAAO;EACxC,IAAI,UAAU,SAAS,SAAS,KAAK,KAAK,SAAS;CACrD;CACA,IAAI,KAAK,WAAW,GAAG,OAAO;CAC9B,IAAI,KAAK,WAAW,GAAG,OAAO,KAAK;CACnC,OAAO,OAAO,OAAO;EAAE,MAAM;EAAM,YAAY,OAAO,OAAO,IAAI;CAAE,CAAC;AACtE;AAEA,MAAa,YAAY;CACvB;CACA;CACA;CACA;;;;;;CAOA,QACE,WACA,QACA,OACA,YACY;EACZ,MAAM,SAAS,SACb,MAAM,UAAU,MAAM;GACpB,cAAc;GACd,aAAa;GACb,MAAM,EAAE,YAAY,SAAS,MAAM,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW;GACtE,UAAU,EAAE,eAAe,QAAQ,QAAQ;GAC3C,MAAM,EAAE,iBAAiB,WAAW,MAAM,KAAK;GAC/C,KAAK,EAAE,iBAAiB,WAAW,KAAK,KAAK;EAC/C,CAAC;EACH,OAAO,MAAM,SAAS;CACxB;;;;;;;CAQA,YAAY,WAAsB,UAA0C;EAC1E,MAAM,QAAQ,SACZ,MAAM,UAAU,MAAM;GACpB,cAAc;GACd,aAAa;GACb,MAAM,EAAE,YACN,MAAM,aAAa,MAAM,KAAK,CAAC,CAAC,UAAU,MAAK,UAAS,MAAM,IAAI,MAAM,GAAG,CAAC,IACxE,QACA;GACN,UAAU,EAAE,eAAgB,MAAM,IAAI,QAAQ,IAAI,QAAQ;GAC1D,MAAM,EAAE,iBAAiB,IAAI,WAAW,IAAI,IAAI,CAAC;GACjD,KAAK,EAAE,iBAAiB,GAAG,WAAW,IAAI,IAAI,CAAC;EACjD,CAAC;EACH,OAAO,KAAK,SAAS;CACvB;;CAGA,UAAU,cAAgD;EACxD,MAAM,QAAQ,SACZ,MAAM,UAAU,MAAM;GACpB,cAAc,CAAC;GACf,aAAa,CAAC;GACd,MAAM,EAAE,YAAY,MAAM,aAAa,MAAM,KAAK,CAAC,CAAC,UAAU,KAAI,UAAS,MAAM,GAAG;GACpF,UAAU,EAAE,eAAe,CAAC,QAAQ;GACpC,MAAM,EAAE,iBAAiB,WAAW,QAAQ,IAAI;GAChD,KAAK,EAAE,iBAAiB,WAAW,QAAQ,IAAI;EACjD,CAAC;EACH,OAAO,CAAC,GAAG,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC;CACrC;AACF;;;;;;AAcA,MAAa,kBAAkB,UAC7B,MAAM,aAAa,MAAM,KAAK,CAAC,CAAC,OAAO,SAAS;;AAGlD,MAAM,qBAAqB,UAAsE;CAC/F,MAAM,wBAAQ,IAAI,IAAiC;CACnD,MAAM,SAAS,SACb,MAAM,UAAU,MAAM;EACpB,iBAAgB,UAAS,KAAK,MAAM,IAAI,MAAM,MAAM,KAAK;EACzD,gBAAgB,CAAC;EACjB,MAAM,EAAE,YAAY,MAAM,QAAQ,KAAK;EACvC,eAAe,CAAC;CAClB,CAAC;CACH,MAAM,QAAQ,KAAK;CACnB,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC;AAC3B;;;;;;AAOA,MAAM,iBACJ,OACA,QACA,YAEA,OAAO,IACL,OAAO,QAAQ,kBAAkB,KAAK,IAAG,UACvC,OAAO,IAAI,OAAO,KAAK,IAAG,YAAW,CAAC,MAAM,MAAM,OAAO,CAAU,CACrE,IACA,cAAa;CACX,MAAM,UAAU,IAAI,IAAI,SAAS;CACjC,MAAM,eAAe,SACnB,MAAM,UAAU,MAAM;EACpB,iBAAiB,EAAE,WAAY,QAAQ,IAAI,IAAI,MAAM,OAAO,SAAS;EACrE,WAAU,UACR,WAAW,eAAe,KAAK,IAC3B,QACA,OAAO,OAAO;GAAE,MAAM;GAAgB;EAAM,CAAC;EACnD,MAAM,EAAE,YAAY,IAAI,MAAM,IAAI,WAAW,CAAC;EAC9C,UAAU,EAAE,eAAe,OAAO,OAAO;GAAE,MAAM;GAAoB;EAAS,CAAC;CACjF,CAAC;CACH,QAAQ,OAAO,SAAS,KAAK,MAAM,IAAI,WAAW,CAAC;AACrD,CACF;;;;;AAYF,MAAa,YACX,QACA,SACA,iBACI;;CAEJ,MAAM,WACJ,OAAO,MAAM,SAAS,MAAM,GAAG;EAC7B,cACE,OAAO,QAAQ;GAAE,WAAW;GAAQ,MAAM,YAAY,UAAU,WAAW,CAAC;EAAE,CAAC;EACjF,SAAQ,eAAc;GACpB,MAAM,SAAS,UAAU,WAAW;GACpC,MAAM,MAAM,UAAU,YAAY,MAAM;GACxC,MAAM,QAAQ,OAAO,MAAM,KAAK;IAC9B,cAAsC,CAAC;IACvC,SAAS,EAAE,YAAY;GACzB,CAAC;GAED,MAAM,YAAY,WAAW,cAAc,UAAU,SAAS;GAC9D,OAAO,OAAO,IACZ,cAAc,CAAC,GAAG,WAAW,QAAQ,GAAG,KAAK,GAAG,QAAQ,OAAO,IAC/D,eAAc;IACZ,WAAW,IAAI,CACb,UAAU,WAAW,QAAQ,GAAG,GAChC,OAAO,OAAO,GAAG,IAAI,UAAU,OAAO,EAAE,IAAI,SAC9C,CAAC;IACD,MAAM,OAAO,UACX,OAAO,QAAQ,MAAM,EAAE,WAAW,IAAI,SAChC,YAAY,MAAM,CAC1B;GACF,EACF;EACF;CACF,CAAC;;;;;;CAOH,UACE,QACA,YAEA,OAAO,MAAM,SAAS,MAAM,GAAG;EAC7B,cAAc,OAAO,QAAQ,CAAC,CAAC;EAC/B,SAAQ,eAAc;GACpB,MAAM,WAAW,QAAQ,SAAQ,WAAU;IACzC,MAAM,SAAS,OAAO,OAAO,OAAO,WAAW,MAAM,IAChD;KAAE,MAAM;KAAY,UAAU;KAAQ;IAAY,IAClD;KAAE,MAAM;KAAU;KAAQ;IAAY;IAC3C,OAAO,OAAO,MAAM,UAAU,YAAY,MAAM,GAAG;KACjD,cAAc,CAAC;KACf,SAAS,EAAE,OAAO,WAAW,CAC3B;MAAE;MAAQ;MAAO,MAAM,OAAO,UAAU,YAAY,YAAY,MAAM,CAAC;KAAE,CAC3E;IACF,CAAC;GACH,CAAC;GACD,OAAO,OAAO,IACZ,cACE,SAAS,SAAS,EAAE,YAAY,KAAK,GACrC,QACA,OACF,IACA,cACE,SAAS,KAAK,EAAE,QAAQ,OAAO,YAAY;IACzC;IACA,WAAW,UAAU,OAAO,EAAE;IAC9B;GACF,EAAE,CACN;EACF;CACF,CAAC;;CAGH,WACE,QACA,aACoD;EACpD,MAAM,SAAS;GAAE,MAAM;GAAY;GAAU;EAAY;EACzD,OAAO,OAAO,MACZ,OAAO,QAAQ,SAAS,MAAM,IAAG,eAAc,UAAU,YAAY,MAAM,CAAC,GAC5E;GACE,cAAc,OAAO,QAAQ,OAAO,KAAK,CAAC;GAC1C,SAAS,EAAE,OAAO,WAChB,OAAO,IAAI,cAAc,OAAO,QAAQ,OAAO,IAAG,cAChD,OAAO,KAAK;IACV,WAAW,UAAU,OAAO,EAAE;IAC9B,MAAM,OAAO,UAAU,YAAY,YAAY,MAAM,CAAC;GACxD,CAAC,CACH;EACJ,CACF;CACF;AACF;AAEA,MAAM,aAAa,iBAAyB;CAAE,MAAM;CAAO;AAAY"}
|