@tstdl/base 0.78.0-beta7 → 0.78.0-beta70

package/openid-connect/oidc.service.js

@@ -8,16 +8,20 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OidcService = void 0;
 const container_1 = require("../container");
-const error_1 = require("../error");
+const forbidden_error_1 = require("../error/forbidden.error");
+const not_implemented_error_1 = require("../error/not-implemented.error");
 const client_1 = require("../http/client");
+const http_headers_1 = require("../http/http-headers");
 const schema_1 = require("../schema");
 const alphabet_1 = require("../utils/alphabet");
 const cryptography_1 = require("../utils/cryptography");
 const date_time_1 = require("../utils/date-time");
-const jwt_1 = require("../utils/jwt");
 const random_1 = require("../utils/random");
 const type_guards_1 = require("../utils/type-guards");
 const oidc_configuration_service_1 = require("./oidc-configuration.service");
@@ -25,15 +29,19 @@ const oidc_state_repository_1 = require("./oidc-state.repository");
 const tokenResponseSchema = (0, schema_1.object)({
     /* eslint-disable @typescript-eslint/naming-convention */
     access_token: (0, schema_1.string)(),
-    id_token: (0, schema_1.string)(),
+    id_token: (0, schema_1.optional)((0, schema_1.string)()),
     token_type: (0, schema_1.string)(),
     refresh_token: (0, schema_1.optional)((0, schema_1.string)())
     /* eslint-enable @typescript-eslint/naming-convention */
 });
 let OidcService = class OidcService {
-    constructor(oidcConfigurationService, oidcStateRepository) {
+    constructor(oidcConfigurationService, oidcStateRepository, httpClient) {
         this.oidcConfigurationService = oidcConfigurationService;
-        this.oidcStateRepository = oidcStateRepository;
+        this.maybeOidcStateRepository = oidcStateRepository;
+        this.httpClient = httpClient;
+    }
+    get oidcStateRepository() {
+        return (0, type_guards_1.assertDefinedPass)(this.maybeOidcStateRepository, 'OidcStateRepository is not provided but required.');
     }
     async initAuthorization({ endpoint, clientId, clientSecret, scope, expiration, data }) {
         const oidcConfiguration = await this.oidcConfigurationService.getConfiguration(endpoint);
@@ -67,24 +75,59 @@ let OidcService = class OidcService {
     async validateState(state) {
         const oidcState = await this.oidcStateRepository.tryLoadByFilterAndDelete({ value: state });
         if ((0, type_guards_1.isUndefined)(oidcState)) {
-            throw new error_1.ForbiddenError('invalid state code');
+            throw new forbidden_error_1.ForbiddenError('invalid state code');
         }
         return oidcState;
     }
-    async getToken({ endpoint, clientId, clientSecret, code, redirectUri, codeVerifier, scope }) {
-        const oidcConfiguration = await this.oidcConfigurationService.getConfiguration(endpoint);
-        const formData = {
-            /* eslint-disable @typescript-eslint/naming-convention */
-            client_id: clientId,
-            client_secret: clientSecret,
-            grant_type: 'authorization_code',
-            scope,
-            code,
-            code_verifier: codeVerifier,
-            redirect_uri: redirectUri
-            /* eslint-enable @typescript-eslint/naming-convention */
-        };
-        const tokenResponse = await client_1.HttpClient.instance.postJson(oidcConfiguration.tokenEndpoint, { headers: { authorization: `Bearer ${code}` }, body: { form: formData } });
+    async getToken(parameters) {
+        const oidcConfiguration = await this.oidcConfigurationService.getConfiguration(parameters.endpoint);
+        const headers = new http_headers_1.HttpHeaders();
+        let formData = {};
+        let authorization;
+        switch (parameters.grantType) {
+            case 'authorization_code':
+                headers.set('authorization', `Bearer ${parameters.code}`);
+                formData = {
+                    /* eslint-disable @typescript-eslint/naming-convention */
+                    grant_type: 'authorization_code',
+                    client_id: parameters.clientId,
+                    client_secret: parameters.clientSecret,
+                    scope: parameters.scope,
+                    code: parameters.code,
+                    code_verifier: parameters.codeVerifier,
+                    redirect_uri: parameters.redirectUri
+                    /* eslint-enable @typescript-eslint/naming-convention */
+                };
+                break;
+            case 'client_credentials':
+                formData = {
+                    /* eslint-disable @typescript-eslint/naming-convention */
+                    grant_type: 'client_credentials',
+                    scope: parameters.scope
+                    /* eslint-enable @typescript-eslint/naming-convention */
+                };
+                break;
+            default:
+                throw new not_implemented_error_1.NotImplementedError(`Grant type "${parameters.grantType}" not supported.`);
+        }
+        switch (parameters.authType) {
+            case 'body':
+            case undefined:
+                formData['client_id'] = parameters.clientId;
+                formData['client_secret'] = parameters.clientSecret;
+                break;
+            case 'basic-auth':
+                authorization = {
+                    basic: {
+                        username: parameters.clientId,
+                        password: parameters.clientSecret
+                    }
+                };
+                break;
+            default:
+                throw new not_implemented_error_1.NotImplementedError(`Auth type "${parameters.authType}" not supported.`);
+        }
+        const tokenResponse = await this.httpClient.postJson(oidcConfiguration.tokenEndpoint, { headers, authorization, body: { form: formData } });
         return parseTokenResponse(tokenResponse);
     }
     async refreshToken({ endpoint, clientId, clientSecret, refreshToken }) {
@@ -97,27 +140,31 @@ let OidcService = class OidcService {
             refresh_token: refreshToken
             /* eslint-enable @typescript-eslint/naming-convention */
         };
-        const tokenResponse = await client_1.HttpClient.instance.postJson(oidcConfiguration.tokenEndpoint, { headers: { authorization: `Bearer ${refreshToken}` }, body: { form: formData } });
+        const tokenResponse = await this.httpClient.postJson(oidcConfiguration.tokenEndpoint, { headers: { authorization: `Bearer ${refreshToken}` }, body: { form: formData } });
         return parseTokenResponse(tokenResponse);
     }
     async getUserInfo(endpoint, token) {
         const oidcConfiguration = await this.oidcConfigurationService.getConfiguration(endpoint);
-        const userInfoResponse = await client_1.HttpClient.instance.getJson(oidcConfiguration.userinfoEndpoint, { headers: { authorization: `${token.tokenType} ${token.accessToken}` } });
+        if ((0, type_guards_1.isUndefined)(oidcConfiguration.userInfoEndpoint)) {
+            throw new Error('User info endpoint not supported.');
+        }
+        const userInfoResponse = await this.httpClient.getJson(oidcConfiguration.userInfoEndpoint, { headers: { authorization: `${token.tokenType} ${token.accessToken}` } });
         return userInfoResponse;
     }
 };
 OidcService = __decorate([
     (0, container_1.singleton)(),
-    __metadata("design:paramtypes", [oidc_configuration_service_1.OidcConfigurationService, oidc_state_repository_1.OidcStateRepository])
+    __param(1, (0, container_1.inject)(oidc_state_repository_1.OidcStateRepository)),
+    __param(1, (0, container_1.optional)()),
+    __metadata("design:paramtypes", [oidc_configuration_service_1.OidcConfigurationService, Object, client_1.HttpClient])
 ], OidcService);
 exports.OidcService = OidcService;
 function parseTokenResponse(response) {
     const { access_token, id_token, token_type, refresh_token } = schema_1.Schema.parse(tokenResponseSchema, response, { mask: true }); // eslint-disable-line @typescript-eslint/naming-convention
-    const decodedToken = (0, jwt_1.parseJwtTokenString)(id_token);
     const token = {
         tokenType: token_type,
-        expiration: (0, type_guards_1.assertNumberPass)(decodedToken.token.payload.exp) * 1000,
         accessToken: access_token,
+        idToken: id_token,
         refreshToken: refresh_token,
         raw: response
     };

package/openid-connect/oidc.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"oidc.service.js","sourceRoot":"","sources":["../../source/openid-connect/oidc.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAwC;AACxC,oCAAyC;AACzC,2CAA2C;AAC3C,sCAA4D;AAE5D,gDAA4C;AAC5C,wDAA8C;AAC9C,kDAAqD;AAErD,sCAAkD;AAClD,4CAAiD;AACjD,sDAAoE;AACpE,6EAAwE;AAExE,mEAA8D;AAS9D,MAAM,mBAAmB,GAAG,IAAA,eAAM,EAAC;IACjC,yDAAyD;IACzD,YAAY,EAAE,IAAA,eAAM,GAAE;IACtB,QAAQ,EAAE,IAAA,eAAM,GAAE;IAClB,UAAU,EAAE,IAAA,eAAM,GAAE;IACpB,aAAa,EAAE,IAAA,iBAAQ,EAAC,IAAA,eAAM,GAAE,CAAC;IACjC,wDAAwD;CACzD,CAAC,CAAC;AAGH,IAAa,WAAW,GAAxB,MAAa,WAAW;IAItB,YAAY,wBAAkD,EAAE,mBAAwC;QACtG,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAA4B;QAC7G,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,MAAM,KAAK,GAAiB;YAC1B,KAAK,EAAE,IAAA,wBAAe,EAAC,EAAE,EAAE,mBAAQ,CAAC,qBAAqB,CAAC;YAC1D,YAAY,EAAE,IAAA,wBAAe,EAAC,EAAE,EAAE,mBAAQ,CAAC,qBAAqB,CAAC;YACjE,QAAQ;YACR,QAAQ;YACR,YAAY;YACZ,UAAU,EAAE,IAAA,4BAAgB,GAAE,GAAG,UAAU;YAC3C,IAAI;SACL,CAAC;QAEF,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE7C,MAAM,aAAa,GAAG,MAAM,IAAA,qBAAM,EAAC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QAEhF,MAAM,MAAM,GAAmB;YAC7B,qBAAqB,EAAE,iBAAiB,CAAC,qBAAqB;YAC9D,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ;YACR,KAAK;YACL,aAAa;YACb,mBAAmB,EAAE,MAAM;SAC5B,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAa;QAC7B,MAAM,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAa;QAC/B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,wBAAwB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5F,IAAI,IAAA,yBAAW,EAAC,SAAS,CAAC,EAAE;YAC1B,MAAM,IAAI,sBAAc,CAAC,oBAAoB,CAAC,CAAC;SAChD;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,KAAK,EAA0B;QACjH,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG;YACf,yDAAyD;YACzD,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;YAC3B,UAAU,EAAE,oBAAoB;YAChC,KAAK;YACL,IAAI;YACJ,aAAa,EAAE,YAAY;YAC3B,YAAY,EAAE,WAAW;YACzB,wDAAwD;SACzD,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,mBAAU,CAAC,QAAQ,CAAC,QAAQ,CAAO,iBAAiB,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5K,OAAO,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAA8B;QAC/F,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG;YACf,yDAAyD;YACzD,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;YAC3B,UAAU,EAAE,eAAe;YAC3B,aAAa,EAAE,YAAY;YAC3B,wDAAwD;SACzD,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,mBAAU,CAAC,QAAQ,CAAC,QAAQ,CAAO,iBAAiB,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACpL,OAAO,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAAgB,EAAE,KAAgB;QAClD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACzF,MAAM,gBAAgB,GAAG,MAAM,mBAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QAE1K,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF,CAAA;AAjGY,WAAW;IADvB,IAAA,qBAAS,GAAE;qCAK4B,qDAAwB,EAAuB,2CAAmB;GAJ7F,WAAW,CAiGvB;AAjGY,kCAAW;AAmGxB,SAAS,kBAAkB,CAAC,QAAc;IACxC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,eAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,2DAA2D;IAEtL,MAAM,YAAY,GAAG,IAAA,yBAAmB,EAAe,QAAQ,CAAC,CAAC;IAEjE,MAAM,KAAK,GAAc;QACvB,SAAS,EAAE,UAAU;QACrB,UAAU,EAAE,IAAA,8BAAgB,EAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI;QACnE,WAAW,EAAE,YAAY;QACzB,YAAY,EAAE,aAAa;QAC3B,GAAG,EAAE,QAAQ;KACd,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}
+{"version":3,"file":"oidc.service.js","sourceRoot":"","sources":["../../source/openid-connect/oidc.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4CAA4E;AAC5E,8DAAyD;AACzD,0EAAoE;AAEpE,2CAA2C;AAC3C,uDAAkD;AAClD,sCAA4D;AAE5D,gDAA4C;AAC5C,wDAA8C;AAC9C,kDAAqD;AACrD,4CAAiD;AACjD,sDAAqE;AACrE,6EAAwE;AAExE,mEAA8D;AAG9D,MAAM,mBAAmB,GAAG,IAAA,eAAM,EAAC;IACjC,yDAAyD;IACzD,YAAY,EAAE,IAAA,eAAM,GAAE;IACtB,QAAQ,EAAE,IAAA,iBAAQ,EAAC,IAAA,eAAM,GAAE,CAAC;IAC5B,UAAU,EAAE,IAAA,eAAM,GAAE;IACpB,aAAa,EAAE,IAAA,iBAAQ,EAAC,IAAA,eAAM,GAAE,CAAC;IACjC,wDAAwD;CACzD,CAAC,CAAC;AAGI,IAAM,WAAW,GAAjB,MAAM,WAAW;IAStB,YAAY,wBAAkD,EAAiD,mBAAoD,EAAE,UAAsB;QACzL,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,wBAAwB,GAAG,mBAAmB,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IARD,IAAY,mBAAmB;QAC7B,OAAO,IAAA,+BAAiB,EAAC,IAAI,CAAC,wBAAwB,EAAE,mDAAmD,CAAC,CAAC;IAC/G,CAAC;IAQD,KAAK,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAA4B;QAC7G,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,MAAM,KAAK,GAAiB;YAC1B,KAAK,EAAE,IAAA,wBAAe,EAAC,EAAE,EAAE,mBAAQ,CAAC,qBAAqB,CAAC;YAC1D,YAAY,EAAE,IAAA,wBAAe,EAAC,EAAE,EAAE,mBAAQ,CAAC,qBAAqB,CAAC;YACjE,QAAQ;YACR,QAAQ;YACR,YAAY;YACZ,UAAU,EAAE,IAAA,4BAAgB,GAAE,GAAG,UAAU;YAC3C,IAAI;SACL,CAAC;QAEF,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE7C,MAAM,aAAa,GAAG,MAAM,IAAA,qBAAM,EAAC,SAAS,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QAEhF,MAAM,MAAM,GAAmB;YAC7B,qBAAqB,EAAE,iBAAiB,CAAC,qBAAqB;YAC9D,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ;YACR,KAAK;YACL,aAAa;YACb,mBAAmB,EAAE,MAAM;SAC5B,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAa;QAC1B,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAa;QAC7B,MAAM,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,KAAa;QAC/B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,wBAAwB,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5F,IAAI,IAAA,yBAAW,EAAC,SAAS,CAAC,EAAE;YAC1B,MAAM,IAAI,gCAAc,CAAC,oBAAoB,CAAC,CAAC;SAChD;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,UAAkC;QAC/C,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEpG,MAAM,OAAO,GAAG,IAAI,0BAAW,EAAE,CAAC;QAClC,IAAI,QAAQ,GAAW,EAAE,CAAC;QAC1B,IAAI,aAAmD,CAAC;QAExD,QAAQ,UAAU,CAAC,SAAS,EAAE;YAC5B,KAAK,oBAAoB;gBACvB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;gBAE1D,QAAQ,GAAG;oBACT,yDAAyD;oBACzD,UAAU,EAAE,oBAAoB;oBAChC,SAAS,EAAE,UAAU,CAAC,QAAQ;oBAC9B,aAAa,EAAE,UAAU,CAAC,YAAY;oBACtC,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,aAAa,EAAE,UAAU,CAAC,YAAY;oBACtC,YAAY,EAAE,UAAU,CAAC,WAAW;oBACpC,wDAAwD;iBACzD,CAAC;gBAEF,MAAM;YAER,KAAK,oBAAoB;gBACvB,QAAQ,GAAG;oBACT,yDAAyD;oBACzD,UAAU,EAAE,oBAAoB;oBAEhC,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,wDAAwD;iBACzD,CAAC;gBAEF,MAAM;YAER;gBACE,MAAM,IAAI,2CAAmB,CAAC,eAAgB,UAAqC,CAAC,SAAS,kBAAkB,CAAC,CAAC;SACpH;QAED,QAAQ,UAAU,CAAC,QAAQ,EAAE;YAC3B,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS;gBACZ,QAAQ,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC;gBAC5C,QAAQ,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC;gBACpD,MAAM;YAER,KAAK,YAAY;gBACf,aAAa,GAAG;oBACd,KAAK,EAAE;wBACL,QAAQ,EAAE,UAAU,CAAC,QAAQ;wBAC7B,QAAQ,EAAE,UAAU,CAAC,YAAY;qBAClC;iBACF,CAAC;gBACF,MAAM;YAER;gBACE,MAAM,IAAI,2CAAmB,CAAC,cAAe,UAAqC,CAAC,QAAQ,kBAAkB,CAAC,CAAC;SAClH;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAO,iBAAiB,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClJ,OAAO,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAA8B;QAC/F,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,MAAM,QAAQ,GAAG;YACf,yDAAyD;YACzD,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;YAC3B,UAAU,EAAE,eAAe;YAC3B,aAAa,EAAE,YAAY;YAC3B,wDAAwD;SACzD,CAAC;QAEF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAO,iBAAiB,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAChL,OAAO,kBAAkB,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAAgB,EAAE,KAAgB;QAClD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAEzF,IAAI,IAAA,yBAAW,EAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;SACtD;QAED,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtK,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF,CAAA;AAxJY,WAAW;IADvB,IAAA,qBAAS,GAAE;IAUuD,WAAA,IAAA,kBAAM,EAAC,2CAAmB,CAAC,CAAA;IAAE,WAAA,IAAA,oBAAc,GAAE,CAAA;qCAAxE,qDAAwB,UAAmH,mBAAU;GAThL,WAAW,CAwJvB;AAxJY,kCAAW;AA0JxB,SAAS,kBAAkB,CAAC,QAAc;IACxC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,eAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,2DAA2D;IAEtL,MAAM,KAAK,GAAc;QACvB,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,YAAY;QACzB,OAAO,EAAE,QAAQ;QACjB,YAAY,EAAE,aAAa;QAC3B,GAAG,EAAE,QAAQ;KACd,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.78.0-beta7",
+  "version": "0.78.0-beta70",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"
@@ -18,11 +18,11 @@
     "luxon": "^3.0",
     "reflect-metadata": "^0.1",
     "rxjs": "^7.5",
-    "type-fest": "^2.18"
+    "type-fest": "^2.19"
   },
   "devDependencies": {
     "@types/chroma-js": "2.1",
-    "@types/koa__router": "8.0",
+    "@types/koa__router": "12.0",
     "@types/luxon": "3.0",
     "@types/minio": "7.0",
     "@types/mjml": "4.7",
@@ -33,24 +33,25 @@
     "eslint": "8",
     "ttypescript": "1.5",
     "typedoc": "0.23",
-    "typescript": "4.7",
+    "typescript": "4.8",
     "typescript-transform-paths": "3.3"
   },
   "peerDependencies": {
-    "@elastic/elasticsearch": "^8.2",
+    "@elastic/elasticsearch": "^8.4",
     "@koa/router": "^12.0",
-    "@tstdl/angular": "^0.11.0-beta7",
+    "@tstdl/angular": "^0.11.0-beta70",
     "chroma-js": "^2.4",
-    "got": "^12.3",
+    "got": "^12.5",
     "handlebars": "^4.7",
+    "knex": "^2.3",
     "koa": "^2.13",
     "minio": "^7.0",
     "mjml": "^4.13",
-    "mongodb": "4.9",
+    "mongodb": "4.10",
     "nodemailer": "^6.7",
-    "puppeteer": "^16.2",
-    "undici": "^5.9",
-    "urlpattern-polyfill": "^4.0"
+    "puppeteer": "^18.0",
+    "undici": "^5.10",
+    "urlpattern-polyfill": "^5.0"
   },
   "peerDependenciesMeta": {
     "@tstdl/angular": {

package/pdf/pdf.service.d.ts

@@ -2,32 +2,111 @@ import type { AfterResolve } from "../container";
 import { afterResolve } from "../container";
 import type { AsyncDisposable } from "../disposable/disposable";
 import { disposeAsync } from "../disposable/disposable";
-import { TemplateService } from "../templates";
-export declare type PdfRenderOptions = {
+import { Logger } from "../logger";
+import type { TemplateField } from "../templates";
+import { Template, TemplateService } from "../templates";
+export declare enum PdfFormat {
+    Letter = "letter",
+    Legal = "legal",
+    Tabloid = "tabloid",
+    Ledger = "ledger",
+    A0 = "a0",
+    A1 = "a1",
+    A2 = "a2",
+    A3 = "a3",
+    A4 = "a4",
+    A5 = "a5",
+    A6 = "a6"
+}
+export declare class PdfMarginObject {
+    top?: number | string;
+    bottom?: number | string;
+    right?: number | string;
+    left?: number | string;
+}
+export declare class PdfRenderOptions {
     omitDefaultBackground?: boolean;
     renderBackground?: boolean;
     landscape?: boolean;
-    format?: 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+    format?: PdfFormat;
     width?: string | number;
     height?: string | number;
     scale?: number;
-    margin?: string | number | {
-        top?: number | string;
-        bottom?: number | string;
-        right?: number | string;
-        left?: number | string;
-    };
+    margin?: string | number | PdfMarginObject;
+    displayHeaderFooter?: boolean;
     waitForNetworkIdle?: boolean;
-};
+    headerTemplate?: string;
+    footerTemplate?: string;
+    /**
+     * Timeout for closing render context in case something went wrong.
+     * @default 60000 (1 minute)
+     */
+    timeout?: number;
+}
+export declare type PdfTemplateOptions = PdfRenderOptions;
+export declare class PdfTemplate extends Template<{
+    header: false;
+    body: true;
+    footer: false;
+}, PdfRenderOptions> {
+    options?: PdfTemplateOptions;
+}
 export declare class PdfService implements AsyncDisposable, AfterResolve {
     private readonly templateService;
+    private readonly logger;
     private readonly pool;
-    constructor(templateService: TemplateService);
+    constructor(templateService: TemplateService, logger: Logger);
     [afterResolve](): void;
     [disposeAsync](): Promise<void>;
     dispose(): Promise<void>;
+    /**
+     * Renders HTML to pdf stream
+     * @param html html to render
+     * @param options render options
+     * @returns pdf stream
+     */
+    renderHtmlStream(html: string, options?: PdfRenderOptions): ReadableStream<Uint8Array>;
+    /**
+     * Renders HTML to pdf
+     * @param html html to render
+     * @param options render options
+     * @returns pdf bytes
+     */
     renderHtml(html: string, options?: PdfRenderOptions): Promise<Uint8Array>;
+    /**
+     * Renders an url to pdf stream
+     * @param url url to load and render
+     * @param options render options
+     * @returns pdf stream
+     */
+    renderUrlStream(url: string, options?: PdfRenderOptions): ReadableStream<Uint8Array>;
+    /**
+     * Renders an url to pdf
+     * @param url url to load and render
+     * @param options render options
+     * @returns pdf bytes
+     */
     renderUrl(url: string, options?: PdfRenderOptions): Promise<Uint8Array>;
+    /**
+     * Renders a template to pdf
+     * @param key template key
+     * @param templateContext context for template rendering
+     * @param options additional options, overwrites options specified in template
+     * @returns pdf bytes
+     */
+    renderTemplateStream(key: string, templateContext?: object, options?: PdfRenderOptions): ReadableStream<Uint8Array>;
+    /**
+     * Renders a template to pdf
+     * @param key template key
+     * @param templateContext context for template rendering
+     * @param options additional options, overwrites options specified in template
+     * @returns pdf bytes
+     */
     renderTemplate(key: string, templateContext?: object, options?: PdfRenderOptions): Promise<Uint8Array>;
-    private render;
+    private renderStream;
 }
+export declare function pdfTemplate(fields: {
+    body: TemplateField;
+    header?: TemplateField;
+    footer?: TemplateField;
+}, options?: PdfTemplateOptions): PdfTemplate;

package/pdf/pdf.service.js

@@ -8,18 +8,125 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PdfService = void 0;
+exports.pdfTemplate = exports.PdfService = exports.PdfTemplate = exports.PdfRenderOptions = exports.PdfMarginObject = exports.PdfFormat = void 0;
 const container_1 = require("../container");
 const core_1 = require("../core");
 const disposable_1 = require("../disposable/disposable");
+const logger_1 = require("../logger");
 const pool_1 = require("../pool");
+const schema_1 = require("../schema");
 const templates_1 = require("../templates");
+const finalize_stream_1 = require("../utils/stream/finalize-stream");
+const readable_stream_adapter_1 = require("../utils/stream/readable-stream-adapter");
+const readable_stream_from_promise_1 = require("../utils/stream/readable-stream-from-promise");
+const stream_reader_1 = require("../utils/stream/stream-reader");
 const type_guards_1 = require("../utils/type-guards");
+const units_1 = require("../utils/units");
 const puppeteer = require("puppeteer");
+var PdfFormat;
+(function (PdfFormat) {
+    PdfFormat["Letter"] = "letter";
+    PdfFormat["Legal"] = "legal";
+    PdfFormat["Tabloid"] = "tabloid";
+    PdfFormat["Ledger"] = "ledger";
+    PdfFormat["A0"] = "a0";
+    PdfFormat["A1"] = "a1";
+    PdfFormat["A2"] = "a2";
+    PdfFormat["A3"] = "a3";
+    PdfFormat["A4"] = "a4";
+    PdfFormat["A5"] = "a5";
+    PdfFormat["A6"] = "a6";
+})(PdfFormat = exports.PdfFormat || (exports.PdfFormat = {}));
+class PdfMarginObject {
+}
+__decorate([
+    (0, schema_1.Optional)([Number, String]),
+    __metadata("design:type", Object)
+], PdfMarginObject.prototype, "top", void 0);
+__decorate([
+    (0, schema_1.Optional)([Number, String]),
+    __metadata("design:type", Object)
+], PdfMarginObject.prototype, "bottom", void 0);
+__decorate([
+    (0, schema_1.Optional)([Number, String]),
+    __metadata("design:type", Object)
+], PdfMarginObject.prototype, "right", void 0);
+__decorate([
+    (0, schema_1.Optional)([Number, String]),
+    __metadata("design:type", Object)
+], PdfMarginObject.prototype, "left", void 0);
+exports.PdfMarginObject = PdfMarginObject;
+class PdfRenderOptions {
+}
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Boolean)
+], PdfRenderOptions.prototype, "omitDefaultBackground", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Boolean)
+], PdfRenderOptions.prototype, "renderBackground", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Boolean)
+], PdfRenderOptions.prototype, "landscape", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    (0, schema_1.Enumeration)(PdfFormat),
+    __metadata("design:type", String)
+], PdfRenderOptions.prototype, "format", void 0);
+__decorate([
+    (0, schema_1.Optional)([String, Number]),
+    __metadata("design:type", Object)
+], PdfRenderOptions.prototype, "width", void 0);
+__decorate([
+    (0, schema_1.Optional)([String, Number]),
+    __metadata("design:type", Object)
+], PdfRenderOptions.prototype, "height", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Number)
+], PdfRenderOptions.prototype, "scale", void 0);
+__decorate([
+    (0, schema_1.Optional)([String, Number, PdfMarginObject]),
+    __metadata("design:type", Object)
+], PdfRenderOptions.prototype, "margin", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Boolean)
+], PdfRenderOptions.prototype, "displayHeaderFooter", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Boolean)
+], PdfRenderOptions.prototype, "waitForNetworkIdle", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", String)
+], PdfRenderOptions.prototype, "headerTemplate", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", String)
+], PdfRenderOptions.prototype, "footerTemplate", void 0);
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Number)
+], PdfRenderOptions.prototype, "timeout", void 0);
+exports.PdfRenderOptions = PdfRenderOptions;
+class PdfTemplate extends templates_1.Template {
+}
+__decorate([
+    (0, schema_1.Optional)(),
+    __metadata("design:type", Object)
+], PdfTemplate.prototype, "options", void 0);
+exports.PdfTemplate = PdfTemplate;
 let PdfService = class PdfService {
-    constructor(templateService) {
+    constructor(templateService, logger) {
         this.templateService = templateService;
+        this.logger = logger;
         this.pool = new pool_1.Pool(async () => puppeteer.launch(), async (browser) => browser.close());
     }
     [container_1.afterResolve]() {
@@ -31,52 +138,125 @@ let PdfService = class PdfService {
     async dispose() {
         return this.pool.dispose();
     }
+    /**
+     * Renders HTML to pdf stream
+     * @param html html to render
+     * @param options render options
+     * @returns pdf stream
+     */
+    renderHtmlStream(html, options) {
+        return this.renderStream(async (page) => page.setContent(html, { waitUntil: (options?.waitForNetworkIdle == true) ? 'networkidle2' : 'load' }), options);
+    }
+    /**
+     * Renders HTML to pdf
+     * @param html html to render
+     * @param options render options
+     * @returns pdf bytes
+     */
     async renderHtml(html, options) {
-        return this.render(async (page) => page.setContent(html, { waitUntil: (options?.waitForNetworkIdle == true) ? 'networkidle2' : 'load' }), options);
+        const stream = this.renderHtmlStream(html, options);
+        return (0, stream_reader_1.readBinaryStream)(stream);
+    }
+    /**
+     * Renders an url to pdf stream
+     * @param url url to load and render
+     * @param options render options
+     * @returns pdf stream
+     */
+    renderUrlStream(url, options) {
+        return this.renderStream(async (page) => {
+            await page.goto(url, { waitUntil: (options?.waitForNetworkIdle == true) ? 'networkidle2' : 'load' });
+        }, options);
     }
+    /**
+     * Renders an url to pdf
+     * @param url url to load and render
+     * @param options render options
+     * @returns pdf bytes
+     */
     async renderUrl(url, options) {
-        return this.render(async (page) => page.goto(url, { waitUntil: (options?.waitForNetworkIdle == true) ? 'networkidle2' : 'load' }), options);
+        const stream = this.renderUrlStream(url, options);
+        return (0, stream_reader_1.readBinaryStream)(stream);
     }
+    /**
+     * Renders a template to pdf
+     * @param key template key
+     * @param templateContext context for template rendering
+     * @param options additional options, overwrites options specified in template
+     * @returns pdf bytes
+     */
+    renderTemplateStream(key, templateContext, options) {
+        return this.renderStream(async (page) => {
+            const { fields: { header, body, footer }, options: optionsFromTemplate } = await this.templateService.render(key, templateContext);
+            await page.setContent(body, { ...optionsFromTemplate, headerTemplate: header, footerTemplate: footer, waitUntil: (options?.waitForNetworkIdle == true) ? 'networkidle2' : 'load', ...options });
+            return { ...optionsFromTemplate, headerTemplate: header, footerTemplate: footer, ...options };
+        }, options);
+    }
+    /**
+     * Renders a template to pdf
+     * @param key template key
+     * @param templateContext context for template rendering
+     * @param options additional options, overwrites options specified in template
+     * @returns pdf bytes
+     */
     async renderTemplate(key, templateContext, options) {
-        const html = await this.templateService.render(key, templateContext);
-        return this.renderHtml(html, options);
+        const stream = this.renderTemplateStream(key, templateContext, options);
+        return (0, stream_reader_1.readBinaryStream)(stream);
     }
-    async render(handler, options) {
-        return this.pool.use(async (browser) => {
+    renderStream(handler, options = {}) {
+        return (0, readable_stream_from_promise_1.readableStreamFromPromise)(async () => this.pool.use(async (browser) => {
             const page = await browser.newPage();
+            const timeoutRef = setTimeout(() => void page.close().catch((error) => this.logger.error(error)), (options.timeout ?? units_1.millisecondsPerMinute));
             try {
-                await handler(page);
-                const margin = (0, type_guards_1.isUndefined)(options?.margin)
+                const optionsFromHandler = await handler(page) ?? {};
+                const mergedOptions = { ...optionsFromHandler, ...options };
+                const margin = (0, type_guards_1.isUndefined)(mergedOptions.margin)
                     ? undefined
-                    : (0, type_guards_1.isObject)(options.margin)
-                        ? options.margin
+                    : (0, type_guards_1.isObject)(mergedOptions.margin)
+                        ? mergedOptions.margin
                         : {
-                            top: options.margin,
-                            bottom: options.margin,
-                            right: options.margin,
-                            left: options.margin
+                            top: mergedOptions.margin,
+                            bottom: mergedOptions.margin,
+                            right: mergedOptions.margin,
+                            left: mergedOptions.margin
                         };
-                const result = await page.pdf({
-                    format: options?.format ?? 'a4',
-                    scale: options?.scale,
-                    landscape: options?.landscape,
-                    width: options?.width,
-                    height: options?.height,
-                    omitBackground: options?.omitDefaultBackground,
-                    printBackground: options?.renderBackground,
-                    margin
+                const pdfStream = await page.createPDFStream({
+                    format: mergedOptions.format ?? 'a4',
+                    scale: mergedOptions.scale,
+                    landscape: mergedOptions.landscape,
+                    width: mergedOptions.width,
+                    height: mergedOptions.height,
+                    omitBackground: mergedOptions.omitDefaultBackground,
+                    printBackground: mergedOptions.renderBackground,
+                    margin,
+                    displayHeaderFooter: mergedOptions.displayHeaderFooter ?? ((0, type_guards_1.isDefined)(mergedOptions.headerTemplate) || (0, type_guards_1.isDefined)(mergedOptions.footerTemplate)),
+                    headerTemplate: mergedOptions.headerTemplate,
+                    footerTemplate: mergedOptions.footerTemplate
+                });
+                return (0, finalize_stream_1.finalizeStream)((0, readable_stream_adapter_1.getReadableStreamFromIterable)(pdfStream), async () => {
+                    await page.close();
+                    clearTimeout(timeoutRef);
                 });
-                return result;
             }
-            finally {
+            catch (error) {
                 await page.close();
+                clearTimeout(timeoutRef);
+                throw error;
             }
-        });
+        }));
     }
 };
 PdfService = __decorate([
     (0, container_1.singleton)(),
-    __metadata("design:paramtypes", [templates_1.TemplateService])
+    __param(1, (0, container_1.resolveArg)('PdfService')),
+    __metadata("design:paramtypes", [templates_1.TemplateService, logger_1.Logger])
 ], PdfService);
 exports.PdfService = PdfService;
+function pdfTemplate(fields, options) {
+    return {
+        fields,
+        options
+    };
+}
+exports.pdfTemplate = pdfTemplate;
 //# sourceMappingURL=pdf.service.js.map