@authhero/saml 0.5.18 → 0.6.0

package/dist/core.d.ts

@@ -21,6 +21,23 @@ declare const samlRequestSchema: z.ZodObject<{
         "@_Version": z.ZodString;
     }, z.core.$strip>;
 }, z.core.$strip>;
+declare const samlLogoutRequestSchema: z.ZodObject<{
+    "samlp:LogoutRequest": z.ZodObject<{
+        "saml:Issuer": z.ZodObject<{
+            "#text": z.ZodString;
+            "@_xmlns:saml": z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        "saml:NameID": z.ZodOptional<z.ZodObject<{
+            "#text": z.ZodString;
+        }, z.core.$strip>>;
+        "samlp:SessionIndex": z.ZodOptional<z.ZodObject<{
+            "#text": z.ZodString;
+        }, z.core.$strip>>;
+        "@_ID": z.ZodString;
+        "@_Version": z.ZodOptional<z.ZodString>;
+        "@_Destination": z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 declare const samlMetadataResponseSchema: z.ZodArray<z.ZodObject<{
     ":@": z.ZodObject<{
         "@_xmlns": z.ZodString;
@@ -486,6 +503,36 @@ declare function parseSamlRequestQuery(samlRequestQuery: string): Promise<{
         "@_ProtocolBinding"?: string | undefined;
     };
 }>;
+declare function parseSamlLogoutRequestQuery(samlRequestQuery: string): Promise<{
+    "samlp:LogoutRequest": {
+        "saml:Issuer": {
+            "#text": string;
+            "@_xmlns:saml"?: string | undefined;
+        };
+        "@_ID": string;
+        "saml:NameID"?: {
+            "#text": string;
+        } | undefined;
+        "samlp:SessionIndex"?: {
+            "#text": string;
+        } | undefined;
+        "@_Version"?: string | undefined;
+        "@_Destination"?: string | undefined;
+    };
+}>;
+interface SAMLLogoutResponseParams {
+    issuer: string;
+    destination: string;
+    inResponseTo?: string;
+    success: boolean;
+    /** Only used when `success` is false. */
+    statusMessage?: string;
+}
+/**
+ * Builds an unsigned, HTTP-Redirect-encoded (raw deflate + base64) SAML
+ * LogoutResponse, ready to be URL-encoded into the `SAMLResponse` query param.
+ */
+declare function createSamlLogoutResponse(params: SAMLLogoutResponseParams): Promise<string>;
 declare function createSamlMetadata(samlMetadataParams: SAMLMetadataParams): string;
 declare function createSamlResponse(samlResponseParams: SAMLResponseParams, signer?: SamlSigner): Promise<string>;
 
@@ -499,5 +546,5 @@ declare class HttpSamlSigner implements SamlSigner {
     signSAML(xmlContent: string, privateKey: string, publicCert: string): Promise<string>;
 }
 
-export { HttpSamlSigner, createSamlMetadata, createSamlResponse, dsSignatureSchema, inflateDecompress, inflateRaw, parseSamlRequestQuery, samlIssuerSchema, samlMetadataResponseSchema, samlRequestSchema, samlResponseJsonSchema };
-export type { DSIGSignature, SAMLMetadataParams, SAMLMetadataResponse, SAMLResponseJSON, SAMLResponseParams, SamlSigner };
+export { HttpSamlSigner, createSamlLogoutResponse, createSamlMetadata, createSamlResponse, dsSignatureSchema, inflateDecompress, inflateRaw, parseSamlLogoutRequestQuery, parseSamlRequestQuery, samlIssuerSchema, samlLogoutRequestSchema, samlMetadataResponseSchema, samlRequestSchema, samlResponseJsonSchema };
+export type { DSIGSignature, SAMLLogoutResponseParams, SAMLMetadataParams, SAMLMetadataResponse, SAMLResponseJSON, SAMLResponseParams, SamlSigner };