From a7c96a01f8fc9000870e82587932f9480b63a4df Mon Sep 17 00:00:00 2001 From: "Bobby I." Date: Tue, 25 Mar 2025 13:50:16 +0200 Subject: [PATCH] fix (entraid): correct package entry point structure (#2917) - last time we forgot to include `index.ts` --- packages/entraid/README.md | 6 +++--- packages/entraid/tsconfig.json | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/entraid/README.md b/packages/entraid/README.md index 83ddd1a391..10ecfec997 100644 --- a/packages/entraid/README.md +++ b/packages/entraid/README.md @@ -39,7 +39,7 @@ The first step to using @redis/entraid is choosing the right credentials provide ```typescript import { createClient } from '@redis/client'; -import { EntraIdCredentialsProviderFactory } from '@redis/entraid/dist/lib'; +import { EntraIdCredentialsProviderFactory } from '@redis/entraid'; const provider = EntraIdCredentialsProviderFactory.createForClientCredentials({ clientId: 'your-client-id', @@ -86,7 +86,7 @@ const provider = EntraIdCredentialsProviderFactory.createForUserAssignedManagedI ### DefaultAzureCredential Authentication -tip: see a real sample here: [samples/interactive-browser/index.ts](./samples/interactive-browser/index.ts) +tip: see a real sample here: [samples/interactive-browser/index.ts](./samples/interactive-browser/index.ts) The DefaultAzureCredential from @azure/identity provides a simplified authentication experience that automatically tries different authentication methods based on the environment. This is especially useful for applications that need to work in different environments (local development, CI/CD, and production). @@ -128,7 +128,7 @@ When using the `createForDefaultAzureCredential` method, you need to: 2. Pass the same parameters to the factory method that you would use with the `getToken()` method: - `scopes`: The Redis scope (use the exported `REDIS_SCOPE_DEFAULT` constant) - `options`: Any additional options for the getToken method - + This factory method creates a wrapper around DefaultAzureCredential that adapts it to the Redis client's authentication system, while maintaining all the flexibility of the original Azure Identity authentication. diff --git a/packages/entraid/tsconfig.json b/packages/entraid/tsconfig.json index 414dc1fe75..47100f5b87 100644 --- a/packages/entraid/tsconfig.json +++ b/packages/entraid/tsconfig.json @@ -4,7 +4,8 @@ "outDir": "./dist" }, "include": [ - "./lib/**/*.ts" + "./lib/**/*.ts", + "./index.ts" ], "exclude": [ "./lib/**/*.spec.ts",