Skip to content

fix: fix(entraid): correct package entry point structure #2917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/entraid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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).

Expand Down Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion packages/entraid/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"outDir": "./dist"
},
"include": [
"./lib/**/*.ts"
"./lib/**/*.ts",
"./index.ts"
],
"exclude": [
"./lib/**/*.spec.ts",
Expand Down
Loading