@nymphjs/client 1.0.0-beta.111 → 1.0.0-beta.112

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/CHANGELOG.md CHANGED
@@ -3,6 +3,12 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [1.0.0-beta.112](https://forge.sciactive.com/sciactive/nymphjs/compare/v1.0.0-beta.111...v1.0.0-beta.112) (2026-04-03)
7
+
8
+ ### Features
9
+
10
+ - add acRequest query option ([600b617](https://forge.sciactive.com/sciactive/nymphjs/commits/600b617692b7ba0824e6ee91c0c9f9c29156fbe3))
11
+
6
12
  # [1.0.0-beta.111](https://github.com/sciactive/nymphjs/compare/v1.0.0-beta.110...v1.0.0-beta.111) (2026-03-10)
7
13
 
8
14
  **Note:** Version bump only for package @nymphjs/client
@@ -94,6 +94,13 @@ export type Options<T extends EntityConstructor = EntityConstructor> = {
94
94
  * If true, Nymph will skip the cache and retrieve the entity from the DB.
95
95
  */
96
96
  skipCache?: boolean;
97
+ /**
98
+ * The level(s) of access control requested.
99
+ *
100
+ * Limiting the access control can significantly improve the performance of
101
+ * the query.
102
+ */
103
+ acRequest?: TilmeldAccessRequest;
97
104
  };
98
105
  export type Clause<C> = C | Exclude<C, undefined>[];
99
106
  export type OrWithTime<T> = T | [string, null, string];
@@ -174,4 +181,47 @@ export type Selector = {
174
181
  selector?: Clause<Selector>;
175
182
  '!selector'?: Selector['selector'];
176
183
  };
184
+ export declare enum TilmeldAccessRequest {
185
+ /**
186
+ * The default level, any possible entity readable by the user.
187
+ *
188
+ * This is the same as or-ing together all of the levels listed below.
189
+ */
190
+ ALL_LEVELS = 0,
191
+ /**
192
+ * Owned by and accessible to the user.
193
+ *
194
+ * This is always enabled, so not including it has no effect. It's here to
195
+ * allow the selection of _only_ user owned entities.
196
+ */
197
+ USER_OWNED = 1,
198
+ /**
199
+ * Owned by and accessible to the user's primary group.
200
+ */
201
+ PRIMARY_GROUP_OWNED = 2,
202
+ /**
203
+ * Owned by and accessible to one of the user's secondary groups.
204
+ */
205
+ SECONDARY_GROUP_OWNED = 4,
206
+ /**
207
+ * The user is listed in an access control list.
208
+ */
209
+ USER_ACCESSIBLE = 8,
210
+ /**
211
+ * The user's primary group is listed in an access control list.
212
+ */
213
+ PRIMARY_GROUP_ACCESSIBLE = 16,
214
+ /**
215
+ * One of the user's secondary groups is listed in an access control list.
216
+ */
217
+ SECONDARY_GROUP_ACCESSIBLE = 32,
218
+ /**
219
+ * The entity is accessible to any user.
220
+ */
221
+ OTHER_ACCESSIBLE = 64,
222
+ /**
223
+ * The entity is not owned by anyone.
224
+ */
225
+ UNOWNED = 128
226
+ }
177
227
  export {};
@@ -1,2 +1,45 @@
1
- export {};
1
+ export var TilmeldAccessRequest;
2
+ (function (TilmeldAccessRequest) {
3
+ /**
4
+ * The default level, any possible entity readable by the user.
5
+ *
6
+ * This is the same as or-ing together all of the levels listed below.
7
+ */
8
+ TilmeldAccessRequest[TilmeldAccessRequest["ALL_LEVELS"] = 0] = "ALL_LEVELS";
9
+ /**
10
+ * Owned by and accessible to the user.
11
+ *
12
+ * This is always enabled, so not including it has no effect. It's here to
13
+ * allow the selection of _only_ user owned entities.
14
+ */
15
+ TilmeldAccessRequest[TilmeldAccessRequest["USER_OWNED"] = 1] = "USER_OWNED";
16
+ /**
17
+ * Owned by and accessible to the user's primary group.
18
+ */
19
+ TilmeldAccessRequest[TilmeldAccessRequest["PRIMARY_GROUP_OWNED"] = 2] = "PRIMARY_GROUP_OWNED";
20
+ /**
21
+ * Owned by and accessible to one of the user's secondary groups.
22
+ */
23
+ TilmeldAccessRequest[TilmeldAccessRequest["SECONDARY_GROUP_OWNED"] = 4] = "SECONDARY_GROUP_OWNED";
24
+ /**
25
+ * The user is listed in an access control list.
26
+ */
27
+ TilmeldAccessRequest[TilmeldAccessRequest["USER_ACCESSIBLE"] = 8] = "USER_ACCESSIBLE";
28
+ /**
29
+ * The user's primary group is listed in an access control list.
30
+ */
31
+ TilmeldAccessRequest[TilmeldAccessRequest["PRIMARY_GROUP_ACCESSIBLE"] = 16] = "PRIMARY_GROUP_ACCESSIBLE";
32
+ /**
33
+ * One of the user's secondary groups is listed in an access control list.
34
+ */
35
+ TilmeldAccessRequest[TilmeldAccessRequest["SECONDARY_GROUP_ACCESSIBLE"] = 32] = "SECONDARY_GROUP_ACCESSIBLE";
36
+ /**
37
+ * The entity is accessible to any user.
38
+ */
39
+ TilmeldAccessRequest[TilmeldAccessRequest["OTHER_ACCESSIBLE"] = 64] = "OTHER_ACCESSIBLE";
40
+ /**
41
+ * The entity is not owned by anyone.
42
+ */
43
+ TilmeldAccessRequest[TilmeldAccessRequest["UNOWNED"] = 128] = "UNOWNED";
44
+ })(TilmeldAccessRequest || (TilmeldAccessRequest = {}));
2
45
  //# sourceMappingURL=Nymph.types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"Nymph.types.js","sourceRoot":"","sources":["../src/Nymph.types.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"Nymph.types.js","sourceRoot":"","sources":["../src/Nymph.types.ts"],"names":[],"mappings":"AAoOA,MAAM,CAAN,IAAY,oBA0CX;AA1CD,WAAY,oBAAoB;IAC9B;;;;OAIG;IACH,2EAAc,CAAA;IACd;;;;;OAKG;IACH,2EAAc,CAAA;IACd;;OAEG;IACH,6FAAuB,CAAA;IACvB;;OAEG;IACH,iGAAyB,CAAA;IACzB;;OAEG;IACH,qFAAmB,CAAA;IACnB;;OAEG;IACH,wGAA6B,CAAA;IAC7B;;OAEG;IACH,4GAA+B,CAAA;IAC/B;;OAEG;IACH,wFAAqB,CAAA;IACrB;;OAEG;IACH,uEAAa,CAAA;AACf,CAAC,EA1CW,oBAAoB,KAApB,oBAAoB,QA0C/B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nymphjs/client",
3
- "version": "1.0.0-beta.111",
3
+ "version": "1.0.0-beta.112",
4
4
  "description": "Nymph.js - Client",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -23,11 +23,11 @@
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
26
- "url": "git+https://github.com/sciactive/nymphjs.git"
26
+ "url": "git+https://forge.sciactive.com/sciactive/nymphjs.git"
27
27
  },
28
28
  "author": "Hunter Perrin <hperrin@gmail.com>",
29
29
  "bugs": {
30
- "url": "https://github.com/sciactive/nymphjs/issues"
30
+ "url": "https://forge.sciactive.com/sciactive/nymphjs/issues"
31
31
  },
32
32
  "license": "Apache-2.0",
33
33
  "dependencies": {
@@ -43,5 +43,5 @@
43
43
  "ts-node": "^10.9.2",
44
44
  "typescript": "^5.9.3"
45
45
  },
46
- "gitHead": "8028358367d8fd89bb434f122b243bec4c71f2e1"
46
+ "gitHead": "20157c196abcc9dcc70c1dff207cbea35a32f69f"
47
47
  }
@@ -99,6 +99,13 @@ export type Options<T extends EntityConstructor = EntityConstructor> = {
99
99
  * If true, Nymph will skip the cache and retrieve the entity from the DB.
100
100
  */
101
101
  skipCache?: boolean;
102
+ /**
103
+ * The level(s) of access control requested.
104
+ *
105
+ * Limiting the access control can significantly improve the performance of
106
+ * the query.
107
+ */
108
+ acRequest?: TilmeldAccessRequest;
102
109
  };
103
110
 
104
111
  export type Clause<C> = C | Exclude<C, undefined>[];
@@ -218,3 +225,47 @@ export type Selector = {
218
225
  selector?: Clause<Selector>;
219
226
  '!selector'?: Selector['selector'];
220
227
  };
228
+
229
+ export enum TilmeldAccessRequest {
230
+ /**
231
+ * The default level, any possible entity readable by the user.
232
+ *
233
+ * This is the same as or-ing together all of the levels listed below.
234
+ */
235
+ ALL_LEVELS = 0,
236
+ /**
237
+ * Owned by and accessible to the user.
238
+ *
239
+ * This is always enabled, so not including it has no effect. It's here to
240
+ * allow the selection of _only_ user owned entities.
241
+ */
242
+ USER_OWNED = 1,
243
+ /**
244
+ * Owned by and accessible to the user's primary group.
245
+ */
246
+ PRIMARY_GROUP_OWNED = 2,
247
+ /**
248
+ * Owned by and accessible to one of the user's secondary groups.
249
+ */
250
+ SECONDARY_GROUP_OWNED = 4,
251
+ /**
252
+ * The user is listed in an access control list.
253
+ */
254
+ USER_ACCESSIBLE = 8,
255
+ /**
256
+ * The user's primary group is listed in an access control list.
257
+ */
258
+ PRIMARY_GROUP_ACCESSIBLE = 16,
259
+ /**
260
+ * One of the user's secondary groups is listed in an access control list.
261
+ */
262
+ SECONDARY_GROUP_ACCESSIBLE = 32,
263
+ /**
264
+ * The entity is accessible to any user.
265
+ */
266
+ OTHER_ACCESSIBLE = 64,
267
+ /**
268
+ * The entity is not owned by anyone.
269
+ */
270
+ UNOWNED = 128,
271
+ }