@webpieces/core-util 0.4.750 → 0.4.751

package/src/ipc/IpcProtocol.d.ts

@@ -0,0 +1,37 @@
+import { ApiErrorPayload } from '../errors';
+export declare class IpcCallContext {
+    readonly txId: string;
+    readonly callId: string;
+    readonly parentCallId?: string | undefined;
+    constructor(txId: string, callId: string, parentCallId?: string | undefined);
+}
+export declare class IpcRequest {
+    readonly apiId: string;
+    readonly methodId: string;
+    readonly context: IpcCallContext;
+    readonly body: unknown;
+    readonly version = 1;
+    readonly type = "request";
+    constructor(apiId: string, methodId: string, context: IpcCallContext, body: unknown);
+}
+export declare class IpcSuccess {
+    readonly context: IpcCallContext;
+    readonly body: unknown;
+    readonly version = 1;
+    readonly type = "success";
+    constructor(context: IpcCallContext, body: unknown);
+}
+export declare class IpcFailure {
+    readonly context: IpcCallContext;
+    readonly error: ApiErrorPayload;
+    readonly version = 1;
+    readonly type = "failure";
+    constructor(context: IpcCallContext, error: ApiErrorPayload);
+}
+export type IpcReply = IpcSuccess | IpcFailure;
+export type IpcMessage = IpcRequest | IpcReply;
+export declare class IpcProtocol {
+    static record(value: unknown): Record<string, unknown>;
+    static parse(json: string): IpcMessage;
+    static sameContext(a: IpcCallContext, b: IpcCallContext): boolean;
+}

package/src/ipc/IpcProtocol.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IpcProtocol = exports.IpcFailure = exports.IpcSuccess = exports.IpcRequest = exports.IpcCallContext = void 0;
+const errors_1 = require("../errors");
+const IpcContract_1 = require("./IpcContract");
+class IpcCallContext {
+    txId;
+    callId;
+    parentCallId;
+    constructor(txId, callId, parentCallId) {
+        this.txId = txId;
+        this.callId = callId;
+        this.parentCallId = parentCallId;
+        IpcContract_1.IpcIdentity.assert(txId, 'transaction');
+        IpcContract_1.IpcIdentity.assert(callId, 'call');
+        if (parentCallId !== undefined)
+            IpcContract_1.IpcIdentity.assert(parentCallId, 'parent call');
+    }
+}
+exports.IpcCallContext = IpcCallContext;
+class IpcRequest {
+    apiId;
+    methodId;
+    context;
+    body;
+    version = 1;
+    type = 'request';
+    constructor(apiId, methodId, context, 
+    // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation
+    body) {
+        this.apiId = apiId;
+        this.methodId = methodId;
+        this.context = context;
+        this.body = body;
+    }
+}
+exports.IpcRequest = IpcRequest;
+class IpcSuccess {
+    context;
+    body;
+    version = 1;
+    type = 'success';
+    constructor(context, 
+    // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation
+    body) {
+        this.context = context;
+        this.body = body;
+    }
+}
+exports.IpcSuccess = IpcSuccess;
+class IpcFailure {
+    context;
+    error;
+    version = 1;
+    type = 'failure';
+    constructor(context, error) {
+        this.context = context;
+        this.error = error;
+    }
+}
+exports.IpcFailure = IpcFailure;
+class IpcProtocol {
+    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary; webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation
+    static record(value) {
+        if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+            throw new errors_1.InternalError('Malformed IPC envelope');
+        }
+        // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation
+        return value;
+    }
+    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary
+    static parse(json) {
+        const value = IpcProtocol.record(JSON.parse(json));
+        if (value['version'] !== 1)
+            throw new errors_1.InternalError('Unsupported IPC protocol version');
+        const raw = IpcProtocol.record(value['context']);
+        const context = new IpcCallContext(raw['txId'], raw['callId'], raw['parentCallId']);
+        switch (value['type']) {
+            case 'request':
+                IpcContract_1.IpcIdentity.assert(value['apiId'], 'API');
+                IpcContract_1.IpcIdentity.assert(value['methodId'], 'method');
+                if (!Object.prototype.hasOwnProperty.call(value, 'body'))
+                    throw new errors_1.InternalError('Missing IPC request body');
+                return new IpcRequest(value['apiId'], value['methodId'], context, value['body']);
+            case 'success':
+                if (!Object.prototype.hasOwnProperty.call(value, 'body'))
+                    throw new errors_1.InternalError('Missing IPC success body');
+                return new IpcSuccess(context, value['body']);
+            case 'failure':
+                return new IpcFailure(context, 
+                // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation
+                IpcProtocol.record(value['error']));
+            default:
+                throw new errors_1.InternalError('Invalid IPC message discriminator');
+        }
+    }
+    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary
+    static sameContext(a, b) {
+        return a.callId === b.callId && a.txId === b.txId && a.parentCallId === b.parentCallId;
+    }
+}
+exports.IpcProtocol = IpcProtocol;
+//# sourceMappingURL=IpcProtocol.js.map

