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

package/README.md

@@ -1,4 +1,4 @@
-# Authentication Events Trigger for Azure Functions client library for .NET
+# Authentication Events Trigger for Azure Functions client library for Node
 
 Authentication Event Trigger for Azure Functions handles all the backend processing, (e.g. token/json schema validation) for incoming Http requests for Authentication events. And provides the developer with a strongly typed, versioned object model to work with, meaning the developer need not have any prior knowledge of the request and response json payloads.
 
@@ -12,40 +12,19 @@ This project framework provides the following features:
 
 ## Getting started
 
-### Install the package
+### Install the npm package
 
-```dotnetcli
-dotnet add package Microsoft.Azure.WebJobs.Extensions.AuthenticationEvents --prerelease
+```console
+npm install @azure/functions-authentication-events 
 ```
 
 ### Prerequisites
 
-* [Visual Studio 2019](https://visualstudio.microsoft.com/vs/) for Windows **OR** [Visual Studio Code >= 1.61](https://code.visualstudio.com/download)
-* [Dotnet core 3.1](https://dotnet.microsoft.com/download/dotnet/3.1)
-* [Azure function tools 3.30](https://github.com/Azure/azure-functions-core-tools)
-* [Nuget](https://docs.microsoft.com/nuget/install-nuget-client-tools)
+* [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)
-* For private preview register a Nuget source either using Nuget''s cli **OR** Visual Studio's Nuget Package Manager.
-  * Generate a GIT Personal Access Token. Go to [https://github.com/settings/tokens](https://github.com/settings/tokens)
-    * When generating the token, it needs to have the following permissions/scope: **read:package**
-    * Authorize **Azure** to use the Personal Access Token. (::Only if you are a member of the Azure Organization on GitHub::)
-
-  * Nuget CLI (**Recommended**):
-    * **GIT-USERNAME**: Your GIT username that you log into GIT with.
-    * **GIT-PERSONAL-ACCESS-TOKEN**: Your GIT Personal access token (see below reference on how to generate one)
-
-    ```shell
-    nuget sources add -Name "Azure" -Source "https://nuget.pkg.github.com/Azure/index.json" -username "**[GIT-USERNAME]**" -password "**[GIT-PERSONAL-ACCESS-TOKEN]**"
-    ```
-
-    * More details can be found here
-      * [Nuget Source](https://docs.microsoft.com/nuget/reference/cli-reference/cli-ref-sources)
-      * [How to Generate a GIT Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
-  * Visual Studio's Nuget Package Manager
-    * You'll be prompted for credentials when accessing the source, so keep you Personal Access Token handy as this would be your password.
 
 ### Authenticate the Client
 
@@ -115,17 +94,14 @@ If you would like to _not_ authenticate the token while in local development, se
 
 ### Quickstart
 
-* Visual Studio 2019
-  * Start Visual Studio
-  * Select "Create a new project"
-  * In the template search area search and select "AzureAuthEventsTrigger"
-  * Give your project a meaningful Project Name, Location, Solution and Solution Name.
-
 * Visual Studio Code
   * Start Visual Studio Code
-  * Run the command "Create Azure Authentication Events Trigger Project" via the command palette
+  * 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
-* Please note: that on a first time run it might take awhile to download the the required packages.
+  * 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.
 
@@ -134,7 +110,7 @@ If you would like to _not_ authenticate the token while in local development, se
   "IsEncrypted": false,
   "Values": {
     "AzureWebJobsStorage": "UseDevelopmentStorage=true",
-    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
+    "FUNCTIONS_WORKER_RUNTIME": "node",
     "AuthenticationEvents__BypassTokenValidation": true
   }
 }
@@ -157,9 +133,8 @@ Key concepts of the Azure .NET SDK can be found [here](https://azure.github.io/a
 
 To Test Token Augmentation, please do the following.
 
-* Start Visual Studio.
 * Open the project that was created in the prior step. (QuickStart)
-* Run the Application. (F5)
+* 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"
@@ -168,52 +143,45 @@ To Test Token Augmentation, please do the following.
 
 ```json
 {
-  "type":"microsoft.graph.authenticationEvent.TokenIssuanceStart",
-  "source":"/tenants/{tenantId}/applications/{resourceAppId}",
-  "data":{
-    "@odata.type": "microsoft.graph.onTokenIssuanceStartCalloutData",
-    "tenantId": "30000000-0000-0000-0000-000000000003",
-    "authenticationEventListenerId1": "10000000-0000-0000-0000-000000000001",
-    "customAuthenticationExtensionId": "10000000-0000-0000-0000-000000000002",
-    "authenticationContext1":{
-      "correlationId": "20000000-0000-0000-0000-000000000002",
-      "client": {
-        "ip": "127.0.0.1",
-        "locale": "en-us",
-        "market": "en-au"
-      },
-      "authenticationProtocol": "OAUTH2.0",
-      "clientServicePrincipal": {
-        "id": "40000000-0000-0000-0000-000000000001",
-        "appId": "40000000-0000-0000-0000-000000000002",
-        "appDisplayName": "Test client app",
-        "displayName": "Test client application"
-      },
-      "resourceServicePrincipal": {
-        "id": "40000000-0000-0000-0000-000000000003",
-        "appId": "40000000-0000-0000-0000-000000000004",
-        "appDisplayName": "Test resource app",
-        "displayName": "Test resource application"
-      },
-      "user": {
-        "companyName": "Nick Gomez",
-        "country": "USA",
-        "createdDateTime": "0001-01-01T00:00:00Z",
-        "displayName": "Dummy display name",
-        "givenName": "Example",
-        "id": "60000000-0000-0000-0000-000000000006",
-        "mail": "test@example.com",
-        "onPremisesSamAccountName": "testadmin",
-        "onPremisesSecurityIdentifier": "DummySID",
-        "onPremisesUserPrincipalName": "Dummy Name",
-        "preferredDataLocation": "DummyDataLocation",
-        "preferredLanguage": "DummyLanguage",
-        "surname": "Test",
-        "userPrincipalName": "testadmin@example.com",
-        "userType": "UserTypeCloudManaged"
-      }
+    "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"
+            }
+        }
     }
