@memberjunction/server 3.4.0 → 4.0.0

package/dist/rest/RESTEndpointHandler.d.ts

@@ -1,41 +1,161 @@
 import express from 'express';
+/**
+ * Configuration options for RESTEndpointHandler
+ */
 export interface RESTEndpointHandlerOptions {
+    /**
+     * Array of entity names to include in the API (case-insensitive)
+     * If provided, only these entities will be accessible through the REST API
+     * Supports wildcards using '*' (e.g., 'User*' matches 'User', 'UserRole', etc.)
+     */
     includeEntities?: string[];
+    /**
+     * Array of entity names to exclude from the API (case-insensitive)
+     * These entities will not be accessible through the REST API
+     * Supports wildcards using '*' (e.g., 'Secret*' matches 'Secret', 'SecretKey', etc.)
+     * Note: Exclude patterns always override include patterns
+     */
     excludeEntities?: string[];
+    /**
+     * Array of schema names to include in the API (case-insensitive)
+     * If provided, only entities in these schemas will be accessible through the REST API
+     */
     includeSchemas?: string[];
+    /**
+     * Array of schema names to exclude from the API (case-insensitive)
+     * Entities in these schemas will not be accessible through the REST API
+     * Note: Exclude patterns always override include patterns
+     */
     excludeSchemas?: string[];
 }
+/**
+ * RESTEndpointHandler provides REST API functionality for MemberJunction entities
+ * This class handles request routing and processing for a /rest endpoint that exposes
+ * entity operations via REST instead of GraphQL
+ */
 export declare class RESTEndpointHandler {
     private router;
     private options;
     constructor(options?: RESTEndpointHandlerOptions);
+    /**
+     * Helper to safely extract a string from Express route params
+     * Express 5.x types params as string | string[] | undefined
+     */
+    private getStringParam;
+    /**
+     * Determines if an entity is allowed based on include/exclude lists
+     * with support for wildcards and schema-level filtering
+     * @param entityName The name of the entity to check
+     * @returns True if the entity is allowed, false otherwise
+     */
     private isEntityAllowed;
+    /**
+     * Set up all the API routes for the REST endpoints
+     */
     private setupRoutes;
+    /**
+     * Middleware to check entity access based on include/exclude lists
+     */
     private checkEntityAccess;
+    /**
+     * Middleware to extract MJ user from request
+     */
     private extractMJUser;
+    /**
+     * Error handling middleware
+     */
     private errorHandler;
+    /**
+     * Get the current user
+     */
     private getCurrentUser;
+    /**
+     * Lists entities with optional filtering
+     */
     private getEntityList;
+    /**
+     * Get a single entity by ID
+     */
     private getEntity;
+    /**
+     * Create a new entity
+     */
     private createEntity;
+    /**
+     * Update an existing entity
+     */
     private updateEntity;
+    /**
+     * Delete an entity
+     */
     private deleteEntity;
+    /**
+     * Get record changes for an entity
+     */
     private getRecordChanges;
+    /**
+     * Get record dependencies for an entity
+     */
     private getRecordDependencies;
+    /**
+     * Get entity record name
+     */
     private getEntityRecordName;
+    /**
+     * Run a view
+     */
     private runView;
+    /**
+     * Run multiple views in batch
+     */
     private runViews;
+    /**
+     * Get entity for a view
+     */
     private getViewEntity;
+    /**
+     * Get metadata for all entities
+     */
     private getEntityMetadata;
+    /**
+     * Get field metadata for a specific entity
+     */
     private getEntityFieldMetadata;
+    /**
+     * Get metadata about available views for an entity
+     */
     private getViewsMetadata;
+    /**
+     * Get favorite status for a record
+     */
     private getRecordFavoriteStatus;
+    /**
+     * Set favorite status for a record
+     */
     private setRecordFavoriteStatus;
+    /**
+     * Remove favorite status for a record
+     */
     private removeRecordFavoriteStatus;
+    /**
+     * Execute a transaction
+     */
     private executeTransaction;
+    /**
+     * Run a report
+     */
     private runReport;
+    /**
+     * Run a query
+     */
     private runQuery;
+    /**
+     * Helper method to create a composite key from an ID
+     */
     private createCompositeKey;
+    /**
+     * Get the Express router with all configured routes
+     */
     getRouter(): express.Router;
 }
 //# sourceMappingURL=RESTEndpointHandler.d.ts.map

