remult 3.0.0-next.2 → 3.0.0-next.4

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.
@@ -45,6 +45,8 @@ export interface AdminEntitiesOptions {
45
45
  export interface AdminDisplayOptions {
46
46
  rootPath: string;
47
47
  head: string;
48
+ requireAuthToken: boolean;
49
+ withLiveQuery: boolean;
48
50
  }
49
51
  export default function remultAdminHtml(options: AdminDisplayOptions): string;
50
52
  export declare function buildEntityInfo(options: AdminEntitiesOptions): EntityUIInfo[];
@@ -9,10 +9,10 @@ var get_remult_admin_html_js_1 = require("./get-remult-admin-html.js");
9
9
  var RepositoryImplementation_js_1 = require("../src/remult3/RepositoryImplementation.js");
10
10
  var inputTypes_js_1 = require("../inputTypes.js");
11
11
  function remultAdminHtml(options) {
12
- var rootPath = options.rootPath, head = options.head;
12
+ var rootPath = options.rootPath, head = options.head, requireAuthToken = options.requireAuthToken, withLiveQuery = options.withLiveQuery;
13
13
  return (0, get_remult_admin_html_js_1.getHtml)()
14
14
  .replace('<!--PLACE_HERE_HEAD-->', head)
15
- .replace('<!--PLACE_HERE_BODY-->', "<script>\n window.optionsFromServer = ".concat(JSON.stringify({ rootPath: rootPath }), "\n</script>"));
15
+ .replace('<!--PLACE_HERE_BODY-->', "<script>\n window.optionsFromServer = ".concat(JSON.stringify({ rootPath: rootPath, requireAuthToken: requireAuthToken, withLiveQuery: withLiveQuery }), "\n</script>"));
16
16
  }
17
17
  function buildEntityInfo(options) {
18
18
  var e_1, _a;
@@ -58,6 +58,8 @@ export interface RemultServerOptions<RequestType> {
58
58
  admin?: Allowed | {
59
59
  allow: Allowed;
60
60
  customHtmlHead?: (remult: Remult) => string;
61
+ requireAuthToken?: boolean;
62
+ withLiveQuery?: boolean;
61
63
  };
62
64
  /** Storage to use for backend methods that use queue */
63
65
  queueStorage?: QueueStorage;
@@ -364,9 +364,9 @@ var RemultServerImplementation = /** @class */ (function () {
364
364
  if (this.options.admin !== undefined && this.options.admin !== false) {
365
365
  var admin = function () {
366
366
  return _this.process(function (remult, req, res, orig, origResponse) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
367
- var allowed, head;
368
- var _a, _b, _c;
369
- return tslib_1.__generator(this, function (_d) {
367
+ var allowed, head, requireAuthToken, withLiveQuery;
368
+ var _a, _b, _c, _d;
369
+ return tslib_1.__generator(this, function (_e) {
370
370
  allowed = (0, isOfType_js_1.isOfType)(this.options.admin, 'allow')
371
371
  ? this.options.admin.allow
372
372
  : this.options.admin;
@@ -379,13 +379,22 @@ var RemultServerImplementation = /** @class */ (function () {
379
379
  }
380
380
  else {
381
381
  head = '<title>Admin</title>';
382
+ requireAuthToken = false;
383
+ withLiveQuery = true;
382
384
  if ((0, isOfType_js_1.isOfType)(this.options.admin, 'allow') &&
383
385
  this.options.admin.customHtmlHead) {
384
386
  head = this.options.admin.customHtmlHead(remult);
387
+ requireAuthToken =
388
+ (_c = this.options.admin.requireAuthToken) !== null && _c !== void 0 ? _c : false;
389
+ if (this.options.admin.withLiveQuery === false) {
390
+ withLiveQuery = false;
391
+ }
385
392
  }
386
393
  origResponse.send((0, remult_admin_js_1.default)({
387
- rootPath: (_c = this.options.rootPath) !== null && _c !== void 0 ? _c : '/api',
394
+ rootPath: (_d = this.options.rootPath) !== null && _d !== void 0 ? _d : '/api',
388
395
  head: head,
396
+ requireAuthToken: requireAuthToken,
397
+ withLiveQuery: withLiveQuery,
389
398
  }));
390
399
  }
391
400
  }
package/src/context.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { ClassType } from '../classType.js';
2
- import type { DataProvider } from './data-interfaces.js';
2
+ import { type DataProvider } from './data-interfaces.js';
3
3
  import type { EntityMetadata, EntityRef, FindOptions, RefSubscriber, Repository } from './remult3/remult3.js';
4
4
  import type { ExternalHttpProvider } from './buildRestDataProvider.js';
5
5
  import type { SubscriptionClient, Unsubscribe } from './live-query/SubscriptionChannel.js';
package/src/context.js CHANGED
@@ -6,6 +6,7 @@ exports.setControllerSettings = setControllerSettings;
6
6
  exports.doTransaction = doTransaction;
7
7
  exports.withRemult = withRemult;
8
8
  var tslib_1 = require("tslib");
9
+ var data_interfaces_js_1 = require("./data-interfaces.js");
9
10
  var rest_data_provider_js_1 = require("./data-providers/rest-data-provider.js");
10
11
  var LiveQueryClient_js_1 = require("./live-query/LiveQueryClient.js");
11
12
  var SseSubscriptionClient_js_1 = require("./live-query/SseSubscriptionClient.js");
@@ -82,11 +83,22 @@ var Remult = /** @class */ (function () {
82
83
  * @param dataProvider - an optional alternative data provider to use. Useful for writing to offline storage or an alternative data provider
83
84
  */
84
85
  this.repo = function (entity, dataProvider) {
85
- var _a, _b, _c;
86
+ var _a;
86
87
  var info = (0, RepositoryImplementation_js_1.createOldEntity)(entity, _this);
87
- if (dataProvider === undefined)
88
- dataProvider =
89
- (_c = (_b = (_a = info === null || info === void 0 ? void 0 : info.options) === null || _a === void 0 ? void 0 : _a.dataProvider) === null || _b === void 0 ? void 0 : _b.call(_a, _this.dataProvider)) !== null && _c !== void 0 ? _c : _this.dataProvider;
88
+ if (dataProvider === undefined) {
89
+ if ((_a = info === null || info === void 0 ? void 0 : info.options) === null || _a === void 0 ? void 0 : _a.dataProvider) {
90
+ var d = info.options.dataProvider(_this.dataProvider);
91
+ if (d instanceof Promise) {
92
+ dataProvider = new data_interfaces_js_1.DataProviderPromiseWrapper(d);
93
+ }
94
+ else {
95
+ dataProvider = d !== null && d !== void 0 ? d : undefined;
96
+ }
97
+ }
98
+ }
99
+ if (!dataProvider) {
100
+ dataProvider = _this.dataProvider;
101
+ }
90
102
  var dpCache = _this.repCache.get(dataProvider);
91
103
  if (!dpCache)
92
104
  _this.repCache.set(dataProvider, (dpCache = new Map()));
@@ -76,3 +76,11 @@ export declare class EntityError<entityType = unknown> extends Error implements
76
76
  exception?: any;
77
77
  httpStatusCode?: number;
78
78
  }
79
+ export declare class DataProviderPromiseWrapper implements DataProvider {
80
+ private dataProvider;
81
+ constructor(dataProvider: Promise<DataProvider>);
82
+ getEntityDataProvider(entity: EntityMetadata): EntityDataProvider;
83
+ transaction(action: (dataProvider: DataProvider) => Promise<void>): Promise<void>;
84
+ ensureSchema?(entities: EntityMetadata[]): Promise<void>;
85
+ isProxy?: boolean | undefined;
86
+ }
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.EntityError = void 0;
3
+ exports.DataProviderPromiseWrapper = exports.EntityError = void 0;
4
4
  exports.extractSort = extractSort;
5
5
  var tslib_1 = require("tslib");
6
6
  var sort_js_1 = require("./sort.js");
@@ -24,3 +24,43 @@ var EntityError = /** @class */ (function (_super) {
24
24
  return EntityError;
25
25
  }(Error));
26
26
  exports.EntityError = EntityError;
27
+ var DataProviderPromiseWrapper = /** @class */ (function () {
28
+ function DataProviderPromiseWrapper(dataProvider) {
29
+ this.dataProvider = dataProvider;
30
+ }
31
+ DataProviderPromiseWrapper.prototype.getEntityDataProvider = function (entity) {
32
+ return new EntityDataProviderPromiseWrapper(this.dataProvider.then(function (dp) { return dp.getEntityDataProvider(entity); }));
33
+ };
34
+ DataProviderPromiseWrapper.prototype.transaction = function (action) {
35
+ return this.dataProvider.then(function (dp) { return dp.transaction(action); });
36
+ };
37
+ DataProviderPromiseWrapper.prototype.ensureSchema = function (entities) {
38
+ return this.dataProvider.then(function (dp) { var _a; return (_a = dp.ensureSchema) === null || _a === void 0 ? void 0 : _a.call(dp, entities); });
39
+ };
40
+ return DataProviderPromiseWrapper;
41
+ }());
42
+ exports.DataProviderPromiseWrapper = DataProviderPromiseWrapper;
43
+ var EntityDataProviderPromiseWrapper = /** @class */ (function () {
44
+ function EntityDataProviderPromiseWrapper(dataProvider) {
45
+ this.dataProvider = dataProvider;
46
+ }
47
+ EntityDataProviderPromiseWrapper.prototype.delete = function (id) {
48
+ return this.dataProvider.then(function (dp) { return dp.delete(id); });
49
+ };
50
+ EntityDataProviderPromiseWrapper.prototype.insert = function (data) {
51
+ return this.dataProvider.then(function (dp) { return dp.insert(data); });
52
+ };
53
+ EntityDataProviderPromiseWrapper.prototype.count = function (where) {
54
+ return this.dataProvider.then(function (dp) { return dp.count(where); });
55
+ };
56
+ EntityDataProviderPromiseWrapper.prototype.find = function (options) {
57
+ return this.dataProvider.then(function (dp) { return dp.find(options); });
58
+ };
59
+ EntityDataProviderPromiseWrapper.prototype.groupBy = function (options) {
60
+ return this.dataProvider.then(function (dp) { return dp.groupBy(options); });
61
+ };
62
+ EntityDataProviderPromiseWrapper.prototype.update = function (id, data) {
63
+ return this.dataProvider.then(function (dp) { return dp.update(id, data); });
64
+ };
65
+ return EntityDataProviderPromiseWrapper;
66
+ }());
package/src/entity.d.ts CHANGED
@@ -193,7 +193,7 @@ export interface EntityOptions<entityType = unknown> {
193
193
  * }
194
194
  * @returns A custom data provider for the entity.
195
195
  */
196
- dataProvider?: (defaultDataProvider: DataProvider) => DataProvider | undefined | null;
196
+ dataProvider?: (defaultDataProvider: DataProvider) => DataProvider | Promise<DataProvider> | undefined | null;
197
197
  }
198
198
  /**
199
199
  * Provides additional information and utilities for preprocessing filters in API and backend operations.