Feat: Fix, Upgrade and Enhancements

.dependabot/config.yml

@@ -0,0 +1,21 @@
+version: 1
+update_configs:
+  - package_manager: 'javascript'
+    directory: '/'
+    update_schedule: 'live'
+    default_labels:
+      - 'Type: Dependency'
+    commit_message:
+      prefix: 'chore'
+      include_scope: true
+    target_branch: 'develop'
+
+  - package_manager: 'docker'
+    directory: '/'
+    update_schedule: 'daily'
+    default_labels:
+      - 'Type: Dependency'
+    commit_message:
+      prefix: 'chore'
+      include_scope: true
+    target_branch: 'develop'

.gitignore

@@ -18,7 +18,6 @@ coverage
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
 node_modules
 
-build
 types/
 
 .yarnclean
@@ -33,4 +32,4 @@ types/
 
 *.tgz
 
-package-lock.json
+package-lock.json

.npmignore

@@ -2,6 +2,11 @@ node_modules
 examples
 test
 @types
+types
+src
 docs
 yarn*
-.nyc_output
+.nyc_output
+.idea
+.travis.yml
+.github

.prettierignore

@@ -0,0 +1,5 @@
+build
+.nyc_output
+node_modules
+types
+docs

.prettierrc.json

@@ -0,0 +1 @@
+{}

.travis.yml

@@ -21,9 +21,9 @@ script:
 
 branches:
   only:
-  - master
-  - /^.*-alpha$/
-  - /^.*-rc.*$/
-  - /^feature\/.*$/
+    - master
+    - /^.*-alpha$/
+    - /^.*-rc.*$/
+    - /^feature\/.*$/
 
-after_success: npm run coverage
+after_success: npm run coverage

@types/xml-encryption.d.ts

@@ -10,12 +10,27 @@ declare module "xml-encryption" {
     key: string | Buffer;
   }
   export interface Callback {
-    (err:Error, result): void;
+    (err: Error, result): void;
   }