package/dist/rest/RESTEndpointHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RESTEndpointHandler.d.ts","sourceRoot":"","sources":["../../src/rest/RESTEndpointHandler.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAY9B,MAAM,WAAW,0BAA0B;IAMvC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAQ3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAM3B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAO1B,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAOD,qBAAa,mBAAmB;IAC5B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,OAAO,CAA6B;gBAEhC,OAAO,GAAE,0BAA+B;IAYpD,OAAO,CAAC,eAAe;IAwEvB,OAAO,CAAC,WAAW;IAwDnB,OAAO,CAAC,iBAAiB;YAsBX,aAAa;IA8B3B,OAAO,CAAC,YAAY;YAcN,cAAc;YA2Bd,aAAa;YA4Bb,SAAS;YAwBT,YAAY;YA0BZ,YAAY;YA0BZ,YAAY;YA6BZ,gBAAgB;YA2BhB,qBAAqB;YA2BrB,mBAAmB;YA0BnB,OAAO;YA6BP,QAAQ;YAuCR,aAAa;YAuBb,iBAAiB;YAuCjB,sBAAsB;YA4CtB,gBAAgB;YAoBhB,uBAAuB;YA0BvB,uBAAuB;YA0BvB,0BAA0B;YA0B1B,kBAAkB;YAalB,SAAS;YAaT,QAAQ;IAatB,OAAO,CAAC,kBAAkB;IAsBnB,SAAS,IAAI,OAAO,CAAC,MAAM;CAGrC"}
+{"version":3,"file":"RESTEndpointHandler.d.ts","sourceRoot":"","sources":["../../src/rest/RESTEndpointHandler.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAS9B;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,mBAAmB;IAC5B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,OAAO,CAA6B;gBAEhC,OAAO,GAAE,0BAA+B;IAMpD;;;OAGG;IACH,OAAO,CAAC,cAAc;IAOtB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAqEvB;;OAEG;IACH,OAAO,CAAC,WAAW;IAqDnB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmBzB;;OAEG;YACW,aAAa;IA2B3B;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;YACW,cAAc;IAwB5B;;OAEG;YACW,aAAa;IAyB3B;;OAEG;YACW,SAAS;IAsBvB;;OAEG;YACW,YAAY;IAuB1B;;OAEG;YACW,YAAY;IAwB1B;;OAEG;YACW,YAAY;IA2B1B;;OAEG;YACW,gBAAgB;IAyB9B;;OAEG;YACW,qBAAqB;IAyBnC;;OAEG;YACW,mBAAmB;IAwBjC;;OAEG;YACW,OAAO;IA0BrB;;OAEG;YACW,QAAQ;IAoCtB;;OAEG;YACW,aAAa;IAoB3B;;OAEG;YACW,iBAAiB;IAoC/B;;OAEG;YACW,sBAAsB;IAyCpC;;OAEG;YACW,gBAAgB;IAiB9B;;OAEG;YACW,uBAAuB;IAyBrC;;OAEG;YACW,uBAAuB;IAyBrC;;OAEG;YACW,0BAA0B;IAyBxC;;OAEG;YACW,kBAAkB;IAUhC;;OAEG;YACW,SAAS;IAUvB;;OAEG;YACW,QAAQ;IAUtB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAmB1B;;OAEG;IACI,SAAS,IAAI,OAAO,CAAC,MAAM;CAGrC"}