-  }
 }
 ```
 

package/dist/index.js

@@ -16,5 +16,16 @@ function createFailedRequest(error) {
     };
 }
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** Helper function to create a provider claims for token */
+function createProvideClaimsForToken(claims) {
+    return {
+        actionType: "microsoft.graph.ProvideClaimsForToken",
+        claims: claims,
+    };
+}
+
 exports.createFailedRequest = createFailedRequest;
+exports.createProvideClaimsForToken = createProvideClaimsForToken;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/events.ts"],"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"],"names":[],"mappings":";;;;AAAA;AACA;AAqGA;;;;AAIG;AACG,SAAU,mBAAmB,CAAC,KAAc,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,KAAK,EAAE,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;KAC9D,CAAC;AACJ;;;;"}
+{"version":3,"file":"index.js","sources":["../src/events.ts","../src/tokenIssuanceStart/actions.ts"],"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","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { TokenIssuanceStartAction } from \"./context\";\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"],"names":[],"mappings":";;;;AAAA;AACA;AAqGA;;;;AAIG;AACG,SAAU,mBAAmB,CAAC,KAAc,EAAA;IAChD,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,KAAK,EAAE,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;KAC9D,CAAC;AACJ;;AChHA;AACA;AAeA;AACM,SAAU,2BAA2B,CAAC,MAAkB,EAAA;IAC5D,OAAO;AACL,QAAA,UAAU,EAAE,uCAAuC;AACnD,QAAA,MAAM,EAAE,MAAM;KACf,CAAC;AACJ;;;;;"}

package/dist-esm/src/index.js

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

package/dist-esm/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAUL,mBAAmB,GAEpB,MAAM,UAAU,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\";\n\nexport {\n  AuthenticationEventContext,\n  AuthenticationEventContextClient,\n  AuthenticationEventContextServicePrincipal,\n  AuthenticationEventContextUser,\n  TokenIssuanceStartData,\n  TokenIssuanceStartRequest,\n  TokenIssuanceStartResponse,\n} from \"./tokenIssuanceStart/context\";\nexport { ProvideClaimsForToken, TokenClaim } from \"./tokenIssuanceStart/actions\";\n\nexport { TokenIssuanceStartAction } from \"./tokenIssuanceStart/context\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAUL,mBAAmB,GAEpB,MAAM,UAAU,CAAC;AAWlB,OAAO,EAGL,2BAA2B,GAC5B,MAAM,8BAA8B,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\";\n\nexport {\n  AuthenticationEventContext,\n  AuthenticationEventContextClient,\n  AuthenticationEventContextServicePrincipal,\n  AuthenticationEventContextUser,\n  TokenIssuanceStartData,\n  TokenIssuanceStartRequest,\n  TokenIssuanceStartResponse,\n} from \"./tokenIssuanceStart/context\";\nexport {\n  ProvideClaimsForToken,\n  TokenClaim,\n  createProvideClaimsForToken,\n} from \"./tokenIssuanceStart/actions\";\n\nexport { TokenIssuanceStartAction } from \"./tokenIssuanceStart/context\";\n"]}

package/dist-esm/src/tokenIssuanceStart/actions.js

@@ -1,4 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export {};
+/** Helper function to create a provider claims for token */
+export function createProvideClaimsForToken(claims) {
+    return {
+        actionType: "microsoft.graph.ProvideClaimsForToken",
+        claims: claims,
+    };
+}
 //# sourceMappingURL=actions.js.map

package/dist-esm/src/tokenIssuanceStart/actions.js.map

@@ -1 +1 @@
-{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/tokenIssuanceStart/actions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { TokenIssuanceStartAction } from \"./context\";\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: \"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/**\n * An Interface representing a claim.\n */\nexport interface TokenClaim {\n  /** The id of the claim (i.e. Name). */\n  id: string;\n  /** The value of the claim. */\n  value: string | string[];\n}\n"]}
+{"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 { TokenIssuanceStartAction } from \"./context\";\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"]}

package/dist-esm/src/tokenIssuanceStart/index.js

@@ -1,4 +1,4 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
-export {};
+export { createProvideClaimsForToken } from "./actions";
 //# sourceMappingURL=index.js.map

package/dist-esm/src/tokenIssuanceStart/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tokenIssuanceStart/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport {\n  AuthenticationEventContext,\n  AuthenticationEventContextClient,\n  AuthenticationEventContextServicePrincipal,\n  AuthenticationEventContextUser,\n  TokenIssuanceStartData,\n  TokenIssuanceStartRequest,\n  TokenIssuanceStartResponse,\n  TokenIssuanceStartAction,\n} from \"./context\";\nexport { ProvideClaimsForToken, TokenClaim } from \"./actions\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tokenIssuanceStart/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAYlC,OAAO,EAAqC,2BAA2B,EAAE,MAAM,WAAW,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport {\n  AuthenticationEventContext,\n  AuthenticationEventContextClient,\n  AuthenticationEventContextServicePrincipal,\n  AuthenticationEventContextUser,\n  TokenIssuanceStartData,\n  TokenIssuanceStartRequest,\n  TokenIssuanceStartResponse,\n  TokenIssuanceStartAction,\n} from \"./context\";\nexport { ProvideClaimsForToken, TokenClaim, createProvideClaimsForToken } from \"./actions\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/functions-authentication-events",
-  "version": "1.0.0-alpha.20221101.1",
+  "version": "1.0.0-beta.2",
   "description": "Typescript Trigger SDK for Azure AD Authentication event custom extensions. Lets you focus on your business logic.",
   "sdk-type": "client",
   "main": "dist/index.js",
@@ -65,11 +65,11 @@
     "tslib": "^2.2.0"
   },
   "devDependencies": {
-    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
-    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/dev-tool": "^1.0.0",
+    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/identity": "^2.0.1",
-    "@azure/test-utils": ">=1.0.0-alpha <1.0.0-alphb",
-    "@azure-tools/test-credential": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/test-utils": "^1.0.0",
+    "@azure-tools/test-credential": "~1.0.0",
     "@azure-tools/test-recorder": "^2.0.0",
     "@microsoft/api-extractor": "^7.31.1",
     "@types/chai": "^4.1.6",

package/types/3.1/functions-authentication-events.d.ts

@@ -148,6 +148,8 @@ export declare interface CloudEventRequest<TResponse extends AuthenticationEvent
  * @returns a valid FailedRequest object
  */
 export declare function createFailedRequest(error: unknown): FailedRequest;
+/** Helper function to create a provider claims for token */
+export declare function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken;
 /**
  * Return the correctly formatted error
  * */
@@ -159,23 +161,18 @@ export declare interface FailedRequest extends AuthenticationEventResponse {
  */
 export declare interface ProvideClaimsForToken extends TokenIssuanceStartAction {
     /** The 'Name' of the action in the JSON. */
-    actionType: "ProvideClaimsForToken";
+    actionType: "microsoft.graph.ProvideClaimsForToken";
     /** Collection of claims to add to the token. */
-    claims: TokenClaim[];
+    claims: TokenClaim;
 }
 /**
  * The status of the request.
  */
 export declare type RequestStatus = "Failed" | "TokenInvalid" | "Successful";
 /**
- * An Interface representing a claim.
+ * An type representing a claim.
  */
-export declare interface TokenClaim {
-    /** The id of the claim (i.e. Name). */
-    id: string;
-    /** The value of the claim. */
-    value: string | string[];
-}
+export declare type TokenClaim = Record<string, string | string[]>;
 /**
  * All actions for the token issuance start event should extended this interface, as it looks the correct action to the correct event.
  */

package/types/latest/functions-authentication-events.d.ts

@@ -161,6 +161,9 @@ export declare interface CloudEventRequest<TResponse extends AuthenticationEvent
  */
 export declare function createFailedRequest(error: unknown): FailedRequest;
 
+/** Helper function to create a provider claims for token */
+export declare function createProvideClaimsForToken(claims: TokenClaim): ProvideClaimsForToken;
+
 /**
  * Return the correctly formatted error
  * */
@@ -173,9 +176,9 @@ export declare interface FailedRequest extends AuthenticationEventResponse {
  */
 export declare interface ProvideClaimsForToken extends TokenIssuanceStartAction {
     /** The 'Name' of the action in the JSON. */
-    actionType: "ProvideClaimsForToken";
+    actionType: "microsoft.graph.ProvideClaimsForToken";
     /** Collection of claims to add to the token. */
-    claims: TokenClaim[];
+    claims: TokenClaim;
 }
 
 /**
@@ -184,14 +187,9 @@ export declare interface ProvideClaimsForToken extends TokenIssuanceStartAction
 export declare type RequestStatus = "Failed" | "TokenInvalid" | "Successful";
 
 /**
- * An Interface representing a claim.
+ * An type representing a claim.
  */
-export declare interface TokenClaim {
-    /** The id of the claim (i.e. Name). */
-    id: string;
-    /** The value of the claim. */
-    value: string | string[];
-}
+export declare type TokenClaim = Record<string, string | string[]>;
 
 /**
  * All actions for the token issuance start event should extended this interface, as it looks the correct action to the correct event.