@venizia/ignis-connectors 0.4.8-9 → 0.5.0-0
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/README.md +22 -0
- package/dist/esm/common/driver-data-source.d.ts +3 -3
- package/dist/esm/common/driver-data-source.js +12 -8
- package/dist/esm/common/driver-data-source.js.map +1 -1
- package/dist/esm/common/internal/duck-typing.d.ts +15 -0
- package/dist/esm/common/internal/duck-typing.js +28 -0
- package/dist/esm/common/internal/duck-typing.js.map +1 -0
- package/dist/esm/common/internal/index.d.ts +1 -0
- package/dist/esm/common/internal/index.js +1 -0
- package/dist/esm/common/internal/index.js.map +1 -1
- package/dist/esm/http/common/constants.d.ts +5 -0
- package/dist/esm/http/common/constants.js +5 -0
- package/dist/esm/http/common/constants.js.map +1 -1
- package/dist/esm/http/common/types.d.ts +12 -15
- package/dist/esm/http/common/types.js.map +1 -1
- package/dist/esm/http/datasource.d.ts +3 -22
- package/dist/esm/http/datasource.js +67 -129
- package/dist/esm/http/datasource.js.map +1 -1
- package/dist/esm/http/repository.d.ts +6 -12
- package/dist/esm/http/repository.js +1 -1
- package/dist/esm/http/repository.js.map +1 -1
- package/dist/esm/raw-sql/repository.d.ts +2 -3
- package/dist/esm/raw-sql/repository.js.map +1 -1
- package/dist/esm/relational/core/repositories/common/executor.d.ts +1 -1
- package/dist/esm/relational/core/repositories/common/executor.js.map +1 -1
- package/dist/esm/relational/core/repositories/common/scope-filter.d.ts +2 -2
- package/dist/esm/relational/core/repositories/common/scope-filter.js.map +1 -1
- package/dist/esm/relational/core/repositories/common/types.d.ts +6 -3
- package/dist/esm/relational/core/repositories/common/types.js.map +1 -1
- package/dist/esm/relational/core/repositories/core/base.d.ts +4 -3
- package/dist/esm/relational/core/repositories/core/base.js.map +1 -1
- package/dist/esm/relational/core/repositories/core/persistable.d.ts +4 -3
- package/dist/esm/relational/core/repositories/core/persistable.js +1 -1
- package/dist/esm/relational/core/repositories/core/persistable.js.map +1 -1
- package/dist/esm/relational/core/repositories/core/soft-deletable.js +18 -1
- package/dist/esm/relational/core/repositories/core/soft-deletable.js.map +1 -1
- package/dist/esm/relational/core/repositories/dialect/filter.d.ts +16 -12
- package/dist/esm/relational/core/repositories/dialect/filter.js +30 -17
- package/dist/esm/relational/core/repositories/dialect/filter.js.map +1 -1
- package/dist/esm/relational/core/repositories/dialect/internal/subquery.d.ts +2 -3
- package/dist/esm/relational/core/repositories/dialect/internal/subquery.js.map +1 -1
- package/dist/esm/relational/core/repositories/dialect/query-operators.js +5 -3
- package/dist/esm/relational/core/repositories/dialect/query-operators.js.map +1 -1
- package/dist/esm/relational/core/repositories/dialect/update.d.ts +3 -3
- package/dist/esm/relational/core/repositories/dialect/update.js +2 -2
- package/dist/esm/relational/core/repositories/dialect/update.js.map +1 -1
- package/dist/esm/relational/postgres/drivers/node-postgres.js +5 -2
- package/dist/esm/relational/postgres/drivers/node-postgres.js.map +1 -1
- package/dist/esm/relational/postgres/drivers/pglite.js +5 -3
- package/dist/esm/relational/postgres/drivers/pglite.js.map +1 -1
- package/dist/esm/relational/postgres/drivers/postgres-js.js +2 -3
- package/dist/esm/relational/postgres/drivers/postgres-js.js.map +1 -1
- package/dist/esm/relational/postgres/models/common/types/enrichers.d.ts +4 -1
- package/dist/esm/relational/postgres/models/common/types/enrichers.js.map +1 -1
- package/dist/esm/relational/postgres/models/enrichers/data-type.enricher.d.ts +3 -2
- package/dist/esm/relational/postgres/models/enrichers/data-type.enricher.js.map +1 -1
- package/dist/esm/relational/postgres/repositories/dialect/filter.d.ts +1 -1
- package/dist/esm/relational/postgres/repositories/dialect/filter.js +3 -2
- package/dist/esm/relational/postgres/repositories/dialect/filter.js.map +1 -1
- package/dist/esm/relational/postgres/repositories/dialect/query.d.ts +28 -27
- package/dist/esm/relational/postgres/repositories/dialect/query.js +4 -3
- package/dist/esm/relational/postgres/repositories/dialect/query.js.map +1 -1
- package/dist/esm/relational/postgres/repositories/dialect/update.d.ts +1 -1
- package/dist/esm/relational/postgres/repositories/dialect/update.js.map +1 -1
- package/dist/esm/relational/postgres/repositories/executor.d.ts +6 -0
- package/dist/esm/relational/postgres/repositories/executor.js +31 -11
- package/dist/esm/relational/postgres/repositories/executor.js.map +1 -1
- package/dist/esm/relational/sqlite/drivers/driver.d.ts +1 -2
- package/dist/esm/relational/sqlite/drivers/driver.js.map +1 -1
- package/dist/esm/relational/sqlite/drivers/libsql.js +10 -4
- package/dist/esm/relational/sqlite/drivers/libsql.js.map +1 -1
- package/dist/esm/relational/sqlite/models/common/types/enrichers.d.ts +4 -1
- package/dist/esm/relational/sqlite/models/common/types/enrichers.js.map +1 -1
- package/dist/esm/relational/sqlite/models/enrichers/data-type.enricher.d.ts +3 -2
- package/dist/esm/relational/sqlite/models/enrichers/data-type.enricher.js +1 -3
- package/dist/esm/relational/sqlite/models/enrichers/data-type.enricher.js.map +1 -1
- package/dist/esm/relational/sqlite/repositories/dialect/filter.d.ts +1 -1
- package/dist/esm/relational/sqlite/repositories/dialect/filter.js +3 -2
- package/dist/esm/relational/sqlite/repositories/dialect/filter.js.map +1 -1
- package/dist/esm/relational/sqlite/repositories/dialect/query.js +3 -3
- package/dist/esm/relational/sqlite/repositories/dialect/query.js.map +1 -1
- package/dist/esm/relational/sqlite/repositories/dialect/update.d.ts +2 -2
- package/dist/esm/relational/sqlite/repositories/dialect/update.js.map +1 -1
- package/dist/esm/relational/sqlite/repositories/executor.d.ts +6 -0
- package/dist/esm/relational/sqlite/repositories/executor.js +32 -15
- package/dist/esm/relational/sqlite/repositories/executor.js.map +1 -1
- package/dist/esm/search/core/controllers/abstract.d.ts +31 -9
- package/dist/esm/search/core/controllers/abstract.js +50 -8
- package/dist/esm/search/core/controllers/abstract.js.map +1 -1
- package/dist/esm/search/core/controllers/engine-params.d.ts +10 -1
- package/dist/esm/search/core/controllers/engine-params.js +18 -4
- package/dist/esm/search/core/controllers/engine-params.js.map +1 -1
- package/dist/esm/search/core/controllers/factory.d.ts +547 -46
- package/dist/esm/search/core/controllers/factory.js +110 -31
- package/dist/esm/search/core/controllers/factory.js.map +1 -1
- package/dist/esm/search/core/controllers/index.d.ts +5 -0
- package/dist/esm/search/core/controllers/index.js +5 -0
- package/dist/esm/search/core/controllers/index.js.map +1 -1
- package/dist/esm/search/core/controllers/modes.d.ts +20 -0
- package/dist/esm/search/core/controllers/modes.js +52 -0
- package/dist/esm/search/core/controllers/modes.js.map +1 -0
- package/dist/esm/search/core/controllers/options.d.ts +82 -0
- package/dist/esm/search/core/controllers/options.js +217 -0
- package/dist/esm/search/core/controllers/options.js.map +1 -0
- package/dist/esm/search/core/controllers/raw-access.d.ts +4 -9
- package/dist/esm/search/core/controllers/raw-access.js +8 -19
- package/dist/esm/search/core/controllers/raw-access.js.map +1 -1
- package/dist/esm/search/core/controllers/response.d.ts +46 -0
- package/dist/esm/search/core/controllers/response.js +65 -0
- package/dist/esm/search/core/controllers/response.js.map +1 -0
- package/dist/esm/search/core/controllers/scope.d.ts +11 -6
- package/dist/esm/search/core/controllers/scope.js +2 -2
- package/dist/esm/search/core/controllers/scope.js.map +1 -1
- package/dist/esm/search/core/controllers/settings.d.ts +140 -0
- package/dist/esm/search/core/controllers/settings.js +484 -0
- package/dist/esm/search/core/controllers/settings.js.map +1 -0
- package/dist/esm/search/core/controllers/toggles.d.ts +13 -0
- package/dist/esm/search/core/controllers/toggles.js +22 -0
- package/dist/esm/search/core/controllers/toggles.js.map +1 -0
- package/dist/esm/search/core/controllers/types.d.ts +88 -0
- package/dist/esm/search/core/controllers/types.js +2 -0
- package/dist/esm/search/core/controllers/types.js.map +1 -0
- package/dist/esm/search/core/datasources/abstract.d.ts +2 -0
- package/dist/esm/search/core/datasources/abstract.js.map +1 -1
- package/dist/esm/search/core/models/common/constants.d.ts +2 -0
- package/dist/esm/search/core/models/common/constants.js +4 -0
- package/dist/esm/search/core/models/common/constants.js.map +1 -1
- package/dist/esm/search/core/models/define-search-collection.js +1 -2
- package/dist/esm/search/core/models/define-search-collection.js.map +1 -1
- package/dist/esm/search/meilisearch/common/types.d.ts +9 -3
- package/dist/esm/search/meilisearch/common/types.js.map +1 -1
- package/dist/esm/search/meilisearch/connector.js.map +1 -1
- package/dist/esm/search/meilisearch/internal/connector-internal.d.ts +1 -1
- package/dist/esm/search/meilisearch/internal/connector-internal.js +0 -1
- package/dist/esm/search/meilisearch/internal/connector-internal.js.map +1 -1
- package/dist/esm/search/typesense/common/types/options.d.ts +7 -0
- package/dist/esm/search/typesense/common/types/options.js.map +1 -1
- package/dist/esm/search/typesense/connector.d.ts +9 -1
- package/dist/esm/search/typesense/connector.js +57 -4
- package/dist/esm/search/typesense/connector.js.map +1 -1
- package/dist/esm/search/typesense/datasources/datasource.d.ts +2 -0
- package/dist/esm/search/typesense/datasources/datasource.js.map +1 -1
- package/dist/esm/search/typesense/internal/connector-internal.d.ts +1 -1
- package/dist/esm/search/typesense/internal/connector-internal.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -129,6 +129,28 @@ styles can live in one application.
|
|
|
129
129
|
The root entry imports no driver and no engine client. A driver loads only when you import its
|
|
130
130
|
entry and name its class in `@datasource({ driver })`.
|
|
131
131
|
|
|
132
|
+
### Search controllers
|
|
133
|
+
|
|
134
|
+
`SearchControllerFactory.build` generates `POST /search` and `POST /multi-search`. It needs `authenticate`
|
|
135
|
+
(a config with no strategy and no `skip` throws when the controller is built), and each route you list is a
|
|
136
|
+
toggle:
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
import { Authentication } from '@venizia/ignis-kernel';
|
|
140
|
+
import { SearchControllerFactory } from '@venizia/ignis-connectors/typesense/controllers';
|
|
141
|
+
|
|
142
|
+
const BaseSearchController = SearchControllerFactory.build({
|
|
143
|
+
repository: ArticleRepository,
|
|
144
|
+
authenticate: { strategies: [Authentication.STRATEGY_JWT] }, // or { skip: true } to open the routes
|
|
145
|
+
routes: { search: { use: true } }, // a route that is absent or { use: false } is not served
|
|
146
|
+
query: { fixed: { queryBy: ['title'] }, allow: { tuning: ['typoTokensThreshold'] } },
|
|
147
|
+
});
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
`modes: { raw: { use: true } }` serves `mode: 'raw'` and multi-search over HTTP. `query` sets what the server
|
|
151
|
+
decides for a query, and `response` reshapes the hits. See the
|
|
152
|
+
[Typesense guide](https://ignis.venizia.ai/guides/core-concepts/persistent/search-typesense) for each option.
|
|
153
|
+
|
|
132
154
|
## Where it sits
|
|
133
155
|
|
|
134
156
|
Depends on `@venizia/ignis-kernel`, `@venizia/ignis-filter`, `@venizia/ignis-helpers` and
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { IDataSourceOpening, TAnyDataSourceSchema } from '@venizia/ignis-kernel';
|
|
2
2
|
import { AbstractDataSource } from '@venizia/ignis-kernel/repository';
|
|
3
|
-
import type {
|
|
3
|
+
import type { TClass } from '@venizia/ignis-helpers/common';
|
|
4
4
|
import type { IConnectorDriver } from './driver.js';
|
|
5
5
|
/**
|
|
6
6
|
* A datasource that holds one client and a connector built over it through a driver: the lifecycle
|
|
@@ -13,7 +13,7 @@ import type { IConnectorDriver } from './driver.js';
|
|
|
13
13
|
* `mapSecretToSettings` is a driver-config convention, not Postgres SQL, so it belongs on this
|
|
14
14
|
* neutral base - do not move it down into a family.
|
|
15
15
|
*/
|
|
16
|
-
export declare abstract class AbstractDriverDataSource<Settings extends object = {}, Schema extends TAnyDataSourceSchema = TAnyDataSourceSchema, ConfigurableOptions extends object = {}, Client = unknown, TConnector = unknown, TDriver extends IConnectorDriver<TConnector,
|
|
16
|
+
export declare abstract class AbstractDriverDataSource<Settings extends object = {}, Schema extends TAnyDataSourceSchema = TAnyDataSourceSchema, ConfigurableOptions extends object = {}, Client = unknown, TConnector = unknown, TDriver extends IConnectorDriver<TConnector, unknown> = IConnectorDriver<TConnector, Client>> extends AbstractDataSource<Settings, Schema, ConfigurableOptions> {
|
|
17
17
|
connector?: TConnector;
|
|
18
18
|
protected client?: Client;
|
|
19
19
|
protected driver?: TDriver;
|
|
@@ -81,6 +81,6 @@ export declare abstract class AbstractDriverDataSource<Settings extends object =
|
|
|
81
81
|
/** Vault's database engine returns `{ username, password }`; pg expects `{ user, password }`. */
|
|
82
82
|
protected mapSecretToSettings(opts: {
|
|
83
83
|
secret: Record<string, string>;
|
|
84
|
-
}):
|
|
84
|
+
}): Record<string, unknown>;
|
|
85
85
|
}
|
|
86
86
|
//# sourceMappingURL=driver-data-source.d.ts.map
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AbstractDataSource } from '@venizia/ignis-kernel/repository';
|
|
2
2
|
import { MetadataRegistry } from '@venizia/ignis-kernel/metadata';
|
|
3
3
|
import { getError } from '@venizia/ignis-helpers/core';
|
|
4
|
+
import { DuckTypingUtility } from './internal/index.js';
|
|
4
5
|
/**
|
|
5
6
|
* A datasource that holds one client and a connector built over it through a driver: the lifecycle
|
|
6
7
|
* every connector family that talks to an external engine shares - wiring the driver named by
|
|
@@ -32,7 +33,9 @@ export class AbstractDriverDataSource extends AbstractDataSource {
|
|
|
32
33
|
});
|
|
33
34
|
}
|
|
34
35
|
const DriverClass = this.resolveDriverClass();
|
|
35
|
-
|
|
36
|
+
// `TClass` takes `never[]`, so any driver constructor fits; Reflect.construct passes the client through.
|
|
37
|
+
const driver = Reflect.construct(DriverClass, [{ client: this.client }]);
|
|
38
|
+
return this.useDriver({ driver });
|
|
36
39
|
}
|
|
37
40
|
/**
|
|
38
41
|
* Rejects a driver-name string from untyped JS
|
|
@@ -213,7 +216,7 @@ export class AbstractDriverDataSource extends AbstractDataSource {
|
|
|
213
216
|
let newConnector;
|
|
214
217
|
try {
|
|
215
218
|
const DriverClass = this.resolveDriverClass();
|
|
216
|
-
newDriver =
|
|
219
|
+
newDriver = Reflect.construct(DriverClass, [{ client: newClient }]);
|
|
217
220
|
newConnector = newDriver.createConnector({ schema: this.getSchema() });
|
|
218
221
|
}
|
|
219
222
|
catch (error) {
|
|
@@ -234,10 +237,10 @@ export class AbstractDriverDataSource extends AbstractDataSource {
|
|
|
234
237
|
}
|
|
235
238
|
/** Puts `settings` back to the snapshot: a key the failed rotation added (the rotated `password`) is removed, not left behind. */
|
|
236
239
|
restoreSettings(opts) {
|
|
237
|
-
const settings = this
|
|
240
|
+
const { settings } = this;
|
|
238
241
|
for (const key of Object.keys(settings)) {
|
|
239
242
|
if (!(key in opts.saved)) {
|
|
240
|
-
|
|
243
|
+
Reflect.deleteProperty(settings, key);
|
|
241
244
|
}
|
|
242
245
|
}
|
|
243
246
|
Object.assign(settings, opts.saved);
|
|
@@ -249,15 +252,16 @@ export class AbstractDriverDataSource extends AbstractDataSource {
|
|
|
249
252
|
* client left undrained keeps a WASM instance or file handle alive forever.
|
|
250
253
|
*/
|
|
251
254
|
async drainClient(opts) {
|
|
252
|
-
const client = opts
|
|
253
|
-
const drain =
|
|
254
|
-
|
|
255
|
+
const { client } = opts;
|
|
256
|
+
const drain = DuckTypingUtility.getMethod({ value: client, name: 'end' }) ??
|
|
257
|
+
DuckTypingUtility.getMethod({ value: client, name: 'close' });
|
|
258
|
+
if (!drain) {
|
|
255
259
|
this.logger
|
|
256
260
|
.for(this.drainClient.name)
|
|
257
261
|
.warn('Client exposes neither end() nor close(); nothing to drain');
|
|
258
262
|
return false;
|
|
259
263
|
}
|
|
260
|
-
await drain
|
|
264
|
+
await drain();
|
|
261
265
|
return true;
|
|
262
266
|
}
|
|
263
267
|
/** Vault's database engine returns `{ username, password }`; pg expects `{ user, password }`. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"driver-data-source.js","sourceRoot":"","sources":["../../../src/common/driver-data-source.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAGvD;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,wBAOpB,SAAQ,kBAAyD;IAQjE;;;OAGG;IACO,sBAAsB;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC5E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAE3B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,iIAAiI;aACpK,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE9C,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC;YACpE,MAAM,EAAE,IAAI,CAAC,WAAW;SACzB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC;QAEhC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,iFAAiF,MAAM,CAAC,MAAM,CAAC,iMAAiM;aACnU,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAyB,CAAC;IACnC,CAAC;IAES,aAAa;QACrB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,OAAO,IAAI,CAAC,MAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAA0C;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,6IAA6I;IACrI,oBAAoB,CAAC,IAAwB;QACnD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,wEAAwE;aAC3H,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,4FAA4F,IAAI,CAAC,MAAM,qCAAqC;aAC/L,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,gHAAgH;aACnK,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,oKAAoK;IACjJ,aAAa;QAC9B,OAAO;YACL,GAAG,KAAK,CAAC,aAAa,EAAE;YACxB,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE;YACjD,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE;SACnC,CAAC;IACJ,CAAC;IAED,kGAAkG;IAClG,YAAY;QACV,IAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAY,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,0EAA0E;aAC7G,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACM,KAAK;QACZ,2GAA2G;QAC3G,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAE5E,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,mIAAmI;IAChH,KAAK,CAAC,kBAAkB;QACzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,wHAAwH;QACxH,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAChC,CAAC;QAED,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC/C,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;YAEnB,OAAO;QACT,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,MAAe,CAAC;QAEpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;iBACpB,IAAI,CAAC,wEAAwE,EAAE,KAAK,CAAC,CAAC;YACzF,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhD,OAAO;QACT,CAAC;QAED,0FAA0F;QAC1F,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;YACvF,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhD,OAAO;QACT,CAAC;QAED,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,IAAqD;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE1D,oHAAoH;QACpH,IAAI,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChF,MAAM,CAAC,IAAI,CACT,uEAAuE,EACvE,IAAI,CAAC,GAAG,CACT,CAAC;YAEF,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAa,CAAC;QAE9C,iEAAiE;QACjE,6DAA6D;QAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,aAAa,GAAG,EAAE,GAAI,IAAI,CAAC,QAAsB,EAAE,CAAC;QAE1D,qFAAqF;QACrF,sGAAsG;QACtG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAqB,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAE7F,kEAAkE;QAClE,iEAAiE;QACjE,kEAAkE;QAClE,IAAI,SAAiB,CAAC;QAEtB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,CAAC,MAAgB,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,GAAG,IAAI,CAAC,MAAiB,CAAC;YACzC,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,IAAI,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YAE/C,IAAI,SAAS,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,gEAAgE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACzF,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,gFAAgF;QAChF,IAAI,SAAkB,CAAC;QACvB,IAAI,YAAwB,CAAC;QAE7B,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9C,SAAS,GAAG,IAAI,WAAW,CAAC,EAAE,MAAM,EAAE,SAAoB,EAAE,CAAC,CAAC;YAC9D,YAAY,GAAG,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACzE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YAE9C,MAAM,CAAC,KAAK,CAAC,qEAAqE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9F,MAAM,KAAK,CAAC;QACd,CAAC;QAED,6EAA6E;QAC7E,yEAAyE;QACzE,IAAI,CAAC,MAAM,GAAG,SAAoB,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,YAAuB,CAAC;QAEzC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAEhE,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,kIAAkI;IAC1H,eAAe,CAAC,IAA0B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAqB,CAAC;QAE5C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,WAAW,CAAC,IAAyB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAiB,CAAC;QAEtC,MAAM,KAAK,GAAG,OAAO,MAAM,EAAE,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC;QAE7E,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;iBAC1B,IAAI,CAAC,4DAA4D,CAAC,CAAC;YAEtE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iGAAiG;IACvF,mBAAmB,CAAC,IAAwC;QACpE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3C,MAAM,MAAM,GAAc,EAAE,CAAC;QAE7B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;QACzB,CAAC;QAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["import type { IDataSourceOpening, TAnyDataSourceSchema } from '@venizia/ignis-kernel';\nimport { AbstractDataSource } from '@venizia/ignis-kernel/repository';\nimport { MetadataRegistry } from '@venizia/ignis-kernel/metadata';\nimport type { AnyObject, AnyType, TClass } from '@venizia/ignis-helpers/common';\nimport { getError } from '@venizia/ignis-helpers/core';\nimport type { IConnectorDriver } from './driver';\n\n/**\n * A datasource that holds one client and a connector built over it through a driver: the lifecycle\n * every connector family that talks to an external engine shares - wiring the driver named by\n * `@datasource({ driver })`, closing once, soft-evicting the client after a secret rotation, draining\n * a client by whichever verb its engine spells it with. No SQL members: the relational family adds\n * its dialect, executor and transactions in `AbstractRelationalDataSource`, a raw-SQL engine adds\n * nothing (`BaseRawSqlDataSource`). Transactions stay NotSupported, as in `AbstractDataSource`.\n *\n * `mapSecretToSettings` is a driver-config convention, not Postgres SQL, so it belongs on this\n * neutral base - do not move it down into a family.\n */\nexport abstract class AbstractDriverDataSource<\n Settings extends object = {},\n Schema extends TAnyDataSourceSchema = TAnyDataSourceSchema,\n ConfigurableOptions extends object = {},\n Client = unknown,\n TConnector = unknown,\n TDriver extends IConnectorDriver<TConnector, AnyType> = IConnectorDriver<TConnector, Client>,\n> extends AbstractDataSource<Settings, Schema, ConfigurableOptions> {\n connector?: TConnector;\n\n protected client?: Client;\n protected driver?: TDriver;\n\n private closePromise?: Promise<void>;\n\n /**\n * Lazy and idempotent: builds the driver named by `@datasource({ driver })` over the client\n * `configure()` assigned, then the connector from it. Returns the connector.\n */\n protected wireDriverFromMetadata(): TConnector {\n if (this.connector) {\n return this.connector;\n }\n\n if (this.driver) {\n const connector = this.driver.createConnector({ schema: this.getSchema() });\n this.connector = connector;\n\n return connector;\n }\n\n if (!this.client) {\n throw getError({\n message: `[${this.constructor.name}][wireDriverFromMetadata] No driver and no client | Assign this.client in configure(), or wire a custom driver with useDriver()`,\n });\n }\n\n const DriverClass = this.resolveDriverClass();\n\n return this.useDriver({ driver: new DriverClass({ client: this.client }) });\n }\n\n /**\n * Rejects a driver-name string from untyped JS\n * callers: a string carries no module into the bundle.\n */\n protected resolveDriverClass(): TClass<TDriver> {\n const metadata = MetadataRegistry.getInstance().getDataSourceMetadata({\n target: this.constructor,\n });\n const driver = metadata?.driver;\n\n if (typeof driver !== 'function') {\n throw getError({\n message: `[${this.constructor.name}][resolveDriverClass] @datasource({ driver }) must name a driver CLASS | Got: ${String(driver)} | Use \\`@datasource({ driver: NodePostgresDriver })\\` with \\`import { NodePostgresDriver } from '@venizia/ignis-connectors/postgres/node-postgres'\\`, or wire a custom driver with useDriver()`,\n });\n }\n\n return driver as TClass<TDriver>;\n }\n\n protected resolveDriver(): TDriver {\n this.wireDriverFromMetadata();\n\n return this.driver as TDriver;\n }\n\n /**\n * Assigns `this.driver` AND builds `this.connector` in one step - a\n * driver without its connector is silently bypassed on pooled queries. Returns the connector.\n */\n protected useDriver(opts: { driver: TDriver; schema?: Schema }): TConnector {\n this.driver = opts.driver;\n const connector = opts.driver.createConnector({ schema: opts.schema ?? this.getSchema() });\n this.connector = connector;\n\n return connector;\n }\n\n /** A datasource that opens on first use has no client, driver or connector until the first call that needs it has awaited `ensureOpen()`. */\n private assertOpenForSyncUse(opts: { member: string }): void {\n if (!this.isOpenDeferred()) {\n return;\n }\n\n if (this.isClosed()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource is closed | It opens on first use only before close()`,\n });\n }\n\n if (this.isOpening()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource is still opening | Inside configure() use the opening argument (opening.${opts.member}()); outside it, await ensureOpen()`,\n });\n }\n\n if (!this.isOpen()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource opens on first use and is not open | Await ensureOpen() first; repository calls do it for you`,\n });\n }\n }\n\n /** The handles `configure()` is given: the connector and the client through the ungated internals, so its own database work (migrations, seeding) needs no gate. */\n protected override createOpening(): IDataSourceOpening<TConnector, Client> {\n return {\n ...super.createOpening(),\n getConnector: () => this.wireDriverFromMetadata(),\n getClient: () => this.readClient(),\n };\n }\n\n /** Wires the driver on first use, so a `configure()` that only builds `this.client` is enough. */\n getConnector(): TConnector {\n this.assertOpenForSyncUse({ member: this.getConnector.name });\n\n return this.wireDriverFromMetadata();\n }\n\n /**\n * Raw driver client (`pg.Pool` / `Sql`). Throws rather\n * than handing back an `undefined` typed as `Client`.\n */\n getClient(): Client {\n this.assertOpenForSyncUse({ member: this.getClient.name });\n\n return this.readClient();\n }\n\n private readClient(): Client {\n if (this.driver) {\n return this.driver.getClient() as Client;\n }\n\n if (!this.client) {\n throw getError({\n message: `[${this.constructor.name}][getClient] No driver and no client | Assign this.driver in configure()`,\n });\n }\n\n return this.client;\n }\n\n /**\n * Ends the connection `configure()` opened. Runs once: every later call returns the first call's\n * promise. Goes through the driver, wired now if nothing queried yet, because its `end()` is the\n * engine's whole teardown - PGlite also clears the exit status it plants on the host process.\n */\n override close(): Promise<void> {\n // A stop that arrives while the first use is still opening waits for that open, then closes what it built.\n this.closePromise ??= this.settleOpening().then(() => this.endConnection());\n\n return this.closePromise;\n }\n\n /** Ends a client that a failed open left half-built and forgets the driver and connector, so the next open starts from nothing. */\n protected override async discardPartialOpen(): Promise<void> {\n const { client, driver } = this;\n\n this.client = undefined;\n this.driver = undefined;\n this.connector = undefined;\n\n // A close() that is waiting for this open owns the slot: clearing it would let a second close end the connection twice.\n if (!this.isClosed()) {\n this.closePromise = undefined;\n }\n\n if (driver && typeof driver.end === 'function') {\n await driver.end();\n\n return;\n }\n\n if (client !== undefined) {\n await this.drainClient({ client });\n }\n }\n\n private async endConnection(): Promise<void> {\n if (!this.driver && this.client === undefined) {\n return;\n }\n\n let driver: TDriver;\n\n try {\n driver = this.resolveDriver();\n } catch (error) {\n this.logger\n .for(this.close.name)\n .warn('No driver to end the connection with | draining the client | error: %s', error);\n await this.drainClient({ client: this.client });\n\n return;\n }\n\n // A hand-made driver cast past `IConnectorDriver` can lack the `end()` its type promises.\n if (typeof driver.end !== 'function') {\n this.logger.for(this.close.name).warn('The driver has no end() | draining the client');\n await this.drainClient({ client: this.client });\n\n return;\n }\n\n await driver.end();\n }\n\n /**\n * Soft-evicts the pool after a secret rotation: rebuilds against the rotated credentials without\n * touching live fields, swaps atomically, then drains the old pool. On failure live state is\n * restored, any half-built pool drained, and the error rethrown.\n */\n async onSecretRotated(opts: { key: string; secret: Record<string, string> }): Promise<void> {\n const logger = this.logger.for(this.onSecretRotated.name);\n\n // Nothing is open yet, so there is no pool to swap: the rotated credentials wait in the settings for the first use.\n if (this.isOpenDeferred() && !this.isOpen()) {\n Object.assign(this.settings, this.mapSecretToSettings({ secret: opts.secret }));\n logger.info(\n 'Datasource not open yet; credentials kept for its first use | key: %s',\n opts.key,\n );\n\n return;\n }\n\n const oldClient = this.getClient() as AnyType;\n\n // Snapshot so a failed rebuild restores the datasource verbatim;\n // `settings` is copied because rotation mutates it in place.\n const savedClient = this.client;\n const savedSettings = { ...(this.settings as AnyObject) };\n\n // Rotation only takes effect through this.settings + configure(); a configure() that\n // hard-codes its connection string or reads the environment directly rebuilds with stale credentials.\n Object.assign(this.settings as AnyObject, this.mapSecretToSettings({ secret: opts.secret }));\n\n // configure() overwrites this.client, so the new pool is captured\n // into a local and the old client restored at once - live fields\n // are never nulled and the old pool keeps serving until the swap.\n let newClient: Client;\n\n try {\n await this.configure();\n newClient = this.client as Client;\n } catch (error) {\n const halfBuilt = this.client as AnyType;\n this.client = savedClient;\n this.restoreSettings({ saved: savedSettings });\n\n if (halfBuilt && halfBuilt !== savedClient) {\n await this.drainClient({ client: halfBuilt });\n }\n\n logger.error('Secret rotation failed in configure(); kept old pool | key: %s', opts.key);\n throw error;\n }\n\n this.client = savedClient;\n\n // Wired into locals: live state must stay on the old pool until the swap below.\n let newDriver: TDriver;\n let newConnector: TConnector;\n\n try {\n const DriverClass = this.resolveDriverClass();\n newDriver = new DriverClass({ client: newClient as AnyType });\n newConnector = newDriver.createConnector({ schema: this.getSchema() });\n } catch (error) {\n this.restoreSettings({ saved: savedSettings });\n await this.drainClient({ client: newClient });\n\n logger.error('Secret rotation failed while wiring driver; kept old pool | key: %s', opts.key);\n throw error;\n }\n\n // Commit the live fields in one synchronous step so there is no null window,\n // then soft-evict the old pool so its in-flight transactions can finish.\n this.client = newClient as AnyType;\n this.driver = newDriver;\n this.connector = newConnector as AnyType;\n\n const isDrained = await this.drainClient({ client: oldClient });\n\n if (isDrained) {\n logger.info('Old pool drained after secret rotation | key: %s', opts.key);\n }\n }\n\n /** Puts `settings` back to the snapshot: a key the failed rotation added (the rotated `password`) is removed, not left behind. */\n private restoreSettings(opts: { saved: AnyObject }): void {\n const settings = this.settings as AnyObject;\n\n for (const key of Object.keys(settings)) {\n if (!(key in opts.saved)) {\n delete settings[key];\n }\n }\n\n Object.assign(settings, opts.saved);\n }\n\n /**\n * Shuts a client down by whichever verb its engine spells it with -\n * `pg.Pool` and postgres.js have `end()`, PGlite and libsql only `close()`.\n * Probed rather than type-tested: this tier must not name an engine, and a\n * client left undrained keeps a WASM instance or file handle alive forever.\n */\n protected async drainClient(opts: { client: unknown }): Promise<boolean> {\n const client = opts.client as AnyType;\n\n const drain = typeof client?.end === 'function' ? client.end : client?.close;\n\n if (typeof drain !== 'function') {\n this.logger\n .for(this.drainClient.name)\n .warn('Client exposes neither end() nor close(); nothing to drain');\n\n return false;\n }\n\n await drain.call(client);\n\n return true;\n }\n\n /** Vault's database engine returns `{ username, password }`; pg expects `{ user, password }`. */\n protected mapSecretToSettings(opts: { secret: Record<string, string> }): AnyObject {\n const { username, password } = opts.secret;\n const mapped: AnyObject = {};\n\n if (username !== undefined) {\n mapped.user = username;\n }\n\n if (password !== undefined) {\n mapped.password = password;\n }\n\n return mapped;\n }\n}\n"]}
|
|
1
|
+
{"version":3,"file":"driver-data-source.js","sourceRoot":"","sources":["../../../src/common/driver-data-source.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAElE,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE/C;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,wBAOpB,SAAQ,kBAAyD;IAQjE;;;OAGG;IACO,sBAAsB;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC5E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAE3B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,iIAAiI;aACpK,CAAC,CAAC;QACL,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE9C,yGAAyG;QACzG,MAAM,MAAM,GAAY,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACO,kBAAkB;QAC1B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAC,qBAAqB,CAAC;YACpE,MAAM,EAAE,IAAI,CAAC,WAAW;SACzB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,EAAE,MAAM,CAAC;QAEhC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,iFAAiF,MAAM,CAAC,MAAM,CAAC,iMAAiM;aACnU,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAyB,CAAC;IACnC,CAAC;IAES,aAAa;QACrB,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,OAAO,IAAI,CAAC,MAAiB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAA0C;QAC5D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,6IAA6I;IACrI,oBAAoB,CAAC,IAAwB;QACnD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAC3B,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,wEAAwE;aAC3H,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,4FAA4F,IAAI,CAAC,MAAM,qCAAqC;aAC/L,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACnB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,gHAAgH;aACnK,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,oKAAoK;IACjJ,aAAa;QAC9B,OAAO;YACL,GAAG,KAAK,CAAC,aAAa,EAAE;YACxB,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,sBAAsB,EAAE;YACjD,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,EAAE;SACnC,CAAC;IACJ,CAAC;IAED,kGAAkG;IAClG,YAAY;QACV,IAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAE9D,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAY,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,QAAQ,CAAC;gBACb,OAAO,EAAE,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,0EAA0E;aAC7G,CAAC,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACM,KAAK;QACZ,2GAA2G;QAC3G,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAE5E,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,mIAAmI;IAChH,KAAK,CAAC,kBAAkB;QACzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAEhC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,wHAAwH;QACxH,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAChC,CAAC;QAED,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC/C,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;YAEnB,OAAO;QACT,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,IAAI,MAAe,CAAC;QAEpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QAChC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;iBACpB,IAAI,CAAC,wEAAwE,EAAE,KAAK,CAAC,CAAC;YACzF,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhD,OAAO;QACT,CAAC;QAED,0FAA0F;QAC1F,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;YACvF,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAEhD,OAAO;QACT,CAAC;QAED,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,IAAqD;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE1D,oHAAoH;QACpH,IAAI,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAChF,MAAM,CAAC,IAAI,CACT,uEAAuE,EACvE,IAAI,CAAC,GAAG,CACT,CAAC;YAEF,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAEnC,iEAAiE;QACjE,6DAA6D;QAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAE3C,qFAAqF;QACrF,sGAAsG;QACtG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEhF,kEAAkE;QAClE,iEAAiE;QACjE,kEAAkE;QAClE,IAAI,SAAiB,CAAC;QAEtB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,SAAS,GAAG,IAAI,CAAC,MAAgB,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;YAC1B,IAAI,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YAE/C,IAAI,SAAS,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YAChD,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,gEAAgE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YACzF,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAE1B,gFAAgF;QAChF,IAAI,SAAkB,CAAC;QACvB,IAAI,YAAwB,CAAC;QAE7B,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9C,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YACpE,YAAY,GAAG,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACzE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,eAAe,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YAE9C,MAAM,CAAC,KAAK,CAAC,qEAAqE,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9F,MAAM,KAAK,CAAC;QACd,CAAC;QAED,6EAA6E;QAC7E,yEAAyE;QACzE,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC;QAE9B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAEhE,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,kIAAkI;IAC1H,eAAe,CAAC,IAAyB;QAC/C,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAE1B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,WAAW,CAAC,IAAyB;QACnD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAExB,MAAM,KAAK,GACT,iBAAiB,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC3D,iBAAiB,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAEhE,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,MAAM;iBACR,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;iBAC1B,IAAI,CAAC,4DAA4D,CAAC,CAAC;YAEtE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,KAAK,EAAE,CAAC;QAEd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iGAAiG;IACvF,mBAAmB,CAAC,IAAwC;QACpE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3C,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;QACzB,CAAC;QAED,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC7B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["import type { IDataSourceOpening, TAnyDataSourceSchema } from '@venizia/ignis-kernel';\nimport { AbstractDataSource } from '@venizia/ignis-kernel/repository';\nimport { MetadataRegistry } from '@venizia/ignis-kernel/metadata';\nimport type { TClass } from '@venizia/ignis-helpers/common';\nimport { getError } from '@venizia/ignis-helpers/core';\nimport type { IConnectorDriver } from './driver';\nimport { DuckTypingUtility } from './internal';\n\n/**\n * A datasource that holds one client and a connector built over it through a driver: the lifecycle\n * every connector family that talks to an external engine shares - wiring the driver named by\n * `@datasource({ driver })`, closing once, soft-evicting the client after a secret rotation, draining\n * a client by whichever verb its engine spells it with. No SQL members: the relational family adds\n * its dialect, executor and transactions in `AbstractRelationalDataSource`, a raw-SQL engine adds\n * nothing (`BaseRawSqlDataSource`). Transactions stay NotSupported, as in `AbstractDataSource`.\n *\n * `mapSecretToSettings` is a driver-config convention, not Postgres SQL, so it belongs on this\n * neutral base - do not move it down into a family.\n */\nexport abstract class AbstractDriverDataSource<\n Settings extends object = {},\n Schema extends TAnyDataSourceSchema = TAnyDataSourceSchema,\n ConfigurableOptions extends object = {},\n Client = unknown,\n TConnector = unknown,\n TDriver extends IConnectorDriver<TConnector, unknown> = IConnectorDriver<TConnector, Client>,\n> extends AbstractDataSource<Settings, Schema, ConfigurableOptions> {\n connector?: TConnector;\n\n protected client?: Client;\n protected driver?: TDriver;\n\n private closePromise?: Promise<void>;\n\n /**\n * Lazy and idempotent: builds the driver named by `@datasource({ driver })` over the client\n * `configure()` assigned, then the connector from it. Returns the connector.\n */\n protected wireDriverFromMetadata(): TConnector {\n if (this.connector) {\n return this.connector;\n }\n\n if (this.driver) {\n const connector = this.driver.createConnector({ schema: this.getSchema() });\n this.connector = connector;\n\n return connector;\n }\n\n if (!this.client) {\n throw getError({\n message: `[${this.constructor.name}][wireDriverFromMetadata] No driver and no client | Assign this.client in configure(), or wire a custom driver with useDriver()`,\n });\n }\n\n const DriverClass = this.resolveDriverClass();\n\n // `TClass` takes `never[]`, so any driver constructor fits; Reflect.construct passes the client through.\n const driver: TDriver = Reflect.construct(DriverClass, [{ client: this.client }]);\n\n return this.useDriver({ driver });\n }\n\n /**\n * Rejects a driver-name string from untyped JS\n * callers: a string carries no module into the bundle.\n */\n protected resolveDriverClass(): TClass<TDriver> {\n const metadata = MetadataRegistry.getInstance().getDataSourceMetadata({\n target: this.constructor,\n });\n const driver = metadata?.driver;\n\n if (typeof driver !== 'function') {\n throw getError({\n message: `[${this.constructor.name}][resolveDriverClass] @datasource({ driver }) must name a driver CLASS | Got: ${String(driver)} | Use \\`@datasource({ driver: NodePostgresDriver })\\` with \\`import { NodePostgresDriver } from '@venizia/ignis-connectors/postgres/node-postgres'\\`, or wire a custom driver with useDriver()`,\n });\n }\n\n return driver as TClass<TDriver>;\n }\n\n protected resolveDriver(): TDriver {\n this.wireDriverFromMetadata();\n\n return this.driver as TDriver;\n }\n\n /**\n * Assigns `this.driver` AND builds `this.connector` in one step - a\n * driver without its connector is silently bypassed on pooled queries. Returns the connector.\n */\n protected useDriver(opts: { driver: TDriver; schema?: Schema }): TConnector {\n this.driver = opts.driver;\n const connector = opts.driver.createConnector({ schema: opts.schema ?? this.getSchema() });\n this.connector = connector;\n\n return connector;\n }\n\n /** A datasource that opens on first use has no client, driver or connector until the first call that needs it has awaited `ensureOpen()`. */\n private assertOpenForSyncUse(opts: { member: string }): void {\n if (!this.isOpenDeferred()) {\n return;\n }\n\n if (this.isClosed()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource is closed | It opens on first use only before close()`,\n });\n }\n\n if (this.isOpening()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource is still opening | Inside configure() use the opening argument (opening.${opts.member}()); outside it, await ensureOpen()`,\n });\n }\n\n if (!this.isOpen()) {\n throw getError({\n message: `[${this.constructor.name}][${opts.member}] The datasource opens on first use and is not open | Await ensureOpen() first; repository calls do it for you`,\n });\n }\n }\n\n /** The handles `configure()` is given: the connector and the client through the ungated internals, so its own database work (migrations, seeding) needs no gate. */\n protected override createOpening(): IDataSourceOpening<TConnector, Client> {\n return {\n ...super.createOpening(),\n getConnector: () => this.wireDriverFromMetadata(),\n getClient: () => this.readClient(),\n };\n }\n\n /** Wires the driver on first use, so a `configure()` that only builds `this.client` is enough. */\n getConnector(): TConnector {\n this.assertOpenForSyncUse({ member: this.getConnector.name });\n\n return this.wireDriverFromMetadata();\n }\n\n /**\n * Raw driver client (`pg.Pool` / `Sql`). Throws rather\n * than handing back an `undefined` typed as `Client`.\n */\n getClient(): Client {\n this.assertOpenForSyncUse({ member: this.getClient.name });\n\n return this.readClient();\n }\n\n private readClient(): Client {\n if (this.driver) {\n return this.driver.getClient() as Client;\n }\n\n if (!this.client) {\n throw getError({\n message: `[${this.constructor.name}][getClient] No driver and no client | Assign this.driver in configure()`,\n });\n }\n\n return this.client;\n }\n\n /**\n * Ends the connection `configure()` opened. Runs once: every later call returns the first call's\n * promise. Goes through the driver, wired now if nothing queried yet, because its `end()` is the\n * engine's whole teardown - PGlite also clears the exit status it plants on the host process.\n */\n override close(): Promise<void> {\n // A stop that arrives while the first use is still opening waits for that open, then closes what it built.\n this.closePromise ??= this.settleOpening().then(() => this.endConnection());\n\n return this.closePromise;\n }\n\n /** Ends a client that a failed open left half-built and forgets the driver and connector, so the next open starts from nothing. */\n protected override async discardPartialOpen(): Promise<void> {\n const { client, driver } = this;\n\n this.client = undefined;\n this.driver = undefined;\n this.connector = undefined;\n\n // A close() that is waiting for this open owns the slot: clearing it would let a second close end the connection twice.\n if (!this.isClosed()) {\n this.closePromise = undefined;\n }\n\n if (driver && typeof driver.end === 'function') {\n await driver.end();\n\n return;\n }\n\n if (client !== undefined) {\n await this.drainClient({ client });\n }\n }\n\n private async endConnection(): Promise<void> {\n if (!this.driver && this.client === undefined) {\n return;\n }\n\n let driver: TDriver;\n\n try {\n driver = this.resolveDriver();\n } catch (error) {\n this.logger\n .for(this.close.name)\n .warn('No driver to end the connection with | draining the client | error: %s', error);\n await this.drainClient({ client: this.client });\n\n return;\n }\n\n // A hand-made driver cast past `IConnectorDriver` can lack the `end()` its type promises.\n if (typeof driver.end !== 'function') {\n this.logger.for(this.close.name).warn('The driver has no end() | draining the client');\n await this.drainClient({ client: this.client });\n\n return;\n }\n\n await driver.end();\n }\n\n /**\n * Soft-evicts the pool after a secret rotation: rebuilds against the rotated credentials without\n * touching live fields, swaps atomically, then drains the old pool. On failure live state is\n * restored, any half-built pool drained, and the error rethrown.\n */\n async onSecretRotated(opts: { key: string; secret: Record<string, string> }): Promise<void> {\n const logger = this.logger.for(this.onSecretRotated.name);\n\n // Nothing is open yet, so there is no pool to swap: the rotated credentials wait in the settings for the first use.\n if (this.isOpenDeferred() && !this.isOpen()) {\n Object.assign(this.settings, this.mapSecretToSettings({ secret: opts.secret }));\n logger.info(\n 'Datasource not open yet; credentials kept for its first use | key: %s',\n opts.key,\n );\n\n return;\n }\n\n const oldClient = this.getClient();\n\n // Snapshot so a failed rebuild restores the datasource verbatim;\n // `settings` is copied because rotation mutates it in place.\n const savedClient = this.client;\n const savedSettings = { ...this.settings };\n\n // Rotation only takes effect through this.settings + configure(); a configure() that\n // hard-codes its connection string or reads the environment directly rebuilds with stale credentials.\n Object.assign(this.settings, this.mapSecretToSettings({ secret: opts.secret }));\n\n // configure() overwrites this.client, so the new pool is captured\n // into a local and the old client restored at once - live fields\n // are never nulled and the old pool keeps serving until the swap.\n let newClient: Client;\n\n try {\n await this.configure();\n newClient = this.client as Client;\n } catch (error) {\n const halfBuilt = this.client;\n this.client = savedClient;\n this.restoreSettings({ saved: savedSettings });\n\n if (halfBuilt && halfBuilt !== savedClient) {\n await this.drainClient({ client: halfBuilt });\n }\n\n logger.error('Secret rotation failed in configure(); kept old pool | key: %s', opts.key);\n throw error;\n }\n\n this.client = savedClient;\n\n // Wired into locals: live state must stay on the old pool until the swap below.\n let newDriver: TDriver;\n let newConnector: TConnector;\n\n try {\n const DriverClass = this.resolveDriverClass();\n newDriver = Reflect.construct(DriverClass, [{ client: newClient }]);\n newConnector = newDriver.createConnector({ schema: this.getSchema() });\n } catch (error) {\n this.restoreSettings({ saved: savedSettings });\n await this.drainClient({ client: newClient });\n\n logger.error('Secret rotation failed while wiring driver; kept old pool | key: %s', opts.key);\n throw error;\n }\n\n // Commit the live fields in one synchronous step so there is no null window,\n // then soft-evict the old pool so its in-flight transactions can finish.\n this.client = newClient;\n this.driver = newDriver;\n this.connector = newConnector;\n\n const isDrained = await this.drainClient({ client: oldClient });\n\n if (isDrained) {\n logger.info('Old pool drained after secret rotation | key: %s', opts.key);\n }\n }\n\n /** Puts `settings` back to the snapshot: a key the failed rotation added (the rotated `password`) is removed, not left behind. */\n private restoreSettings(opts: { saved: Settings }): void {\n const { settings } = this;\n\n for (const key of Object.keys(settings)) {\n if (!(key in opts.saved)) {\n Reflect.deleteProperty(settings, key);\n }\n }\n\n Object.assign(settings, opts.saved);\n }\n\n /**\n * Shuts a client down by whichever verb its engine spells it with -\n * `pg.Pool` and postgres.js have `end()`, PGlite and libsql only `close()`.\n * Probed rather than type-tested: this tier must not name an engine, and a\n * client left undrained keeps a WASM instance or file handle alive forever.\n */\n protected async drainClient(opts: { client: unknown }): Promise<boolean> {\n const { client } = opts;\n\n const drain =\n DuckTypingUtility.getMethod({ value: client, name: 'end' }) ??\n DuckTypingUtility.getMethod({ value: client, name: 'close' });\n\n if (!drain) {\n this.logger\n .for(this.drainClient.name)\n .warn('Client exposes neither end() nor close(); nothing to drain');\n\n return false;\n }\n\n await drain();\n\n return true;\n }\n\n /** Vault's database engine returns `{ username, password }`; pg expects `{ user, password }`. */\n protected mapSecretToSettings(opts: { secret: Record<string, string> }): Record<string, unknown> {\n const { username, password } = opts.secret;\n const mapped: Record<string, unknown> = {};\n\n if (username !== undefined) {\n mapped.user = username;\n }\n\n if (password !== undefined) {\n mapped.password = password;\n }\n\n return mapped;\n }\n}\n"]}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/** The `typeof` result a duck-typed member must have. */
|
|
2
|
+
export type TDuckMemberType = 'function' | 'string' | 'number';
|
|
3
|
+
export declare class DuckTypingUtility {
|
|
4
|
+
/** The method `name` of `value`, bound to it, when it is a function; otherwise `undefined`. */
|
|
5
|
+
static getMethod(opts: {
|
|
6
|
+
value: unknown;
|
|
7
|
+
name: string;
|
|
8
|
+
}): ((...args: unknown[]) => unknown) | undefined;
|
|
9
|
+
/** True when `value` is an object (or function) whose every listed member has the stated `typeof`; `null`, `undefined` and primitives are false. */
|
|
10
|
+
static hasMembers(opts: {
|
|
11
|
+
value: unknown;
|
|
12
|
+
members: Readonly<Record<string, TDuckMemberType>>;
|
|
13
|
+
}): boolean;
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=duck-typing.d.ts.map
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export class DuckTypingUtility {
|
|
2
|
+
/** The method `name` of `value`, bound to it, when it is a function; otherwise `undefined`. */
|
|
3
|
+
static getMethod(opts) {
|
|
4
|
+
const { value, name } = opts;
|
|
5
|
+
if (value === null || (typeof value !== 'object' && typeof value !== 'function')) {
|
|
6
|
+
return undefined;
|
|
7
|
+
}
|
|
8
|
+
const member = Reflect.get(value, name);
|
|
9
|
+
if (typeof member !== 'function') {
|
|
10
|
+
return undefined;
|
|
11
|
+
}
|
|
12
|
+
return (...args) => Reflect.apply(member, value, args);
|
|
13
|
+
}
|
|
14
|
+
/** True when `value` is an object (or function) whose every listed member has the stated `typeof`; `null`, `undefined` and primitives are false. */
|
|
15
|
+
static hasMembers(opts) {
|
|
16
|
+
const { value, members } = opts;
|
|
17
|
+
if (value === null || (typeof value !== 'object' && typeof value !== 'function')) {
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
for (const [name, kind] of Object.entries(members)) {
|
|
21
|
+
if (typeof Reflect.get(value, name) !== kind) {
|
|
22
|
+
return false;
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=duck-typing.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"duck-typing.js","sourceRoot":"","sources":["../../../../src/common/internal/duck-typing.ts"],"names":[],"mappings":"AAGA,MAAM,OAAO,iBAAiB;IAC5B,+FAA+F;IAC/F,MAAM,CAAC,SAAS,CAAC,IAGhB;QACC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAE7B,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;YACjF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,MAAM,GAAY,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAEjD,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;IAED,oJAAoJ;IACpJ,MAAM,CAAC,UAAU,CAAC,IAGjB;QACC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEhC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,UAAU,CAAC,EAAE,CAAC;YACjF,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;gBAC7C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["/** The `typeof` result a duck-typed member must have. */\nexport type TDuckMemberType = 'function' | 'string' | 'number';\n\nexport class DuckTypingUtility {\n /** The method `name` of `value`, bound to it, when it is a function; otherwise `undefined`. */\n static getMethod(opts: {\n value: unknown;\n name: string;\n }): ((...args: unknown[]) => unknown) | undefined {\n const { value, name } = opts;\n\n if (value === null || (typeof value !== 'object' && typeof value !== 'function')) {\n return undefined;\n }\n\n const member: unknown = Reflect.get(value, name);\n\n if (typeof member !== 'function') {\n return undefined;\n }\n\n return (...args) => Reflect.apply(member, value, args);\n }\n\n /** True when `value` is an object (or function) whose every listed member has the stated `typeof`; `null`, `undefined` and primitives are false. */\n static hasMembers(opts: {\n value: unknown;\n members: Readonly<Record<string, TDuckMemberType>>;\n }): boolean {\n const { value, members } = opts;\n\n if (value === null || (typeof value !== 'object' && typeof value !== 'function')) {\n return false;\n }\n\n for (const [name, kind] of Object.entries(members)) {\n if (typeof Reflect.get(value, name) !== kind) {\n return false;\n }\n }\n\n return true;\n }\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC","sourcesContent":["export * from './echo';\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC","sourcesContent":["export * from './duck-typing';\nexport * from './echo';\n"]}
|
|
@@ -1,4 +1,9 @@
|
|
|
1
1
|
import type { TConstValue } from '@venizia/ignis-helpers/common';
|
|
2
|
+
/** Headers the HTTP datasource owns on the wire, beside the shared ones in `HTTP.Headers`. */
|
|
3
|
+
export declare class HttpWireHeaders {
|
|
4
|
+
/** The credential's `provider`, when it names one. */
|
|
5
|
+
static readonly AUTH_PROVIDER = "x-auth-provider";
|
|
6
|
+
}
|
|
2
7
|
/** What a read expects back: LIST (a bare array or the `{ count, data }` envelope) or ONE (a single record, never unwrapped). */
|
|
3
8
|
export declare class HttpReadShapes {
|
|
4
9
|
static readonly LIST = "list";
|
|
@@ -1,3 +1,8 @@
|
|
|
1
|
+
/** Headers the HTTP datasource owns on the wire, beside the shared ones in `HTTP.Headers`. */
|
|
2
|
+
export class HttpWireHeaders {
|
|
3
|
+
/** The credential's `provider`, when it names one. */
|
|
4
|
+
static { this.AUTH_PROVIDER = 'x-auth-provider'; }
|
|
5
|
+
}
|
|
1
6
|
/** What a read expects back: LIST (a bare array or the `{ count, data }` envelope) or ONE (a single record, never unwrapped). */
|
|
2
7
|
export class HttpReadShapes {
|
|
3
8
|
static { this.LIST = 'list'; }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/http/common/constants.ts"],"names":[],"mappings":"AAEA,iIAAiI;AACjI,MAAM,OAAO,cAAc;aACT,SAAI,GAAG,MAAM,CAAC;aACd,QAAG,GAAG,KAAK,CAAC;aAEZ,eAAU,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC","sourcesContent":["import type { TConstValue } from '@venizia/ignis-helpers/common';\n\n/** What a read expects back: LIST (a bare array or the `{ count, data }` envelope) or ONE (a single record, never unwrapped). */\nexport class HttpReadShapes {\n static readonly LIST = 'list';\n static readonly ONE = 'one';\n\n static readonly SCHEME_SET = new Set<string>([this.LIST, this.ONE]);\n\n static isValid(value: string): boolean {\n return this.SCHEME_SET.has(value);\n }\n}\n\n/** Valid HTTP read shape values. */\nexport type THttpReadShape = TConstValue<typeof HttpReadShapes>;\n"]}
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/http/common/constants.ts"],"names":[],"mappings":"AAEA,8FAA8F;AAC9F,MAAM,OAAO,eAAe;IAC1B,sDAAsD;aACtC,kBAAa,GAAG,iBAAiB,CAAC;;AAGpD,iIAAiI;AACjI,MAAM,OAAO,cAAc;aACT,SAAI,GAAG,MAAM,CAAC;aACd,QAAG,GAAG,KAAK,CAAC;aAEZ,eAAU,GAAG,IAAI,GAAG,CAAS,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpE,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC","sourcesContent":["import type { TConstValue } from '@venizia/ignis-helpers/common';\n\n/** Headers the HTTP datasource owns on the wire, beside the shared ones in `HTTP.Headers`. */\nexport class HttpWireHeaders {\n /** The credential's `provider`, when it names one. */\n static readonly AUTH_PROVIDER = 'x-auth-provider';\n}\n\n/** What a read expects back: LIST (a bare array or the `{ count, data }` envelope) or ONE (a single record, never unwrapped). */\nexport class HttpReadShapes {\n static readonly LIST = 'list';\n static readonly ONE = 'one';\n\n static readonly SCHEME_SET = new Set<string>([this.LIST, this.ONE]);\n\n static isValid(value: string): boolean {\n return this.SCHEME_SET.has(value);\n }\n}\n\n/** Valid HTTP read shape values. */\nexport type THttpReadShape = TConstValue<typeof HttpReadShapes>;\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { TNativeFetchSender } from '@venizia/ignis-helpers/core';
|
|
2
2
|
/** A credential the HTTP datasource attaches to a request: `Authorization: <type> <value>`, and `provider`, when set, as the `x-auth-provider` header. */
|
|
3
3
|
export interface IAuthToken {
|
|
4
4
|
value: string;
|
|
@@ -15,13 +15,11 @@ export interface IHttpRequestContext {
|
|
|
15
15
|
paths: Array<string>;
|
|
16
16
|
method: string;
|
|
17
17
|
url: string;
|
|
18
|
+
/** 1 for the first send, 2 for the one after a refreshed 401. */
|
|
19
|
+
attempt?: number;
|
|
18
20
|
/** The call's own signal: a hook may stop waiting on it. A refresh shared by other calls should not be aborted by one. */
|
|
19
21
|
signal?: AbortSignal;
|
|
20
22
|
}
|
|
21
|
-
/** `undefined` means no token for this request. A throw fails the request with that error. */
|
|
22
|
-
export type TAuthTokenResolver = (context: IHttpRequestContext) => IAuthToken | undefined;
|
|
23
|
-
/** Headers for this request. A throw fails the request with that error. */
|
|
24
|
-
export type THttpHeadersResolver = (context: IHttpRequestContext) => THttpHeaders | undefined;
|
|
25
23
|
/** Not `Record` alone: header names are case-insensitive, and an object merge appends two spellings. */
|
|
26
24
|
export type THttpHeaders = Headers | Array<[string, string]> | Record<string, string>;
|
|
27
25
|
/**
|
|
@@ -46,18 +44,21 @@ export interface IHttpDataSourceSettings {
|
|
|
46
44
|
/** Sent on every request. `x-request-count` is refused - the connector owns it. */
|
|
47
45
|
headers?: THttpHeaders;
|
|
48
46
|
/**
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* resolved.
|
|
47
|
+
* Headers for this request, run on every send (the 401 retry included); wins over `headers`, a call's own win over it. A throw
|
|
48
|
+
* fails the request; `x-request-count` is refused, and an `authorization` stands only when no token resolves.
|
|
52
49
|
*/
|
|
53
|
-
headersResolver?:
|
|
50
|
+
headersResolver?: (context: IHttpRequestContext) => THttpHeaders | undefined;
|
|
54
51
|
/** Wins over `authTokenResolver`, and is sent whatever the request. */
|
|
55
52
|
authToken?: IAuthToken;
|
|
56
|
-
/** Run on every send, the 401 retry included. */
|
|
57
|
-
authTokenResolver?:
|
|
53
|
+
/** Run on every send, the 401 retry included. `undefined` means no token for this request. A throw fails the request with that error. */
|
|
54
|
+
authTokenResolver?: (context: IHttpRequestContext) => IAuthToken | undefined;
|
|
58
55
|
/** Runs on a 401: `true` retries once (re-resolving the token), `false` lets the 401 stand. */
|
|
59
56
|
onUnauthorized?: (context: IHttpRequestContext) => Promise<boolean> | boolean;
|
|
57
|
+
/** What sends a request: the platform `fetch` when unset. Name one to route through a test double, a proxy or an instrumented client. */
|
|
58
|
+
fetch?: THttpFetch;
|
|
60
59
|
}
|
|
60
|
+
/** What sends a request: a URL and its init, a `Response` back. The public name of the sender type. */
|
|
61
|
+
export type THttpFetch = TNativeFetchSender;
|
|
61
62
|
/** A list with no `Content-Range` has no total - `hasRange` says so rather than using the page size. */
|
|
62
63
|
export interface IHttpReadResult<R> {
|
|
63
64
|
data: R;
|
|
@@ -77,10 +78,6 @@ export interface IHttpWriteResult<R> {
|
|
|
77
78
|
/** What the route answered beside the rows, when the server marked it with `x-response-extra`. */
|
|
78
79
|
extra?: Record<string, unknown>;
|
|
79
80
|
}
|
|
80
|
-
/** The query a repository call sends: an optional `filter` typed against the entity `E`. */
|
|
81
|
-
export type THttpQuery<E extends object> = {
|
|
82
|
-
filter?: TFilter<E>;
|
|
83
|
-
};
|
|
84
81
|
/** Query parameters a route takes beside `filter` or `where` - a keyword, a scope. The filter and `where` win over a key of the same name. */
|
|
85
82
|
export type THttpExtraQuery = Record<string, unknown>;
|
|
86
83
|
/** What the IGNIS search route answers: the total as `found` (`isFoundExact` is false when it is an estimate) and the hits. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/http/common/types.ts"],"names":[],"mappings":"","sourcesContent":["import type {
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/http/common/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { TNativeFetchSender } from '@venizia/ignis-helpers/core';\n\n/** A credential the HTTP datasource attaches to a request: `Authorization: <type> <value>`, and `provider`, when set, as the `x-auth-provider` header. */\nexport interface IAuthToken {\n value: string;\n /**\n * The authorization scheme.\n *\n * @default 'Bearer'\n */\n type?: string;\n provider?: string;\n}\n\n/** The request a hook is asked about: the repository `paths`, the method, and the final URL with its query. */\nexport interface IHttpRequestContext {\n paths: Array<string>;\n method: string;\n url: string;\n /** 1 for the first send, 2 for the one after a refreshed 401. */\n attempt?: number;\n /** The call's own signal: a hook may stop waiting on it. A refresh shared by other calls should not be aborted by one. */\n signal?: AbortSignal;\n}\n\n/** Not `Record` alone: header names are case-insensitive, and an object merge appends two spellings. */\nexport type THttpHeaders = Headers | Array<[string, string]> | Record<string, string>;\n\n/**\n * A request body. A plain object or array goes out as JSON; a string, `Blob`, `FormData`,\n * `URLSearchParams`, `ArrayBuffer` or typed array goes out as it is. Never a stream: the 401 retry\n * sends the same body twice.\n */\nexport type THttpBody = string | object;\n\n/** The list-extras request and result types live with the server contract, in kernel. */\nexport type { TExtraRequest, TExtraResult } from '@venizia/ignis-kernel/repository';\n\n/** What one call may add: its own headers (they win over the configured ones) and a signal to abort it. */\nexport interface IHttpCallOptions {\n headers?: THttpHeaders;\n signal?: AbortSignal;\n}\n\n/** Settings of the HTTP datasource: where to send, which headers and token to attach, and what to do on a 401. */\nexport interface IHttpDataSourceSettings {\n /** An absolute URL, or a path from the page origin (`/api`). A path-relative one is refused. */\n baseUrl: string;\n\n /** The server's `error.rootKey`: an error envelope wrapped under it is unwrapped before it is read. */\n errorRootKey?: string;\n\n /** Sent on every request. `x-request-count` is refused - the connector owns it. */\n headers?: THttpHeaders;\n\n /**\n * Headers for this request, run on every send (the 401 retry included); wins over `headers`, a call's own win over it. A throw\n * fails the request; `x-request-count` is refused, and an `authorization` stands only when no token resolves.\n */\n headersResolver?: (context: IHttpRequestContext) => THttpHeaders | undefined;\n\n /** Wins over `authTokenResolver`, and is sent whatever the request. */\n authToken?: IAuthToken;\n\n /** Run on every send, the 401 retry included. `undefined` means no token for this request. A throw fails the request with that error. */\n authTokenResolver?: (context: IHttpRequestContext) => IAuthToken | undefined;\n\n /** Runs on a 401: `true` retries once (re-resolving the token), `false` lets the 401 stand. */\n onUnauthorized?: (context: IHttpRequestContext) => Promise<boolean> | boolean;\n\n /** What sends a request: the platform `fetch` when unset. Name one to route through a test double, a proxy or an instrumented client. */\n fetch?: THttpFetch;\n}\n\n/** What sends a request: a URL and its init, a `Response` back. The public name of the sender type. */\nexport type THttpFetch = TNativeFetchSender;\n\n/** A list with no `Content-Range` has no total - `hasRange` says so rather than using the page size. */\nexport interface IHttpReadResult<R> {\n data: R;\n hasRange: boolean;\n /** Raw header: tells a present-but-unreadable one from an absent one. */\n contentRange?: string;\n total?: number;\n skip?: number;\n dataLength: number;\n /** What a list answered beside its rows, when the server marked it with `x-response-extra`. */\n extra?: Record<string, unknown>;\n}\n\n/** What a write answers: the rows the server returned, and its `x-response-count`. */\nexport interface IHttpWriteResult<R> {\n data: R;\n count: number;\n /** What the route answered beside the rows, when the server marked it with `x-response-extra`. */\n extra?: Record<string, unknown>;\n}\n\n/** Query parameters a route takes beside `filter` or `where` - a keyword, a scope. The filter and `where` win over a key of the same name. */\nexport type THttpExtraQuery = Record<string, unknown>;\n\n/** What the IGNIS search route answers: the total as `found` (`isFoundExact` is false when it is an estimate) and the hits. */\nexport interface IHttpSearchResult<R> {\n found: number;\n isFoundExact: boolean;\n hits: Array<{ document: R; score?: number; highlight?: unknown; highlights?: Array<unknown> }>;\n}\n"]}
|
|
@@ -1,17 +1,13 @@
|
|
|
1
1
|
import { type THttpReadShape } from './common/constants.js';
|
|
2
|
-
import {
|
|
3
|
-
import { NodeFetchNetworkRequest } from '@venizia/ignis-helpers/core';
|
|
2
|
+
import { DataSourceRoot } from '@venizia/ignis-kernel/repository';
|
|
4
3
|
import type { IAuthToken, IHttpCallOptions, IHttpDataSourceSettings, TExtraRequest, IHttpReadResult, IHttpRequestContext, IHttpWriteResult, THttpBody } from './common/types.js';
|
|
5
4
|
/** Reads an IGNIS REST server through the repository contract. Targets IGNIS, not any REST API. */
|
|
6
|
-
export declare class HttpDataSource extends
|
|
5
|
+
export declare class HttpDataSource extends DataSourceRoot<IHttpDataSourceSettings> {
|
|
7
6
|
name: string;
|
|
8
7
|
settings: IHttpDataSourceSettings;
|
|
9
8
|
schema: never;
|
|
10
|
-
protected network: NodeFetchNetworkRequest;
|
|
11
9
|
/** Normalised once: every request copies these, never re-parses `settings.headers`. */
|
|
12
10
|
protected configuredHeaders: Array<[string, string]>;
|
|
13
|
-
/** Decided once: a relative baseUrl (`/api`) is resolved against the page origin on every request. */
|
|
14
|
-
protected isRelativeBaseUrl: boolean;
|
|
15
11
|
constructor(opts: IHttpDataSourceSettings & {
|
|
16
12
|
name?: string;
|
|
17
13
|
});
|
|
@@ -32,21 +28,6 @@ export declare class HttpDataSource extends AbstractDataSource<IHttpDataSourceSe
|
|
|
32
28
|
isJsonBody?: boolean;
|
|
33
29
|
isFormDataBody?: boolean;
|
|
34
30
|
}): Headers;
|
|
35
|
-
/** The browser global `location` is not declared for a server build, so it is probed, not assumed. */
|
|
36
|
-
protected resolveLocationOrigin(): string | undefined;
|
|
37
|
-
/** The path as an error message quotes it: cut at 200 characters, with an ellipsis. */
|
|
38
|
-
protected static toEchoedPath(opts: {
|
|
39
|
-
path: string;
|
|
40
|
-
}): string;
|
|
41
|
-
/** The request paths name a place under the base path, so none may be a dot segment, hide one, or carry a separator the URL parser would read differently from a server. */
|
|
42
|
-
protected assertPathsStayUnderBase(opts: {
|
|
43
|
-
paths: Array<string>;
|
|
44
|
-
}): void;
|
|
45
|
-
/** The resolved URL, whatever built it, is on the base's origin and under its path: the check that holds when the text checks above miss a form. */
|
|
46
|
-
protected assertUnderBase(opts: {
|
|
47
|
-
url: URL;
|
|
48
|
-
origin?: string;
|
|
49
|
-
}): void;
|
|
50
31
|
buildUrl(opts: {
|
|
51
32
|
paths: Array<string>;
|
|
52
33
|
query?: Record<string, unknown>;
|
|
@@ -76,7 +57,7 @@ export declare class HttpDataSource extends AbstractDataSource<IHttpDataSourceSe
|
|
|
76
57
|
response: Response;
|
|
77
58
|
url: string;
|
|
78
59
|
verb: string;
|
|
79
|
-
}): Promise<
|
|
60
|
+
}): Promise<import("@venizia/ignis-helpers").TJsonValue>;
|
|
80
61
|
/**
|
|
81
62
|
* A failed response as the error the server threw: its status, code, args and text, and its
|
|
82
63
|
* `extra` with the `requestId` added. `message` adds where it failed, for logs; `normalized.text`
|