samlesa 2.12.3 → 2.12.6

package/types/src/metadata.d.ts

@@ -1,57 +1,59 @@
-export interface MetadataInterface {
-    xmlString: string;
-    getMetadata: () => string;
-    exportMetadata: (exportFile: string) => void;
-    getEntityID: () => string;
-    getX509Certificate: (certType: string) => string | string[];
-    getNameIDFormat: () => any[];
-    getSingleLogoutService: (binding: string | undefined) => string | object;
-    getSupportBindings: (services: string[]) => string[];
-}
-export default class Metadata implements MetadataInterface {
-    xmlString: string;
-    meta: any;
-    /**
-    * @param  {string | Buffer} xml
-    * @param  {object} extraParse for custom metadata extractor
-    */
-    constructor(xml: string | Buffer, extraParse?: any);
-    /**
-    * @desc Get the metadata in xml format
-    * @return {string} metadata in xml format
-    */
-    getMetadata(): string;
-    /**
-    * @desc Export the metadata to specific file
-    * @param {string} exportFile is the output file path
-    */
-    exportMetadata(exportFile: string): void;
-    /**
-    * @desc Get the entityID in metadata
-    * @return {string} entityID
-    */
-    getEntityID(): string;
-    /**
-    * @desc Get the x509 certificate declared in entity metadata
-    * @param  {string} use declares the type of certificate
-    * @return {string} certificate in string format
-    */
-    getX509Certificate(use: string): any;
-    /**
-    * @desc Get the support NameID format declared in entity metadata
-    * @return {array} support NameID format
-    */
-    getNameIDFormat(): any;
-    /**
-    * @desc Get the entity endpoint for single logout service
-    * @param  {string} binding e.g. redirect, post
-    * @return {string/object} location
-    */
-    getSingleLogoutService(binding: string | undefined): string | object;
-    /**
-    * @desc Get the support bindings
-    * @param  {[string]} services
-    * @return {[string]} support bindings
-    */
-    getSupportBindings(services: string[]): string[];
-}
+/// <reference types="node" />
+/// <reference types="node" />
+export interface MetadataInterface {
+    xmlString: string;
+    getMetadata: () => string;
+    exportMetadata: (exportFile: string) => void;
+    getEntityID: () => string;
+    getX509Certificate: (certType: string) => string | string[];
+    getNameIDFormat: () => any[];
+    getSingleLogoutService: (binding: string | undefined) => string | object;
+    getSupportBindings: (services: string[]) => string[];
+}
+export default class Metadata implements MetadataInterface {
+    xmlString: string;
+    meta: any;
+    /**
+    * @param  {string | Buffer} xml
+    * @param  {object} extraParse for custom metadata extractor
+    */
+    constructor(xml: string | Buffer, extraParse?: any);
+    /**
+    * @desc Get the metadata in xml format
+    * @return {string} metadata in xml format
+    */
+    getMetadata(): string;
+    /**
+    * @desc Export the metadata to specific file
+    * @param {string} exportFile is the output file path
+    */
+    exportMetadata(exportFile: string): void;
+    /**
+    * @desc Get the entityID in metadata
+    * @return {string} entityID
+    */
+    getEntityID(): string;
+    /**
+    * @desc Get the x509 certificate declared in entity metadata
+    * @param  {string} use declares the type of certificate
+    * @return {string} certificate in string format
+    */
+    getX509Certificate(use: string): any;
+    /**
+    * @desc Get the support NameID format declared in entity metadata
+    * @return {array} support NameID format
+    */
+    getNameIDFormat(): any;
+    /**
+    * @desc Get the entity endpoint for single logout service
+    * @param  {string} binding e.g. redirect, post
+    * @return {string/object} location
+    */
+    getSingleLogoutService(binding: string | undefined): string | object;
+    /**
+    * @desc Get the support bindings
+    * @param  {[string]} services
+    * @return {[string]} support bindings
+    */
+    getSupportBindings(services: string[]): string[];
+}

package/types/src/types.d.ts