package/src/ipc/IpcProtocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpcProtocol.js","sourceRoot":"","sources":["../../../../../../packages/core/core-util/src/ipc/IpcProtocol.ts"],"names":[],"mappings":";;;AAAA,sCAA2D;AAC3D,+CAA4C;AAE5C,MAAa,cAAc;IAEV;IACA;IACA;IAHb,YACa,IAAY,EACZ,MAAc,EACd,YAAqB;QAFrB,SAAI,GAAJ,IAAI,CAAQ;QACZ,WAAM,GAAN,MAAM,CAAQ;QACd,iBAAY,GAAZ,YAAY,CAAS;QAE9B,yBAAW,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QACxC,yBAAW,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,IAAI,YAAY,KAAK,SAAS;YAAE,yBAAW,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IACpF,CAAC;CACJ;AAVD,wCAUC;AAED,MAAa,UAAU;IAIN;IACA;IACA;IAEA;IAPJ,OAAO,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,SAAS,CAAC;IAC1B,YACa,KAAa,EACb,QAAgB,EAChB,OAAuB;IAChC,0IAA0I;IACjI,IAAa;QAJb,UAAK,GAAL,KAAK,CAAQ;QACb,aAAQ,GAAR,QAAQ,CAAQ;QAChB,YAAO,GAAP,OAAO,CAAgB;QAEvB,SAAI,GAAJ,IAAI,CAAS;IACvB,CAAC;CACP;AAVD,gCAUC;AACD,MAAa,UAAU;IAIN;IAEA;IALJ,OAAO,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,SAAS,CAAC;IAC1B,YACa,OAAuB;IAChC,0IAA0I;IACjI,IAAa;QAFb,YAAO,GAAP,OAAO,CAAgB;QAEvB,SAAI,GAAJ,IAAI,CAAS;IACvB,CAAC;CACP;AARD,gCAQC;AACD,MAAa,UAAU;IAIN;IACA;IAJJ,OAAO,GAAG,CAAC,CAAC;IACZ,IAAI,GAAG,SAAS,CAAC;IAC1B,YACa,OAAuB,EACvB,KAAsB;QADtB,YAAO,GAAP,OAAO,CAAgB;QACvB,UAAK,GAAL,KAAK,CAAiB;IAChC,CAAC;CACP;AAPD,gCAOC;AAID,MAAa,WAAW;IACpB,6QAA6Q;IAC7Q,MAAM,CAAC,MAAM,CAAC,KAAc;QACxB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACtE,MAAM,IAAI,sBAAa,CAAC,wBAAwB,CAAC,CAAC;QACtD,CAAC;QACD,0IAA0I;QAC1I,OAAO,KAAgC,CAAC;IAC5C,CAAC;IAED,oIAAoI;IACpI,MAAM,CAAC,KAAK,CAAC,IAAY;QACrB,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,sBAAa,CAAC,kCAAkC,CAAC,CAAC;QACxF,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,IAAI,cAAc,CAC9B,GAAG,CAAC,MAAM,CAAW,EACrB,GAAG,CAAC,QAAQ,CAAW,EACvB,GAAG,CAAC,cAAc,CAAuB,CAC5C,CAAC;QACF,QAAQ,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,KAAK,SAAS;gBACV,yBAAW,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC1C,yBAAW,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;oBACpD,MAAM,IAAI,sBAAa,CAAC,0BAA0B,CAAC,CAAC;gBACxD,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YACrF,KAAK,SAAS;gBACV,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC;oBACpD,MAAM,IAAI,sBAAa,CAAC,0BAA0B,CAAC,CAAC;gBACxD,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAClD,KAAK,SAAS;gBACV,OAAO,IAAI,UAAU,CACjB,OAAO;gBACP,0IAA0I;gBAC1I,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAA+B,CACnE,CAAC;YACN;gBACI,MAAM,IAAI,sBAAa,CAAC,mCAAmC,CAAC,CAAC;QACrE,CAAC;IACL,CAAC;IAED,oIAAoI;IACpI,MAAM,CAAC,WAAW,CAAC,CAAiB,EAAE,CAAiB;QACnD,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC,YAAY,CAAC;IAC3F,CAAC;CACJ;AA9CD,kCA8CC","sourcesContent":["import { ApiErrorPayload, InternalError } from '../errors';\nimport { IpcIdentity } from './IpcContract';\n\nexport class IpcCallContext {\n    constructor(\n        readonly txId: string,\n        readonly callId: string,\n        readonly parentCallId?: string,\n    ) {\n        IpcIdentity.assert(txId, 'transaction');\n        IpcIdentity.assert(callId, 'call');\n        if (parentCallId !== undefined) IpcIdentity.assert(parentCallId, 'parent call');\n    }\n}\n\nexport class IpcRequest {\n    readonly version = 1;\n    readonly type = 'request';\n    constructor(\n        readonly apiId: string,\n        readonly methodId: string,\n        readonly context: IpcCallContext,\n        // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation\n        readonly body: unknown,\n    ) {}\n}\nexport class IpcSuccess {\n    readonly version = 1;\n    readonly type = 'success';\n    constructor(\n        readonly context: IpcCallContext,\n        // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation\n        readonly body: unknown,\n    ) {}\n}\nexport class IpcFailure {\n    readonly version = 1;\n    readonly type = 'failure';\n    constructor(\n        readonly context: IpcCallContext,\n        readonly error: ApiErrorPayload,\n    ) {}\n}\nexport type IpcReply = IpcSuccess | IpcFailure;\nexport type IpcMessage = IpcRequest | IpcReply;\n\nexport class IpcProtocol {\n    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary; webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation\n    static record(value: unknown): Record<string, unknown> {\n        if (typeof value !== 'object' || value === null || Array.isArray(value)) {\n            throw new InternalError('Malformed IPC envelope');\n        }\n        // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation\n        return value as Record<string, unknown>;\n    }\n\n    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary\n    static parse(json: string): IpcMessage {\n        const value = IpcProtocol.record(JSON.parse(json));\n        if (value['version'] !== 1) throw new InternalError('Unsupported IPC protocol version');\n        const raw = IpcProtocol.record(value['context']);\n        const context = new IpcCallContext(\n            raw['txId'] as string,\n            raw['callId'] as string,\n            raw['parentCallId'] as string | undefined,\n        );\n        switch (value['type']) {\n            case 'request':\n                IpcIdentity.assert(value['apiId'], 'API');\n                IpcIdentity.assert(value['methodId'], 'method');\n                if (!Object.prototype.hasOwnProperty.call(value, 'body'))\n                    throw new InternalError('Missing IPC request body');\n                return new IpcRequest(value['apiId'], value['methodId'], context, value['body']);\n            case 'success':\n                if (!Object.prototype.hasOwnProperty.call(value, 'body'))\n                    throw new InternalError('Missing IPC success body');\n                return new IpcSuccess(context, value['body']);\n            case 'failure':\n                return new IpcFailure(\n                    context,\n                    // webpieces-disable no-any-unknown -- untrusted IPC data is schema-validated; generic dispatch cannot assume a DTO type before validation\n                    IpcProtocol.record(value['error']) as unknown as ApiErrorPayload,\n                );\n            default:\n                throw new InternalError('Invalid IPC message discriminator');\n        }\n    }\n\n    // webpieces-disable no-function-outside-class -- portable stateless IPC primitive; no platform DI container exists on this boundary\n    static sameContext(a: IpcCallContext, b: IpcCallContext): boolean {\n        return a.callId === b.callId && a.txId === b.txId && a.parentCallId === b.parentCallId;\n    }\n}\n"]}

package/src/ipc/index.d.ts

@@ -0,0 +1,14 @@
+export { IpcContract, IpcMethod, IpcVoidSchema } from './IpcContract';
+export type { IpcSchema, IpcMethods, IpcApiType } from './IpcContract';
+export { IpcCallContext, IpcRequest, IpcSuccess, IpcFailure, IpcProtocol } from './IpcProtocol';
+export type { IpcReply, IpcMessage } from './IpcProtocol';
+export { IpcConnection, IpcConnectionOptions, IpcTransportError, IpcErrors } from './IpcConnection';
+export type { IpcTransport, IpcScheduler, IpcErrorOwner } from './IpcConnection';
+export { IpcCallLogger } from './IpcLogging';
+export type { IpcLogging } from './IpcLogging';
+export { MaskSpec } from '../http/LogFieldMask';
+export { ApiMethodInfo } from '../http/ApiMethodInfo';
+export { LogApiCallImpl } from '../http/LogApiCall';
+export type { ApiCallContext } from '../http/ApiCallContext';
+export { TimeoutError } from '../http/TimeoutError';
+export { toError } from '../lib/errorUtils';

package/src/ipc/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toError = exports.TimeoutError = exports.LogApiCallImpl = exports.ApiMethodInfo = exports.MaskSpec = exports.IpcCallLogger = exports.IpcErrors = exports.IpcTransportError = exports.IpcConnectionOptions = exports.IpcConnection = exports.IpcProtocol = exports.IpcFailure = exports.IpcSuccess = exports.IpcRequest = exports.IpcCallContext = exports.IpcVoidSchema = exports.IpcMethod = exports.IpcContract = void 0;
+var IpcContract_1 = require("./IpcContract");
+Object.defineProperty(exports, "IpcContract", { enumerable: true, get: function () { return IpcContract_1.IpcContract; } });
+Object.defineProperty(exports, "IpcMethod", { enumerable: true, get: function () { return IpcContract_1.IpcMethod; } });
+Object.defineProperty(exports, "IpcVoidSchema", { enumerable: true, get: function () { return IpcContract_1.IpcVoidSchema; } });
+var IpcProtocol_1 = require("./IpcProtocol");
+Object.defineProperty(exports, "IpcCallContext", { enumerable: true, get: function () { return IpcProtocol_1.IpcCallContext; } });
+Object.defineProperty(exports, "IpcRequest", { enumerable: true, get: function () { return IpcProtocol_1.IpcRequest; } });
+Object.defineProperty(exports, "IpcSuccess", { enumerable: true, get: function () { return IpcProtocol_1.IpcSuccess; } });
+Object.defineProperty(exports, "IpcFailure", { enumerable: true, get: function () { return IpcProtocol_1.IpcFailure; } });
+Object.defineProperty(exports, "IpcProtocol", { enumerable: true, get: function () { return IpcProtocol_1.IpcProtocol; } });
+var IpcConnection_1 = require("./IpcConnection");
+Object.defineProperty(exports, "IpcConnection", { enumerable: true, get: function () { return IpcConnection_1.IpcConnection; } });
+Object.defineProperty(exports, "IpcConnectionOptions", { enumerable: true, get: function () { return IpcConnection_1.IpcConnectionOptions; } });
+Object.defineProperty(exports, "IpcTransportError", { enumerable: true, get: function () { return IpcConnection_1.IpcTransportError; } });
+Object.defineProperty(exports, "IpcErrors", { enumerable: true, get: function () { return IpcConnection_1.IpcErrors; } });
+var IpcLogging_1 = require("./IpcLogging");
+Object.defineProperty(exports, "IpcCallLogger", { enumerable: true, get: function () { return IpcLogging_1.IpcCallLogger; } });
+var LogFieldMask_1 = require("../http/LogFieldMask");
+Object.defineProperty(exports, "MaskSpec", { enumerable: true, get: function () { return LogFieldMask_1.MaskSpec; } });
+var ApiMethodInfo_1 = require("../http/ApiMethodInfo");
+Object.defineProperty(exports, "ApiMethodInfo", { enumerable: true, get: function () { return ApiMethodInfo_1.ApiMethodInfo; } });
+var LogApiCall_1 = require("../http/LogApiCall");
+Object.defineProperty(exports, "LogApiCallImpl", { enumerable: true, get: function () { return LogApiCall_1.LogApiCallImpl; } });
+var TimeoutError_1 = require("../http/TimeoutError");
+Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return TimeoutError_1.TimeoutError; } });
+var errorUtils_1 = require("../lib/errorUtils");
+Object.defineProperty(exports, "toError", { enumerable: true, get: function () { return errorUtils_1.toError; } });
+//# sourceMappingURL=index.js.map

