samlesa 2.12.3 → 2.12.5

package/types/src/entity.d.ts

@@ -1,99 +1,101 @@
-import { IdpMetadata as IdpMetadataConstructor } from './metadata-idp.js';
-import { SpMetadata as SpMetadataConstructor } from './metadata-sp.js';
-import { MetadataIdpConstructor, MetadataSpConstructor, EntitySetting } from './types.js';
-import { FlowResult } from './flow.js';
-export interface ESamlHttpRequest {
-    query?: any;
-    body?: any;
-    octetString?: string;
-}
-export interface BindingContext {
-    context: string;
-    id: string;
-}
-export interface PostBindingContext extends BindingContext {
-    relayState?: string;
-    entityEndpoint: string;
-    type: string;
-}
-export interface SimpleSignBindingContext extends PostBindingContext {
-    sigAlg?: string;
-    signature?: string;
-    keyInfo?: string;
-}
-export interface SimpleSignComputedContext extends BindingContext {
-    sigAlg?: string;
-    signature?: string;
-}
-export interface ParseResult {
-    samlContent: string;
-    extract: any;
-    sigAlg: string;
-}
-export type EntityConstructor = (MetadataIdpConstructor | MetadataSpConstructor) & {
-    metadata?: string | Buffer;
-};
-export default class Entity {
-    entitySetting: EntitySetting;
-    entityType: string;
-    entityMeta: IdpMetadataConstructor | SpMetadataConstructor;
-    /**
-    * @param entitySetting
-    * @param entityMeta is the entity metadata, deprecated after 2.0
-    */
-    constructor(entitySetting: EntityConstructor, entityType: 'idp' | 'sp');
-    /**
-    * @desc  Returns the setting of entity
-    * @return {object}
-    */
-    getEntitySetting(): EntitySetting;
-    /**
-    * @desc  Returns the xml string of entity metadata
-    * @return {string}
-    */
-    getMetadata(): string;
-    /**
-    * @desc  Exports the entity metadata into specified folder
-    * @param  {string} exportFile indicates the file name
-    */
-    exportMetadata(exportFile: string): void;
-    /** * @desc  Verify fields with the one specified in metadata
-    * @param  {string/[string]} field is a string or an array of string indicating the field value in SAML message
-    * @param  {string} metaField is a string indicating the same field specified in metadata
-    * @return {boolean} True/False
-    */
-    verifyFields(field: string | string[], metaField: string): boolean;
-    /** @desc   Generates the logout request for developers to design their own method
-    * @param  {ServiceProvider} sp     object of service provider
-    * @param  {string}   binding       protocol binding
-    * @param  {object}   user          current logged user (e.g. user)
-    * @param  {string} relayState      the URL to which to redirect the user when logout is complete
-    * @param  {function} customTagReplacement     used when developers have their own login response template
-    */
-    createLogoutRequest(targetEntity: any, binding: any, user: any, relayState?: string, customTagReplacement?: any): BindingContext | PostBindingContext;
-    /**
-    * @desc  Generates the logout response for developers to design their own method
-    * @param  {IdentityProvider} idp               object of identity provider
-    * @param  {object} requestInfo                 corresponding request, used to obtain the id
-    * @param  {string} relayState                  the URL to which to redirect the user when logout is complete.
-    * @param  {string} binding                     protocol binding
-    * @param  {function} customTagReplacement                 used when developers have their own login response template
-    */
-    createLogoutResponse(target: any, requestInfo: any, binding: any, relayState?: string, customTagReplacement?: any): BindingContext | PostBindingContext;
-    /**
-    * @desc   Validation of the parsed the URL parameters
-    * @param  {IdentityProvider}   idp             object of identity provider
-    * @param  {string}   binding                   protocol binding
-    * @param  {request}   req                      request
-    * @return {Promise}
-    */
-    parseLogoutRequest(from: any, binding: any, request: ESamlHttpRequest): Promise<FlowResult>;
-    /**
-    * @desc   Validation of the parsed the URL parameters
-    * @param  {object} config                      config for the parser
-    * @param  {string}   binding                   protocol binding
-    * @param  {request}   req                      request
-    * @return {Promise}
-    */
-    parseLogoutResponse(from: any, binding: any, request: ESamlHttpRequest): Promise<FlowResult>;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+import { IdpMetadata as IdpMetadataConstructor } from './metadata-idp.js';
+import { SpMetadata as SpMetadataConstructor } from './metadata-sp.js';
+import { MetadataIdpConstructor, MetadataSpConstructor, EntitySetting } from './types.js';
+import { FlowResult } from './flow.js';
+export interface ESamlHttpRequest {
+    query?: any;
+    body?: any;
+    octetString?: string;
+}
+export interface BindingContext {
+    context: string;
+    id: string;
+}
+export interface PostBindingContext extends BindingContext {
+    relayState?: string;
+    entityEndpoint: string;
+    type: string;
+}
+export interface SimpleSignBindingContext extends PostBindingContext {
+    sigAlg?: string;
+    signature?: string;
+    keyInfo?: string;
+}
+export interface SimpleSignComputedContext extends BindingContext {
+    sigAlg?: string;
+    signature?: string;
+}
+export interface ParseResult {
+    samlContent: string;
+    extract: any;
+    sigAlg: string;
+}
+export type EntityConstructor = (MetadataIdpConstructor | MetadataSpConstructor) & {
+    metadata?: string | Buffer;
+};
+export default class Entity {
+    entitySetting: EntitySetting;
+    entityType: string;
+    entityMeta: IdpMetadataConstructor | SpMetadataConstructor;
+    /**
+    * @param entitySetting
+    * @param entityMeta is the entity metadata, deprecated after 2.0
+    */
+    constructor(entitySetting: EntityConstructor, entityType: 'idp' | 'sp');
+    /**
+    * @desc  Returns the setting of entity
+    * @return {object}
+    */
+    getEntitySetting(): EntitySetting;
+    /**
+    * @desc  Returns the xml string of entity metadata
+    * @return {string}
+    */
+    getMetadata(): string;
+    /**
+    * @desc  Exports the entity metadata into specified folder
+    * @param  {string} exportFile indicates the file name
+    */
+    exportMetadata(exportFile: string): void;
+    /** * @desc  Verify fields with the one specified in metadata
+    * @param  {string/[string]} field is a string or an array of string indicating the field value in SAML message
+    * @param  {string} metaField is a string indicating the same field specified in metadata
+    * @return {boolean} True/False
+    */
+    verifyFields(field: string | string[], metaField: string): boolean;
+    /** @desc   Generates the logout request for developers to design their own method
+    * @param  {ServiceProvider} sp     object of service provider
+    * @param  {string}   binding       protocol binding
+    * @param  {object}   user          current logged user (e.g. user)
+    * @param  {string} relayState      the URL to which to redirect the user when logout is complete
+    * @param  {function} customTagReplacement     used when developers have their own login response template
+    */
+    createLogoutRequest(targetEntity: any, binding: any, user: any, relayState?: string, customTagReplacement?: any): BindingContext | PostBindingContext;
+    /**
+    * @desc  Generates the logout response for developers to design their own method
+    * @param  {IdentityProvider} idp               object of identity provider
+    * @param  {object} requestInfo                 corresponding request, used to obtain the id
+    * @param  {string} relayState                  the URL to which to redirect the user when logout is complete.
+    * @param  {string} binding                     protocol binding
+    * @param  {function} customTagReplacement                 used when developers have their own login response template
+    */
+    createLogoutResponse(target: any, requestInfo: any, binding: any, relayState?: string, customTagReplacement?: any): BindingContext | PostBindingContext;
+    /**
+    * @desc   Validation of the parsed the URL parameters
+    * @param  {IdentityProvider}   idp             object of identity provider
+    * @param  {string}   binding                   protocol binding
+    * @param  {request}   req                      request
+    * @return {Promise}
+    */
+    parseLogoutRequest(from: any, binding: any, request: ESamlHttpRequest): Promise<FlowResult>;
+    /**
+    * @desc   Validation of the parsed the URL parameters
+    * @param  {object} config                      config for the parser
+    * @param  {string}   binding                   protocol binding
+    * @param  {request}   req                      request
+    * @return {Promise}
+    */
+    parseLogoutResponse(from: any, binding: any, request: ESamlHttpRequest): Promise<FlowResult>;
+}

package/types/src/extractor.d.ts

@@ -1,25 +1,25 @@
-interface ExtractorField {
-    key: string;
-    localPath: string[] | string[][];
-    attributes: string[];
-    index?: string[];
-    attributePath?: string[];
-    context?: boolean;
-}
-export type ExtractorFields = ExtractorField[];
-export declare const loginRequestFields: ExtractorFields;
-export declare const loginResponseStatusFields: {
-    key: string;
-    localPath: string[];
-    attributes: string[];
-}[];
-export declare const logoutResponseStatusFields: {
-    key: string;
-    localPath: string[];
-    attributes: string[];
-}[];
-export declare const loginResponseFields: ((assertion: any) => ExtractorFields);
-export declare const logoutRequestFields: ExtractorFields;
-export declare const logoutResponseFields: ExtractorFields;
-export declare function extract(context: string, fields: any): any;
-export {};
+interface ExtractorField {
+    key: string;
+    localPath: string[] | string[][];
+    attributes: string[];
+    index?: string[];
+    attributePath?: string[];
+    context?: boolean;
+}
+export type ExtractorFields = ExtractorField[];
+export declare const loginRequestFields: ExtractorFields;
+export declare const loginResponseStatusFields: {
+    key: string;
+    localPath: string[];
+    attributes: string[];
+}[];
+export declare const logoutResponseStatusFields: {
+    key: string;
+    localPath: string[];
+    attributes: string[];
+}[];
+export declare const loginResponseFields: ((assertion: any) => ExtractorFields);
+export declare const logoutRequestFields: ExtractorFields;
+export declare const logoutResponseFields: ExtractorFields;
+export declare function extract(context: string, fields: any): any;
+export {};

package/types/src/flow.d.ts

@@ -1,6 +1,6 @@
-export interface FlowResult {
-    samlContent: string;
-    extract: any;
-    sigAlg?: string | null;
-}
-export declare function flow(options: any): Promise<FlowResult>;
+export interface FlowResult {
+    samlContent: string;
+    extract: any;
+    sigAlg?: string | null;
+}
+export declare function flow(options: any): Promise<FlowResult>;