@@ -1,127 +1,129 @@
-import { LoginResponseTemplate } from './libsaml.js';
-export { IdentityProvider as IdentityProviderConstructor } from './entity-idp.js';
-export { IdpMetadata as IdentityProviderMetadata } from './metadata-idp.js';
-export { ServiceProvider as ServiceProviderConstructor } from './entity-sp.js';
-export { SpMetadata as ServiceProviderMetadata } from './metadata-sp.js';
-export type MetadataFile = string | Buffer;
-type SSOService = {
-    isDefault?: boolean;
-    Binding: string;
-    Location: string;
-};
-export type ServiceName = {
-    value: string;
-    /** @description 语言标识符（如 en/zh-CN） */
-    lang?: string;
-};
-export type RequestedAttribute = {
-    name: string;
-    friendlyName?: string;
-    isRequired?: boolean;
-    nameFormat?: string;
-    attributeValue?: string[];
-};
-export type AttributeConsumingService = {
-    isDefault: boolean;
-    serviceName: ServiceName[];
-    serviceDescription: ServiceName[];
-    requestedAttributes: RequestedAttribute[];
-};
-export type AttrService = AttributeConsumingService[];
-export interface MetadataIdpOptions {
-    entityID?: string;
-    signingCert?: string | Buffer | (string | Buffer)[];
-    encryptCert?: string | Buffer | (string | Buffer)[];
-    wantAuthnRequestsSigned?: boolean;
-    nameIDFormat?: string[];
-    singleSignOnService?: SSOService[];
-    singleLogoutService?: SSOService[];
-    requestSignatureAlgorithm?: string;
-}
-export type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
-export interface MetadataSpOptions {
-    entityID?: string;
-    signingCert?: string | Buffer | (string | Buffer)[];
-    encryptCert?: string | Buffer | (string | Buffer)[];
-    authnRequestsSigned?: boolean;
-    wantAssertionsSigned?: boolean;
-    wantMessageSigned?: boolean;
-    signatureConfig?: {
-        [key: string]: any;
-    };
-    nameIDFormat?: string[];
-    singleSignOnService?: SSOService[];
-    singleLogoutService?: SSOService[];
-    assertionConsumerService?: SSOService[];
-    attributeConsumingService?: AttributeConsumingService[];
-    elementsOrder?: string[];
-}
-export type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
-export type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
-export interface SignatureConfig {
-    prefix?: string;
-    location?: {
-        reference?: string;
-        action?: 'append' | 'prepend' | 'before' | 'after';
-    };
-}
-export interface SAMLDocumentTemplate {
-    context?: string;
-}
-export type ServiceProviderSettings = {
-    metadata?: string | Buffer;
-    entityID?: string;
-    authnRequestsSigned?: boolean;
-    wantAssertionsSigned?: boolean;
-    wantMessageSigned?: boolean;
-    wantLogoutResponseSigned?: boolean;
-    wantLogoutRequestSigned?: boolean;
-    privateKey?: string | Buffer;
-    privateKeyPass?: string;
-    isAssertionEncrypted?: boolean;
-    requestSignatureAlgorithm?: string;
-    encPrivateKey?: string | Buffer;
-    encPrivateKeyPass?: string | Buffer;
-    assertionConsumerService?: SSOService[];
-    singleLogoutService?: SSOService[];
-    signatureConfig?: SignatureConfig;
-    loginRequestTemplate?: SAMLDocumentTemplate;
-    logoutRequestTemplate?: SAMLDocumentTemplate;
-    signingCert?: string | Buffer | (string | Buffer)[];
-    encryptCert?: string | Buffer | (string | Buffer)[];
-    transformationAlgorithms?: string[];
-    nameIDFormat?: string[];
-    allowCreate?: boolean;
-    relayState?: string;
-    clockDrifts?: [number, number];
-};
-export type IdentityProviderSettings = {
-    metadata?: string | Buffer;
-    /** signature algorithm */
-    requestSignatureAlgorithm?: string;
-    /** template of login response */
-    loginResponseTemplate?: LoginResponseTemplate;
-    /** template of logout request */
-    logoutRequestTemplate?: SAMLDocumentTemplate;
-    /** customized function used for generating request ID */
-    generateID?: () => string;
-    entityID?: string;
-    privateKey?: string | Buffer;
-    privateKeyPass?: string;
-    signingCert?: string | Buffer | (string | Buffer)[];
-    encryptCert?: string | Buffer | (string | Buffer)[];
-    nameIDFormat?: string[];
-    singleSignOnService?: SSOService[];
-    singleLogoutService?: SSOService[];
-    isAssertionEncrypted?: boolean;
-    encPrivateKey?: string | Buffer;
-    encPrivateKeyPass?: string;
-    messageSigningOrder?: string;
-    wantLogoutRequestSigned?: boolean;
-    wantLogoutResponseSigned?: boolean;
-    wantAuthnRequestsSigned?: boolean;
-    wantLogoutRequestSignedResponseSigned?: boolean;
-    tagPrefix?: {
-        [key: string]: string;
-    };
-};
+/// <reference types="node" />
+/// <reference types="node" />
+import { LoginResponseTemplate } from './libsaml.js';
+export { IdentityProvider as IdentityProviderConstructor } from './entity-idp.js';
+export { IdpMetadata as IdentityProviderMetadata } from './metadata-idp.js';
+export { ServiceProvider as ServiceProviderConstructor } from './entity-sp.js';
+export { SpMetadata as ServiceProviderMetadata } from './metadata-sp.js';
+export type MetadataFile = string | Buffer;
+type SSOService = {
+    isDefault?: boolean;
+    Binding: string;
+    Location: string;
+};
+export type ServiceName = {
+    value: string;
+    /** @description 语言标识符（如 en/zh-CN） */
+    lang?: string;
+};
+export type RequestedAttribute = {
+    name: string;
+    friendlyName?: string;
+    isRequired?: boolean;
+    nameFormat?: string;
+    attributeValue?: string[];
+};
+export type AttributeConsumingService = {
+    isDefault: boolean;
+    serviceName: ServiceName[];
+    serviceDescription: ServiceName[];
+    requestedAttributes: RequestedAttribute[];
+};
+export type AttrService = AttributeConsumingService[];
+export interface MetadataIdpOptions {
+    entityID?: string;
+    signingCert?: string | Buffer | (string | Buffer)[];
+    encryptCert?: string | Buffer | (string | Buffer)[];
+    wantAuthnRequestsSigned?: boolean;
+    nameIDFormat?: string[];
+    singleSignOnService?: SSOService[];
+    singleLogoutService?: SSOService[];
+    requestSignatureAlgorithm?: string;
+}
+export type MetadataIdpConstructor = MetadataIdpOptions | MetadataFile;
+export interface MetadataSpOptions {
+    entityID?: string;
+    signingCert?: string | Buffer | (string | Buffer)[];
+    encryptCert?: string | Buffer | (string | Buffer)[];
+    authnRequestsSigned?: boolean;
+    wantAssertionsSigned?: boolean;
+    wantMessageSigned?: boolean;
+    signatureConfig?: {
+        [key: string]: any;
+    };
+    nameIDFormat?: string[];
+    singleSignOnService?: SSOService[];
+    singleLogoutService?: SSOService[];
+    assertionConsumerService?: SSOService[];
+    attributeConsumingService?: AttributeConsumingService[];
+    elementsOrder?: string[];
+}
+export type MetadataSpConstructor = MetadataSpOptions | MetadataFile;
+export type EntitySetting = ServiceProviderSettings & IdentityProviderSettings;
+export interface SignatureConfig {
+    prefix?: string;
+    location?: {
+        reference?: string;
+        action?: 'append' | 'prepend' | 'before' | 'after';
+    };
+}
+export interface SAMLDocumentTemplate {
+    context?: string;
+}
+export type ServiceProviderSettings = {
+    metadata?: string | Buffer;
+    entityID?: string;
+    authnRequestsSigned?: boolean;
+    wantAssertionsSigned?: boolean;
+    wantMessageSigned?: boolean;
+    wantLogoutResponseSigned?: boolean;
+    wantLogoutRequestSigned?: boolean;
+    privateKey?: string | Buffer;
+    privateKeyPass?: string;
+    isAssertionEncrypted?: boolean;
+    requestSignatureAlgorithm?: string;
+    encPrivateKey?: string | Buffer;
+    encPrivateKeyPass?: string | Buffer;
+    assertionConsumerService?: SSOService[];
+    singleLogoutService?: SSOService[];
+    signatureConfig?: SignatureConfig;
+    loginRequestTemplate?: SAMLDocumentTemplate;
+    logoutRequestTemplate?: SAMLDocumentTemplate;
+    signingCert?: string | Buffer | (string | Buffer)[];
+    encryptCert?: string | Buffer | (string | Buffer)[];
+    transformationAlgorithms?: string[];
+    nameIDFormat?: string[];
+    allowCreate?: boolean;
+    relayState?: string;
+    clockDrifts?: [number, number];
+};
+export type IdentityProviderSettings = {
+    metadata?: string | Buffer;
+    /** signature algorithm */
+    requestSignatureAlgorithm?: string;
+    /** template of login response */
+    loginResponseTemplate?: LoginResponseTemplate;
+    /** template of logout request */
+    logoutRequestTemplate?: SAMLDocumentTemplate;
+    /** customized function used for generating request ID */
+    generateID?: () => string;
+    entityID?: string;
+    privateKey?: string | Buffer;
+    privateKeyPass?: string;
+    signingCert?: string | Buffer | (string | Buffer)[];
+    encryptCert?: string | Buffer | (string | Buffer)[];
+    nameIDFormat?: string[];
+    singleSignOnService?: SSOService[];
+    singleLogoutService?: SSOService[];
+    isAssertionEncrypted?: boolean;
+    encPrivateKey?: string | Buffer;
+    encPrivateKeyPass?: string;
+    messageSigningOrder?: string;
+    wantLogoutRequestSigned?: boolean;
+    wantLogoutResponseSigned?: boolean;
+    wantAuthnRequestsSigned?: boolean;
+    wantLogoutRequestSignedResponseSigned?: boolean;
+    tagPrefix?: {
+        [key: string]: string;
+    };
+};