package/src/ipc/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/core/core-util/src/ipc/index.ts"],"names":[],"mappings":";;;AAAA,6CAAsE;AAA7D,0GAAA,WAAW,OAAA;AAAE,wGAAA,SAAS,OAAA;AAAE,4GAAA,aAAa,OAAA;AAE9C,6CAAgG;AAAvF,6GAAA,cAAc,OAAA;AAAE,yGAAA,UAAU,OAAA;AAAE,yGAAA,UAAU,OAAA;AAAE,yGAAA,UAAU,OAAA;AAAE,0GAAA,WAAW,OAAA;AAExE,iDAAoG;AAA3F,8GAAA,aAAa,OAAA;AAAE,qHAAA,oBAAoB,OAAA;AAAE,kHAAA,iBAAiB,OAAA;AAAE,0GAAA,SAAS,OAAA;AAE1E,2CAA6C;AAApC,2GAAA,aAAa,OAAA;AAEtB,qDAAgD;AAAvC,wGAAA,QAAQ,OAAA;AACjB,uDAAsD;AAA7C,8GAAA,aAAa,OAAA;AACtB,iDAAoD;AAA3C,4GAAA,cAAc,OAAA;AAEvB,qDAAoD;AAA3C,4GAAA,YAAY,OAAA;AAErB,gDAA4C;AAAnC,qGAAA,OAAO,OAAA","sourcesContent":["export { IpcContract, IpcMethod, IpcVoidSchema } from './IpcContract';\nexport type { IpcSchema, IpcMethods, IpcApiType } from './IpcContract';\nexport { IpcCallContext, IpcRequest, IpcSuccess, IpcFailure, IpcProtocol } from './IpcProtocol';\nexport type { IpcReply, IpcMessage } from './IpcProtocol';\nexport { IpcConnection, IpcConnectionOptions, IpcTransportError, IpcErrors } from './IpcConnection';\nexport type { IpcTransport, IpcScheduler, IpcErrorOwner } from './IpcConnection';\nexport { IpcCallLogger } from './IpcLogging';\nexport type { IpcLogging } from './IpcLogging';\nexport { MaskSpec } from '../http/LogFieldMask';\nexport { ApiMethodInfo } from '../http/ApiMethodInfo';\nexport { LogApiCallImpl } from '../http/LogApiCall';\nexport type { ApiCallContext } from '../http/ApiCallContext';\nexport { TimeoutError } from '../http/TimeoutError';\n\nexport { toError } from '../lib/errorUtils';\n"]}