@ibgib/node-gib 0.0.18 → 0.0.20
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/dist/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.handler.d.mts +39 -0
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.handler.d.mts.map +1 -0
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.handler.mjs +197 -0
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.handler.mjs.map +1 -0
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-genesis.handler.d.mts.map +1 -1
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-genesis.handler.mjs +6 -3
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-genesis.handler.mjs.map +1 -1
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-register-delegate.handler.d.mts.map +1 -1
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-register-delegate.handler.mjs +5 -3
- package/dist/serve-gib/handlers/api/identity/keystone-custodian-register-delegate.handler.mjs.map +1 -1
- package/dist/serve-gib/handlers/api/keystone/sso-login.handler.d.mts.map +1 -1
- package/dist/serve-gib/handlers/api/keystone/sso-login.handler.mjs +11 -5
- package/dist/serve-gib/handlers/api/keystone/sso-login.handler.mjs.map +1 -1
- package/dist/serve-gib/identity-index/identity-index-service.d.mts +5 -1
- package/dist/serve-gib/identity-index/identity-index-service.d.mts.map +1 -1
- package/dist/serve-gib/identity-index/identity-index-service.mjs +10 -1
- package/dist/serve-gib/identity-index/identity-index-service.mjs.map +1 -1
- package/dist/serve-gib/index.d.mts +1 -0
- package/dist/serve-gib/index.d.mts.map +1 -1
- package/dist/serve-gib/index.mjs +3 -0
- package/dist/serve-gib/index.mjs.map +1 -1
- package/dist/serve-gib/path-constants.d.mts +4 -0
- package/dist/serve-gib/path-constants.d.mts.map +1 -1
- package/dist/serve-gib/path-constants.mjs +4 -0
- package/dist/serve-gib/path-constants.mjs.map +1 -1
- package/e2e/identity-custodian-lifecycle.e2e.md +37 -0
- package/e2e/identity-sso-lifecycle.e2e.md +9 -7
- package/package.json +3 -3
- package/src/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.handler.mts +245 -0
- package/src/serve-gib/handlers/api/identity/keystone-custodian-add-master-password.respec.mts +167 -0
- package/src/serve-gib/handlers/api/identity/keystone-custodian-genesis.handler.mts +6 -3
- package/src/serve-gib/handlers/api/identity/keystone-custodian-register-delegate.handler.mts +5 -3
- package/src/serve-gib/handlers/api/identity/keystone-custodian-register-delegate.respec.mts +3 -3
- package/src/serve-gib/handlers/api/keystone/sso-login.handler.mts +12 -6
- package/src/serve-gib/identity-index/identity-index-service.mts +11 -1
- package/src/serve-gib/index.mts +3 -0
- package/src/serve-gib/path-constants.mts +5 -0
- package/data/identity_index/email/hashes/32/13/49/e64f32730f01a61ada211f29eaf0a210fc2386b668ad04d7e8a9b16766.json +0 -4
- package/dist/serve-gib/handlers/api/ibgib/ibgib-handler-types.d.mts +0 -41
- package/dist/serve-gib/handlers/api/ibgib/ibgib-handler-types.d.mts.map +0 -1
- package/dist/serve-gib/handlers/api/ibgib/ibgib-handler-types.mjs +0 -34
- package/dist/serve-gib/handlers/api/ibgib/ibgib-handler-types.mjs.map +0 -1
- package/dist/serve-gib/handlers/api/ibgib/ibgib.handler.d.mts +0 -26
- package/dist/serve-gib/handlers/api/ibgib/ibgib.handler.d.mts.map +0 -1
- package/dist/serve-gib/handlers/api/ibgib/ibgib.handler.mjs +0 -179
- package/dist/serve-gib/handlers/api/ibgib/ibgib.handler.mjs.map +0 -1
- package/src/serve-gib/handlers/api/ibgib/ibgib-handler-types.mts +0 -49
- package/src/serve-gib/handlers/api/ibgib/ibgib.handler.mts +0 -176
|
@@ -218,9 +218,19 @@ let _identityIndexService: IdentityIndexService | undefined;
|
|
|
218
218
|
/**
|
|
219
219
|
* Singleton factory getter for the IdentityIndexService.
|
|
220
220
|
*/
|
|
221
|
-
export function getIdentityIndexService(): IdentityIndexService {
|
|
221
|
+
export function getIdentityIndexService(opts?: IdentityIndexServiceOptions): IdentityIndexService {
|
|
222
|
+
if (opts) {
|
|
223
|
+
return new IdentityIndexService(opts);
|
|
224
|
+
}
|
|
222
225
|
if (!_identityIndexService) {
|
|
223
226
|
_identityIndexService = new IdentityIndexService();
|
|
224
227
|
}
|
|
225
228
|
return _identityIndexService;
|
|
226
229
|
}
|
|
230
|
+
|
|
231
|
+
/**
|
|
232
|
+
* Resets the cached singleton instance (useful during testing across different data directories).
|
|
233
|
+
*/
|
|
234
|
+
export function resetIdentityIndexService(): void {
|
|
235
|
+
_identityIndexService = undefined;
|
|
236
|
+
}
|
package/src/serve-gib/index.mts
CHANGED
|
@@ -36,6 +36,7 @@ export * from './handlers/api/keystone/sso-link.handler.mjs';
|
|
|
36
36
|
export * from './handlers/api/keystone/sso-login.handler.mjs';
|
|
37
37
|
export * from './handlers/api/identity/keystone-custodian-genesis.handler.mjs';
|
|
38
38
|
export * from './handlers/api/identity/keystone-custodian-register-delegate.handler.mjs';
|
|
39
|
+
export * from './handlers/api/identity/keystone-custodian-add-master-password.handler.mjs';
|
|
39
40
|
export * from './handlers/api/email/email-inbound.handler.mjs';
|
|
40
41
|
export * from './handlers/api/email/email-outbound.handler.mjs';
|
|
41
42
|
export * from './handlers/api/email/email-verification-code.handler.mjs';
|
|
@@ -60,6 +61,7 @@ import { SsoLoginHandler } from './handlers/api/keystone/sso-login.handler.mjs';
|
|
|
60
61
|
import { SsoConfigHandler } from './handlers/api/keystone/sso-config.handler.mjs';
|
|
61
62
|
import { KeystoneCustodianGenesisHandler } from './handlers/api/identity/keystone-custodian-genesis.handler.mjs';
|
|
62
63
|
import { KeystoneCustodianRegisterDelegateHandler } from './handlers/api/identity/keystone-custodian-register-delegate.handler.mjs';
|
|
64
|
+
import { KeystoneCustodianAddMasterPasswordHandler } from './handlers/api/identity/keystone-custodian-add-master-password.handler.mjs';
|
|
63
65
|
import { EmailInboundHandler } from './handlers/api/email/email-inbound.handler.mjs';
|
|
64
66
|
import { EmailOutboundHandler } from './handlers/api/email/email-outbound.handler.mjs';
|
|
65
67
|
import { EmailVerificationCodeHandler } from './handlers/api/email/email-verification-code.handler.mjs';
|
|
@@ -89,6 +91,7 @@ export function getStandardServeGibHandlers(opts: StandardHandlersOptions = {}):
|
|
|
89
91
|
new SsoConfigHandler(),
|
|
90
92
|
new KeystoneCustodianGenesisHandler(),
|
|
91
93
|
new KeystoneCustodianRegisterDelegateHandler(),
|
|
94
|
+
new KeystoneCustodianAddMasterPasswordHandler(),
|
|
92
95
|
new EmailInboundHandler(),
|
|
93
96
|
new EmailOutboundHandler(),
|
|
94
97
|
new EmailVerificationCodeHandler(),
|
|
@@ -134,6 +134,11 @@ export const API_PATH_REGEXES = {
|
|
|
134
134
|
* /api/identity/custodian/register-delegate
|
|
135
135
|
*/
|
|
136
136
|
KEYSTONE_CUSTODIAN_REGISTER_DELEGATE: /^\/api\/identity\/custodian\/register-delegate\/?$/i,
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* /api/identity/custodian/add-master-password
|
|
140
|
+
*/
|
|
141
|
+
KEYSTONE_CUSTODIAN_ADD_MASTER_PASSWORD: /^\/api\/identity\/custodian\/add-master-password\/?$/i,
|
|
137
142
|
};
|
|
138
143
|
|
|
139
144
|
export const VALID_STATIC_PATH_REGEX = /^\/[a-zA-Z0-9\-_\.\/]*$/;
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
import { IbGibAddr } from "@ibgib/ts-gib/dist/types.mjs";
|
|
2
|
-
import { DomainInfo } from "../../../types.mjs";
|
|
3
|
-
export interface IbGibParams {
|
|
4
|
-
domainInfo: DomainInfo;
|
|
5
|
-
ibGibIb: string;
|
|
6
|
-
ibGibGib: string;
|
|
7
|
-
ibGibAddr: IbGibAddr;
|
|
8
|
-
}
|
|
9
|
-
export declare const DEFAULT_QUERY_PARAMS_GET_IBGIB: {
|
|
10
|
-
/**
|
|
11
|
-
* If true, will get the latest ibgib.
|
|
12
|
-
*/
|
|
13
|
-
getLatest: boolean;
|
|
14
|
-
/**
|
|
15
|
-
* If true, will get the ibgib's entire dependency graph
|
|
16
|
-
*/
|
|
17
|
-
getGraph: boolean;
|
|
18
|
-
/**
|
|
19
|
-
* If true, returns only the resolved address (addr) rather than the full
|
|
20
|
-
* ibgib or graph body. Useful for a lightweight "tip check" before initiating
|
|
21
|
-
* a full sync: client compares `latestAddr` with its locally known addr.
|
|
22
|
-
*
|
|
23
|
-
* ## notes
|
|
24
|
-
*
|
|
25
|
-
* Typically combined with `getLatest: true` to ask "what is the server's
|
|
26
|
-
* current tip for this timeline?" without paying the cost of fetching the
|
|
27
|
-
* full ibgib body or graph.
|
|
28
|
-
*
|
|
29
|
-
* When `getLatest: false` and `addrOnly: true`, returns the addr as-is
|
|
30
|
-
* (i.e., confirms the given addr exists on the server).
|
|
31
|
-
*/
|
|
32
|
-
addrOnly: boolean;
|
|
33
|
-
};
|
|
34
|
-
/**
|
|
35
|
-
* @see {@link DEFAULT_QUERY_PARAMS_GET_IBGIB} key/values for jsdocs
|
|
36
|
-
*/
|
|
37
|
-
export type IbGibGetQueryParams = Partial<typeof DEFAULT_QUERY_PARAMS_GET_IBGIB>;
|
|
38
|
-
export type KNOWN_QUERY_PARAMS_IBGIB_GET = keyof IbGibGetQueryParams;
|
|
39
|
-
export declare const KNOWN_QUERY_PARAMS_IBGIB_GET: KNOWN_QUERY_PARAMS_IBGIB_GET[];
|
|
40
|
-
export declare function isKnownQueryParamsKey_IbGibGet(key: any): key is KNOWN_QUERY_PARAMS_IBGIB_GET;
|
|
41
|
-
//# sourceMappingURL=ibgib-handler-types.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ibgib-handler-types.d.mts","sourceRoot":"","sources":["../../../../../src/serve-gib/handlers/api/ibgib/ibgib-handler-types.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,WAAW,WAAW;IACxB,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;CACxB;AAGD,eAAO,MAAM,8BAA8B;IACvC;;OAEG;IACH,SAAS;IACT;;OAEG;IACH,QAAQ;IACR;;;;;;;;;;;;;OAaG;IACH,QAAQ;CACX,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACjF,MAAM,MAAM,4BAA4B,GAAG,MAAM,mBAAmB,CAAC;AACrE,eAAO,MAAM,4BAA4B,EAAkD,4BAA4B,EAAE,CAAC;AAC1H,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,4BAA4B,CAI5F"}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
// #region IbGibGetQueryParams
|
|
2
|
-
export const DEFAULT_QUERY_PARAMS_GET_IBGIB = {
|
|
3
|
-
/**
|
|
4
|
-
* If true, will get the latest ibgib.
|
|
5
|
-
*/
|
|
6
|
-
getLatest: false, // Default to false for regular ibgibs
|
|
7
|
-
/**
|
|
8
|
-
* If true, will get the ibgib's entire dependency graph
|
|
9
|
-
*/
|
|
10
|
-
getGraph: false, // Default to false for regular ibgibs
|
|
11
|
-
/**
|
|
12
|
-
* If true, returns only the resolved address (addr) rather than the full
|
|
13
|
-
* ibgib or graph body. Useful for a lightweight "tip check" before initiating
|
|
14
|
-
* a full sync: client compares `latestAddr` with its locally known addr.
|
|
15
|
-
*
|
|
16
|
-
* ## notes
|
|
17
|
-
*
|
|
18
|
-
* Typically combined with `getLatest: true` to ask "what is the server's
|
|
19
|
-
* current tip for this timeline?" without paying the cost of fetching the
|
|
20
|
-
* full ibgib body or graph.
|
|
21
|
-
*
|
|
22
|
-
* When `getLatest: false` and `addrOnly: true`, returns the addr as-is
|
|
23
|
-
* (i.e., confirms the given addr exists on the server).
|
|
24
|
-
*/
|
|
25
|
-
addrOnly: false,
|
|
26
|
-
};
|
|
27
|
-
export const KNOWN_QUERY_PARAMS_IBGIB_GET = Object.keys(DEFAULT_QUERY_PARAMS_GET_IBGIB);
|
|
28
|
-
export function isKnownQueryParamsKey_IbGibGet(key) {
|
|
29
|
-
return !!key && typeof key === 'string' ?
|
|
30
|
-
KNOWN_QUERY_PARAMS_IBGIB_GET.includes(key) :
|
|
31
|
-
false;
|
|
32
|
-
}
|
|
33
|
-
// #endregion IbGibGetQueryParams
|
|
34
|
-
//# sourceMappingURL=ibgib-handler-types.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ibgib-handler-types.mjs","sourceRoot":"","sources":["../../../../../src/serve-gib/handlers/api/ibgib/ibgib-handler-types.mts"],"names":[],"mappings":"AAWA,8BAA8B;AAC9B,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,KAAK,EAAE,sCAAsC;IACxD;;OAEG;IACH,QAAQ,EAAE,KAAK,EAAE,sCAAsC;IACvD;;;;;;;;;;;;;OAaG;IACH,QAAQ,EAAE,KAAK;CAClB,CAAC;AAMF,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAmC,CAAC;AAC1H,MAAM,UAAU,8BAA8B,CAAC,GAAQ;IACnD,OAAO,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC;QACrC,4BAA4B,CAAC,QAAQ,CAAC,GAAU,CAAC,CAAC,CAAC;QACnD,KAAK,CAAC;AACd,CAAC;AACD,iCAAiC"}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @module serve-gib/handlers/api/ibgib
|
|
3
|
-
*/
|
|
4
|
-
import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
|
|
5
|
-
import { ServeGibHandlerWithMetaspaceBase } from '../../handler-base.mjs';
|
|
6
|
-
import { RequestContext, ResponseResult, ServeGibHttpMethod } from '../../../types.mjs';
|
|
7
|
-
import { IbGibGetQueryParams, IbGibParams } from './ibgib-handler-types.mjs';
|
|
8
|
-
export interface IbGibGraphResponseBody {
|
|
9
|
-
addr: string;
|
|
10
|
-
count: number;
|
|
11
|
-
graph: Record<string, IbGib_V1>;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* GET /api/ibgib/:domainAddr/:ibGibAddr
|
|
15
|
-
*/
|
|
16
|
-
export declare class IbGibHandler extends ServeGibHandlerWithMetaspaceBase<IbGibParams, IbGibGetQueryParams> {
|
|
17
|
-
protected lc: string;
|
|
18
|
-
protected method: ServeGibHttpMethod;
|
|
19
|
-
protected regex: RegExp;
|
|
20
|
-
protected parseParamsImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<IbGibParams | undefined>;
|
|
21
|
-
protected validateQueryParams({ queryParams }: {
|
|
22
|
-
queryParams: any;
|
|
23
|
-
}): Promise<string[]>;
|
|
24
|
-
protected handleRouteImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<ResponseResult | undefined>;
|
|
25
|
-
}
|
|
26
|
-
//# sourceMappingURL=ibgib.handler.d.mts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ibgib.handler.d.mts","sourceRoot":"","sources":["../../../../../src/serve-gib/handlers/api/ibgib/ibgib.handler.mts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAG3D,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAGxF,OAAO,EAC6B,mBAAmB,EAAE,WAAW,EAEnE,MAAM,2BAA2B,CAAC;AAGnC,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACnC;AAID;;GAEG;AACH,qBAAa,YAAa,SAAQ,gCAAgC,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAChG,UAAmB,EAAE,EAAE,MAAM,CAA4B;IACzD,UAAmB,MAAM,EAAE,kBAAkB,CAAS;IACtD,UAAmB,KAAK,SAA+B;IAEvD,UAAyB,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,WAAW,EAAE,mBAAmB,CAAC,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAsBnI;IAED,UAAyB,mBAAmB,CAAC,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,GAAG,CAAC;KAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAmCtG;IAED,UAAgB,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,WAAW,EAAE,mBAAmB,CAAC,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC,CA8E7H;CACJ"}
|
|
@@ -1,179 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @module serve-gib/handlers/api/ibgib
|
|
3
|
-
*/
|
|
4
|
-
import { extractErrorMsg } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
|
|
5
|
-
import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
|
|
6
|
-
import { GLOBAL_LOG_A_LOT } from '../../../constants.mjs';
|
|
7
|
-
import { ServeGibHandlerWithMetaspaceBase } from '../../handler-base.mjs';
|
|
8
|
-
import { validateAddressSegment } from '../../../path-helper.mjs';
|
|
9
|
-
import { API_PATH_REGEXES } from '../../../path-constants.mjs';
|
|
10
|
-
import { DEFAULT_QUERY_PARAMS_GET_IBGIB, isKnownQueryParamsKey_IbGibGet, KNOWN_QUERY_PARAMS_IBGIB_GET } from './ibgib-handler-types.mjs';
|
|
11
|
-
import { validateAndCoerceBooleanQueryParam } from '../../../serve-gib-helpers.mjs';
|
|
12
|
-
const logalot = GLOBAL_LOG_A_LOT;
|
|
13
|
-
/**
|
|
14
|
-
* GET /api/ibgib/:domainAddr/:ibGibAddr
|
|
15
|
-
*/
|
|
16
|
-
export class IbGibHandler extends ServeGibHandlerWithMetaspaceBase {
|
|
17
|
-
lc = `[${IbGibHandler.name}]`;
|
|
18
|
-
method = 'GET';
|
|
19
|
-
regex = API_PATH_REGEXES.IBGIB_ADDR;
|
|
20
|
-
async parseParamsImpl(reqCtx) {
|
|
21
|
-
const lc = `${this.lc}[${this.parseParamsImpl.name}]`;
|
|
22
|
-
try {
|
|
23
|
-
if (logalot) {
|
|
24
|
-
console.log(`${lc} starting...`);
|
|
25
|
-
}
|
|
26
|
-
const match = reqCtx.pathname.match(this.regex);
|
|
27
|
-
if (!match) {
|
|
28
|
-
throw new Error(`(UNEXPECTED) match falsy for regex? at this point, we have passed canHandleRoute, so this should parse correctly. (E: 8ce0810a3a88f420639bf8286df1d826)`);
|
|
29
|
-
}
|
|
30
|
-
const domainIb = decodeURIComponent(match[1]);
|
|
31
|
-
const domainGib = decodeURIComponent(match[2]);
|
|
32
|
-
const domainAddr = getIbGibAddr({ ib: domainIb, gib: domainGib });
|
|
33
|
-
const ibGibIb = decodeURIComponent(match[3]);
|
|
34
|
-
const ibGibGib = decodeURIComponent(match[4]);
|
|
35
|
-
const ibGibAddr = getIbGibAddr({ ib: ibGibIb, gib: ibGibGib });
|
|
36
|
-
return {
|
|
37
|
-
ibGibIb, ibGibGib, ibGibAddr,
|
|
38
|
-
domainInfo: this.getDomainInfo({ domainAddr }),
|
|
39
|
-
};
|
|
40
|
-
}
|
|
41
|
-
catch (error) {
|
|
42
|
-
console.error(`${lc} ${extractErrorMsg(error)}`);
|
|
43
|
-
throw error;
|
|
44
|
-
}
|
|
45
|
-
finally {
|
|
46
|
-
if (logalot) {
|
|
47
|
-
console.log(`${lc} complete.`);
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
async validateQueryParams({ queryParams }) {
|
|
52
|
-
const lc = `${this.lc}[${this.validateQueryParams.name}]`;
|
|
53
|
-
try {
|
|
54
|
-
if (logalot) {
|
|
55
|
-
console.log(`${lc} starting...`);
|
|
56
|
-
}
|
|
57
|
-
const errors = [];
|
|
58
|
-
// strict checking
|
|
59
|
-
const queryParamsKeys = Object.keys(queryParams);
|
|
60
|
-
const invalidKeys = queryParamsKeys.filter(x => !isKnownQueryParamsKey_IbGibGet(x));
|
|
61
|
-
if (invalidKeys.length > 0) {
|
|
62
|
-
throw new Error(`invalid query params keys: ${invalidKeys.join(', ')}. valid query params keys: ${KNOWN_QUERY_PARAMS_IBGIB_GET.join(', ')} (E: b7e8a9f2c1d34e56b89a01d4f2e7c326)`);
|
|
63
|
-
}
|
|
64
|
-
const ValidationFns = {
|
|
65
|
-
getLatest: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getLatest', errors),
|
|
66
|
-
getGraph: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getGraph', errors),
|
|
67
|
-
addrOnly: async () => validateAndCoerceBooleanQueryParam(queryParams, 'addrOnly', errors),
|
|
68
|
-
};
|
|
69
|
-
// execute all validation functions
|
|
70
|
-
for (const fn of Object.values(ValidationFns)) {
|
|
71
|
-
await fn();
|
|
72
|
-
}
|
|
73
|
-
return errors;
|
|
74
|
-
}
|
|
75
|
-
catch (error) {
|
|
76
|
-
console.error(`${lc} ${extractErrorMsg(error)}`);
|
|
77
|
-
throw error;
|
|
78
|
-
}
|
|
79
|
-
finally {
|
|
80
|
-
if (logalot) {
|
|
81
|
-
console.log(`${lc} complete.`);
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
async handleRouteImpl(reqCtx) {
|
|
86
|
-
const lc = `${this.lc}[${this.handleRouteImpl.name}]`;
|
|
87
|
-
try {
|
|
88
|
-
if (logalot) {
|
|
89
|
-
console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`);
|
|
90
|
-
}
|
|
91
|
-
if (logalot) {
|
|
92
|
-
console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`);
|
|
93
|
-
}
|
|
94
|
-
if (!reqCtx.metaspace) {
|
|
95
|
-
throw new Error(`(UNEXPECTED) metaspace falsy? we should have initialized it by now since this is a domain-dependent handler (E: 864661c668d2aa1918b7ee677a7d9c26)`);
|
|
96
|
-
}
|
|
97
|
-
const { ibGibIb, ibGibGib } = reqCtx.params;
|
|
98
|
-
if (!ibGibIb || !ibGibGib) {
|
|
99
|
-
return undefined;
|
|
100
|
-
}
|
|
101
|
-
// Reconstruct addr from params
|
|
102
|
-
const rawAddr = `${ibGibIb}^${ibGibGib}`;
|
|
103
|
-
if (!validateAddressSegment(rawAddr))
|
|
104
|
-
return this.error(400, 'Invalid address format');
|
|
105
|
-
const addr = rawAddr;
|
|
106
|
-
const queryParams = {
|
|
107
|
-
...DEFAULT_QUERY_PARAMS_GET_IBGIB,
|
|
108
|
-
...(reqCtx.queryParams ?? {}),
|
|
109
|
-
};
|
|
110
|
-
const { getLatest, getGraph, addrOnly } = queryParams;
|
|
111
|
-
const space = await reqCtx.metaspace.getLocalUserSpace({ lock: false });
|
|
112
|
-
if (!space) {
|
|
113
|
-
throw new Error(`(UNEXPECTED) couldn't get default local user space? (E: ec6161ea3a08892ad8bfd1b7b0d79826)`);
|
|
114
|
-
}
|
|
115
|
-
let addr_latest = addr;
|
|
116
|
-
if (getLatest) {
|
|
117
|
-
const latestAddr = await reqCtx.metaspace.getLatestAddr({ addr, space });
|
|
118
|
-
if (latestAddr) {
|
|
119
|
-
addr_latest = latestAddr;
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
// Lightweight tip-check: return only the resolved address.
|
|
123
|
-
// Client uses this to decide whether a full sync is necessary
|
|
124
|
-
// without incurring the cost of fetching the full ibgib or graph.
|
|
125
|
-
if (addrOnly && !getGraph) {
|
|
126
|
-
return this.ok({ addr: addr_latest, clientAddr: addr });
|
|
127
|
-
} /* <<<<< returns early */
|
|
128
|
-
if (getGraph) {
|
|
129
|
-
const resGraph = await reqCtx.metaspace.getDependencyGraph({
|
|
130
|
-
ibGibAddr: addr_latest,
|
|
131
|
-
space,
|
|
132
|
-
live: getLatest,
|
|
133
|
-
});
|
|
134
|
-
const addrs = Object.keys(resGraph);
|
|
135
|
-
if (addrs.length > 0) {
|
|
136
|
-
if (addrOnly) {
|
|
137
|
-
// Return only the address list for delta negotiation (smart diff):
|
|
138
|
-
// client compares these against what it already has to determine
|
|
139
|
-
// the minimal set it needs to fetch.
|
|
140
|
-
return this.ok({ addr: addr_latest, clientAddr: addr, addrs });
|
|
141
|
-
}
|
|
142
|
-
else {
|
|
143
|
-
const responseBody = {
|
|
144
|
-
addr: addr_latest,
|
|
145
|
-
count: addrs.length,
|
|
146
|
-
graph: resGraph
|
|
147
|
-
};
|
|
148
|
-
return this.ok(responseBody);
|
|
149
|
-
}
|
|
150
|
-
}
|
|
151
|
-
else {
|
|
152
|
-
return this.notFound(`Graph not found for ${addr_latest} (E: 89b259f13ae5e4f0d8287f6c0475a826)`);
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
else {
|
|
156
|
-
const resGet = await reqCtx.metaspace.get({ space, addr: addr_latest });
|
|
157
|
-
if (resGet.success && resGet.ibGibs?.length === 1) {
|
|
158
|
-
const ibGib = resGet.ibGibs[0];
|
|
159
|
-
return this.ok(ibGib);
|
|
160
|
-
}
|
|
161
|
-
else {
|
|
162
|
-
return this.notFound(`IbGib not found for ${addr_latest} (E: 017621e0a8086832ff06cfc884b8c426)`);
|
|
163
|
-
}
|
|
164
|
-
}
|
|
165
|
-
}
|
|
166
|
-
catch (error) {
|
|
167
|
-
if (logalot) {
|
|
168
|
-
console.error(extractErrorMsg(error));
|
|
169
|
-
}
|
|
170
|
-
return this.error(500, extractErrorMsg(error));
|
|
171
|
-
}
|
|
172
|
-
finally {
|
|
173
|
-
if (logalot) {
|
|
174
|
-
console.log(`${lc} complete.`);
|
|
175
|
-
}
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
//# sourceMappingURL=ibgib.handler.mjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ibgib.handler.mjs","sourceRoot":"","sources":["../../../../../src/serve-gib/handlers/api/ibgib/ibgib.handler.mts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,iDAAiD,CAAC;AAClF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAE1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EACH,8BAA8B,EAC9B,8BAA8B,EAAE,4BAA4B,EAC/D,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAC;AAQpF,MAAM,OAAO,GAAG,gBAAgB,CAAC;AAEjC;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,gCAAkE;IAC7E,EAAE,GAAW,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC;IACtC,MAAM,GAAuB,KAAK,CAAC;IACnC,KAAK,GAAG,gBAAgB,CAAC,UAAU,CAAC;IAEpC,KAAK,CAAC,eAAe,CAAC,MAAwD;QAC7F,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC;QACtD,IAAI,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAAC,CAAC;YAClD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChD,IAAI,CAAC,KAAK,EAAE,CAAC;gBAAC,MAAM,IAAI,KAAK,CAAC,yJAAyJ,CAAC,CAAC;YAAC,CAAC;YAC3L,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/C,MAAM,UAAU,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC/D,OAAO;gBACH,OAAO,EAAE,QAAQ,EAAE,SAAS;gBAC5B,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,CAAC;aACjD,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACjD,MAAM,KAAK,CAAC;QAChB,CAAC;gBAAS,CAAC;YACP,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAEkB,KAAK,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAyB;QAC/E,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC;QAC1D,IAAI,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YAAC,CAAC;YAElD,MAAM,MAAM,GAAa,EAAE,CAAC;YAE5B,kBAAkB;YAClB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACjD,MAAM,WAAW,GAAa,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9F,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,8BAA8B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YACvL,CAAC;YAID,MAAM,aAAa,GAAuD;gBACtE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,kCAAkC,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,CAAC;gBAC3F,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,kCAAkC,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC;gBACzF,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,kCAAkC,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC;aAC5F,CAAC;YAEF,mCAAmC;YACnC,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC5C,MAAM,EAAE,EAAE,CAAC;YACf,CAAC;YAED,OAAO,MAAM,CAAC;QAElB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACjD,MAAM,KAAK,CAAC;QAChB,CAAC;gBAAS,CAAC;YACP,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAAC,CAAC;QACpD,CAAC;IACL,CAAC;IAES,KAAK,CAAC,eAAe,CAAC,MAAwD;QACpF,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC;QACtD,IAAI,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,oDAAoD,CAAC,CAAC;YAAC,CAAC;YAExF,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,oDAAoD,CAAC,CAAC;YAAC,CAAC;YACxF,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBAAC,MAAM,IAAI,KAAK,CAAC,mJAAmJ,CAAC,CAAC;YAAC,CAAC;YAEhM,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,MAAqB,CAAC;YAC3D,IAAI,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAAC,OAAO,SAAS,CAAC;YAAC,CAAC;YAEhD,+BAA+B;YAC/B,MAAM,OAAO,GAAG,GAAG,OAAO,IAAI,QAAQ,EAAE,CAAC;YACzC,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;YACvF,MAAM,IAAI,GAAG,OAAO,CAAC;YAErB,MAAM,WAAW,GAAG;gBAChB,GAAG,8BAA8B;gBACjC,GAAG,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;aAChC,CAAC;YAEF,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC;YAEtD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YACxE,IAAI,CAAC,KAAK,EAAE,CAAC;gBAAC,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAC;YAAC,CAAC;YAE7H,IAAI,WAAW,GAAW,IAAI,CAAC;YAC/B,IAAI,SAAS,EAAE,CAAC;gBACZ,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;gBACzE,IAAI,UAAU,EAAE,CAAC;oBAAC,WAAW,GAAG,UAAU,CAAC;gBAAC,CAAC;YACjD,CAAC;YAED,2DAA2D;YAC3D,8DAA8D;YAC9D,kEAAkE;YAClE,IAAI,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,CAAC,CAAC,yBAAyB;YAE3B,IAAI,QAAQ,EAAE,CAAC;gBACX,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC;oBACvD,SAAS,EAAE,WAAW;oBACtB,KAAK;oBACL,IAAI,EAAE,SAAS;iBAClB,CAAC,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACnB,IAAI,QAAQ,EAAE,CAAC;wBACX,mEAAmE;wBACnE,iEAAiE;wBACjE,qCAAqC;wBACrC,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;oBACnE,CAAC;yBAAM,CAAC;wBACJ,MAAM,YAAY,GAA2B;4BACzC,IAAI,EAAE,WAAW;4BACjB,KAAK,EAAE,KAAK,CAAC,MAAM;4BACnB,KAAK,EAAE,QAAQ;yBAClB,CAAC;wBACF,OAAO,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;oBACjC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,uBAAuB,WAAW,wCAAwC,CAAC,CAAC;gBACrG,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;gBACxE,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;oBAChD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAC/B,OAAO,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,uBAAuB,WAAW,wCAAwC,CAAC,CAAC;gBACrG,CAAC;YACL,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAA;YAAC,CAAC;YACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;gBAAS,CAAC;YACP,IAAI,OAAO,EAAE,CAAC;gBAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAAC,CAAC;QACpD,CAAC;IACL,CAAC;CACJ"}
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
import { IbGibAddr } from "@ibgib/ts-gib/dist/types.mjs";
|
|
2
|
-
|
|
3
|
-
import { DomainInfo } from "../../../types.mjs";
|
|
4
|
-
|
|
5
|
-
export interface IbGibParams {
|
|
6
|
-
domainInfo: DomainInfo;
|
|
7
|
-
ibGibIb: string;
|
|
8
|
-
ibGibGib: string;
|
|
9
|
-
ibGibAddr: IbGibAddr;
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
// #region IbGibGetQueryParams
|
|
13
|
-
export const DEFAULT_QUERY_PARAMS_GET_IBGIB = {
|
|
14
|
-
/**
|
|
15
|
-
* If true, will get the latest ibgib.
|
|
16
|
-
*/
|
|
17
|
-
getLatest: false, // Default to false for regular ibgibs
|
|
18
|
-
/**
|
|
19
|
-
* If true, will get the ibgib's entire dependency graph
|
|
20
|
-
*/
|
|
21
|
-
getGraph: false, // Default to false for regular ibgibs
|
|
22
|
-
/**
|
|
23
|
-
* If true, returns only the resolved address (addr) rather than the full
|
|
24
|
-
* ibgib or graph body. Useful for a lightweight "tip check" before initiating
|
|
25
|
-
* a full sync: client compares `latestAddr` with its locally known addr.
|
|
26
|
-
*
|
|
27
|
-
* ## notes
|
|
28
|
-
*
|
|
29
|
-
* Typically combined with `getLatest: true` to ask "what is the server's
|
|
30
|
-
* current tip for this timeline?" without paying the cost of fetching the
|
|
31
|
-
* full ibgib body or graph.
|
|
32
|
-
*
|
|
33
|
-
* When `getLatest: false` and `addrOnly: true`, returns the addr as-is
|
|
34
|
-
* (i.e., confirms the given addr exists on the server).
|
|
35
|
-
*/
|
|
36
|
-
addrOnly: false,
|
|
37
|
-
};
|
|
38
|
-
/**
|
|
39
|
-
* @see {@link DEFAULT_QUERY_PARAMS_GET_IBGIB} key/values for jsdocs
|
|
40
|
-
*/
|
|
41
|
-
export type IbGibGetQueryParams = Partial<typeof DEFAULT_QUERY_PARAMS_GET_IBGIB>;
|
|
42
|
-
export type KNOWN_QUERY_PARAMS_IBGIB_GET = keyof IbGibGetQueryParams;
|
|
43
|
-
export const KNOWN_QUERY_PARAMS_IBGIB_GET = Object.keys(DEFAULT_QUERY_PARAMS_GET_IBGIB) as KNOWN_QUERY_PARAMS_IBGIB_GET[];
|
|
44
|
-
export function isKnownQueryParamsKey_IbGibGet(key: any): key is KNOWN_QUERY_PARAMS_IBGIB_GET {
|
|
45
|
-
return !!key && typeof key === 'string' ?
|
|
46
|
-
KNOWN_QUERY_PARAMS_IBGIB_GET.includes(key as any) :
|
|
47
|
-
false;
|
|
48
|
-
}
|
|
49
|
-
// #endregion IbGibGetQueryParams
|
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @module serve-gib/handlers/api/ibgib
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
import { extractErrorMsg } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
|
|
6
|
-
import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
|
|
7
|
-
import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
|
|
8
|
-
|
|
9
|
-
import { GLOBAL_LOG_A_LOT } from '../../../constants.mjs';
|
|
10
|
-
import { ServeGibHandlerWithMetaspaceBase } from '../../handler-base.mjs';
|
|
11
|
-
import { RequestContext, ResponseResult, ServeGibHttpMethod } from '../../../types.mjs';
|
|
12
|
-
import { validateAddressSegment } from '../../../path-helper.mjs';
|
|
13
|
-
import { API_PATH_REGEXES } from '../../../path-constants.mjs';
|
|
14
|
-
import {
|
|
15
|
-
DEFAULT_QUERY_PARAMS_GET_IBGIB, IbGibGetQueryParams, IbGibParams,
|
|
16
|
-
isKnownQueryParamsKey_IbGibGet, KNOWN_QUERY_PARAMS_IBGIB_GET
|
|
17
|
-
} from './ibgib-handler-types.mjs';
|
|
18
|
-
import { validateAndCoerceBooleanQueryParam } from '../../../serve-gib-helpers.mjs';
|
|
19
|
-
|
|
20
|
-
export interface IbGibGraphResponseBody {
|
|
21
|
-
addr: string;
|
|
22
|
-
count: number;
|
|
23
|
-
graph: Record<string, IbGib_V1>;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
const logalot = GLOBAL_LOG_A_LOT;
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* GET /api/ibgib/:domainAddr/:ibGibAddr
|
|
30
|
-
*/
|
|
31
|
-
export class IbGibHandler extends ServeGibHandlerWithMetaspaceBase<IbGibParams, IbGibGetQueryParams> {
|
|
32
|
-
protected override lc: string = `[${IbGibHandler.name}]`;
|
|
33
|
-
protected override method: ServeGibHttpMethod = 'GET';
|
|
34
|
-
protected override regex = API_PATH_REGEXES.IBGIB_ADDR;
|
|
35
|
-
|
|
36
|
-
protected override async parseParamsImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<IbGibParams | undefined> {
|
|
37
|
-
const lc = `${this.lc}[${this.parseParamsImpl.name}]`;
|
|
38
|
-
try {
|
|
39
|
-
if (logalot) { console.log(`${lc} starting...`); }
|
|
40
|
-
const match = reqCtx.pathname.match(this.regex);
|
|
41
|
-
if (!match) { throw new Error(`(UNEXPECTED) match falsy for regex? at this point, we have passed canHandleRoute, so this should parse correctly. (E: 8ce0810a3a88f420639bf8286df1d826)`); }
|
|
42
|
-
const domainIb = decodeURIComponent(match[1]);
|
|
43
|
-
const domainGib = decodeURIComponent(match[2]);
|
|
44
|
-
const domainAddr = getIbGibAddr({ ib: domainIb, gib: domainGib });
|
|
45
|
-
const ibGibIb = decodeURIComponent(match[3]);
|
|
46
|
-
const ibGibGib = decodeURIComponent(match[4]);
|
|
47
|
-
const ibGibAddr = getIbGibAddr({ ib: ibGibIb, gib: ibGibGib });
|
|
48
|
-
return {
|
|
49
|
-
ibGibIb, ibGibGib, ibGibAddr,
|
|
50
|
-
domainInfo: this.getDomainInfo({ domainAddr }),
|
|
51
|
-
};
|
|
52
|
-
} catch (error) {
|
|
53
|
-
console.error(`${lc} ${extractErrorMsg(error)}`);
|
|
54
|
-
throw error;
|
|
55
|
-
} finally {
|
|
56
|
-
if (logalot) { console.log(`${lc} complete.`); }
|
|
57
|
-
}
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
protected override async validateQueryParams({ queryParams }: { queryParams: any; }): Promise<string[]> {
|
|
61
|
-
const lc = `${this.lc}[${this.validateQueryParams.name}]`;
|
|
62
|
-
try {
|
|
63
|
-
if (logalot) { console.log(`${lc} starting...`); }
|
|
64
|
-
|
|
65
|
-
const errors: string[] = [];
|
|
66
|
-
|
|
67
|
-
// strict checking
|
|
68
|
-
const queryParamsKeys = Object.keys(queryParams);
|
|
69
|
-
const invalidKeys: string[] = queryParamsKeys.filter(x => !isKnownQueryParamsKey_IbGibGet(x));
|
|
70
|
-
if (invalidKeys.length > 0) {
|
|
71
|
-
throw new Error(`invalid query params keys: ${invalidKeys.join(', ')}. valid query params keys: ${KNOWN_QUERY_PARAMS_IBGIB_GET.join(', ')} (E: b7e8a9f2c1d34e56b89a01d4f2e7c326)`);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
// Enforce that EVERY key must have a validation function mapping
|
|
75
|
-
type ValidationFn = () => Promise<void>;
|
|
76
|
-
const ValidationFns: Record<KNOWN_QUERY_PARAMS_IBGIB_GET, ValidationFn> = {
|
|
77
|
-
getLatest: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getLatest', errors),
|
|
78
|
-
getGraph: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getGraph', errors),
|
|
79
|
-
addrOnly: async () => validateAndCoerceBooleanQueryParam(queryParams, 'addrOnly', errors),
|
|
80
|
-
};
|
|
81
|
-
|
|
82
|
-
// execute all validation functions
|
|
83
|
-
for (const fn of Object.values(ValidationFns)) {
|
|
84
|
-
await fn();
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
return errors;
|
|
88
|
-
|
|
89
|
-
} catch (error) {
|
|
90
|
-
console.error(`${lc} ${extractErrorMsg(error)}`);
|
|
91
|
-
throw error;
|
|
92
|
-
} finally {
|
|
93
|
-
if (logalot) { console.log(`${lc} complete.`); }
|
|
94
|
-
}
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
protected async handleRouteImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<ResponseResult | undefined> {
|
|
98
|
-
const lc = `${this.lc}[${this.handleRouteImpl.name}]`;
|
|
99
|
-
try {
|
|
100
|
-
if (logalot) { console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`); }
|
|
101
|
-
|
|
102
|
-
if (logalot) { console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`); }
|
|
103
|
-
if (!reqCtx.metaspace) { throw new Error(`(UNEXPECTED) metaspace falsy? we should have initialized it by now since this is a domain-dependent handler (E: 864661c668d2aa1918b7ee677a7d9c26)`); }
|
|
104
|
-
|
|
105
|
-
const { ibGibIb, ibGibGib } = reqCtx.params as IbGibParams;
|
|
106
|
-
if (!ibGibIb || !ibGibGib) { return undefined; }
|
|
107
|
-
|
|
108
|
-
// Reconstruct addr from params
|
|
109
|
-
const rawAddr = `${ibGibIb}^${ibGibGib}`;
|
|
110
|
-
if (!validateAddressSegment(rawAddr)) return this.error(400, 'Invalid address format');
|
|
111
|
-
const addr = rawAddr;
|
|
112
|
-
|
|
113
|
-
const queryParams = {
|
|
114
|
-
...DEFAULT_QUERY_PARAMS_GET_IBGIB,
|
|
115
|
-
...(reqCtx.queryParams ?? {}),
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
const { getLatest, getGraph, addrOnly } = queryParams;
|
|
119
|
-
|
|
120
|
-
const space = await reqCtx.metaspace.getLocalUserSpace({ lock: false });
|
|
121
|
-
if (!space) { throw new Error(`(UNEXPECTED) couldn't get default local user space? (E: ec6161ea3a08892ad8bfd1b7b0d79826)`); }
|
|
122
|
-
|
|
123
|
-
let addr_latest: string = addr;
|
|
124
|
-
if (getLatest) {
|
|
125
|
-
const latestAddr = await reqCtx.metaspace.getLatestAddr({ addr, space });
|
|
126
|
-
if (latestAddr) { addr_latest = latestAddr; }
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
// Lightweight tip-check: return only the resolved address.
|
|
130
|
-
// Client uses this to decide whether a full sync is necessary
|
|
131
|
-
// without incurring the cost of fetching the full ibgib or graph.
|
|
132
|
-
if (addrOnly && !getGraph) {
|
|
133
|
-
return this.ok({ addr: addr_latest, clientAddr: addr });
|
|
134
|
-
} /* <<<<< returns early */
|
|
135
|
-
|
|
136
|
-
if (getGraph) {
|
|
137
|
-
const resGraph = await reqCtx.metaspace.getDependencyGraph({
|
|
138
|
-
ibGibAddr: addr_latest,
|
|
139
|
-
space,
|
|
140
|
-
live: getLatest,
|
|
141
|
-
});
|
|
142
|
-
const addrs = Object.keys(resGraph);
|
|
143
|
-
if (addrs.length > 0) {
|
|
144
|
-
if (addrOnly) {
|
|
145
|
-
// Return only the address list for delta negotiation (smart diff):
|
|
146
|
-
// client compares these against what it already has to determine
|
|
147
|
-
// the minimal set it needs to fetch.
|
|
148
|
-
return this.ok({ addr: addr_latest, clientAddr: addr, addrs });
|
|
149
|
-
} else {
|
|
150
|
-
const responseBody: IbGibGraphResponseBody = {
|
|
151
|
-
addr: addr_latest,
|
|
152
|
-
count: addrs.length,
|
|
153
|
-
graph: resGraph
|
|
154
|
-
};
|
|
155
|
-
return this.ok(responseBody);
|
|
156
|
-
}
|
|
157
|
-
} else {
|
|
158
|
-
return this.notFound(`Graph not found for ${addr_latest} (E: 89b259f13ae5e4f0d8287f6c0475a826)`);
|
|
159
|
-
}
|
|
160
|
-
} else {
|
|
161
|
-
const resGet = await reqCtx.metaspace.get({ space, addr: addr_latest });
|
|
162
|
-
if (resGet.success && resGet.ibGibs?.length === 1) {
|
|
163
|
-
const ibGib = resGet.ibGibs[0];
|
|
164
|
-
return this.ok(ibGib);
|
|
165
|
-
} else {
|
|
166
|
-
return this.notFound(`IbGib not found for ${addr_latest} (E: 017621e0a8086832ff06cfc884b8c426)`);
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
} catch (error) {
|
|
170
|
-
if (logalot) { console.error(extractErrorMsg(error)) }
|
|
171
|
-
return this.error(500, extractErrorMsg(error));
|
|
172
|
-
} finally {
|
|
173
|
-
if (logalot) { console.log(`${lc} complete.`); }
|
|
174
|
-
}
|
|
175
|
-
}
|
|
176
|
-
}
|