@researchdatabox/redbox-core 0.0.0-bootstrap.0

package/dist/controllers/RecordController.d.ts

@@ -0,0 +1,114 @@
+import { Observable } from 'rxjs';
+import { Controllers as controllers, DatastreamService, RecordsService, SearchService, BrandingModel, RecordModel } from '../index';
+import { Server as TusServer } from '@tus/server';
+type AnyRecord = Record<string, unknown>;
+type HeaderValue = string | number | ReadonlyArray<string>;
+/**
+ * Package that contains all Controllers.
+ */
+export declare namespace Controllers {
+    /**
+     * Responsible for all things related to a Record, includings Forms, etc.
+     *
+     * Author: <a href='https://github.com/shilob' target='_blank'>Shilo Banihit</a>
+     */
+    class Record extends controllers.Core.Controller {
+        recordsService: RecordsService;
+        searchService: SearchService;
+        datastreamService: DatastreamService;
+        init(): void;
+        /**
+         * Exported methods, accessible from internet.
+         */
+        protected _exportedMethods: string[];
+        /**
+         **************************************************************************************************
+         **************************************** Add custom methods **************************************
+         **************************************************************************************************
+         */
+        bootstrap(): void;
+        private getErrorMessage;
+        private asError;
+        private getReqBrand;
+        getMeta(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        getMetaDefault(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        edit(req: Sails.Req, res: Sails.Res): void;
+        protected hasEditAccess(brand: BrandingModel, user: AnyRecord | undefined, currentRec: AnyRecord): Observable<boolean>;
+        protected hasViewAccess(brand: BrandingModel, user: AnyRecord | undefined, currentRec: AnyRecord): Observable<boolean>;
+        getForm(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        create(req: Sails.Req, res: Sails.Res): void;
+        private createInternal;
+        delete(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        restoreRecord(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        destroyDeletedRecord(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        update(req: Sails.Req, res: Sails.Res): void;
+        private updateInternal;
+        protected saveMetadata(brand: BrandingModel, oid: string, currentRec: AnyRecord, metadata: AnyRecord, user: AnyRecord): Observable<unknown>;
+        protected saveAuthorization(brand: BrandingModel, oid: string, currentRec: AnyRecord, authorization: unknown, user: AnyRecord): Observable<unknown>;
+        protected getRecord(oid: string): Observable<RecordModel>;
+        protected updateMetadata(brand: BrandingModel, oid: string, currentRec: AnyRecord, user: AnyRecord | undefined): Observable<unknown>;
+        protected updateAuthorization(brand: BrandingModel, oid: string, currentRec: AnyRecord, user: AnyRecord | undefined): Observable<unknown>;
+        stepTo(req: Sails.Req, res: Sails.Res): import("rxjs").Subscription;
+        search(req: Sails.Req, res: Sails.Res): Promise<void>;
+        /**
+         * Returns the RecordType configuration based of the response model that is intentionally restricting
+         * the object schema and information that is allowed to be sent back in this endpoint
+         */
+        getType(req: Sails.Req, res: Sails.Res): void;
+        /**
+         * Returns all RecordTypes configuration based of the response model that is intentionally restricting
+         * the object schema and information that is allowed to be sent back in this endpoint
+         */
+        getAllTypes(req: Sails.Req, res: Sails.Res): void;
+        getDashboardType(req: Sails.Req, res: Sails.Res): void;
+        getAllDashboardTypes(req: Sails.Req, res: Sails.Res): void;
+        protected tusServer: TusServer | null;
+        protected initTusServer(): void;
+        protected getTusMetadata(req: Sails.Req, field: string): string;
+        protected normalizeTusLocationHeader(locationHeader: HeaderValue, requestHost: string, prefix: string): string;
+        doAttachment(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>> | Observable<string> | undefined>;
+        getWorkflowSteps(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        getRelatedRecords(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        getRelatedRecordsInternal(req: Sails.Req, _res: Sails.Res): Promise<unknown>;
+        getPermissionsInternal(req: Sails.Req, _res: Sails.Res): Promise<{
+            edit: {
+                username: string;
+                name: string;
+                email: string;
+            }[];
+            view: {
+                username: string;
+                name: string;
+                email: string;
+            }[];
+            editRoles: unknown;
+            viewRoles: unknown;
+            editPending: unknown;
+            viewPending: unknown;
+        }>;
+        getPermissions(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>>>;
+        getAttachments(req: Sails.Req, res: Sails.Res): void;
+        getDataStream(req: Sails.Req, res: Sails.Res): Promise<import("express").Response<any, globalThis.Record<string, any>> | Observable<string>>;
+        /**
+         **************************************************************************************************
+         **************************************** Override magic methods **********************************
+         **************************************************************************************************
+         */
+        /** Dashboard Controller functions */
+        listWorkspaces(req: Sails.Req, res: Sails.Res): void;
+        render(req: Sails.Req, res: Sails.Res): Promise<void>;
+        getRecordList(req: Sails.Req, res: Sails.Res): Promise<void>;
+        getDeletedRecordList(req: Sails.Req, res: Sails.Res): Promise<void>;
+        renderDeletedRecords(req: Sails.Req, res: Sails.Res): void;
+        private getDocMetadata;
+        protected getRecords(workflowState: unknown, recordType: unknown, start: unknown, rows: unknown, user: AnyRecord, roles: AnyRecord[], brand: BrandingModel, editAccessOnly?: unknown, packageType?: unknown, sort?: unknown, filterFields?: unknown, filterString?: unknown, filterMode?: unknown, secondarySort?: unknown): Promise<{
+            [key: string]: unknown;
+        } | null>;
+        protected getDeletedRecords(workflowState: unknown, recordType: unknown, start: unknown, rows: unknown, user: AnyRecord, roles: AnyRecord[], brand: BrandingModel, editAccessOnly?: unknown, packageType?: unknown, sort?: unknown, filterFields?: unknown, filterString?: unknown, filterMode?: unknown): Promise<{
+            [key: string]: unknown;
+        } | null>;
+        private mergeRecordMetadata;
+    }
+}
+export {};
+//# sourceMappingURL=RecordController.d.ts.map

package/dist/controllers/RecordController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordController.d.ts","sourceRoot":"","sources":["../../src/controllers/RecordController.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,UAAU,EACX,MAAM,MAAM,CAAC;AAEd,OAAO,EAGL,WAAW,IAAI,WAAW,EAC1B,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,aAAa,EAEb,WAAW,EAGZ,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,MAAM,IAAI,SAAS,EAAU,MAAM,aAAa,CAAC;AAS1D,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAOzC,KAAK,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAG3D;;GAEG;AAEH,yBAAiB,WAAW,CAAC;IAC3B;;;;OAIG;IACH,MAAa,MAAO,SAAQ,WAAW,CAAC,IAAI,CAAC,UAAU;QAErD,cAAc,EAAG,cAAc,CAAC;QAChC,aAAa,EAAG,aAAa,CAAC;QAC9B,iBAAiB,EAAG,iBAAiB,CAAC;QAE/B,IAAI,IAAI,IAAI;QAenB;;WAEG;QACH,UAAmB,gBAAgB,EAAE,MAAM,EAAE,CA8B3C;QAEF;;;;WAIG;QAEI,SAAS;QAmBhB,OAAO,CAAC,eAAe;QAOvB,OAAO,CAAC,OAAO;QAIf,OAAO,CAAC,WAAW;QAIN,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QA6EtC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAgCnD,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QA8F1C,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAOtH,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAOzG,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAoI5C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;gBAI9B,cAAc;QA2Cf,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QA2CrC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QA2C5C,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAqCzD,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;gBAI9B,cAAc;QA0D5B,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAK3I,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAgBnJ,SAAS,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC;QAUzD,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAYpI,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC;QAQlI,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAqD/B,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAgElD;;;WAGG;QACI,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAc7C;;;WAGG;QACI,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAc1C,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAa/C,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAgB1D,SAAS,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAQ;QAE7C,SAAS,CAAC,aAAa;QA8DvB,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;QAS/D,SAAS,CAAC,0BAA0B,CAAC,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;QAyCjG,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAqL3C,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAsBrD,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAM1C,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;QAYzD,sBAAsB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG;;;;;;;;;;;;;;;;QA+C5D,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAO7C,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAQvC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAwCzD;;;;WAIG;QAGH,qCAAqC;QAE9B,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAKvC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAoCrC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAwE5C,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAiEzD,oBAAoB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG;QAK1D,OAAO,CAAC,cAAc;kBAaN,UAAU,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,GAAE,OAAmB,EAAE,WAAW,GAAE,OAAmB,EAAE,IAAI,GAAE,OAAmB,EAAE,YAAY,GAAE,OAAmB,EAAE,YAAY,GAAE,OAAmB,EAAE,UAAU,GAAE,OAAmB,EAAE,aAAa,GAAE,OAAmB;;;kBA4C7X,iBAAiB,CAAC,aAAa,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,GAAE,OAAmB,EAAE,WAAW,GAAE,OAAmB,EAAE,IAAI,GAAE,OAAmB,EAAE,YAAY,GAAE,OAAmB,EAAE,YAAY,GAAE,OAAmB,EAAE,UAAU,GAAE,OAAmB;;;QA4ChX,OAAO,CAAC,mBAAmB;KAY5B;CACF"}