@azure/functions-authentication-events 1.0.0-beta.2 → 1.0.0-beta.3

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2020 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

package/README.md

@@ -4,42 +4,42 @@ Authentication Event Trigger for Azure Functions handles all the backend process
 
 This project framework provides the following features:
 
-* Token validation for securing the API call
-* Object model, typing, and IDE intellisense
-* Inbound and outbound validation of the API request and response schemas
-* Versioning
-* No need for boilerplate code.
+- Token validation for securing the API call
+- Object model, typing, and IDE intellisense
+- Inbound and outbound validation of the API request and response schemas
+- Versioning
+- No need for boilerplate code.
 
 ## Getting started
 
 ### Install the npm package
 
 ```console
-npm install @azure/functions-authentication-events 
+npm install @azure/functions-authentication-events
 ```
 
 ### Prerequisites
 
-* [Azure function tools](https://github.com/Azure/azure-functions-core-tools)
-* [Azure Function Core Tools](https://github.com/Azure/azure-functions-core-tools#installing)
-* If using Visual Studio Code the following extensions:
-  * [ms-azuretools.vscode-azurefunctions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions)
-  * [ms-dotnettools.csharp](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
+- [Azure function tools](https://github.com/Azure/azure-functions-core-tools)
+- [Azure Function Core Tools](https://github.com/Azure/azure-functions-core-tools#installing)
+- If using Visual Studio Code the following extensions:
+  - [ms-azuretools.vscode-azurefunctions](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azurefunctions)
+  - [ms-dotnettools.csharp](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
 
 ### Authenticate the Client
 
-When Azure AD authentication events service calls your custom extension, it will send an `Authorization` header with a `Bearer {token}`. This token will represent a [service to service authentication](https://review.docs.microsoft.com/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow) in which:
+When Azure AD authentication events service calls your custom extension, it will send an `Authorization` header with a `Bearer {token}`. This token will represent a [service to service authentication](https://review.learn.microsoft.com/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow) in which:
 
-* The '**resource**', also known as the **audience**, is the application that you register to represent your API. This is represented by the `aud` claim in the token.
-* The '**client**' is a Microsoft application that represents the Azure AD authentication events service. It has an `appId` value of `99045fe1-7639-4a75-9d4a-577b6ca3810f`. This is represented by:
-  * The `azp` claim in the token if your application `accessTokenAcceptedVersion` property is set to `2`.
-  * The `appid` claim in the token if your resource application's `accessTokenAcceptedVersion` property is set to `1` or `null`.
+- The '**resource**', also known as the **audience**, is the application that you register to represent your API. This is represented by the `aud` claim in the token.
+- The '**client**' is a Microsoft application that represents the Azure AD authentication events service. It has an `appId` value of `99045fe1-7639-4a75-9d4a-577b6ca3810f`. This is represented by:
+  - The `azp` claim in the token if your application `accessTokenAcceptedVersion` property is set to `2`.
+  - The `appid` claim in the token if your resource application's `accessTokenAcceptedVersion` property is set to `1` or `null`.
 
-There are three approaches to dealing with the token. You can customize the behavior using [application settings](https://docs.microsoft.com/azure/azure-functions/functions-how-to-use-azure-function-app-settings?tabs=portal#settings) as shown below or via the [local.settings.json](https://docs.microsoft.com/azure/azure-functions/functions-develop-local#local-settings-file) file in local environments.
+There are three approaches to dealing with the token. You can customize the behavior using [application settings](https://learn.microsoft.com/azure/azure-functions/functions-how-to-use-azure-function-app-settings?tabs=portal#settings) as shown below or via the [local.settings.json](https://learn.microsoft.com/azure/azure-functions/functions-develop-local#local-settings-file) file in local environments.
 
 #### Validate tokens using Azure Functions Azure AD authentication integration
 
-When running your function in production, it is **highly recommended** to use the [Azure Functions Azure AD authentication integration](https://docs.microsoft.com/azure/app-service/configure-authentication-provider-aad#-option-2-use-an-existing-registration-created-separately) for validating incoming tokens.
+When running your function in production, it is **highly recommended** to use the [Azure Functions Azure AD authentication integration](https://learn.microsoft.com/azure/app-service/configure-authentication-provider-aad#-option-2-use-an-existing-registration-created-separately) for validating incoming tokens.
 
 1. Go to the "Authentication" tab in your Function App
 2. Click on "Add identity provider"
@@ -47,29 +47,27 @@ When running your function in production, it is **highly recommended** to use th
 4. Select "Provide the details of an existing app registration"
 5. Enter the `Application ID` of the app that represents your API in Azure AD
 
-The issuer and allowed audience depends on the [`accessTokenAcceptedVersion`](https://review.docs.microsoft.com/azure/active-directory/develop/access-tokens) property of your application (can be found in the "Manifest" of the application).
+The issuer and allowed audience depends on the [`accessTokenAcceptedVersion`](https://review.learn.microsoft.com/azure/active-directory/develop/access-tokens) property of your application (can be found in the "Manifest" of the application).
 
-If the `accessTokenAcceptedVersion` property is set to `2`:
-6. Set the `Issuer URL to "https://login.microsoftonline.com/{tenantId}/v2.0"
+If the `accessTokenAcceptedVersion` property is set to `2`: 6. Set the `Issuer URL to "https://login.microsoftonline.com/{tenantId}/v2.0"
 7. Set an 'Allowed Audience' to the Application ID (`appId`)
 
-If the `accessTokenAcceptedVersion` property is set to `1` or `null`:
-6. Set the `Issuer URL to "https://sts.windows.net/{tenantId}/"
-7. Set an 'Allowed Audience' to the Application ID URI (also known as`identifierUri`). It should be in the format of`api://{azureFunctionAppName}.azurewebsites.net/{resourceApiAppId}` or `api://{FunctionAppFullyQualifiedDomainName}/{resourceApiAppId}` if using a [custom domain name](https://docs.microsoft.com/azure/dns/dns-custom-domain#:~:text=Azure%20Function%20App%201%20Navigate%20to%20Function%20App,Custom%20domain%20text%20field%20and%20select%20Validate.%20).
+If the `accessTokenAcceptedVersion` property is set to `1` or `null`: 6. Set the `Issuer URL to "https://sts.windows.net/{tenantId}/"
+7. Set an 'Allowed Audience' to the Application ID URI (also known as`identifierUri`). It should be in the format of`api://{azureFunctionAppName}.azurewebsites.net/{resourceApiAppId}`or`api://{FunctionAppFullyQualifiedDomainName}/{resourceApiAppId}` if using a [custom domain name](https://learn.microsoft.com/azure/dns/dns-custom-domain#:~:text=Azure%20Function%20App%201%20Navigate%20to%20Function%20App,Custom%20domain%20text%20field%20and%20select%20Validate.%20).
 
 By default, the Authentication event trigger will validate that Azure Function authentication integration is configured and it will check that the **client** in the token is set to `99045fe1-7639-4a75-9d4a-577b6ca3810f` (via the `azp` or `appid` claims in the token).
 
 If you want to test your API against some other client that is not Azure AD authentication events service, like using Postman, you can configure an _optional_ application setting:
 
-* **AuthenticationEvents__CustomCallerAppId** - the guid of your desired client. If not provided, `99045fe1-7639-4a75-9d4a-577b6ca3810f` is assumed.
+- **AuthenticationEvents\_\_CustomCallerAppId** - the guid of your desired client. If not provided, `99045fe1-7639-4a75-9d4a-577b6ca3810f` is assumed.
 
 #### Have the trigger validate the token
 
 In local environments or environments that aren't hosted in the Azure Function service, the trigger can do the token validation. Set the following application settings:
 
-* **AuthenticationEvents__TenantId** - your tenant ID
-* **AuthenticationEvents__AudienceAppId** - the same value as "Allowed audience" in option 1.
-* **AuthenticationEvents__CustomCallerAppId** (_optional_) - the guid of your desired client. If not provided, `99045fe1-7639-4a75-9d4a-577b6ca3810f` is assumed.
+- **AuthenticationEvents\_\_TenantId** - your tenant ID
+- **AuthenticationEvents\_\_AudienceAppId** - the same value as "Allowed audience" in option 1.
+- **AuthenticationEvents\_\_CustomCallerAppId** (_optional_) - the guid of your desired client. If not provided, `99045fe1-7639-4a75-9d4a-577b6ca3810f` is assumed.
 
 An example `local.settings.json` file:
 
@@ -90,20 +88,20 @@ An example `local.settings.json` file:
 
 If you would like to _not_ authenticate the token while in local development, set the following application setting:
 
-* **AuthenticationEvents__BypassTokenValidation** - value of `true` will make the trigger not check for a validation of the token.
+- **AuthenticationEvents\_\_BypassTokenValidation** - value of `true` will make the trigger not check for a validation of the token.
 
 ### Quickstart
 
-* Visual Studio Code
-  * Start Visual Studio Code
-  * Run the terminal command `func init . --worker-runtime node` via the command palette
-  * Run the terminal command `func new` via the command palette
-  * Follow the project creation prompts
-  * Run the terminal command `npm install @azure/functions-authentication-events` via the command palette
-  * Run the terminal command `npm install` via the command palette
-  * Run the terminal command `npm run-script build` via the command palette
-* For development purpose turn of token validation for testing:
-* Add the **AuthenticationEvents__BypassTokenValidation** application key to the "Values" section in the local.settings.json file and set it's value to **true**.  If you do not have a local.settings.json file in your local environment, create one in the root of your Function App.
+- Visual Studio Code
+  - Start Visual Studio Code
+  - Run the terminal command `func init . --worker-runtime node` via the command palette
+  - Run the terminal command `func new` via the command palette
+  - Follow the project creation prompts
+  - Run the terminal command `npm install @azure/functions-authentication-events` via the command palette
+  - Run the terminal command `npm install` via the command palette
+  - Run the terminal command `npm run-script build` via the command palette
+- For development purpose turn of token validation for testing:
+- Add the **AuthenticationEvents\_\_BypassTokenValidation** application key to the "Values" section in the local.settings.json file and set it's value to **true**. If you do not have a local.settings.json file in your local environment, create one in the root of your Function App.
 
 ```json
 {
@@ -116,7 +114,7 @@ If you would like to _not_ authenticate the token while in local development, se
 }
 ```
 
-* Once the project is loaded, you can run the sample code and you should see the Azure functions developer's application load your end point.
+- Once the project is loaded, you can run the sample code and you should see the Azure functions developer's application load your end point.
 
 ## Key concepts
 
@@ -124,100 +122,109 @@ Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/a
 
 ## Documentation
 
-* One the function has been published, there's some good reading about logging and metrics that can be found [here](https://docs.microsoft.com/azure/azure-functions/functions-monitor-log-analytics?tabs=csharp)
+- One the function has been published, there's some good reading about logging and metrics that can be found [here](https://learn.microsoft.com/azure/azure-functions/functions-monitor-log-analytics?tabs=csharp)
 
-* For API Documentation, please see the (Link TBD)
-* Once this moves to preview, we except no breaking changes and would be as simple as removing the the nuget source that points to the private preview.
+- For API Documentation, please see the (Link TBD)
+- Once this moves to preview, we except no breaking changes and would be as simple as removing the the nuget source that points to the private preview.
 
 ## Examples
 
 To Test Token Augmentation, please do the following.
 
-* Open the project that was created in the prior step. (QuickStart)
-* Run the Application. `func host start`
-* Once the Azure functions developer's application has started, copy the listening url that is displayed with the application starts up.
-* Note: All Authentication functions are listed, in the case we have one function listener registered called "**OnTokenIssuanceStart**"
-* Your function endpoint will then be a combination of the listening url and function, for example: "http://localhost:7071/runtime/webhooks/AuthenticationEvents?code=(YOUR_CODE)&function=OnTokenIssuanceStart"
-* Post the following payload using something like Postman or Fiddler.
-* Steps for using Postman can be found (Link TBD)
+- Open the project that was created in the prior step. (QuickStart)
+- Run the Application. `func host start`
+- Once the Azure functions developer's application has started, copy the listening url that is displayed with the application starts up.
+- Note: All Authentication functions are listed, in the case we have one function listener registered called "**OnTokenIssuanceStart**"
+- Your function endpoint will then be a combination of the listening url and function, for example: "http://localhost:7071/runtime/webhooks/AuthenticationEvents?code=(YOUR_CODE)&function=OnTokenIssuanceStart"
+- Post the following payload using something like Postman or Fiddler.
+- Steps for using Postman can be found (Link TBD)
 
 ```json
 {
-    "type": "microsoft.graph.authenticationEvent.tokenIssuanceStart",
-    "source": "/tenants/00000001-0000-0ff1-ce00-000000000000/applications/ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
-    "data": {
-        "@odata.type": "microsoft.graph.onTokenIssuanceStartCalloutData",
-        "tenantId": "00000001-0000-0ff1-ce00-000000000000",
-        "authenticationEventListenerId": "f2390d57-9664-4dde-b625-f0115925e1e2",
-        "customAuthenticationExtensionId": "9cc1c1ed-5f04-4fdf-85c0-94a7c6ea819c",
-        "authenticationContext": {
-            "correlationId": "f4bd1870-b774-4fa5-ba78-e08ac6be14c0",
-            "client": {
-                "ip": "127.0.0.1",
-                "locale": "en-us",
-                "market": "en-us"
-            },
-            "protocol": "OAUTH2.0",
-            "clientServicePrincipal": {
-                "id": "eedfddb9-304e-4d62-aa83-24700a0bcf0e",
-                "appId": "ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
-                "appDisplayName": "",
-                "displayName": "Test application"
-            },
-            "resourceServicePrincipal": {
-                "id": "eedfddb9-304e-4d62-aa83-24700a0bcf0e",
-                "appId": "ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
-                "appDisplayName": "",
-                "displayName": "Test application"
-            },
-            "user": {
-                "companyName": "Evo Sts Test",
-                "country": "",
-                "id": "69d24544-c420-4721-a4bf-106f2378d9f6",
-                "mail": "testadmin@evostsoneboxtest.com",
-                "onPremisesSamAccountName": "testadmin",
-                "onPremisesSecurityIdentifier": "testadmin",
-                "preferredDataLocation": "",
-                "userPrincipalName": "testadmin@evostsoneboxtest.com"
-            }
-        }
+  "type": "microsoft.graph.authenticationEvent.tokenIssuanceStart",
+  "source": "/tenants/00000001-0000-0ff1-ce00-000000000000/applications/ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
+  "data": {
+    "@odata.type": "microsoft.graph.onTokenIssuanceStartCalloutData",
+    "tenantId": "00000001-0000-0ff1-ce00-000000000000",
+    "authenticationEventListenerId": "f2390d57-9664-4dde-b625-f0115925e1e2",
+    "customAuthenticationExtensionId": "9cc1c1ed-5f04-4fdf-85c0-94a7c6ea819c",
+    "authenticationContext": {
+      "correlationId": "f4bd1870-b774-4fa5-ba78-e08ac6be14c0",
+      "client": {
+        "ip": "127.0.0.1",
+        "locale": "en-us",
+        "market": "en-us"
+      },
+      "protocol": "OAUTH2.0",
+      "clientServicePrincipal": {
+        "id": "eedfddb9-304e-4d62-aa83-24700a0bcf0e",
+        "appId": "ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
+        "appDisplayName": "",
+        "displayName": "Test application"
+      },
+      "resourceServicePrincipal": {
+        "id": "eedfddb9-304e-4d62-aa83-24700a0bcf0e",
+        "appId": "ef9e995c-efdb-4e76-97a9-8cdfc6e06afc",
+        "appDisplayName": "",
+        "displayName": "Test application"
+      },
+      "user": {
+        "companyName": "Evo Sts Test",
+        "country": "",
+        "id": "69d24544-c420-4721-a4bf-106f2378d9f6",
+        "mail": "testadmin@evostsoneboxtest.com",
+        "onPremisesSamAccountName": "testadmin",
+        "onPremisesSecurityIdentifier": "testadmin",
+        "preferredDataLocation": "",
+        "userPrincipalName": "testadmin@evostsoneboxtest.com"
+      }
     }
+  }
 }
 ```
 
-* You should see this response:
+- You should see this response:
 
 ```json
 {
-    "data": {
-        "@odata.type": "microsoft.graph.onTokenIssuanceStartResponseData",
-        "actions": [
-            {
-                "@odata.type": "ProvideClaimsForToken",
-                "claims": [
-                    {
-                        "DateOfBirth": "01/01/2000"
-                    },
-                    {
-                        "CustomRoles": [
-                            "Writer",
-                            "Editor"
-                        ]
-                    }
-                ]
-            }
+  "data": {
+    "@odata.type": "microsoft.graph.onTokenIssuanceStartResponseData",
+    "actions": [
+      {
+        "@odata.type": "ProvideClaimsForToken",
+        "claims": [
+          {
+            "DateOfBirth": "01/01/2000"
+          },
+          {
+            "CustomRoles": ["Writer", "Editor"]
+          }
         ]
-    }
+      }
+    ]
+  }
 }
 ```
 
 ## Troubleshooting
 
-* Visual Studio Code
-  * If running in Visual Studio Code, you get an error along the lines of the local Azure Storage Emulator is unavailable, you can start the emulator manually.! (Note: Azure Storage emulator is now deprecated and the suggested replacement is [Azurite](https://docs.microsoft.com/azure/storage/common/storage-use-azurite?tabs=visual-studio))
-  * If using Visual Studio Code on Mac please use [Azurite](https://docs.microsoft.com/azure/storage/common/storage-use-azurite?tabs=visual-studio)
-  * If you see the following error on Windows (it's a bug) when trying to run the created projected.
-  * This can be resolved by executing this command in powershell `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope LocalMachine` more info on this can be found [here](https://github.com/Azure/azure-functions-core-tools/issues/1821) and [here](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7)
+- Visual Studio Code
+  - If running in Visual Studio Code, you get an error along the lines of the local Azure Storage Emulator is unavailable, you can start the emulator manually.! (Note: Azure Storage emulator is now deprecated and the suggested replacement is [Azurite](https://learn.microsoft.com/azure/storage/common/storage-use-azurite?tabs=visual-studio))
+  - If using Visual Studio Code on Mac please use [Azurite](https://learn.microsoft.com/azure/storage/common/storage-use-azurite?tabs=visual-studio)
+  - If you see the following error on Windows (it's a bug) when trying to run the created projected.
+  - This can be resolved by executing this command in powershell `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope LocalMachine` more info on this can be found [here](https://github.com/Azure/azure-functions-core-tools/issues/1821) and [here](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7)
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 ## Next steps
 
@@ -225,11 +232,11 @@ For more information on Azure SDK, please refer to [this website](https://azure.
 
 ## Publish
 
-* Follow the instruction here to create and publish your Azure Application. <https://docs.microsoft.com/azure/azure-functions/functions-develop-vs?tabs=in-process#publish-to-azure>
-* To determine your published posting endpoint, combine the azure function endpoint you created, route to the listener and listener code, the listen code can be found by navigating to your azure function application, selecting "App Keys" and copying the value of AuthenticationEvents_extension.
-* For example: "https://azureautheventstriggerdemo.azurewebsites.net/runtime/webhooks/AuthenticationEvents?code=(AuthenticationEvents_extension_key)&function=OnTokenIssuanceStart"
-* Make sure your production environment has the correct application settings for token authentication.
-* Once again you can test the published function by posting the above payload to the new endpoint.
+- Follow the instruction here to create and publish your Azure Application. <https://learn.microsoft.com/azure/azure-functions/functions-develop-vs?tabs=in-process#publish-to-azure>
+- To determine your published posting endpoint, combine the azure function endpoint you created, route to the listener and listener code, the listen code can be found by navigating to your azure function application, selecting "App Keys" and copying the value of AuthenticationEvents_extension.
+- For example: "https://azureautheventstriggerdemo.azurewebsites.net/runtime/webhooks/AuthenticationEvents?code=(AuthenticationEvents_extension_key)&function=OnTokenIssuanceStart"
+- Make sure your production environment has the correct application settings for token authentication.
+- Once again you can test the published function by posting the above payload to the new endpoint.
 
 ## Contributing
 
@@ -252,6 +259,7 @@ more information see the [Code of Conduct FAQ][coc_faq] or contact
 <opencode@microsoft.com> with any additional questions or comments.
 
 <!-- LINKS -->
+
 [cg]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/resourcemanager/Azure.ResourceManager/docs/CONTRIBUTING.md
 [coc]: https://opensource.microsoft.com/codeofconduct/
 [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/

package/dist/browser/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const SDK_VERSION: string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/browser/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,WAAW,EAAE,MAAuB,CAAC"}

package/{dist-esm/src → dist/browser}/constants.js

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 export const SDK_VERSION = "1.0.0-beta.1";
 //# sourceMappingURL=constants.js.map

package/{dist-esm/src → dist/browser}/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const SDK_VERSION: string = \"1.0.0-beta.1\";\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,cAAc,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.0.0-beta.1\";\n"]}

package/dist/browser/events.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Abstract base event interface to house common event request attributes.
+ */
+export interface AuthenticationEventRequestCommon {
+    /** Related Type */
+    type: string;
+    /** The status of the current request, see RequestStatus. */
+    requestStatus: RequestStatus;
+    /** A user friendly message (containing errors), that the authentication event returns. */
+    statusMessage: string;
+    /** A dictionary of query string parameters */
+    queryParameters: Record<string, string>;
+}
+/**
+ * Event request interface extended the related response and event data (payload) objects.
+ */
+export interface AuthenticationEventRequest<TResponse extends AuthenticationEventResponse, TData extends AuthenticationEventData> extends AuthenticationEventRequestCommon {
+    /** Related IEventResponse */
+    response: TResponse;
+    /** Related IEventData */
+    payload: TData;
+}
+/**
+ * Event request interface extended the related response and event data (payload) objects for cloud events.
+ */
+export interface CloudEventRequest<TResponse extends AuthenticationEventResponse, TData extends AuthenticationEventData> extends AuthenticationEventRequest<TResponse, TData> {
+    /** Related Source */
+    source: string;
+    /** Related \@odata.type */
+    oDataType: string;
+}
+/**
+ * Event response interface that houses attributes returned from the authentication events trigger.
+ */
+export interface AuthenticationEventResponse {
+    /** A template of the body of the expected response. */
+    body: string;
+}
+/**
+ * Event data interface pertaining to the expected payload, this interface houses the common attributes for data events.
+ */
+export interface AuthenticationEventData {
+    /** Tenant the request is related to. */
+    tenantId: string;
+    /** Unique Id for the event. */
+    authenticationEventListenerId: string;
+    /** The unique internal Id of the registered custom extension. */
+    customAuthenticationExtensionId: string;
+}
+/**
+ * An interface that binds a response that has actions
+ */
+export interface ActionableResponse<TEventAction extends AuthenticationEventAction> extends AuthenticationEventResponse {
+    /** Collections of actions pertaining to the event. */
+    actions: TEventAction[];
+}
+/**
+ * An interface for any responses that implement an cloud event payload and has actions on it.
+ */
+export interface ActionableCloudEventResponse<TEventAction extends AuthenticationEventAction> extends ActionableResponse<TEventAction> {
+    /** Gets the Cloud Event \@odata.type. */
+    oDataType: string;
+}
+/**
+ * An interface representing an action for an event.
+ */
+export interface AuthenticationEventAction {
+    /** Must be overridden, this will be the 'Name' of the action in the JSON. */
+    actionType: string;
+}
+/**
+ * The status of the request.
+ */
+export type RequestStatus = "Failed" | "TokenInvalid" | "Successful";
+/**
+ * Return the correctly formatted error
+ * */
+export interface FailedRequest extends AuthenticationEventResponse {
+    error: string;
+}
+/**
+ * Helper function to create a files request
+ * @param error - string or exception
+ * @returns a valid FailedRequest object
+ */
+export declare function createFailedRequest(error: unknown): FailedRequest;
+//# sourceMappingURL=events.d.ts.map

package/dist/browser/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,aAAa,EAAE,aAAa,CAAC;IAC7B,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CACzC,SAAS,SAAS,2BAA2B,EAC7C,KAAK,SAAS,uBAAuB,CACrC,SAAQ,gCAAgC;IACxC,6BAA6B;IAC7B,QAAQ,EAAE,SAAS,CAAC;IACpB,yBAAyB;IACzB,OAAO,EAAE,KAAK,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAChC,SAAS,SAAS,2BAA2B,EAC7C,KAAK,SAAS,uBAAuB,CACrC,SAAQ,0BAA0B,CAAC,SAAS,EAAE,KAAK,CAAC;IACpD,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,6BAA6B,EAAE,MAAM,CAAC;IACtC,iEAAiE;IACjE,+BAA+B,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,YAAY,SAAS,yBAAyB,CAChF,SAAQ,2BAA2B;IACnC,sDAAsD;IACtD,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B,CAAC,YAAY,SAAS,yBAAyB,CAC1F,SAAQ,kBAAkB,CAAC,YAAY,CAAC;IACxC,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,6EAA6E;IAC7E,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAC;AAErE;;KAEK;AACL,MAAM,WAAW,aAAc,SAAQ,2BAA2B;IAEhE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CAKjE"}

package/{dist-esm/src → dist/browser}/events.js

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 /**
  * Helper function to create a files request
  * @param error - string or exception

package/dist/browser/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/events.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqGlC;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,OAAO;QACL,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;KAC9D,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Abstract base event interface to house common event request attributes.\n */\nexport interface AuthenticationEventRequestCommon {\n  /** Related Type */\n  type: string;\n  /** The status of the current request, see RequestStatus. */\n  requestStatus: RequestStatus;\n  /** A user friendly message (containing errors), that the authentication event returns. */\n  statusMessage: string;\n  /** A dictionary of query string parameters */\n  queryParameters: Record<string, string>;\n}\n\n/**\n * Event request interface extended the related response and event data (payload) objects.\n */\nexport interface AuthenticationEventRequest<\n  TResponse extends AuthenticationEventResponse,\n  TData extends AuthenticationEventData,\n> extends AuthenticationEventRequestCommon {\n  /** Related IEventResponse */\n  response: TResponse;\n  /** Related IEventData */\n  payload: TData;\n}\n\n/**\n * Event request interface extended the related response and event data (payload) objects for cloud events.\n */\nexport interface CloudEventRequest<\n  TResponse extends AuthenticationEventResponse,\n  TData extends AuthenticationEventData,\n> extends AuthenticationEventRequest<TResponse, TData> {\n  /** Related Source */\n  source: string;\n  /** Related \\@odata.type */\n  oDataType: string;\n}\n\n/**\n * Event response interface that houses attributes returned from the authentication events trigger.\n */\nexport interface AuthenticationEventResponse {\n  /** A template of the body of the expected response. */\n  body: string;\n}\n\n/**\n * Event data interface pertaining to the expected payload, this interface houses the common attributes for data events.\n */\nexport interface AuthenticationEventData {\n  /** Tenant the request is related to. */\n  tenantId: string;\n  /** Unique Id for the event. */\n  authenticationEventListenerId: string;\n  /** The unique internal Id of the registered custom extension. */\n  customAuthenticationExtensionId: string;\n}\n\n/**\n * An interface that binds a response that has actions\n */\nexport interface ActionableResponse<TEventAction extends AuthenticationEventAction>\n  extends AuthenticationEventResponse {\n  /** Collections of actions pertaining to the event. */\n  actions: TEventAction[];\n}\n\n/**\n * An interface for any responses that implement an cloud event payload and has actions on it.\n */\nexport interface ActionableCloudEventResponse<TEventAction extends AuthenticationEventAction>\n  extends ActionableResponse<TEventAction> {\n  /** Gets the Cloud Event \\@odata.type. */\n  oDataType: string;\n}\n\n/**\n * An interface representing an action for an event.\n */\nexport interface AuthenticationEventAction {\n  /** Must be overridden, this will be the 'Name' of the action in the JSON. */\n  actionType: string;\n}\n\n/**\n * The status of the request.\n */\nexport type RequestStatus = \"Failed\" | \"TokenInvalid\" | \"Successful\";\n\n/**\n * Return the correctly formatted error\n * */\nexport interface FailedRequest extends AuthenticationEventResponse {\n  //* * The error that caused the request to fail. */\n  error: string;\n}\n\n/**\n * Helper function to create a files request\n * @param error - string or exception\n * @returns a valid FailedRequest object\n */\nexport function createFailedRequest(error: unknown): FailedRequest {\n  return {\n    body: \"\",\n    error: error instanceof Error ? error.message : String(error),\n  };\n}\n"]}

package/dist/browser/index.d.ts

@@ -0,0 +1,5 @@
+export { FailedRequest, ActionableResponse, AuthenticationEventAction, AuthenticationEventData, AuthenticationEventRequest, AuthenticationEventRequestCommon, AuthenticationEventResponse, RequestStatus, CloudEventRequest, createFailedRequest, ActionableCloudEventResponse, } from "./events.js";
+export { AuthenticationEventContext, AuthenticationEventContextClient, AuthenticationEventContextServicePrincipal, AuthenticationEventContextUser, TokenIssuanceStartData, TokenIssuanceStartRequest, TokenIssuanceStartResponse, } from "./tokenIssuanceStart/context.js";
+export { ProvideClaimsForToken, TokenClaim, createProvideClaimsForToken, } from "./tokenIssuanceStart/actions.js";
+export { TokenIssuanceStartAction } from "./tokenIssuanceStart/context.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,yBAAyB,EACzB,uBAAuB,EACvB,0BAA0B,EAC1B,gCAAgC,EAChC,2BAA2B,EAC3B,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,GAC7B,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,0BAA0B,EAC1B,gCAAgC,EAChC,0CAA0C,EAC1C,8BAA8B,EAC9B,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,2BAA2B,GAC5B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC"}

package/dist/browser/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export { createFailedRequest, } from "./events.js";
+export { createProvideClaimsForToken, } from "./tokenIssuanceStart/actions.js";
+//# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAUL,mBAAmB,GAEpB,MAAM,aAAa,CAAC;AAWrB,OAAO,EAGL,2BAA2B,GAC5B,MAAM,iCAAiC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport {\n  FailedRequest,\n  ActionableResponse,\n  AuthenticationEventAction,\n  AuthenticationEventData,\n  AuthenticationEventRequest,\n  AuthenticationEventRequestCommon,\n  AuthenticationEventResponse,\n  RequestStatus,\n  CloudEventRequest,\n  createFailedRequest,\n  ActionableCloudEventResponse,\n} from \"./events.js\";\n\nexport {\n  AuthenticationEventContext,\n  AuthenticationEventContextClient,\n  AuthenticationEventContextServicePrincipal,\n  AuthenticationEventContextUser,\n  TokenIssuanceStartData,\n  TokenIssuanceStartRequest,\n  TokenIssuanceStartResponse,\n} from \"./tokenIssuanceStart/context.js\";\nexport {\n  ProvideClaimsForToken,\n  TokenClaim,\n  createProvideClaimsForToken,\n} from \"./tokenIssuanceStart/actions.js\";\n\nexport { TokenIssuanceStartAction } from \"./tokenIssuanceStart/context.js\";\n"]}

package/dist/browser/logger.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The \@azure/logger configuration for this package.
+ *
+ * @internal
+ */
+export declare const logger: import("@azure/logger").AzureLogger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/browser/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,MAAM,qCAAwD,CAAC"}

package/{dist-esm/src → dist/browser}/logger.js

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 import { createClientLogger } from "@azure/logger";
 /**
  * The \@azure/logger configuration for this package.

package/{dist-esm/src → dist/browser}/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,iCAAiC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The \\@azure/logger configuration for this package.\n *\n * @internal\n */\nexport const logger = createClientLogger(\"functions-authentication-events\");\n"]}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC,iCAAiC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The \\@azure/logger configuration for this package.\n *\n * @internal\n */\nexport const logger = createClientLogger(\"functions-authentication-events\");\n"]}

package/dist/browser/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/browser/tokenIssuanceStart/actions.d.ts

@@ -0,0 +1,17 @@
+import type { TokenIssuanceStartAction } from "./context.js";
+/**
+ * An Interface for the Provide Claims for token action.
+ */
+export interface ProvideClaimsForToken extends TokenIssuanceStartAction {
+    /** The 'Name' of the action in the JSON. */
+    actionType: "microsoft.graph.ProvideClaimsForToken";
+    /** Collection of claims to add to the token. */
+    claims: TokenClaim;
+}
+/** Helper function to create a provider claims for token */
+export declare function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken;
+/**
+ * An type representing a claim.
+ */
+export type TokenClaim = Record<string, string | string[]>;
+//# sourceMappingURL=actions.d.ts.map

package/dist/browser/tokenIssuanceStart/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/tokenIssuanceStart/actions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,wBAAwB;IACrE,4CAA4C;IAC5C,UAAU,EAAE,uCAAuC,CAAC;IACpD,gDAAgD;IAChD,MAAM,EAAE,UAAU,CAAC;CAEpB;AAED,4DAA4D;AAC5D,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,UAAU,GAAG,qBAAqB,CAKrF;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC"}

package/{dist-esm/src → dist/browser}/tokenIssuanceStart/actions.js

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
+// Licensed under the MIT License.
 /** Helper function to create a provider claims for token */
 export function createProvideClaimsForToken(claims) {
     return {

package/dist/browser/tokenIssuanceStart/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/tokenIssuanceStart/actions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAelC,4DAA4D;AAC5D,MAAM,UAAU,2BAA2B,CAAC,MAAkB;IAC5D,OAAO;QACL,UAAU,EAAE,uCAAuC;QACnD,MAAM,EAAE,MAAM;KACf,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { TokenIssuanceStartAction } from \"./context.js\";\n\n/**\n * An Interface for the Provide Claims for token action.\n */\nexport interface ProvideClaimsForToken extends TokenIssuanceStartAction {\n  /** The 'Name' of the action in the JSON. */\n  actionType: \"microsoft.graph.ProvideClaimsForToken\";\n  /** Collection of claims to add to the token. */\n  claims: TokenClaim;\n  /** Helper constructor to easily add claims to the action. */\n}\n\n/** Helper function to create a provider claims for token */\nexport function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken {\n  return {\n    actionType: \"microsoft.graph.ProvideClaimsForToken\",\n    claims: claims,\n  };\n}\n\n/**\n * An type representing a claim.\n */\nexport type TokenClaim = Record<string, string | string[]>;\n"]}