@nymphjs/client 1.0.0-beta.12 → 1.0.0-beta.121

package/src/Nymph.types.ts

@@ -1,4 +1,4 @@
-import { EntityConstructor, EntityInterface } from './Entity.types';
+import { EntityConstructor, EntityInterface } from './Entity.types.js';
 
 export type NymphOptions = {
   /**
@@ -17,10 +17,18 @@ export type NymphOptions = {
    * A WebSocket implementation.
    */
   WebSocket?: typeof WebSocket;
+  /**
+   * Return `null` or empty array instead of error when entity/ies not found.
+   */
+  returnNullOnNotFound?: boolean;
   /**
    * Whether to not output status messages to the console.
    */
   noConsole?: boolean;
+  /**
+   * Don't automatically try to connect to PubSub server.
+   */
+  noAutoconnect?: boolean;
   /**
    * Use a WeakRef based cache of entities.
    *
@@ -40,6 +48,16 @@ export type NymphOptions = {
    * can help to synchronize them correctly and avoid data conflicts.
    */
   weakCache?: boolean;
+  /**
+   * Whether to renew tokens when a request is made.
+   *
+   * If you turn this off, the client will request that the server not renew an
+   * authentication token, even if it is within the renewal time of the
+   * expiration date.
+   *
+   * This defaults to true.
+   */
+  renewTokens?: boolean;
 };
 
 export type EventType = 'request' | 'response';
@@ -49,13 +67,45 @@ export type RequestCallback = (url: string, options: RequestInit) => void;
 export type ResponseCallback = (response: Response, text: string) => void;
 
 export type Options<T extends EntityConstructor = EntityConstructor> = {
+  /**
+   * The Entity class to query.
+   */
   class: T;
+  /**
+   * The limit of entities to be returned. Not needed when using `getEntity`, as
+   * it always returns only one.
+   */
   limit?: number;
+  /**
+   * The offset from the first matching entity, in order, to start retrieving.
+   */
   offset?: number;
+  /**
+   * If true, entities will be retrieved from newest to oldest/largest to
+   * smallest (with regard to `sort`).
+   */
   reverse?: boolean;
-  sort?: 'cdate' | 'mdate';
+  /**
+   * How to sort the entities. Should be "cdate", "mdate", the name of a
+   * property, or null.
+   */
+  sort?: 'cdate' | 'mdate' | string | null;
+  /**
+   * What to return, the entities with their data, just the GUIDs, or just a
+   * count.
+   */
   return?: 'entity' | 'guid' | 'count';
+  /**
+   * If true, Nymph will skip the cache and retrieve the entity from the DB.
+   */
   skipCache?: boolean;
+  /**
+   * The level(s) of access control requested.
+   *
+   * Limiting the access control can significantly improve the performance of
+   * the query.
+   */
+  acRequest?: TilmeldAccessRequest;
 };
 
 export type Clause<C> = C | Exclude<C, undefined>[];
@@ -81,6 +131,9 @@ type PrimitiveSelector = {
   contain?: [string, any];
   '!contain'?: PrimitiveSelector['contain'];
 
+  search?: [string, string];
+  '!search'?: PrimitiveSelector['search'];
+
   match?: [string, string];
   '!match'?: PrimitiveSelector['match'];
 
@@ -136,6 +189,9 @@ export type Selector = {
   contain?: Clause<OrWithTime<PrimitiveSelector['contain']>>;
   '!contain'?: Clause<OrWithTime<PrimitiveSelector['contain']>>;
 
+  search?: Clause<PrimitiveSelector['search']>;
+  '!search'?: Clause<PrimitiveSelector['search']>;
+
   match?: Clause<PrimitiveSelector['match']>;
   '!match'?: Clause<PrimitiveSelector['match']>;
 
@@ -169,3 +225,47 @@ export type Selector = {
   selector?: Clause<Selector>;
   '!selector'?: Selector['selector'];
 };
+
+export enum TilmeldAccessRequest {
+  /**
+   * The default level, any possible entity readable by the user.
+   *
+   * This is the same as or-ing together all of the levels listed below.
+   */
+  ALL_LEVELS = 0,
+  /**
+   * Owned by and accessible to the user.
+   *
+   * This is always enabled, so not including it has no effect. It's here to
+   * allow the selection of _only_ user owned entities.
+   */
+  USER_OWNED = 1,
+  /**
+   * Owned by and accessible to the user's primary group.
+   */
+  PRIMARY_GROUP_OWNED = 2,
+  /**
+   * Owned by and accessible to one of the user's secondary groups.
+   */
+  SECONDARY_GROUP_OWNED = 4,
+  /**
+   * The user is listed in an access control list.
+   */
+  USER_ACCESSIBLE = 8,
+  /**
+   * The user's primary group is listed in an access control list.
+   */
+  PRIMARY_GROUP_ACCESSIBLE = 16,
+  /**
+   * One of the user's secondary groups is listed in an access control list.
+   */
+  SECONDARY_GROUP_ACCESSIBLE = 32,
+  /**
+   * The entity is accessible to any user.
+   */
+  OTHER_ACCESSIBLE = 64,
+  /**
+   * The entity is not owned by anyone.
+   */
+  UNOWNED = 128,
+}