samlify 2.10.0 → 2.10.2

package/types/src/extractor.d.ts

@@ -6,7 +6,7 @@ interface ExtractorField {
     attributePath?: string[];
     context?: boolean;
 }
-export type ExtractorFields = ExtractorField[];
+export declare type ExtractorFields = ExtractorField[];
 export declare const loginRequestFields: ExtractorFields;
 export declare const loginResponseStatusFields: {
     key: string;

package/types/src/libsaml.d.ts

@@ -3,6 +3,7 @@
 * @author tngan
 * @desc  A simple library including some common functions
 */
+/// <reference types="node" />
 import { MetadataInterface } from './metadata';
 export interface SignatureConstructor {
     rawSamlMessage: string;
@@ -57,7 +58,7 @@ export interface LogoutRequestTemplate extends BaseSamlTemplate {
 }
 export interface LogoutResponseTemplate extends BaseSamlTemplate {
 }
-export type KeyUse = 'signing' | 'encryption';
+export declare type KeyUse = 'signing' | 'encryption';
 export interface KeyComponent {
     [key: string]: any;
 }
@@ -85,7 +86,7 @@ export interface LibSamlInterface {
     defaultLogoutResponseTemplate: LogoutResponseTemplate;
 }
 declare const _default: {
-    createXPath: (local: any, isExtractAll?: boolean) => string;
+    createXPath: (local: any, isExtractAll?: boolean | undefined) => string;
     getQueryParamByType: (type: string) => "SAMLRequest" | "SAMLResponse";
     defaultLoginRequestTemplate: {
         context: string;
@@ -149,7 +150,7 @@ declare const _default: {
      *   - The first element is `true` if the signature is valid, `false` otherwise.
      *   - The second element is the cryptographically authenticated assertion node as a string, or `null` if not found.
      */
-    verifySignature(xml: string, opts: SignatureVerifierOptions): (string | boolean)[] | (boolean | null)[];
+    verifySignature(xml: string, opts: SignatureVerifierOptions): [boolean, string | null];
     /**
     * @desc Helper function to create the key section in metadata (abstraction for signing and encrypt use)
     * @param  {string} use          type of certificate (e.g. signing, encrypt)
@@ -165,7 +166,7 @@ declare const _default: {
     * @param  {string} signingAlgorithm          signing algorithm
     * @return {string} message signature
     */
-    constructMessageSignature(octetString: string, key: string, passphrase?: string, isBase64?: boolean, signingAlgorithm?: string): string | Buffer;
+    constructMessageSignature(octetString: string, key: string, passphrase?: string | undefined, isBase64?: boolean | undefined, signingAlgorithm?: string | undefined): string | Buffer;
     /**
     * @desc Verifies message signature
     * @param  {Metadata} metadata                 metadata object of identity provider or service provider
@@ -174,7 +175,7 @@ declare const _default: {
     * @param  {string} verifyAlgorithm            algorithm used to verify
     * @return {boolean} verification result
     */
-    verifyMessageSignature(metadata: any, octetString: string, signature: string | Buffer, verifyAlgorithm?: string): boolean;
+    verifyMessageSignature(metadata: any, octetString: string, signature: string | Buffer, verifyAlgorithm?: string | undefined): boolean;
     /**
     * @desc Get the public key in string format
     * @param  {string} x509Certificate certificate
@@ -191,7 +192,7 @@ declare const _default: {
     * @param  {string} xml                      response in xml string format
     * @return {Promise} a promise to resolve the finalized xml
     */
-    encryptAssertion(sourceEntity: any, targetEntity: any, xml?: string): Promise<string>;
+    encryptAssertion(sourceEntity: any, targetEntity: any, xml?: string | undefined): Promise<string>;
     /**
     * @desc Decrypt the assertion section in Response
     * @param  {string} type             only accept SAMLResponse to proceed decryption

package/types/src/metadata.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 export interface MetadataInterface {
     xmlString: string;
     getMetadata: () => string;

package/types/src/types.d.ts

@@ -1,10 +1,11 @@
+/// <reference types="node" />
 import { LoginResponseTemplate } from './libsaml';
 export { IdentityProvider as IdentityProviderConstructor } from './entity-idp';
 export { IdpMetadata as IdentityProviderMetadata } from './metadata-idp';
 export { ServiceProvider as ServiceProviderConstructor } from './entity-sp';
 export { SpMetadata as ServiceProviderMetadata } from './metadata-sp';
-export type MetadataFile = string | Buffer;
-type SSOService = {
+export declare type MetadataFile = string | Buffer;
+declare type SSOService = {
     isDefault?: boolean;
     Binding: string;
     Location: string;
@@ -19,7 +20,7 @@ export interface MetadataIdpOptions {
     singleLogoutService?: SSOService[];
     requestSignatureAlgorithm?: string;
 }
-export type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
+export declare type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
 export interface MetadataSpOptions {
     entityID?: string;
     signingCert?: string | Buffer | (string | Buffer)[];
@@ -36,8 +37,8 @@ export interface MetadataSpOptions {
     assertionConsumerService?: SSOService[];
     elementsOrder?: string[];
 }
-export type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
-export type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
+export declare type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
+export declare type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
 export interface SignatureConfig {
     prefix?: string;
     location?: {
@@ -48,7 +49,7 @@ export interface SignatureConfig {
 export interface SAMLDocumentTemplate {
     context?: string;
 }
-export type ServiceProviderSettings = {
+export declare type ServiceProviderSettings = {
     metadata?: string | Buffer;
     entityID?: string;
     authnRequestsSigned?: boolean;
@@ -75,7 +76,7 @@ export type ServiceProviderSettings = {
     relayState?: string;
     clockDrifts?: [number, number];
 };
-export type IdentityProviderSettings = {
+export declare type IdentityProviderSettings = {
     metadata?: string | Buffer;
     /** signature algorithm */
     requestSignatureAlgorithm?: string;

package/types/src/utility.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 /**
  * @desc Mimic lodash.zipObject
  * @param arr1 {string[]}
@@ -34,7 +35,7 @@ export declare function get(obj: any, path: any, defaultValue: any): any;
  * @desc Check if the input is string
  * @param {any} input
  */
-export declare function isString(input: any): input is string;
+export declare function isString(input: any): boolean;
 /**
 * @desc Encode string with base64 format
 * @param  {string} message                       plain-text message

package/types/src/validator.d.ts

@@ -1,3 +1,3 @@
-type DriftTolerance = [number, number];
+declare type DriftTolerance = [number, number];
 declare function verifyTime(utcNotBefore: string | undefined, utcNotOnOrAfter: string | undefined, drift?: DriftTolerance): boolean;
 export { verifyTime };

package/types/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/vitest.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    include: ['test/**/*.ts'],
+    exclude: ['node_modules', 'build'],
+    globals: true,
+    environment: 'node',
+  },
+})
+
+