-  export function encrypt(content: string, options: EncryptOptions, callback: Callback): string;
-  export function encryptKeyInfo(symmetricKey: string, options: EncryptOptions, callback: Callback): string;
-  export function decrypt(xml: string | Document, options: DecryptOptions, callback: Callback): string;
-  export function decryptKeyInfo(doc: string | Document, options: DecryptOptions): string;
-	const _default: { decrypt, encrypt, decryptKeyInfo, encryptKeyInfo };
+  export function encrypt(
+    content: string,
+    options: EncryptOptions,
+    callback: Callback
+  ): string;
+  export function encryptKeyInfo(
+    symmetricKey: string,
+    options: EncryptOptions,
+    callback: Callback
+  ): string;
+  export function decrypt(
+    xml: string | Document,
+    options: DecryptOptions,
+    callback: Callback
+  ): string;
+  export function decryptKeyInfo(
+    doc: string | Document,
+    options: DecryptOptions
+  ): string;
+  const _default: { decrypt; encrypt; decryptKeyInfo; encryptKeyInfo };
   export default _default;
 }

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-present Tony Ngan
+Copyright (c) 2020-present Meabed
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,21 +1,21 @@
-# samlify ·
+# samlify-js ·
 
 [![Build Status](https://travis-ci.org/tngan/samlify.svg?branch=master)](https://travis-ci.org/tngan/samlify)
 [![npm version](https://img.shields.io/npm/v/samlify.svg?style=flat)](https://www.npmjs.com/package/samlify)
 [![Coverage Status](https://img.shields.io/coveralls/tngan/samlify/master.svg)](https://coveralls.io/github/tngan/samlify?branch=master)
 [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/samlify)
 
-Highly configuarable Node.js SAML 2.0 library for Single Sign On
+---
 
-## Welcome PRs
+## Fork with typescript fixes, packages upgrade and faster bug fixes.
 
-Welcome all PRs for maintaining this project, or provide a link to the repositories especially for use cases alongside with different frameworks.
+---
 
-### Sponsor
+Highly configuarable Node.js SAML 2.0 library for Single Sign On
 
-| <img width="50" src="https://user-images.githubusercontent.com/83319/31722733-de95bbde-b3ea-11e7-96bf-4f4e8f915588.png"> | <div style="text-align: left;">If you want to quickly implement SAML SSO, feel free to check out Auth0's NodeJS SDK and free plan at [auth0.com/overview](https://auth0.com/overview?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=samlify&utm_content=auth).</div> |
-| :----------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+## Welcome PRs
 
+Welcome all PRs for maintaining this project, or provide a link to the repositories especially for use cases alongside with different frameworks.
 
 ### Installation
 
@@ -24,8 +24,8 @@ To install the stable version
 Starting from v2.6, multiple schema validators are now supported. You can simply set the validator via the following global method. We have four validator modules right now, and you can write your own. The `setSchemaValidator` is required since v2.6, it will throw error if you don't set at the beginning.
 
 ```js
-import * as samlify from 'samlify';
-import * as validator from '@authenio/samlify-xsd-schema-validator';
+import * as samlify from "samlify-js";
+import * as validator from "@authenio/samlify-xsd-schema-validator";
 // import * as validator from '@authenio/samlify-validate-with-xmllint';
 // import * as validator from '@authenio/samlify-node-xmllint';
 // import * as validator from '@authenio/samlify-libxml-xsd'; // only support for version of nodejs <= 8
@@ -42,10 +42,10 @@ Now you can create your own schema validator and even suppress it but you have t
 
 ```typescript
 samlify.setSchemaValidator({
-  validate: (response: string) => {
-    /* implment your own or always returns a resolved promise to skip */
-    return Promise.resolve('skipped');
-  }
+	validate: (response: string) => {
+		/* implment your own or always returns a resolved promise to skip */
+		return Promise.resolve("skipped");
+	},
 });
 ```
 
@@ -67,7 +67,7 @@ yarn
 ### Get Started
 
 ```javascript
-const saml = require('samlify');
+const saml = require("samlify-js");
 ```
 
 See full documentation [here](https://samlify.js.org/)

build/api.d.ts

@@ -0,0 +1,8 @@
+interface Context extends ValidatorContext {
+}
+interface ValidatorContext {
+    validate?: (xml: string) => Promise<any>;
+}
+export declare function getContext(): Context;
+export declare function setSchemaValidator(params: ValidatorContext): void;
+export {};

build/binding-post.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @file binding-post.ts
+ * @author tngan
+ * @desc Binding-level API, declare the functions using POST binding
+ */
+import { BindingContext } from "./entity";
+/**
+ * @desc Generate a base64 encoded login request
+ * @param  {string} referenceTagXPath           reference uri
+ * @param  {object} entity                      object includes both idp and sp
+ * @param  {function} customTagReplacement     used when developers have their own login response template
+ */
+declare function base64LoginRequest(referenceTagXPath: string, entity: any, customTagReplacement?: (template: string) => BindingContext): BindingContext;
+/**
+ * @desc Generate a base64 encoded login response
+ * @param  {object} requestInfo                 corresponding request, used to obtain the id
+ * @param  {object} entity                      object includes both idp and sp
+ * @param  {object} user                        current logged user (e.g. req.user)
+ * @param  {function} customTagReplacement     used when developers have their own login response template
+ * @param  {boolean}  encryptThenSign           whether or not to encrypt then sign first (if signing). Defaults to sign-then-encrypt
+ */
+declare function base64LoginResponse(requestInfo: any, entity: any, user?: any, customTagReplacement?: (template: string) => BindingContext, encryptThenSign?: boolean): Promise<BindingContext>;
+/**
+ * @desc Generate a base64 encoded logout request
+ * @param  {object} user                         current logged user (e.g. req.user)
+ * @param  {string} referenceTagXPath            reference uri
+ * @param  {object} entity                       object includes both idp and sp
+ * @param  {function} customTagReplacement      used when developers have their own login response template
+ * @return {string} base64 encoded request
+ */
+declare function base64LogoutRequest(user: any, referenceTagXPath: any, entity: any, customTagReplacement?: (template: string) => BindingContext): BindingContext;
+/**
+ * @desc Generate a base64 encoded logout response
+ * @param  {object} requestInfo                 corresponding request, used to obtain the id
+ * @param  {object} entity                      object includes both idp and sp
+ * @param  {function} customTagReplacement     used when developers have their own login response template
+ */
+declare function base64LogoutResponse(requestInfo: any, entity: any, customTagReplacement: (template: string) => BindingContext): BindingContext;
+declare const postBinding: {
+    base64LoginRequest: typeof base64LoginRequest;
+    base64LoginResponse: typeof base64LoginResponse;
+    base64LogoutRequest: typeof base64LogoutRequest;
+    base64LogoutResponse: typeof base64LogoutResponse;
+};
+export default postBinding;