@gettersethya/mira-collection 0.1.0-alpha.10
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/LICENSE +21 -0
- package/README.md +164 -0
- package/dist/src/collection/auth.d.ts +79 -0
- package/dist/src/collection/auth.d.ts.map +1 -0
- package/dist/src/collection/auth.js +55 -0
- package/dist/src/collection/auth.js.map +1 -0
- package/dist/src/collection/base.d.ts +64 -0
- package/dist/src/collection/base.d.ts.map +1 -0
- package/dist/src/collection/base.js +45 -0
- package/dist/src/collection/base.js.map +1 -0
- package/dist/src/collection/bytes.d.ts +51 -0
- package/dist/src/collection/bytes.d.ts.map +1 -0
- package/dist/src/collection/bytes.js +51 -0
- package/dist/src/collection/bytes.js.map +1 -0
- package/dist/src/collection/errors.d.ts +29 -0
- package/dist/src/collection/errors.d.ts.map +1 -0
- package/dist/src/collection/errors.js +23 -0
- package/dist/src/collection/errors.js.map +1 -0
- package/dist/src/collection/field.d.ts +334 -0
- package/dist/src/collection/field.d.ts.map +1 -0
- package/dist/src/collection/field.js +201 -0
- package/dist/src/collection/field.js.map +1 -0
- package/dist/src/collection/index-builder.d.ts +59 -0
- package/dist/src/collection/index-builder.d.ts.map +1 -0
- package/dist/src/collection/index-builder.js +43 -0
- package/dist/src/collection/index-builder.js.map +1 -0
- package/dist/src/collection/index.d.ts +22 -0
- package/dist/src/collection/index.d.ts.map +1 -0
- package/dist/src/collection/index.js +21 -0
- package/dist/src/collection/index.js.map +1 -0
- package/dist/src/collection/serialize.d.ts +24 -0
- package/dist/src/collection/serialize.d.ts.map +1 -0
- package/dist/src/collection/serialize.js +133 -0
- package/dist/src/collection/serialize.js.map +1 -0
- package/dist/src/collection/types.d.ts +127 -0
- package/dist/src/collection/types.d.ts.map +1 -0
- package/dist/src/collection/types.js +2 -0
- package/dist/src/collection/types.js.map +1 -0
- package/dist/src/collection/view.d.ts +57 -0
- package/dist/src/collection/view.d.ts.map +1 -0
- package/dist/src/collection/view.js +54 -0
- package/dist/src/collection/view.js.map +1 -0
- package/dist/src/filter/builder.d.ts +127 -0
- package/dist/src/filter/builder.d.ts.map +1 -0
- package/dist/src/filter/builder.js +72 -0
- package/dist/src/filter/builder.js.map +1 -0
- package/dist/src/filter/compiler.d.ts +48 -0
- package/dist/src/filter/compiler.d.ts.map +1 -0
- package/dist/src/filter/compiler.js +132 -0
- package/dist/src/filter/compiler.js.map +1 -0
- package/dist/src/filter/index.d.ts +6 -0
- package/dist/src/filter/index.d.ts.map +1 -0
- package/dist/src/filter/index.js +4 -0
- package/dist/src/filter/index.js.map +1 -0
- package/dist/src/filter/types.d.ts +96 -0
- package/dist/src/filter/types.d.ts.map +1 -0
- package/dist/src/filter/types.js +44 -0
- package/dist/src/filter/types.js.map +1 -0
- package/dist/src/index.d.ts +5 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +4 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/rule/builder.d.ts +91 -0
- package/dist/src/rule/builder.d.ts.map +1 -0
- package/dist/src/rule/builder.js +138 -0
- package/dist/src/rule/builder.js.map +1 -0
- package/dist/src/rule/index.d.ts +3 -0
- package/dist/src/rule/index.d.ts.map +1 -0
- package/dist/src/rule/index.js +3 -0
- package/dist/src/rule/index.js.map +1 -0
- package/dist/src/rule/types.d.ts +132 -0
- package/dist/src/rule/types.d.ts.map +1 -0
- package/dist/src/rule/types.js +2 -0
- package/dist/src/rule/types.js.map +1 -0
- package/dist/tests/collection/auth.test.d.ts +2 -0
- package/dist/tests/collection/auth.test.d.ts.map +1 -0
- package/dist/tests/collection/auth.test.js +44 -0
- package/dist/tests/collection/auth.test.js.map +1 -0
- package/dist/tests/collection/base.test.d.ts +2 -0
- package/dist/tests/collection/base.test.d.ts.map +1 -0
- package/dist/tests/collection/base.test.js +70 -0
- package/dist/tests/collection/base.test.js.map +1 -0
- package/dist/tests/collection/bytes.test.d.ts +2 -0
- package/dist/tests/collection/bytes.test.d.ts.map +1 -0
- package/dist/tests/collection/bytes.test.js +9 -0
- package/dist/tests/collection/bytes.test.js.map +1 -0
- package/dist/tests/collection/field.test.d.ts +2 -0
- package/dist/tests/collection/field.test.d.ts.map +1 -0
- package/dist/tests/collection/field.test.js +165 -0
- package/dist/tests/collection/field.test.js.map +1 -0
- package/dist/tests/collection/index-type.test.d.ts +2 -0
- package/dist/tests/collection/index-type.test.d.ts.map +1 -0
- package/dist/tests/collection/index-type.test.js +28 -0
- package/dist/tests/collection/index-type.test.js.map +1 -0
- package/dist/tests/collection/serialize.test.d.ts +2 -0
- package/dist/tests/collection/serialize.test.d.ts.map +1 -0
- package/dist/tests/collection/serialize.test.js +193 -0
- package/dist/tests/collection/serialize.test.js.map +1 -0
- package/dist/tests/collection/view.test.d.ts +2 -0
- package/dist/tests/collection/view.test.d.ts.map +1 -0
- package/dist/tests/collection/view.test.js +66 -0
- package/dist/tests/collection/view.test.js.map +1 -0
- package/dist/tests/filter/compiler.test.d.ts +2 -0
- package/dist/tests/filter/compiler.test.d.ts.map +1 -0
- package/dist/tests/filter/compiler.test.js +156 -0
- package/dist/tests/filter/compiler.test.js.map +1 -0
- package/dist/tests/rule/builder.test.d.ts +2 -0
- package/dist/tests/rule/builder.test.d.ts.map +1 -0
- package/dist/tests/rule/builder.test.js +342 -0
- package/dist/tests/rule/builder.test.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +36 -0
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
function toChainable(operand) {
|
|
2
|
+
const methods = {
|
|
3
|
+
eq(right) { return { op: "eq", left: operand, right }; },
|
|
4
|
+
neq(right) { return { op: "neq", left: operand, right }; },
|
|
5
|
+
gt(right) { return { op: "gt", left: operand, right }; },
|
|
6
|
+
gte(right) { return { op: "gte", left: operand, right }; },
|
|
7
|
+
lt(right) { return { op: "lt", left: operand, right }; },
|
|
8
|
+
lte(right) { return { op: "lte", left: operand, right }; },
|
|
9
|
+
in(right) { return { op: "in", left: operand, right }; },
|
|
10
|
+
startsWith(right) { return { op: "startsWith", left: operand, right }; },
|
|
11
|
+
contains(right) { return { op: "contains", left: operand, right }; }
|
|
12
|
+
};
|
|
13
|
+
return Object.assign(Object.create(methods), operand);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Rule builder API.
|
|
17
|
+
*
|
|
18
|
+
* Constructs access rule expressions using a fluent builder pattern.
|
|
19
|
+
* Rules are compiled to SQL WHERE clauses at runtime by the rule compiler.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* // Simple field comparison
|
|
23
|
+
* Rule.field("ownerId").eq(Rule.authId(Users))
|
|
24
|
+
*
|
|
25
|
+
* // Boolean combination
|
|
26
|
+
* Rule.or(
|
|
27
|
+
* Rule.field("isPublic").eq(Rule.literal(true)),
|
|
28
|
+
* Rule.field("ownerId").eq(Rule.authId(Users))
|
|
29
|
+
* )
|
|
30
|
+
*
|
|
31
|
+
* // Date-based rule
|
|
32
|
+
* Rule.field("createdAt").gte(Rule.dateAdd(Rule.now(), -30, "day"))
|
|
33
|
+
*
|
|
34
|
+
* // Subquery
|
|
35
|
+
* const memberTeams = Rule.subquery(Members, "teamId").where(
|
|
36
|
+
* Rule.field("userId").eq(Rule.authId(Users))
|
|
37
|
+
* )
|
|
38
|
+
* Rule.field("teamId").in(memberTeams)
|
|
39
|
+
*
|
|
40
|
+
* // Subquery with typed callback
|
|
41
|
+
* Rule.field("id").in(
|
|
42
|
+
* Rule.subquery(Members, "teamId").where(
|
|
43
|
+
* (Q) => Q.field("userId").eq(Rule.authId(Users))
|
|
44
|
+
* )
|
|
45
|
+
* )
|
|
46
|
+
*
|
|
47
|
+
* // Always allow
|
|
48
|
+
* Rule.public()
|
|
49
|
+
*/
|
|
50
|
+
export const Rule = {
|
|
51
|
+
/** Reference a record field by name. Returns a chainable operand. Value type is unknown; use via RuleBuilder for typed comparisons. */
|
|
52
|
+
field: (name) => toChainable({ kind: "field", field: name }),
|
|
53
|
+
/** Reference a value from the incoming request (header, query param, or body field). */
|
|
54
|
+
request: (source, key) => toChainable({ kind: "request", source, key }),
|
|
55
|
+
/** Reference a field from the authenticated user's record. */
|
|
56
|
+
auth: (_collection, field) => toChainable({ kind: "auth", collection: _collection.name, field }),
|
|
57
|
+
/** Reference the ID of the currently authenticated user. */
|
|
58
|
+
authId: (_collection) => toChainable({ kind: "authId", collection: _collection.name }),
|
|
59
|
+
/** Reference the collection name of the currently authenticated user. */
|
|
60
|
+
authCollection: () => toChainable({ kind: "authCollection" }),
|
|
61
|
+
/** A literal value for comparison. The value type `V` is inferred from the argument. */
|
|
62
|
+
literal: (value) => ({
|
|
63
|
+
kind: "literal",
|
|
64
|
+
value
|
|
65
|
+
}),
|
|
66
|
+
/**
|
|
67
|
+
* Create a subquery operand into another collection.
|
|
68
|
+
* Call `.where()` on the result to finish the subquery.
|
|
69
|
+
*
|
|
70
|
+
* @example
|
|
71
|
+
* // Bare expression (backward compatible)
|
|
72
|
+
* Rule.subquery(Members, "teamId").where(
|
|
73
|
+
* Rule.field("userId").eq(Rule.authId(Users))
|
|
74
|
+
* )
|
|
75
|
+
*
|
|
76
|
+
* // Typed callback — Q.field() is scoped to the subquery collection
|
|
77
|
+
* Rule.subquery(Members, "teamId").where(
|
|
78
|
+
* (Q) => Q.field("userId").eq(Rule.authId(Users))
|
|
79
|
+
* )
|
|
80
|
+
*/
|
|
81
|
+
subquery: (_collection, field) => ({
|
|
82
|
+
where: (expr) => ({
|
|
83
|
+
kind: "subquery",
|
|
84
|
+
collection: _collection.name,
|
|
85
|
+
field,
|
|
86
|
+
where: typeof expr === "function" ? expr(makeRuleBuilder()) : expr
|
|
87
|
+
})
|
|
88
|
+
}),
|
|
89
|
+
/** Current timestamp operand. Compiles to `datetime('now')` in SQLite. */
|
|
90
|
+
now: () => ({ kind: "now" }),
|
|
91
|
+
/** Add a duration to a date operand for date arithmetic. */
|
|
92
|
+
dateAdd: (operand, amount, unit) => ({
|
|
93
|
+
kind: "dateAdd",
|
|
94
|
+
operand,
|
|
95
|
+
amount,
|
|
96
|
+
unit
|
|
97
|
+
}),
|
|
98
|
+
/** Compute the difference between two date operands. */
|
|
99
|
+
dateDiff: (left, right, unit) => ({
|
|
100
|
+
kind: "dateDiff",
|
|
101
|
+
left,
|
|
102
|
+
right,
|
|
103
|
+
unit
|
|
104
|
+
}),
|
|
105
|
+
/** Logical AND of expressions. */
|
|
106
|
+
and: (...exprs) => {
|
|
107
|
+
if (exprs.length === 0)
|
|
108
|
+
return { op: "public" };
|
|
109
|
+
if (exprs.length === 1)
|
|
110
|
+
return exprs[0];
|
|
111
|
+
return exprs.slice(1).reduce((acc, curr) => ({ op: "and", left: acc, right: curr }), exprs[0]);
|
|
112
|
+
},
|
|
113
|
+
/** Logical OR of expressions. */
|
|
114
|
+
or: (...exprs) => {
|
|
115
|
+
if (exprs.length === 0)
|
|
116
|
+
return { op: "public" };
|
|
117
|
+
if (exprs.length === 1)
|
|
118
|
+
return exprs[0];
|
|
119
|
+
return exprs.slice(1).reduce((acc, curr) => ({ op: "or", left: acc, right: curr }), exprs[0]);
|
|
120
|
+
},
|
|
121
|
+
/** Logical negation of a sub-expression. */
|
|
122
|
+
not: (expr) => ({ op: "not", expr }),
|
|
123
|
+
/** Always-true rule that allows all access. */
|
|
124
|
+
public: () => ({ op: "public" })
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Creates a typed `RuleBuilder<F>` that constrains `field()` to names in `F`
|
|
128
|
+
* and types each comparison operand to the field's value type.
|
|
129
|
+
* Used internally by collection definers and subquery typed callbacks.
|
|
130
|
+
*/
|
|
131
|
+
export function makeRuleBuilder() {
|
|
132
|
+
function field(name) {
|
|
133
|
+
return toChainable({ kind: "field", field: name });
|
|
134
|
+
}
|
|
135
|
+
const builder = { ...Rule, field };
|
|
136
|
+
return builder;
|
|
137
|
+
}
|
|
138
|
+
//# sourceMappingURL=builder.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../../src/rule/builder.ts"],"names":[],"mappings":"AAgDA,SAAS,WAAW,CAAsB,OAA0B;IAClE,MAAM,OAAO,GAA8B;QACzC,EAAE,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACvD,GAAG,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACzD,EAAE,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACvD,GAAG,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACzD,EAAE,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACvD,GAAG,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACzD,EAAE,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACvD,UAAU,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;QACvE,QAAQ,CAAC,KAAK,IAAI,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA,CAAC,CAAC;KACpE,CAAA;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAuB,EAAE,OAAO,CAAC,CAAA;AAC7E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,MAAM,IAAI,GAMb;IACF,uIAAuI;IACvI,KAAK,EAAE,CAAyB,IAAO,EAA4B,EAAE,CACnE,WAAW,CAAa,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAEzD,wFAAwF;IACxF,OAAO,EAAE,CAAC,MAAmC,EAAE,GAAW,EAAgC,EAAE,CAC1F,WAAW,CAAiB,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;IAE/D,8DAA8D;IAC9D,IAAI,EAAE,CACJ,WAAc,EACd,KAAQ,EACsB,EAAE,CAAC,WAAW,CAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;IAErH,4DAA4D;IAC5D,MAAM,EAAE,CAA6B,WAAc,EAA6B,EAAE,CAChF,WAAW,CAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;IAE5E,yEAAyE;IACzE,cAAc,EAAE,GAA8B,EAAE,CAC9C,WAAW,CAAc,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAEtD,wFAAwF;IACxF,OAAO,EAAE,CAAI,KAAQ,EAAuB,EAAE,CAAC,CAAC;QAC9C,IAAI,EAAE,SAAS;QACf,KAAK;KACN,CAAC;IAEF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,EAAE,CACR,WAAc,EACd,KAAQ,EACyG,EAAE,CAAC,CAAC;QACrH,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAChB,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,WAAW,CAAC,IAAI;YAC5B,KAAK;YACL,KAAK,EAAE,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,EAAe,CAAC,CAAC,CAAC,CAAC,IAAI;SAChF,CAAC;KACH,CAAC;IAEF,0EAA0E;IAC1E,GAAG,EAAE,GAA6B,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAEtD,4DAA4D;IAC5D,OAAO,EAAE,CAAC,OAAyB,EAAE,MAAc,EAAE,IAA+B,EAA4B,EAAE,CAAC,CAAC;QAClH,IAAI,EAAE,SAAS;QACf,OAAO;QACP,MAAM;QACN,IAAI;KACL,CAAC;IAEF,wDAAwD;IACxD,QAAQ,EAAE,CAAC,IAAsB,EAAE,KAAuB,EAAE,IAA+B,EAA4B,EAAE,CAAC,CAAC;QACzH,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,KAAK;QACL,IAAI;KACL,CAAC;IAEF,kCAAkC;IAClC,GAAG,EAAE,CAA4B,GAAG,KAAyB,EAAe,EAAE;QAC5E,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAA;QAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC,CAAC,CAAE,CAAA;QACxC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAc,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,CAAA;IAC9G,CAAC;IAED,iCAAiC;IACjC,EAAE,EAAE,CAA4B,GAAG,KAAyB,EAAe,EAAE;QAC3E,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAA;QAC/C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC,CAAC,CAAE,CAAA;QACxC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAc,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,CAAA;IAC7G,CAAC;IAED,4CAA4C;IAC5C,GAAG,EAAE,CAA4B,IAAiB,EAAe,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAEzF,+CAA+C;IAC/C,MAAM,EAAE,GAA2C,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;CACzE,CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe;IAC7B,SAAS,KAAK,CAA6B,IAAO;QAChD,OAAO,WAAW,CAA2B,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9E,CAAC;IACD,MAAM,OAAO,GAAmB,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,CAAA;IAClD,OAAO,OAAO,CAAA;AAChB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/rule/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rule/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA"}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A value node in a rule expression — can be a field reference, literal, auth context, subquery, date operation, or request value.
|
|
3
|
+
*
|
|
4
|
+
* - `field` — a record field (e.g., `Rule.field("ownerId")`)
|
|
5
|
+
* - `literal` — a static value (e.g., `Rule.literal(42)`)
|
|
6
|
+
* - `auth` — a field from the authenticated user record (e.g., `Rule.auth(Users, "role")`)
|
|
7
|
+
* - `authId` — the ID of the authenticated user (e.g., `Rule.authId(Users)`)
|
|
8
|
+
* - `subquery` — a subquery into another collection (e.g., `Rule.subquery(Members, "teamId")`)
|
|
9
|
+
* - `request` — a value from the incoming request (header, query, body)
|
|
10
|
+
* - `now` — current timestamp (e.g., `Rule.now()`)
|
|
11
|
+
* - `dateAdd` — date arithmetic (e.g., `Rule.dateAdd(Rule.now(), 7, "day")`)
|
|
12
|
+
* - `dateDiff` — difference between two dates (e.g., `Rule.dateDiff(Rule.field("created"), Rule.now(), "day")`)
|
|
13
|
+
* - `authCollection` — the collection name of the authenticated user (e.g., `Rule.authCollection()`)
|
|
14
|
+
*/
|
|
15
|
+
export type OperandNode<K extends string = string, V = unknown> = {
|
|
16
|
+
kind: "field";
|
|
17
|
+
collection?: string;
|
|
18
|
+
field: K;
|
|
19
|
+
} | {
|
|
20
|
+
kind: "literal";
|
|
21
|
+
value: V;
|
|
22
|
+
} | {
|
|
23
|
+
kind: "auth";
|
|
24
|
+
collection: string;
|
|
25
|
+
field: string;
|
|
26
|
+
} | {
|
|
27
|
+
kind: "authId";
|
|
28
|
+
collection: string;
|
|
29
|
+
} | {
|
|
30
|
+
kind: "authCollection";
|
|
31
|
+
} | {
|
|
32
|
+
kind: "subquery";
|
|
33
|
+
collection: string;
|
|
34
|
+
field: string;
|
|
35
|
+
where: ExprNode<any>;
|
|
36
|
+
} | {
|
|
37
|
+
kind: "request";
|
|
38
|
+
source: "header" | "query" | "body";
|
|
39
|
+
key: string;
|
|
40
|
+
} | {
|
|
41
|
+
kind: "now";
|
|
42
|
+
} | {
|
|
43
|
+
kind: "dateAdd";
|
|
44
|
+
operand: OperandNode<any>;
|
|
45
|
+
amount: number;
|
|
46
|
+
unit: "day" | "hour" | "minute";
|
|
47
|
+
} | {
|
|
48
|
+
kind: "dateDiff";
|
|
49
|
+
left: OperandNode<any>;
|
|
50
|
+
right: OperandNode<any>;
|
|
51
|
+
unit: "day" | "hour" | "minute";
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* A boolean expression node in a rule — the result of comparing operands or combining sub-expressions.
|
|
55
|
+
*
|
|
56
|
+
* - `eq` / `neq` / `gt` / `gte` / `lt` / `lte` — comparison operators
|
|
57
|
+
* - `in` — membership test (literal array or subquery)
|
|
58
|
+
* - `and` / `or` / `not` — boolean combinators
|
|
59
|
+
* - `startsWith` / `contains` — string pattern matching
|
|
60
|
+
* - `public` — always-true marker
|
|
61
|
+
*/
|
|
62
|
+
export type ExprNode<K extends string = string> = {
|
|
63
|
+
op: "eq";
|
|
64
|
+
left: OperandNode<K>;
|
|
65
|
+
right: OperandNode<any>;
|
|
66
|
+
} | {
|
|
67
|
+
op: "neq";
|
|
68
|
+
left: OperandNode<K>;
|
|
69
|
+
right: OperandNode<any>;
|
|
70
|
+
} | {
|
|
71
|
+
op: "gt";
|
|
72
|
+
left: OperandNode<K>;
|
|
73
|
+
right: OperandNode<any>;
|
|
74
|
+
} | {
|
|
75
|
+
op: "gte";
|
|
76
|
+
left: OperandNode<K>;
|
|
77
|
+
right: OperandNode<any>;
|
|
78
|
+
} | {
|
|
79
|
+
op: "lt";
|
|
80
|
+
left: OperandNode<K>;
|
|
81
|
+
right: OperandNode<any>;
|
|
82
|
+
} | {
|
|
83
|
+
op: "lte";
|
|
84
|
+
left: OperandNode<K>;
|
|
85
|
+
right: OperandNode<any>;
|
|
86
|
+
} | {
|
|
87
|
+
op: "in";
|
|
88
|
+
left: OperandNode<K>;
|
|
89
|
+
right: OperandNode<any>;
|
|
90
|
+
} | {
|
|
91
|
+
op: "and";
|
|
92
|
+
left: ExprNode<K>;
|
|
93
|
+
right: ExprNode<K>;
|
|
94
|
+
} | {
|
|
95
|
+
op: "or";
|
|
96
|
+
left: ExprNode<K>;
|
|
97
|
+
right: ExprNode<K>;
|
|
98
|
+
} | {
|
|
99
|
+
op: "not";
|
|
100
|
+
expr: ExprNode<K>;
|
|
101
|
+
} | {
|
|
102
|
+
op: "startsWith";
|
|
103
|
+
left: OperandNode<K>;
|
|
104
|
+
right: OperandNode<any>;
|
|
105
|
+
} | {
|
|
106
|
+
op: "contains";
|
|
107
|
+
left: OperandNode<K>;
|
|
108
|
+
right: OperandNode<any>;
|
|
109
|
+
} | {
|
|
110
|
+
op: "public";
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* A map of access rules keyed by action.
|
|
114
|
+
* Used in `CollectionSchema["x-rules"]`. Actions without a rule deny all access by default.
|
|
115
|
+
*
|
|
116
|
+
* @example
|
|
117
|
+
* {
|
|
118
|
+
* list: Rule.public(), // anyone can list
|
|
119
|
+
* view: Rule.field("ownerId").eq(Rule.authId(Users)), // owner only
|
|
120
|
+
* create: Rule.field("ownerId").eq(Rule.authId(Users)),
|
|
121
|
+
* update: Rule.field("ownerId").eq(Rule.authId(Users)),
|
|
122
|
+
* delete: Rule.field("ownerId").eq(Rule.authId(Users))
|
|
123
|
+
* }
|
|
124
|
+
*/
|
|
125
|
+
export type RuleMap<K extends string = string> = {
|
|
126
|
+
list?: ExprNode<K>;
|
|
127
|
+
view?: ExprNode<K>;
|
|
128
|
+
create?: ExprNode<K>;
|
|
129
|
+
update?: ExprNode<K>;
|
|
130
|
+
delete?: ExprNode<K>;
|
|
131
|
+
};
|
|
132
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/rule/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,IAC1D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC7B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;CAAE,GAC7E;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACrE;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAA;CAAE,GAC/F;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;IAAC,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAA;AAE1G;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAC1C;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC3D;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC5D;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC3D;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC5D;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC3D;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC5D;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GAC3D;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;CAAE,GACpD;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;CAAE,GACnD;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;CAAE,GAChC;IAAE,EAAE,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GACnE;IAAE,EAAE,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,CAAA;CAAE,GACjE;IAAE,EAAE,EAAE,QAAQ,CAAA;CAAE,CAAA;AAEpB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;IAC/C,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAClB,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAClB,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IACpB,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IACpB,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;CACrB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/rule/types.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auth.test.d.ts","sourceRoot":"","sources":["../../../tests/collection/auth.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { AuthCollection } from "../../src/collection/auth.js";
|
|
3
|
+
import { Field } from "../../src/collection/field.js";
|
|
4
|
+
const ID_PROPERTY = { type: "string", "x-system": true };
|
|
5
|
+
const SEQID_PROPERTY = { type: "integer", "x-kind": "seqId", "x-system": true, "x-hidden": true };
|
|
6
|
+
const CREATED_PROPERTY = { type: "string", "x-system": true };
|
|
7
|
+
const UPDATED_PROPERTY = { type: "string", "x-system": true };
|
|
8
|
+
describe("AuthCollection", () => {
|
|
9
|
+
it("auth collection injects system fields", () => {
|
|
10
|
+
const Users = AuthCollection.define("users", { displayName: Field.text({ required: true }) });
|
|
11
|
+
expect(Users.schema).toEqual({
|
|
12
|
+
"x-collection-kind": "auth",
|
|
13
|
+
"x-indexes": [{ fields: ["email"], unique: true }],
|
|
14
|
+
type: "object",
|
|
15
|
+
properties: {
|
|
16
|
+
id: ID_PROPERTY,
|
|
17
|
+
seqId: SEQID_PROPERTY,
|
|
18
|
+
email: { type: "string", format: "email", "x-system": true },
|
|
19
|
+
password: { type: "string", "x-system": true, "x-hidden": true },
|
|
20
|
+
emailVerified: { type: "boolean", "x-system": true, default: false },
|
|
21
|
+
displayName: { type: "string" },
|
|
22
|
+
created: CREATED_PROPERTY,
|
|
23
|
+
updated: UPDATED_PROPERTY
|
|
24
|
+
},
|
|
25
|
+
required: ["email", "password", "displayName"]
|
|
26
|
+
});
|
|
27
|
+
});
|
|
28
|
+
it("auth collection with no extraFields", () => {
|
|
29
|
+
const Users = AuthCollection.define("users", {});
|
|
30
|
+
expect(Users.schema.properties).toHaveProperty("id");
|
|
31
|
+
expect(Users.schema.properties).toHaveProperty("email");
|
|
32
|
+
expect(Users.schema.properties).toHaveProperty("password");
|
|
33
|
+
expect(Users.schema.properties).toHaveProperty("seqId");
|
|
34
|
+
});
|
|
35
|
+
it("auto-injects id as system primary key before seqId", () => {
|
|
36
|
+
const Users = AuthCollection.define("users", {});
|
|
37
|
+
const keys = Object.keys(Users.schema.properties);
|
|
38
|
+
expect(Users.schema.properties.id).toEqual(ID_PROPERTY);
|
|
39
|
+
expect(keys.indexOf("id")).toBe(0);
|
|
40
|
+
expect(keys.indexOf("seqId")).toBe(1);
|
|
41
|
+
expect(Users.schema.required).not.toContain("id");
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
//# sourceMappingURL=auth.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auth.test.js","sourceRoot":"","sources":["../../../tests/collection/auth.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAE7C,MAAM,WAAW,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACxD,MAAM,cAAc,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACjG,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AAC7D,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AAE7D,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAA;QAE7F,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YAC3B,mBAAmB,EAAE,MAAM;YAC3B,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAClD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,EAAE,EAAE,WAAW;gBACf,KAAK,EAAE,cAAc;gBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE;gBAC5D,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE;gBAChE,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE;gBACpE,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC/B,OAAO,EAAE,gBAAgB;gBACzB,OAAO,EAAE,gBAAgB;aAC1B;YACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC;SAC/C,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAChD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QACpD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QACvD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;QAC1D,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAChD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACvD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACnD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base.test.d.ts","sourceRoot":"","sources":["../../../tests/collection/base.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { BaseCollection } from "../../src/collection/base.js";
|
|
3
|
+
import { Bytes } from "../../src/collection/bytes.js";
|
|
4
|
+
import { Field } from "../../src/collection/field.js";
|
|
5
|
+
const ID_PROPERTY = { type: "string", "x-system": true };
|
|
6
|
+
const SEQID_PROPERTY = { type: "integer", "x-kind": "seqId", "x-system": true, "x-hidden": true };
|
|
7
|
+
const CREATED_PROPERTY = { type: "string", "x-system": true };
|
|
8
|
+
const UPDATED_PROPERTY = { type: "string", "x-system": true };
|
|
9
|
+
describe("BaseCollection", () => {
|
|
10
|
+
it("full base collection schema matches expected", () => {
|
|
11
|
+
const Users = BaseCollection.define("users", { email: Field.email() });
|
|
12
|
+
const Posts = BaseCollection.define("posts", {
|
|
13
|
+
title: Field.text({ maxLength: 200 }),
|
|
14
|
+
content: Field.text({ required: false }),
|
|
15
|
+
published: Field.boolean({ default: false, indexed: true }),
|
|
16
|
+
userId: Field.relation(Users),
|
|
17
|
+
avatar: Field.file({ maxSize: Bytes.fromMB(5), mimeTypes: ["image/*"] })
|
|
18
|
+
}).indexes((I) => [I.unique("userId", "title")]);
|
|
19
|
+
expect(Posts.schema).toEqual({
|
|
20
|
+
"x-collection-kind": "base",
|
|
21
|
+
"x-indexes": [
|
|
22
|
+
{ fields: ["published"], unique: false },
|
|
23
|
+
{ fields: ["userId", "title"], unique: true }
|
|
24
|
+
],
|
|
25
|
+
type: "object",
|
|
26
|
+
properties: {
|
|
27
|
+
id: ID_PROPERTY,
|
|
28
|
+
seqId: SEQID_PROPERTY,
|
|
29
|
+
title: { type: "string", maxLength: 200 },
|
|
30
|
+
content: { type: "string" },
|
|
31
|
+
published: { type: "boolean", default: false },
|
|
32
|
+
userId: { type: "string", "x-kind": "relation", "x-collection": "users", "x-field": "id" },
|
|
33
|
+
avatar: { type: "string", "x-kind": "file", "x-maxSize": 5_242_880, "x-mimeTypes": ["image/*"] },
|
|
34
|
+
created: CREATED_PROPERTY,
|
|
35
|
+
updated: UPDATED_PROPERTY
|
|
36
|
+
},
|
|
37
|
+
required: ["title", "userId", "avatar"]
|
|
38
|
+
});
|
|
39
|
+
});
|
|
40
|
+
it("auto-injects id as system primary key before seqId", () => {
|
|
41
|
+
const Col = BaseCollection.define("posts", { title: Field.text() });
|
|
42
|
+
const keys = Object.keys(Col.schema.properties);
|
|
43
|
+
expect(Col.schema.properties.id).toEqual(ID_PROPERTY);
|
|
44
|
+
expect(keys.indexOf("id")).toBe(0);
|
|
45
|
+
expect(keys.indexOf("seqId")).toBe(1);
|
|
46
|
+
expect(Col.schema.required).not.toContain("id");
|
|
47
|
+
});
|
|
48
|
+
it("no indexes key when no indexes defined", () => {
|
|
49
|
+
const Col = BaseCollection.define("simple", { title: Field.text() });
|
|
50
|
+
expect(Col.schema).not.toHaveProperty("x-indexes");
|
|
51
|
+
});
|
|
52
|
+
it("base collection with rules", () => {
|
|
53
|
+
const Users = {
|
|
54
|
+
name: "users",
|
|
55
|
+
fields: {},
|
|
56
|
+
schema: {
|
|
57
|
+
"x-collection-kind": "auth",
|
|
58
|
+
type: "object",
|
|
59
|
+
properties: {}
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
const Col = BaseCollection.define("posts", { title: Field.text(), ownerId: Field.text() })
|
|
63
|
+
.rules((R) => ({
|
|
64
|
+
create: R.field("ownerId").eq(R.authId(Users))
|
|
65
|
+
}));
|
|
66
|
+
expect(Col.schema["x-rules"]).toBeDefined();
|
|
67
|
+
expect(Col.schema["x-rules"].create).toBeDefined();
|
|
68
|
+
});
|
|
69
|
+
});
|
|
70
|
+
//# sourceMappingURL=base.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base.test.js","sourceRoot":"","sources":["../../../tests/collection/base.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAC7C,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAI7C,MAAM,WAAW,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACxD,MAAM,cAAc,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACjG,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AAC7D,MAAM,gBAAgB,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AAE7D,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;QACtE,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE;YAC3C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;YACrC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YACxC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC3D,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC7B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;SACzE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAEhD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YAC3B,mBAAmB,EAAE,MAAM;YAC3B,WAAW,EAAE;gBACX,EAAE,MAAM,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE;gBACxC,EAAE,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;aAC9C;YACD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,EAAE,EAAE,WAAW;gBACf,KAAK,EAAE,cAAc;gBACrB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE;gBACzC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAC3B,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBAC9C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;gBAC1F,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,SAAS,CAAC,EAAE;gBAChG,OAAO,EAAE,gBAAgB;gBACzB,OAAO,EAAE,gBAAgB;aAC1B;YACD,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC;SACxC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACnE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;QAC/C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAA;QACrD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACrC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACpE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAA;IACpD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,KAAK,GAAqB;YAC9B,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,EAAE;YACV,MAAM,EAAE;gBACN,mBAAmB,EAAE,MAAM;gBAC3B,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF,CAAA;QACD,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;aACvF,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACb,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC/C,CAAC,CAAC,CAAA;QACL,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;QAC3C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAE,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAA;IACrD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bytes.test.d.ts","sourceRoot":"","sources":["../../../tests/collection/bytes.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { Bytes } from "../../src/collection/bytes.js";
|
|
3
|
+
describe("Bytes", () => {
|
|
4
|
+
it("fromKB", () => expect(Bytes.fromKB(1)).toBe(1024));
|
|
5
|
+
it("fromMB", () => expect(Bytes.fromMB(1)).toBe(1_048_576));
|
|
6
|
+
it("fromGB", () => expect(Bytes.fromGB(1)).toBe(1_073_741_824));
|
|
7
|
+
it("fromTB", () => expect(Bytes.fromTB(1)).toBe(1_099_511_627_776));
|
|
8
|
+
});
|
|
9
|
+
//# sourceMappingURL=bytes.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bytes.test.js","sourceRoot":"","sources":["../../../tests/collection/bytes.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAE7C,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IACtD,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;IAC3D,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAA;IAC/D,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAA;AACrE,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"field.test.d.ts","sourceRoot":"","sources":["../../../tests/collection/field.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
import { Field } from "../../src/collection/field.js";
|
|
3
|
+
function mockCollection(name, fields) {
|
|
4
|
+
return {
|
|
5
|
+
name,
|
|
6
|
+
fields,
|
|
7
|
+
schema: {
|
|
8
|
+
"x-collection-kind": "base",
|
|
9
|
+
type: "object",
|
|
10
|
+
properties: {}
|
|
11
|
+
}
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
describe("Field.text", () => {
|
|
15
|
+
it("defaults", () => {
|
|
16
|
+
const f = Field.text();
|
|
17
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "text" });
|
|
18
|
+
expect(f.required).toBeUndefined();
|
|
19
|
+
expect(f.unique).toBeUndefined();
|
|
20
|
+
});
|
|
21
|
+
it("with options", () => {
|
|
22
|
+
const f = Field.text({ maxLength: 100, unique: true });
|
|
23
|
+
expect(f).toMatchObject({ kind: "text", maxLength: 100, unique: true });
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
describe("Field.number", () => {
|
|
27
|
+
it("defaults", () => {
|
|
28
|
+
const f = Field.number();
|
|
29
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "number" });
|
|
30
|
+
});
|
|
31
|
+
it("with min/max", () => {
|
|
32
|
+
const f = Field.number({ min: 0, max: 100 });
|
|
33
|
+
expect(f).toMatchObject({ kind: "number", min: 0, max: 100 });
|
|
34
|
+
});
|
|
35
|
+
});
|
|
36
|
+
describe("Field.integer", () => {
|
|
37
|
+
it("defaults", () => {
|
|
38
|
+
const f = Field.integer();
|
|
39
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "integer" });
|
|
40
|
+
});
|
|
41
|
+
});
|
|
42
|
+
describe("Field.boolean", () => {
|
|
43
|
+
it("defaults", () => {
|
|
44
|
+
const f = Field.boolean();
|
|
45
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "boolean" });
|
|
46
|
+
});
|
|
47
|
+
it("with default", () => {
|
|
48
|
+
const f = Field.boolean({ default: true });
|
|
49
|
+
expect(f).toMatchObject({ kind: "boolean", default: true });
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
describe("Field.date", () => {
|
|
53
|
+
it("defaults", () => {
|
|
54
|
+
const f = Field.date();
|
|
55
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "date" });
|
|
56
|
+
});
|
|
57
|
+
});
|
|
58
|
+
describe("Field.email", () => {
|
|
59
|
+
it("defaults", () => {
|
|
60
|
+
const f = Field.email();
|
|
61
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "email" });
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
describe("Field.json", () => {
|
|
65
|
+
it("defaults", () => {
|
|
66
|
+
const f = Field.json();
|
|
67
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "json" });
|
|
68
|
+
});
|
|
69
|
+
});
|
|
70
|
+
describe("Field.literalText", () => {
|
|
71
|
+
it("stores literal values and kind", () => {
|
|
72
|
+
const f = Field.literalText({ literal: ["a", "b"] });
|
|
73
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "literalText", literal: ["a", "b"], _literal: ["a", "b"] });
|
|
74
|
+
});
|
|
75
|
+
it("returns ViewableFieldDef (has .view())", () => {
|
|
76
|
+
const f = Field.literalText({ literal: ["x"] });
|
|
77
|
+
expect(typeof f.view).toBe("function");
|
|
78
|
+
const viewed = f.view();
|
|
79
|
+
expect(viewed.viewOnly).toBe(true);
|
|
80
|
+
});
|
|
81
|
+
it("preserves required: false", () => {
|
|
82
|
+
const f = Field.literalText({ literal: ["a", "b"], required: false });
|
|
83
|
+
expect(f.required).toBe(false);
|
|
84
|
+
});
|
|
85
|
+
it("error callback is preserved", () => {
|
|
86
|
+
const f = Field.literalText({
|
|
87
|
+
literal: ["a", "b"],
|
|
88
|
+
error: (k) => k === "literal" ? "invalid role" : undefined
|
|
89
|
+
});
|
|
90
|
+
expect(typeof f.error).toBe("function");
|
|
91
|
+
expect(f.error("literal")).toBe("invalid role");
|
|
92
|
+
expect(f.error("type")).toBeUndefined();
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
describe("Field.file", () => {
|
|
96
|
+
it("defaults", () => {
|
|
97
|
+
const f = Field.file();
|
|
98
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "file" });
|
|
99
|
+
});
|
|
100
|
+
it("with maxSize and mimeTypes", () => {
|
|
101
|
+
const f = Field.file({ maxSize: 1024, mimeTypes: ["image/png"] });
|
|
102
|
+
expect(f).toMatchObject({ kind: "file", maxSize: 1024, mimeTypes: ["image/png"] });
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
describe("Field.seqId", () => {
|
|
106
|
+
it("defaults", () => {
|
|
107
|
+
const f = Field.seqId();
|
|
108
|
+
expect(f).toMatchObject({ _tag: "FieldDef", kind: "seqId" });
|
|
109
|
+
expect(f.required).toBeUndefined();
|
|
110
|
+
});
|
|
111
|
+
});
|
|
112
|
+
describe("Field.view()", () => {
|
|
113
|
+
it("text field can be marked view-only", () => {
|
|
114
|
+
const f = Field.text().view();
|
|
115
|
+
expect(f._tag).toBe("FieldDef");
|
|
116
|
+
expect(f.kind).toBe("text");
|
|
117
|
+
expect(f.viewOnly).toBe(true);
|
|
118
|
+
});
|
|
119
|
+
it("view-only preserves builder options", () => {
|
|
120
|
+
const f = Field.text({ maxLength: 200 }).view();
|
|
121
|
+
expect(f.maxLength).toBe(200);
|
|
122
|
+
expect(f.viewOnly).toBe(true);
|
|
123
|
+
});
|
|
124
|
+
it("integer field can be marked view-only", () => {
|
|
125
|
+
const f = Field.integer({ min: 0, max: 999 }).view();
|
|
126
|
+
expect(f.viewOnly).toBe(true);
|
|
127
|
+
expect(f.min).toBe(0);
|
|
128
|
+
});
|
|
129
|
+
it("relation field can be marked view-only", () => {
|
|
130
|
+
const col = { name: "users", fields: {}, schema: { "x-collection-kind": "base", type: "object", properties: {} } };
|
|
131
|
+
const f = Field.relation(col).view();
|
|
132
|
+
expect(f.viewOnly).toBe(true);
|
|
133
|
+
expect(f.kind).toBe("relation");
|
|
134
|
+
expect(f.targetCollection).toBe("users");
|
|
135
|
+
});
|
|
136
|
+
it("boolean default preserved after .view()", () => {
|
|
137
|
+
const f = Field.boolean({ default: true }).view();
|
|
138
|
+
expect(f.default).toBe(true);
|
|
139
|
+
expect(f.viewOnly).toBe(true);
|
|
140
|
+
});
|
|
141
|
+
it("Field.seqId does not expose .view()", () => {
|
|
142
|
+
const f = Field.seqId();
|
|
143
|
+
expect(f.view).toBeUndefined();
|
|
144
|
+
expect(f.viewOnly).toBeUndefined();
|
|
145
|
+
});
|
|
146
|
+
it("view() returns a new object, does not mutate", () => {
|
|
147
|
+
const base = Field.text();
|
|
148
|
+
const viewed = base.view();
|
|
149
|
+
expect(base.viewOnly).toBeUndefined();
|
|
150
|
+
expect(viewed.viewOnly).toBe(true);
|
|
151
|
+
});
|
|
152
|
+
});
|
|
153
|
+
describe("Field.relation", () => {
|
|
154
|
+
it("resolves collection name at call time", () => {
|
|
155
|
+
const Users = mockCollection("users", { email: Field.email() });
|
|
156
|
+
const f = Field.relation(Users);
|
|
157
|
+
expect(f).toMatchObject({ kind: "relation", targetCollection: "users", targetField: "id" });
|
|
158
|
+
});
|
|
159
|
+
it("accepts explicit field", () => {
|
|
160
|
+
const Users = mockCollection("users", { email: Field.email() });
|
|
161
|
+
const f = Field.relation(Users, { field: "email" });
|
|
162
|
+
expect(f.targetField).toBe("email");
|
|
163
|
+
});
|
|
164
|
+
});
|
|
165
|
+
//# sourceMappingURL=field.test.js.map
|